Skip to content

Commit d843fa5

Browse files
mayuka-cmayuka-c
authored
Fix revive package name conventions (kubernetes-sigs#2464)
Dockerfile Address comments Comment Dockerfile Comment
1 parent b8b1a62 commit d843fa5

File tree

38 files changed

+229
-175
lines changed

38 files changed

+229
-175
lines changed

‎.golangci.yml‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,6 @@ linters:
121121
- linters:
122122
- revive
123123
text: 'exported: exported method .*\.(Reconcile|SetupWithManager|SetupWebhookWithManager) should have comment or be unexported'
124-
# To be fixed: This is done to unblock the bumping of golint.
125-
- linters:
126-
- revive
127-
text: 'var-naming: avoid meaningless package names'
128124
- linters:
129125
- errcheck
130126
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‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ COPY api/ api/
3939
COPY controllers/ controllers/
4040
COPY cloud/ cloud/
4141
COPY pkg/ pkg/
42-
COPY util/ util/
4342
COPY internal/ internal/
4443

4544
# Build

‎cloud/scope/cluster.go‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ import (
3535
v1beta1patch "sigs.k8s.io/cluster-api/util/deprecated/v1beta1/patch" //nolint:staticcheck
3636

3737
infrav1 "sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1beta2"
38-
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/utils"
3938
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/vpc"
4039
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/endpoints"
40+
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/pagingutils"
4141
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/record"
4242
)
4343

@@ -181,7 +181,7 @@ func (s *ClusterScope) ensureVPCUnique(vpcName string) (*vpcv1.VPC, error) {
181181
return true, "", nil
182182
}
183183

184-
if err := utils.PagingHelper(f); err != nil {
184+
if err := pagingutils.PagingHelper(f); err != nil {
185185
return nil, err
186186
}
187187

@@ -286,7 +286,7 @@ func (s *ClusterScope) getSubnetAddrPrefix(vpcID, zone string) (string, error) {
286286
return true, "", nil
287287
}
288288

289-
if err := utils.PagingHelper(f); err != nil {
289+
if err := pagingutils.PagingHelper(f); err != nil {
290290
return "", err
291291
}
292292

@@ -327,7 +327,7 @@ func (s *ClusterScope) ensureSubnetUnique(subnetName string) (*vpcv1.Subnet, err
327327
return true, "", nil
328328
}
329329

330-
if err := utils.PagingHelper(f); err != nil {
330+
if err := pagingutils.PagingHelper(f); err != nil {
331331
return nil, err
332332
}
333333

@@ -374,7 +374,7 @@ func (s *ClusterScope) DeleteSubnet(ctx context.Context) error {
374374
return true, "", nil
375375
}
376376

377-
if err := utils.PagingHelper(f); err != nil {
377+
if err := pagingutils.PagingHelper(f); err != nil {
378378
return err
379379
}
380380

@@ -556,7 +556,7 @@ func (s *ClusterScope) getLoadBalancerByHostname(loadBalancerHostname string) (*
556556
return true, "", nil
557557
}
558558

559-
if err := utils.PagingHelper(f); err != nil {
559+
if err := pagingutils.PagingHelper(f); err != nil {
560560
return nil, err
561561
}
562562

@@ -594,7 +594,7 @@ func (s *ClusterScope) ensureLoadBalancerUnique(loadBalancerName string) (*vpcv1
594594
return true, "", nil
595595
}
596596

597-
if err := utils.PagingHelper(f); err != nil {
597+
if err := pagingutils.PagingHelper(f); err != nil {
598598
return nil, err
599599
}
600600

@@ -642,7 +642,7 @@ func (s *ClusterScope) DeleteLoadBalancer() (bool, error) {
642642
return true, "", nil
643643
}
644644

645-
if err := utils.PagingHelper(f); err != nil {
645+
if err := pagingutils.PagingHelper(f); err != nil {
646646
return false, err
647647
}
648648
}

‎cloud/scope/machine.go‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,13 @@ import (
4040
v1beta1patch "sigs.k8s.io/cluster-api/util/deprecated/v1beta1/patch" //nolint:staticcheck
4141

4242
infrav1 "sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1beta2"
43+
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/accounts"
4344
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/authenticator"
4445
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/globaltagging"
45-
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/utils"
4646
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/vpc"
4747
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/endpoints"
4848
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/options"
49+
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/pagingutils"
4950
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/record"
5051
)
5152

@@ -503,7 +504,7 @@ func (m *MachineScope) ensureInstanceUnique(instanceName string) (*vpcv1.Instanc
503504
return true, "", nil
504505
}
505506

506-
if err := utils.PagingHelper(f); err != nil {
507+
if err := pagingutils.PagingHelper(f); err != nil {
507508
return nil, err
508509
}
509510

@@ -950,7 +951,7 @@ func fetchKeyID(ctx context.Context, key *infrav1.IBMVPCResourceReference, m *Ma
950951
return true, "", nil
951952
}
952953

953-
if err := utils.PagingHelper(f); err != nil {
954+
if err := pagingutils.PagingHelper(f); err != nil {
954955
return nil, err
955956
}
956957

@@ -1008,7 +1009,7 @@ func fetchImageID(ctx context.Context, image *infrav1.IBMVPCResourceReference, m
10081009
return true, "", nil
10091010
}
10101011

1011-
if err := utils.PagingHelper(f); err != nil {
1012+
if err := pagingutils.PagingHelper(f); err != nil {
10121013
return nil, err
10131014
}
10141015

@@ -1094,7 +1095,7 @@ func (m *MachineScope) SetNotReady() {
10941095
func (m *MachineScope) SetProviderID(id *string) error {
10951096
// Based on the ProviderIDFormat version the providerID format will be decided.
10961097
if options.ProviderIDFormatType(options.ProviderIDFormat) == options.ProviderIDFormatV2 {
1097-
accountID, err := utils.GetAccountIDWrapper()
1098+
accountID, err := accounts.GetAccountIDWrapper()
10981099
if err != nil {
10991100
return fmt.Errorf("failed to get cloud account id: %w", err)
11001101
}

‎cloud/scope/machine_test.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ import (
3535
"sigs.k8s.io/controller-runtime/pkg/client/fake"
3636

3737
infrav1 "sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1beta2"
38-
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/utils"
38+
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/accounts"
3939
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/vpc/mock"
4040
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/options"
4141

@@ -140,7 +140,7 @@ func TestSetVPCProviderID(t *testing.T) {
140140
g := NewWithT(t)
141141
scope := setupMachineScope(clusterName, machineName, mock.NewMockVpc(gomock.NewController(t)))
142142
options.ProviderIDFormat = string("v2")
143-
utils.GetAccountIDFunc = func() (string, error) {
143+
accounts.GetAccountIDFunc = func() (string, error) {
144144
return "dummy-account-id", nil // Return dummy value
145145
}
146146
err := scope.SetProviderID(ptr.To(providerID))
@@ -151,7 +151,7 @@ func TestSetVPCProviderID(t *testing.T) {
151151
g := NewWithT(t)
152152
scope := setupMachineScope(clusterName, machineName, mock.NewMockVpc(gomock.NewController(t)))
153153
options.ProviderIDFormat = string("v2")
154-
utils.GetAccountIDFunc = func() (string, error) {
154+
accounts.GetAccountIDFunc = func() (string, error) {
155155
return "", errors.New("error getting accountID") // Return dummy error
156156
}
157157
err := scope.SetProviderID(ptr.To(providerID))

‎cloud/scope/powervs_cluster.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,16 @@ import (
4949
v1beta1patch "sigs.k8s.io/cluster-api/util/deprecated/v1beta1/patch" //nolint:staticcheck
5050

5151
infrav1 "sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1beta2"
52+
"sigs.k8s.io/cluster-api-provider-ibmcloud/internal/genutil"
53+
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/accounts"
5254
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/authenticator"
5355
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/cos"
5456
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/powervs"
5557
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/resourcecontroller"
5658
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/resourcemanager"
5759
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/transitgateway"
58-
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/utils"
5960
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/vpc"
6061
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/endpoints"
61-
genUtil "sigs.k8s.io/cluster-api-provider-ibmcloud/util"
6262
)
6363

6464
const (
@@ -1993,7 +1993,7 @@ func (s *PowerVSClusterScope) createTransitGateway(ctx context.Context) error {
19931993
return fmt.Errorf("failed to proeceed with transit gateway creation as either one of VPC or PowerVS service instance reconciliation is not successful")
19941994
}
19951995

1996-
location, globalRouting, err := genUtil.GetTransitGatewayLocationAndRouting(s.Zone(), s.VPC().Region)
1996+
location, globalRouting, err := genutil.GetTransitGatewayLocationAndRouting(s.Zone(), s.VPC().Region)
19971997
if err != nil {
19981998
return fmt.Errorf("failed to get transit gateway location and routing: %w", err)
19991999
}
@@ -2419,7 +2419,7 @@ func (s *PowerVSClusterScope) fetchResourceGroupID() (string, error) {
24192419
return "", err
24202420
}
24212421

2422-
account, err := utils.GetAccount(auth)
2422+
account, err := accounts.GetAccount(auth)
24232423
if err != nil {
24242424
return "", err
24252425
}

‎cloud/scope/powervs_cluster_test.go‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ import (
3939
clusterv1 "sigs.k8s.io/cluster-api/api/core/v1beta2"
4040

4141
infrav1 "sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1beta2"
42-
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/utils"
42+
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/pointer"
4343
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/cos"
4444
mockcos "sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/cos/mock"
4545
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/powervs"
@@ -240,7 +240,7 @@ func TestGetDHCPServerID(t *testing.T) {
240240
g := NewWithT(t)
241241
t.Run(tc.name, func(_ *testing.T) {
242242
dhcpServerID := tc.clusterScope.GetDHCPServerID()
243-
g.Expect(utils.DereferencePointer(dhcpServerID)).To(Equal(utils.DereferencePointer(tc.expectedID)))
243+
g.Expect(pointer.Dereference(dhcpServerID)).To(Equal(pointer.Dereference(tc.expectedID)))
244244
})
245245
}
246246
}
@@ -276,7 +276,7 @@ func TestGetVPCID(t *testing.T) {
276276
g := NewWithT(t)
277277
t.Run(tc.name, func(_ *testing.T) {
278278
vpcID := tc.clusterScope.GetVPCID()
279-
g.Expect(utils.DereferencePointer(vpcID)).To(Equal(utils.DereferencePointer(tc.expectedID)))
279+
g.Expect(pointer.Dereference(vpcID)).To(Equal(pointer.Dereference(tc.expectedID)))
280280
})
281281
}
282282
}
@@ -355,7 +355,7 @@ func TestGetVPCSubnetID(t *testing.T) {
355355
g := NewWithT(t)
356356
t.Run(tc.name, func(_ *testing.T) {
357357
subnetID := tc.clusterScope.GetVPCSubnetID(tc.subnetName)
358-
g.Expect(utils.DereferencePointer(subnetID)).To(Equal(utils.DereferencePointer(tc.expectedID)))
358+
g.Expect(pointer.Dereference(subnetID)).To(Equal(pointer.Dereference(tc.expectedID)))
359359
})
360360
}
361361
}
@@ -475,7 +475,7 @@ func TestVPCSecurityGroupByName(t *testing.T) {
475475
g := NewWithT(t)
476476
t.Run(tc.name, func(_ *testing.T) {
477477
sgID, _, _ := tc.clusterScope.GetVPCSecurityGroupByName(tc.sgName)
478-
g.Expect(utils.DereferencePointer(sgID)).To(Equal(utils.DereferencePointer(tc.expectedID)))
478+
g.Expect(pointer.Dereference(sgID)).To(Equal(pointer.Dereference(tc.expectedID)))
479479
})
480480
}
481481
}
@@ -554,7 +554,7 @@ func TestVPCSecurityGroupByID(t *testing.T) {
554554
g := NewWithT(t)
555555
t.Run(tc.name, func(_ *testing.T) {
556556
sgID, _, _ := tc.clusterScope.GetVPCSecurityGroupByID(tc.sgID)
557-
g.Expect(utils.DereferencePointer(sgID)).To(Equal(utils.DereferencePointer(tc.expectedID)))
557+
g.Expect(pointer.Dereference(sgID)).To(Equal(pointer.Dereference(tc.expectedID)))
558558
})
559559
}
560560
}
@@ -601,7 +601,7 @@ func TestGetTransitGatewayID(t *testing.T) {
601601
g := NewWithT(t)
602602
t.Run(tc.name, func(_ *testing.T) {
603603
tgID := tc.clusterScope.GetTransitGatewayID()
604-
g.Expect(utils.DereferencePointer(tgID)).To(Equal(utils.DereferencePointer(tc.expectedID)))
604+
g.Expect(pointer.Dereference(tgID)).To(Equal(pointer.Dereference(tc.expectedID)))
605605
})
606606
}
607607
}
@@ -680,7 +680,7 @@ func TestGetLoadBalancerID(t *testing.T) {
680680
g := NewWithT(t)
681681
t.Run(tc.name, func(_ *testing.T) {
682682
lbID := tc.clusterScope.GetLoadBalancerID(tc.lbName)
683-
g.Expect(utils.DereferencePointer(lbID)).To(Equal(utils.DereferencePointer(tc.expectedID)))
683+
g.Expect(pointer.Dereference(lbID)).To(Equal(pointer.Dereference(tc.expectedID)))
684684
})
685685
}
686686
}

‎cmd/capibmadm/utils/utils.go‎ renamed to ‎cmd/capibmadm/cliutils/utils.go‎

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,13 @@ See the License for the specific language governing permissions and
1414
limitations under the License.
1515
*/
1616

17-
// Package utils contains utility and printer functions for cli.
18-
package utils
17+
// Package cliutils contains utility functions for cli.
18+
package cliutils
1919

2020
import (
2121
"context"
2222
"fmt"
2323

24-
"github.com/go-openapi/strfmt"
25-
2624
"github.com/IBM/platform-services-go-sdk/resourcemanagerv2"
2725

2826
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/clients/platformservices"
@@ -55,37 +53,3 @@ func GetResourceGroupID(ctx context.Context, resourceGroup string, accountID str
5553
err = fmt.Errorf("could not retrieve resource group id for %s", resourceGroup)
5654
return "", err
5755
}
58-
59-
// DereferencePointer dereferences pointer.
60-
func DereferencePointer(value interface{}) interface{} {
61-
switch v := value.(type) {
62-
case *string:
63-
if v != nil {
64-
return *v
65-
}
66-
return ""
67-
case *int, *int8, *int16, *int32, *int64:
68-
i := value.(*int64)
69-
if i != nil {
70-
return *i
71-
}
72-
return 0
73-
case *strfmt.DateTime:
74-
if v != nil {
75-
return *v
76-
}
77-
return strfmt.DateTime{}
78-
case *bool:
79-
if v != nil {
80-
return *v
81-
}
82-
return false
83-
case *float32, *float64:
84-
f := value.(*float64)
85-
if f != nil {
86-
return *f
87-
}
88-
return 0
89-
}
90-
return nil
91-
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import (
3434
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/clients/iam"
3535
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/clients/powervs"
3636
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/options"
37-
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/utils"
37+
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/accounts"
3838
)
3939

4040
type imageImportOptions struct {
@@ -107,7 +107,7 @@ func importimage(ctx context.Context, imageImportOption imageImportOptions) erro
107107
log := logf.Log
108108
log.Info("Importing PowerVS images: ", "service-instance-id", options.GlobalOptions.ServiceInstanceID)
109109

110-
accountID, err := utils.GetAccount(iam.GetIAMAuth())
110+
accountID, err := accounts.GetAccount(iam.GetIAMAuth())
111111
if err != nil {
112112
return err
113113
}

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ import (
3131
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/clients/iam"
3232
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/clients/powervs"
3333
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/options"
34+
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/pointer"
3435
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/printer"
35-
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/utils"
36-
pkgUtils "sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/utils"
36+
"sigs.k8s.io/cluster-api-provider-ibmcloud/pkg/cloud/services/accounts"
3737
)
3838

3939
// ListCommand powervs image list command.
@@ -57,7 +57,7 @@ func listimage(ctx context.Context) error {
5757
log := logf.Log
5858
log.Info("Listing PowerVS images", "service-instance-id", options.GlobalOptions.ServiceInstanceID)
5959

60-
accountID, err := pkgUtils.GetAccount(iam.GetIAMAuth())
60+
accountID, err := accounts.GetAccount(iam.GetIAMAuth())
6161
if err != nil {
6262
return err
6363
}
@@ -83,14 +83,14 @@ func listimage(ctx context.Context) error {
8383

8484
for _, image := range images.Images {
8585
imageToAppend := ImgSpec{
86-
ImageID: utils.DereferencePointer(image.ImageID).(string),
87-
Name: utils.DereferencePointer(image.Name).(string),
88-
Description: utils.DereferencePointer(image.Description).(string),
89-
State: utils.DereferencePointer(image.State).(string),
90-
StoragePool: utils.DereferencePointer(image.StoragePool).(string),
91-
StorageType: utils.DereferencePointer(image.StorageType).(string),
92-
CreationDate: utils.DereferencePointer(image.CreationDate).(strfmt.DateTime),
93-
LastUpdateDate: utils.DereferencePointer(image.LastUpdateDate).(strfmt.DateTime),
86+
ImageID: pointer.Dereference(image.ImageID).(string),
87+
Name: pointer.Dereference(image.Name).(string),
88+
Description: pointer.Dereference(image.Description).(string),
89+
State: pointer.Dereference(image.State).(string),
90+
StoragePool: pointer.Dereference(image.StoragePool).(string),
91+
StorageType: pointer.Dereference(image.StorageType).(string),
92+
CreationDate: pointer.Dereference(image.CreationDate).(strfmt.DateTime),
93+
LastUpdateDate: pointer.Dereference(image.LastUpdateDate).(strfmt.DateTime),
9494
}
9595
if image.Specifications != nil {
9696
imageToAppend.Architecture = image.Specifications.Architecture

0 commit comments

Comments
 (0)