Skip to content

Latest commit

 

History

History
73 lines (44 loc) · 3.94 KB

CONTRIBUTING.md

File metadata and controls

73 lines (44 loc) · 3.94 KB
Raw

Contributing

We welcome contributors to this Terraform Provider and we'll do our best to review and merge all requests. Generally adding missing features (as per the Wavefront API or bug fixes will be welcomed, functional changes may probably require some discussion first.

We make use of go-wavefront-management-api to abstract the API from the provider. New features (and possibly bug fixes) will likely require updates to go-wavefront

Steps

  1. Open an Issue - to track the change
  2. Fork the repository
  3. Make your changes
  4. Submit a Pull Request

Resources

  • This is a good blog post by Hashicorp to get started.
  • Looking at how existing Providers work can be useful.
  • This is a good blog post to get some details on how to debug custom terraform provider.

Setup

Ensure you have Go installed and correctly setup.

Fetch your fork of the - repository go get github.com/<your_account>/terraform-provider-wavefront

Build the current version to ensure you're correctly setup make build. This will create two binaries in the form of terraform-provider-wavefront_version_os_arch in the root of the repository, one for Darwin amd64 and one for Linux amd64, if you're using a different operating system or architecture then you will need to update the build step of the makefile to also build a binary for your OS and architecture.

Now that you have a binary you should attempt to run it and expect to see a message similar to the one below.

./terraform-provider-wavefront_v0.1.2_darwin_amd64
This binary is a plugin. These are not meant to be executed directly.
Please execute the program that consumes these plugins, which will
load any plugins automatically

Versioning

We use Semantic Versioning on this project. The version is located inside the version file, in the root of the repository, in the format vMajor.Minor.Patch, update this version as required.

Dependencies

We use Go Vendor to manage dependencies. Any dependencies that you add or update should be reflected within vendor and pushed along with your changes.

Unit Testing

Unit Tests should be written where required and can be run from make test. The core functionality of the provider (Read, Create, Update, Delete and Import of resources is best tested via integration tests) but any supporting function should be unit tested.

make test does not run acceptance tests.

Acceptance Testing

Acceptance Tests are required for the Read, Create, Update, Delete and Import of resources. To run the acceptance tests you should have access to a Wavefront account.

The WAVEFRONT_ADDRESS and WAVEFRONT_TOKEN environment variables are required in order for the tests to run.

export WAVEFRONT_ADDRESS=<your-account>.wavefront.com
export WAVEFRONT_TOKEN=<your-wavefront-token>

make testacc

Formatting

make fmt will ensure that your code is correctly formatted. The build, test and acceptance stages of make will also run a fmt check and let you know if you need to run make fmt

Running Locally

You can test the changes locally by building the plugin make build. Once you have the plugin you should remove the _os_arch from the end of the file name and place it in ~/.terraform.d/plugins which is where terraform init will look for plugins.

Valid provider file names are terraform-provider-NAME_X.X.X or terraform-provider-NAME_vX.X.X