Merge branch 'main' into bendbennett/issues-16

.changes/unreleased/FEATURES-20230118-100343.yaml

@@ -0,0 +1,6 @@
+kind: FEATURES
+body: 'helper/resource: Added `TF_ACC_PERSIST_WORKING_DIR` environment variable to
+  allow persisting of Terraform files generated during each test step'
+time: 2023-01-18T10:03:43.12743Z
+custom:
+  Issue: "18"

.changes/unreleased/FEATURES-20230123-174450.yaml

@@ -0,0 +1,6 @@
+kind: FEATURES
+body: 'helper/resource: Added `TestCase` type `WorkingDir` field to allow specifying
+  the base directory where testing files used by the testing module are generated'
+time: 2023-01-23T17:44:50.681427Z
+custom:
+  Issue: "18"

.changie.yaml

@@ -1,3 +1,6 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: MPL-2.0
+
 changesDir: .changes
 unreleasedDir: unreleased
 changelogPath: CHANGELOG.md
@@ -14,7 +17,7 @@ kinds:
   - label: BREAKING CHANGES
   - label: NOTES
   - label: FEATURES
-  - label: IMPROVEMENTS
+  - label: ENHANCEMENTS
   - label: BUG FIXES
 newlines:
   afterKind: 1

.github/workflows/ci-go.yml

@@ -21,7 +21,7 @@ jobs:
         with:
           go-version-file: 'go.mod'
       - run: go mod download
-      - uses: golangci/golangci-lint-action@0ad9a0988b3973e851ab0a07adf248ec2e100376 # v3.3.1
+      - uses: golangci/golangci-lint-action@08e2f20817b15149a52b5b3ebe7de50aff2ba8c5 # v3.4.0
   test:
     name: test (Go v${{ matrix.go-version }})
     runs-on: ubuntu-latest

.github/workflows/ci-goreleaser.yml

@@ -18,6 +18,6 @@ jobs:
       - uses: actions/setup-go@6edd4406fa81c3da01a34fa6f6343087c207a568 # v3.5.0
         with:
           go-version-file: 'go.mod'
-      - uses: goreleaser/goreleaser-action@8f67e590f2d095516493f017008adc464e63adb1 # v4.1.0
+      - uses: goreleaser/goreleaser-action@9754a253a8673b0ea869c2e863b4e975497efd0c # v4.1.1
         with:
           args: check

.github/workflows/jira-sync.yml

@@ -0,0 +1,39 @@
+on:
+  issues:
+    types: [closed, deleted, reopened]
+  pull_request_target:
+    types: [closed, reopened]
+
+name: Jira Sync
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    name: Jira sync
+    steps:
+
+    - name: Login
+      uses: atlassian/gajira-login@45fd029b9f1d6d8926c6f04175aa80c0e42c9026 # v3.0.1
+      if: contains(github.event.pull_request.labels.*.name, 'tf-devex-triage') || contains(github.event.issue.labels.*.name, 'tf-devex-triage')
+      env:
+        JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
+        JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
+        JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
+    - name: Search for existing issue
+      id: search
+      if: contains(github.event.pull_request.labels.*.name, 'tf-devex-triage') || contains(github.event.issue.labels.*.name, 'tf-devex-triage')
+      uses: tomhjp/gh-action-jira-search@04700b457f317c3e341ce90da5a3ff4ce058f2fa # v0.2.2
+      with:
+        jql: 'project="TFECO" and "Team (R&D)[Labels]"="TF-DevEx" and description ~ "${{ github.event.issue.html_url || github.event.pull_request.html_url }}" and labels in (Github)'
+    - name: Close task
+      if: ( github.event.action == 'closed' || github.event.action == 'deleted' ) && steps.search.outputs.issue
+      uses: atlassian/gajira-transition@38fc9cd61b03d6a53dd35fcccda172fe04b36de3 # v3.0.1
+      with:
+        issue: ${{ steps.search.outputs.issue }}
+        transition: "Closed"
+    - name: Reopen task
+      if: github.event.action == 'reopened' && steps.search.outputs.issue
+      uses: atlassian/gajira-transition@38fc9cd61b03d6a53dd35fcccda172fe04b36de3 # v3.0.1
+      with:
+        issue: ${{ steps.search.outputs.issue }}
+        transition: "To Do"

.github/workflows/release.yml

@@ -35,14 +35,14 @@ jobs:
         with:
           fetch-depth: 0
       - name: Batch changes
-        uses: miniscruff/changie-action@v0
+        uses: miniscruff/changie-action@7d8e4c245da691d57ca34019a0504321fa7b7e07 # v1.0.0
         with:
           version: latest
           args: batch ${{ needs.changelog-version.outputs.version }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Merge changes
-        uses: miniscruff/changie-action@v0
+        uses: miniscruff/changie-action@7d8e4c245da691d57ca34019a0504321fa7b7e07 # v1.0.0
         with:
           version: latest
           args: merge
@@ -85,7 +85,7 @@ jobs:
         run: |
           cd .changes
           sed -e "1{/# /d;}" -e "2{/^$/d;}" ${{ needs.changelog-version.outputs.version }}.md > /tmp/release-notes.txt
-      - uses: goreleaser/goreleaser-action@8f67e590f2d095516493f017008adc464e63adb1 # v4.1.0
+      - uses: goreleaser/goreleaser-action@9754a253a8673b0ea869c2e863b4e975497efd0c # v4.1.1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:

.github/workflows/send-to-jira.yml

@@ -0,0 +1,37 @@
+on:
+  issues:
+    types: [labeled]
+
+name: Jira Sync
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    name: Jira sync
+    steps:
+
+    - name: Login
+      uses: atlassian/gajira-login@45fd029b9f1d6d8926c6f04175aa80c0e42c9026 # v3.0.1
+      if: github.event.label.name == 'tf-devex-triage'
+      env:
+        JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
+        JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
+        JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
+    - name: Search for existing issue
+      id: search
+      if: github.event.label.name == 'tf-devex-triage'
+      uses: tomhjp/gh-action-jira-search@04700b457f317c3e341ce90da5a3ff4ce058f2fa # v0.2.2
+      with:
+        jql: 'project="TFECO" and "Team (R&D)[Labels]"="TF-DevEx" and description ~ "${{ github.event.issue.html_url || github.event.pull_request.html_url }}" and labels in (Github)'
+
+    - name: Create task in DevEx board
+      if: github.event.label.name == 'tf-devex-triage' && !steps.search.outputs.issue
+      uses: atlassian/gajira-create@59e177c4f6451399df5b4911c2211104f171e669 #v3.0.1
+      with:
+        project: TFECO
+        issuetype: "Task"
+        summary: "[GH] ${{ github.event.issue.title || github.event.pull_request.title }}"
+        description: "${{ github.event.issue.html_url || github.event.pull_request.html_url }} \n Synced by Github Actions, tagged by ${{ github.actor }}"
+        # customfield_10091 is Team (R&D)
+        fields: '{"customfield_10091": ["TF-DevEx"], "labels": ["Github"]}'
+

.gitignore

@@ -1 +1,5 @@
-.idea
+node_modules
+website-preview
+
+.idea
+.vscode/settings.json

.golangci.yml

@@ -0,0 +1,25 @@
+issues:
+  max-per-linter: 0
+  max-same-issues: 0
+
+linters:
+  disable-all: true
+  enable:
+    - durationcheck
+    - errcheck
+    - exportloopref
+    - forcetypeassert
+    - gofmt
+    - gosimple
+    - ineffassign
+    - makezero
+    - misspell
+    - nilerr
+    - paralleltest
+    - predeclared
+    - staticcheck
+    - tenv
+    - unconvert
+    - unparam
+    - unused
+    - vet

.goreleaser.yml

@@ -1,3 +1,6 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: MPL-2.0
+
 project_name: terraform-plugin-testing
 build:
   skip: true

Makefile

@@ -0,0 +1,14 @@
+# Run this if working on the website locally to run in watch mode.
+.PHONY: website
+website:
+	$(MAKE) -C website website
+
+# Use this if you have run `website/build-local` to use the locally built image.
+.PHONY: website/local
+website/local:
+	$(MAKE) -C website website/local
+
+# Run this to generate a new local Docker image.
+.PHONY: website/build-local
+website/build-local:
+	$(MAKE) -C website website/build-local

helper/acctest/random_test.go

@@ -13,13 +13,17 @@ import (
 )
 
 func TestRandIntRange(t *testing.T) {
+	t.Parallel()
+
 	v := RandInt()
 	if vv := RandIntRange(v, v+1); vv != v {
 		t.Errorf("expected RandIntRange(%d, %d) to return %d, got %d", v, v+1, v, vv)
 	}
 }
 
 func TestRandIpAddress(t *testing.T) {
+	t.Parallel()
+
 	testCases := []struct {
 		s           string
 		expected    *regexp.Regexp

helper/resource/id_test.go

@@ -14,6 +14,8 @@ var allDigits = regexp.MustCompile(`^\d+$`)
 var allHex = regexp.MustCompile(`^[a-f0-9]+$`)
 
 func TestUniqueId(t *testing.T) {
+	t.Parallel()
+
 	split := func(rest string) (timestamp, increment string) {
 		return rest[:18], rest[18:]
 	}

helper/resource/plugin_test.go

@@ -244,6 +244,8 @@ func TestSdkProviderFactoriesMerge(t *testing.T) {
 }
 
 func TestRunProviderCommand(t *testing.T) {
+	t.Parallel()
+
 	currentDir, err := os.Getwd()
 
 	if err != nil {
@@ -261,7 +263,7 @@ func TestRunProviderCommand(t *testing.T) {
 			funcCalled = true
 			return nil
 		},
-		helper.RequireNewWorkingDir(ctx, t),
+		helper.RequireNewWorkingDir(ctx, t, ""),
 		&providerFactories{
 			legacy: map[string]func() (*schema.Provider, error){
 				"examplecloud": func() (*schema.Provider, error) { //nolint:unparam // required signature

helper/resource/state_shim.go

@@ -66,19 +66,22 @@ func shimOutputState(so *tfjson.StateOutput) (*terraform.OutputState, error) {
 		case string:
 			elements := make([]interface{}, len(v))
 			for i, el := range v {
+				//nolint:forcetypeassert // Guaranteed by type switch
 				elements[i] = el.(string)
 			}
 			os.Value = elements
 		case bool:
 			elements := make([]interface{}, len(v))
 			for i, el := range v {
+				//nolint:forcetypeassert // Guaranteed by type switch
 				elements[i] = el.(bool)
 			}
 			os.Value = elements
 		// unmarshalled number from JSON will always be json.Number
 		case json.Number:
 			elements := make([]interface{}, len(v))
 			for i, el := range v {
+				//nolint:forcetypeassert // Guaranteed by type switch
 				elements[i] = el.(json.Number)
 			}
 			os.Value = elements

helper/resource/state_test.go

@@ -94,6 +94,8 @@ func UnknownPendingStateRefreshFunc() StateRefreshFunc {
 }
 
 func TestWaitForState_inconsistent_positive(t *testing.T) {
+	t.Parallel()
+
 	conf := &StateChangeConf{
 		Pending:                   []string{"replicating"},
 		Target:                    []string{"done"},
@@ -110,11 +112,14 @@ func TestWaitForState_inconsistent_positive(t *testing.T) {
 	}
 
 	if idx != 4 {
+		//nolint:forcetypeassert // Internal test
 		t.Fatalf("Expected index 4, given %d", idx.(int))
 	}
 }
 
 func TestWaitForState_inconsistent_negative(t *testing.T) {
+	t.Parallel()
+
 	refreshCount := int64(0)
 	f := InconsistentStateRefreshFunc()
 	refresh := func() (interface{}, string, error) {
@@ -151,6 +156,8 @@ func TestWaitForState_inconsistent_negative(t *testing.T) {
 }
 
 func TestWaitForState_timeout(t *testing.T) {
+	t.Parallel()
+
 	old := refreshGracePeriod
 	refreshGracePeriod = 5 * time.Millisecond
 	defer func() {
@@ -183,6 +190,8 @@ func TestWaitForState_timeout(t *testing.T) {
 // Make sure a timeout actually cancels the refresh goroutine and waits for its
 // return.
 func TestWaitForState_cancel(t *testing.T) {
+	t.Parallel()
+
 	// make this refresh func block until we cancel it
 	cancel := make(chan struct{})
 	refresh := func() (interface{}, string, error) {
@@ -238,6 +247,8 @@ func TestWaitForState_cancel(t *testing.T) {
 }
 
 func TestWaitForState_success(t *testing.T) {
+	t.Parallel()
+
 	conf := &StateChangeConf{
 		Pending: []string{"pending", "incomplete"},
 		Target:  []string{"running"},
@@ -255,6 +266,8 @@ func TestWaitForState_success(t *testing.T) {
 }
 
 func TestWaitForState_successUnknownPending(t *testing.T) {
+	t.Parallel()
+
 	conf := &StateChangeConf{
 		Target:  []string{"done"},
 		Refresh: UnknownPendingStateRefreshFunc(),
@@ -271,6 +284,8 @@ func TestWaitForState_successUnknownPending(t *testing.T) {
 }
 
 func TestWaitForState_successEmpty(t *testing.T) {
+	t.Parallel()
+
 	conf := &StateChangeConf{
 		Pending: []string{"pending", "incomplete"},
 		Target:  []string{},
@@ -290,6 +305,8 @@ func TestWaitForState_successEmpty(t *testing.T) {
 }
 
 func TestWaitForState_failureEmpty(t *testing.T) {
+	t.Parallel()
+
 	conf := &StateChangeConf{
 		Pending:        []string{"pending", "incomplete"},
 		Target:         []string{},
@@ -312,6 +329,8 @@ func TestWaitForState_failureEmpty(t *testing.T) {
 }
 
 func TestWaitForState_failure(t *testing.T) {
+	t.Parallel()
+
 	conf := &StateChangeConf{
 		Pending: []string{"pending", "incomplete"},
 		Target:  []string{"running"},
@@ -333,6 +352,8 @@ func TestWaitForState_failure(t *testing.T) {
 }
 
 func TestWaitForStateContext_cancel(t *testing.T) {
+	t.Parallel()
+
 	// make this refresh func block until we cancel it
 	ctx, cancel := context.WithCancel(context.Background())
 	refresh := func() (interface{}, string, error) {