Commit 08a1ee3b authored by Kai Ehrhardt's avatar Kai Ehrhardt
Browse files

feat(job): add terraform fmt checker 

closes #37
parent e4851321

README.md

+23 −11
Original line number Diff line number Diff line
@@ -446,6 +446,18 @@ Save the API key as :lock: `INFRACOST_API_KEY` GitLab secret variable. 


Set `INFRACOST_CURRENCY` variable to set currency [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) prices should be converted to. Defaults to USD.



### `tf fmt` job



The terraform [`fmt` command](https://www.terraform.io/cli/commands/fmt) is usually used to format Terraform source files to a canonical format and style.



This job uses the _check_ mode, and fails if any file appears not being properly formatted. It uses the following variables:





| Name                 | description                                                                                | default value        |

| -------------------- | ------------------------------------------------------------------------------------------ | -------------------- |

| `TF_FMT_ENABLED`     | Set to `true` to enable terraform fmt                                                      | _none_ (disabled)    |

| `TF_FMT_ARGS`        | terraform fmt [options](https://www.terraform.io/cli/commands/fmt#usage)                   | `-diff -recursive`   |



## Variants



The Terraform template can be used in conjunction with template variants to cover specific cases.

kicker.json

+13 −0
Original line number Diff line number Diff line
@@ -146,6 +146,19 @@ 
        }

      ]

    },

    {

      "id": "tffmt",

      "name": "tffmt",

      "description": "Check your Terraform code with [tffmt](https://www.terraform.io/cli/commands/fmt#usage)",

      "enable_with": "TF_FMT_ENABLED",

      "variables": [

        {

          "name": "TF_FMT_ARGS",

          "description": "terraform fmt extra [options](https://www.terraform.io/cli/commands/fmt#usage)",

          "default": "-diff -recursive"

        }

      ]

    },

    {

      "id": "review",

      "name": "Review",

templates/gitlab-ci-terraform.yml

+16 −1
Original line number Diff line number Diff line
@@ -55,6 +55,7 @@ variables: 
  TF_INFRACOST_IMAGE: "infracost/infracost"

  TF_INFRACOST_ARGS: "breakdown"

  TF_INFACOST_USAGE_FILE: "infracost-usage.yml"

  TF_FMT_ARGS: "-diff -recursive"



  # root module directory

  TF_PROJECT_DIR: "."
@@ -736,6 +737,20 @@ tf-infracost: 
      when: never

    - !reference [.test-policy, rules]



tf-fmt:

  extends: .tf-base

  stage: test

  before_script:

    - *tf-scripts

    - cd "$TF_PROJECT_DIR"

  script:

    - terraform fmt -check $TF_FMT_ARGS

  dependencies: []

  rules:

    - if: '$TF_FMT_ENABLED != "true"'

      when: never

    - !reference [.test-policy, rules]



# =============================================================================

# === Review env jobs

# =============================================================================