test the Readme in CI

Author: andreaTP

.github/workflows/ci.yml

@@ -72,3 +72,29 @@ jobs:
       if: success() || failure() # always run even if the previous step fails
       with:
         report_paths: '**/target/surefire-reports/TEST-*.xml'
+
+  readme-ci:
+    runs-on: ubuntu-latest
+    name: CI - Readme
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+      - name: Set up Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+          cache: maven
+      - name: Build Opa Java Wasm
+        run: mvn clean install -DskipTests
+        env:
+          MAVEN_OPTS: "-Dmaven.repo.local=${{ github.workspace }}/repository"
+      # Test root Readme
+      - name: jbang
+        uses: jbangdev/jbang-action@9f8c55e0a2b6b297711162b20c209c5e07076e59 # tag=v0.117.1
+        with:
+          script: Readme.md
+        env:
+          JBANG_REPO: "${{ github.workspace }}/repository"
+      - name: compare results
+        run: diff -r Readme.result TestReadme.result

.gitignore

@@ -1,3 +1,5 @@
 target
 .idea
 testcases.tar.gz
+policy.wasm
+TestReadme.result

Readme.md

@@ -29,14 +29,26 @@ With Maven add the core module dependency:
 </dependency>
 ```
 
+<!--
+```java
+//DEPS com.styra.opa:opa-java-wasm:999-SNAPSHOT
+
+var policyPath = Path.of("core/src/main/resources/demo-policy.wasm");
+var targetPath = Path.of("policy.wasm");
+Files.copy(policyPath, targetPath, StandardCopyOption.REPLACE_EXISTING);
+
+var policyWasm = new File("policy.wasm");
+```
+-->
+
 ## Usage
 
 There are only a couple of steps required to start evaluating the policy.
 
 ### Import the module
 
 ```java
-import com.styra.opa.wasm.Opa;
+import com.styra.opa.wasm.OpaPolicy;
 ```
 
 ### Load the policy
@@ -71,13 +83,19 @@ APIs for policy evaluation:
 Example:
 
 ```java
-input = '{"path": "/", "role": "admin"}';
+var input = "{\"path\": \"/\", \"role\": \"admin\"}";
 
 var policy = OpaPolicy.builder().withPolicy(policyWasm).build();
 var result = policy.evaluate(input);
 System.out.println("Result is: " + result);
 ```
 
+<!--
+```java
+Files.write(Paths.get("TestReadme.result"), (result + "\n").getBytes());
+```
+-->
+
 > For any `opa build` created WASM binaries the result set, when defined, will
 > contain a `result` key with the value of the compiled entrypoint. See
 > [https://www.openpolicyagent.org/docs/latest/wasm/](https://www.openpolicyagent.org/docs/latest/wasm/)

Readme.result

@@ -0,0 +1 @@
+[{"result":false}]