Merge pull request #2797 from jackfrancis/codespell-shouldnot-release-1.5

k8s-ci-robot · web-flow · commit b85361f5c4e5 · 2022-11-08T18:26:14.000-08:00
[release-1.5] update codespell definitions and fix go 1.19 lint
diff --git a/.codespellignore b/.codespellignore
@@ -3,3 +3,5 @@ witht
 geting
 ot
 intepreted
+updat
+shouldnot
diff --git a/azure/mock_azure/doc.go b/azure/mock_azure/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../hack/tools/bin/mockgen -destination azure_mock.go -package mock_azure -source ../interfaces.go
 //go:generate /usr/bin/env bash -c "cat ../../hack/boilerplate/boilerplate.generatego.txt azure_mock.go > _azure_mock.go && mv _azure_mock.go azure_mock.go"
 package mock_azure
diff --git a/azure/scope/mocks/doc.go b/azure/scope/mocks/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../hack/tools/bin/mockgen -destination node_getter_mock.go -package mock_scope -source ../machinepoolmachine.go nodeGetter
 //go:generate /usr/bin/env bash -c "cat ../../../hack/boilerplate/boilerplate.generatego.txt node_getter_mock.go > _node_getter_mock.go && mv _node_getter_mock.go node_getter_mock.go"
 package mock_scope
diff --git a/azure/services/async/mock_async/doc.go b/azure/services/async/mock_async/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination async_mock.go -package mock_async -source ../interfaces.go FutureHandler
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt async_mock.go > _async_mock.go && mv _async_mock.go async_mock.go"
 package mock_async
diff --git a/azure/services/availabilitysets/mock_availabilitysets/doc.go b/azure/services/availabilitysets/mock_availabilitysets/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination client_mock.go -package mock_availabilitysets -source ../client.go Client
 //go:generate ../../../../hack/tools/bin/mockgen -destination availabilitysets_mock.go -package mock_availabilitysets -source ../availabilitysets.go AvailabilitySetScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt client_mock.go > _client_mock.go && mv _client_mock.go client_mock.go"
diff --git a/azure/services/bastionhosts/mocks_bastionhosts/doc.go b/azure/services/bastionhosts/mocks_bastionhosts/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination bastionhosts_mock.go -package mock_bastionhosts -source ../bastionhosts.go BastionScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt bastionhosts_mock.go > _bastionhosts_mock.go && mv _bastionhosts_mock.go bastionhosts_mock.go"
 package mock_bastionhosts
diff --git a/azure/services/disks/mock_disks/doc.go b/azure/services/disks/mock_disks/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination disks_mock.go -package mock_disks -source ../disks.go DiskScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt disks_mock.go > _disks_mock.go && mv _disks_mock.go disks_mock.go"
 package mock_disks
diff --git a/azure/services/groups/mock_groups/doc.go b/azure/services/groups/mock_groups/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination client_mock.go -package mock_groups -source ../client.go Client
 //go:generate ../../../../hack/tools/bin/mockgen -destination groups_mock.go -package mock_groups -source ../groups.go GroupScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt client_mock.go > _client_mock.go && mv _client_mock.go client_mock.go"
diff --git a/azure/services/inboundnatrules/mock_inboundnatrules/doc.go b/azure/services/inboundnatrules/mock_inboundnatrules/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination client_mock.go -package mock_inboundnatrules -source ../client.go Client
 //go:generate ../../../../hack/tools/bin/mockgen -destination inboundnatrules_mock.go -package mock_inboundnatrules -source ../inboundnatrules.go InboundNatScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt client_mock.go > _client_mock.go && mv _client_mock.go client_mock.go"
diff --git a/azure/services/loadbalancers/mock_loadbalancers/doc.go b/azure/services/loadbalancers/mock_loadbalancers/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination loadbalancers_mock.go -package mock_loadbalancers -source ../loadbalancers.go LBScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt loadbalancers_mock.go > _loadbalancers_mock.go && mv _loadbalancers_mock.go loadbalancers_mock.go"
 package mock_loadbalancers
diff --git a/azure/services/managedclusters/mock_managedclusters/doc.go b/azure/services/managedclusters/mock_managedclusters/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination client_mock.go -package mock_managedclusters -source ../client.go CredentialGetter
 //go:generate ../../../../hack/tools/bin/mockgen -destination managedclusters_mock.go -package mock_managedclusters -source ../managedclusters.go ManagedClusterScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt client_mock.go > _client_mock.go && mv _client_mock.go client_mock.go"
diff --git a/azure/services/natgateways/mock_natgateways/doc.go b/azure/services/natgateways/mock_natgateways/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination natgateways_mock.go -package mock_natgateways -source ../natgateways.go NatGatewayScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt natgateways_mock.go > _natgateways_mock.go && mv _natgateways_mock.go natgateways_mock.go"
 package mock_natgateways
diff --git a/azure/services/networkinterfaces/mock_networkinterfaces/doc.go b/azure/services/networkinterfaces/mock_networkinterfaces/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination client_mock.go -package mock_networkinterfaces -source ../client.go Client
 //go:generate ../../../../hack/tools/bin/mockgen -destination networkinterfaces_mock.go -package mock_networkinterfaces -source ../networkinterfaces.go NICScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt client_mock.go > _client_mock.go && mv _client_mock.go client_mock.go"
diff --git a/azure/services/privatedns/mock_privatedns/doc.go b/azure/services/privatedns/mock_privatedns/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination privatedns_mock.go -package mock_privatedns -source ../privatedns.go Scope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt privatedns_mock.go > _privatedns_mock.go && mv _privatedns_mock.go privatedns_mock.go"
 package mock_privatedns
diff --git a/azure/services/publicips/mock_publicips/doc.go b/azure/services/publicips/mock_publicips/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination client_mock.go -package mock_publicips -source ../client.go Client
 //go:generate ../../../../hack/tools/bin/mockgen -destination publicips_mock.go -package mock_publicips -source ../publicips.go PublicIPScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt client_mock.go > _client_mock.go && mv _client_mock.go client_mock.go"
diff --git a/azure/services/resourceskus/mock_resourceskus/doc.go b/azure/services/resourceskus/mock_resourceskus/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination resourceskus_mock.go -package mock_resourceskus -source ../client.go Client
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt resourceskus_mock.go > _resourceskus_mock.go && mv _resourceskus_mock.go resourceskus_mock.go"
 package mock_resourceskus
diff --git a/azure/services/roleassignments/mock_roleassignments/doc.go b/azure/services/roleassignments/mock_roleassignments/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination client_mock.go -package mock_roleassignments -source ../client.go Client
 //go:generate ../../../../hack/tools/bin/mockgen -destination roleassignments_mock.go -package mock_roleassignments -source ../roleassignments.go RoleAssignmentScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt client_mock.go > _client_mock.go && mv _client_mock.go client_mock.go"
diff --git a/azure/services/routetables/mock_routetables/doc.go b/azure/services/routetables/mock_routetables/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination routetables_mock.go -package mock_routetables -source ../routetables.go RouteTableScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt routetables_mock.go > _routetables_mock.go && mv _routetables_mock.go routetables_mock.go"
 package mock_routetables
diff --git a/azure/services/scalesets/client.go b/azure/services/scalesets/client.go
@@ -176,8 +176,9 @@ func (ac *AzureClient) CreateOrUpdateAsync(ctx context.Context, resourceGroupNam
 // progress of the operation.
 //
 // Parameters:
-//   resourceGroupName - the name of the resource group.
-//   vmssName - the name of the VM scale set to create or update. parameters - the scale set object.
+//
+//	resourceGroupName - the name of the resource group.
+//	vmssName - the name of the VM scale set to create or update. parameters - the scale set object.
 func (ac *AzureClient) UpdateAsync(ctx context.Context, resourceGroupName, vmssName string, parameters compute.VirtualMachineScaleSetUpdate) (*infrav1.Future, error) {
 	ctx, _, done := tele.StartSpanWithLogger(ctx, "scalesets.AzureClient.UpdateAsync")
 	defer done()
@@ -287,8 +288,9 @@ func (ac *AzureClient) UpdateInstances(ctx context.Context, resourceGroupName, v
 // progress of the operation.
 //
 // Parameters:
-//   resourceGroupName - the name of the resource group.
-//   vmssName - the name of the VM scale set to create or update. parameters - the scale set object.
+//
+//	resourceGroupName - the name of the resource group.
+//	vmssName - the name of the VM scale set to create or update. parameters - the scale set object.
 func (ac *AzureClient) DeleteAsync(ctx context.Context, resourceGroupName, vmssName string) (*infrav1.Future, error) {
 	ctx, _, done := tele.StartSpanWithLogger(ctx, "scalesets.AzureClient.DeleteAsync")
 	defer done()
diff --git a/azure/services/scalesets/mock_scalesets/doc.go b/azure/services/scalesets/mock_scalesets/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination client_mock.go -package mock_scalesets -source ../client.go Client
 //go:generate ../../../../hack/tools/bin/mockgen -destination scalesets_mock.go -package mock_scalesets -source ../scalesets.go ScaleSetScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt client_mock.go > _client_mock.go && mv _client_mock.go client_mock.go"
diff --git a/azure/services/scalesetvms/client.go b/azure/services/scalesetvms/client.go
@@ -128,9 +128,10 @@ func (ac *azureClient) GetResultIfDone(ctx context.Context, future *infrav1.Futu
 // progress of the operation.
 //
 // Parameters:
-//   resourceGroupName - the name of the resource group.
-//   vmssName - the name of the VM scale set to create or update. parameters - the scale set object.
-//   instanceID - the ID of the VM scale set VM.
+//
+//	resourceGroupName - the name of the resource group.
+//	vmssName - the name of the VM scale set to create or update. parameters - the scale set object.
+//	instanceID - the ID of the VM scale set VM.
 func (ac *azureClient) DeleteAsync(ctx context.Context, resourceGroupName, vmssName, instanceID string) (*infrav1.Future, error) {
 	ctx, _, done := tele.StartSpanWithLogger(ctx, "scalesetvms.azureClient.DeleteAsync")
 	defer done()
diff --git a/azure/services/scalesetvms/mock_scalesetvms/doc.go b/azure/services/scalesetvms/mock_scalesetvms/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination client_mock.go -package mock_scalesetvms -source ../client.go client
 //go:generate ../../../../hack/tools/bin/mockgen -destination scalesetvms_mock.go -package mock_scalesetvms -source ../scalesetvms.go ScaleSetVMScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt client_mock.go > _client_mock.go && mv _client_mock.go client_mock.go"
diff --git a/azure/services/securitygroups/mock_securitygroups/doc.go b/azure/services/securitygroups/mock_securitygroups/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination securitygroups_mock.go -package mock_securitygroups -source ../securitygroups.go NSGScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt securitygroups_mock.go > _securitygroups_mock.go && mv _securitygroups_mock.go securitygroups_mock.go"
 package mock_securitygroups
diff --git a/azure/services/subnets/mock_subnets/doc.go b/azure/services/subnets/mock_subnets/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination subnets_mock.go -package mock_subnets -source ../subnets.go SubnetScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt subnets_mock.go > _subnets_mock.go && mv _subnets_mock.go subnets_mock.go"
 package mock_subnets
diff --git a/azure/services/tags/mock_tags/doc.go b/azure/services/tags/mock_tags/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination client_mock.go -package mock_tags -source ../client.go Client
 //go:generate ../../../../hack/tools/bin/mockgen -destination tags_mock.go -package mock_tags -source ../tags.go TagScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt client_mock.go > _client_mock.go && mv _client_mock.go client_mock.go"
diff --git a/azure/services/virtualmachineimages/mock_virtualmachineimages/doc.go b/azure/services/virtualmachineimages/mock_virtualmachineimages/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -package mock_virtualmachineimages -destination client_mock.go -source ../client.go
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt client_mock.go > _client_mock.go && mv _client_mock.go client_mock.go"
 package mock_virtualmachineimages
diff --git a/azure/services/virtualmachines/mock_virtualmachines/doc.go b/azure/services/virtualmachines/mock_virtualmachines/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination client_mock.go -package mock_virtualmachines -source ../client.go Client
 //go:generate ../../../../hack/tools/bin/mockgen -destination virtualmachines_mock.go -package mock_virtualmachines -source ../virtualmachines.go VMScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt client_mock.go > _client_mock.go && mv _client_mock.go client_mock.go"
diff --git a/azure/services/virtualnetworks/mock_virtualnetworks/doc.go b/azure/services/virtualnetworks/mock_virtualnetworks/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination client_mock.go -package mock_virtualnetworks -source ../client.go Getter
 //go:generate ../../../../hack/tools/bin/mockgen -destination virtualnetworks_mock.go -package mock_virtualnetworks -source ../virtualnetworks.go VNetScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt client_mock.go > _client_mock.go && mv _client_mock.go client_mock.go"
diff --git a/azure/services/vmextensions/mock_vmextensions/doc.go b/azure/services/vmextensions/mock_vmextensions/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination vmextensions_mock.go -package mock_vmextensions -source ../vmextensions.go VMExtensionScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt vmextensions_mock.go > _vmextensions_mock.go && mv _vmextensions_mock.go vmextensions_mock.go"
 package mock_vmextensions
diff --git a/azure/services/vnetpeerings/mock_vnetpeerings/doc.go b/azure/services/vnetpeerings/mock_vnetpeerings/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../../hack/tools/bin/mockgen -destination vnetpeerings_mock.go -package mock_vnetpeerings -source ../vnetpeerings.go VnetPeeringScope
 //go:generate /usr/bin/env bash -c "cat ../../../../hack/boilerplate/boilerplate.generatego.txt vnetpeerings_mock.go > _vnetpeerings_mock.go && mv _vnetpeerings_mock.go vnetpeerings_mock.go"
 package mock_vnetpeerings
diff --git a/exp/controllers/mocks/doc.go b/exp/controllers/mocks/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../hack/tools/bin/mockgen -destination reconciler_mock.go -package mock_controllers sigs.k8s.io/cluster-api-provider-azure/azure Reconciler
 //go:generate /usr/bin/env bash -c "cat ../../../hack/boilerplate/boilerplate.generatego.txt reconciler_mock.go > _reconciler_mock.go && mv _reconciler_mock.go reconciler_mock.go"
 package mock_controllers
diff --git a/internal/test/mock_log/doc.go b/internal/test/mock_log/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../hack/tools/bin/mockgen -destination log_mock.go -package mock_log github.com/go-logr/logr LogSink
 //go:generate /usr/bin/env bash -c "cat ../../../hack/boilerplate/boilerplate.generatego.txt log_mock.go > _log_mock.go && mv _log_mock.go log_mock.go"
 package mock_log
diff --git a/internal/test/record/logger.go b/internal/test/record/logger.go
@@ -269,11 +269,11 @@ func copySlice(in []interface{}) []interface{} {
 
 // flatten returns a human readable/machine parsable text representing the LogEntry.
 // Most notable difference with the klog implementation are:
-// - The message is printed at the beginning of the line, without the Msg= variable name e.g.
-//   "Msg"="This is a message" --> This is a message
-// - Variables name are not quoted, eg.
-//   This is a message "Var1"="value" --> This is a message Var1="value"
-// - Variables are not sorted, thus allowing full control to the developer on the output.
+//   - The message is printed at the beginning of the line, without the Msg= variable name e.g.
+//     "Msg"="This is a message" --> This is a message
+//   - Variables name are not quoted, eg.
+//     This is a message "Var1"="value" --> This is a message Var1="value"
+//   - Variables are not sorted, thus allowing full control to the developer on the output.
 func flatten(entry LogEntry) (string, error) {
 	var msgValue string
 	var errorValue error
diff --git a/pkg/coalescing/mocks/doc.go b/pkg/coalescing/mocks/doc.go
@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 // Run go generate to regenerate this mock.
+//
 //go:generate ../../../hack/tools/bin/mockgen -destination coalescing_mock.go -package mock_coalescing -source ../reconciler.go ReconcileCacher
 //go:generate ../../../hack/tools/bin/mockgen -destination reconciler_mock.go -package mock_coalescing sigs.k8s.io/controller-runtime/pkg/reconcile Reconciler
 //go:generate /usr/bin/env bash -c "cat ../../../hack/boilerplate/boilerplate.generatego.txt coalescing_mock.go > _coalescing_mock.go && mv _coalescing_mock.go coalescing_mock.go"
diff --git a/util/tele/corr_id.go b/util/tele/corr_id.go
@@ -45,7 +45,7 @@ type CorrID string
 // use the newly created context over the old one. Common usage is
 // below:
 //
-// 	ctx := context.Background()
+//	ctx := context.Background()
 //	ctx, newCorrID := ctxWithCorrID(ctx)
 //	fmt.Println("new corr ID: ", newCorrID)
 //	doSomething(ctx)
