contributing.md

contributing

Raising bugs, feature requests and PRs is more than welcome!

If you want to jump in and help out, here's the best way to get started

Prerequisites

• docker
• golang
• terraform 1.* and onwards
• make
  • Windows: http://gnuwin32.sourceforge.net/packages/make.htm
  • OSX: brew install make
  • Debian/Ubuntu: apt-get make
• minikube (for testing)

Package dependencies

make init

Building the binary

make build

Tests

Unit Tests

make test

Acceptance Tests

To spin up actual clusters on your machine

make acceptance

Test stack

make set-local
make test-stack

or

make set-local
make build 
terraform -chdir=examples/resources/minikube_cluster apply 

Debugging via vscode

Attaching to the terraform provider binary

To debug your terraform provider, run the Debug Terraform Provider vscode task. This will then output an environment variable that you will need to set in a new shell like so

export TF_REATTACH_PROVIDERS='*output from vscode debug session'
make set-local
make test-stack

Debugging via go entrypoint

You can run a self-contained cluster spin up and teardown via

go run ./hack/main.go *drivername*

Regenerating terradocs / mocks

Any changes to mocked interfaces and schema resources need to be reflected in their generated counter parts

make configure