Add verification of go import organization

.github/workflows/verify_imports.yml

@@ -0,0 +1,20 @@
+name: Verify organization of imports
+on:
+  push:
+    branches:
+      - '**'
+    paths:
+      - '**.go'
+    tags-ignore:
+      - 'v*'
+  pull_request:
+    paths:
+      - '**.go'
+jobs:
+  verify-imports:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Verify that imports are organized
+      run: make verify-imports

.golangci.yaml

@@ -9,4 +9,3 @@ linters:
     - staticcheck
     - typecheck
     - unused
-    - revive

Makefile

@@ -173,8 +173,11 @@ manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and Cust
 generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
 	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
 
-.PHONY: generate-client ## Generate client packages
-generate-client: code-generator
+.PHONY: generate-client ## Generate client packages and organize the goimports
+generate-client: generate-client-files imports
+
+.PHONY: generate-client-files
+generate-client-files: code-generator
 	rm -rf client
 	$(APPLYCONFIGURATION_GEN) \
 		--input-dirs="github.com/project-codeflare/codeflare-operator/api/codeflare/v1alpha1" \
@@ -278,6 +281,7 @@ LISTER_GEN ?= $(LOCALBIN)/lister-gen
 INFORMER_GEN ?= $(LOCALBIN)/informer-gen
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
 ENVTEST ?= $(LOCALBIN)/setup-envtest
+OPENSHIFT-GOIMPORTS ?= $(LOCALBIN)/openshift-goimports
 OPERATOR_SDK ?= $(LOCALBIN)/operator-sdk
 GH_CLI ?= $(LOCALBIN)/gh
 
@@ -338,6 +342,11 @@ envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
 $(ENVTEST): $(LOCALBIN)
 	test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
 
+.PHONY: openshift-goimports
+openshift-goimports: $(OPENSHIFT-GOIMPORTS) ## Download openshift-goimports locally if necessary.
+$(OPENSHIFT-GOIMPORTS): $(LOCALBIN)
+	test -s $(LOCALBIN)/openshift-goimports || GOBIN=$(LOCALBIN) go install github.com/openshift-eng/openshift-goimports@latest
+
 OPERATOR_SDK_DL_URL := https://github.com/operator-framework/operator-sdk/releases/download/$(OPERATOR_SDK_VERSION)
 .PHONY: install-operator-sdk
 install-operator-sdk: $(OPERATOR_SDK) ## Download fixed version operator-sdk binary for consist outcome
@@ -440,3 +449,11 @@ test-e2e: defaults manifests generate fmt vet ## Run e2e tests.
 .PHONY: setup-e2e
 setup-e2e: ## Set up e2e tests.
 	KUBERAY_VERSION=$(KUBERAY_VERSION) test/e2e/setup.sh
+
+.PHONY: imports
+imports: openshift-goimports ## Organize imports in go files using openshift-goimports. Example: make imports
+	$(OPENSHIFT-GOIMPORTS)
+
+.PHONY: verify-imports
+verify-imports: openshift-goimports ## Run import verifications.
+	./hack/verify-imports.sh $(OPENSHIFT-GOIMPORTS)

controllers/config/manifest.go

@@ -4,6 +4,7 @@ import (
 	"github.com/go-logr/logr"
 	mfc "github.com/manifestival/controller-runtime-client"
 	mf "github.com/manifestival/manifestival"
+
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 

controllers/instascale_controller.go

@@ -21,24 +21,23 @@ import (
 	"fmt"
 	"path"
 
+	"github.com/go-logr/logr"
+	mf "github.com/manifestival/manifestival"
+
 	appsv1 "k8s.io/api/apps/v1"
 	corev1 "k8s.io/api/core/v1"
 	authv1 "k8s.io/api/rbac/v1"
 	rbacv1 "k8s.io/api/rbac/v1"
 	apierrs "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/types"
-
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	"sigs.k8s.io/controller-runtime/pkg/handler"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 	"sigs.k8s.io/controller-runtime/pkg/source"
 
-	"github.com/go-logr/logr"
-	mf "github.com/manifestival/manifestival"
-
 	"github.com/project-codeflare/codeflare-operator/api/codeflare/v1alpha1"
 	"github.com/project-codeflare/codeflare-operator/controllers/config"
 	"github.com/project-codeflare/codeflare-operator/controllers/util"

controllers/instascale_controller_test.go

@@ -3,11 +3,10 @@ package controllers
 import (
 	"context"
 
-	. "github.com/onsi/ginkgo/v2"
-	. "github.com/onsi/gomega"
-
 	mfc "github.com/manifestival/controller-runtime-client"
 	mf "github.com/manifestival/manifestival"
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 
 	codeflarev1alpha1 "github.com/project-codeflare/codeflare-operator/api/codeflare/v1alpha1"
 )