feat: Environments

Author: zacharyblasczyk

.env.example

@@ -0,0 +1,17 @@
+# Required environment variables for running acceptance tests
+CTRLPLANE_PROVIDER_TESTING_API_KEY=your_api_key_here
+CTRLPLANE_PROVIDER_TESTING_WORKSPACE=your_workspace_here
+CTRLPLANE_PROVIDER_TESTING_BASE_URL=https://app.ctrlplane.com
+
+# Test configuration
+TF_ACC=1                # Required for running acceptance tests
+TF_LOG=DEBUG           # Optional: Set to DEBUG for verbose logging during tests
+TF_LOG_PATH=./terraform.log  # Optional: Log file path for test output
+
+# Go test configuration
+GO_TEST_TIMEOUT=120m    # Test timeout duration
+GO_TEST_PARALLEL=4      # Number of parallel tests to run
+
+# Optional test configuration
+TF_ACC=1  # Set to 1 to run acceptance tests
+TF_LOG=INFO  # Set to DEBUG for verbose logging during tests 

.gitignore

@@ -33,3 +33,5 @@ website/vendor
 
 # Keep windows files with windows line endings
 *.winfile eol=crlf
+
+.env

GNUmakefile

@@ -12,19 +12,37 @@ lint:
 generate:
 	cd tools; go generate ./...
 
+generate-client:
+	cd client; go generate ./...
+
 fmt:
 	gofmt -s -w -e .
 
 test:
 	go test -v -cover -timeout=120s -parallel=10 ./...
 
 testacc:
-	TF_ACC=1 go test -v -cover -timeout 120m ./...
-
-test-acceptance:
+	@if [ ! -f .env ]; then \
+		echo "Error: .env file not found. Copy .env.example to .env and configure it."; \
+		exit 1; \
+	fi
+	@echo "Running acceptance tests..."
+	source .env && \
 	TF_ACC=1 \
-	CTRLPLANE_TOKEN=$(CTRLPLANE_PROVIDER_TESTING_API_KEY) \
-	CTRLPLANE_WORKSPACE=$(CTRLPLANE_PROVIDER_TESTING_WORKSPACE) \
-	go test -v -cover -timeout 120m ./...
-
-.PHONY: fmt lint test testacc build install generate
+		CTRLPLANE_TOKEN="$${CTRLPLANE_PROVIDER_TESTING_API_KEY}" \
+		CTRLPLANE_WORKSPACE="$${CTRLPLANE_PROVIDER_TESTING_WORKSPACE}" \
+		CTRLPLANE_BASE_URL="$${CTRLPLANE_PROVIDER_TESTING_BASE_URL}" \
+		go test -v \
+		-timeout=$${GO_TEST_TIMEOUT:-120m} \
+		-parallel=$${GO_TEST_PARALLEL:-4} \
+		-cover \
+		./internal/provider/...
+
+# Clean test artifacts
+clean:
+	rm -f terraform.log
+	rm -rf .terraform
+	rm -f .terraform.lock.hcl
+	rm -f terraform.tfstate*
+
+.PHONY: fmt lint test testacc build install generate clean install-local

README.md

@@ -2,7 +2,7 @@
 
 _This template repository is built on the [Terraform Plugin Framework](https://github.com/hashicorp/terraform-plugin-framework). The template repository built on the [Terraform Plugin SDK](https://github.com/hashicorp/terraform-plugin-sdk) can be found at [terraform-provider-scaffolding](https://github.com/hashicorp/terraform-provider-scaffolding). See [Which SDK Should I Use?](https://developer.hashicorp.com/terraform/plugin/framework-benefits) in the Terraform documentation for additional information._
 
-This repository is a *template* for a [Terraform](https://www.terraform.io) provider. It is intended as a starting point for creating Terraform providers, containing:
+This repository is a _template_ for a [Terraform](https://www.terraform.io) provider. It is intended as a starting point for creating Terraform providers, containing:
 
 - A resource and a data source (`internal/provider/`),
 - Examples (`examples/`) and generated documentation (`docs/`),
@@ -57,7 +57,15 @@ To generate or update documentation, run `make generate`.
 
 In order to run the full suite of Acceptance tests, run `make testacc`.
 
-*Note:* Acceptance tests create real resources, and often cost money to run.
+_Note:_ Acceptance tests create real resources, and often cost money to run.
+
+Create a `.env` file with the following environment variables:
+
+```shell
+CTRLPLANE
+CTRLPLANE_PROVIDER_TESTING_API_KEY=your_token_here
+CTRLPLANE_PROVIDER_TESTING_WORKSPACE=your_workspace_here
+```
 
 ```shell
 make testacc