fix: Small fixes and adding the lint check on GH actions

Tarun Khandelwal · Tarun Khandelwal · commit d4ce8cc55bb4 · 2021-02-16T19:17:00.000+05:30
Signed-off-by: Tarun Khandelwal &lt;tarkhand@redhat.com&gt;

Did some small changes to resolve some typos and added the go lint to GH actions and remove existing errors

Signed-off-by: Tarun Khandelwal &lt;tarkhand@redhat.com&gt;
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,24 @@
+### Description
+
+_Short summary of what is the issue and the solution._
+
+### Dependencies
+
+- _Ex. Other PRs._
+
+### Breaking Change
+
+- [ ] Yes
+- [ ] No
+
+### Testing Notes
+
+**What I did:**
+_What did you do to validate this PR?_
+
+**How you can replicate my testing:**
+_How can the reviewer validate this PR?_
+
+### **Links**
+
+_Issues links or other related resources_
diff --git a/.github/semantic.yml b/.github/semantic.yml
@@ -0,0 +1,10 @@
+# Always validate all commits, and ignore the PR title
+commitsOnly: true
+
+# Allow use of Merge commits (eg on github: "Merge branch 'master' into feature/ride-unicorns")
+# this is only relevant when using commitsOnly: true (or titleAndCommits: true)
+allowMergeCommits: true
+
+# Allow use of Revert commits (eg on github: "Revert "feat: ride unicorns"")
+# this is only relevant when using commitsOnly: true (or titleAndCommits: true)
+allowRevertCommits: true
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,19 @@
+name: Lint
+on:
+  push:
+    tags:
+      - v*
+    branches:
+      - master
+  pull_request:
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v2
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v2
+        with:
+          version: v1.36
diff --git a/.golangci.yml b/.golangci.yml
@@ -0,0 +1,39 @@
+run:
+  # timeout for analysis, e.g. 30s, 5m, default is 1m
+  timeout: 20m
+
+linters:
+  # please, do not use `enable-all`: it's deprecated and will be removed soon.
+  # inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
+  disable-all: true
+  enable:
+    - bodyclose
+    - deadcode
+    - depguard
+    - dogsled
+    - errcheck
+    - goconst
+    - gofmt
+    - goimports
+    - golint
+    - goprintffuncname
+    - gosimple
+    - govet
+    - ineffassign
+    - interfacer
+    - misspell
+    - nakedret
+    - rowserrcheck
+    - staticcheck
+    - structcheck
+    - stylecheck
+    - typecheck
+    - unconvert
+    - unparam
+    - unused
+    - varcheck
+    - whitespace
+
+linters-settings:
+  gofmt:
+    simplify: false
diff --git a/api/v1/gitbranch_types.go b/api/v1/gitbranch_types.go
@@ -23,7 +23,7 @@ import (
 // GitBranchSpec defines the desired state of GitBranch
 type GitBranchSpec struct {
 	Repository string `json:"repository,omitempty"`
-	BranchName string `json:"branchName,omitmepty"`
+	BranchName string `json:"branchName,omitempty"`
 }
 
 // GitBranchStatus defines the observed state of GitBranch
diff --git a/api/v1/groupversion_info.go b/api/v1/groupversion_info.go
@@ -47,7 +47,3 @@ var (
 	// Serializer provides high-level encoding/decoding functions
 	Serializer = serializer.NewSerializer(Scheme, &codecs)
 )
-
-func init() {
-	AddToScheme(Scheme)
-}
diff --git a/connectors/connector.go b/connectors/connector.go
@@ -58,7 +58,7 @@ func NewConnector(ctx context.Context, crdClient client.Client, k8sClient *kuber
 		if !found {
 			password = []byte{}
 		}
-		return NewGitSSH(crdClient, log, sshURL, string(user), privateKey, string(password))
+		return NewGitSSH(crdClient, log, sshURL, user, privateKey, string(password))
 	}
 	return nil, errors.New("no connector settings found")
 }
diff --git a/connectors/github.go b/connectors/github.go
@@ -211,7 +211,9 @@ func (g *Github) CreatePullRequest(ctx context.Context, pr PullRequest) error {
 	ghPR, response, err := g.scm.PullRequests.Create(ctx, repoName, prRequest)
 	if err != nil {
 		buf := new(bytes.Buffer)
-		buf.ReadFrom(response.Body)
+		if _, err := buf.ReadFrom(response.Body); err != nil {
+			log.Errorf("Error reading the response body: %v", err)
+		}
 		log.Errorf("Github status code: %d", response.Status)
 		log.Errorf("Github response:\n [%s]", buf.String())
 		return errors.Wrap(err, "failed to create PullRequest in Github")
diff --git a/connectors/github_util.go b/connectors/github_util.go
@@ -20,8 +20,8 @@ type GithubFetcher struct {
 }
 
 func (g *GithubFetcher) BuildPRCRDsFromGithub(ctx context.Context, lastUpdated time.Time) ([]gitv1.GitPullRequest, error) {
-	crdPRs := []gitv1.GitPullRequest{}
-	repoName := g.repositoryName(g.repository)
+	var crdPRs []gitv1.GitPullRequest
+	repoName := g.repositoryName()
 
 	prs, _, err := g.client.PullRequests.List(ctx, repoName, scm.PullRequestListOptions{UpdatedAfter: &lastUpdated})
 	if err != nil {
@@ -40,7 +40,7 @@ func (g *GithubFetcher) BuildPRCRDsFromGithub(ctx context.Context, lastUpdated t
 }
 
 func (g *GithubFetcher) BuildPRCRDFromGithub(ctx context.Context, pr *scm.PullRequest, lastUpdated time.Time) (*gitv1.GitPullRequest, error) {
-	repositoryName := g.repositoryName(g.repository)
+	repositoryName := g.repositoryName()
 	reviewers := []string{}
 	approvers := map[string]bool{}
 
@@ -91,7 +91,7 @@ func (g *GithubFetcher) BuildPRCRDFromGithub(ctx context.Context, pr *scm.PullRe
 
 func (g *GithubFetcher) BuildBranchCRDsFromGithub(ctx context.Context, lastUpdated time.Time) ([]gitv1.GitBranch, error) {
 	crdBranches := []gitv1.GitBranch{}
-	repoName := g.repositoryName(g.repository)
+	repoName := g.repositoryName()
 
 	branches, _, err := g.client.Git.ListBranches(ctx, repoName, scm.ListOptions{})
 	if err != nil {
@@ -110,7 +110,7 @@ func (g *GithubFetcher) BuildBranchCRDsFromGithub(ctx context.Context, lastUpdat
 }
 
 func (g *GithubFetcher) BuildBranchCRDFromGithub(ctx context.Context, branch *scm.Reference, lastUpdated time.Time) (*gitv1.GitBranch, error) {
-	repositoryName := g.repositoryName(g.repository)
+	repositoryName := g.repositoryName()
 
 	crd := gitv1.GitBranch{
 		ObjectMeta: metav1.ObjectMeta{
@@ -134,7 +134,7 @@ func (g *GithubFetcher) BuildBranchCRDFromGithub(ctx context.Context, branch *sc
 	return &crd, nil
 }
 
-func (g *GithubFetcher) repositoryName(r gitv1.GitRepository) string {
+func (g *GithubFetcher) repositoryName() string {
 	return fmt.Sprintf("%s/%s", g.owner, g.repoName)
 }
 
diff --git a/connectors/gitssh.go b/connectors/gitssh.go
@@ -6,7 +6,6 @@ import (
 	"os"
 
 	gitv1 "github.com/flanksource/git-operator/api/v1"
-	v1 "github.com/flanksource/git-operator/api/v1"
 	"github.com/go-git/go-billy/v5"
 	"github.com/go-git/go-billy/v5/memfs"
 	git "github.com/go-git/go-git/v5"
@@ -44,6 +43,9 @@ func (g *GitSSH) Clone(ctx context.Context, branch string) (billy.Filesystem, *g
 		Progress: os.Stdout,
 		Auth:     g.auth,
 	})
+	if err != nil {
+		return nil, nil, err
+	}
 
 	work, err := repo.Worktree()
 	if err != nil {
@@ -145,17 +147,19 @@ func (g *GitSSH) GetBranchCRDsFromRemote(ctx context.Context, repository *gitv1.
 		return nil, errors.Wrap(err, "failed to list branches")
 	}
 
-	branches := []v1.GitBranch{}
+	branches := []gitv1.GitBranch{}
 
-	branchesIter.ForEach(func(ref *plumbing.Reference) error {
+	if err := branchesIter.ForEach(func(ref *plumbing.Reference) error {
 		// Ignore HEAD
 		if ref.Name().Short() == "HEAD" {
 			return nil
 		}
 		branch := g.GetBranchCRDFromRemote(repository, ref)
 		branches = append(branches, branch)
 		return nil
-	})
+	}); err != nil {
+		return nil, err
+	}
 
 	return branches, nil
 }
diff --git a/connectors/pull_request.go b/connectors/pull_request.go
@@ -58,7 +58,9 @@ func (p *PullRequestDiff) createInGithub(ctx context.Context, pr *gitv1.GitPullR
 	ghPR, response, err := p.GithubClient.PullRequests.Create(ctx, repoName, prRequest)
 	if err != nil {
 		buf := new(bytes.Buffer)
-		buf.ReadFrom(response.Body)
+		if _, err := buf.ReadFrom(response.Body); err != nil {
+			log.Errorf("Error reading the response body: %v", err)
+		}
 		log.Errorf("Github status code: %d", response.Status)
 		log.Errorf("Github response:\n [%s]", buf.String())
 		return errors.Wrap(err, "failed to create PullRequest in Github")
diff --git a/controllers/gitopsapi_controller.go b/controllers/gitopsapi_controller.go
@@ -117,7 +117,9 @@ func serve(c echo.Context, r *GitopsAPIReconciler) error {
 	branchName := fmt.Sprintf("automated-update-%s", timestamp)
 
 	if api.Spec.PullRequest {
-		work.Checkout(&gitv5.CheckoutOptions{Branch: plumbing.NewBranchReferenceName(branchName), Create: true})
+		if err := work.Checkout(&gitv5.CheckoutOptions{Branch: plumbing.NewBranchReferenceName(branchName), Create: true}); err != nil {
+			return err
+		}
 	}
 
 	obj := unstructured.Unstructured{Object: make(map[string]interface{})}
@@ -127,7 +129,7 @@ func serve(c echo.Context, r *GitopsAPIReconciler) error {
 		return c.String(http.StatusInternalServerError, err.Error())
 	}
 
-	prettyYaml, err := yaml.Marshall(obj.Object)
+	prettyYaml, err := yaml.Marshal(obj.Object)
 	if err != nil {
 		r.Log.Error(err, "error marshalling to yaml, falling back to plaintext")
 	} else {
@@ -225,7 +227,7 @@ func copy(data []byte, path string, fs billy.Filesystem, work *gitv5.Worktree) e
 	if err != nil {
 		return errors.Wrap(err, "failed to open")
 	}
-	src := bytes.NewBuffer([]byte(data))
+	src := bytes.NewBuffer(data)
 	if _, err := io.Copy(dst, src); err != nil {
 		return errors.Wrap(err, "failed to copy")
 	}
@@ -248,9 +250,11 @@ func (r *GitopsAPIReconciler) SetupWithManager(mgr ctrl.Manager) error {
 
 	r.Clientset = clientset
 	r.Client = mgr.GetClient()
-	ctrl.NewControllerManagedBy(mgr).
+	if err := ctrl.NewControllerManagedBy(mgr).
 		For(&gitv1.GitopsAPI{}).
-		Complete(r)
+		Complete(r); err != nil {
+		return err
+	}
 	e := echo.New()
 	e.POST("/:namespace/:name/:token", func(c echo.Context) error {
 		return serve(c, r)
@@ -263,5 +267,4 @@ func (r *GitopsAPIReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	}()
 
 	return nil
-
 }
diff --git a/go.mod b/go.mod
@@ -5,47 +5,33 @@ go 1.14
 require (
 	github.com/flanksource/commons v1.4.3
 	github.com/flanksource/kommons v0.1.6
-	github.com/fluxcd/go-git-providers v0.0.3
-	github.com/fluxcd/toolkit v0.0.1-beta.2
-	github.com/go-git/go-billy v4.2.0+incompatible
 	github.com/go-git/go-billy/v5 v5.0.0
 	github.com/go-git/go-git/v5 v5.1.0
 	github.com/go-logr/logr v0.2.1
-	github.com/go-logr/zapr v0.2.0
-	github.com/go-openapi/spec v0.19.8
+	github.com/go-logr/zapr v0.2.0 // indirect
 	github.com/google/go-github/v32 v32.1.0
 	github.com/jenkins-x/go-scm v1.5.141
 	github.com/labstack/echo v3.3.10+incompatible
-	github.com/labstack/gommon v0.3.0 // indirect
-	github.com/mattn/go-isatty v0.0.12 // indirect
-	github.com/mitchellh/go-homedir v1.1.0
 	github.com/nbio/st v0.0.0-20140626010706-e9e8d9816f32 // indirect
 	github.com/onsi/ginkgo v1.14.0
 	github.com/onsi/gomega v1.10.1
 	github.com/pkg/errors v0.9.1
-	github.com/rjeczalik/notify v0.9.2
 	github.com/sirupsen/logrus v1.7.0
-	github.com/spf13/pflag v1.0.5
-	github.com/stretchr/testify v1.6.1
 	github.com/weaveworks/libgitops v0.0.3
 	go.uber.org/zap v1.15.0
 	golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9
 	golang.org/x/oauth2 v0.0.0-20191202225959-858c2ad4c8b6
-	golang.org/x/sys v0.0.0-20200812155832-6a926be9bd1d
-	gopkg.in/src-d/go-billy.v4 v4.3.2
 	gopkg.in/yaml.v2 v2.3.0
 	k8s.io/api v0.19.3
 	k8s.io/apimachinery v0.19.3
 	k8s.io/client-go v11.0.0+incompatible
-	k8s.io/kube-openapi v0.0.0-20200805222855-6aeccd4b50c6
 	sigs.k8s.io/controller-runtime v0.6.0
 	sigs.k8s.io/kustomize/api v0.4.1
-	sigs.k8s.io/kustomize/kyaml v0.1.11
-	sigs.k8s.io/yaml v1.2.0
 
 )
 
 replace (
+	github.com/Azure/go-autorest => github.com/Azure/go-autorest v13.3.2+incompatible
 	github.com/docker/distribution => github.com/docker/distribution v2.7.1+incompatible
 	google.golang.org/genproto => google.golang.org/genproto v0.0.0-20191230161307-f3c370f40bfb
 	google.golang.org/grpc => google.golang.org/grpc v1.26.0
diff --git a/go.sum b/go.sum
diff --git a/main.go b/main.go
diff --git a/test/e2e.go b/test/e2e.go

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ import (`
`23`	`23`	`// GitBranchSpec defines the desired state of GitBranch`
`24`	`24`	`type GitBranchSpec struct {`
`25`	`25`	Repository string `json:"repository,omitempty"`
`26`		- BranchName string `json:"branchName,omitmepty"`
	`26`	+ BranchName string `json:"branchName,omitempty"`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`// GitBranchStatus defines the observed state of GitBranch`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,3 @@ var (`
`47`	`47`	`// Serializer provides high-level encoding/decoding functions`
`48`	`48`	`Serializer = serializer.NewSerializer(Scheme, &codecs)`
`49`	`49`	`)`
`50`		`-`
`51`		`-func init() {`
`52`		`- AddToScheme(Scheme)`
`53`		`-}`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ func NewConnector(ctx context.Context, crdClient client.Client, k8sClient *kuber`
`58`	`58`	`if !found {`
`59`	`59`	`password = []byte{}`
`60`	`60`	`}`
`61`		`- return NewGitSSH(crdClient, log, sshURL, string(user), privateKey, string(password))`
	`61`	`+ return NewGitSSH(crdClient, log, sshURL, user, privateKey, string(password))`
`62`	`62`	`}`
`63`	`63`	`return nil, errors.New("no connector settings found")`
`64`	`64`	`}`