golangci-lint workflow

.github/workflows/golangci-lint.yml

@@ -0,0 +1,20 @@
+name: golangci-lint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go-version: [1.16.x]
+    steps:
+      - uses: actions/checkout@v2
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v2
+        with:
+          version: v1.42
+          #only-new-issues: true

.golangci.yml

@@ -0,0 +1,14 @@
+run:
+  timeout: 5m
+linters:
+  enable:
+    - gosimple
+    - stylecheck
+    - revive #golint is deprecated and golangci-lint recommends to use revive instead
+    #other deprecated lint libraries: maligned, scopelint, interfacer
+issues:
+  exclude-rules:
+  - path: _test\.go
+    linters:
+    - unused
+    - deadcode

admin_setting_saml.go

@@ -48,14 +48,14 @@ type AdminSAMLSetting struct {
 }
 
 // Read returns the SAML settings.
-func (s *adminSAMLSettings) Read(ctx context.Context) (*AdminSAMLSetting, error) {
-	req, err := s.client.newRequest("GET", "admin/saml-settings", nil)
+func (a *adminSAMLSettings) Read(ctx context.Context) (*AdminSAMLSetting, error) {
+	req, err := a.client.newRequest("GET", "admin/saml-settings", nil)
 	if err != nil {
 		return nil, err
 	}
 
 	saml := &AdminSAMLSetting{}
-	err = s.client.do(ctx, req, saml)
+	err = a.client.do(ctx, req, saml)
 	if err != nil {
 		return nil, err
 	}

admin_user.go

@@ -85,7 +85,7 @@ type AdminUserListOptions struct {
 
 // List all user accounts in the Terraform Enterprise installation
 func (a *adminUsers) List(ctx context.Context, options AdminUserListOptions) (*AdminUserList, error) {
-	u := fmt.Sprintf("admin/users")
+	u := "admin/users"
 	req, err := a.client.newRequest("GET", u, &options)
 	if err != nil {
 		return nil, err

helper_test.go

@@ -16,7 +16,7 @@ import (
 	"github.com/hashicorp/go-uuid"
 )
 
-const badIdentifier = "! / nope"
+const badIdentifier = "! / nope" //nolint
 
 // Memoize test account details
 var _testAccountDetails *TestAccountDetails
@@ -561,9 +561,8 @@ func createRunWithStatus(t *testing.T, client *Client, w *Workspace, timeout int
 func createPlannedRun(t *testing.T, client *Client, w *Workspace) (*Run, func()) {
 	if paidFeaturesDisabled() {
 		return createRunWithStatus(t, client, w, 45, RunPlanned)
-	} else {
-		return createRunWithStatus(t, client, w, 45, RunCostEstimated)
 	}
+	return createRunWithStatus(t, client, w, 45, RunCostEstimated)
 }
 
 func createCostEstimatedRun(t *testing.T, client *Client, w *Workspace) (*Run, func()) {

ip_ranges.go

@@ -83,7 +83,7 @@ func (i *ipRanges) customDo(ctx context.Context, req *retryablehttp.Request, ir
 	defer resp.Body.Close()
 
 	if resp.StatusCode < 200 && resp.StatusCode >= 400 {
-		return fmt.Errorf("Error HTTP response while retrieving IP ranges: %d", resp.StatusCode)
+		return fmt.Errorf("error HTTP response while retrieving IP ranges: %d", resp.StatusCode)
 	} else if resp.StatusCode == 304 {
 		return nil
 	}

oauth_client.go

@@ -144,7 +144,7 @@ func (o OAuthClientCreateOptions) valid() error {
 		return errors.New("service provider is required")
 	}
 	if validString(o.PrivateKey) && *o.ServiceProvider != *ServiceProvider(ServiceProviderAzureDevOpsServer) {
-		return errors.New("Private Key can only be present with Azure DevOps Server service provider")
+		return errors.New("private Key can only be present with Azure DevOps Server service provider")
 	}
 	return nil
 }

policy_set_version.go

@@ -85,11 +85,11 @@ type PolicySetVersion struct {
 func (p PolicySetVersion) uploadURL() (string, error) {
 	uploadURL, ok := p.Links["upload"].(string)
 	if !ok {
-		return uploadURL, fmt.Errorf("The Policy Set Version does not contain an upload link.")
+		return uploadURL, fmt.Errorf("the Policy Set Version does not contain an upload link")
 	}
 
 	if uploadURL == "" {
-		return uploadURL, fmt.Errorf("The Policy Set Version upload URL is empty.")
+		return uploadURL, fmt.Errorf("the Policy Set Version upload URL is empty")
 	}
 
 	return uploadURL, nil

registry_module.go

@@ -110,7 +110,7 @@ type RegistryModuleVersion struct {
 func (r *registryModules) Upload(ctx context.Context, rmv RegistryModuleVersion, path string) error {
 	uploadURL, ok := rmv.Links["upload"].(string)
 	if !ok {
-		return fmt.Errorf("Provided RegistryModuleVersion does not contain an upload link")
+		return fmt.Errorf("provided RegistryModuleVersion does not contain an upload link")
 	}
 
 	body, err := packContents(path)

tfe.go

@@ -531,18 +531,18 @@ func serializeRequestBody(v interface{}) (interface{}, error) {
 
 	// Infer whether the request uses jsonapi or regular json
 	// serialization based on how the fields are tagged.
-	jsonApiFields := 0
+	jsonAPIFields := 0
 	jsonFields := 0
 	for i := 0; i < modelType.NumField(); i++ {
 		structField := modelType.Field(i)
 		if structField.Tag.Get("jsonapi") != "" {
-			jsonApiFields++
+			jsonAPIFields++
 		}
 		if structField.Tag.Get("json") != "" {
 			jsonFields++
 		}
 	}
-	if jsonApiFields > 0 && jsonFields > 0 {
+	if jsonAPIFields > 0 && jsonFields > 0 {
 		// Defining a struct with both json and jsonapi tags doesn't
 		// make sense, because a struct can only be serialized
 		// as one or another. If this does happen, it's a bug
@@ -552,13 +552,12 @@ func serializeRequestBody(v interface{}) (interface{}, error) {
 
 	if jsonFields > 0 {
 		return json.Marshal(v)
-	} else {
-		buf := bytes.NewBuffer(nil)
-		if err := jsonapi.MarshalPayloadWithoutIncluded(buf, v); err != nil {
-			return nil, err
-		}
-		return buf, nil
 	}
+	buf := bytes.NewBuffer(nil)
+	if err := jsonapi.MarshalPayloadWithoutIncluded(buf, v); err != nil {
+		return nil, err
+	}
+	return buf, nil
 }
 
 // do sends an API request and returns the API response. The API response