Scaffolding for new Terraform module projects
-
main.tf
,variables.tf
,outputs.tf
files to module root path -
.editorconfig
,.gitignore
,.gitattributes
and.terraform-version
files to module root path -
Option to choose test framework
-
test
directory with an example test based on test framework selection -
.pre-commit-config.yaml
forterraform fmt
,terraform-docs
,check-merge-conflict
and (go fmt
,golint
) /rubocop
-
example
directory with module usage tf files
- terraform
pro tip: use tfenv
- terraform-docs
- pre-commit
- For tests
- To use generator using Docker, Install Docker
recommended
- To use generator using Nodejs, Install nodejs
pro tip: use nvm
To use the included generator execute the below command in shell and provide your answers to the prompts.
> docker run --rm -it -v $(pwd):/generated -e myuid="$(id -u):$(id -g)" sudokar/generator-tf-module
> npx -p yo -p generator-tf-module -c 'yo tf-module'
...
? Enter name for the new terraform module : example-module
? Enter description for the new terraform module : Example terraform module
? Enter author name : sudokar
? Choose terraform version (Use arrow keys)
❯ 0.13
0.12
0.11
? Choose test framework (Use arrow keys)
❯ Terratest
kitchen-terraform
Project layout generated for the new module with Terratest selection
example-module
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .pre-commit-config.yaml
├── .terraform-version
├── README.md
├── main.tf
├── outputs.tf
├── variables.tf
├── example
│ ├── main.tf
│ ├── outputs.tf
│ └── variables.tf
├── test
└── example_test.go
Project layout generated for the new module with kitchen-terraform selection
example-module
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .pre-commit-config.yaml
├── .terraform-version
├── .ruby-version
├── .kitchen.yml
├── Gemfile
├── README.md
├── main.tf
├── outputs.tf
├── variables.tf
├── example
│ ├── main.tf
│ ├── outputs.tf
│ └── variables.tf
├── test
└── integration
└── default
└── example_spec.rb
Step 1
On the generated module's root path, Initialize git repository
git init
Step 2
On the generated module's root path, Install pre-commit hooks
pre-commit install
Step 3 (Applicable only for terratest
)
For golang tests, get below libs
> go get github.com/gruntwork-io/terratest/modules/terraform
> go get github.com/stretchr/testify/assert
Found a bug? feel free to raise an issue.
Pull requests are always welcome. Keen to review and merge asap.
This project is authored and maintained by sudokar
MIT