Terraform module development tool.

1. Extract variables from main.tf and generate a variables.tf file
2. Find missing variables in variables.tf and main.tf based on each other
3. Generate a module use stub from a variables.tf file
4. Generate a .env or .tfvars file with variables from main.tf
5. Generate HCL with template variables corresponding to variables from a Terraform template
6. Delete extra scratchrelaxtv files

pip install scratchrelaxtv 

Once installed, you can run scratchrelaxtv by typing either relaxtv or scratchrelaxtv.

Find out more about Terraform workflows and using scratchrelaxtv here.

Here are two example workflows using scratchrelaxtv.

Original module development:

1. Write main.tf with whatever variables you need
2. Run scratchrelaxtv to generate variables.tf
3. Fill in descriptions, defaults, etc. in variables.tf
4. Run terraform fmt to prettify everything

Cleanup module:

1. Run scratchrelaxtv in folder with main.tf and variables.tf to find missing variables
2. Using -cf option, automatically add missing vars to variables.tf
3. Fill in descriptions, defaults, etc. in variables.tf for newly added vars
4. Run terraform fmt to prettify everything

By default, scratchrelaxtv looks for main.tf and will generate a variables.tf file. (Use the -i to specify a different input file.) Variables will be in the same order in variables.tf as they were in main.tf. You can sort the variables using the -a (ascending) and -d (descending) options. You can also --force to overwrite an existing variables.tf file. Otherwise, scratchrelaxtv will generate new variables.tf files with each run: variables.1.tf, variables.2.tf and so on.

Assume this main.tf:

resource "aws_s3_bucket" "this" { count = var.create_bucket ? 1 : 0 bucket = var.bucket region = var.region }

Run scratchrelaxtv:

$ relaxtv 2019-04-26 08:02:54,011 - INFO - generating variables file 2019-04-26 08:02:54,011 - INFO - input file: main.tf 2019-04-26 08:02:54,011 - INFO - output file: variables.tf 2019-04-26 08:02:54,011 - INFO - not forcing overwrite of output file 2019-04-26 08:02:54,011 - INFO - not ordering output file

The generated variables.tf:

variable "create_bucket" { description = "" type = string default = "" } variable "bucket" { description = "" type = string default = "" } variable "region" { description = "" type = string default = "" }

Assume you already have a main.tf and a variables.tf. In this example, the variables.tf is missing the region variable.

main.tf:

resource "aws_s3_bucket" "this" { bucket = var.bucket region = var.region }

variables.tf:

variable "bucket" { description = "The bucket where the stuff will be stored" type = string default = "" }

Run scratchrelaxtv to automatically add any missing variables:

$ relaxtv -cf 2019-04-26 08:21:27,289 - INFO - checking for missing variables 2019-04-26 08:21:27,289 - INFO - input file: main.tf 2019-04-26 08:21:27,289 - INFO - output file: variables.tf 2019-04-26 08:21:27,289 - INFO - forcing overwrite of output file 2019-04-26 08:21:27,289 - INFO - not ordering output file 2019-04-26 08:21:27,290 - WARNING - input file main.tf is missing variables: region

Now, the variables.tf looks like this:

variable "bucket" { description = "The bucket where the stuff will be stored" type = string default = "" } variable "region" { description = "" type = string default = "" }

By default, when generating a stub, scratchrelaxtv looks for variables.tf.

Assume this variables.tf:

variable "id" { description = "The ID of the resource" type = string default = "" } variable "bucket" { description = "The bucket where the stuff will be stored" type = string default = "" } variable "region" { description = "The AWS region where the bucket lives" type = string default = "" }

Run scratchrelaxtv with the module stub option:

$ relaxtv -m 2019-04-26 08:09:27,147 - INFO - generating module usage stub 2019-04-26 08:09:27,147 - INFO - input file: variables.tf 2019-04-26 08:09:27,147 - INFO - output file: modstub.tf 2019-04-26 08:09:27,147 - INFO - not forcing overwrite of output file 2019-04-26 08:09:27,147 - INFO - not ordering output file

The generated modstub.tf:

module "tests2" { source = "../tests2" providers = { aws = "aws" } id = local.id bucket = local.bucket region = local.region }

By default, when generating a .tfvars file, scratchrelaxtv looks for variables.tf.

Assume this variables.tf:

resource "aws_s3_bucket" "this" { bucket = var.bucket region = var.region }

Run scratchrelaxtv with the generate .tfvars and sort-ascending options:

$ relaxtv -ta 2019-06-21 20:01:35,362 - INFO - generating .tfvars file 2019-06-21 20:01:35,362 - INFO - input file: variables.tf 2019-06-21 20:01:35,362 - INFO - output file: terraform.tfvars 2019-06-21 20:01:35,362 - INFO - not forcing overwrite of output file 2019-06-21 20:01:35,362 - INFO - ordering output file ascending

The generated terraform.tfvars file:

bucket = "replace" region = "replace" 

By default, when using template mode, scratchrelaxtv looks for template.sh. (Use the -i to specify a different input file.)

Assume this template.sh:

#!/bin/bash build_os="${build_os}" build_type="${build_type}"

Run scratchrelaxtv with the --template and sort-ascending options:

$ relaxtv -a --template 2019-06-21 20:01:35,362 - INFO - extracting template variables 2019-06-21 20:01:35,362 - INFO - input file: template.sh 2019-06-21 20:01:35,362 - INFO - output file: template_vars.tf 2019-06-21 20:01:35,362 - INFO - not forcing overwrite of output file 2019-06-21 20:01:35,362 - INFO - ordering output file ascending

The generated template_vars.tf file:

locals { templates_vars = { build_os = "replace" build_type = "replace" } }

By default, when generating a .env file, scratchrelaxtv looks for variables.tf. (Use the -i to specify a different input file.)

Assume this variables.tf:

resource "aws_s3_bucket" "this" { bucket = var.bucket region = var.region }

Run scratchrelaxtv with the generate .env and sort-ascending options:

$ relaxtv -ea 2019-06-21 20:01:35,362 - INFO - generating .env file 2019-06-21 20:01:35,362 - INFO - input file: variables.tf 2019-06-21 20:01:35,362 - INFO - output file: .env 2019-06-21 20:01:35,362 - INFO - not forcing overwrite of output file 2019-06-21 20:01:35,362 - INFO - ordering output file ascending

The generated .env:

unset "${!TF_VAR_@}" TF_VAR_bucket=replace TF_VAR_region=replace

$ relaxtv -r

scratchrelaxtv can also tidy up your directories by removing its own extra generated files. Presumably it will only remove files you no longer need but be careful. This chart shows examples of what would be deleted or not.

NOTE: scratchrelaxtv removes files in the current directory and subdirectories.

scratchrelaxtv includes help:

$ relaxtv -h usage: scratchrelaxtv [-h] [-i INPUT] [-o OUTPUT] [-f] [-m] [-n MODNAME] [-r]  [-c] [-e] [-t] [--template] [-a | -d] optional arguments:  -h, --help show this help message and exit  -i INPUT, --input INPUT  file to extract vars from  -o OUTPUT, --output OUTPUT  file to write extracted vars to  -f, --force overwrite existing out file  -m, --modstub generate module usage stub  -n MODNAME, --modname MODNAME  name to use in module stub  -r, --remove remove all modstub.tf, variables.#.tf files  -c, --check check that all vars are listed  -e, --env generate .env with Terraform vars  -t, --tfvars generate .tfvars with Terraform vars  --template generate .tf from Terraform template vars  -a, --asc sort output variables in ascending order  -d, --desc sort output variables in descending order