Merge pull request #74 from sullivtr/iss-70-opt-out-remote-state-verify

conditionalize remote-state verification logic, and add simple test

Author: sullivtr

.github/workflows/acceptance.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -27,12 +27,12 @@ jobs:
           terraform_wrapper: false
 
       - name: Run test
-        run: go test -v ./... | awk '!/\[no test files\]/ {print}'
+        run: go test -v -coverprofile=cover.out ./... | awk '!/\[no test files\]/ {print}'
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
-          file: ./cp.out
+          file: ./cover.out
           name: codecov-umbrella
           fail_ci_if_error: false

.github/workflows/build.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   goreleaser:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -29,7 +29,7 @@ jobs:
       - name: Build
         uses: goreleaser/goreleaser-action@v2
         with:
-          version: latest
+          version: 1.5.0
           args: release --snapshot --skip-validate --skip-publish
         env:
           GPG_FINGERPRINT: ${{ steps.import_gpg.outputs.fingerprint }}

.github/workflows/e2e.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -29,8 +29,10 @@ jobs:
       - name: Build
         uses: goreleaser/goreleaser-action@v2
         with:
-          version: latest
+          version: 1.5.0
           args: release --snapshot --skip-validate --skip-publish --skip-sign -f .goreleaser-e2e-build.yml
 
       - name: Run test
-        run: make test
+        run: |
+          make copyplugins
+          make test

.github/workflows/release.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   goreleaser:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -28,7 +28,7 @@ jobs:
       - name: Release
         uses: goreleaser/goreleaser-action@v2
         with:
-          version: latest
+          version: 1.5.0
           args: release --rm-dist
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

GNUmakefile

@@ -26,16 +26,16 @@ build: clean fetch ## publishes in dry run mode
 copyplugins: ## copy plugins to test folders
 	$(eval COPY_FILES := $(filter %/, $(wildcard ./dist/terraform-provider-graphql*/)))
 	$(eval OS_ARCH := $(patsubst ./dist/terraform-provider-graphql_%/, %, $(COPY_FILES)))
-	$(eval TEST_FOLDERS := $(foreach p,$(OS_ARCH), $(patsubst %,%terraform.d/plugins/terraform.example.com/examplecorp/graphql/2.0.0/$p,$(TEST_DESTS))))
+	$(eval TEST_FOLDERS := $(foreach p,$(OS_ARCH), $(patsubst %,%terraform.d/plugins/gqlprovidertf.com/examplecorp/graphql/2.0.0/$p,$(TEST_DESTS))))
 	@sleep 1
 	@mkdir -p $(TEST_FOLDERS);
 	@for o in $(OS_ARCH); do \
 		for f in $(TEST_DESTS); do \
-	    	cp ./dist/terraform-provider-graphql_$$o/* $$f/terraform.d/plugins/terraform.example.com/examplecorp/graphql/2.0.0/$$o; \
+	    	cp ./dist/terraform-provider-graphql_$$o/* $$f/terraform.d/plugins/gqlprovidertf.com/examplecorp/graphql/2.0.0/$$o; \
 		done; \
 	done
 
-test: copyplugins ## test
+test: ## test
 	@cd e2e && $(MAKE) test
 
 fulltest: build test ## build and test

cp.out

@@ -48,6 +48,7 @@ resource "graphql_mutation" "basic_mutation" {
 * `compute_mutation_keys` - (Required) A map representing the hierarchy of your response object leading to the object properties that will be used during a terraform destroy & update operation.
 * `compute_from_create` - A bool to determine if computed keys should be computed based off of the response from the create request, or the read request. Default: false
 * `force_replace` - A bool to determine if the resource should always be replaced (deleted and recreated) during update lifecycle hooks. Default: false
+* `enable_remote_state_verification` - A pre v2.4.0 backward-compatibility flag. Set to `false` to disable resource remote state verification during reads.
 
 
 ## Attribute Reference

docs/resources/mutation.md

@@ -60,6 +60,50 @@ func TestBasicCreateUpdateMutations(t *testing.T) {
 	assert.NoFileExists(t, "./gql-server/test.json")
 }
 
+func TestBasicCreateUpdateMutationsRemoteStateVerificationDisabled(t *testing.T) {
+
+	varFileCreate := []string{"./variable_initial_create_remote_state_verify_disabled.tfvars"}
+	varFileUpdate := []string{"./variable_update.tfvars"}
+	terraformOptionsCreate := &terraform.Options{
+		// Set the path to the Terraform code that will be tested.
+		TerraformDir: "./test_basic",
+		VarFiles:     varFileCreate,
+		Logger:       logger.Discard,
+	}
+
+	terraformOptionsUpdate := &terraform.Options{
+		TerraformDir: "./test_basic",
+		VarFiles:     varFileUpdate,
+		Logger:       logger.Discard,
+	}
+
+	// Ensure workspace is clean
+	assert.NoFileExists(t, "./gql-server/test.json")
+
+	terraform.InitAndApply(t, terraformOptionsCreate)
+
+	// Validate creation
+	assert.FileExists(t, "./gql-server/test.json")
+
+	// Validate data source output
+	dataSourceOutput, _ := terraform.OutputJsonE(t, terraformOptionsCreate, "query_output")
+	assert.Contains(t, dataSourceOutput, initialTextOutput)
+
+	// Validate computed delete variables
+	deleteVariableOutput, _ := terraform.OutputJsonE(t, terraformOptionsCreate, "computed_delete_variables")
+	assert.Contains(t, deleteVariableOutput, idOutPut)
+	assert.Contains(t, deleteVariableOutput, testVarComputed)
+
+	// Run update & validate changes
+	terraform.InitAndApply(t, terraformOptionsUpdate)
+	updatedOutput, _ := terraform.OutputJsonE(t, terraformOptionsUpdate, "query_output")
+	assert.Contains(t, updatedOutput, updatedTextOutput)
+	assert.NotContains(t, updatedOutput, initialTextOutput)
+
+	terraform.Destroy(t, terraformOptionsUpdate)
+	assert.NoFileExists(t, "./gql-server/test.json")
+}
+
 func TestBasicForceReplace(t *testing.T) {
 
 	varFileCreate := []string{"./variable_initial_create.tfvars"}

e2e/basic_test.go

@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     graphql = {
-      source  = "terraform.example.com/examplecorp/graphql"
+      source  = "gqlprovidertf.com/examplecorp/graphql"
       version = "2.0.0"
     }
   }

e2e/test_basic/test.tf

@@ -0,0 +1,8 @@
+todo_text = "Here is something todo"
+todo_user_id = "T5577006791947779410"
+
+compute_mutation_keys = {
+    "id" = "todo.id"
+}
+compute_from_create = false
+enable_remote_state_verification = false