CONTRIBUTING.md

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine (version 1.18+ 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 install. This will build the provider and put the provider binary in the $GOPATH/bin directory.

$ make install
...
$ $GOPATH/bin/terraform-provider-orcasecurity
...

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

$ make test

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

Note: Acceptance tests create real resources. You have to be a Orca Security customer to execute them.

Export provider configuration:

export ORCASECURITY_API_ENDPOINT=https://api.orcasecurity.io # US region
export ORCASECURITY_API_TOKEN=YOURSECRETAPITOKEN

$ make testacc

In order to run a specific acceptance test, use the TESTARGS environment variable. For example, the following command will run TestAccAutomationResource_JiraIssue acceptance test only:

$ make testacc TESTARGS='-run=TestAccAutomationResource_JiraIssue'

All acceptance tests for a specific package can be run by setting the PKG_NAME environment variable. For example:

$ make testacc PKG_NAME=orcasecurity/automations

In order to check changes you made locally to the provider, you can use the binary you just compiled by adding the following to your ~/.terraformrc file. This is valid for Terraform 1.0+. Please see Terraform's documentation for more details.

provider_installation {

  # Use /home/yourname/go/bin as an overridden package directory
  # for the orcasecurity/orcasecurity provider. This disables the version and checksum
  # verifications for this provider and forces Terraform to look for the
  # orcasecurity provider plugin in the given directory.
  dev_overrides {
    "orcasecurity/orcasecurity" = "/home/yourname/go/bin"
  }

  # For all other providers, install them directly from their origin provider
  # registries as normal. If you omit this, Terraform will _only_ use
  # the dev_overrides block, and so no other providers will be available.
  direct {}
}

For information about writing acceptance tests, see the main Terraform contributing guide.