Update golangci-lint/goimports configuration (#4945)

* Update goimports settings to consider github.com/elastic/cloud-on-k8s a local prefix in imports

* remove comment in golangci.yml

* Fix imports
Add back linter hints

* Fix more imports
Add back more linter hints

* Update verbiage for ccontributing guidelines
Update additional files to group import groups properly

* Fix mis-aligned imports

* Fix additional bad import statements

.golangci.yml

@@ -11,6 +11,10 @@ linters-settings:
  or more contributor license agreements. Licensed under the Elastic License 2.0;
  you may not use this file except in compliance with the Elastic License 2.0.
 
+ goimports:
+ # put imports beginning with prefix after 3rd-party packages;
+ local-prefixes: github.com/elastic/cloud-on-k8s
+
  nolintlint:
  allow-leading-space: false
  allow-unused: false

CONTRIBUTING.md

@@ -33,9 +33,10 @@ Check requirements and steps in this [guide](dev-setup.md).
 ### Format your code and manage imports
 
 1. Run `make lint` to make sure there are no lint warnings.
-2. Make sure you only have two groups in your imports:
+2. Make sure you only have, at maximum, 3 groups in your imports:
  - a group for packages from the standard library
- - a group for third parties
+ - (optionally) a group for third parties
+ - (optionally) a group for 'local' imports (local being 'github.com/elastic/cloud-on-k8s')
 
 ### Scripts
 

cmd/licensing-info/main.go

@@ -10,12 +10,13 @@ import (
  "fmt"
  "log"
 
- controllerscheme "github.com/elastic/cloud-on-k8s/pkg/controller/common/scheme"
- "github.com/elastic/cloud-on-k8s/pkg/license"
  "k8s.io/client-go/kubernetes/scheme"
  _ "k8s.io/client-go/plugin/pkg/client/auth/gcp" // auth on gke
  "sigs.k8s.io/controller-runtime/pkg/client"
  "sigs.k8s.io/controller-runtime/pkg/client/config"
+
+ controllerscheme "github.com/elastic/cloud-on-k8s/pkg/controller/common/scheme"
+ "github.com/elastic/cloud-on-k8s/pkg/license"
 )
 
 // Simple program that returns the licensing information, including the total memory of all Elastic managed components by

cmd/main.go

@@ -5,11 +5,12 @@
 package main
 
 import (
+ "github.com/spf13/cobra"
+ _ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
+
  "github.com/elastic/cloud-on-k8s/cmd/manager"
  "github.com/elastic/cloud-on-k8s/pkg/about"
  "github.com/elastic/cloud-on-k8s/pkg/dev"
- "github.com/spf13/cobra"
- _ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
 )
 
 func main() {

cmd/manager/main.go

@@ -15,6 +15,27 @@ import (
  "strings"
  "time"
 
+ "github.com/fsnotify/fsnotify"
+ "github.com/go-logr/logr"
+ "github.com/spf13/cobra"
+ "github.com/spf13/viper"
+ "go.elastic.co/apm"
+ "go.uber.org/automaxprocs/maxprocs"
+ corev1 "k8s.io/api/core/v1"
+ "k8s.io/apimachinery/pkg/runtime"
+ "k8s.io/apimachinery/pkg/util/wait"
+ "k8s.io/client-go/kubernetes"
+ clientgoscheme "k8s.io/client-go/kubernetes/scheme"
+ _ "k8s.io/client-go/plugin/pkg/client/auth/gcp" // allow gcp authentication
+ "k8s.io/client-go/rest"
+ "k8s.io/client-go/tools/leaderelection/resourcelock"
+ ctrl "sigs.k8s.io/controller-runtime"
+ "sigs.k8s.io/controller-runtime/pkg/cache"
+ "sigs.k8s.io/controller-runtime/pkg/client"
+ logf "sigs.k8s.io/controller-runtime/pkg/log"
+ "sigs.k8s.io/controller-runtime/pkg/manager"
+ "sigs.k8s.io/controller-runtime/pkg/manager/signals"
+
  "github.com/elastic/cloud-on-k8s/pkg/about"
  agentv1alpha1 "github.com/elastic/cloud-on-k8s/pkg/apis/agent/v1alpha1"
  apmv1 "github.com/elastic/cloud-on-k8s/pkg/apis/apm/v1"
@@ -61,26 +82,6 @@ import (
  "github.com/elastic/cloud-on-k8s/pkg/utils/metrics"
  "github.com/elastic/cloud-on-k8s/pkg/utils/net"
  "github.com/elastic/cloud-on-k8s/pkg/utils/rbac"
- "github.com/fsnotify/fsnotify"
- "github.com/go-logr/logr"
- "github.com/spf13/cobra"
- "github.com/spf13/viper"
- "go.elastic.co/apm"
- "go.uber.org/automaxprocs/maxprocs"
- corev1 "k8s.io/api/core/v1"
- "k8s.io/apimachinery/pkg/runtime"
- "k8s.io/apimachinery/pkg/util/wait"
- "k8s.io/client-go/kubernetes"
- clientgoscheme "k8s.io/client-go/kubernetes/scheme"
- _ "k8s.io/client-go/plugin/pkg/client/auth/gcp" // allow gcp authentication
- "k8s.io/client-go/rest"
- "k8s.io/client-go/tools/leaderelection/resourcelock"
- ctrl "sigs.k8s.io/controller-runtime"
- "sigs.k8s.io/controller-runtime/pkg/cache"
- "sigs.k8s.io/controller-runtime/pkg/client"
- logf "sigs.k8s.io/controller-runtime/pkg/log"
- "sigs.k8s.io/controller-runtime/pkg/manager"
- "sigs.k8s.io/controller-runtime/pkg/manager/signals"
 )
 
 const (

cmd/manager/main_test.go

@@ -8,20 +8,21 @@ import (
  "context"
  "testing"
 
- apmv1 "github.com/elastic/cloud-on-k8s/pkg/apis/apm/v1"
- beatv1beta1 "github.com/elastic/cloud-on-k8s/pkg/apis/beat/v1beta1"
- esv1 "github.com/elastic/cloud-on-k8s/pkg/apis/elasticsearch/v1"
- entv1 "github.com/elastic/cloud-on-k8s/pkg/apis/enterprisesearch/v1"
- kbv1 "github.com/elastic/cloud-on-k8s/pkg/apis/kibana/v1"
- "github.com/elastic/cloud-on-k8s/pkg/controller/common/reconciler"
- "github.com/elastic/cloud-on-k8s/pkg/utils/k8s"
  "github.com/stretchr/testify/require"
  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"
  logf "sigs.k8s.io/controller-runtime/pkg/log"
+
+ apmv1 "github.com/elastic/cloud-on-k8s/pkg/apis/apm/v1"
+ beatv1beta1 "github.com/elastic/cloud-on-k8s/pkg/apis/beat/v1beta1"
+ esv1 "github.com/elastic/cloud-on-k8s/pkg/apis/elasticsearch/v1"
+ entv1 "github.com/elastic/cloud-on-k8s/pkg/apis/enterprisesearch/v1"
+ kbv1 "github.com/elastic/cloud-on-k8s/pkg/apis/kibana/v1"
+ "github.com/elastic/cloud-on-k8s/pkg/controller/common/reconciler"
+ "github.com/elastic/cloud-on-k8s/pkg/utils/k8s"
 )
 
 func ownedSecret(namespace, name, ownerNs, ownerName, ownerKind string) *corev1.Secret {

hack/deployer/cmd/create.go

@@ -10,8 +10,9 @@ import (
  "os"
  "path"
 
- "github.com/elastic/cloud-on-k8s/hack/deployer/runner"
  "github.com/spf13/cobra"
+
+ "github.com/elastic/cloud-on-k8s/hack/deployer/runner"
 )
 
 func CreateCommand() *cobra.Command {

hack/deployer/cmd/execute.go

@@ -5,8 +5,9 @@
 package cmd
 
 import (
- "github.com/elastic/cloud-on-k8s/hack/deployer/runner"
  "github.com/spf13/cobra"
+
+ "github.com/elastic/cloud-on-k8s/hack/deployer/runner"
 )
 
 func ExecuteCommand() *cobra.Command {

hack/deployer/cmd/get.go

@@ -7,9 +7,10 @@ package cmd
 import (
  "fmt"
 
- "github.com/elastic/cloud-on-k8s/hack/deployer/runner"
  "github.com/ghodss/yaml"
  "github.com/spf13/cobra"
+
+ "github.com/elastic/cloud-on-k8s/hack/deployer/runner"
 )
 
 func GetCommand() *cobra.Command {

pkg/apis/agent/v1alpha1/validations.go

@@ -8,9 +8,10 @@ import (
  "fmt"
  "reflect"
 
+ "k8s.io/apimachinery/pkg/util/validation/field"
+
  commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
  "github.com/elastic/cloud-on-k8s/pkg/controller/common/version"
- "k8s.io/apimachinery/pkg/util/validation/field"
 )
 
 var (

pkg/apis/agent/v1alpha1/validations_test.go

@@ -7,8 +7,9 @@ package v1alpha1
 import (
  "testing"
 
- commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
  "github.com/stretchr/testify/assert"
+
+ commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
 )
 
 func Test_checkSupportedVersion(t *testing.T) {

pkg/apis/agent/v1alpha1/webhook.go

@@ -7,13 +7,14 @@ package v1alpha1
 import (
  "errors"
 
- ulog "github.com/elastic/cloud-on-k8s/pkg/utils/log"
  apierrors "k8s.io/apimachinery/pkg/api/errors"
  "k8s.io/apimachinery/pkg/runtime"
  "k8s.io/apimachinery/pkg/runtime/schema"
  "k8s.io/apimachinery/pkg/util/validation/field"
  ctrl "sigs.k8s.io/controller-runtime"
  "sigs.k8s.io/controller-runtime/pkg/webhook"
+
+ ulog "github.com/elastic/cloud-on-k8s/pkg/utils/log"
 )
 
 var (

pkg/apis/apm/v1/webhook.go

@@ -8,15 +8,16 @@ import (
  "errors"
  "fmt"
 
- commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
- "github.com/elastic/cloud-on-k8s/pkg/controller/common/version"
- ulog "github.com/elastic/cloud-on-k8s/pkg/utils/log"
  apierrors "k8s.io/apimachinery/pkg/api/errors"
  runtime "k8s.io/apimachinery/pkg/runtime"
  "k8s.io/apimachinery/pkg/runtime/schema"
  "k8s.io/apimachinery/pkg/util/validation/field"
  ctrl "sigs.k8s.io/controller-runtime"
  "sigs.k8s.io/controller-runtime/pkg/webhook"
+
+ commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
+ "github.com/elastic/cloud-on-k8s/pkg/controller/common/version"
+ ulog "github.com/elastic/cloud-on-k8s/pkg/utils/log"
 )
 
 var (

pkg/apis/apm/v1/webhook_test.go

@@ -9,14 +9,15 @@ import (
  "strings"
  "testing"
 
- apmv1 "github.com/elastic/cloud-on-k8s/pkg/apis/apm/v1"
- commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
- "github.com/elastic/cloud-on-k8s/pkg/utils/test"
  "github.com/stretchr/testify/require"
  admissionv1beta1 "k8s.io/api/admission/v1beta1"
  corev1 "k8s.io/api/core/v1"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  "k8s.io/apimachinery/pkg/types"
+
+ apmv1 "github.com/elastic/cloud-on-k8s/pkg/apis/apm/v1"
+ commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
+ "github.com/elastic/cloud-on-k8s/pkg/utils/test"
 )
 
 func TestWebhook(t *testing.T) {

pkg/apis/apm/v1beta1/apmserver_types.go

@@ -5,9 +5,10 @@
 package v1beta1
 
 import (
- commonv1beta1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1beta1"
  corev1 "k8s.io/api/core/v1"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+ commonv1beta1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1beta1"
 )
 
 const APMServerContainerName = "apm-server"

pkg/apis/apm/v1beta1/webhook.go

@@ -7,15 +7,16 @@ package v1beta1
 import (
  "errors"
 
- commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
- "github.com/elastic/cloud-on-k8s/pkg/controller/common/version"
- ulog "github.com/elastic/cloud-on-k8s/pkg/utils/log"
  apierrors "k8s.io/apimachinery/pkg/api/errors"
  runtime "k8s.io/apimachinery/pkg/runtime"
  "k8s.io/apimachinery/pkg/runtime/schema"
  "k8s.io/apimachinery/pkg/util/validation/field"
  ctrl "sigs.k8s.io/controller-runtime"
  "sigs.k8s.io/controller-runtime/pkg/webhook"
+
+ commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
+ "github.com/elastic/cloud-on-k8s/pkg/controller/common/version"
+ ulog "github.com/elastic/cloud-on-k8s/pkg/utils/log"
 )
 
 var (

pkg/apis/apm/v1beta1/webhook_test.go

@@ -9,13 +9,14 @@ import (
  "strings"
  "testing"
 
- apmv1beta1 "github.com/elastic/cloud-on-k8s/pkg/apis/apm/v1beta1"
- "github.com/elastic/cloud-on-k8s/pkg/utils/test"
  "github.com/stretchr/testify/require"
  admissionv1beta1 "k8s.io/api/admission/v1beta1"
  corev1 "k8s.io/api/core/v1"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  "k8s.io/apimachinery/pkg/types"
+
+ apmv1beta1 "github.com/elastic/cloud-on-k8s/pkg/apis/apm/v1beta1"
+ "github.com/elastic/cloud-on-k8s/pkg/utils/test"
 )
 
 func TestWebhook(t *testing.T) {

pkg/apis/beat/v1beta1/webhook.go

@@ -7,13 +7,14 @@ package v1beta1
 import (
  "errors"
 
- ulog "github.com/elastic/cloud-on-k8s/pkg/utils/log"
  apierrors "k8s.io/apimachinery/pkg/api/errors"
  "k8s.io/apimachinery/pkg/runtime"
  "k8s.io/apimachinery/pkg/runtime/schema"
  "k8s.io/apimachinery/pkg/util/validation/field"
  ctrl "sigs.k8s.io/controller-runtime"
  "sigs.k8s.io/controller-runtime/pkg/webhook"
+
+ ulog "github.com/elastic/cloud-on-k8s/pkg/utils/log"
 )
 
 var (

pkg/apis/common/v1/validations.go

@@ -9,13 +9,14 @@ import (
  "fmt"
  "strings"
 
- common_name "github.com/elastic/cloud-on-k8s/pkg/controller/common/name"
- "github.com/elastic/cloud-on-k8s/pkg/controller/common/version"
  v1 "k8s.io/api/core/v1"
  "k8s.io/apimachinery/pkg/api/meta"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  "k8s.io/apimachinery/pkg/runtime"
  "k8s.io/apimachinery/pkg/util/validation/field"
+
+ common_name "github.com/elastic/cloud-on-k8s/pkg/controller/common/name"
+ "github.com/elastic/cloud-on-k8s/pkg/controller/common/version"
 )
 
 // NoUnknownFields checks whether the last applied config annotation contains json with unknown fields.

pkg/apis/elasticsearch/v1/autoscaling.go

@@ -10,11 +10,12 @@ import (
  "fmt"
  "time"
 
+ "k8s.io/apimachinery/pkg/api/resource"
+ metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
  "github.com/elastic/cloud-on-k8s/pkg/controller/common/version"
  "github.com/elastic/cloud-on-k8s/pkg/utils/set"
  "github.com/elastic/cloud-on-k8s/pkg/utils/stringsutil"
- "k8s.io/apimachinery/pkg/api/resource"
- metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 const ElasticsearchAutoscalingSpecAnnotationName = "elasticsearch.alpha.elastic.co/autoscaling-spec"

pkg/apis/elasticsearch/v1/autoscaling_test.go

@@ -8,9 +8,10 @@ import (
  "reflect"
  "testing"
 
- commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
  "github.com/stretchr/testify/assert"
  "k8s.io/apimachinery/pkg/api/resource"
+
+ commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
 )
 
 func TestAutoscalingSpec_GetAutoscaledNodeSets(t *testing.T) {

pkg/apis/elasticsearch/v1/elasticsearch_config.go

@@ -5,11 +5,12 @@
 package v1
 
 import (
- "github.com/elastic/cloud-on-k8s/pkg/controller/common/version"
- "github.com/elastic/cloud-on-k8s/pkg/utils/stringsutil"
  "github.com/elastic/go-ucfg"
  "k8s.io/utils/pointer"
 
+ "github.com/elastic/cloud-on-k8s/pkg/controller/common/version"
+ "github.com/elastic/cloud-on-k8s/pkg/utils/stringsutil"
+
  commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
 )
 

pkg/apis/elasticsearch/v1/elasticsearch_config_test.go

@@ -7,12 +7,13 @@ package v1
 import (
  "testing"
 
- commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
- "github.com/elastic/cloud-on-k8s/pkg/controller/common/version"
- "github.com/elastic/cloud-on-k8s/pkg/utils/compare"
  "github.com/go-test/deep"
  "github.com/stretchr/testify/require"
  "k8s.io/utils/pointer"
+
+ commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
+ "github.com/elastic/cloud-on-k8s/pkg/controller/common/version"
+ "github.com/elastic/cloud-on-k8s/pkg/utils/compare"
 )
 
 func TestConfig_RoleDefaults(t *testing.T) {