chore: add tfproviderlint workflow (#592)

remyleone · web-flow · commit 490856e42ac0 · 2020-11-10T11:55:01.000+01:00
diff --git a/.github/workflows/tfproviderlint.yml b/.github/workflows/tfproviderlint.yml
@@ -0,0 +1,12 @@
+name: Run tfproviderlint
+
+on: [pull_request, push]
+
+jobs:
+  tfproviderlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.0.0
+      - uses: bflad/tfproviderlint-github-action@master
+        with:
+          args: ./...
diff --git a/go.mod b/go.mod
@@ -6,7 +6,7 @@ require (
 	github.com/google/go-cmp v0.5.2
 	github.com/hashicorp/go-retryablehttp v0.6.7
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.2.0
-	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.7.0.20201106174615-fd524d38cee8
+	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.7.0.20201109203223-9446a84bfb2a
 	github.com/stretchr/testify v1.6.1
 	golang.org/x/crypto v0.0.0-20200820211705-5c72a883971a // indirect
 	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1
diff --git a/go.sum b/go.sum
@@ -301,6 +301,8 @@ github.com/scaleway/scaleway-sdk-go v1.0.0-beta.7.0.20201012095732-98ec365545de
 github.com/scaleway/scaleway-sdk-go v1.0.0-beta.7.0.20201012095732-98ec365545de/go.mod h1:CJJ5VAbozOl0yEw7nHB9+7BXTJbIn6h7W+f6Gau5IP8=
 github.com/scaleway/scaleway-sdk-go v1.0.0-beta.7.0.20201106174615-fd524d38cee8 h1:OUM8gK4Frdx3yhDJWQSToADtrvCTGaZXYrm6O3j3JaQ=
 github.com/scaleway/scaleway-sdk-go v1.0.0-beta.7.0.20201106174615-fd524d38cee8/go.mod h1:CJJ5VAbozOl0yEw7nHB9+7BXTJbIn6h7W+f6Gau5IP8=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.7.0.20201109203223-9446a84bfb2a h1:bcVe/pXc4HWi8RwkiiYOdIjYWjQvR5eeMRaepXGW298=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.7.0.20201109203223-9446a84bfb2a/go.mod h1:CJJ5VAbozOl0yEw7nHB9+7BXTJbIn6h7W+f6Gau5IP8=
 github.com/sergi/go-diff v1.0.0 h1:Kpca3qRNrduNnOQeazBd0ysaKrUJiIuISHxogkT9RPQ=
 github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
 github.com/sergi/go-diff v1.1.0 h1:we8PVUC3FE2uYfodKH/nBHMSetSfHDR6scGdBi+erh0=
diff --git a/scaleway/data_source_helpers.go b/scaleway/data_source_helpers.go
@@ -42,7 +42,6 @@ func datasourceSchemaFromResourceSchema(rs map[string]*schema.Schema) map[string
 		dv := &schema.Schema{
 			Computed:    true,
 			ForceNew:    false,
-			Required:    false,
 			Description: v.Description,
 			Type:        v.Type,
 		}
diff --git a/scaleway/data_source_marketplace_image_beta.go b/scaleway/data_source_marketplace_image_beta.go
@@ -1,13 +1,17 @@
 package scaleway
 
 import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/scaleway/scaleway-sdk-go/api/marketplace/v1"
+	"github.com/scaleway/scaleway-sdk-go/scw"
 )
 
 func dataSourceScalewayMarketplaceImageBeta() *schema.Resource {
 	return &schema.Resource{
-		Read: dataSourceScalewayMarketplaceImageReadBeta,
+		ReadContext: dataSourceScalewayMarketplaceImageReadBeta,
 
 		Schema: map[string]*schema.Schema{
 			"label": {
@@ -26,21 +30,19 @@ func dataSourceScalewayMarketplaceImageBeta() *schema.Resource {
 	}
 }
 
-func dataSourceScalewayMarketplaceImageReadBeta(d *schema.ResourceData, m interface{}) error {
-	meta := m.(*Meta)
-	marketplaceAPI := marketplace.NewAPI(meta.scwClient)
-	zone, err := extractZone(d, meta)
+func dataSourceScalewayMarketplaceImageReadBeta(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
+	marketplaceAPI, zone, err := marketplaceAPIWithZone(d, m)
 	if err != nil {
-		return err
+		return diag.FromErr(err)
 	}
 
 	imageID, err := marketplaceAPI.GetLocalImageIDByLabel(&marketplace.GetLocalImageIDByLabelRequest{
 		ImageLabel:     d.Get("label").(string),
 		CommercialType: d.Get("instance_type").(string),
 		Zone:           zone,
-	})
+	}, scw.WithContext(ctx))
 	if err != nil {
-		return err
+		return diag.FromErr(err)
 	}
 
 	zonedID := datasourceNewZonedID(imageID, zone)
diff --git a/scaleway/data_source_registry_image_beta.go b/scaleway/data_source_registry_image_beta.go
@@ -57,8 +57,8 @@ func dataSourceScalewayRegistryImageBeta() *schema.Resource {
 	}
 }
 
-func dataSourceScalewayRegistryImageBetaRead(d *schema.ResourceData, m interface{}) error {
-	api, region, err := registryAPIWithRegion(d, m)
+func dataSourceScalewayRegistryImageBetaRead(d *schema.ResourceData, meta interface{}) error {
+	api, region, err := registryAPIWithRegion(d, meta)
 	if err != nil {
 		return err
 	}
diff --git a/scaleway/helpers.go b/scaleway/helpers.go
@@ -284,7 +284,7 @@ func newTemplateFunc(tplStr string) func(data interface{}) string {
 		buffer := bytes.Buffer{}
 		err := t.Execute(&buffer, tplParams)
 		if err != nil {
-			panic(err)
+			panic(err) // lintignore:R009
 		}
 		return buffer.String()
 	}
@@ -329,7 +329,7 @@ func expandDuration(data interface{}) *time.Duration {
 	d, err := time.ParseDuration(data.(string))
 	if err != nil {
 		// We panic as this should never happened. Data from state should be validate using a validate func
-		panic(err)
+		panic(err) // lintignore:R009
 	}
 	return &d
 }
@@ -422,7 +422,7 @@ func expandIPNet(raw string) scw.IPNet {
 	err := json.Unmarshal([]byte(raw), &ipNet)
 	if err != nil {
 		// We panic as this should never happen. Data from state should be validate using a validate func
-		panic(fmt.Errorf("%s could not be marshaled: %v", raw, err))
+		panic(fmt.Errorf("%s could not be marshaled: %v", raw, err)) // lintignore:R009
 	}
 
 	return ipNet
@@ -432,7 +432,7 @@ func flattenIPNet(ipNet scw.IPNet) string {
 	raw, err := json.Marshal(ipNet)
 	if err != nil {
 		// We panic as this should never happen.
-		panic(err)
+		panic(err) // lintignore:R009
 	}
 	return string(raw[1 : len(raw)-1])
 }
diff --git a/scaleway/helpers_marketplace.go b/scaleway/helpers_marketplace.go
@@ -0,0 +1,16 @@
+package scaleway
+
+import (
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/scaleway/scaleway-sdk-go/api/marketplace/v1"
+	"github.com/scaleway/scaleway-sdk-go/scw"
+)
+
+// marketplaceAPIWithZone returns a new marketplace API and the zone for a Create request
+func marketplaceAPIWithZone(d *schema.ResourceData, m interface{}) (*marketplace.API, scw.Zone, error) {
+	meta := m.(*Meta)
+	marketplaceAPI := marketplace.NewAPI(meta.scwClient)
+
+	zone, err := extractZone(d, meta)
+	return marketplaceAPI, zone, err
+}
diff --git a/scaleway/resource_rdb_instance_beta.go b/scaleway/resource_rdb_instance_beta.go
@@ -274,7 +274,7 @@ func resourceScalewayRdbInstanceBetaUpdate(ctx context.Context, d *schema.Resour
 		}
 
 		// Wait for the instance to settle after upgrading
-		time.Sleep(30 * time.Second)
+		time.Sleep(30 * time.Second) // lintignore:R018
 	}
 
 	if d.HasChange("password") {

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,6 @@ func datasourceSchemaFromResourceSchema(rs map[string]*schema.Schema) map[string`
`42`	`42`	`dv := &schema.Schema{`
`43`	`43`	`Computed: true,`
`44`	`44`	`ForceNew: false,`
`45`		`- Required: false,`
`46`	`45`	`Description: v.Description,`
`47`	`46`	`Type: v.Type,`
`48`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,8 +57,8 @@ func dataSourceScalewayRegistryImageBeta() *schema.Resource {`
`57`	`57`	`}`
`58`	`58`	`}`
`59`	`59`
`60`		`-func dataSourceScalewayRegistryImageBetaRead(d *schema.ResourceData, m interface{}) error {`
`61`		`- api, region, err := registryAPIWithRegion(d, m)`
	`60`	`+func dataSourceScalewayRegistryImageBetaRead(d *schema.ResourceData, meta interface{}) error {`
	`61`	`+ api, region, err := registryAPIWithRegion(d, meta)`
`62`	`62`	`if err != nil {`
`63`	`63`	`return err`
`64`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -284,7 +284,7 @@ func newTemplateFunc(tplStr string) func(data interface{}) string {`
`284`	`284`	`buffer := bytes.Buffer{}`
`285`	`285`	`err := t.Execute(&buffer, tplParams)`
`286`	`286`	`if err != nil {`
`287`		`- panic(err)`
	`287`	`+ panic(err) // lintignore:R009`
`288`	`288`	`}`
`289`	`289`	`return buffer.String()`
`290`	`290`	`}`
`@@ -329,7 +329,7 @@ func expandDuration(data interface{}) *time.Duration {`
`329`	`329`	`d, err := time.ParseDuration(data.(string))`
`330`	`330`	`if err != nil {`
`331`	`331`	`// We panic as this should never happened. Data from state should be validate using a validate func`
`332`		`- panic(err)`
	`332`	`+ panic(err) // lintignore:R009`
`333`	`333`	`}`
`334`	`334`	`return &d`
`335`	`335`	`}`
`@@ -422,7 +422,7 @@ func expandIPNet(raw string) scw.IPNet {`
`422`	`422`	`err := json.Unmarshal([]byte(raw), &ipNet)`
`423`	`423`	`if err != nil {`
`424`	`424`	`// We panic as this should never happen. Data from state should be validate using a validate func`
`425`		`- panic(fmt.Errorf("%s could not be marshaled: %v", raw, err))`
	`425`	`+ panic(fmt.Errorf("%s could not be marshaled: %v", raw, err)) // lintignore:R009`
`426`	`426`	`}`
`427`	`427`
`428`	`428`	`return ipNet`
`@@ -432,7 +432,7 @@ func flattenIPNet(ipNet scw.IPNet) string {`
`432`	`432`	`raw, err := json.Marshal(ipNet)`
`433`	`433`	`if err != nil {`
`434`	`434`	`// We panic as this should never happen.`
`435`		`- panic(err)`
	`435`	`+ panic(err) // lintignore:R009`
`436`	`436`	`}`
`437`	`437`	`return string(raw[1 : len(raw)-1])`
`438`	`438`	`}`
Original file line number	Diff line number	Diff line change
`@@ -274,7 +274,7 @@ func resourceScalewayRdbInstanceBetaUpdate(ctx context.Context, d *schema.Resour`
`274`	`274`	`}`
`275`	`275`
`276`	`276`	`// Wait for the instance to settle after upgrading`
`277`		`- time.Sleep(30 * time.Second)`
	`277`	`+ time.Sleep(30 * time.Second) // lintignore:R018`
`278`	`278`	`}`
`279`	`279`
`280`	`280`	`if d.HasChange("password") {`