Terraform Provider: Zendesk

Important

Read the contribution guideline before adding a pull request.

• Zendesk Terraform Provider
  • Developing the Provider
    • Adding and Updating Dependencies
    • Documentation Generation
    • Testing
      • Acceptance Testing

Developing the Provider

If you wish to work on the provider, you'll first need Go installed on your machine ( see Requirements above).

To compile the provider, run go install. This will build the provider and put the provider binary in the $GOPATH/bin directory.

Adding and Updating 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

To update an existing dependency:

go get -u github.com/author/dependency
go mod tidy

In either case, commit the changes to go.mod and go.sum.

Documentation Generation

Important

This is required when making any schema changes, as the pipeline will fail if docs are not updated in PR To generate or update documentation, run go generate ./....

Testing

This project contains both unit and acceptance tests. See below on running.

Unit Testing

To run unit tests, run:

  task test

Acceptance Testing

Caution

In order to run acceptance tests, the following environment variables must be set in a .env file:

Name	Description
ZENDESK_SUBDOMAIN	Zendesk subdomain, ex: dynatrace
ZENDESK_USERNAME	Zendesk username used for basic token auth.
ZENDESK_API_TOKEN	API token used for Zendesk basic token auth.

Once these variables are set, please run following command:

  task test ACC=true

This will run all tests including acceptance tests. To run acceptance tests only, run:

  task test ACC_ONLY=true