Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/me-viper/OpaDotNet.Compilation
Backend for packaging OPA policy and data files into bundles
https://github.com/me-viper/OpaDotNet.Compilation
dotnet-core open-policy-agent
Last synced: 25 days ago
JSON representation
Backend for packaging OPA policy and data files into bundles
- Host: GitHub
- URL: https://github.com/me-viper/OpaDotNet.Compilation
- Owner: me-viper
- License: mit
- Created: 2023-08-16T08:27:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-07T05:45:47.000Z (4 months ago)
- Last Synced: 2024-11-10T06:42:21.874Z (about 1 month ago)
- Topics: dotnet-core, open-policy-agent
- Language: C#
- Homepage: https://me-viper.github.io/OpaDotNet/
- Size: 138 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-opa - OpaDotNet.Compilation - dotnet core backend for packaging Open Policy Agent Rego policies and data files into WASM policy bundles (WebAssembly (Wasm) / Typescript)
README
[](https://github.com/me-viper/OpaDotNet.Compilation/actions/workflows/ci.yml)
[](https://coveralls.io/github/me-viper/OpaDotNet.Compilation?branch=main)
# Open Policy Agent (OPA) Compilation Tools
Backend for packaging OPA policy and data files into bundles for [OpaDotNet](https://github.com/me-viper/OpaDotNet) project.
## NuGet Packages
| | Package |
|---------------------------------------|----------|
| OpaDotNet.Compilation.Abstractions | [](https://www.nuget.org/packages/OpaDotNet.Compilation.Abstractions/) |
| OpaDotNet.Compilation.Cli | [](https://www.nuget.org/packages/OpaDotNet.Compilation.Cli/) |
| OpaDotNet.Compilation.Interop | [](https://www.nuget.org/packages/OpaDotNet.Compilation.Interop/) |
## Getting Started
Which one you should be using?
Use `OpaDotNet.Compilation.Cli` if you have `opa` CLI [tool](https://www.openpolicyagent.org/docs/latest/cli) installed or you need functionality besides compilation (running tests, syntax checking etc.). Suitable for web applications and/or applications running in Docker containers. See [README](./src/OpaDotNet.Compilation.Cli) for more details.
Use `OpaDotNet.Compilation.Interop` if you need compilation only and want to avoid having external dependencies. Suitable for libraries, console application etc. See [README](./src/OpaDotNet.Compilation.Interop/README.md) for more details.
For more information you can check the [guide](https://me-viper.github.io/OpaDotNet/articles/compilation/compilation.html).
### Cli
#### Install OpaDotNet.Compilation.Cli nuget package
```sh
dotnet add package OpaDotNet.Compilation.Cli
```
#### Usage
> [!IMPORTANT]
> You will need `opa` cli tool v0.20.0+ to be in your PATH or provide full path in `RegoCliCompilerOptions`.
```csharp
using OpaDotNet.Compilation.Abstractions;
using OpaDotNet.Compilation.Cli;
IRegoCompiler compiler = new RegoCliCompiler();
var bundleStream = await compiler.CompileFile("example.rego", new[] { "example/hello" });
// Use compiled policy bundle.
...
```
### Interop
#### Install OpaDotNet.Compilation.Interop nuget package
```sh
dotnet add package OpaDotNet.Compilation.Interop
```
#### Usage
```csharp
using OpaDotNet.Compilation.Abstractions;
using OpaDotNet.Compilation.Interop;
IRegoCompiler compiler = new RegoInteropCompiler();
var bundleStream = await compiler.CompileFile("example.rego", new[] { "example/hello" });
// Use compiled policy bundle.
...
```
## Building
### Prerequisites
- go lang v1.20
- dotnet SDK 7.0
- opa cli
#### Linux (WSL)
- `gcc` to compile `Opa.Interop.so`
- `gcc-mingw-w64` to compile `Opa.Interop.dll`
#### Windows
> [!NOTE]
> WSL 2.0 is required to compile `Opa.Interop.so` on windows.
- Powershell Core 7.0+
- WSL 2.0
### Build and Test
- Run `build.ps1` Compile [Opa.Interop](./interop/) libraries
- Run `dotnet build` to build the project or use Visual Studio to build `OpaDotNet.Compilation.sln`
- Run `dotnet test` to test the project or use Visual Studio test explorer.
## 3rd Party Libraries and Contributions
- [OPA SDK](https://pkg.go.dev/github.com/open-policy-agent/opa/sdk) - High-level API for embedding OPA inside of Go programs.