Update verbiage for ccontributing guidelines

Update additional files to group import groups properly
elastic · Oct 20, 2021 · 4743b16 · 4743b16
1 parent 4f159b9
commit 4743b16
Show file tree

Hide file tree

Showing 16 changed files with 27 additions and 40 deletions.
diff --git a/CONTRIBUTING.md b/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
 

diff --git a/pkg/controller/association/conf.go b/pkg/controller/association/conf.go
@@ -21,11 +21,10 @@ import (
  "k8s.io/client-go/tools/record"
  "sigs.k8s.io/controller-runtime/pkg/reconcile"
 
+ commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
  "github.com/elastic/cloud-on-k8s/pkg/controller/common/events"
  "github.com/elastic/cloud-on-k8s/pkg/controller/common/tracing"
  "github.com/elastic/cloud-on-k8s/pkg/controller/common/version"
-
- commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
  "github.com/elastic/cloud-on-k8s/pkg/utils/k8s"
 )
 

diff --git a/pkg/controller/association/controller/beat_es.go b/pkg/controller/association/controller/beat_es.go
@@ -8,10 +8,9 @@ import (
  "fmt"
  "strings"
 
- "sigs.k8s.io/controller-runtime/pkg/client"
-
  pkgerrors "github.com/pkg/errors"
  "k8s.io/apimachinery/pkg/types"
+ "sigs.k8s.io/controller-runtime/pkg/client"
  "sigs.k8s.io/controller-runtime/pkg/manager"
 
  beatv1beta1 "github.com/elastic/cloud-on-k8s/pkg/apis/beat/v1beta1"

diff --git a/pkg/controller/association/reconciler.go b/pkg/controller/association/reconciler.go
@@ -10,6 +10,7 @@ import (
  "reflect"
  "time"
 
+ "github.com/go-logr/logr"
  "go.elastic.co/apm"
  corev1 "k8s.io/api/core/v1"
  apierrors "k8s.io/apimachinery/pkg/api/errors"
@@ -18,8 +19,6 @@ import (
  "sigs.k8s.io/controller-runtime/pkg/client"
  "sigs.k8s.io/controller-runtime/pkg/reconcile"
 
- "github.com/go-logr/logr"
-
  commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
  esv1 "github.com/elastic/cloud-on-k8s/pkg/apis/elasticsearch/v1"
  "github.com/elastic/cloud-on-k8s/pkg/controller/common"

diff --git a/pkg/controller/association/resources_test.go b/pkg/controller/association/resources_test.go
@@ -8,13 +8,12 @@ import (
  "context"
  "testing"
 
+ "github.com/stretchr/testify/assert"
  corev1 "k8s.io/api/core/v1"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  "k8s.io/apimachinery/pkg/runtime"
  "k8s.io/apimachinery/pkg/types"
 
- "github.com/stretchr/testify/assert"
-
  commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
  esv1 "github.com/elastic/cloud-on-k8s/pkg/apis/elasticsearch/v1"
  kbv1 "github.com/elastic/cloud-on-k8s/pkg/apis/kibana/v1"

diff --git a/pkg/controller/common/keystore/resources_test.go b/pkg/controller/common/keystore/resources_test.go
@@ -7,17 +7,18 @@ package keystore
 import (
  "testing"
 
- commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
- kbv1 "github.com/elastic/cloud-on-k8s/pkg/apis/kibana/v1"
- "github.com/elastic/cloud-on-k8s/pkg/controller/common/driver"
- watches2 "github.com/elastic/cloud-on-k8s/pkg/controller/common/watches"
- "github.com/elastic/cloud-on-k8s/pkg/utils/k8s"
  "github.com/magiconair/properties/assert"
  "github.com/stretchr/testify/require"
  corev1 "k8s.io/api/core/v1"
  "k8s.io/apimachinery/pkg/api/resource"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  "k8s.io/client-go/tools/record"
+
+ commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
+ kbv1 "github.com/elastic/cloud-on-k8s/pkg/apis/kibana/v1"
+ "github.com/elastic/cloud-on-k8s/pkg/controller/common/driver"
+ watches2 "github.com/elastic/cloud-on-k8s/pkg/controller/common/watches"
+ "github.com/elastic/cloud-on-k8s/pkg/utils/k8s"
 )
 
 var (

diff --git a/pkg/controller/common/license/verifier_test.go b/pkg/controller/common/license/verifier_test.go
@@ -14,7 +14,6 @@ import (
  "time"
 
  "github.com/go-test/deep"
-
  "github.com/stretchr/testify/assert"
  "github.com/stretchr/testify/require"
 

diff --git a/pkg/controller/elasticsearch/remotecluster/elasticsearch_test.go b/pkg/controller/elasticsearch/remotecluster/elasticsearch_test.go
@@ -8,10 +8,9 @@ import (
  "reflect"
  "testing"
 
- "k8s.io/client-go/tools/record"
-
  "github.com/stretchr/testify/assert"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+ "k8s.io/client-go/tools/record"
 
  commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
  esv1 "github.com/elastic/cloud-on-k8s/pkg/apis/elasticsearch/v1"

diff --git a/pkg/controller/elasticsearch/sset/list_test.go b/pkg/controller/elasticsearch/sset/list_test.go
@@ -8,13 +8,12 @@ import (
  "reflect"
  "testing"
 
- "k8s.io/apimachinery/pkg/types"
-
  "github.com/stretchr/testify/assert"
  "github.com/stretchr/testify/require"
  appsv1 "k8s.io/api/apps/v1"
  corev1 "k8s.io/api/core/v1"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+ "k8s.io/apimachinery/pkg/types"
 
  "github.com/elastic/cloud-on-k8s/pkg/controller/common/version"
  "github.com/elastic/cloud-on-k8s/pkg/controller/elasticsearch/label"

diff --git a/pkg/controller/elasticsearch/user/associated_test.go b/pkg/controller/elasticsearch/user/associated_test.go
@@ -8,12 +8,11 @@ import (
  "reflect"
  "testing"
 
+ "github.com/stretchr/testify/require"
  corev1 "k8s.io/api/core/v1"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  "k8s.io/apimachinery/pkg/runtime"
 
- "github.com/stretchr/testify/require"
-
  esv1 "github.com/elastic/cloud-on-k8s/pkg/apis/elasticsearch/v1"
  "github.com/elastic/cloud-on-k8s/pkg/utils/k8s"
 )

diff --git a/pkg/controller/elasticsearch/user/user_provided_test.go b/pkg/controller/elasticsearch/user/user_provided_test.go
@@ -9,6 +9,8 @@ import (
 
  "github.com/stretchr/testify/require"
  corev1 "k8s.io/api/core/v1"
+ metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+ "k8s.io/apimachinery/pkg/runtime"
  "k8s.io/apimachinery/pkg/types"
  "k8s.io/client-go/tools/record"
 
@@ -18,9 +20,6 @@ import (
  "github.com/elastic/cloud-on-k8s/pkg/controller/common/watches"
  "github.com/elastic/cloud-on-k8s/pkg/controller/elasticsearch/user/filerealm"
  "github.com/elastic/cloud-on-k8s/pkg/utils/k8s"
-
- metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
- "k8s.io/apimachinery/pkg/runtime"
 )
 
 func initDynamicWatches(watchNames ...string) watches.DynamicWatches {

diff --git a/pkg/controller/enterprisesearch/pod_test.go b/pkg/controller/enterprisesearch/pod_test.go
@@ -7,9 +7,8 @@ package enterprisesearch
 import (
  "testing"
 
- corev1 "k8s.io/api/core/v1"
-
  "github.com/stretchr/testify/assert"
+ corev1 "k8s.io/api/core/v1"
 
  entv1 "github.com/elastic/cloud-on-k8s/pkg/apis/enterprisesearch/v1"
 )

diff --git a/pkg/controller/kibana/driver_test.go b/pkg/controller/kibana/driver_test.go
@@ -20,15 +20,14 @@ import (
  "k8s.io/apimachinery/pkg/util/intstr"
  "k8s.io/client-go/tools/record"
 
- "github.com/elastic/cloud-on-k8s/pkg/controller/kibana/network"
-
  commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
  kbv1 "github.com/elastic/cloud-on-k8s/pkg/apis/kibana/v1"
  "github.com/elastic/cloud-on-k8s/pkg/controller/common"
  "github.com/elastic/cloud-on-k8s/pkg/controller/common/certificates"
  "github.com/elastic/cloud-on-k8s/pkg/controller/common/deployment"
  "github.com/elastic/cloud-on-k8s/pkg/controller/common/watches"
  "github.com/elastic/cloud-on-k8s/pkg/controller/elasticsearch/settings"
+ "github.com/elastic/cloud-on-k8s/pkg/controller/kibana/network"
  "github.com/elastic/cloud-on-k8s/pkg/utils/compare"
  "github.com/elastic/cloud-on-k8s/pkg/utils/k8s"
 )

diff --git a/pkg/controller/kibana/pod_test.go b/pkg/controller/kibana/pod_test.go
@@ -7,10 +7,6 @@ package kibana
 import (
  "testing"
 
- commonvolume "github.com/elastic/cloud-on-k8s/pkg/controller/common/volume"
- "github.com/elastic/cloud-on-k8s/pkg/controller/kibana/network"
- "github.com/elastic/cloud-on-k8s/pkg/utils/k8s"
-
  "github.com/stretchr/testify/assert"
  "github.com/stretchr/testify/require"
  corev1 "k8s.io/api/core/v1"
@@ -21,6 +17,9 @@ import (
  kbv1 "github.com/elastic/cloud-on-k8s/pkg/apis/kibana/v1"
  "github.com/elastic/cloud-on-k8s/pkg/controller/common/container"
  "github.com/elastic/cloud-on-k8s/pkg/controller/common/keystore"
+ commonvolume "github.com/elastic/cloud-on-k8s/pkg/controller/common/volume"
+ "github.com/elastic/cloud-on-k8s/pkg/controller/kibana/network"
+ "github.com/elastic/cloud-on-k8s/pkg/utils/k8s"
 )
 
 func TestNewPodTemplateSpec(t *testing.T) {

diff --git a/pkg/controller/remoteca/watches.go b/pkg/controller/remoteca/watches.go
@@ -7,9 +7,6 @@ package remoteca
 import (
  "fmt"
 
- "github.com/elastic/cloud-on-k8s/pkg/controller/common"
- "github.com/elastic/cloud-on-k8s/pkg/utils/maps"
-
  v1 "k8s.io/api/core/v1"
  "k8s.io/apimachinery/pkg/types"
  "sigs.k8s.io/controller-runtime/pkg/client"
@@ -19,9 +16,11 @@ import (
  "sigs.k8s.io/controller-runtime/pkg/source"
 
  esv1 "github.com/elastic/cloud-on-k8s/pkg/apis/elasticsearch/v1"
+ "github.com/elastic/cloud-on-k8s/pkg/controller/common"
  "github.com/elastic/cloud-on-k8s/pkg/controller/common/watches"
  "github.com/elastic/cloud-on-k8s/pkg/controller/elasticsearch/certificates/remoteca"
  "github.com/elastic/cloud-on-k8s/pkg/controller/elasticsearch/certificates/transport"
+ "github.com/elastic/cloud-on-k8s/pkg/utils/maps"
 )
 
 // AddWatches set watches on objects needed to manage the association between a local and a remote cluster.

diff --git a/pkg/dev/portforward/pod_forwarder_test.go b/pkg/dev/portforward/pod_forwarder_test.go
@@ -12,11 +12,9 @@ import (
  "testing"
  "time"
 
- "k8s.io/apimachinery/pkg/types"
-
- "github.com/stretchr/testify/require"
-
  "github.com/stretchr/testify/assert"
+ "github.com/stretchr/testify/require"
+ "k8s.io/apimachinery/pkg/types"
 )
 
 type capturingDialer struct {