Use golangci-lint as linter for Go (#1671)

* use golangci-lint as linter for Go instead of golint

* Update hack/verify-golangci-lint.sh

Co-authored-by: Andrey Velichkevich <[email protected]>

* specify golangci-lint version

Co-authored-by: Andrey Velichkevich <[email protected]>

* fix echo comment

Co-authored-by: Andrey Velichkevich <[email protected]>

* fix echo comment

Co-authored-by: Andrey Velichkevich <[email protected]>

* fix lint

* fix gofmt

* fix generated codes

* close the connection for early stopping without using defer

* do not create or delete any resources within gomega.Eventually

* add condition to return error in getKatibJob func

* remove comment out lines

* simplify some codes

Co-authored-by: Andrey Velichkevich <[email protected]>

* remove an unnecessary variable

Co-authored-by: Andrey Velichkevich <[email protected]>

* fix golangci-lint error

Co-authored-by: Andrey Velichkevich <[email protected]>

Co-authored-by: Andrey Velichkevich <[email protected]>

Author: tenzen-y

Makefile

@@ -1,4 +1,4 @@
-HAS_LINT := $(shell command -v golint;)
+HAS_LINT := $(shell command -v golangci-lint;)
 COMMIT := v1beta1-$(shell git rev-parse --short=7 HEAD)
 KATIB_REGISTRY := docker.io/kubeflowkatib
 
@@ -14,10 +14,10 @@ fmt:
 
 lint:
 ifndef HAS_LINT
-	go get -u golang.org/x/lint/golint
-	echo "installing golint"
+	go get -u github.com/golangci/golangci-lint/cmd/[email protected]
+	echo "golangci-lint has been installed"
 endif
-	hack/verify-golint.sh
+	hack/verify-golangci-lint.sh
 
 vet:
 	go vet ./pkg/... ./cmd/...

cmd/metricscollector/v1beta1/file-metricscollector/main.go

@@ -308,7 +308,6 @@ func watchMetricsFile(mFile string, stopRules stopRulesFlag, filters []string) {
 			if err != nil {
 				klog.Fatalf("Could not connect to Early Stopping service, error: %v", err)
 			}
-			defer conn.Close()
 			c := api.NewEarlyStoppingClient(conn)
 
 			setTrialStatusReq := &api.SetTrialStatusRequest{
@@ -320,9 +319,9 @@ func watchMetricsFile(mFile string, stopRules stopRulesFlag, filters []string) {
 			if err != nil {
 				klog.Fatalf("Set Trial status error: %v", err)
 			}
+			conn.Close()
 
 			klog.Infof("Trial status is successfully updated")
-
 		}
 	}
 }

hack/.golint_failures

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+# Copyright 2021 The Kubeflow Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -o errexit
+set -o pipefail
+
+cd $(dirname "$0")/..
+
+if ! which golangci-lint >/dev/null; then
+	echo 'Can not find golangci-lint, install with: make lint'
+	exit 1
+fi
+
+echo 'Running golangci-lint'
+golangci-lint run --timeout 5m

hack/verify-golangci-lint.sh

@@ -200,14 +200,14 @@ const (
 	StdOutCollector CollectorKind = "StdOut"
 
 	FileCollector   CollectorKind = "File"
-	DefaultFilePath               = "/var/log/katib/metrics.log"
+	DefaultFilePath string        = "/var/log/katib/metrics.log"
 
 	TfEventCollector              CollectorKind = "TensorFlowEvent"
-	DefaultTensorflowEventDirPath               = "/var/log/katib/tfevent/"
+	DefaultTensorflowEventDirPath string        = "/var/log/katib/tfevent/"
 
 	PrometheusMetricCollector CollectorKind = "PrometheusMetric"
-	DefaultPrometheusPath                   = "/metrics"
-	DefaultPrometheusPort                   = 8080
+	DefaultPrometheusPath     string        = "/metrics"
+	DefaultPrometheusPort     int           = 8080
 
 	CustomCollector CollectorKind = "Custom"
 

hack/verify-golint.sh

@@ -23,10 +23,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-const (
-	cleanDataFinalizer = "clean-data-in-db"
-)
-
 func getCondition(exp *Experiment, condType ExperimentConditionType) *ExperimentCondition {
 	if exp.Status.Conditions != nil {
 		for _, condition := range exp.Status.Conditions {

pkg/apis/controller/common/v1beta1/common_types.go

@@ -278,7 +278,7 @@ func (r *ReconcileExperiment) ReconcileExperiment(instance *experimentsv1beta1.E
 	}
 	reconcileRequired := !instance.IsCompleted()
 	if reconcileRequired {
-		r.ReconcileTrials(instance, trials.Items)
+		return r.ReconcileTrials(instance, trials.Items)
 	}
 
 	return nil

pkg/apis/controller/experiments/v1beta1/util.go

@@ -46,15 +46,19 @@ func TestMain(m *testing.M) {
 			filepath.Join("..", "..", "..", "manifests", "v1beta1", "components", "crd"),
 		},
 	}
-	apis.AddToScheme(scheme.Scheme)
-
 	var err error
+	if err = apis.AddToScheme(scheme.Scheme); err != nil {
+		stdlog.Fatal(err)
+	}
+
 	if cfg, err = t.Start(); err != nil {
 		stdlog.Fatal(err)
 	}
 
 	code := m.Run()
-	t.Stop()
+	if err = t.Stop(); err != nil {
+		stdlog.Fatal(err)
+	}
 	os.Exit(code)
 }