See the Proofpoint - Meta Networks Provider documentation to get started using the provider.
- Terraform 0.12.x or higher
- Go >= 1.13
- Goreleaser
- Clone the repository
- Enter the repository directory
- Build the provider using the Go
install
command:
$ go install
This provider uses Go modules. Please see the Go documentation for the most up-to-date information about using Go modules.
To add a new dependency github.com/author/dependency
to your Terraform provider:
$ go get github.com/author/dependency
$ make mod-tidy
Then commit the changes to go.mod
and go.sum
.
If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).
To compile and run the provider locally run:
$ make debug-mode
And then export the printed TF_REATTACH_PROVIDERS
as env variable.
This will compile the provider in debug mode and will allow you to execute terraform command with it.
In order to generate or update documentation, run make generate
.
The documentation are auto-generated using the docs generation tool
and are based on the resources descriptions in the schema and on the files in the examples
folder
There are two types of tests that can be executed:
- unit-tests
- acceptance-tests
Acceptance tests are expressed in terms of Test Cases, each using one or more Terraform configurations designed to create a set of resources under test, and then verify the actual infrastructure created.
Note: Acceptance tests create real resources, see more about it here
In order to run the full suite of Acceptance tests:
- Configure the authentication env variables or configuration file specified in provider documentation.
- Execute:
$ make acc_tests
In order to tun unit-tests only run
$ make unittest