Terraform Enterprise Provider
- Website: https://www.terraform.io
- Mailing list: Google Groups
Requirements
Building The Provider
Clone repository to: $GOPATH/src/github.com/terraform-providers/terraform-provider-tfe
$ mkdir -p $GOPATH/src/github.com/terraform-providers; cd $GOPATH/src/github.com/terraform-providers
$ git clone git@github.com:terraform-providers/terraform-provider-tfe
Enter the provider directory and build the provider
$ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-tfe
$ make build
Using the provider
If you're building the provider, follow the instructions to
install it as a plugin.
After placing it into your plugins directory, run terraform init
to initialize it.
Developing the Provider
If you wish to work on the provider, you'll first need Go installed
on your machine (version 1.11+ is required). You'll also need to correctly setup a
GOPATH, as well as adding $GOPATH/bin
to your $PATH
.
To compile the provider, run make build
. This will build the provider and put the provider binary
in the $GOPATH/bin
directory.
$ make build
...
$ $GOPATH/bin/terraform-provider-tfe
...
Testing
1. (Optional) Create a policy sets repo
If you are planning to run the full suite of tests or work on policy sets, you'll need to set up a policy set repository in GitHub.
Your policy set repository will need the following:
- A policy set stored in a subdirectory
- A branch other than master
2. Set up environment variables
To run all tests, you will need to set the following environment variables:
Required:
A hostname and token must be provided in order to run the acceptance tests. By
default, these are loaded from the the credentials
in the CLI config
file. You can override
these values with the environment variables specified below:
TFE_HOSTNAME
- URL of a Terraform Cloud or Terraform Enterprise instance to be used for testing, without the scheme. Example:tfe.local
TFE_TOKEN
- A user API token for an administrator account on the Terraform Cloud or Terraform Enterprise instance being used for testing.
Optional:
TFE_USER1
andTFE_USER2
: The usernames of two pre-existing users on the Terraform Cloud or Terraform Enterprise instance being used for testing. Required for running team membership tests.GITHUB_TOKEN
- GitHub personal access token. Used to establish a VCS provider connection.GITHUB_POLICY_SET_IDENTIFIER
- GitHub policy set repository identifier in the formatusername/repository
. Required for running policy set tests.GITHUB_POLICY_SET_BRANCH
: A GitHub branch for the repository specified byGITHUB_POLICY_SET_IDENTIFIER
. Required for running policy set tests.GITHUB_POLICY_SET_PATH
: A GitHub subdirectory for the repository specified byGITHUB_POLICY_SET_IDENTIFIER
. Required for running policy set tests.
You can set your environment variables up however you prefer. The following are instructions for setting up environment variables using envchain.
-
Make sure you have envchain installed. Instructions for this can be found in the envchain README.
-
Pick a namespace for storing your environment variables. I suggest
terraform-provider-tfe
or something similar. -
For each environment variable you need to set, run the following command:
envchain --set YOUR_NAMESPACE_HERE ENVIRONMENT_VARIABLE_HERE
OR
Set all of the environment variables at once with the following command:
envchain --set YOUR_NAMESPACE_HERE TFE_HOSTNAME TFE_TOKEN TFE_USER1 TFE_USER2 GITHUB_TOKEN GITHUB_POLICY_SET_IDENTIFIER GITHUB_POLICY_SET_BRANCH GITHUB_POLICY_SET_PATH
3. Run the tests
Running the provider tests
With envchain:
$ envchain YOUR_NAMESPACE_HERE make test
Without envchain:
$ make test
Running all the acceptance tests
With envchain:
$ envchain YOUR_NAMESPACE_HERE make testacc
Without envchain:
$ make testacc
Running specific acceptance tests
The commands below use notification configurations as an example.
With envchain:
$ TESTARGS="-run TestAccTFENotificationConfiguration" envchain YOUR_NAMESPACE_HERE make testacc
Without envchain:
$ TESTARGS="-run TestAccTFENotificationConfiguration" make testacc