DEVELOPING.md

Development

Terraform Plugin Framework

_This template repository is built on the Terraform Plugin Framework. The template repository built on the Terraform Plugin SDK can be found at terraform-provider-scaffolding. See Which SDK Should I Use? in the Terraform documentation for additional information.*

This repository is a template for a Terraform provider. It is intended as a starting point for creating Terraform providers, containing:

• A resource and a data source (internal/provider/),
• Examples (examples/) and generated documentation (docs/),
• Miscellaneous meta files.

These files contain boilerplate code that you will need to edit to create your own Terraform provider. Tutorials for creating Terraform providers can be found on the HashiCorp Developer platform. Terraform Plugin Framework specific guides are titled accordingly.

Please see the GitHub template repository documentation for how to create a new repository from this template on GitHub.

Once you've written your provider, you'll want to publish it on the Terraform Registry so that others can use it.

Adding Dependencies

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
go mod tidy

Then commit the changes to go.mod and go.sum.

Developing the Provider

1. Generate code.

   a. Generate API client code from the OpenAPI spec:

   make gen-spec

   b. Generate mock client code:

   make gen-mock

   Note: The make codegen command runs both gen-spec and gen-mock.

2. Generate or update documentation:

   go generate

3. Run acceptance tests:

   First, you need to setup the environment variables for the acceptance tests. You can use the following commands to set the environment variables:

   export RWC_ENDPOINT=<The account service URL>
   export RWC_API_KEY=<Your API Key>
   export RWC_API_SECRET=<Your API secret>
   

   Then run the acceptance tests:

   make testacc

   Note: Acceptance tests create real resources, and often cost money to run.

   You can also run with a stateful mocking cloud client to test the provider with the acceptance test suites. This is only used for ease of development. The acceptance test above should be used to verify the provider's functionality before releasing.

   make mockacc