🌱 add a verify rule for golang files import order (#177)

* 🌱 add a verify rule for golang files import order This PR uses the [gci tool](https://github.com/daixiang0/gci) to make all go files' import section with a specific order, it will organize import with group with order： 1. standard library modules 2. 3rd party modules 3. modules in OCM org, like the `open-cluster-management.io/api` 4. current project `open-cluster-management.io/ocm` modules developers can use the `make fmt-imports` to format the import automatically and the `make verify-fmt-imports` to check for any violation. Signed-off-by: zhujian <jiazhu@redhat.com> * 🌱 format the go files import Signed-off-by: zhujian <jiazhu@redhat.com> --------- Signed-off-by: zhujian <jiazhu@redhat.com>
open-cluster-management-io · Jun 12, 2023 · 7332a58 · 7332a58
1 parent 3c9bfea
commit 7332a58
Show file tree

Hide file tree

Showing 266 changed files with 815 additions and 583 deletions.
diff --git a/.github/workflows/pre.yml b/.github/workflows/pre.yml
@@ -29,19 +29,10 @@ jobs:
           go-version: ${{ env.GO_VERSION }}
       - name: verify
         run: make verify
-
-  verify-deps:
-    name: verify-deps
-    runs-on: ubuntu-latest
-    steps:
-      - name: checkout code
-        uses: actions/checkout@v3
-      - name: install Go
-        uses: actions/setup-go@v3
-        with:
-          go-version: ${{ env.GO_VERSION }}
       - name: verify-deps
         run: make verify-deps
+      - name: verify-fmt-imports
+        run: make verify-fmt-imports
 
   build:
     name: build

diff --git a/Makefile b/Makefile
@@ -68,6 +68,21 @@ verify-gocilint:
 	go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.45.2
 	golangci-lint run --timeout=3m --modules-download-mode vendor ./...
 
+install-golang-gci:
+	go install github.com/daixiang0/gci@v0.10.1
+
+fmt-imports: install-golang-gci
+	gci write --skip-generated -s standard -s default -s "prefix(open-cluster-management.io)" -s "prefix(open-cluster-management.io/ocm)" cmd pkg test dependencymagnet
+
+verify-fmt-imports: install-golang-gci
+	@output=$$(gci diff --skip-generated -s standard -s default -s "prefix(open-cluster-management.io)" -s "prefix(open-cluster-management.io/ocm)" cmd pkg test dependencymagnet); \
+	if [ -n "$$output" ]; then \
+	    echo "Diff output is not empty: $$output"; \
+	    exit 1; \
+	else \
+	    echo "Diff output is empty"; \
+	fi
+
 verify: verify-crds
 
 ensure-operator-sdk:

diff --git a/cmd/placement/main.go b/cmd/placement/main.go
@@ -4,16 +4,15 @@ import (
 	goflag "flag"
 	"fmt"
 	"math/rand"
-	"open-cluster-management.io/ocm/pkg/cmd/hub"
 	"os"
 	"time"
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
-
 	utilflag "k8s.io/component-base/cli/flag"
 	"k8s.io/component-base/logs"
 
+	"open-cluster-management.io/ocm/pkg/cmd/hub"
 	"open-cluster-management.io/ocm/pkg/version"
 )
 

diff --git a/cmd/registration-operator/main.go b/cmd/registration-operator/main.go
@@ -4,17 +4,16 @@ import (
 	goflag "flag"
 	"fmt"
 	"math/rand"
-	"open-cluster-management.io/ocm/pkg/cmd/hub"
-	"open-cluster-management.io/ocm/pkg/cmd/spoke"
 	"os"
 	"time"
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
-
 	utilflag "k8s.io/component-base/cli/flag"
 	"k8s.io/component-base/logs"
 
+	"open-cluster-management.io/ocm/pkg/cmd/hub"
+	"open-cluster-management.io/ocm/pkg/cmd/spoke"
 	"open-cluster-management.io/ocm/pkg/version"
 )
 

diff --git a/cmd/registration/main.go b/cmd/registration/main.go
@@ -4,17 +4,16 @@ import (
 	goflag "flag"
 	"fmt"
 	"math/rand"
-	"open-cluster-management.io/ocm/pkg/cmd/hub"
-	"open-cluster-management.io/ocm/pkg/cmd/spoke"
 	"os"
 	"time"
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
-
 	utilflag "k8s.io/component-base/cli/flag"
 	"k8s.io/component-base/logs"
 
+	"open-cluster-management.io/ocm/pkg/cmd/hub"
+	"open-cluster-management.io/ocm/pkg/cmd/spoke"
 	"open-cluster-management.io/ocm/pkg/cmd/webhook"
 	"open-cluster-management.io/ocm/pkg/version"
 )

diff --git a/cmd/work/main.go b/cmd/work/main.go
@@ -4,17 +4,16 @@ import (
 	goflag "flag"
 	"fmt"
 	"math/rand"
-	"open-cluster-management.io/ocm/pkg/cmd/hub"
-	"open-cluster-management.io/ocm/pkg/cmd/spoke"
 	"os"
 	"time"
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
-
 	utilflag "k8s.io/component-base/cli/flag"
 	"k8s.io/component-base/logs"
 
+	"open-cluster-management.io/ocm/pkg/cmd/hub"
+	"open-cluster-management.io/ocm/pkg/cmd/spoke"
 	"open-cluster-management.io/ocm/pkg/cmd/webhook"
 	"open-cluster-management.io/ocm/pkg/version"
 )

diff --git a/dependencymagnet/doc.go b/dependencymagnet/doc.go
@@ -7,6 +7,7 @@ package dependencymagnet
 
 import (
 	_ "github.com/openshift/build-machinery-go"
+
 	_ "open-cluster-management.io/api/addon/v1alpha1"
 	_ "open-cluster-management.io/api/cluster/v1"
 	_ "open-cluster-management.io/api/cluster/v1alpha1"

diff --git a/pkg/cmd/hub/operator.go b/pkg/cmd/hub/operator.go
@@ -1,9 +1,8 @@
 package hub
 
 import (
-	"github.com/spf13/cobra"
-
 	"github.com/openshift/library-go/pkg/controller/controllercmd"
+	"github.com/spf13/cobra"
 
 	"open-cluster-management.io/ocm/pkg/operator/operators/clustermanager"
 	"open-cluster-management.io/ocm/pkg/version"

diff --git a/pkg/cmd/hub/placement.go b/pkg/cmd/hub/placement.go
@@ -1,9 +1,8 @@
 package hub
 
 import (
-	"github.com/spf13/cobra"
-
 	"github.com/openshift/library-go/pkg/controller/controllercmd"
+	"github.com/spf13/cobra"
 
 	controllers "open-cluster-management.io/ocm/pkg/placement/controllers"
 	"open-cluster-management.io/ocm/pkg/version"

diff --git a/pkg/cmd/hub/registration.go b/pkg/cmd/hub/registration.go
@@ -3,9 +3,8 @@ package hub
 import (
 	"time"
 
-	"github.com/spf13/cobra"
-
 	"github.com/openshift/library-go/pkg/controller/controllercmd"
+	"github.com/spf13/cobra"
 
 	"open-cluster-management.io/ocm/pkg/registration/hub"
 	"open-cluster-management.io/ocm/pkg/version"

diff --git a/pkg/cmd/hub/work.go b/pkg/cmd/hub/work.go
@@ -1,9 +1,8 @@
 package hub
 
 import (
-	"github.com/spf13/cobra"
-
 	"github.com/openshift/library-go/pkg/controller/controllercmd"
+	"github.com/spf13/cobra"
 
 	"open-cluster-management.io/ocm/pkg/version"
 	"open-cluster-management.io/ocm/pkg/work/hub"

diff --git a/pkg/cmd/spoke/operator.go b/pkg/cmd/spoke/operator.go
@@ -1,9 +1,8 @@
 package spoke
 
 import (
-	"github.com/spf13/cobra"
-
 	"github.com/openshift/library-go/pkg/controller/controllercmd"
+	"github.com/spf13/cobra"
 
 	"open-cluster-management.io/ocm/pkg/operator/operators/klusterlet"
 	"open-cluster-management.io/ocm/pkg/version"

diff --git a/pkg/cmd/spoke/registration.go b/pkg/cmd/spoke/registration.go
@@ -1,9 +1,8 @@
 package spoke
 
 import (
-	"github.com/spf13/cobra"
-
 	"github.com/openshift/library-go/pkg/controller/controllercmd"
+	"github.com/spf13/cobra"
 
 	"open-cluster-management.io/ocm/pkg/registration/spoke"
 	"open-cluster-management.io/ocm/pkg/version"

diff --git a/pkg/cmd/spoke/work.go b/pkg/cmd/spoke/work.go
@@ -1,9 +1,8 @@
 package spoke
 
 import (
-	"github.com/spf13/cobra"
-
 	"github.com/openshift/library-go/pkg/controller/controllercmd"
+	"github.com/spf13/cobra"
 
 	"open-cluster-management.io/ocm/pkg/version"
 	"open-cluster-management.io/ocm/pkg/work/spoke"

diff --git a/pkg/cmd/webhook/registration.go b/pkg/cmd/webhook/registration.go
@@ -2,6 +2,7 @@ package webhook
 
 import (
 	"github.com/spf13/cobra"
+
 	"open-cluster-management.io/ocm/pkg/features"
 	"open-cluster-management.io/ocm/pkg/registration/webhook"
 )

diff --git a/pkg/cmd/webhook/work.go b/pkg/cmd/webhook/work.go
@@ -2,6 +2,7 @@ package webhook
 
 import (
 	"github.com/spf13/cobra"
+
 	"open-cluster-management.io/ocm/pkg/features"
 	_ "open-cluster-management.io/ocm/pkg/features"
 	"open-cluster-management.io/ocm/pkg/work/webhook"

diff --git a/pkg/common/options/options.go b/pkg/common/options/options.go
@@ -2,12 +2,13 @@ package options
 
 import (
 	"fmt"
+	"strings"
+
 	"github.com/openshift/library-go/pkg/controller/controllercmd"
 	"github.com/spf13/pflag"
 	apimachineryvalidation "k8s.io/apimachinery/pkg/api/validation"
 	"k8s.io/client-go/rest"
 	"k8s.io/client-go/tools/clientcmd"
-	"strings"
 )
 
 // AgentOptions is the common agent options

diff --git a/pkg/common/patcher/patcher.go b/pkg/common/patcher/patcher.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+
 	jsonpatch "github.com/evanphx/json-patch"
 	"k8s.io/apimachinery/pkg/api/equality"
 	"k8s.io/apimachinery/pkg/api/meta"

diff --git a/pkg/common/patcher/patcher_test.go b/pkg/common/patcher/patcher_test.go
@@ -3,14 +3,17 @@ package patcher
 import (
 	"context"
 	"encoding/json"
+	"testing"
+
 	"k8s.io/apimachinery/pkg/api/equality"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	clienttesting "k8s.io/client-go/testing"
+
 	clusterfake "open-cluster-management.io/api/client/cluster/clientset/versioned/fake"
 	clusterv1 "open-cluster-management.io/api/cluster/v1"
+
 	testingcommon "open-cluster-management.io/ocm/pkg/common/testing"
 	testinghelpers "open-cluster-management.io/ocm/pkg/registration/helpers/testing"
-	"testing"
 )
 
 func TestAddFinalizer(t *testing.T) {

diff --git a/pkg/common/testing/assertion.go b/pkg/common/testing/assertion.go
@@ -1,13 +1,14 @@
 package testing
 
 import (
+	"strings"
+	"testing"
+
 	"github.com/davecgh/go-spew/spew"
 	"k8s.io/apimachinery/pkg/api/meta"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	clienttesting "k8s.io/client-go/testing"
-	"strings"
-	"testing"
 )
 
 // AssertError asserts the actual error representation is the same with the expected,

diff --git a/pkg/common/testing/fake_sync_context.go b/pkg/common/testing/fake_sync_context.go
@@ -1,10 +1,11 @@
 package testing
 
 import (
+	"testing"
+
 	"github.com/openshift/library-go/pkg/operator/events"
 	"github.com/openshift/library-go/pkg/operator/events/eventstesting"
 	"k8s.io/client-go/util/workqueue"
-	"testing"
 )
 
 type FakeSyncContext struct {

diff --git a/pkg/features/feature.go b/pkg/features/feature.go
@@ -6,6 +6,7 @@ package features
 import (
 	"k8s.io/apimachinery/pkg/util/runtime"
 	"k8s.io/component-base/featuregate"
+
 	ocmfeature "open-cluster-management.io/api/feature"
 )
 

diff --git a/pkg/operator/certrotation/cabundle.go b/pkg/operator/certrotation/cabundle.go
@@ -6,17 +6,16 @@ import (
 	"fmt"
 	"reflect"
 
+	"github.com/openshift/library-go/pkg/crypto"
+	"github.com/openshift/library-go/pkg/operator/events"
+	"github.com/openshift/library-go/pkg/operator/resource/resourceapply"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/equality"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	corev1client "k8s.io/client-go/kubernetes/typed/core/v1"
 	corev1listers "k8s.io/client-go/listers/core/v1"
 	"k8s.io/client-go/util/cert"
-
-	"github.com/openshift/library-go/pkg/crypto"
-	"github.com/openshift/library-go/pkg/operator/events"
-	"github.com/openshift/library-go/pkg/operator/resource/resourceapply"
 )
 
 // CABundleRotation maintains a CA bundle config map, but adding new CA certs and removing expired old ones.

diff --git a/pkg/operator/certrotation/target.go b/pkg/operator/certrotation/target.go
@@ -6,15 +6,14 @@ import (
 	"fmt"
 	"time"
 
-	corev1 "k8s.io/api/core/v1"
-	apierrors "k8s.io/apimachinery/pkg/api/errors"
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/apimachinery/pkg/util/sets"
-
 	"github.com/openshift/library-go/pkg/certs"
 	"github.com/openshift/library-go/pkg/crypto"
 	"github.com/openshift/library-go/pkg/operator/events"
 	"github.com/openshift/library-go/pkg/operator/resource/resourceapply"
+	corev1 "k8s.io/api/core/v1"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/util/sets"
 	corev1client "k8s.io/client-go/kubernetes/typed/core/v1"
 	corev1listers "k8s.io/client-go/listers/core/v1"
 	"k8s.io/client-go/util/cert"

diff --git a/pkg/operator/helpers/helpers.go b/pkg/operator/helpers/helpers.go
@@ -36,6 +36,7 @@ import (
 	"k8s.io/klog/v2"
 	apiregistrationv1 "k8s.io/kube-aggregator/pkg/apis/apiregistration/v1"
 	apiregistrationclient "k8s.io/kube-aggregator/pkg/client/clientset_generated/clientset/typed/apiregistration/v1"
+
 	operatorv1client "open-cluster-management.io/api/client/operator/clientset/versioned/typed/operator/v1"
 	operatorapiv1 "open-cluster-management.io/api/operator/v1"
 )

diff --git a/pkg/operator/helpers/helpers_test.go b/pkg/operator/helpers/helpers_test.go
@@ -9,9 +9,6 @@ import (
 	"testing"
 	"time"
 
-	"k8s.io/component-base/featuregate"
-	ocmfeature "open-cluster-management.io/api/feature"
-
 	"github.com/google/go-cmp/cmp"
 	"github.com/openshift/library-go/pkg/assets"
 	"github.com/openshift/library-go/pkg/operator/events"
@@ -33,9 +30,13 @@ import (
 	clienttesting "k8s.io/client-go/testing"
 	clientcmdapi "k8s.io/client-go/tools/clientcmd/api"
 	clientcmdlatest "k8s.io/client-go/tools/clientcmd/api/latest"
+	"k8s.io/component-base/featuregate"
 	fakeapiregistration "k8s.io/kube-aggregator/pkg/client/clientset_generated/clientset/fake"
+
 	opereatorfake "open-cluster-management.io/api/client/operator/clientset/versioned/fake"
+	ocmfeature "open-cluster-management.io/api/feature"
 	operatorapiv1 "open-cluster-management.io/api/operator/v1"
+
 	"open-cluster-management.io/ocm/manifests"
 )
 

diff --git a/pkg/operator/helpers/queuekey.go b/pkg/operator/helpers/queuekey.go
@@ -4,12 +4,11 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/openshift/library-go/pkg/controller/factory"
 	"k8s.io/apimachinery/pkg/api/meta"
 	"k8s.io/apimachinery/pkg/labels"
 	"k8s.io/apimachinery/pkg/runtime"
 
-	"github.com/openshift/library-go/pkg/controller/factory"
-
 	operatorlister "open-cluster-management.io/api/client/operator/listers/operator/v1"
 	operatorapiv1 "open-cluster-management.io/api/operator/v1"
 )

diff --git a/pkg/operator/helpers/testing/assertion.go b/pkg/operator/helpers/testing/assertion.go
@@ -8,7 +8,9 @@ import (
 	"k8s.io/apimachinery/pkg/api/meta"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
+
 	opratorapiv1 "open-cluster-management.io/api/operator/v1"
+
 	"open-cluster-management.io/ocm/pkg/operator/helpers"
 )