https://github.com/terraform-compliance/cli

a lightweight, security focused, BDD test framework against terraform.
https://github.com/terraform-compliance/cli

bdd bdd-style compliance hashicorp infrastructure terraform testing testing-framework

Last synced: 31 minutes ago
JSON representation

a lightweight, security focused, BDD test framework against terraform.

• Host: GitHub
• URL: https://github.com/terraform-compliance/cli
• Owner: terraform-compliance
• License: mit
• Created: 2017-04-02T15:53:29.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-04T11:06:31.000Z (2 months ago)
• Last Synced: 2024-10-29T17:11:41.786Z (about 1 month ago)
• Topics: bdd, bdd-style, compliance, hashicorp, infrastructure, terraform, testing, testing-framework
• Language: Python
• Homepage: https://terraform-compliance.com
• Size: 22 MB
• Stars: 1,356
• Watchers: 36
• Forks: 152
• Open Issues: 96
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-repositories - terraform-compliance/cli - a lightweight, security focused, BDD test framework against terraform. (Python)
• awesome-tf - terraform-compliance - BDD Testing for Terraform Files. (Testing / Community providers)
• jimsghstars - terraform-compliance/cli - a lightweight, security focused, BDD test framework against terraform. (Python)

README

        
terraform-compliance




  

  

    

  

  

  

  

    

  


  

  

    

  

  

  

    

  

  

  

    

  









`terraform-compliance` is a lightweight, security and compliance focused test framework against terraform to enable negative testing capability for your infrastructure-as-code.

- __compliance:__ Ensure the implemented code is following security standards, your own custom standards

- __behaviour driven development:__ We have BDD for nearly everything, why not for IaC ?

- __portable:__ just install it from `pip` or run it via `docker`. See [Installation](https://terraform-compliance.com/pages/installation/)

- __pre-deploy:__ it validates your code before it is deployed

- __easy to integrate:__ it can run in your pipeline (or in git hooks) to ensure all deployments are validated.

- __segregation of duty:__ you can keep your tests in a different repository where a separate team is responsible. 

- __why ?:__ why not ?

## Performance

If terraform-compliance is not running quickly enough make sure to check the

optional faster\_parsing pip install flag in the [Installation Guide](https://terraform-compliance.com/pages/installation/)

## Idea

`terraform-compliance` mainly focuses on [negative testing](https://en.wikipedia.org/wiki/Negative_testing) instead

of having fully-fledged [functional tests](https://en.wikipedia.org/wiki/Functional_testing) that are mostly used for

proving a component of code is performing properly. 

Fortunately, `terraform` is a marvellous abstraction layer for any API 

that __creates__/__updates__/__destroys__ entities. `terraform` also provides the 

[capability](https://www.terraform.io/docs/commands/plan.html#detailed-exitcode) 

to ensure everything is up-to-date between the local configuration and the remote API(s) responses. 

Given the fact, `terraform` is used mostly against Cloud APIs, what was missing is to ensure 

your code against your infrastructure must follow specific policies. Currently HashiCorp provides 

[Sentinel](https://www.hashicorp.com/sentinel/) for Enterprise Products. `terraform-compliance` is providing a 

similar functionality only for `terraform` while it is free-to-use and it is Open Source.

E.g. a sample policy could be, if you are working with `AWS`, you should not create an `S3 bucket`, 

without having any `encryption`. Of course, this is just an example which may or not be applicable 

for your case.

`terraform-compliance` provides a test framework to create these policies that will be executed against 

your [terraform plan](https://www.terraform.io/docs/commands/plan.html) in a context where both 

developers and security teams can understand easily while reading it, by applying [Behaviour Driven 

Development](https://en.wikipedia.org/wiki/Behavior-driven_development) Principles.

As returning back to the example, our example defined above will be translated into a BDD Feature 

and Scenario, as also seen in below ;

```

if you are working with AWS, you should not create an S3 bucket, without having any encryption

```

translates into ;

```gherkin

Given I have AWS S3 Bucket defined

Then it must contain server_side_encryption_configuration

```

`server_side_encryption_configuration` is coming from the terraform code, as shown below ;

```

resource "aws_s3_bucket" "b" {

  bucket = "my-bucket"

  acl    = "private"

  server_side_encryption_configuration {

    rule {

      apply_server_side_encryption_by_default {

        kms_master_key_id = "${aws_kms_key.mykey.arn}"

        sse_algorithm     = "aws:kms"

      }

    }

  }

}

```

This policy ( Scenario ) will allow all S3 buckets newly created or updated must have encryption configuration set within the code. In an ideal way, this Scenario (among with all other Scenarios) will run on a CI/CD pipeline that will ensure that nothing is deployed by violating your policies.

See [Examples](https://terraform-compliance.com/pages/Examples/) for more sample use cases.

Regarding the feature file format - `radish` is used to parse files with extension `.feature` - https://radish.readthedocs.io/en/stable/tutorial.html

![Example Run](https://github.com/eerkunt/terraform-compliance/blob/master/terraform-compliance-demo.gif?raw=true)

## Sponsors

* [resmo.com](resmo.com): Discover unmatched insights for Cloud and SaaS assets. Use SQL to ask questions and get real-time notifications for security and compliance violations.

## License

[MIT](https://tldrlegal.com/license/mit-license)