Terraform Provider SonarCloud

A Terraform provider for managing SonarCloud user groups and their permissions.

Requirements

• Terraform >= 0.13.x
• Go >= 1.15
• GoReleaser >= 0.153.x

Installing the Provider locally

1. Clone the repository
2. Enter the repository directory
3. Run make install to build the terraform provider and store it in ~/.terraform/plugins.

Note: this uses Goreleaser under the hood. Alternatively you can use go build and move the binary to the correct location yourself.

Developing the Provider

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

The source files for sending requests to SonarCloud are generated and stored in pkg/. The API is generated based on the contents of gen/services.json, which is the output of https://sonarcloud.io/api/webservices/list. See the AllowedEndpoints in gen/main.go for the list of endpoints that is used for creating API source files. Run make gen to (re)generate the API source files.

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

Run make test to run all unit tests. This should work without further config and not touch any infrastructure.

Run make testacc to run all acceptance tests. This relies on quite a specific test-organization being available in SonarCloud. The project should have the following 3 groups:

• Members (Default) - with 2 members
• Owners (Should be auto-created as well) - with 1 member
• TEST_DONT_REMOVE - with 0 members (see environment variables below to see how to customize this)

Set the following environment variables before running the acceptance test:

Variable	Description
SONAR_ORGANIZATION	The name of the org to run tests against.
SONAR_TOKEN	A token with admin permissions for the organization.