opa_api resource

[edit on GitHub]

Use the opa_api Chef InSpec audit resource to query Open Policy Agent (OPA) using the OPA URL and data.

Availability

Installation

This resource is distributed along with Chef InSpec itself. You can use it automatically.

Syntax

An opa_api resource block declares OPA policy configurations that can be tested.

describe opa_api(url: "localhost:8181/v1/data/example/violation", data: "input.json") do
  its(["result"]) { should eq 'value' }
end

where

• 'url' specifies the url of the OPA server on which OPA is running.
• 'data' specifies the json formatted data or json file.
• its(["returned_result"]) { should eq 'expected_result' } compares the results of the query against the expected result in the test.

parameters

The opa_api resource InSpec resource requires a url and data as a JSON file or a string in JSON format.

url (required)

The URL of the OPA API server.

data (required)

An OPA query as a JSON data file or a string in JSON format.

Properties

result

The result property checks whether the resource query returns an empty result.

its('result') { should be nil }

allow

The allow property checks if a specific input matches the policy defined in OPA. This matcher will not work if allow is not defined in the policy file.

its('allow') { should eq 'value' }

Examples

The following examples show how to use this Chef InSpec audit resource.

describe opa_api(url: "localhost:8181/v1/data/example/allow", data: "input.json") do
  its("result") { shoule_not be nil }
  its(["result"]) { should eq true }
  its("allow") { should eq "true" }
end

The above example shows how the allow value can be fetched in two ways.

Matchers

For a full list of available matchers, please visit our matchers page.