Hashicorp Terraform Rules for Bazel

Overview

This repository contains rules for Hashicrop Terraform.

Setup

Add the following to your WORKSPACE file:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "rules_hashicorp_terraform",
    urls = ["https://github.com/acqio/rules_hashicorp_terraform/archive/<revision>.tar.gz"],
    strip_prefix = "rules_hashicorp_terraform-<revision>",
    sha256 = "rules_hashicorp_terraform-<revision>",
)

load("@rules_hashicorp_terraform//terraform:repositories.bzl", terraform_repositories = "repositories")

terraform_repositories()

load("@rules_hashicorp_terraform//terraform:defs.bzl", "tf_dependencies", "tf_configure")

tf_dependencies()

tf_configure(
    settings = "//:settings.tf",
    # BEGIN OPTIONAL attrs
    # Optional parameters to define the version of the terraform binary to be used.
    # The version and sha256 keys are mandatory.
    repository = {
        "version": "0.14.0",
        "sha256": "07fd7173f7a360ad5e4d5ea5035670cf426cf7a08d0486bc0fe7c9d76b447722",
    },
    # Optional parameters to command execute
    # https://docs.bazel.build/versions/master/skylark/lib/repository_ctx.html#execute).
    quiet = True,
    timeout = 600,
    # Optional parameters to terraform init.
    # https://www.terraform.io/docs/cli/commands/init.htm
    tf_upgrade = True,
    tf_verify_plugins = True,
    tf_log = "NONE",
    # END OPTIONS attrs
)

Terraform settings

This file settings.tf or settgins.tf.json file at the root of your repository. Your content should be Terraform settings.

Its purpose is to declare which minimum version of Terraform is compatible with its HCL code as well as which Providers (plugins) should be available for use.

E.g.

terraform {
    # https://www.terraform.io/docs/language/expressions/version-constraints.html#version-constraint-syntax
    required_version = ">= 0.14.0"
    # https://www.terraform.io/docs/language/providers/requirements.html#requiring-providers
    required_providers {
        null = {
            source = "hashicorp/null"
            version = "3.0.0"
        }
    }
}

A terraform configuration file is also created at the end of the tool set configuration.

This file specifies the filesystem mirror the underlying providers are downloaded.

From this configuration it is possible to declare all providers and reuse in the rules.

NOTE: Just consider declaring in this file settings referring to Terraform Provider as the minimum required version and providers (plugins) to use. Any other configuration may impact the correct functioning of this project and its rules.

Simple usage

The rules_hashicorp_terraform target can be used as executables for custom actions or can be executed directly by Bazel. For example, you can run:

bazel run @terraform//:cli -- -h

Rules

• tf_main
• tf_module
• tf_test
• tf_workspace