Fix revive package name conventions

.golangci.yml

@@ -121,10 +121,6 @@ linters:
       - linters:
           - revive
         text: 'exported: exported method .*\.(Reconcile|SetupWithManager|SetupWebhookWithManager) should have comment or be unexported'
-        # To be fixed: This is done to unblock the bumping of golint.
-      - linters:
-          - revive
-        text: 'var-naming: avoid meaningless package names'
       - linters:
           - errcheck
         text: Error return value of .((os\.)?std(out|err)\..*|.*Close|.*Flush|os\.Remove(All)?|.*print(f|ln)?|os\.(Un)?(S|s)?etenv). is not checked

Dockerfile

@@ -39,7 +39,6 @@ COPY api/ api/
 COPY controllers/ controllers/
 COPY cloud/ cloud/
 COPY pkg/ pkg/
-COPY util/ util/
 COPY internal/ internal/
 
 # Build

cloud/scope/cluster.go

@@ -35,9 +35,9 @@ import (
 	v1beta1patch "sigs.k8s.io/cluster-api/util/deprecated/v1beta1/patch" //nolint:staticcheck
 
 	infrav1 "sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1beta2"
-	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/utils"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/vpc"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/endpoints"
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/pagingutils"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/record"
 )
 
@@ -181,7 +181,7 @@ func (s *ClusterScope) ensureVPCUnique(vpcName string) (*vpcv1.VPC, error) {
 		return true, "", nil
 	}
 
-	if err := utils.PagingHelper(f); err != nil {
+	if err := pagingutils.PagingHelper(f); err != nil {
 		return nil, err
 	}
 
@@ -286,7 +286,7 @@ func (s *ClusterScope) getSubnetAddrPrefix(vpcID, zone string) (string, error) {
 		return true, "", nil
 	}
 
-	if err := utils.PagingHelper(f); err != nil {
+	if err := pagingutils.PagingHelper(f); err != nil {
 		return "", err
 	}
 
@@ -327,7 +327,7 @@ func (s *ClusterScope) ensureSubnetUnique(subnetName string) (*vpcv1.Subnet, err
 		return true, "", nil
 	}
 
-	if err := utils.PagingHelper(f); err != nil {
+	if err := pagingutils.PagingHelper(f); err != nil {
 		return nil, err
 	}
 
@@ -374,7 +374,7 @@ func (s *ClusterScope) DeleteSubnet(ctx context.Context) error {
 		return true, "", nil
 	}
 
-	if err := utils.PagingHelper(f); err != nil {
+	if err := pagingutils.PagingHelper(f); err != nil {
 		return err
 	}
 
@@ -556,7 +556,7 @@ func (s *ClusterScope) getLoadBalancerByHostname(loadBalancerHostname string) (*
 		return true, "", nil
 	}
 
-	if err := utils.PagingHelper(f); err != nil {
+	if err := pagingutils.PagingHelper(f); err != nil {
 		return nil, err
 	}
 
@@ -594,7 +594,7 @@ func (s *ClusterScope) ensureLoadBalancerUnique(loadBalancerName string) (*vpcv1
 		return true, "", nil
 	}
 
-	if err := utils.PagingHelper(f); err != nil {
+	if err := pagingutils.PagingHelper(f); err != nil {
 		return nil, err
 	}
 
@@ -642,7 +642,7 @@ func (s *ClusterScope) DeleteLoadBalancer() (bool, error) {
 			return true, "", nil
 		}
 
-		if err := utils.PagingHelper(f); err != nil {
+		if err := pagingutils.PagingHelper(f); err != nil {
 			return false, err
 		}
 	}

cloud/scope/machine.go

@@ -40,12 +40,13 @@ import (
 	v1beta1patch "sigs.k8s.io/cluster-api/util/deprecated/v1beta1/patch" //nolint:staticcheck
 
 	infrav1 "sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1beta2"
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/accounts"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/authenticator"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/globaltagging"
-	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/utils"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/vpc"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/endpoints"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/options"
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/pagingutils"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/record"
 )
 
@@ -503,7 +504,7 @@ func (m *MachineScope) ensureInstanceUnique(instanceName string) (*vpcv1.Instanc
 		return true, "", nil
 	}
 
-	if err := utils.PagingHelper(f); err != nil {
+	if err := pagingutils.PagingHelper(f); err != nil {
 		return nil, err
 	}
 
@@ -950,7 +951,7 @@ func fetchKeyID(ctx context.Context, key *infrav1.IBMVPCResourceReference, m *Ma
 		return true, "", nil
 	}
 
-	if err := utils.PagingHelper(f); err != nil {
+	if err := pagingutils.PagingHelper(f); err != nil {
 		return nil, err
 	}
 
@@ -1008,7 +1009,7 @@ func fetchImageID(ctx context.Context, image *infrav1.IBMVPCResourceReference, m
 		return true, "", nil
 	}
 
-	if err := utils.PagingHelper(f); err != nil {
+	if err := pagingutils.PagingHelper(f); err != nil {
 		return nil, err
 	}
 
@@ -1094,7 +1095,7 @@ func (m *MachineScope) SetNotReady() {
 func (m *MachineScope) SetProviderID(id *string) error {
 	// Based on the ProviderIDFormat version the providerID format will be decided.
 	if options.ProviderIDFormatType(options.ProviderIDFormat) == options.ProviderIDFormatV2 {
-		accountID, err := utils.GetAccountIDWrapper()
+		accountID, err := accounts.GetAccountIDWrapper()
 		if err != nil {
 			return fmt.Errorf("failed to get cloud account id: %w", err)
 		}

cloud/scope/machine_test.go

@@ -35,7 +35,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 
 	infrav1 "sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1beta2"
-	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/utils"
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/accounts"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/vpc/mock"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/options"
 
@@ -140,7 +140,7 @@ func TestSetVPCProviderID(t *testing.T) {
 		g := NewWithT(t)
 		scope := setupMachineScope(clusterName, machineName, mock.NewMockVpc(gomock.NewController(t)))
 		options.ProviderIDFormat = string("v2")
-		utils.GetAccountIDFunc = func() (string, error) {
+		accounts.GetAccountIDFunc = func() (string, error) {
 			return "dummy-account-id", nil // Return dummy value
 		}
 		err := scope.SetProviderID(ptr.To(providerID))
@@ -151,7 +151,7 @@ func TestSetVPCProviderID(t *testing.T) {
 		g := NewWithT(t)
 		scope := setupMachineScope(clusterName, machineName, mock.NewMockVpc(gomock.NewController(t)))
 		options.ProviderIDFormat = string("v2")
-		utils.GetAccountIDFunc = func() (string, error) {
+		accounts.GetAccountIDFunc = func() (string, error) {
 			return "", errors.New("error getting accountID") // Return dummy error
 		}
 		err := scope.SetProviderID(ptr.To(providerID))

cloud/scope/powervs_cluster.go

@@ -49,16 +49,16 @@ import (
 	v1beta1patch "sigs.k8s.io/cluster-api/util/deprecated/v1beta1/patch" //nolint:staticcheck
 
 	infrav1 "sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1beta2"
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/internal/genutil"
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/accounts"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/authenticator"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/cos"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/powervs"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/resourcecontroller"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/resourcemanager"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/transitgateway"
-	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/utils"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/vpc"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/endpoints"
-	genUtil "sigs.k8s.io/cluster-api-provider-ibmcloud/util"
 )
 
 const (
@@ -1993,7 +1993,7 @@ func (s *PowerVSClusterScope) createTransitGateway(ctx context.Context) error {
 		return fmt.Errorf("failed to proeceed with transit gateway creation as either one of VPC or PowerVS service instance reconciliation is not successful")
 	}
 
-	location, globalRouting, err := genUtil.GetTransitGatewayLocationAndRouting(s.Zone(), s.VPC().Region)
+	location, globalRouting, err := genutil.GetTransitGatewayLocationAndRouting(s.Zone(), s.VPC().Region)
 	if err != nil {
 		return fmt.Errorf("failed to get transit gateway location and routing: %w", err)
 	}
@@ -2419,7 +2419,7 @@ func (s *PowerVSClusterScope) fetchResourceGroupID() (string, error) {
 		return "", err
 	}
 
-	account, err := utils.GetAccount(auth)
+	account, err := accounts.GetAccount(auth)
 	if err != nil {
 		return "", err
 	}

cloud/scope/powervs_cluster_test.go

@@ -39,7 +39,7 @@ import (
 	clusterv1 "sigs.k8s.io/cluster-api/api/core/v1beta2"
 
 	infrav1 "sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1beta2"
-	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/utils"
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/pointer"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/cos"
 	mockcos "sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/cos/mock"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/powervs"
@@ -240,7 +240,7 @@ func TestGetDHCPServerID(t *testing.T) {
 		g := NewWithT(t)
 		t.Run(tc.name, func(_ *testing.T) {
 			dhcpServerID := tc.clusterScope.GetDHCPServerID()
-			g.Expect(utils.DereferencePointer(dhcpServerID)).To(Equal(utils.DereferencePointer(tc.expectedID)))
+			g.Expect(pointer.Dereference(dhcpServerID)).To(Equal(pointer.Dereference(tc.expectedID)))
 		})
 	}
 }
@@ -276,7 +276,7 @@ func TestGetVPCID(t *testing.T) {
 		g := NewWithT(t)
 		t.Run(tc.name, func(_ *testing.T) {
 			vpcID := tc.clusterScope.GetVPCID()
-			g.Expect(utils.DereferencePointer(vpcID)).To(Equal(utils.DereferencePointer(tc.expectedID)))
+			g.Expect(pointer.Dereference(vpcID)).To(Equal(pointer.Dereference(tc.expectedID)))
 		})
 	}
 }
@@ -355,7 +355,7 @@ func TestGetVPCSubnetID(t *testing.T) {
 		g := NewWithT(t)
 		t.Run(tc.name, func(_ *testing.T) {
 			subnetID := tc.clusterScope.GetVPCSubnetID(tc.subnetName)
-			g.Expect(utils.DereferencePointer(subnetID)).To(Equal(utils.DereferencePointer(tc.expectedID)))
+			g.Expect(pointer.Dereference(subnetID)).To(Equal(pointer.Dereference(tc.expectedID)))
 		})
 	}
 }
@@ -475,7 +475,7 @@ func TestVPCSecurityGroupByName(t *testing.T) {
 		g := NewWithT(t)
 		t.Run(tc.name, func(_ *testing.T) {
 			sgID, _, _ := tc.clusterScope.GetVPCSecurityGroupByName(tc.sgName)
-			g.Expect(utils.DereferencePointer(sgID)).To(Equal(utils.DereferencePointer(tc.expectedID)))
+			g.Expect(pointer.Dereference(sgID)).To(Equal(pointer.Dereference(tc.expectedID)))
 		})
 	}
 }
@@ -554,7 +554,7 @@ func TestVPCSecurityGroupByID(t *testing.T) {
 		g := NewWithT(t)
 		t.Run(tc.name, func(_ *testing.T) {
 			sgID, _, _ := tc.clusterScope.GetVPCSecurityGroupByID(tc.sgID)
-			g.Expect(utils.DereferencePointer(sgID)).To(Equal(utils.DereferencePointer(tc.expectedID)))
+			g.Expect(pointer.Dereference(sgID)).To(Equal(pointer.Dereference(tc.expectedID)))
 		})
 	}
 }
@@ -601,7 +601,7 @@ func TestGetTransitGatewayID(t *testing.T) {
 		g := NewWithT(t)
 		t.Run(tc.name, func(_ *testing.T) {
 			tgID := tc.clusterScope.GetTransitGatewayID()
-			g.Expect(utils.DereferencePointer(tgID)).To(Equal(utils.DereferencePointer(tc.expectedID)))
+			g.Expect(pointer.Dereference(tgID)).To(Equal(pointer.Dereference(tc.expectedID)))
 		})
 	}
 }
@@ -680,7 +680,7 @@ func TestGetLoadBalancerID(t *testing.T) {
 		g := NewWithT(t)
 		t.Run(tc.name, func(_ *testing.T) {
 			lbID := tc.clusterScope.GetLoadBalancerID(tc.lbName)
-			g.Expect(utils.DereferencePointer(lbID)).To(Equal(utils.DereferencePointer(tc.expectedID)))
+			g.Expect(pointer.Dereference(lbID)).To(Equal(pointer.Dereference(tc.expectedID)))
 		})
 	}
 }

cmd/capibmadm/utils/utils.go → cmd/capibmadm/cliutils/utils.go

@@ -14,15 +14,13 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// Package utils contains utility and printer functions for cli.
-package utils
+// Package cliutils contains utility functions for cli.
+package cliutils
 
 import (
 	"context"
 	"fmt"
 
-	"github.com/go-openapi/strfmt"
-
 	"github.com/IBM/platform-services-go-sdk/resourcemanagerv2"
 
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/clients/platformservices"
@@ -55,37 +53,3 @@ func GetResourceGroupID(ctx context.Context, resourceGroup string, accountID str
 	err = fmt.Errorf("could not retrieve resource group id for %s", resourceGroup)
 	return "", err
 }
-
-// DereferencePointer dereferences pointer.
-func DereferencePointer(value interface{}) interface{} {
-	switch v := value.(type) {
-	case *string:
-		if v != nil {
-			return *v
-		}
-		return ""
-	case *int, *int8, *int16, *int32, *int64:
-		i := value.(*int64)
-		if i != nil {
-			return *i
-		}
-		return 0
-	case *strfmt.DateTime:
-		if v != nil {
-			return *v
-		}
-		return strfmt.DateTime{}
-	case *bool:
-		if v != nil {
-			return *v
-		}
-		return false
-	case *float32, *float64:
-		f := value.(*float64)
-		if f != nil {
-			return *f
-		}
-		return 0
-	}
-	return nil
-}

cmd/capibmadm/cmd/powervs/image/import.go

@@ -34,7 +34,7 @@ import (
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/clients/iam"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/clients/powervs"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/options"
-	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/utils"
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/accounts"
 )
 
 type imageImportOptions struct {
@@ -107,7 +107,7 @@ func importimage(ctx context.Context, imageImportOption imageImportOptions) erro
 	log := logf.Log
 	log.Info("Importing PowerVS images: ", "service-instance-id", options.GlobalOptions.ServiceInstanceID)
 
-	accountID, err := utils.GetAccount(iam.GetIAMAuth())
+	accountID, err := accounts.GetAccount(iam.GetIAMAuth())
 	if err != nil {
 		return err
 	}

cmd/capibmadm/cmd/powervs/image/list.go

@@ -31,9 +31,9 @@ import (
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/clients/iam"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/clients/powervs"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/options"
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/pointer"
 	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/printer"
-	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/utils"
-	pkgUtils "sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/utils"
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/accounts"
 )
 
 // ListCommand powervs image list command.
@@ -57,7 +57,7 @@ func listimage(ctx context.Context) error {
 	log := logf.Log
 	log.Info("Listing PowerVS images", "service-instance-id", options.GlobalOptions.ServiceInstanceID)
 
-	accountID, err := pkgUtils.GetAccount(iam.GetIAMAuth())
+	accountID, err := accounts.GetAccount(iam.GetIAMAuth())
 	if err != nil {
 		return err
 	}
@@ -83,14 +83,14 @@ func listimage(ctx context.Context) error {
 
 	for _, image := range images.Images {
 		imageToAppend := ImgSpec{
-			ImageID:        utils.DereferencePointer(image.ImageID).(string),
-			Name:           utils.DereferencePointer(image.Name).(string),
-			Description:    utils.DereferencePointer(image.Description).(string),
-			State:          utils.DereferencePointer(image.State).(string),
-			StoragePool:    utils.DereferencePointer(image.StoragePool).(string),
-			StorageType:    utils.DereferencePointer(image.StorageType).(string),
-			CreationDate:   utils.DereferencePointer(image.CreationDate).(strfmt.DateTime),
-			LastUpdateDate: utils.DereferencePointer(image.LastUpdateDate).(strfmt.DateTime),
+			ImageID:        pointer.Dereference(image.ImageID).(string),
+			Name:           pointer.Dereference(image.Name).(string),
+			Description:    pointer.Dereference(image.Description).(string),
+			State:          pointer.Dereference(image.State).(string),
+			StoragePool:    pointer.Dereference(image.StoragePool).(string),
+			StorageType:    pointer.Dereference(image.StorageType).(string),
+			CreationDate:   pointer.Dereference(image.CreationDate).(strfmt.DateTime),
+			LastUpdateDate: pointer.Dereference(image.LastUpdateDate).(strfmt.DateTime),
 		}
 		if image.Specifications != nil {
 			imageToAppend.Architecture = image.Specifications.Architecture