Add lint-fix make target, add gci to flytectl, remove goimports make …

…target (#5484) * Favor golangci-lint --fix instead running goimports,gci directly Signed-off-by: Jason Parraga <[email protected]> * Enable gci lint on flytectl Signed-off-by: Jason Parraga <[email protected]> * check in gci fixes on flytectl Signed-off-by: Jason Parraga <[email protected]> * Deduplicate per feedback Signed-off-by: Jason Parraga <[email protected]> --------- Signed-off-by: Jason Parraga <[email protected]>
flyteorg · Jun 17, 2024 · ba88e82 · ba88e82
1 parent 8c8e4f8
commit ba88e82
Show file tree

Hide file tree

Showing 122 changed files with 150 additions and 341 deletions.
diff --git a/boilerplate/flyte/golang_test_targets/Makefile b/boilerplate/flyte/golang_test_targets/Makefile
@@ -3,6 +3,7 @@
 #
 # TO OPT OUT OF UPDATES, SEE https://github.com/flyteorg/boilerplate/blob/master/Readme.rst
 
+LINT_FLAGS ?=
 
 .PHONY: download_tooling
 download_tooling: #download dependencies (including test deps) for the package
@@ -14,13 +15,11 @@ generate: download_tooling #generate go code
 
 .PHONY: lint
 lint: download_tooling #lints the package for common code smells
-	GL_DEBUG=linters_output,env golangci-lint run --deadline=5m --exclude deprecated -v
+	GL_DEBUG=linters_output,env golangci-lint run $(LINT_FLAGS) --deadline=5m --exclude deprecated -v
 
-# If code is failing goimports linter, this will fix.
-# skips 'vendor'
-.PHONY: goimports
-goimports:
-	@boilerplate/flyte/golang_test_targets/goimports
+.PHONY: lint-fix
+lint-fix: LINT_FLAGS=--fix
+lint-fix: lint
 
 .PHONY: mod_download
 mod_download: #download dependencies (including test deps) for the package

diff --git a/boilerplate/flyte/golang_test_targets/Readme.rst b/boilerplate/flyte/golang_test_targets/Readme.rst
@@ -5,6 +5,8 @@ Provides an ``install`` make target that uses ``go mod`` to install golang depen
 
 Provides a ``lint`` make target that uses golangci to lint your code.
 
+Provides a ``lint-fix`` make target that uses golangci to lint and fix your code in place.
+
 Provides a ``test_unit`` target for unit tests.
 
 Provides a ``test_unit_cover`` target for analysing coverage of unit tests, which will output the coverage of each function and total statement coverage.

diff --git a/boilerplate/flyte/golang_test_targets/goimports b/boilerplate/flyte/golang_test_targets/goimports
diff --git a/flytectl/.golangci.yml b/flytectl/.golangci.yml
@@ -13,6 +13,7 @@ linters:
     - deadcode
     - errcheck
     - gas
+    - gci
     - goconst
     - goimports
     - golint

diff --git a/flytectl/cmd/config/config.go b/flytectl/cmd/config/config.go
@@ -4,9 +4,8 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/flyteorg/flyte/flytestdlib/config"
-
 	"github.com/flyteorg/flyte/flytectl/pkg/printer"
+	"github.com/flyteorg/flyte/flytestdlib/config"
 )
 
 var (

diff --git a/flytectl/cmd/config/subcommand/clusterresourceattribute/file_config_test.go b/flytectl/cmd/config/subcommand/clusterresourceattribute/file_config_test.go
@@ -4,7 +4,6 @@ import (
 	"testing"
 
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-
 	"github.com/stretchr/testify/assert"
 )
 

diff --git a/flytectl/cmd/config/subcommand/executionclusterlabel/file_config_test.go b/flytectl/cmd/config/subcommand/executionclusterlabel/file_config_test.go
@@ -4,7 +4,6 @@ import (
 	"testing"
 
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-
 	"github.com/stretchr/testify/assert"
 )
 

diff --git a/flytectl/cmd/config/subcommand/executionqueueattribute/file_config_test.go b/flytectl/cmd/config/subcommand/executionqueueattribute/file_config_test.go
@@ -4,7 +4,6 @@ import (
 	"testing"
 
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-
 	"github.com/stretchr/testify/assert"
 )
 

diff --git a/flytectl/cmd/config/subcommand/plugin_override/file_config_test.go b/flytectl/cmd/config/subcommand/plugin_override/file_config_test.go
@@ -4,7 +4,6 @@ import (
 	"testing"
 
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-
 	"github.com/stretchr/testify/assert"
 )
 

diff --git a/flytectl/cmd/config/subcommand/project/project_config.go b/flytectl/cmd/config/subcommand/project/project_config.go
@@ -8,7 +8,6 @@ import (
 	"github.com/flyteorg/flyte/flytectl/cmd/config"
 	"github.com/flyteorg/flyte/flytectl/pkg/filters"
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-
 	"gopkg.in/yaml.v3"
 )
 

diff --git a/flytectl/cmd/config/subcommand/project/project_config_test.go b/flytectl/cmd/config/subcommand/project/project_config_test.go
@@ -7,7 +7,6 @@ import (
 	"github.com/flyteorg/flyte/flytectl/clierrors"
 	"github.com/flyteorg/flyte/flytectl/cmd/config"
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-
 	"github.com/stretchr/testify/assert"
 )
 

diff --git a/flytectl/cmd/config/subcommand/taskresourceattribute/file_config_test.go b/flytectl/cmd/config/subcommand/taskresourceattribute/file_config_test.go
@@ -4,7 +4,6 @@ import (
 	"testing"
 
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-
 	"github.com/stretchr/testify/assert"
 )
 

diff --git a/flytectl/cmd/config/subcommand/workflowexecutionconfig/file_config_test.go b/flytectl/cmd/config/subcommand/workflowexecutionconfig/file_config_test.go
@@ -4,7 +4,6 @@ import (
 	"testing"
 
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-
 	"github.com/stretchr/testify/assert"
 )
 

diff --git a/flytectl/cmd/configuration/configuration.go b/flytectl/cmd/configuration/configuration.go
@@ -8,13 +8,11 @@ import (
 	"os"
 	"strings"
 
-	"github.com/flyteorg/flyte/flytectl/pkg/util"
-
-	"github.com/flyteorg/flyte/flytectl/pkg/configutil"
-
 	initConfig "github.com/flyteorg/flyte/flytectl/cmd/config/subcommand/config"
 	cmdcore "github.com/flyteorg/flyte/flytectl/cmd/core"
 	cmdUtil "github.com/flyteorg/flyte/flytectl/pkg/commandutils"
+	"github.com/flyteorg/flyte/flytectl/pkg/configutil"
+	"github.com/flyteorg/flyte/flytectl/pkg/util"
 	"github.com/flyteorg/flyte/flytestdlib/config/viper"
 	"github.com/go-ozzo/ozzo-validation/v4/is"
 	"github.com/spf13/cobra"

diff --git a/flytectl/cmd/configuration/configuration_test.go b/flytectl/cmd/configuration/configuration_test.go
@@ -9,14 +9,11 @@ import (
 	"strings"
 	"testing"
 
-	admin2 "github.com/flyteorg/flyte/flyteidl/clients/go/admin"
-
-	"github.com/flyteorg/flyte/flytectl/pkg/configutil"
-
 	initConfig "github.com/flyteorg/flyte/flytectl/cmd/config/subcommand/config"
 	cmdCore "github.com/flyteorg/flyte/flytectl/cmd/core"
+	"github.com/flyteorg/flyte/flytectl/pkg/configutil"
 	"github.com/flyteorg/flyte/flytectl/pkg/util"
-
+	admin2 "github.com/flyteorg/flyte/flyteidl/clients/go/admin"
 	"github.com/stretchr/testify/assert"
 )
 

diff --git a/flytectl/cmd/core/cmd.go b/flytectl/cmd/core/cmd.go
@@ -4,16 +4,14 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/pkg/errors"
-	"google.golang.org/grpc/codes"
-	"google.golang.org/grpc/status"
-
 	"github.com/flyteorg/flyte/flytectl/cmd/config"
 	"github.com/flyteorg/flyte/flytectl/pkg/pkce"
 	"github.com/flyteorg/flyte/flyteidl/clients/go/admin"
-
+	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
 )
 
 type PFlagProvider interface {

diff --git a/flytectl/cmd/core/cmd_ctx.go b/flytectl/cmd/core/cmd_ctx.go
@@ -3,9 +3,8 @@ package cmdcore
 import (
 	"io"
 
-	"github.com/flyteorg/flyte/flyteidl/clients/go/admin"
-
 	"github.com/flyteorg/flyte/flytectl/pkg/ext"
+	"github.com/flyteorg/flyte/flyteidl/clients/go/admin"
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/service"
 )
 

diff --git a/flytectl/cmd/core/cmd_test.go b/flytectl/cmd/core/cmd_test.go
@@ -7,7 +7,6 @@ import (
 
 	"github.com/flyteorg/flyte/flyteidl/clients/go/admin"
 	"github.com/flyteorg/flyte/flytestdlib/config"
-
 	"github.com/spf13/cobra"
 	"github.com/stretchr/testify/assert"
 )

diff --git a/flytectl/cmd/create/create.go b/flytectl/cmd/create/create.go
@@ -3,7 +3,6 @@ package create
 import (
 	"github.com/flyteorg/flyte/flytectl/cmd/config/subcommand/project"
 	cmdcore "github.com/flyteorg/flyte/flytectl/cmd/core"
-
 	"github.com/spf13/cobra"
 )
 

diff --git a/flytectl/cmd/create/create_test.go b/flytectl/cmd/create/create_test.go
@@ -4,9 +4,8 @@ import (
 	"sort"
 	"testing"
 
-	"github.com/stretchr/testify/assert"
-
 	"github.com/flyteorg/flyte/flytectl/cmd/testutils"
+	"github.com/stretchr/testify/assert"
 )
 
 const testDataFolder = "../testdata/"

diff --git a/flytectl/cmd/create/execution.go b/flytectl/cmd/create/execution.go
@@ -4,11 +4,10 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-	"github.com/flyteorg/flyte/flytestdlib/logger"
-
 	"github.com/flyteorg/flyte/flytectl/cmd/config"
 	cmdCore "github.com/flyteorg/flyte/flytectl/cmd/core"
+	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
+	"github.com/flyteorg/flyte/flytestdlib/logger"
 )
 
 const (

diff --git a/flytectl/cmd/create/execution_test.go b/flytectl/cmd/create/execution_test.go
@@ -4,17 +4,15 @@ import (
 	"fmt"
 	"testing"
 
+	"github.com/flyteorg/flyte/flytectl/cmd/config"
+	cmdCore "github.com/flyteorg/flyte/flytectl/cmd/core"
+	"github.com/flyteorg/flyte/flytectl/cmd/testutils"
+	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
+	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/core"
 	"github.com/golang/protobuf/proto"
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/suite"
 	"google.golang.org/protobuf/types/known/timestamppb"
-
-	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/core"
-
-	"github.com/flyteorg/flyte/flytectl/cmd/config"
-	cmdCore "github.com/flyteorg/flyte/flytectl/cmd/core"
-	"github.com/flyteorg/flyte/flytectl/cmd/testutils"
 )
 
 type createSuite struct {

diff --git a/flytectl/cmd/create/execution_util.go b/flytectl/cmd/create/execution_util.go
@@ -6,14 +6,13 @@ import (
 	"io/ioutil"
 	"strings"
 
+	cmdCore "github.com/flyteorg/flyte/flytectl/cmd/core"
+	cmdGet "github.com/flyteorg/flyte/flytectl/cmd/get"
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/core"
 	"github.com/flyteorg/flyte/flytestdlib/logger"
 	"github.com/google/uuid"
 	"sigs.k8s.io/yaml"
-
-	cmdCore "github.com/flyteorg/flyte/flytectl/cmd/core"
-	cmdGet "github.com/flyteorg/flyte/flytectl/cmd/get"
 )
 
 func createExecutionRequestForWorkflow(ctx context.Context, workflowName, project, domain string,

diff --git a/flytectl/cmd/create/execution_util_test.go b/flytectl/cmd/create/execution_util_test.go
@@ -5,11 +5,9 @@ import (
 	"fmt"
 	"testing"
 
+	"github.com/flyteorg/flyte/flytectl/cmd/config"
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/core"
-
-	"github.com/flyteorg/flyte/flytectl/cmd/config"
-
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 )

diff --git a/flytectl/cmd/create/project.go b/flytectl/cmd/create/project.go
@@ -7,9 +7,8 @@ import (
 	"github.com/flyteorg/flyte/flytectl/clierrors"
 	"github.com/flyteorg/flyte/flytectl/cmd/config"
 	"github.com/flyteorg/flyte/flytectl/cmd/config/subcommand/project"
-	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-
 	cmdCore "github.com/flyteorg/flyte/flytectl/cmd/core"
+	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
 	"github.com/flyteorg/flyte/flytestdlib/logger"
 )
 

diff --git a/flytectl/cmd/create/project_test.go b/flytectl/cmd/create/project_test.go
@@ -6,12 +6,9 @@ import (
 	"testing"
 
 	"github.com/flyteorg/flyte/flytectl/clierrors"
-
 	"github.com/flyteorg/flyte/flytectl/cmd/config"
 	"github.com/flyteorg/flyte/flytectl/cmd/config/subcommand/project"
-
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 )

diff --git a/flytectl/cmd/delete/delete.go b/flytectl/cmd/delete/delete.go
@@ -9,7 +9,6 @@ import (
 	"github.com/flyteorg/flyte/flytectl/cmd/config/subcommand/taskresourceattribute"
 	"github.com/flyteorg/flyte/flytectl/cmd/config/subcommand/workflowexecutionconfig"
 	cmdcore "github.com/flyteorg/flyte/flytectl/cmd/core"
-
 	"github.com/spf13/cobra"
 )
 

diff --git a/flytectl/cmd/delete/delete_test.go b/flytectl/cmd/delete/delete_test.go
@@ -4,9 +4,8 @@ import (
 	"sort"
 	"testing"
 
-	"github.com/stretchr/testify/assert"
-
 	"github.com/flyteorg/flyte/flytectl/cmd/testutils"
+	"github.com/stretchr/testify/assert"
 )
 
 const (

diff --git a/flytectl/cmd/delete/execution_test.go b/flytectl/cmd/delete/execution_test.go
@@ -7,7 +7,6 @@ import (
 	"github.com/flyteorg/flyte/flytectl/cmd/config"
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/core"
-
 	"github.com/stretchr/testify/assert"
 )
 

diff --git a/flytectl/cmd/delete/matchable_cluster_resource_attribute_test.go b/flytectl/cmd/delete/matchable_cluster_resource_attribute_test.go
@@ -7,7 +7,6 @@ import (
 	"github.com/flyteorg/flyte/flytectl/cmd/config"
 	"github.com/flyteorg/flyte/flytectl/cmd/config/subcommand/clusterresourceattribute"
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 )

diff --git a/flytectl/cmd/delete/matchable_execution_cluster_label_test.go b/flytectl/cmd/delete/matchable_execution_cluster_label_test.go
@@ -7,7 +7,6 @@ import (
 	"github.com/flyteorg/flyte/flytectl/cmd/config"
 	"github.com/flyteorg/flyte/flytectl/cmd/config/subcommand/executionclusterlabel"
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 )

diff --git a/flytectl/cmd/delete/matchable_execution_queue_attribute_test.go b/flytectl/cmd/delete/matchable_execution_queue_attribute_test.go
@@ -7,7 +7,6 @@ import (
 	"github.com/flyteorg/flyte/flytectl/cmd/config"
 	"github.com/flyteorg/flyte/flytectl/cmd/config/subcommand/executionqueueattribute"
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 )

diff --git a/flytectl/cmd/delete/matchable_plugin_override_test.go b/flytectl/cmd/delete/matchable_plugin_override_test.go
@@ -7,7 +7,6 @@ import (
 	"github.com/flyteorg/flyte/flytectl/cmd/config"
 	pluginoverride "github.com/flyteorg/flyte/flytectl/cmd/config/subcommand/plugin_override"
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 )

diff --git a/flytectl/cmd/delete/matchable_task_resource_attribute_test.go b/flytectl/cmd/delete/matchable_task_resource_attribute_test.go
@@ -7,7 +7,6 @@ import (
 	"github.com/flyteorg/flyte/flytectl/cmd/config"
 	"github.com/flyteorg/flyte/flytectl/cmd/config/subcommand/taskresourceattribute"
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
-
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 )

diff --git a/flytectl/cmd/delete/matchable_workflow_execution_config.go b/flytectl/cmd/delete/matchable_workflow_execution_config.go
@@ -3,10 +3,9 @@ package delete
 import (
 	"context"
 
-	"github.com/flyteorg/flyte/flytectl/cmd/config/subcommand/workflowexecutionconfig"
-
 	"github.com/flyteorg/flyte/flytectl/cmd/config"
 	sconfig "github.com/flyteorg/flyte/flytectl/cmd/config/subcommand"
+	"github.com/flyteorg/flyte/flytectl/cmd/config/subcommand/workflowexecutionconfig"
 	cmdCore "github.com/flyteorg/flyte/flytectl/cmd/core"
 	"github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin"
 )
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,6 +13,7 @@ linters: @@
         - deadcode
         - errcheck
         - gas
+        - gci
         - goconst
         - goimports
         - golint
@@ Expand Down @@