Tidy import order (#4440)

* Sort linters

* Add gci

* Add exclusions for generated code

* Update imports for core operator

* Update imports for asoctl

* Add lint for mangle-test-json

* Update imports for generator

* Fix tests sensitive to line numbers

* Add test utility to taskfile

* Update new tests

* Remove aliases group

* Update controller

* Update generator

* Update asoctl

* Update line numbers in test

Author: theunrepentantgeek

.golangci.yml

@@ -4,31 +4,51 @@ run:
 
 linters:
   enable:
+    - gci
     - gofmt
-    - staticcheck
     - gosimple
-    - unused
-    - tparallel
     - paralleltest
     - prealloc
-    - unparam  # This was added while we used go1.18 which means it's always been disabled. It may eventually be re-enabled and we'll need to fix what it finds
+    - staticcheck
+    - tparallel
+    - unparam 
+    - unused
   presets:
     - bugs
     - unused
   disable:
     # The below rules are disabled due to bug with go1.18 and generics: https://github.com/golangci/golangci-lint/issues/2859
     - stylecheck
     - musttag # Extremely slow, at least on CI machines
+
 linters-settings:
-  govet:
-    check-shadowing: true
-  unused:
-    generated-is-used: true
   exhaustive:
     default-signifies-exhaustive: true
+  gci:
+    custom-order: true
+    sections:
+      - standard
+      - dot
+      - default
+      - prefix(github.com/Azure/azure-service-operator/)
+  govet:
+    check-shadowing: true
   gosimple:
     # See https://golangci-lint.run/usage/linters#gosimple for a breakdown of what's checked by this linter
     checks:
       - "all"
       - "-S1002" # Comparison to bool explicitly can sometimes add clarity
       - "-S1016" # Uncommon language feature, encourages coupling when it may not be appropriate
+  unused:
+    generated-is-used: true
+
+issues:
+  exclude-rules:
+    # Exclude some linters from being run on generated files
+    - path: "_gen.go"
+      linters:
+        - gci
+    # Exclude some linters from being run on generated test files
+    - path: "_gen_test.go"
+      linters:
+        - gci

Taskfile.yml

@@ -17,6 +17,8 @@ vars:
   CONTROLLER_OUTPUT:
     sh: 'realpath v2/config'
 
+  MANGLE_ROOT: v2/tools/mangle-test-json
+
   TEST_RESOURCE_PREFIX: asotest
   TEST_LIVE_RESOURCE_PREFIX: asolivetest
   SCRIPTS_ROOT:
@@ -70,6 +72,7 @@ tasks:
       - controller:quick-checks
       - asoctl:quick-checks
       - crossplane:quick-checks
+      - mangle-test:quick-checks
     cmds:
       - task: format-code # Run after the deps to avoid racing with generated file creation
 
@@ -261,6 +264,7 @@ tasks:
       - task: doc:render-diagrams
 
   ############### Controller targets ###############
+
   controller:quick-checks:
     cmds:
       - task: controller:test
@@ -1105,7 +1109,20 @@ tasks:
     cmds:
       - task: doc:crd-api
 
+  ############### Utility targets ###############
+
+  mangle-test:quick-checks:
+    cmds:
+      - task: mangle-test:lint
+
+  mangle-test:lint:
+    desc: Run mangle-test fast lint checks.
+    dir: '{{.MANGLE_ROOT}}'
+    cmds:
+      - golangci-lint run --verbose --fast=false --timeout 5m ./...  
+
   ############### Crossplane targets ###############
+
   crossplane:quick-checks:
     cmds:
       - task: basic-checks

v2/api/apimanagement/customizations/subscription_extensions.go

@@ -8,6 +8,8 @@ package customizations
 import (
 	"context"
 
+	. "github.com/Azure/azure-service-operator/v2/internal/logging"
+
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
@@ -16,7 +18,6 @@ import (
 
 	apimanagement "github.com/Azure/azure-service-operator/v2/api/apimanagement/v1api20220801/storage"
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
-	. "github.com/Azure/azure-service-operator/v2/internal/logging"
 	"github.com/Azure/azure-service-operator/v2/internal/set"
 	"github.com/Azure/azure-service-operator/v2/internal/util/to"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"

v2/api/appconfiguration/customizations/configuration_store_extensions.go

@@ -8,6 +8,8 @@ package customizations
 import (
 	"context"
 
+	. "github.com/Azure/azure-service-operator/v2/internal/logging"
+
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/runtime"
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration"
 	"github.com/go-logr/logr"
@@ -17,7 +19,6 @@ import (
 
 	storage "github.com/Azure/azure-service-operator/v2/api/appconfiguration/v1api20220501/storage"
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
-	. "github.com/Azure/azure-service-operator/v2/internal/logging"
 	"github.com/Azure/azure-service-operator/v2/internal/set"
 	"github.com/Azure/azure-service-operator/v2/internal/util/to"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"

v2/api/authorization/customizations/role_assignment_extensions.go

@@ -10,7 +10,6 @@ import (
 	"strings"
 
 	api "github.com/Azure/azure-service-operator/v2/api/authorization/v1api20220401"
-
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime/extensions"
 )

v2/api/authorization/customizations/role_definition_extensions.go

@@ -10,7 +10,6 @@ import (
 	"strings"
 
 	api "github.com/Azure/azure-service-operator/v2/api/authorization/v1api20220401"
-
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime/extensions"
 )

v2/api/cache/customizations/redis_extensions.go

@@ -9,6 +9,8 @@ import (
 	"context"
 	"strconv"
 
+	. "github.com/Azure/azure-service-operator/v2/internal/logging"
+
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/redis/armredis"
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
@@ -17,7 +19,6 @@ import (
 
 	redis "github.com/Azure/azure-service-operator/v2/api/cache/v1api20230801/storage"
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
-	. "github.com/Azure/azure-service-operator/v2/internal/logging"
 	"github.com/Azure/azure-service-operator/v2/internal/set"
 	"github.com/Azure/azure-service-operator/v2/internal/util/to"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"

v2/api/compute/customizations/vmss_extensions.go

@@ -11,14 +11,15 @@ import (
 	"net/http"
 	"reflect"
 
+	. "github.com/Azure/azure-service-operator/v2/internal/logging"
+
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore"
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
 	"sigs.k8s.io/controller-runtime/pkg/conversion"
 
 	compute "github.com/Azure/azure-service-operator/v2/api/compute/v1api20220301/storage"
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
-	. "github.com/Azure/azure-service-operator/v2/internal/logging"
 	"github.com/Azure/azure-service-operator/v2/internal/resolver"
 	"github.com/Azure/azure-service-operator/v2/internal/util/kubeclient"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"

v2/api/containerservice/customizations/managed_cluster_extensions.go

@@ -10,6 +10,8 @@ import (
 	"fmt"
 	"strings"
 
+	. "github.com/Azure/azure-service-operator/v2/internal/logging"
+
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerservice/armcontainerservice"
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
@@ -18,7 +20,6 @@ import (
 
 	containerservice "github.com/Azure/azure-service-operator/v2/api/containerservice/v1api20240901/storage"
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
-	. "github.com/Azure/azure-service-operator/v2/internal/logging"
 	"github.com/Azure/azure-service-operator/v2/internal/resolver"
 	"github.com/Azure/azure-service-operator/v2/internal/set"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"

v2/api/dataprotection/customizations/backup_vaults_backup_instance_extensions.go

@@ -10,14 +10,15 @@ import (
 	"fmt"
 	"strings"
 
+	. "github.com/Azure/azure-service-operator/v2/internal/logging"
+
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/dataprotection/armdataprotection/v3"
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
 	"sigs.k8s.io/controller-runtime/pkg/conversion"
 
 	dataprotection "github.com/Azure/azure-service-operator/v2/api/dataprotection/v1api20231101/storage"
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
-	. "github.com/Azure/azure-service-operator/v2/internal/logging"
 	"github.com/Azure/azure-service-operator/v2/internal/resolver"
 	"github.com/Azure/azure-service-operator/v2/internal/set"
 	"github.com/Azure/azure-service-operator/v2/internal/util/to"

v2/api/dbformariadb/customizations/server_extensions.go

@@ -8,14 +8,15 @@ package customizations
 import (
 	"context"
 
+	. "github.com/Azure/azure-service-operator/v2/internal/logging"
+
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
 	v1 "k8s.io/api/core/v1"
 	"sigs.k8s.io/controller-runtime/pkg/conversion"
 
 	mariadb "github.com/Azure/azure-service-operator/v2/api/dbformariadb/v1api20180601/storage"
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
-	. "github.com/Azure/azure-service-operator/v2/internal/logging"
 	"github.com/Azure/azure-service-operator/v2/internal/set"
 	"github.com/Azure/azure-service-operator/v2/internal/util/to"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"

v2/api/dbformysql/customizations/flexible_server_extensions.go

@@ -8,14 +8,15 @@ package customizations
 import (
 	"context"
 
+	. "github.com/Azure/azure-service-operator/v2/internal/logging"
+
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
 	v1 "k8s.io/api/core/v1"
 	"sigs.k8s.io/controller-runtime/pkg/conversion"
 
 	mysql "github.com/Azure/azure-service-operator/v2/api/dbformysql/v1api20230630/storage"
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
-	. "github.com/Azure/azure-service-operator/v2/internal/logging"
 	"github.com/Azure/azure-service-operator/v2/internal/set"
 	"github.com/Azure/azure-service-operator/v2/internal/util/to"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"

v2/api/dbforpostgresql/customizations/flexible_server_extensions.go

@@ -10,14 +10,15 @@ import (
 	"fmt"
 	"strings"
 
+	. "github.com/Azure/azure-service-operator/v2/internal/logging"
+
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
 	v1 "k8s.io/api/core/v1"
 	"sigs.k8s.io/controller-runtime/pkg/conversion"
 
 	postgresql "github.com/Azure/azure-service-operator/v2/api/dbforpostgresql/v1api20221201/storage"
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
-	. "github.com/Azure/azure-service-operator/v2/internal/logging"
 	"github.com/Azure/azure-service-operator/v2/internal/resolver"
 	"github.com/Azure/azure-service-operator/v2/internal/set"
 	"github.com/Azure/azure-service-operator/v2/internal/util/to"

v2/api/dbforpostgresql/customizations/flexible_servers_database_extensions.go

@@ -13,7 +13,6 @@ import (
 
 	api "github.com/Azure/azure-service-operator/v2/api/dbforpostgresql/v1api20221201"
 	hub "github.com/Azure/azure-service-operator/v2/api/dbforpostgresql/v1api20221201/storage"
-
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
 	"github.com/Azure/azure-service-operator/v2/internal/resolver"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"

v2/api/dbforpostgresql/customizations/flexible_servers_firewall_rule_extensions.go

@@ -12,7 +12,6 @@ import (
 	"github.com/go-logr/logr"
 
 	postgresql "github.com/Azure/azure-service-operator/v2/api/dbforpostgresql/v1api20210601/storage"
-
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
 	"github.com/Azure/azure-service-operator/v2/internal/resolver"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"

v2/api/devices/customizations/iot_hub_extensions.go

@@ -8,6 +8,8 @@ package customizations
 import (
 	"context"
 
+	. "github.com/Azure/azure-service-operator/v2/internal/logging"
+
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/runtime"
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/iothub/armiothub"
 	"github.com/go-logr/logr"
@@ -17,7 +19,6 @@ import (
 
 	devices "github.com/Azure/azure-service-operator/v2/api/devices/v1api20210702/storage"
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
-	. "github.com/Azure/azure-service-operator/v2/internal/logging"
 	"github.com/Azure/azure-service-operator/v2/internal/set"
 	"github.com/Azure/azure-service-operator/v2/internal/util/to"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"

v2/api/documentdb/customizations/database_account_extensions.go

@@ -9,6 +9,8 @@ import (
 	"context"
 	"strings"
 
+	. "github.com/Azure/azure-service-operator/v2/internal/logging"
+
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos"
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
@@ -17,7 +19,6 @@ import (
 
 	documentdb "github.com/Azure/azure-service-operator/v2/api/documentdb/v1api20231115/storage"
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
-	. "github.com/Azure/azure-service-operator/v2/internal/logging"
 	"github.com/Azure/azure-service-operator/v2/internal/resolver"
 	"github.com/Azure/azure-service-operator/v2/internal/set"
 	"github.com/Azure/azure-service-operator/v2/internal/util/to"

v2/api/eventgrid/customizations/topic_extension.go

@@ -7,6 +7,8 @@ package customizations
 import (
 	"context"
 
+	. "github.com/Azure/azure-service-operator/v2/internal/logging"
+
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventgrid/armeventgrid"
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
@@ -15,7 +17,6 @@ import (
 
 	"github.com/Azure/azure-service-operator/v2/api/eventgrid/v1api20200601/storage"
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
-	. "github.com/Azure/azure-service-operator/v2/internal/logging"
 	"github.com/Azure/azure-service-operator/v2/internal/set"
 	"github.com/Azure/azure-service-operator/v2/internal/util/to"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"

v2/api/eventhub/customizations/namespace_extension.go

@@ -8,6 +8,8 @@ package customizations
 import (
 	"context"
 
+	. "github.com/Azure/azure-service-operator/v2/internal/logging"
+
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventhub/armeventhub"
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
@@ -16,7 +18,6 @@ import (
 
 	"github.com/Azure/azure-service-operator/v2/api/eventhub/v1api20211101/storage"
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
-	. "github.com/Azure/azure-service-operator/v2/internal/logging"
 	"github.com/Azure/azure-service-operator/v2/internal/set"
 	"github.com/Azure/azure-service-operator/v2/internal/util/to"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"

v2/api/eventhub/customizations/namespaces_authorization_rule_extension.go

@@ -8,6 +8,8 @@ package customizations
 import (
 	"context"
 
+	. "github.com/Azure/azure-service-operator/v2/internal/logging"
+
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventhub/armeventhub"
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
@@ -16,7 +18,6 @@ import (
 
 	"github.com/Azure/azure-service-operator/v2/api/eventhub/v1api20211101/storage"
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
-	. "github.com/Azure/azure-service-operator/v2/internal/logging"
 	"github.com/Azure/azure-service-operator/v2/internal/set"
 	"github.com/Azure/azure-service-operator/v2/internal/util/to"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"

v2/api/eventhub/customizations/namespaces_eventhubs_authorization_rule_extension.go

@@ -8,6 +8,8 @@ package customizations
 import (
 	"context"
 
+	. "github.com/Azure/azure-service-operator/v2/internal/logging"
+
 	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventhub/armeventhub"
 	"github.com/go-logr/logr"
 	"github.com/pkg/errors"
@@ -16,7 +18,6 @@ import (
 
 	"github.com/Azure/azure-service-operator/v2/api/eventhub/v1api20211101/storage"
 	"github.com/Azure/azure-service-operator/v2/internal/genericarmclient"
-	. "github.com/Azure/azure-service-operator/v2/internal/logging"
 	"github.com/Azure/azure-service-operator/v2/internal/set"
 	"github.com/Azure/azure-service-operator/v2/internal/util/to"
 	"github.com/Azure/azure-service-operator/v2/pkg/genruntime"