Merge pull request #501 from alexkappa/patch/DXCDT-12-wiremock

[DXCDT-12] Use wiremock within custom domain verification test

Author: sergiught

.github/workflows/build.yml

@@ -28,16 +28,22 @@ jobs:
     - name: Build
       run: make build
 
+    - name: Start containers
+      run: docker-compose up -d --build
+
     - name: Test
       run: make testacc OPTS=-coverprofile=c.out
       env:
         AUTH0_DOMAIN: ${{ secrets.AUTH0_DOMAIN }}
         AUTH0_CLIENT_ID: ${{ secrets.AUTH0_CLIENT_ID }}
         AUTH0_CLIENT_SECRET: ${{ secrets.AUTH0_CLIENT_SECRET }}
-        DIGITALOCEAN_ACCESS_TOKEN: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }}
 
     - name: Send code coverage report
       uses: aktions/codeclimate-test-reporter@v1
       with:
         codeclimate-test-reporter-id: ${{ secrets.CC_TEST_REPORTER_ID }}
         command: after-build --prefix github.com/alexkappa/terraform-provider-auth0
+
+    - name: Stop containers
+      if: always()
+      run: docker-compose down

CONTRIBUTING.md

@@ -1,17 +1,23 @@
 # Contributing
 
-Before you begin, read through some of the Terraform documentation on [Extending
+Before you begin, read through the Terraform documentation on [Extending
 Terraform](https://www.terraform.io/docs/extend/index.html) and [Writing Custom
 Providers](https://learn.hashicorp.com/collections/terraform/providers).
 
-Finally the [HashiCorp Provider Design
+Finally, the [HashiCorp Provider Design
 Principles](https://www.terraform.io/docs/extend/hashicorp-provider-design-principles.html)
 explore the underlying principles for the design choices of this provider.
 
+## Prerequisites
+
+- [Go 1.13+](https://go.dev/)
+- [Docker](https://docs.docker.com/get-docker/) - used for running acceptance tests.
+- [Docker-Compose](https://docs.docker.com/compose/install/) - used for running acceptance tests.
+
 ## Getting started
 
 To work on the provider, you'll need [Go](http://www.golang.org) installed on
-your machine (version 1.10+ is *required*). You'll also need to correctly setup
+your machine (version 1.13+ is *required*). You'll also need to correctly set up
 a [GOPATH](http://golang.org/doc/code.html#GOPATH), as well as adding
 `$GOPATH/bin` to your `$PATH`.
 
@@ -43,9 +49,8 @@ AUTH0_CLIENT_SECRET=<your-auth0-client-secret>
 Then, run `make testacc`. 
 
 **Note:** The acceptance tests make calls to a real Auth0 tenant, and create
-real resources. Certain tests, for example for custom domains
-(`TestAccCustomDomain`), also require a paid Auth0 subscription to be able to
-run successfully. 
+real resources. Certain tests also require a paid Auth0 subscription to be able to
+run successfully, e.g. `TestAccCustomDomain` and the ones starting with `TestAccLogStream*`.
 
 **Note:** At the time of writing, the following configuration steps are also
 required for the test tenant:
@@ -56,7 +61,7 @@ required for the test tenant:
 ## Documentation
 
 To make it easier to document new resources a handy script is available. The
-script can output documentation of a resource in markdown format, using the 
+script can output documentation of a resource in Markdown format, using the 
 schema of the resource itself.
 
 ```sh
@@ -80,4 +85,4 @@ git push origin vX.Y.Z
 
 This will trigger the
 [Release](https://github.com/alexkappa/terraform-provider-auth0/actions/workflows/release.yml)
-GitHub Action which creates a new release.
+GitHub Action which creates a new release.

GNUmakefile

@@ -22,7 +22,7 @@ test: fmtcheck
 	@echo $(PKGS) | \
 		xargs -t -n4 go test $(TESTARGS) -timeout=30s -parallel=4 -run ^$(TESTS)$
 
-testacc: fmtcheck
+testacc: fmtcheck dev-up
 	@TF_ACC=1 go test $(PKGS) -v $(TESTARGS) -timeout 120m -coverprofile=$(COVERS) -run ^$(TESTS)$
 
 vet:
@@ -46,4 +46,7 @@ errcheck:
 docgen:
 	go run scripts/gendocs.go -resource auth0_<resource>
 
-.PHONY: build test testacc vet fmt fmtcheck errcheck docgen
+dev-up:
+	@docker-compose up -d
+
+.PHONY: build test testacc vet fmt fmtcheck errcheck docgen dev-up