Changed to golangci-lint and introduced LintChanges command (#3057)

* Changed to golangci-lint and introduced LintChanges command

Signed-off-by: David Gannon <19214156+dgannon991@users.noreply.github.com>

---------

Signed-off-by: David Gannon <19214156+dgannon991@users.noreply.github.com>

cmd/exec/main.go

@@ -31,7 +31,7 @@ func main() {
 		defer func() {
 			// Capture panics and trace them
 			if panicErr := recover(); panicErr != nil {
-				log.Error(fmt.Errorf("%s", panicErr),
+				_ = log.Error(fmt.Errorf("%s", panicErr),
 					attribute.Bool("panic", true),
 					attribute.String("stackTrace", string(debug.Stack())))
 				log.EndSpan()

cmd/porter/bundle.go

@@ -86,7 +86,7 @@ The docker driver builds the bundle image using the local Docker host. To use a
 		"Path to the build context directory where all bundle assets are located. Defaults to the current directory.")
 	f.StringVar(&opts.Driver, "driver", porter.BuildDriverDefault,
 		fmt.Sprintf("Driver for building the invocation image. Allowed values are: %s", strings.Join(porter.BuildDriverAllowedValues, ", ")))
-	f.MarkHidden("driver") // Hide the driver flag since there aren't any choices to make right now
+	_ = f.MarkHidden("driver") // Hide the driver flag since there aren't any choices to make right now
 	f.StringArrayVar(&opts.BuildArgs, "build-arg", nil,
 		"Set build arguments in the template Dockerfile (format: NAME=VALUE). May be specified multiple times. Max length is 5,000 characters.")
 	f.StringArrayVar(&opts.SSH, "ssh", nil,

cmd/porter/bundle_test.go

@@ -190,9 +190,10 @@ func TestBuildValidate_Driver(t *testing.T) {
 				// noop
 				return nil
 			}
-			p.FileSystem.WriteFile("porter.yaml", []byte(""), pkg.FileModeWritable)
+			err := p.FileSystem.WriteFile("porter.yaml", []byte(""), pkg.FileModeWritable)
+			require.NoError(t, err)
 
-			err := rootCmd.Execute()
+			err = rootCmd.Execute()
 			if tc.wantError == "" {
 				require.NoError(t, err)
 				assert.Equal(t, tc.wantDriver, p.Data.BuildDriver)

cmd/porter/completion.go

@@ -16,17 +16,18 @@ For additional details see: https://porter.sh/install#command-completion`,
 		DisableFlagsInUseLine: true,
 		ValidArgs:             []string{"bash", "zsh", "fish", "powershell"},
 		Args:                  cobra.MatchAll(cobra.ExactArgs(1), cobra.OnlyValidArgs),
-		Run: func(cmd *cobra.Command, args []string) {
+		RunE: func(cmd *cobra.Command, args []string) error {
 			switch args[0] {
 			case "bash":
-				cmd.Root().GenBashCompletion(p.Out)
+				return cmd.Root().GenBashCompletion(p.Out)
 			case "zsh":
-				cmd.Root().GenZshCompletion(p.Out)
+				return cmd.Root().GenZshCompletion(p.Out)
 			case "fish":
-				cmd.Root().GenFishCompletion(p.Out, true)
+				return cmd.Root().GenFishCompletion(p.Out, true)
 			case "powershell":
-				cmd.Root().GenPowerShellCompletionWithDesc(p.Out)
+				return cmd.Root().GenPowerShellCompletionWithDesc(p.Out)
 			}
+			return nil
 		},
 	}
 	cmd.Annotations = map[string]string{

cmd/porter/installations.go

@@ -435,5 +435,5 @@ func addBundleActionFlags(f *pflag.FlagSet, actionOpts porter.BundleAction) {
 
 	// Gracefully support any renamed flags
 	f.StringArrayVar(&opts.CredentialIdentifiers, "cred", nil, "DEPRECATED")
-	f.MarkDeprecated("cred", "please use credential-set instead.")
+	_ = f.MarkDeprecated("cred", "please use credential-set instead.")
 }

cmd/porter/main.go

@@ -69,7 +69,7 @@ func main() {
 		defer func() {
 			// Capture panics and trace them
 			if panicErr := recover(); panicErr != nil {
-				log.Error(fmt.Errorf("%s", panicErr),
+				_ = log.Error(fmt.Errorf("%s", panicErr),
 					attribute.Bool("panic", true),
 					attribute.String("stackTrace", string(debug.Stack())))
 				log.EndSpan()
@@ -84,7 +84,7 @@ func main() {
 		if err := rootCmd.ExecuteContext(ctx); err != nil {
 			// Ideally we log all errors in the span that generated it,
 			// but as a failsafe, always log the error at the root span as well
-			log.Error(err)
+			_ = log.Error(err)
 			return cli.ExitCodeErr
 		}
 		return cli.ExitCodeSuccess

cmd/porter/main_test.go

@@ -97,7 +97,9 @@ func TestExperimentalFlags(t *testing.T) {
 
 		cmd := buildRootCommandFrom(p.Porter)
 		cmd.SetArgs([]string{"install"})
-		cmd.Execute()
+		err := cmd.Execute()
+		require.Error(t, err)
+
 		assert.False(t, p.Config.IsFeatureEnabled(experimental.FlagNoopFeature))
 	})
 
@@ -107,7 +109,8 @@ func TestExperimentalFlags(t *testing.T) {
 
 		cmd := buildRootCommandFrom(p.Porter)
 		cmd.SetArgs([]string{"install", "--experimental", experimental.NoopFeature})
-		cmd.Execute()
+		err := cmd.Execute()
+		require.Error(t, err)
 
 		assert.True(t, p.Config.IsFeatureEnabled(experimental.FlagNoopFeature))
 	})
@@ -121,7 +124,8 @@ func TestExperimentalFlags(t *testing.T) {
 
 		cmd := buildRootCommandFrom(p.Porter)
 		cmd.SetArgs([]string{"install"})
-		cmd.Execute()
+		err := cmd.Execute()
+		require.Error(t, err)
 
 		assert.True(t, p.Config.IsFeatureEnabled(experimental.FlagNoopFeature))
 	})
@@ -134,7 +138,8 @@ func TestExperimentalFlags(t *testing.T) {
 		require.NoError(t, p.FileSystem.WriteFile("/home/myuser/.porter/config.yaml", cfg, pkg.FileModeWritable))
 		cmd := buildRootCommandFrom(p.Porter)
 		cmd.SetArgs([]string{"install"})
-		cmd.Execute()
+		err := cmd.Execute()
+		require.Error(t, err)
 
 		assert.True(t, p.Config.IsFeatureEnabled(experimental.FlagNoopFeature))
 	})
@@ -147,7 +152,8 @@ func TestExperimentalFlags(t *testing.T) {
 		require.NoError(t, p.FileSystem.WriteFile("/home/myuser/.porter/config.yaml", cfg, pkg.FileModeWritable))
 		cmd := buildRootCommandFrom(p.Porter)
 		cmd.SetArgs([]string{"install", "--experimental", "no-op"})
-		cmd.Execute()
+		err := cmd.Execute()
+		require.Error(t, err)
 
 		assert.True(t, p.Config.IsFeatureEnabled(experimental.FlagNoopFeature))
 	})
@@ -161,7 +167,8 @@ func TestExperimentalFlags(t *testing.T) {
 
 		cmd := buildRootCommandFrom(p.Porter)
 		cmd.SetArgs([]string{"install", "--experimental", "no-op"})
-		cmd.Execute()
+		err := cmd.Execute()
+		require.Error(t, err)
 
 		assert.True(t, p.Config.IsFeatureEnabled(experimental.FlagNoopFeature))
 	})
@@ -177,7 +184,8 @@ func TestExperimentalFlags(t *testing.T) {
 		require.NoError(t, p.FileSystem.WriteFile("/home/myuser/.porter/config.yaml", cfg, pkg.FileModeWritable))
 		cmd := buildRootCommandFrom(p.Porter)
 		cmd.SetArgs([]string{"install"})
-		cmd.Execute()
+		err := cmd.Execute()
+		require.Error(t, err)
 
 		assert.False(t, p.Config.IsFeatureEnabled(experimental.FlagNoopFeature))
 	})
@@ -198,7 +206,9 @@ func TestVerbosity(t *testing.T) {
 
 		cmd := buildRootCommandFrom(p.Porter)
 		cmd.SetArgs([]string{"install"})
-		cmd.Execute()
+		err := cmd.Execute()
+		require.Error(t, err)
+
 		assert.Equal(t, config.LogLevelInfo, p.Config.GetVerbosity())
 	})
 
@@ -208,7 +218,8 @@ func TestVerbosity(t *testing.T) {
 
 		cmd := buildRootCommandFrom(p.Porter)
 		cmd.SetArgs([]string{"install", "--verbosity=debug"})
-		cmd.Execute()
+		err := cmd.Execute()
+		require.Error(t, err)
 
 		assert.Equal(t, config.LogLevelDebug, p.Config.GetVerbosity())
 	})
@@ -222,7 +233,8 @@ func TestVerbosity(t *testing.T) {
 
 		cmd := buildRootCommandFrom(p.Porter)
 		cmd.SetArgs([]string{"install"})
-		cmd.Execute()
+		err := cmd.Execute()
+		require.Error(t, err)
 
 		assert.Equal(t, config.LogLevelError, p.Config.GetVerbosity())
 	})
@@ -235,7 +247,8 @@ func TestVerbosity(t *testing.T) {
 		require.NoError(t, p.FileSystem.WriteFile("/home/myuser/.porter/config.yaml", cfg, pkg.FileModeWritable))
 		cmd := buildRootCommandFrom(p.Porter)
 		cmd.SetArgs([]string{"install"})
-		cmd.Execute()
+		err := cmd.Execute()
+		require.Error(t, err)
 
 		assert.Equal(t, config.LogLevelWarn, p.Config.GetVerbosity())
 	})
@@ -248,7 +261,8 @@ func TestVerbosity(t *testing.T) {
 		require.NoError(t, p.FileSystem.WriteFile("/home/myuser/.porter/config.yaml", cfg, pkg.FileModeWritable))
 		cmd := buildRootCommandFrom(p.Porter)
 		cmd.SetArgs([]string{"install", "--verbosity", "warn"})
-		cmd.Execute()
+		err := cmd.Execute()
+		require.Error(t, err)
 
 		assert.Equal(t, config.LogLevelWarn, p.Config.GetVerbosity())
 	})
@@ -262,7 +276,8 @@ func TestVerbosity(t *testing.T) {
 
 		cmd := buildRootCommandFrom(p.Porter)
 		cmd.SetArgs([]string{"install", "--verbosity=debug"})
-		cmd.Execute()
+		err := cmd.Execute()
+		require.Error(t, err)
 
 		assert.Equal(t, config.LogLevelDebug, p.Config.GetVerbosity())
 	})
@@ -278,7 +293,8 @@ func TestVerbosity(t *testing.T) {
 		require.NoError(t, p.FileSystem.WriteFile("/home/myuser/.porter/config.yaml", cfg, pkg.FileModeWritable))
 		cmd := buildRootCommandFrom(p.Porter)
 		cmd.SetArgs([]string{"install"})
-		cmd.Execute()
+		err := cmd.Execute()
+		require.Error(t, err)
 
 		assert.Equal(t, config.LogLevelWarn, p.Config.GetVerbosity())
 	})

cmd/porter/mixins_test.go

@@ -25,7 +25,7 @@ func TestBuildListMixinsCommand_AlternateFormat(t *testing.T) {
 	defer p.Close()
 
 	cmd := buildMixinsListCommand(p.Porter)
-	cmd.ParseFlags([]string{"-o", "json"})
+	require.NoError(t, cmd.ParseFlags([]string{"-o", "json"}))
 
 	err := cmd.PreRunE(cmd, []string{})
 
@@ -38,7 +38,7 @@ func TestBuildListMixinsCommand_BadFormat(t *testing.T) {
 	defer p.Close()
 
 	cmd := buildMixinsListCommand(p.Porter)
-	cmd.ParseFlags([]string{"-o", "flarts"})
+	require.NoError(t, cmd.ParseFlags([]string{"-o", "flarts"}))
 
 	err := cmd.PreRunE(cmd, []string{})
 

cmd/porter/plugins.go

@@ -170,7 +170,10 @@ func buildPluginRunCommand(p *porter.Porter) *cobra.Command {
 		Use:   "run PLUGIN_KEY",
 		Short: "Serve internal plugins",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			opts.ApplyArgs(args)
+			err := opts.ApplyArgs(args)
+			if err != nil {
+				return err
+			}
 			return p.RunInternalPlugins(cmd.Context(), opts)
 		},
 		Hidden: true, // This should ALWAYS be hidden, it is not a user-facing command

cmd/porter/run_test.go

@@ -15,7 +15,7 @@ func TestRun_Validate(t *testing.T) {
 
 	configTpl, err := p.Templates.GetManifest()
 	require.NoError(t, err)
-	p.TestConfig.TestContext.AddTestFileContents(configTpl, config.Name)
+	require.NoError(t, p.TestConfig.TestContext.AddTestFileContents(configTpl, config.Name))
 	cmd := buildRunCommand(p.Porter)
 
 	p.Setenv(config.EnvACTION, cnab.ActionInstall)
@@ -30,7 +30,7 @@ func TestRun_ValidateCustomAction(t *testing.T) {
 
 	configTpl, err := p.Templates.GetManifest()
 	require.NoError(t, err)
-	p.TestConfig.TestContext.AddTestFileContents(configTpl, config.Name)
+	require.NoError(t, p.TestConfig.TestContext.AddTestFileContents(configTpl, config.Name))
 	cmd := buildRunCommand(p.Porter)
 
 	p.Setenv(config.EnvACTION, "status")

mage/docs/docs.go

@@ -36,7 +36,7 @@ func Docs() {
 	if baseURL != "" {
 		cmd.Args("-b", baseURL)
 	}
-	cmd.RunV()
+	mgx.Must(cmd.RunV())
 }
 
 func removePreviewContainer() {

magefile.go

@@ -702,10 +702,10 @@ func Vet() {
 	must.RunV("go", "vet", "./...")
 }
 
-// Run staticcheck on the project
+// Run golangci-lint on the project
 func Lint() {
-	mg.Deps(tools.EnsureStaticCheck)
-	must.RunV("staticcheck", "./...")
+	mg.Deps(tools.EnsureGolangCILint)
+	must.RunV("golangci-lint", "run", "--max-issues-per-linter", "0", "--max-same-issues", "0", "./...")
 }
 
 func getPorterHome() string {

pkg/build/buildkit/buildx.go

@@ -163,8 +163,7 @@ func (b *Builder) determineBuildArgs(
 	manifest *manifest.Manifest,
 	opts build.BuildImageOptions) (map[string]string, error) {
 
-	//lint:ignore SA4006 ignore unused context for now
-	ctx, span := tracing.StartSpan(ctx)
+	_, span := tracing.StartSpan(ctx)
 	defer span.EndSpan()
 
 	// This will grow later when we add custom build args from the porter.yaml