Use golangci-lint in Drone Pipelines (#255)

Author: trotttrotttrott

.drone/drone.jsonnet

@@ -1,5 +1,5 @@
-local golang = 'golang:1.16';
 local grafana = 'grafana/grafana:8.0.3';
+local build = 'grafana/build-container:1.4.1';
 
 // We'd like the same pipeline for testing pull requests as we do for building
 // master. The only difference is their names and triggers.
@@ -14,9 +14,11 @@ local pipeline(name, trigger) = {
   steps: [
     {
       name: 'tests',
-      image: golang,
+      image: build,
       commands: [
         'sleep 5',  // https://docs.drone.io/pipeline/docker/syntax/services/#initialization
+        'golangci-lint --version',
+        'golangci-lint run ./...',
         'make testacc',
       ],
       environment: {

.drone/drone.yml

@@ -9,9 +9,11 @@ platform:
 
 steps:
 - name: tests
-  image: golang:1.16
+  image: grafana/build-container:1.4.1
   commands:
   - sleep 5
+  - golangci-lint --version
+  - golangci-lint run ./...
   - make testacc
   environment:
     GRAFANA_AUTH: admin:admin
@@ -39,9 +41,11 @@ platform:
 
 steps:
 - name: tests
-  image: golang:1.16
+  image: grafana/build-container:1.4.1
   commands:
   - sleep 5
+  - golangci-lint --version
+  - golangci-lint run ./...
   - make testacc
   environment:
     GRAFANA_AUTH: admin:admin
@@ -62,6 +66,6 @@ trigger:
 
 ---
 kind: signature
-hmac: c1a676f627f31e0a41b4f2625f9c55b37ec44fc6d4f31558909bde6f00a8bd5c
+hmac: e720237ec519da396e1c93fba1b538353b1df9d3965095a3230ff640ae5b4bdd
 
 ...

.golangci.toml

@@ -0,0 +1,58 @@
+[run]
+timeout = "10m"
+build-tags = [
+  "cloud",
+  "enterprise",
+]
+
+[linters-settings.golint]
+min-confidence = 3
+
+[linters-settings.goconst]
+min-len = 5
+min-occurrences = 5
+
+[linters]
+disable-all = true
+enable = [
+  "bodyclose",
+  "deadcode",
+  "depguard",
+  "dogsled",
+  "goconst",
+  "gocritic",
+  "goimports",
+  "golint",
+  "goprintffuncname",
+  "gosec",
+  "gosimple",
+  "govet",
+  "ineffassign",
+  "misspell",
+  "nakedret",
+  "rowserrcheck",
+  "exportloopref",
+  "staticcheck",
+  "structcheck",
+  "stylecheck",
+  "typecheck",
+  "unconvert",
+  "unused",
+  "varcheck",
+  "whitespace",
+  "gocyclo",
+  "unparam",
+]
+
+[[issues.exclude-rules]]
+linters = ["stylecheck"]
+path = "_test.go"
+text = "ST1003: should not use underscores in Go names;"
+
+[[issues.exclude-rules]]
+linters = ["gocritic"]
+text = "deprecatedComment: the proper format is `Deprecated: <text>`"
+
+[[issues.exclude-rules]]
+linters = ["gosec"]
+text = "G402: TLS MinVersion too low."

grafana/data_source_synthetic_monitoring_probe.go

@@ -11,7 +11,6 @@ import (
 )
 
 func dataSourceSyntheticMonitoringProbe() *schema.Resource {
-
 	probeSchema := datasourceSchemaFromResourceSchema(syntheticMonitoringProbe.Schema)
 	addRequiredFieldsToSchema(probeSchema, "name")
 	delete(probeSchema, "auth_token")

grafana/data_source_synthetic_monitoring_probes.go

@@ -8,7 +8,6 @@ import (
 )
 
 func dataSourceSyntheticMonitoringProbes() *schema.Resource {
-
 	return &schema.Resource{
 		Description: "Data source for retrieving all probes.",
 		ReadContext: dataSourceSyntheticMonitoringProbesRead,
@@ -26,7 +25,6 @@ func dataSourceSyntheticMonitoringProbes() *schema.Resource {
 }
 
 func dataSourceSyntheticMonitoringProbesRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-
 	c := meta.(*client).smapi
 	var diags diag.Diagnostics
 	prbs, err := c.ListProbes(ctx)

grafana/provider.go

@@ -134,7 +134,6 @@ type client struct {
 
 func configure(version string, p *schema.Provider) func(context.Context, *schema.ResourceData) (interface{}, diag.Diagnostics) {
 	return func(ctx context.Context, d *schema.ResourceData) (interface{}, diag.Diagnostics) {
-
 		var diags diag.Diagnostics
 		p.UserAgent("terraform-provider-grafana", version)
 
@@ -188,8 +187,8 @@ func configure(version string, p *schema.Provider) func(context.Context, *schema
 		c.gapi = gclient
 
 		smToken := d.Get("sm_access_token").(string)
-		smUrl := d.Get("sm_url").(string)
-		c.smapi = smapi.NewClient(smUrl, smToken, nil)
+		smURL := d.Get("sm_url").(string)
+		c.smapi = smapi.NewClient(smURL, smToken, nil)
 
 		return c, diags
 	}

grafana/provider_test.go

@@ -36,6 +36,7 @@ func init() {
 	// Always allocate a new provider instance each invocation, otherwise gRPC
 	// ProviderConfigure() can overwrite configuration during concurrent testing.
 	testAccProviderFactories = map[string]func() (*schema.Provider, error){
+		//nolint:unparam // error is always nil
 		"grafana": func() (*schema.Provider, error) {
 			return Provider("testacc")(), nil
 		},

grafana/resource_alert_notification.go

@@ -149,23 +149,25 @@ func ReadAlertNotification(ctx context.Context, d *schema.ResourceData, meta int
 	settings := map[string]interface{}{}
 	for k, v := range alertNotification.Settings.(map[string]interface{}) {
 		boolVal, ok := v.(bool)
-		if ok && boolVal {
+		switch {
+		case ok && boolVal:
 			settings[k] = "true"
-		} else if ok && !boolVal {
+		case ok && !boolVal:
 			settings[k] = "false"
-		} else {
+		default:
 			settings[k] = v
 		}
 	}
 	secureSettings := map[string]interface{}{}
 
 	for k, v := range alertNotification.SecureFields.(map[string]interface{}) {
 		boolVal, ok := v.(bool)
-		if ok && boolVal {
+		switch {
+		case ok && boolVal:
 			secureSettings[k] = "true"
-		} else if ok && !boolVal {
+		case ok && !boolVal:
 			secureSettings[k] = "false"
-		} else {
+		default:
 			secureSettings[k] = v
 		}
 	}
@@ -199,7 +201,7 @@ func DeleteAlertNotification(ctx context.Context, d *schema.ResourceData, meta i
 	return diag.Diagnostics{}
 }
 
-func makeAlertNotification(ctx context.Context, d *schema.ResourceData) (*gapi.AlertNotification, error) {
+func makeAlertNotification(_ context.Context, d *schema.ResourceData) (*gapi.AlertNotification, error) {
 	idStr := d.Id()
 	var id int64
 	var err error
@@ -210,22 +212,24 @@ func makeAlertNotification(ctx context.Context, d *schema.ResourceData) (*gapi.A
 	settings := map[string]interface{}{}
 	for k, v := range d.Get("settings").(map[string]interface{}) {
 		strVal, ok := v.(string)
-		if ok && strVal == "true" {
+		switch {
+		case ok && strVal == "true":
 			settings[k] = true
-		} else if ok && strVal == "false" {
+		case ok && strVal == "false":
 			settings[k] = false
-		} else {
+		default:
 			settings[k] = v
 		}
 	}
 	secureSettings := map[string]interface{}{}
 	for k, v := range d.Get("secure_settings").(map[string]interface{}) {
 		strVal, ok := v.(string)
-		if ok && strVal == "true" {
+		switch {
+		case ok && strVal == "true":
 			secureSettings[k] = true
-		} else if ok && strVal == "false" {
+		case ok && strVal == "false":
 			secureSettings[k] = false
-		} else {
+		default:
 			secureSettings[k] = v
 		}
 	}

grafana/resource_alert_notification_test.go

@@ -86,7 +86,7 @@ func TestAccAlertNotification_disableResolveMessage(t *testing.T) {
 	})
 }
 
-func TestAccAlertNotification_invalid_frequence(t *testing.T) {
+func TestAccAlertNotification_invalid_frequency(t *testing.T) {
 	var alertNotification gapi.AlertNotification
 
 	resource.Test(t, resource.TestCase{
@@ -102,7 +102,7 @@ func TestAccAlertNotification_invalid_frequence(t *testing.T) {
 	})
 }
 
-func TestAccAlertNotification_reminder_no_frequence(t *testing.T) {
+func TestAccAlertNotification_reminder_no_frequency(t *testing.T) {
 	var alertNotification gapi.AlertNotification
 
 	resource.Test(t, resource.TestCase{

grafana/resource_builtin_role_assignment.go

@@ -2,7 +2,6 @@ package grafana
 
 import (
 	"context"
-	"errors"
 	"fmt"
 	"log"
 
@@ -77,10 +76,10 @@ func updateAssignments(d *schema.ResourceData, meta interface{}) diag.Diagnostic
 	if err != nil {
 		return diag.FromErr(err)
 	}
-	//compile the list of differences between current state and config
+	// compile the list of differences between current state and config
 	changes := roleChanges(stateRoles, configRoles)
 	brName := d.Get("builtin_role").(string)
-	//now we can make the corresponding updates so current state matches config
+	// now we can make the corresponding updates so current state matches config
 	if err := createOrRemove(meta, brName, changes); err != nil {
 		return diag.FromErr(err)
 	}
@@ -183,9 +182,8 @@ func roleChanges(rolesInState, rolesInConfig map[string]bool) []RoleChange {
 }
 
 func collectRoles(d *schema.ResourceData) (map[string]bool, map[string]bool, error) {
-
 	errFn := func(uid string) error {
-		return errors.New(fmt.Sprintf("Error: Role '%s' cannot be specified multiple times.", uid))
+		return fmt.Errorf("error: Role '%s' cannot be specified multiple times", uid)
 	}
 
 	rolesFn := func(roles interface{}) (map[string]bool, error) {
@@ -226,7 +224,7 @@ func createOrRemove(meta interface{}, name string, changes []RoleChange) error {
 			err = client.DeleteBuiltInRoleAssignment(br)
 		}
 		if err != nil {
-			return errors.New(fmt.Sprintf("Error with %s %v", name, err))
+			return fmt.Errorf("error with %s %w", name, err)
 		}
 	}
 	return nil