mirror of
https://github.com/microsoft/regorus.git
synced 2026-08-05 02:16:11 +00:00
e68e852ee3
- split the xtask crate into structured modules for - bindings - ci - dev - util - no-std - Adding commands for - ci-release/ci-debug - MUSL/no-std - per- binding language smoke tests - developer tasks (fmt, clippy, pre-commit, pre-push) - refresh Cargo manifests/locks, binding readmes, and shared FFI helpers so every binding reuses the same preparation steps - refactor GitHub Actions (release/debug, extensions, CodeQL, clippy, bindings) to call the new xtask commands - Use rust-cache in ci workflows (microsoft qdk also does this) - extend README with a contributor workflow section describing how xtask mirrors CI expectations - update pre-commit and pre-push hooks to use the xtask dev commands WORKAROUND: When dotnet is run from an xtask, codeql tracer intercepts it an routes to a nonexistent binary. Therefore in codeql workflow, xtask is not used for c# and instead dotnet is directly invoked. Tracked by #545 closes #475 Signed-off-by: Anand Krishnamoorthi <anakrish@microsoft.com>
77 lines
2.4 KiB
Markdown
77 lines
2.4 KiB
Markdown
# Regorus Java
|
|
<!-- Trivial change to trigger version bump test -->
|
|
**Regorus** is
|
|
|
|
- *Rego*-*Rus(t)* - A fast, light-weight [Rego](https://www.openpolicyagent.org/docs/latest/policy-language/)
|
|
interpreter written in Rust.
|
|
- *Rigorous* - A rigorous enforcer of well-defined Rego semantics.
|
|
|
|
See main [Regorus page](https://github.com/microsoft/regorus) for more details about the project.
|
|
|
|
## Building
|
|
|
|
Due to operational overhead we don't publish Java bindings to Maven Central
|
|
currently (see https://github.com/microsoft/regorus/issues/237) and you need to build from source to use it.
|
|
|
|
In order to build Regorus Java for a target platform, you need to install Rust target for that platform first:
|
|
```bash
|
|
$ rustup target add aarch64-apple-darwin
|
|
```
|
|
|
|
Afterwards, you can build native library for that target using:
|
|
```bash
|
|
$ cargo build --release --target aarch64-apple-darwin
|
|
```
|
|
|
|
You will then have a native library at `target/aarch64-apple-darwin/release/libregorus_java.dylib` depending on your target.
|
|
|
|
You then need to build Java bindings using:
|
|
```bash
|
|
$ mvn package
|
|
```
|
|
|
|
And you will have a JAR at `./target/regorus-java-0.1.5.jar`.
|
|
|
|
### Automation
|
|
|
|
The repository exposes helper commands for local workflows:
|
|
|
|
- `cargo xtask build-java` runs `mvn package` with quiet output helpers.
|
|
- `cargo xtask test-java` rebuilds the native library via the Maven exec plugin and executes the binding tests.
|
|
|
|
## Usage
|
|
|
|
You can use Regorus Java bindings as:
|
|
|
|
```java
|
|
import com.microsoft.regorus.Engine;
|
|
|
|
public class Test {
|
|
public static void main(String[] args) {
|
|
try (Engine engine = new Engine()) {
|
|
engine.addPolicy(
|
|
"hello.rego",
|
|
"package test\nmessage = concat(\", \", [input.message, data.message])"
|
|
);
|
|
engine.addDataJson("{\"message\":\"World!\"}");
|
|
engine.setInputJson("{\"message\":\"Hello\"}");
|
|
String resJson = engine.evalQuery("data.test.message");
|
|
|
|
System.out.println(resJson);
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
You need to ensure artifacts built in [previous section](#building) are in Java's classpath.
|
|
|
|
For example with `java` CLI:
|
|
```bash
|
|
$ java -Djava.library.path=../../target/aarch64-apple-darwin/release/ -cp target/regorus-java-0.1.5.jar Test.java
|
|
```
|
|
|
|
should gave you the output:
|
|
```
|
|
{"result":[{"expressions":[{"value":"Hello, World!","text":"data.test.message","location":{"row":1,"col":1}}]}]}
|
|
```
|