Add linter rule to organize imports into sections (#335)

Author: dgrove-oss

.golangci.yml

@@ -2,6 +2,43 @@ run:
   deadline: 5m
   allow-parallel-runners: true
 
+# Settings of specific linters
+linters-settings:
+  gci:
+    sections:
+    - standard
+    - default
+    - prefix(github.com/project-codeflare/appwrapper)
+    - blank
+    - dot
+    skip-generated: true # Skip generated files.
+
+linters:
+  disable-all: true
+  enable:
+  - copyloopvar
+  - dupl
+  - dupword
+  - errcheck
+  - gci
+  - ginkgolinter
+  - goconst
+  - gocyclo
+  - gofmt
+  - goimports
+  - gosimple
+  - govet
+  - ineffassign
+  - lll
+  - misspell
+  - nakedret
+  - prealloc
+  - staticcheck
+  - typecheck
+  - unconvert
+  - unparam
+  - unused
+
 issues:
   # don't skip warning about doc comments
   # don't exclude the default set of lint
@@ -28,25 +65,3 @@ issues:
   - path: "pkg/*"
     linters:
     - lll
-linters:
-  disable-all: true
-  enable:
-  - copyloopvar
-  - dupl
-  - errcheck
-  - goconst
-  - gocyclo
-  - gofmt
-  - goimports
-  - gosimple
-  - govet
-  - ineffassign
-  - lll
-  - misspell
-  - nakedret
-  - prealloc
-  - staticcheck
-  - typecheck
-  - unconvert
-  - unparam
-  - unused

cmd/main.go

@@ -24,21 +24,16 @@ import (
 	"os"
 	"strings"
 
-	// Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
-	// to ensure that exec-entrypoint and run can make use of them.
-	_ "k8s.io/client-go/plugin/pkg/client/auth"
-
 	zaplog "go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
-	"k8s.io/utils/ptr"
-
 	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/runtime"
 	"k8s.io/apimachinery/pkg/types"
 	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
 	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
+	"k8s.io/utils/ptr"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
@@ -52,7 +47,10 @@ import (
 	"github.com/project-codeflare/appwrapper/pkg/config"
 	"github.com/project-codeflare/appwrapper/pkg/controller"
 	"github.com/project-codeflare/appwrapper/pkg/logger"
-	//+kubebuilder:scaffold:imports
+
+	// Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
+	// to ensure that exec-entrypoint and run can make use of them.
+	_ "k8s.io/client-go/plugin/pkg/client/auth"
 )
 
 var (

internal/controller/appwrapper/appwrapper_controller.go

@@ -33,7 +33,6 @@ import (
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/apimachinery/pkg/util/sets"
 	"k8s.io/client-go/tools/record"
-
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"

internal/controller/appwrapper/appwrapper_controller_test.go

@@ -19,8 +19,6 @@ package appwrapper
 import (
 	"time"
 
-	. "github.com/onsi/ginkgo/v2"
-	. "github.com/onsi/gomega"
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/meta"
 	"k8s.io/apimachinery/pkg/api/resource"
@@ -33,6 +31,9 @@ import (
 	awv1beta2 "github.com/project-codeflare/appwrapper/api/v1beta2"
 	"github.com/project-codeflare/appwrapper/pkg/config"
 	"github.com/project-codeflare/appwrapper/pkg/utils"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("AppWrapper Controller", func() {

internal/controller/appwrapper/fixtures_test.go

@@ -21,8 +21,6 @@ import (
 	"math/rand"
 	"time"
 
-	. "github.com/onsi/gomega"
-
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -33,6 +31,8 @@ import (
 	"sigs.k8s.io/yaml"
 
 	awv1beta2 "github.com/project-codeflare/appwrapper/api/v1beta2"
+
+	. "github.com/onsi/gomega"
 )
 
 const charset = "abcdefghijklmnopqrstuvwxyz0123456789"

internal/controller/appwrapper/node_health_monitor.go

@@ -25,7 +25,6 @@ import (
 	"k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/api/resource"
 	"k8s.io/apimachinery/pkg/util/sets"
-
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/handler"

internal/controller/appwrapper/node_health_monitor_test.go

@@ -17,14 +17,16 @@ limitations under the License.
 package appwrapper
 
 import (
-	. "github.com/onsi/ginkgo/v2"
-	. "github.com/onsi/gomega"
-	"github.com/project-codeflare/appwrapper/pkg/config"
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
+
+	"github.com/project-codeflare/appwrapper/pkg/config"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("NodeMonitor Controller", func() {
@@ -74,7 +76,7 @@ var _ = Describe("NodeMonitor Controller", func() {
 		Expect(err).NotTo(HaveOccurred())
 
 		By("Healthy cluster has no unhealthy nodes")
-		Expect(len(noExecuteNodes)).Should(Equal(0))
+		Expect(noExecuteNodes).Should(BeEmpty())
 
 		By("A node labeled EVICT is detected as unhealthy")
 		node := getNode(node1Name.Name)
@@ -84,7 +86,7 @@ var _ = Describe("NodeMonitor Controller", func() {
 		Expect(err).NotTo(HaveOccurred())
 		_, err = nodeMonitor.Reconcile(ctx, reconcile.Request{NamespacedName: node2Name})
 		Expect(err).NotTo(HaveOccurred())
-		Expect(len(noExecuteNodes)).Should(Equal(1))
+		Expect(noExecuteNodes).Should(HaveLen(1))
 		Expect(noExecuteNodes).Should(HaveKey(node1Name.Name))
 		Expect(noExecuteNodes[node1Name.Name]).Should(HaveKey("nvidia.com/gpu"))
 
@@ -93,7 +95,7 @@ var _ = Describe("NodeMonitor Controller", func() {
 		Expect(err).NotTo(HaveOccurred())
 		_, err = nodeMonitor.Reconcile(ctx, reconcile.Request{NamespacedName: node2Name})
 		Expect(err).NotTo(HaveOccurred())
-		Expect(len(noExecuteNodes)).Should(Equal(1))
+		Expect(noExecuteNodes).Should(HaveLen(1))
 		Expect(noExecuteNodes).Should(HaveKey(node1Name.Name))
 		Expect(noExecuteNodes[node1Name.Name]).Should(HaveKey("nvidia.com/gpu"))
 
@@ -102,7 +104,7 @@ var _ = Describe("NodeMonitor Controller", func() {
 		Expect(k8sClient.Update(ctx, node)).Should(Succeed())
 		_, err = nodeMonitor.Reconcile(ctx, reconcile.Request{NamespacedName: node1Name})
 		Expect(err).NotTo(HaveOccurred())
-		Expect(len(noExecuteNodes)).Should(Equal(0))
+		Expect(noExecuteNodes).Should(BeEmpty())
 
 		deleteNode(node1Name.Name)
 		deleteNode(node2Name.Name)

internal/controller/appwrapper/resource_management.go

@@ -22,9 +22,6 @@ import (
 	"fmt"
 	"time"
 
-	awv1beta2 "github.com/project-codeflare/appwrapper/api/v1beta2"
-	utilmaps "github.com/project-codeflare/appwrapper/internal/util"
-	"github.com/project-codeflare/appwrapper/pkg/utils"
 	v1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/api/meta"
@@ -35,6 +32,10 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	"sigs.k8s.io/controller-runtime/pkg/log"
+
+	awv1beta2 "github.com/project-codeflare/appwrapper/api/v1beta2"
+	utilmaps "github.com/project-codeflare/appwrapper/internal/util"
+	"github.com/project-codeflare/appwrapper/pkg/utils"
 )
 
 func parseComponent(raw []byte, expectedNamespace string) (*unstructured.Unstructured, error) {

internal/controller/appwrapper/suite_test.go

@@ -23,11 +23,6 @@ import (
 	"runtime"
 	"testing"
 
-	. "github.com/onsi/ginkgo/v2"
-	. "github.com/onsi/gomega"
-
-	//+kubebuilder:scaffold:imports
-
 	admissionv1 "k8s.io/api/admission/v1"
 	rbacv1 "k8s.io/api/rbac/v1"
 	apimachineryruntime "k8s.io/apimachinery/pkg/runtime"
@@ -39,6 +34,9 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 
 	awv1beta2 "github.com/project-codeflare/appwrapper/api/v1beta2"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 // These tests use Ginkgo (BDD-style Go testing framework). Refer to

internal/webhook/appwrapper_fixtures_test.go

@@ -21,15 +21,16 @@ import (
 	"math/rand"
 	"time"
 
-	. "github.com/onsi/gomega"
-
-	awv1beta2 "github.com/project-codeflare/appwrapper/api/v1beta2"
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/utils/ptr"
 	"sigs.k8s.io/yaml"
+
+	awv1beta2 "github.com/project-codeflare/appwrapper/api/v1beta2"
+
+	. "github.com/onsi/gomega"
 )
 
 const charset = "abcdefghijklmnopqrstuvwxyz0123456789"