Merge pull request #2346 from timflannagan/add-sanity-check

Introduce a sanity workflow for checking static linting violations in CI

Author: timflannagan

.github/workflows/sanity.yaml

@@ -0,0 +1,23 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    paths:
+      - '**'
+      - '!doc/**'
+
+jobs:
+  sanity:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: '~1.16'
+      - name: Install goimports
+        run: go install golang.org/x/tools/cmd/goimports@latest
+      - name: Run sanity checks
+        run: make vendor && make lint && make diff

Makefile

@@ -184,6 +184,9 @@ clean:
 	@rm -rf test/e2e/log
 	@rm -rf e2e.namespace
 
+lint:
+	find . -name '*.go' -not -path "./vendor/*" -not -path "./pkg/lib/operatorclient/operatorclientmocks/*" | xargs gofmt -w
+	find . -name '*.go' -not -path "./vendor/*" -not -path "./pkg/lib/operatorclient/operatorclientmocks/*" | xargs goimports -w
 
 # Copy CRD manifests
 manifests: vendor

pkg/controller/certs/certs.go

@@ -16,12 +16,12 @@ import (
 )
 
 type CertGenerator interface {
-  Generate(notAfter time.Time, organization string, ca *KeyPair, hosts []string) (*KeyPair, error)
+	Generate(notAfter time.Time, organization string, ca *KeyPair, hosts []string) (*KeyPair, error)
 }
 
 type CertGeneratorFunc func(notAfter time.Time, organization string, ca *KeyPair, hosts []string) (*KeyPair, error)
 
-func (f CertGeneratorFunc) Generate(notAfter time.Time, organization string, ca *KeyPair, hosts []string) (*KeyPair, error)  {
+func (f CertGeneratorFunc) Generate(notAfter time.Time, organization string, ca *KeyPair, hosts []string) (*KeyPair, error) {
 	return f(notAfter, organization, ca, hosts)
 }
 

pkg/controller/operators/catalog/installplan_sync.go

@@ -4,7 +4,6 @@ import (
 	"context"
 	"errors"
 
-
 	"github.com/sirupsen/logrus"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/labels"

pkg/controller/operators/openshift/clusteroperator_controller_test.go

@@ -2,6 +2,7 @@ package openshift
 
 import (
 	"fmt"
+
 	semver "github.com/blang/semver/v4"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"

pkg/controller/operators/operatorcondition_controller_test.go

@@ -6,8 +6,8 @@ import (
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
-	operatorsv2 "github.com/operator-framework/api/pkg/operators/v2"
 	operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
+	operatorsv2 "github.com/operator-framework/api/pkg/operators/v2"
 	"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/ownerutil"
 
 	appsv1 "k8s.io/api/apps/v1"

pkg/controller/operators/operatorconditiongenerator_controller_test.go

@@ -14,8 +14,8 @@ import (
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
-	operatorsv2 "github.com/operator-framework/api/pkg/operators/v2"
 	operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
+	operatorsv2 "github.com/operator-framework/api/pkg/operators/v2"
 )
 
 var _ = Describe("The OperatorConditionsGenerator Controller", func() {

pkg/controller/registry/grpc/source.go

@@ -2,10 +2,11 @@ package grpc
 
 import (
 	"context"
-	"github.com/operator-framework/operator-registry/pkg/client"
 	"sync"
 	"time"
 
+	"github.com/operator-framework/operator-registry/pkg/client"
+
 	"github.com/sirupsen/logrus"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/connectivity"
@@ -225,4 +226,4 @@ func (s *SourceStore) ClientsForNamespaces(namespaces ...string) map[registry.Ca
 
 	// TODO : remove unhealthy
 	return refs
-}
+}

pkg/controller/registry/resolver/rbac.go

@@ -22,7 +22,7 @@ func generateName(base string, o interface{}) string {
 	hashutil.DeepHashObject(hasher, o)
 	hash := utilrand.SafeEncodeString(fmt.Sprint(hasher.Sum32()))
 	if len(base)+len(hash) > maxNameLength {
-		base = base[:maxNameLength - len(hash) - 1]
+		base = base[:maxNameLength-len(hash)-1]
 	}
 
 	return fmt.Sprintf("%s-%s", base, hash)

pkg/controller/registry/resolver/rbac_test.go

@@ -29,15 +29,15 @@ func TestGenerateName(t *testing.T) {
 			name: "generate",
 			args: args{
 				base: "myname",
-				o: []string{"something"},
+				o:    []string{"something"},
 			},
 			want: "myname-9c895f74f",
 		},
 		{
 			name: "truncated",
 			args: args{
 				base: strings.Repeat("name", 100),
-				o: []string{"something", "else"},
+				o:    []string{"something", "else"},
 			},
 			want: "namenamenamenamenamenamenamenamenamenamenamenamename-78fd8b4d6b",
 		},