Implement compliance testing with Terraform and Azure

Article
03/20/2023

Terraform enables the definition, preview, and deployment of cloud infrastructure. Using Terraform, you create configuration files using HCL syntax. The HCL syntax allows you to specify the cloud provider - such as Azure - and the elements that make up your cloud infrastructure. After you create your configuration files, you create an execution plan that allows you to preview your infrastructure changes before they're deployed. Once you verify the changes, you apply the execution plan to deploy the infrastructure.

Many times, compliance testing is part of the continuous integration process and is used to ensure that user-defined policies are followed. For example, you might define geopolitical naming conventions for your Azure resources. Another common example is creating virtual machines from a defined subset of images. Compliance testing would be used to enforce rules in these and many other scenarios.

In this article, you learn how to:

Understand when to use compliance testing
Learn how to do a compliance test
See and run an example compliance test

1. Configure your environment

Azure subscription: If you don't have an Azure subscription, create a free account before you begin.

Configure Terraform: If you haven't already done so, configure Terraform using one of the following options:

Docker: Install Docker.
Python: Install Python.
Terraform-compliance tool: Install the Terraform compliance tool by running the following command: pip install terraform-compliance.
Example code and resources: Using the DownGit tool, download from GitHub the compliance-testing project and unzip into a new directory to contain the example code. This directory is referred to as the example directory.

2. Understand compliance testing and checks

Compliance testing is a nonfunctional testing technique to determine if a system meets prescribed standards. Compliance testing is also known as conformance testing.

Most software teams do an analysis to check that the standards are properly enforced and implemented. Often working simultaneously to improve the standards that, in turn, lead to increased quality.

With compliance testing, there are two important concepts to consider: compliance testing and compliance checks.

Compliance testing ensures that the output of each development lifecycle phase conforms to agreed-upon requirements.
Compliance checks should be integrated into the development cycle at the beginning of the projects. Attempting to add compliance checks at a later stage becomes increasingly more difficult when the requirement itself isn't adequately documented.

Doing compliance checks is straight forward. A set of standards and procedures is developed and documented for each phase of the development lifecycle. The output of each phase is compared against the documented requirements. The results of the test are any "gaps" in not conforming to the predetermined standards. Compliance testing is done through the inspection process and the outcome of the review process should be documented.

Let's take a look at a specific example.

A common problem is environments that break when multiple developers apply incompatible changes. Let's say one person works on a change and applies resources such as creating a VM in a test environment. Another person then applies a different version of the code that provisions different version of that VM. What is needed here is oversight to ensure conformity to stated rules.

One way to address this issue would be to define a policy of tagging the resources - such as with role and creator tags. Once you define the policies, a tool like Terraform-compliance is used to ensure the policies are followed.

Terraform-compliance focuses on negative testing. Negative testing is the process of ensuring that a system can gracefully handle unexpected input or unwanted behavior. Fuzzing is an example of negative testing. With fuzzing, a system that receives input is tested to ensure that it can safely handle unexpected input.

Fortunately, Terraform is an abstraction layer for any API that creates, updates, or destroys cloud-infrastructure entities. Terraform also ensures the local configuration and the remote API responses are in synch. Since Terraform is mostly used against Cloud APIs, we still need a way to ensure the code deployed against the infrastructure follows specific policies. Terraform-compliance - a free and open-source tool - provides this functionality for Terraform configurations.

Using the VM example, a compliance policy might be as follows: "If you're creating an Azure resource, it must contain a tag".

The Terraform-compliance tool provides a test framework where you create policies like the example. You then run those policies against your Terraform execution plan.

Terraform-compliance allows you to apply BDD, or behavior-driven development, principles. BDD is a collaborative process where all stakeholders work together to define what a system should do. These stakeholders generally include the developers, testers, and anyone with a vested interest in - or who will be impacted by - the system being developed. The goal of BDD is to encourage teams to build concrete examples that express a common understanding of how the system should behave.

3. Examine a compliance-test example

Previously in this article, you read about a compliance-testing example of creating a VM for a test environment. This section shows how to translate that example into a BDD Feature and Scenario. The rule is first expressed using Cucumber, which is a tool used to support BDD.

when creating Azure resources, every new resource should have a tag

The previous rule is translated as follows:

If the resource supports tags
Then it must contain a tag
And its value must not be null

The Terraform HCL code would then adhere to the rule as follows.

resource "random_uuid" "uuid" {}

resource "azurerm_resource_group" "rg" {
  name     = "rg-hello-tf-${random_uuid.uuid.result}"
  location = var.location

  tags = {
    environment = "dev"
    application = "Azure Compliance"
  } 
}

The first policy could be written as a BDD feature scenario as follows:

Feature: Test tagging compliance  # /target/src/features/tagging.feature
    Scenario: Ensure all resources have tags
        If the resource supports tags
        Then it must contain a tag
        And its value must not be null

The following code shows a test for a specific tag:

Scenario Outline: Ensure that specific tags are defined
    If the resource supports tags
    Then it must contain a tag <tags>
    And its value must match the "<value>" regex

    Examples:
      | tags        | value              |
      | Creator     | .+                 |
      | Application | .+                 |
      | Role        | .+                 |
      | Environment | ^(prod\|uat\|dev)$ |

4. Run the compliance-test example

In this section, you download and test the example.

Within the example directory, navigate to the src directory.
Run terraform init to initialize the working directory.
```
terraform init
```
Run terraform validate to validate the syntax of the configuration files.
```
terraform validate
```
Key points:
- You see a message indicating that the Terraform configuration is valid.
Run terraform plan to create an execution plan.
```
terraform plan -out main.tfplan
```
Run terraform show to convert the execution plan to JSON for the compliance step.
```
terraform show -json main.tfplan > main.tfplan.json
```
Run docker pull to download the terraform-compliance image.
```
docker pull eerkunt/terraform-compliance
```
Run docker run to run the tests in a docker container.
```
docker run --rm -v $PWD:/target -it eerkunt/terraform-compliance -f features -p main.tfplan.json
```
Key points:
- The test will fail because - while the first rule requiring existence of tags succeeds - the second rule fails in that the Role and Creator tags are missing.

Fix the error by modifying main.tf as follows (where a Role and Creator tag are added).

  tags = {
    Environment = "dev"
    Application = "Azure Compliance"
    Creator     = "Azure Compliance"
    Role        = "Azure Compliance"
  }

Key points:

The configuration is now in compliance with the policy.

5. Verify the results

Run terraform validate again to verify the syntax.
```
terraform validate
```
Run terraform plan again to create a new execution plan.
```
terraform plan -out main.tfplan
```
Run terraform show to convert the execution plan to JSON for the compliance step.
```
terraform show -json main.tfplan > main.tfplan.json
```
Run docker run again to test the configuration. If the full spec has been implemented, the test succeeds.
```
docker run --rm -v $PWD:/target -it eerkunt/terraform-compliance -f features -p main.tfplan.json
```
Run terraform apply to apply the execution plan.
```
terraform apply main.tfplan -target=random_uuid.uuid
```
Key points:
- A resource group is created with a name following the pattern: rg-hello-tf-<random_number>.

Troubleshoot Terraform on Azure

Troubleshoot common problems when using Terraform on Azure

Next steps

Learn more about using Terraform in Azure

Share via