Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 2.39 KB

DEVELOPMENT.md

File metadata and controls

68 lines (46 loc) · 2.39 KB
Raw

Development Environment Setup

Requirements

  • Terraform 1.0.7+ (to run acceptance tests)
  • Go 1.18 (to build the provider plugin)

Quick Start

If you wish to work on the provider, you'll first need Go installed on your machine (please check the requirements before proceeding).

Note: This project uses Go Modules making it safe to work with it outside of your existing GOPATH. The instructions that follow assume a directory in your home directory outside of the standard GOPATH (i.e $HOME/development/terraform-providers/).

Clone repository to: $HOME/development/terraform-providers/

$ mkdir -p $HOME/development/terraform-providers/; cd $HOME/development/terraform-providers/
$ git clone [email protected]:terraform-providers/terraform-provider-awscc
...

Enter the provider directory and run make tools. This will install the needed tools for the provider.

$ make tools

To compile the provider, run make all. This will generate the resources and datasources, build the provider and put the provider binary in the $GOPATH/bin directory.

$ make all
...
$ $GOPATH/bin/terraform-provider-awscc
...

Testing the Provider

In order to test the provider, you can run make test.

Note: Make sure no AWS_ACCESS_KEY_ID or AWS_SECRET_ACCESS_KEY variables are set, and there's no [default] section in the AWS credentials file ~/.aws/credentials.

$ make test

In order to run the full suite of Acceptance tests, run make testacc.

Note: Acceptance tests create real resources, and often cost money to run. At this time all acceptance tests are also generated.

$ make testacc

Using the Provider

Development overrides for provider developers can be leveraged in order to use the provider built from source.

To do this, populate a Terraform CLI configuration file (~/.terraformrc for all platforms other than Windows; terraform.rc in the %APPDATA% directory when using Windows) with at least the following options:

provider_installation {
  dev_overrides {
    "hashicorp/awscc" = "[REPLACE WITH GOPATH]/bin"
  }
  direct {}
}