remove logrus references and enable logrus_analyzer in CI

Author: tejal29

cmd/skaffold/app/cmd/cmd.go

@@ -23,13 +23,11 @@ import (
 	"os"
 	"strings"
 
-	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	"k8s.io/kubectl/pkg/util/templates"
 
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/config"
-	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/constants"
 	sErrors "github.com/GoogleContainerTools/skaffold/pkg/skaffold/errors"
 	event "github.com/GoogleContainerTools/skaffold/pkg/skaffold/event/v2"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/instrumentation"
@@ -198,7 +196,7 @@ func NewSkaffoldCommand(out, errOut io.Writer) *cobra.Command {
 	rootCmd.AddCommand(NewCmdInspect())
 
 	templates.ActsAsRootCommand(rootCmd, nil, groups...)
-	rootCmd.PersistentFlags().StringVarP(&v, "verbosity", "v", constants.DefaultLogLevel.String(), fmt.Sprintf("Log level: one of %v", logrus.AllLevels))
+	rootCmd.PersistentFlags().StringVarP(&v, "verbosity", "v", log.DefaultLogLevel.String(), fmt.Sprintf("Log level: one of %v", log.AllLevels))
 	rootCmd.PersistentFlags().IntVar(&defaultColor, "color", int(output.DefaultColorCode), "Specify the default output color in ANSI escape codes")
 	rootCmd.PersistentFlags().BoolVar(&forceColors, "force-colors", false, "Always print color codes (hidden)")
 	rootCmd.PersistentFlags().BoolVar(&interactive, "interactive", true, "Allow user prompts for more information")
@@ -254,17 +252,7 @@ func FlagToEnvVarName(f *pflag.Flag) string {
 }
 
 func setUpLogs(stdErr io.Writer, level string, timestamp bool) error {
-	logrus.SetOutput(stdErr)
-	lvl, err := logrus.ParseLevel(level)
-	if err != nil {
-		return fmt.Errorf("parsing log level: %w", err)
-	}
-	logrus.SetLevel(lvl)
-	logrus.SetFormatter(&logrus.TextFormatter{
-		FullTimestamp: timestamp,
-	})
-	logrus.AddHook(event.NewLogHook())
-	return nil
+	return log.SetupLogs(stdErr, level, timestamp, event.NewLogHook())
 }
 
 // alwaysSucceedWhenCancelled returns nil if the context was cancelled.

hack/generate-statik.sh

@@ -51,7 +51,7 @@ cp -R docs/content/en/schemas "${TMP_DIR}/schemas"
 if ! [[ -f ${STATIK} ]]; then
     echo 'Installing statik tool'
     pushd ${DIR}/tools
-    GOBIN=${BIN} GO111MODULE=on go install -mod=vendor -tags tools github.com/rakyll/statik
+    GOBIN=${BIN} GO111MODULE=on go install -tags tools github.com/rakyll/statik
     popd
 fi
 

hack/golangci-lint.sh

@@ -44,18 +44,16 @@ fi
 ${BIN}/golangci-lint run ${FLAGS} --exclude=SA1019 -c ${DIR}/golangci.yml \
     | awk '/out of memory/ || /Timeout exceeded/ {failed = 1}; {print}; END {exit failed}'
 
-if [[ "${CUSTOM_LINTER}" == "true" ]]; then
-  # Install and run custom linter to detect usage for logrus package.
-  # Currently, we can't run private custom linter in golangcl-lint due to abandoned issue
-  # https://github.com/golangci/golangci-lint/issues/1276
-  if ! [ -x "$(command -v ${BIN}/logrus-analyzer)" ] ; then
-    echo >&2 'Installing custom logrus linter'
-    cd "${DIR}/tools"
-    GO111MODULE=on go build -o ${BIN}/logrus-analyzer logrus_analyzer.go
-    cd -
-  fi
-
-  ${BIN}/logrus-analyzer ${FLAGS} github.com/GoogleContainerTools/skaffold... \
-    | awk '/out of memory/ || /Timeout exceeded/ {failed = 1}; {print}; END {exit failed}'
+
+# Install and run custom linter to detect usage for logrus package.
+# Currently, we can't run private custom linter in golangcl-lint due to abandoned issue
+# https://github.com/golangci/golangci-lint/issues/1276
+if ! [ -x "$(command -v ${BIN}/logrus-analyzer)" ] ; then
+  echo >&2 'Installing custom logrus linter'
+  cd "${DIR}/tools"
+  GO111MODULE=on go build -o ${BIN}/logrus-analyzer logrus_analyzer.go
+  cd -
 fi
+${BIN}/logrus-analyzer ${FLAGS} github.com/GoogleContainerTools/skaffold{/pkg,/cmd,/diag}...
+
 

hack/tools/linters/logrus.go

@@ -23,6 +23,15 @@ import (
 	"golang.org/x/tools/go/analysis"
 )
 
+// Ignore files
+var ignoreFileSuffixes = []string {
+	// always ignore test files
+	"_test.go",
+	"pkg/skaffold/output/log/log.go",
+	"pkg/skaffold/event/v2/logger.go",
+	"pkg/skaffold/build/buildpacks/logger.go",
+
+}
 var LogrusAnalyzer = &analysis.Analyzer{
 	Name: "logruslinter",
 	Doc:  "find usage of logrus",
@@ -31,14 +40,19 @@ var LogrusAnalyzer = &analysis.Analyzer{
 
 func run(pass *analysis.Pass) (interface{}, error) {
 	for _, file := range pass.Files {
+		pos := pass.Fset.PositionFor(file.Pos(), false)
+		// Ignore logrus usage in test files
+		if ignore(pos.Filename) {
+			continue
+		}
 		ast.Inspect(file, func(n ast.Node) bool {
 			if importSpec, ok := n.(*ast.ImportSpec); ok {
 				if importSpec.Path != nil && strings.Contains(importSpec.Path.Value, "github.com/sirupsen/logrus") {
 					pass.Report(analysis.Diagnostic{
 						Pos:      importSpec.Pos(),
 						End:      0,
 						Category: "logrus-analyzer",
-						Message:  "Dont use github.com/sirupsen/logrus package, use output.Log instead.",
+						Message:  "Do not use github.com/sirupsen/logrus package, use output.log.Entry instead.",
 					})
 				}
 			}
@@ -47,3 +61,12 @@ func run(pass *analysis.Pass) (interface{}, error) {
 	}
 	return nil, nil
 }
+
+func ignore(f string) bool {
+	for _, v := range ignoreFileSuffixes {
+		if strings.HasSuffix(f, v) {
+			return true
+	  }
+	}
+	return false
+}