Merge pull request #713 from wyardley/wyardley/golangci-lint

ci: use golangci-lint docker image directly

.circleci/config.yml

@@ -172,12 +172,12 @@ jobs:
       - run: ./.circleci/deploy-gh-pages.sh
 
   lint:
-    executor: go
+    docker:
+      - image: golangci/golangci-lint:v1.46-alpine
+    resource_class: large
     steps:
       - checkout
-      - run: make install-lint
-      - run: make build
-      - run: make lint
+      - run: golangci-lint run
 
   deploy-test:
     executor: go

.golangci.yml

@@ -0,0 +1,36 @@
+---
+service:
+  golangci-lint-version: 1.46.x
+
+linters:
+  enable:
+    - deadcode
+    - errcheck
+    - goconst
+    - gofmt
+    - goimports
+    # - gosec
+    - gosimple
+    - govet
+    - ineffassign
+    - megacheck
+    - misspell
+    - nakedret
+    # - revive
+    - staticcheck
+    - structcheck
+    - typecheck
+    - unconvert
+    # - unparam
+    - unused
+    - varcheck
+    - vet
+    - vetshadow
+
+# Instead of disabling tests entirely, just ignore goconst, which is the only
+# one with issues there currently.
+issues:
+  exclude-rules:
+    - path: (.+)_test.go
+      linters:
+        - goconst

Makefile

@@ -26,16 +26,11 @@ cover:
 
 .PHONY: lint
 lint:
-	bash .circleci/lint.sh
+	golangci-lint run
 
 .PHONY: doc
 doc:
 	godoc -http=:6060
 
-.PHONY: install-lint
-install-lint:
-	bash .circleci/install-lint.sh
-
-
 .PHONY: always
 always:

api/api_test.go

@@ -61,7 +61,7 @@ func TestFollowProject(t *testing.T) {
 			expErr: "invalid character '/'",
 		},
 		{
-			label: "returns a followed project succesfully",
+			label: "returns a followed project successfully",
 			transportFn: func(r *http.Request) (*http.Response, error) {
 				if r.URL.String() != "https://circleci.com/api/v1.1/project/github/test-user/test-project/follow" {
 					panic(fmt.Sprintf("unexpected url: %s", r.URL.String()))

api/context_graphql.go

@@ -285,7 +285,7 @@ func (c *GraphQLContextClient) DeleteEnvironmentVariable(contextId, variableName
 	}
 
 	err := cl.Run(request, &response)
-	return errors.Wrap(improveVcsTypeError(err), "failed to delete environment varaible")
+	return errors.Wrap(improveVcsTypeError(err), "failed to delete environment variable")
 }
 
 // CreateEnvironmentVariable creates a new environment variable in the given
@@ -343,7 +343,7 @@ func (c *GraphQLContextClient) CreateEnvironmentVariable(contextId, variableName
 	}
 
 	if err := cl.Run(request, &response); err != nil {
-		return errors.Wrap(improveVcsTypeError(err), "failed to store environment varaible in context")
+		return errors.Wrap(improveVcsTypeError(err), "failed to store environment variable in context")
 	}
 
 	if response.StoreEnvironmentVariable.Error.Type != "" {

api/context_test.go

@@ -188,7 +188,7 @@ var _ = ginkgo.Describe("API", func() {
 
 			list.Organization.Id = "C3D79A95-6BD5-40B4-9958-AB6BDC4CAD50"
 			list.Organization.Contexts.Edges = []struct{ Node circleCIContext }{
-				struct{ Node circleCIContext }{
+				{
 					Node: ctx,
 				},
 			}

api/rest/client.go

@@ -99,8 +99,8 @@ func (c *Client) DoRequest(req *http.Request, resp interface{}) (statusCode int,
 }
 
 type HTTPError struct {
-	Code int
-	Message  string
+	Code    int
+	Message string
 }
 
 func (e *HTTPError) Error() string {

api/rest/client_test.go

@@ -61,7 +61,7 @@ func TestClient_DoRequest(t *testing.T) {
 		defer cleanup()
 
 		t.Run("Check result", func(t *testing.T) {
-			r, err := c.NewRequest("GET", &url.URL{Path: "my/error/endpoint"}, nil)
+			r, err := c.NewRequest(http.MethodGet, &url.URL{Path: "my/error/endpoint"}, nil)
 			assert.NilError(t, err)
 
 			resp := make(map[string]interface{})
@@ -73,7 +73,7 @@ func TestClient_DoRequest(t *testing.T) {
 
 		t.Run("Check request", func(t *testing.T) {
 			assert.Check(t, cmp.Equal(fix.URL(), url.URL{Path: "/api/v2/my/error/endpoint"}))
-			assert.Check(t, cmp.Equal(fix.Method(), "GET"))
+			assert.Check(t, cmp.Equal(fix.Method(), http.MethodGet))
 			assert.Check(t, cmp.DeepEqual(fix.Header(), http.Header{
 				"Accept-Encoding": {"gzip"},
 				"Accept-Type":     {"application/json"},
@@ -90,7 +90,7 @@ func TestClient_DoRequest(t *testing.T) {
 		defer cleanup()
 
 		t.Run("Check result", func(t *testing.T) {
-			r, err := c.NewRequest("GET", &url.URL{Path: "path"}, nil)
+			r, err := c.NewRequest(http.MethodGet, &url.URL{Path: "path"}, nil)
 			assert.NilError(t, err)
 
 			resp := make(map[string]interface{})
@@ -105,7 +105,7 @@ func TestClient_DoRequest(t *testing.T) {
 
 		t.Run("Check request", func(t *testing.T) {
 			assert.Check(t, cmp.Equal(fix.URL(), url.URL{Path: "/api/v2/path"}))
-			assert.Check(t, cmp.Equal(fix.Method(), "GET"))
+			assert.Check(t, cmp.Equal(fix.Method(), http.MethodGet))
 			assert.Check(t, cmp.DeepEqual(fix.Header(), http.Header{
 				"Accept-Encoding": {"gzip"},
 				"Accept-Type":     {"application/json"},

api/runner/runner_test.go

@@ -82,7 +82,7 @@ func TestRunner_GetResourceClassByName(t *testing.T) {
 
 	t.Run("Check request", func(t *testing.T) {
 		assert.Check(t, cmp.Equal(fix.URL(), url.URL{Path: "/api/v2/runner/resource", RawQuery: "namespace=the-namespace"}))
-		assert.Check(t, cmp.Equal(fix.method, "GET"))
+		assert.Check(t, cmp.Equal(fix.method, http.MethodGet))
 		assert.Check(t, cmp.DeepEqual(fix.Header(), http.Header{
 			"Accept-Encoding": {"gzip"},
 			"Accept-Type":     {"application/json"},
@@ -133,7 +133,7 @@ func TestRunner_GetResourceClassesByNamespace(t *testing.T) {
 
 	t.Run("Check request", func(t *testing.T) {
 		assert.Check(t, cmp.Equal(fix.URL(), url.URL{Path: "/api/v2/runner/resource", RawQuery: "namespace=the-namespace"}))
-		assert.Check(t, cmp.Equal(fix.method, "GET"))
+		assert.Check(t, cmp.Equal(fix.method, http.MethodGet))
 		assert.Check(t, cmp.DeepEqual(fix.Header(), http.Header{
 			"Accept-Encoding": {"gzip"},
 			"Accept-Type":     {"application/json"},
@@ -279,7 +279,7 @@ func TestRunner_GetRunnerTokensByResourceClass(t *testing.T) {
 
 	t.Run("Check request", func(t *testing.T) {
 		assert.Check(t, cmp.Equal(fix.URL(), url.URL{Path: "/api/v2/runner/token", RawQuery: "resource-class=the-namespace%2Fthe-resource-class"}))
-		assert.Check(t, cmp.Equal(fix.method, "GET"))
+		assert.Check(t, cmp.Equal(fix.method, http.MethodGet))
 		assert.Check(t, cmp.DeepEqual(fix.Header(), http.Header{
 			"Accept-Encoding": {"gzip"},
 			"Accept-Type":     {"application/json"},
@@ -390,7 +390,7 @@ func TestRunner_GetRunnerInstances_ByNamespace(t *testing.T) {
 
 	t.Run("Check request", func(t *testing.T) {
 		assert.Check(t, cmp.Equal(fix.URL(), url.URL{Path: "/api/v2/runner", RawQuery: "namespace=the-namespace"}))
-		assert.Check(t, cmp.Equal(fix.method, "GET"))
+		assert.Check(t, cmp.Equal(fix.method, http.MethodGet))
 		assert.Check(t, cmp.DeepEqual(fix.Header(), http.Header{
 			"Accept-Encoding": {"gzip"},
 			"Accept-Type":     {"application/json"},

api/schedule_test.go

@@ -67,7 +67,7 @@ func TestSchedules(t *testing.T) {
 		if r.URL.String() != "https://circleci.com/api/v2/project/github/test-org/test-project/schedule" {
 			panic(fmt.Sprintf("unexpected url: %s", r.URL.String()))
 		}
-		if r.Method != "GET" {
+		if r.Method != http.MethodGet {
 			panic(fmt.Sprintf("unexpected method: %s", r.Method))
 		}
 		return mock.NewHTTPResponse(200, formatListResponse([]Schedule{mockSchedule()})), nil
@@ -90,7 +90,7 @@ func TestScheduleByID(t *testing.T) {
 		if r.URL.String() != "https://circleci.com/api/v2/schedule/07f08dea-de06-48d4-9b47-9639229b7d24" {
 			panic(fmt.Sprintf("unexpected url: %s", r.URL.String()))
 		}
-		if r.Method != "GET" {
+		if r.Method != http.MethodGet {
 			panic(fmt.Sprintf("unexpected method: %s", r.Method))
 		}
 		return mock.NewHTTPResponse(200, mockScheduleString()), nil
@@ -114,7 +114,7 @@ func TestScheduleByName(t *testing.T) {
 		if r.URL.String() != "https://circleci.com/api/v2/project/github/test-org/test-project/schedule" {
 			panic(fmt.Sprintf("unexpected url: %s", r.URL.String()))
 		}
-		if r.Method != "GET" {
+		if r.Method != http.MethodGet {
 			panic(fmt.Sprintf("unexpected method: %s", r.Method))
 		}
 		return mock.NewHTTPResponse(200, formatListResponse([]Schedule{mockSchedule()})), nil

cmd/check_test.go

@@ -96,7 +96,7 @@ var _ = Describe("Check", func() {
 
 			tempSettings.TestServer.AppendHandlers(
 				ghttp.CombineHandlers(
-					ghttp.VerifyRequest("GET", "/repos/CircleCI-Public/circleci-cli/releases"),
+					ghttp.VerifyRequest(http.MethodGet, "/repos/CircleCI-Public/circleci-cli/releases"),
 					ghttp.RespondWith(http.StatusOK, response),
 				),
 			)

cmd/config.go

@@ -178,7 +178,7 @@ func processConfig(opts configOptions, flags *pflag.FlagSet) error {
 	var err error
 
 	if len(paramsYaml) > 0 {
-		// The 'src' value can be a filepath, or a yaml string. If the file cannot be read sucessfully,
+		// The 'src' value can be a filepath, or a yaml string. If the file cannot be read successfully,
 		// proceed with the assumption that the value is already valid yaml.
 		raw, err := ioutil.ReadFile(paramsYaml)
 		if err != nil {

cmd/namespace.go

@@ -19,7 +19,7 @@ type namespaceOptions struct {
 
 	// Allows user to skip y/n confirm when creating a namespace
 	noPrompt bool
-	orgID *string
+	orgID    *string
 	// This lets us pass in our own interface for testing
 	tty createNamespaceUserInterface
 	// Linked with --integration-testing flag for stubbing UI in gexec tests
@@ -57,7 +57,7 @@ func newNamespaceCommand(config *settings.Config) *cobra.Command {
 	}
 
 	createCmd := &cobra.Command{
-		Use: "create <name> [<vcs-type>] [<org-name>]",
+		Use:   "create <name> [<vcs-type>] [<org-name>]",
 		Short: "Create a namespace",
 		Long: `Create a namespace.
 Please note that at this time all namespaces created in the registry are world-readable.`,
@@ -76,7 +76,7 @@ Please note that at this time all namespaces created in the registry are world-r
 
 			return createNamespace(cmd, opts)
 		},
-		Args: cobra.RangeArgs(1, 3),
+		Args:        cobra.RangeArgs(1, 3),
 		Annotations: make(map[string]string),
 		Example: `  circleci namespace create NamespaceName github OrgName
   circleci namespace create NamespaceName --org-id "your-org-id-here"`,
@@ -157,17 +157,17 @@ To change the namespace, you will have to contact CircleCI customer support.
 	return nil
 }
 
-func createNamespace(cmd *cobra.Command,opts namespaceOptions) error {
+func createNamespace(cmd *cobra.Command, opts namespaceOptions) error {
 	namespaceName := opts.args[0]
 	//skip if no orgid provided
-	if opts.orgID != nil && strings.TrimSpace(*opts.orgID) != ""{
+	if opts.orgID != nil && strings.TrimSpace(*opts.orgID) != "" {
 		_, err := uuid.Parse(*opts.orgID)
 		if err == nil {
 			return createNamespaceWithOrgId(opts, namespaceName, *opts.orgID)
 		}
 
-	//skip if no vcs type and org name provided
-	} else if len(opts.args) == 3{
+		//skip if no vcs type and org name provided
+	} else if len(opts.args) == 3 {
 		return createNamespaceWithVcsTypeAndOrgName(opts, namespaceName, opts.args[1], opts.args[2])
 	}
 	return cmd.Help()

cmd/orb.go

@@ -76,7 +76,7 @@ type createOrbTestUI struct {
 
 type orbProtectTemplateRelease struct {
 	ZipUrl string `json:"zipball_url"`
-	Name string `json:"name"`
+	Name   string `json:"name"`
 }
 
 func (ui createOrbTestUI) askUserToConfirm(message string) bool {
@@ -1086,7 +1086,6 @@ func initOrb(opts orbOptions) error {
 		}
 	}
 
-
 	latestRelease := releaseTags[0]
 	resp, err := http.Get(latestRelease.ZipUrl)
 	if err != nil {
@@ -1342,7 +1341,7 @@ func initOrb(opts orbOptions) error {
 		return err
 	}
 
-	orbRoot, err := ioutil.ReadFile(path.Join(orbPath, "src",  "@orb.yml"))
+	orbRoot, err := ioutil.ReadFile(path.Join(orbPath, "src", "@orb.yml"))
 	if err != nil {
 		return err
 	}
@@ -1521,7 +1520,7 @@ func unzipToOrbPath(src, dest string) error {
 			}
 		}()
 
-		// This is neccesary because the zip downloaded from GitHub will have a
+		// This is necessary because the zip downloaded from GitHub will have a
 		// directory with the actual template, rather than the template being
 		// top-level.
 		pathParts := strings.Split(f.Name, "/")

cmd/update.go

@@ -73,7 +73,7 @@ func newUpdateCommand(config *settings.Config) *cobra.Command {
 	update.AddCommand(&cobra.Command{
 		Use:    "build-agent",
 		Hidden: true,
-		Short:  "This command has no effect, and is kept for backwards compatiblity",
+		Short:  "This command has no effect, and is kept for backwards compatibility",
 		PersistentPreRun: func(_ *cobra.Command, _ []string) {
 			opts.cfg.SkipUpdateCheck = true
 		},