Skip to content

Write tests against structured configuration data using the Open Policy Agent Rego query language

License

Notifications You must be signed in to change notification settings

zakare0/conftest

 
 

Repository files navigation

Conftest

CircleCI Netlify

Conftest helps you write tests against structured configuration data. Using Conftest you can write tests for your Kubernetes configuration, Tekton pipeline definitions, Terraform code, Serverless configs or any other config files.

Conftest uses the Rego language from Open Policy Agent for writing the assertions. You can read more about Rego in How do I write policies in the Open Policy Agent documentation.

Here's a quick example. Save the following as policy/deployment.rego:

package main

deny[msg] {
  input.kind = "Deployment"
  not input.spec.template.spec.securityContext.runAsNonRoot = true
  msg = "Containers must not run as root"
}

deny[msg] {
  input.kind = "Deployment"
  not input.spec.selector.matchLabels.app
  msg = "Containers must provide app label for pod selectors"
}

Assuming you have a Kubernetes deployment in deployment.yaml you can run Conftest like so:

$ conftest test deployment.yaml
FAIL - deployment.yaml - Containers must not run as root
FAIL - deployment.yaml - Deployments are not allowed

2 tests, 0 passed, 0 warnings, 2 failures

Conftest isn't specific to Kubernetes. It will happily let you write tests for any configuration files in a variety of different formats.

See the documentation for installation instructions and more details about the features. For discussions and questions join us on the Open Policy Agent Slack in the #conftest channel.

About

Write tests against structured configuration data using the Open Policy Agent Rego query language

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 89.7%
  • Shell 8.9%
  • Other 1.4%