standardized go import. (#457)

Signed-off-by: Morven Cao <lcao@redhat.com>

Author: morvencao

.github/workflows/e2e.yml

@@ -14,6 +14,18 @@ permissions:
   contents: read
 
 jobs:
+  verify:
+    name: verify
+    runs-on: ubuntu-22.04
+    steps:
+      - name: checkout code
+        uses: actions/checkout@v4
+      - name: install Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ env.GO_VERSION }}
+      - name: verify
+        run: make verify
   e2e:
     runs-on: ubuntu-22.04
     steps:

Makefile

@@ -6,6 +6,10 @@ CGO_ENABLED := 1
 # Enable users to override the golang used to accomodate custom installations
 GO ?= go
 
+# Set GOPATH from go env if not already set
+GOPATH ?= $(shell $(GO) env GOPATH)
+export GOPATH
+
 # Allow overriding `oc` command.
 # Used by pr_check.py to ssh deploy inside private Hive cluster via bastion host.
 oc:=oc
@@ -156,15 +160,29 @@ ifndef TEST_SUMMARY_FORMAT
 	TEST_SUMMARY_FORMAT=short-verbose
 endif
 
-# Checks if a GOPATH is set, or emits an error message
+# Ensures GOPATH is set (now auto-configured at top of Makefile)
 check-gopath:
-ifndef GOPATH
-	$(error GOPATH is not set)
-endif
+	@echo "GOPATH is set to: $(GOPATH)"
 .PHONY: check-gopath
 
+install-golang-gci:
+	go install github.com/daixiang0/gci@v0.13.7
+
+fmt-imports: install-golang-gci
+	gci write --skip-generated -s standard -s default -s "prefix(github.com/openshift-online/maestro)" -s localmodule cmd pkg test
+
+verify-fmt-imports: install-golang-gci
+	@output=$$(gci diff --skip-generated -s standard -s default -s "prefix(github.com/openshift-online/maestro)" -s localmodule cmd pkg test); \
+	if [ -n "$$output" ]; then \
+	    echo "Go import diff output is not empty: $$output"; \
+	    echo "Please run 'make fmt-imports' to format the golang files imports automatically."; \
+	    exit 1; \
+	else \
+	    echo "Go import diff output is empty"; \
+	fi
+
 # Verifies that source passes standard checks.
-verify: check-gopath
+verify: check-gopath verify-fmt-imports
 	${GO} vet \
 		./cmd/... \
 		./pkg/...

cmd/maestro/common/otlp_sdk.go

@@ -5,6 +5,7 @@ import (
 	"os"
 	"time"
 
+	errors "github.com/zgalor/weberr"
 	"go.opentelemetry.io/contrib/exporters/autoexport"
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/propagation"
@@ -14,7 +15,6 @@ import (
 	"k8s.io/klog/v2"
 
 	"github.com/openshift-online/maestro/pkg/constants"
-	errors "github.com/zgalor/weberr"
 )
 
 // Without a specific configuration, a noop tracer is used by default.

cmd/maestro/environments/framework.go

@@ -7,20 +7,20 @@ import (
 	"strings"
 
 	"github.com/getsentry/sentry-go"
-	"github.com/openshift-online/maestro/pkg/client/cloudevents"
-	"github.com/openshift-online/maestro/pkg/client/grpcauthorizer"
-	"github.com/openshift-online/maestro/pkg/client/ocm"
-	"github.com/openshift-online/maestro/pkg/config"
-	"github.com/openshift-online/maestro/pkg/errors"
 	"github.com/spf13/pflag"
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/rest"
 	"k8s.io/client-go/tools/clientcmd"
 	"k8s.io/klog/v2"
-
-	envtypes "github.com/openshift-online/maestro/cmd/maestro/environments/types"
 	workpayload "open-cluster-management.io/sdk-go/pkg/cloudevents/clients/work/payload"
 	"open-cluster-management.io/sdk-go/pkg/cloudevents/generic/options/builder"
+
+	envtypes "github.com/openshift-online/maestro/cmd/maestro/environments/types"
+	"github.com/openshift-online/maestro/pkg/client/cloudevents"
+	"github.com/openshift-online/maestro/pkg/client/grpcauthorizer"
+	"github.com/openshift-online/maestro/pkg/client/ocm"
+	"github.com/openshift-online/maestro/pkg/config"
+	"github.com/openshift-online/maestro/pkg/errors"
 )
 
 func init() {

cmd/maestro/main.go

@@ -5,11 +5,12 @@ import (
 	"log"
 	"os"
 
+	"github.com/spf13/cobra"
+	"k8s.io/klog/v2"
+
 	"github.com/openshift-online/maestro/cmd/maestro/agent"
 	"github.com/openshift-online/maestro/cmd/maestro/migrate"
 	"github.com/openshift-online/maestro/cmd/maestro/servecmd"
-	"github.com/spf13/cobra"
-	"k8s.io/klog/v2"
 )
 
 // nolint

cmd/maestro/migrate/cmd.go

@@ -2,12 +2,13 @@ package migrate
 
 import (
 	"context"
-	"github.com/openshift-online/maestro/pkg/db/db_session"
+
 	"github.com/spf13/cobra"
 	"k8s.io/klog/v2"
 
 	"github.com/openshift-online/maestro/pkg/config"
 	"github.com/openshift-online/maestro/pkg/db"
+	"github.com/openshift-online/maestro/pkg/db/db_session"
 )
 
 var dbConfig = config.NewDatabaseConfig()

cmd/maestro/server/api_server.go

@@ -7,16 +7,15 @@ import (
 	"net/http"
 	"time"
 
-	"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
-	"k8s.io/klog/v2"
-
 	sentryhttp "github.com/getsentry/sentry-go/http"
 	"github.com/ghodss/yaml"
 	_ "github.com/golang-jwt/jwt/v4"
 	"github.com/golang/glog"
 	gorillahandlers "github.com/gorilla/handlers"
 	sdk "github.com/openshift-online/ocm-sdk-go"
 	"github.com/openshift-online/ocm-sdk-go/authentication"
+	"go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
+	"k8s.io/klog/v2"
 
 	"github.com/openshift-online/maestro/cmd/maestro/common"
 	"github.com/openshift-online/maestro/cmd/maestro/environments"

cmd/maestro/server/auth_interceptor.go

@@ -5,14 +5,15 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/openshift-online/maestro/pkg/client/grpcauthorizer"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/credentials"
 	"google.golang.org/grpc/metadata"
 	"google.golang.org/grpc/peer"
 	"google.golang.org/grpc/status"
 	"k8s.io/klog/v2"
+
+	"github.com/openshift-online/maestro/pkg/client/grpcauthorizer"
 )
 
 // Context key type defined to avoid collisions in other pkgs using context

cmd/maestro/server/controllers.go

@@ -2,7 +2,7 @@ package server
 
 import (
 	"context"
-	
+
 	"k8s.io/klog/v2"
 
 	"github.com/openshift-online/maestro/pkg/api"

cmd/maestro/server/event_server.go

@@ -4,19 +4,20 @@ import (
 	"context"
 	"fmt"
 
+	"k8s.io/apimachinery/pkg/api/meta"
+	"k8s.io/klog/v2"
+	"open-cluster-management.io/sdk-go/pkg/cloudevents/clients/common"
+	workpayload "open-cluster-management.io/sdk-go/pkg/cloudevents/clients/work/payload"
+	"open-cluster-management.io/sdk-go/pkg/cloudevents/generic/types"
+	sdkgologging "open-cluster-management.io/sdk-go/pkg/logging"
+
 	"github.com/openshift-online/maestro/pkg/api"
 	"github.com/openshift-online/maestro/pkg/client/cloudevents"
 	"github.com/openshift-online/maestro/pkg/dao"
 	"github.com/openshift-online/maestro/pkg/db"
 	"github.com/openshift-online/maestro/pkg/dispatcher"
 	"github.com/openshift-online/maestro/pkg/event"
 	"github.com/openshift-online/maestro/pkg/services"
-	"k8s.io/apimachinery/pkg/api/meta"
-	"k8s.io/klog/v2"
-	"open-cluster-management.io/sdk-go/pkg/cloudevents/clients/common"
-	workpayload "open-cluster-management.io/sdk-go/pkg/cloudevents/clients/work/payload"
-	"open-cluster-management.io/sdk-go/pkg/cloudevents/generic/types"
-	sdkgologging "open-cluster-management.io/sdk-go/pkg/logging"
 )
 
 // EventServer handles resource-related events: