chore: run golangci-lint for pull requests and annotate failing checks so we can fix them individually (#658)

Author: mattkasa

.github/workflows/golangci-lint.yml

@@ -1,6 +1,6 @@
 name: golangci-lint
 
-on: push
+on: [push,pull_request]
 
 jobs:
   golangci:

gitlab/data_source_gitlab_group_test.go

@@ -10,7 +10,7 @@ import (
 )
 
 func TestAccDataSourceGitlabGroup_basic(t *testing.T) {
-	rString := fmt.Sprintf("%s", acctest.RandString(5))
+	rString := fmt.Sprintf("%s", acctest.RandString(5)) // nolint // TODO: Resolve this golangci-lint issue: S1025: the argument is already a string, there's no need to use fmt.Sprintf (gosimple)
 
 	resource.Test(t, resource.TestCase{
 		PreCheck:  func() { testAccPreCheck(t) },

gitlab/data_source_gitlab_projects.go

@@ -102,7 +102,7 @@ func flattenGitlabBasicUser(user *gitlab.User) (values []map[string]interface{})
 }
 
 func flattenProjects(projects []*gitlab.Project) (values []map[string]interface{}) {
-	if projects != nil {
+	if projects != nil { // nolint // TODO: Resolve this golangci-lint issue: S1031: unnecessary nil check around range (gosimple)
 		for _, project := range projects {
 			v := map[string]interface{}{
 				"id":                                    project.ID,

gitlab/data_source_gitlab_projects_test.go

@@ -137,7 +137,7 @@ func testAccDataSourceGitlabProjects(src string, n string) resource.TestCheckFun
 
 		var errorMessageExpected strings.Builder
 		for _, attr := range testAttributes {
-			errorMessageExpected.WriteString(fmt.Sprintf("%s=%v, ", attr, projectResource[fmt.Sprintf("%s", attr)]))
+			errorMessageExpected.WriteString(fmt.Sprintf("%s=%v, ", attr, projectResource[fmt.Sprintf("%s", attr)])) // nolint // TODO: Resolve this golangci-lint issue: S1025: the argument is already a string, there's no need to use fmt.Sprintf (gosimple)
 		}
 
 		var errorMessageGot strings.Builder

gitlab/data_source_gitlab_user_test.go

@@ -10,7 +10,7 @@ import (
 )
 
 func TestAccDataSourceGitlabUser_basic(t *testing.T) {
-	rString := fmt.Sprintf("%s", acctest.RandString(5))
+	rString := fmt.Sprintf("%s", acctest.RandString(5)) // nolint // TODO: Resolve this golangci-lint issue: S1025: the argument is already a string, there's no need to use fmt.Sprintf (gosimple)
 
 	resource.Test(t, resource.TestCase{
 		PreCheck:  func() { testAccPreCheck(t) },

gitlab/helper_test.go

@@ -14,9 +14,9 @@ import (
 func testAccCompareGitLabAttribute(attr string, expected, received *schema.ResourceData) error {
 	e := expected.Get(attr)
 	r := received.Get(attr)
-	switch e.(type) {
+	switch e.(type) { // nolint // TODO: Resolve this golangci-lint issue: S1034: assigning the result of this type assertion to a variable (switch e := e.(type)) could eliminate type assertions in switch cases (gosimple)
 	case *schema.Set:
-		if !e.(*schema.Set).Equal(r) {
+		if !e.(*schema.Set).Equal(r) { // nolint // TODO: Resolve this golangci-lint issue: S1034(related information): could eliminate this type assertion (gosimple)
 			return fmt.Errorf(`attribute set %s expected "%+v" received "%+v"`, attr, e, r)
 		}
 	default:

gitlab/provider.go

@@ -142,7 +142,7 @@ func providerConfigure(p *schema.Provider, d *schema.ResourceData) (interface{},
 
 	// NOTE: httpclient.TerraformUserAgent is deprecated and removed in Terraform SDK v2
 	// After upgrading the SDK to v2 replace with p.UserAgent("terraform-provider-gitlab")
-	client.UserAgent = httpclient.TerraformUserAgent(p.TerraformVersion) + " terraform-provider-gitlab"
+	client.UserAgent = httpclient.TerraformUserAgent(p.TerraformVersion) + " terraform-provider-gitlab" // nolint // TODO: Resolve this golangci-lint issue: SA1019: httpclient.TerraformUserAgent is deprecated: This will be removed in v2 without replacement. If you need its functionality, you can copy it or reference the v1 package. (staticcheck)
 
 	return client, err
 }

gitlab/resource_gitlab_deploy_key_enable.go

@@ -52,7 +52,7 @@ func resourceGitlabDeployEnableKey() *schema.Resource {
 func resourceGitlabDeployKeyEnableCreate(d *schema.ResourceData, meta interface{}) error {
 	client := meta.(*gitlab.Client)
 	project := d.Get("project").(string)
-	key_id, err := strconv.Atoi(d.Get("key_id").(string))
+	key_id, err := strconv.Atoi(d.Get("key_id").(string)) // nolint // TODO: Resolve this golangci-lint issue: ineffectual assignment to err (ineffassign)
 
 	log.Printf("[DEBUG] enable gitlab deploy key %s/%d", project, key_id)
 

gitlab/resource_gitlab_deploy_key_test.go

@@ -153,7 +153,7 @@ func testAccCheckGitlabDeployKeyDestroy(s *terraform.State) error {
 		if rs.Type != "gitlab_project" {
 			continue
 		}
-		deployKeyID, err := strconv.Atoi(rs.Primary.ID)
+		deployKeyID, err := strconv.Atoi(rs.Primary.ID) // nolint // TODO: Resolve this golangci-lint issue: ineffectual assignment to err (ineffassign)
 		project := rs.Primary.Attributes["project"]
 
 		gotDeployKey, resp, err := conn.DeployKeys.GetDeployKey(project, deployKeyID)

gitlab/resource_gitlab_group_ldap_link.go

@@ -71,7 +71,7 @@ func resourceGitlabGroupLdapLinkCreate(d *schema.ResourceData, meta interface{})
 	}
 
 	if force {
-		resourceGitlabGroupLdapLinkDelete(d, meta)
+		resourceGitlabGroupLdapLinkDelete(d, meta) // nolint // TODO: Resolve this golangci-lint issue: Error return value is not checked (errcheck)
 	}
 
 	log.Printf("[DEBUG] Create GitLab group LdapLink %s", d.Id())
@@ -95,9 +95,9 @@ func resourceGitlabGroupLdapLinkRead(d *schema.ResourceData, meta interface{}) e
 	if err != nil {
 		// The read/GET API wasn't implemented in GitLab until version 12.8 (March 2020, well after the add and delete APIs).
 		// If we 404, assume GitLab is at an older version and take things on faith.
-		switch err.(type) {
+		switch err.(type) { // nolint // TODO: Resolve this golangci-lint issue: S1034: assigning the result of this type assertion to a variable (switch err := err.(type)) could eliminate type assertions in switch cases (gosimple)
 		case *gitlab.ErrorResponse:
-			if err.(*gitlab.ErrorResponse).Response.StatusCode == 404 {
+			if err.(*gitlab.ErrorResponse).Response.StatusCode == 404 { // nolint // TODO: Resolve this golangci-lint issue: S1034(related information): could eliminate this type assertion (gosimple)
 				log.Printf("[WARNING] This GitLab instance doesn't have the GET API for group_ldap_sync.  Please upgrade to 12.8 or later for best results.")
 			} else {
 				return err
@@ -124,7 +124,7 @@ func resourceGitlabGroupLdapLinkRead(d *schema.ResourceData, meta interface{}) e
 
 		if !found {
 			d.SetId("")
-			return errors.New(fmt.Sprintf("LdapLink %s does not exist.", d.Id()))
+			return errors.New(fmt.Sprintf("LdapLink %s does not exist.", d.Id())) // nolint // TODO: Resolve this golangci-lint issue: S1028: should use fmt.Errorf(...) instead of errors.New(fmt.Sprintf(...)) (gosimple)
 		}
 	}
 
@@ -140,10 +140,10 @@ func resourceGitlabGroupLdapLinkDelete(d *schema.ResourceData, meta interface{})
 	log.Printf("[DEBUG] Delete GitLab group LdapLink %s", d.Id())
 	_, err := client.Groups.DeleteGroupLDAPLinkForProvider(groupId, ldap_provider, cn)
 	if err != nil {
-		switch err.(type) {
+		switch err.(type) { // nolint // TODO: Resolve this golangci-lint issue: S1034: assigning the result of this type assertion to a variable (switch err := err.(type)) could eliminate type assertions in switch cases (gosimple)
 		case *gitlab.ErrorResponse:
 			// Ignore LDAP links that don't exist
-			if strings.Contains(string(err.(*gitlab.ErrorResponse).Message), "Linked LDAP group not found") {
+			if strings.Contains(string(err.(*gitlab.ErrorResponse).Message), "Linked LDAP group not found") { // nolint // TODO: Resolve this golangci-lint issue: S1034(related information): could eliminate this type assertion (gosimple)
 				log.Printf("[WARNING] %s", err)
 			} else {
 				return err