cvm: fix tag/field SkipImageValidation conflicts (#97)

lbajolet-hashicorp · nywilken · web-flow · commit a7c545153fef · 2023-06-16T14:18:48.000-04:00
* cvm: fix tag/field SkipImageValidation conflicts

The `SkipImageValidation' field and its tag, `skip_region_validation`,
was duplicated in two structures, `TencentCloudImageConfig`, and
`TencentCloudAccessConfig`.

This resulted in unexpected behaviour, as setting the attribute in a
template will set the config for both substructures for JSON templates,
while on HCL templates, only one would be settable.

To fix this discrepancy, we mutualise the field as a config argument for
the global configuration object, and propagate its value to the
appropriate configuration structures. This way, region validation can
be skipped for both the AccessConfig, and the ImageConfig, in all cases.

* Bump github.com/hashicorp/packer-plugin-sdk@v0.4.0

---------

Co-authored-by: Wilken Rivera &lt;dev@wilkenrivera.com&gt;
diff --git a/builder/tencentcloud/cvm/access_config.go b/builder/tencentcloud/cvm/access_config.go
@@ -65,14 +65,13 @@ type TencentCloudAccessConfig struct {
 	// reference Region and Zone
 	//  for parameter taking.
 	Zone string `mapstructure:"zone" required:"true"`
-	// Do not check region and zone when validate.
-	SkipValidation bool `mapstructure:"skip_region_validation" required:"false"`
 	// The endpoint you want to reach the cloud endpoint,
 	// if tce cloud you should set a tce cvm endpoint.
 	CvmEndpoint string `mapstructure:"cvm_endpoint" required:"false"`
 	// The endpoint you want to reach the cloud endpoint,
 	// if tce cloud you should set a tce vpc endpoint.
-	VpcEndpoint string `mapstructure:"vpc_endpoint" required:"false"`
+	VpcEndpoint    string `mapstructure:"vpc_endpoint" required:"false"`
+	skipValidation bool
 }
 
 func (cf *TencentCloudAccessConfig) Client() (*cvm.Client, *vpc.Client, error) {
@@ -132,7 +131,7 @@ func (cf *TencentCloudAccessConfig) Prepare(ctx *interpolate.Context) []error {
 
 	if cf.Region == "" {
 		errs = append(errs, fmt.Errorf("parameter region must be set"))
-	} else if !cf.SkipValidation {
+	} else if !cf.skipValidation {
 		if err := cf.validateRegion(); err != nil {
 			errs = append(errs, err)
 		}
diff --git a/builder/tencentcloud/cvm/access_config_test.go b/builder/tencentcloud/cvm/access_config_test.go
@@ -27,7 +27,7 @@ func TestTencentCloudAccessConfig_Prepare(t *testing.T) {
 		t.Fatal("should raise error: unknown region")
 	}
 
-	cf.SkipValidation = true
+	cf.skipValidation = true
 	if err := cf.Prepare(nil); err != nil {
 		t.Fatalf("shouldn't raise error: %v", err)
 	}
diff --git a/builder/tencentcloud/cvm/builder.go b/builder/tencentcloud/cvm/builder.go
@@ -27,6 +27,9 @@ type Config struct {
 	TencentCloudImageConfig  `mapstructure:",squash"`
 	TencentCloudRunConfig    `mapstructure:",squash"`
 
+	// Do not check region and zone when validate.
+	SkipRegionValidation bool `mapstructure:"skip_region_validation" required:"false"`
+
 	ctx interpolate.Context
 }
 
@@ -53,6 +56,10 @@ func (b *Builder) Prepare(raws ...interface{}) ([]string, []string, error) {
 		return nil, nil, err
 	}
 
+	// Propagate SkipRegionValidation to Access/Image configs
+	b.config.TencentCloudAccessConfig.skipValidation = b.config.SkipRegionValidation
+	b.config.TencentCloudImageConfig.skipValidation = b.config.SkipRegionValidation
+
 	// Accumulate any errors
 	var errs *packersdk.MultiError
 	errs = packersdk.MultiErrorAppend(errs, b.config.TencentCloudAccessConfig.Prepare(&b.config.ctx)...)
diff --git a/builder/tencentcloud/cvm/builder.hcl2spec.go b/builder/tencentcloud/cvm/builder.hcl2spec.go
diff --git a/builder/tencentcloud/cvm/image_config.go b/builder/tencentcloud/cvm/image_config.go
@@ -34,10 +34,9 @@ type TencentCloudImageConfig struct {
 	// accounts that will be shared to
 	// after your image created.
 	ImageShareAccounts []string `mapstructure:"image_share_accounts" required:"false"`
-	// Do not check region and zone when validate.
-	SkipValidation bool `mapstructure:"skip_region_validation" required:"false"`
 	// Key/value pair tags that will be applied to the resulting image.
-	ImageTags map[string]string `mapstructure:"image_tags" required:"false"`
+	ImageTags      map[string]string `mapstructure:"image_tags" required:"false"`
+	skipValidation bool
 }
 
 func (cf *TencentCloudImageConfig) Prepare(ctx *interpolate.Context) []error {
@@ -65,7 +64,7 @@ func (cf *TencentCloudImageConfig) Prepare(ctx *interpolate.Context) []error {
 
 			regionSet[region] = struct{}{}
 
-			if !cf.SkipValidation {
+			if !cf.skipValidation {
 				if err := validRegion(region); err != nil {
 					errs = append(errs, err)
 					continue
diff --git a/builder/tencentcloud/cvm/image_config_test.go b/builder/tencentcloud/cvm/image_config_test.go
@@ -30,7 +30,7 @@ func TestTencentCloudImageConfig_Prepare(t *testing.T) {
 		t.Fatal("should have err")
 	}
 
-	cf.SkipValidation = true
+	cf.skipValidation = true
 	if err := cf.Prepare(nil); err != nil {
 		t.Fatalf("shouldn't have err:%v", err)
 	}
diff --git a/docs-partials/builder/tencentcloud/cvm/TencentCloudAccessConfig-not-required.mdx b/docs-partials/builder/tencentcloud/cvm/TencentCloudAccessConfig-not-required.mdx
@@ -1,7 +1,5 @@
 <!-- Code generated from the comments of the TencentCloudAccessConfig struct in builder/tencentcloud/cvm/access_config.go; DO NOT EDIT MANUALLY -->
 
-- `skip_region_validation` (bool) - Do not check region and zone when validate.
-
 - `cvm_endpoint` (string) - The endpoint you want to reach the cloud endpoint,
   if tce cloud you should set a tce cvm endpoint.
 
diff --git a/docs-partials/builder/tencentcloud/cvm/TencentCloudImageConfig-not-required.mdx b/docs-partials/builder/tencentcloud/cvm/TencentCloudImageConfig-not-required.mdx
@@ -18,8 +18,6 @@
 - `image_share_accounts` ([]string) - accounts that will be shared to
   after your image created.
 
-- `skip_region_validation` (bool) - Do not check region and zone when validate.
-
 - `image_tags` (map[string]string) - Key/value pair tags that will be applied to the resulting image.
 
 <!-- End of code generated from the comments of the TencentCloudImageConfig struct in builder/tencentcloud/cvm/image_config.go; -->
diff --git a/go.mod b/go.mod
@@ -4,7 +4,7 @@ go 1.18
 
 require (
 	github.com/hashicorp/hcl/v2 v2.13.0
-	github.com/hashicorp/packer-plugin-sdk v0.3.4
+	github.com/hashicorp/packer-plugin-sdk v0.4.0
 	github.com/pkg/errors v0.9.1
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.367
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cvm v1.0.366
@@ -13,14 +13,17 @@ require (
 )
 
 require (
-	cloud.google.com/go v0.94.0 // indirect
-	cloud.google.com/go/storage v1.16.1 // indirect
+	cloud.google.com/go v0.105.0 // indirect
+	cloud.google.com/go/compute v1.12.1 // indirect
+	cloud.google.com/go/compute/metadata v0.1.1 // indirect
+	cloud.google.com/go/iam v0.6.0 // indirect
+	cloud.google.com/go/storage v1.27.0 // indirect
 	github.com/Azure/go-ntlmssp v0.0.0-20200615164410-66371956d46c // indirect
 	github.com/ChrisTrenkamp/goxpath v0.0.0-20210404020558-97928f7e12b6 // indirect
 	github.com/agext/levenshtein v1.2.3 // indirect
 	github.com/apparentlymart/go-textseg/v13 v13.0.0 // indirect
 	github.com/armon/go-metrics v0.3.9 // indirect
-	github.com/aws/aws-sdk-go v1.40.34 // indirect
+	github.com/aws/aws-sdk-go v1.44.114 // indirect
 	github.com/bgentry/go-netrc v0.0.0-20140422174119-9fd32a8b3d3d // indirect
 	github.com/cenkalti/backoff/v3 v3.2.2 // indirect
 	github.com/dylanmei/iso8601 v0.1.0 // indirect
@@ -30,23 +33,24 @@ require (
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/protobuf v1.5.2 // indirect
 	github.com/golang/snappy v0.0.4 // indirect
-	github.com/google/go-cmp v0.5.6 // indirect
+	github.com/google/go-cmp v0.5.9 // indirect
 	github.com/google/uuid v1.3.0 // indirect
-	github.com/googleapis/gax-go/v2 v2.1.0 // indirect
+	github.com/googleapis/enterprise-certificate-proxy v0.2.0 // indirect
+	github.com/googleapis/gax-go/v2 v2.6.0 // indirect
 	github.com/hashicorp/consul/api v1.10.1 // indirect
 	github.com/hashicorp/errwrap v1.1.0 // indirect
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
-	github.com/hashicorp/go-getter/gcs/v2 v2.1.0 // indirect
-	github.com/hashicorp/go-getter/s3/v2 v2.1.0 // indirect
-	github.com/hashicorp/go-getter/v2 v2.1.0 // indirect
+	github.com/hashicorp/go-getter/gcs/v2 v2.2.0 // indirect
+	github.com/hashicorp/go-getter/s3/v2 v2.2.0 // indirect
+	github.com/hashicorp/go-getter/v2 v2.2.0 // indirect
 	github.com/hashicorp/go-hclog v0.16.2 // indirect
 	github.com/hashicorp/go-immutable-radix v1.3.1 // indirect
 	github.com/hashicorp/go-multierror v1.1.1 // indirect
 	github.com/hashicorp/go-retryablehttp v0.7.0 // indirect
 	github.com/hashicorp/go-rootcerts v1.0.2 // indirect
 	github.com/hashicorp/go-safetemp v1.0.0 // indirect
 	github.com/hashicorp/go-sockaddr v1.0.2 // indirect
-	github.com/hashicorp/go-version v1.3.0 // indirect
+	github.com/hashicorp/go-version v1.6.0 // indirect
 	github.com/hashicorp/golang-lru v0.5.4 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/hashicorp/serf v0.9.5 // indirect
@@ -55,6 +59,7 @@ require (
 	github.com/hashicorp/yamux v0.0.0-20210826001029-26ff87cf9493 // indirect
 	github.com/jehiah/go-strftime v0.0.0-20171201141054-1d33003b3869 // indirect
 	github.com/jmespath/go-jmespath v0.4.0 // indirect
+	github.com/klauspost/compress v1.11.2 // indirect
 	github.com/kr/fs v0.1.0 // indirect
 	github.com/masterzen/simplexml v0.0.0-20190410153822-31eea3082786 // indirect
 	github.com/masterzen/winrm v0.0.0-20210623064412-3b76017826b0 // indirect
@@ -76,17 +81,18 @@ require (
 	github.com/ulikunitz/xz v0.5.10 // indirect
 	go.opencensus.io v0.23.0 // indirect
 	golang.org/x/crypto v0.0.0-20220517005047-85d78b3ac167 // indirect
-	golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2 // indirect
-	golang.org/x/oauth2 v0.0.0-20210819190943-2bc19b11175f // indirect
-	golang.org/x/sys v0.0.0-20211019181941-9d821ace8654 // indirect
-	golang.org/x/term v0.0.0-20210615171337-6886f2dfbf5b // indirect
-	golang.org/x/text v0.3.7 // indirect
+	golang.org/x/net v0.8.0 // indirect
+	golang.org/x/oauth2 v0.1.0 // indirect
+	golang.org/x/sys v0.6.0 // indirect
+	golang.org/x/term v0.6.0 // indirect
+	golang.org/x/text v0.8.0 // indirect
 	golang.org/x/time v0.0.0-20210723032227-1f47c861a9ac // indirect
-	google.golang.org/api v0.56.0 // indirect
+	golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 // indirect
+	google.golang.org/api v0.101.0 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
-	google.golang.org/genproto v0.0.0-20210831024726-fe130286e0e2 // indirect
-	google.golang.org/grpc v1.40.0 // indirect
-	google.golang.org/protobuf v1.27.1 // indirect
+	google.golang.org/genproto v0.0.0-20221027153422-115e99e71e1c // indirect
+	google.golang.org/grpc v1.50.1 // indirect
+	google.golang.org/protobuf v1.28.1 // indirect
 	gopkg.in/square/go-jose.v2 v2.6.0 // indirect
 	gopkg.in/yaml.v2 v2.3.0 // indirect
 )
diff --git a/go.sum b/go.sum

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ func TestTencentCloudAccessConfig_Prepare(t *testing.T) {`
`27`	`27`	`t.Fatal("should raise error: unknown region")`
`28`	`28`	`}`
`29`	`29`
`30`		`- cf.SkipValidation = true`
	`30`	`+ cf.skipValidation = true`
`31`	`31`	`if err := cf.Prepare(nil); err != nil {`
`32`	`32`	`t.Fatalf("shouldn't raise error: %v", err)`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ func TestTencentCloudImageConfig_Prepare(t *testing.T) {`
`30`	`30`	`t.Fatal("should have err")`
`31`	`31`	`}`
`32`	`32`
`33`		`- cf.SkipValidation = true`
	`33`	`+ cf.skipValidation = true`
`34`	`34`	`if err := cf.Prepare(nil); err != nil {`
`35`	`35`	`t.Fatalf("shouldn't have err:%v", err)`
`36`	`36`	`}`