@@ -26,8 +26,8 @@ Set up your local environment by installing [Go](http://www.golang.org). Also
2626[ Docker] ( https://docs.docker.com/install/ ) can be used for running tests.
2727
2828## Local Development with Grafana
29- If you develop the provider and want to test locally with your grafana provider
30- 1 . create a ` .terraformrc ` file in your operating system user directory and paste the following
29+ If you develop the provider and want to test locally with your Grafana provider
30+ 1 . Create a ` .terraformrc ` file in your operating system user directory and paste the following
3131```
3232provider_installation {
3333 dev_overrides {
@@ -44,12 +44,18 @@ provider_installation {
4444### Running Tests
4545
4646Acceptance tests require a running instance of Grafana. You can either handle
47- running an instance of Grafana yourself or use ` docker-compose ` .
47+ running an instance of Grafana yourself or use Docker Compose .
4848
49- If you choose ` docker-compose ` , run ` make testacc-docker ` . This is the simplest
50- option, but often not the quickest.
49+ There are Make targets provided for different test scenarios that will start Grafana in Docker Compose automatically.
50+ This is the simplest option, but often not the quickest.
5151
52- Alternatively you can use the ` testacc ` target which will use your local ` go `
52+ To run the OSS tests with Grafana running in Docker Compose:
53+
54+ ``` sh
55+ make testacc-oss-docker
56+ ```
57+
58+ Alternatively, you can use the ` testacc ` target which will use your local ` go `
5359installation:
5460
5561``` sh
@@ -66,6 +72,15 @@ make testacc
6672To run tests for resources which are available only for Grafana Enterprise, running instance of Grafana Enterprise is required.
6773It is only possible to run tests for Grafana Enterprise using local environment.
6874
75+ To run the Enterprise tests with Grafana running in Docker Compose:
76+
77+ ``` sh
78+ make testacc-enterprise-docker
79+ ```
80+
81+ Alternatively, you can use the ` testacc-enterprise ` target which will use your local ` go `
82+ installation:
83+
6984``` sh
7085# Assuming Grafana was run with:
7186# docker run --rm -p 3000:3000 grafana/grafana
@@ -79,13 +94,13 @@ make testacc-enterprise
7994
8095Documentation is generated with
8196[ tfplugindocs] ( https://github.com/hashicorp/terraform-plugin-docs ) . Generated
82- files are in ` docs/ ` and should not be updated manually. They are derived from:
97+ files are in ` docs/ ` and * should not be updated manually* . They are derived from:
8398
8499- Schema ` Description ` fields in the provider Go code.
85100- [ examples/] ( ./examples )
86101- [ templates/] ( ./templates )
87102
88- Use ` go generate ` to update generated docs.
103+ Use ` go generate ./... ` to update generated docs. This will be checked by CI on pull requests to ensure docs are in sync .
89104
90105## Releasing
91106
0 commit comments