Saving my place

Author: rainkwan

querycheck/additional_cli_options.go

@@ -0,0 +1,29 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package querycheck
+
+// AdditionalCLIOptions allows an intentionally limited set of options to be passed
+// to the Terraform CLI when executing test steps.
+type AdditionalCLIOptions struct {
+	// Apply represents options to be passed to the `terraform apply` command.
+	Apply ApplyOptions
+
+	// Plan represents options to be passed to the `terraform plan` command.
+	Plan PlanOptions
+}
+
+// ApplyOptions represents options to be passed to the `terraform apply` command.
+type ApplyOptions struct {
+	// AllowDeferral will pass the experimental `-allow-deferral` flag to the apply command.
+	AllowDeferral bool
+}
+
+// PlanOptions represents options to be passed to the `terraform plan` command.
+type PlanOptions struct {
+	// AllowDeferral will pass the experimental `-allow-deferral` flag to the plan command.
+	AllowDeferral bool
+
+	// NoRefresh will pass the `-refresh=false` flag to the plan command.
+	NoRefresh bool
+}

querycheck/contains_name_test.go

@@ -1,37 +1,34 @@
-package querycheck_test
+package querycheck
 
 import (
+	"regexp"
+	"testing"
+
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
-	r "github.com/hashicorp/terraform-plugin-testing/helper/resource"
 	"github.com/hashicorp/terraform-plugin-testing/internal/testing/testprovider"
 	"github.com/hashicorp/terraform-plugin-testing/internal/testing/testsdk/providerserver"
-	"github.com/hashicorp/terraform-plugin-testing/querycheck"
 	"github.com/hashicorp/terraform-plugin-testing/tfversion"
-	"regexp"
-	"testing"
 )
 
 func TestContainsResourceWithName(t *testing.T) {
 	t.Parallel()
 
-	r.UnitTest(t, r.TestCase{
+	UnitTest(t, TestCase{
 		TerraformVersionChecks: []tfversion.TerraformVersionCheck{
 			tfversion.SkipBelow(tfversion.Version1_14_0),
 		},
 		ProtoV6ProviderFactories: map[string]func() (tfprotov6.ProviderServer, error){
 			"examplecloud": providerserver.NewProviderServer(testprovider.Provider{
 				ListResources: map[string]testprovider.ListResource{
-
 					// TODO: define a simpler resource and list resource here or copy the `examplecloud_test.go` and `examplecloud_list_resource.go` files here for use
-
-					//"examplecloud_containerette": examplecloudListResource(),
+					"examplecloud_containerette": examplecloudListResource(),
 				},
 				Resources: map[string]testprovider.Resource{
-					//"examplecloud_containerette": examplecloudResource(),
+					"examplecloud_containerette": examplecloudResource(),
 				},
 			}),
 		},
-		Steps: []r.TestStep{
+		Steps: []TestStep{
 			// We'll skip the first test step where we simulate creating the resource that will be returned when we query for it for simplicity.
 			{
 				Query: true,
@@ -54,13 +51,13 @@ func TestContainsResourceWithName(t *testing.T) {
 					}
 				}
 				`,
-				QueryResultChecks: []querycheck.QueryResultCheck{
-					querycheck.ContainsResourceWithName("examplecloud_containerette.test", "banane"),
-					querycheck.ContainsResourceWithName("examplecloud_containerette.test", "ananas"),
-					querycheck.ContainsResourceWithName("examplecloud_containerette.test", "kiwi"),
-					querycheck.ContainsResourceWithName("examplecloud_containerette.test2", "papaya"),
-					querycheck.ContainsResourceWithName("examplecloud_containerette.test2", "birne"),
-					querycheck.ContainsResourceWithName("examplecloud_containerette.test2", "kirsche"),
+				QueryResultChecks: []QueryResultCheck{
+					ContainsResourceWithName("examplecloud_containerette.test", "banane"),
+					ContainsResourceWithName("examplecloud_containerette.test", "ananas"),
+					ContainsResourceWithName("examplecloud_containerette.test", "kiwi"),
+					ContainsResourceWithName("examplecloud_containerette.test2", "papaya"),
+					ContainsResourceWithName("examplecloud_containerette.test2", "birne"),
+					ContainsResourceWithName("examplecloud_containerette.test2", "kirsche"),
 				},
 			},
 		},
@@ -71,24 +68,22 @@ func TestContainsResourceWithName(t *testing.T) {
 func TestContainsResourceWithName_NotFound(t *testing.T) {
 	t.Parallel()
 
-	r.UnitTest(t, r.TestCase{
+	UnitTest(t, TestCase{
 		TerraformVersionChecks: []tfversion.TerraformVersionCheck{
 			tfversion.SkipBelow(tfversion.Version1_14_0),
 		},
 		ProtoV6ProviderFactories: map[string]func() (tfprotov6.ProviderServer, error){
 			"examplecloud": providerserver.NewProviderServer(testprovider.Provider{
 				ListResources: map[string]testprovider.ListResource{
-
-					// TODO: define a resource and list resource here or copy the `examplecloud_test.go` and `examplecloud_list_resource.go` files here for use
-
-					//"examplecloud_containerette": examplecloudListResource(),
+					// TODO: define a simpler resource and list resource here or copy the `examplecloud_test.go` and `examplecloud_list_resource.go` files here for use
+					"examplecloud_containerette": examplecloudListResource(),
 				},
 				Resources: map[string]testprovider.Resource{
-					//"examplecloud_containerette": examplecloudResource(),
+					"examplecloud_containerette": examplecloudResource(),
 				},
 			}),
 		},
-		Steps: []r.TestStep{
+		Steps: []TestStep{
 			{
 				Query: true,
 				Config: `
@@ -110,8 +105,8 @@ func TestContainsResourceWithName_NotFound(t *testing.T) {
 					}
 				}
 				`,
-				QueryResultChecks: []querycheck.QueryResultCheck{
-					querycheck.ContainsResourceWithName("examplecloud_containerette.test", "pflaume"),
+				QueryResultChecks: []QueryResultCheck{
+					ContainsResourceWithName("examplecloud_containerette.test", "pflaume"),
 				},
 				// TODO update expected error message to match what we output
 				ExpectError: regexp.MustCompile("examplecloud_containerette.test - there are no pflaumen here!"),

querycheck/environment_variables.go

@@ -0,0 +1,45 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package querycheck
+
+// Environment variables for acceptance testing. Additional environment
+// variable constants can be found in the internal/plugintest package.
+const (
+	// Environment variable to enable acceptance tests using this package's
+	// ParallelTest and Test functions whose TestCase does not enable the
+	// IsUnitTest field. Defaults to disabled, in which each test will call
+	// (*testing.T).Skip(). Can be set to any value to enable acceptance tests,
+	// however "1" is conventional.
+	EnvTfAcc = "TF_ACC"
+
+	// Environment variable with hostname for the provider under acceptance
+	// test. The hostname is the first portion of the full provider source
+	// address, such as "example.com" in example.com/myorg/myprovider. Defaults
+	// to "registry.terraform.io".
+	//
+	// Only required if any Terraform configuration set via the TestStep
+	// type Config field includes a provider source, such as the terraform
+	// configuration block required_providers attribute.
+	EnvTfAccProviderHost = "TF_ACC_PROVIDER_HOST"
+
+	// Environment variable with namespace for the provider under acceptance
+	// test. The namespace is the second portion of the full provider source
+	// address, such as "myorg" in registry.terraform.io/myorg/myprovider.
+	// Defaults to "-" for Terraform 0.12-0.13 compatibility and "hashicorp".
+	//
+	// Only required if any Terraform configuration set via the TestStep
+	// type Config field includes a provider source, such as the terraform
+	// configuration block required_providers attribute.
+	EnvTfAccProviderNamespace = "TF_ACC_PROVIDER_NAMESPACE"
+
+	// This is an undocumented compatibility flag. When this is set, a
+	// `Config`-mode test step will invoke a refresh before successful
+	// completion.
+	//
+	// This is a compatibility measure for test cases that have different --
+	// but semantically-equal -- state representations in their test steps.
+	// When comparing two states, the testing framework is not aware of
+	// semantic equality or set equality.
+	EnvTfAccRefreshAfterApply = "TF_ACC_REFRESH_AFTER_APPLY"
+)