Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Bisnode/opa-gradle-plugin
Plugin adding various tasks to help out integrating Open Policy Agent (OPA) in Gradle builds.
https://github.com/Bisnode/opa-gradle-plugin
gradle gradle-plugin opa openpolicyagent policies policy rego
Last synced: 3 months ago
JSON representation
Plugin adding various tasks to help out integrating Open Policy Agent (OPA) in Gradle builds.
- Host: GitHub
- URL: https://github.com/Bisnode/opa-gradle-plugin
- Owner: Bisnode
- License: apache-2.0
- Created: 2019-11-12T09:55:16.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-04T09:56:51.000Z (6 months ago)
- Last Synced: 2024-01-20T01:43:21.979Z (6 months ago)
- Topics: gradle, gradle-plugin, opa, openpolicyagent, policies, policy, rego
- Language: Java
- Size: 10 MB
- Stars: 12
- Watchers: 8
- Forks: 4
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-opa - Gradle - OPA plugin for Gradle (Language and Platform Integrations / Java)
README
# Open Policy Agent plugin for Gradle
[](https://lgtm.com/projects/g/Bisnode/opa-gradle-plugin/alerts/)
[](https://lgtm.com/projects/g/Bisnode/opa-gradle-plugin/context:java)
[](https://codecov.io/gh/Bisnode/opa-gradle-plugin)
[](https://plugins.gradle.org/plugin/com.bisnode.opa)
Plugin adding various tasks to help out integrating Open Policy Agent (OPA) in Gradle builds.
## Install
Simply add the plugin to your build.gradle `plugins` declaration:
[](https://plugins.gradle.org/plugin/com.bisnode.opa)
```
plugins {
id 'com.bisnode.opa' version ''
}
```
For legacy versions of Gradle, see instructions in the
[Gradle plugin directory](https://plugins.gradle.org/plugin/com.bisnode.opa).
**Prerequisites**: OPA installed on same machine as the tasks are run, either on `$PATH` or pointed out by the
`location` configuration attribute (see Configuration below).
## Configuration
The following configuration properties are made available by the plugin:
```
opa {
location = 'path/opa/executable' // default: use opa on $PATH
srcDir = 'path/to/rego/src' // default: src/main/rego
testDir = 'path/to/rego/tests/' // default: src/test/rego
}
```
## Tasks
The plugin adds the following tasks:
* `testRego` - Runs `opa test {srcDir} {testDir}` (see below).
* `testRegoCoverage` - Runs `opa test {srcDir} {testDir} --coverage` saving report in `build/report/opa` directory.
* `startOpa` - Start OPA in background for subsequent tasks like integration tests.
* `stopOpa` - Stop OPA process started by `startOpa`.
### testRego
The `testRego` task runs the unit tests found in `testDir` with all policies provided in `srcDir`. If not provided,
these directories default to `src/main/rego` (rego policies) and `src/test/rego` (rego tests) respectively.
When invoked with `--info` output similar to `--info` is printed to console.
Example:
#### JUnit XML test results
The `testRego` task automatically converts the OPA test command output into JUnit XML and writes the output to the
`build/tests-results/opa` directory. This enables any tool or system (such as CI/CD servers) that knows how to parse
JUnit test results to include the OPA test results when handling test outcomes, like when compiling test reports.
Example test report output in Atlassian Bamboo:
### Run Rego tests
To integrate policy tests into your regular Gradle pipeline you may add the `testRego` and/or `testRegoCoverage` tasks
as dependencies of the `check` task:
```
check.dependsOn(testRego, testRegoCoverage)
```
### Run OPA for integration tests
Just start/stop OPA before/after your test suite like this:
```
integrationTest.dependsOn startOpa
integrationTest.finalizedBy stopOpa
```
## Contribution
Interested in contributing? Please, start by reading [this document](https://github.com/Bisnode/opa-gradle-plugin/blob/master/CONTRIBUTING.md).