Skip to content

Commit 2194336

Browse files
authored
Add importas linting configuration to enforce common package import naming (#2715)
* Add importas linting configuration to enforce common package import naming Signed-off-by: timflannagan <[email protected]> * cmd,pkg,test: Fix linting violations Signed-off-by: timflannagan <[email protected]>
1 parent 51a2097 commit 2194336

40 files changed

+498
-479
lines changed

.golangci.yaml

+18
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,24 @@ linters:
2121
disable:
2222
- errcheck
2323

24+
linters-settings:
25+
importas:
26+
alias:
27+
- pkg: k8s.io/api/core/v1
28+
alias: corev1
29+
- pkg: k8s.io/api/apps/v1
30+
alias: appsv1
31+
- pkg: k8s.io/apimachinery/pkg/apis/meta/v1
32+
alias: metav1
33+
- pkg: k8s.io/apimachinery/pkg/api/errors
34+
alias: apierrors
35+
- pkg: github.com/operator-framework/api/pkg/operators/v1alpha1
36+
alias: operatorsv1alpha1
37+
- pkg: github.com/operator-framework/api/pkg/operators/v1
38+
alias: operatorsv1
39+
- pkg: github.com/operator-framework/api/pkg/operators/v2
40+
alias: operatorsv2
41+
2442
issues:
2543
max-issues-per-linter: 0
2644
max-same-issues: 0

cmd/olm/main.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
configv1client "github.com/openshift/client-go/config/clientset/versioned/typed/config/v1"
1414
"github.com/sirupsen/logrus"
1515
"github.com/spf13/pflag"
16-
v1 "k8s.io/api/core/v1"
16+
corev1 "k8s.io/api/core/v1"
1717
"k8s.io/klog"
1818
ctrl "sigs.k8s.io/controller-runtime"
1919

@@ -103,8 +103,8 @@ func main() {
103103
// the empty string, the resulting array will be `[]string{""}`.
104104
namespaces := strings.Split(*watchedNamespaces, ",")
105105
for _, ns := range namespaces {
106-
if ns == v1.NamespaceAll {
107-
namespaces = []string{v1.NamespaceAll}
106+
if ns == corev1.NamespaceAll {
107+
namespaces = []string{corev1.NamespaceAll}
108108
break
109109
}
110110
}

pkg/controller/install/apiservice.go

+16-16
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import (
66
"strings"
77

88
log "github.com/sirupsen/logrus"
9-
k8serrors "k8s.io/apimachinery/pkg/api/errors"
9+
apierrors "k8s.io/apimachinery/pkg/api/errors"
1010
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
1111
apiregistrationv1 "k8s.io/kube-aggregator/pkg/apis/apiregistration/v1"
1212

@@ -26,7 +26,7 @@ func (i *StrategyDeploymentInstaller) createOrUpdateAPIService(caPEM []byte, des
2626
exists := true
2727
apiService, err := i.strategyClient.GetOpLister().APIRegistrationV1().APIServiceLister().Get(apiServiceName)
2828
if err != nil {
29-
if !k8serrors.IsNotFound(err) {
29+
if !apierrors.IsNotFound(err) {
3030
return err
3131
}
3232

@@ -120,14 +120,14 @@ func IsAPIServiceAdoptable(opLister operatorlister.OperatorLister, target *v1alp
120120

121121
// Get the CSV that target replaces
122122
replacing, replaceGetErr := opLister.OperatorsV1alpha1().ClusterServiceVersionLister().ClusterServiceVersions(target.GetNamespace()).Get(target.Spec.Replaces)
123-
if replaceGetErr != nil && !k8serrors.IsNotFound(replaceGetErr) && !k8serrors.IsGone(replaceGetErr) {
123+
if replaceGetErr != nil && !apierrors.IsNotFound(replaceGetErr) && !apierrors.IsGone(replaceGetErr) {
124124
err = replaceGetErr
125125
return
126126
}
127127

128128
// Get the current owner CSV of the APIService
129129
currentOwnerCSV, ownerGetErr := opLister.OperatorsV1alpha1().ClusterServiceVersionLister().ClusterServiceVersions(ownerNamespace).Get(ownerName)
130-
if ownerGetErr != nil && !k8serrors.IsNotFound(ownerGetErr) && !k8serrors.IsGone(ownerGetErr) {
130+
if ownerGetErr != nil && !apierrors.IsNotFound(ownerGetErr) && !apierrors.IsGone(ownerGetErr) {
131131
err = ownerGetErr
132132
return
133133
}
@@ -179,13 +179,13 @@ func (i *StrategyDeploymentInstaller) deleteLegacyAPIServiceResources(desc apiSe
179179
// Attempt to delete the legacy Service.
180180
existingService, err := i.strategyClient.GetOpClient().GetService(namespace, legacyServiceName)
181181
if err != nil {
182-
if !k8serrors.IsNotFound(err) {
182+
if !apierrors.IsNotFound(err) {
183183
return err
184184
}
185185
} else if ownerutil.AdoptableLabels(existingService.GetLabels(), true, i.owner) {
186186
logger.Infof("Deleting Service with legacy APIService name %s", existingService.Name)
187187
err = i.strategyClient.GetOpClient().DeleteService(namespace, legacyServiceName, &metav1.DeleteOptions{})
188-
if err != nil && !k8serrors.IsNotFound(err) {
188+
if err != nil && !apierrors.IsNotFound(err) {
189189
return err
190190
}
191191
} else {
@@ -198,13 +198,13 @@ func (i *StrategyDeploymentInstaller) deleteLegacyAPIServiceResources(desc apiSe
198198
// Attempt to delete the legacy Secret.
199199
existingSecret, err := i.strategyClient.GetOpClient().GetSecret(namespace, SecretName(apiServiceName))
200200
if err != nil {
201-
if !k8serrors.IsNotFound(err) {
201+
if !apierrors.IsNotFound(err) {
202202
return err
203203
}
204204
} else if ownerutil.AdoptableLabels(existingSecret.GetLabels(), true, i.owner) {
205205
logger.Infof("Deleting Secret with legacy APIService name %s", existingSecret.Name)
206206
err = i.strategyClient.GetOpClient().DeleteSecret(namespace, SecretName(apiServiceName), &metav1.DeleteOptions{})
207-
if err != nil && !k8serrors.IsNotFound(err) {
207+
if err != nil && !apierrors.IsNotFound(err) {
208208
return err
209209
}
210210
} else {
@@ -214,13 +214,13 @@ func (i *StrategyDeploymentInstaller) deleteLegacyAPIServiceResources(desc apiSe
214214
// Attempt to delete the legacy Role.
215215
existingRole, err := i.strategyClient.GetOpClient().GetRole(namespace, SecretName(apiServiceName))
216216
if err != nil {
217-
if !k8serrors.IsNotFound(err) {
217+
if !apierrors.IsNotFound(err) {
218218
return err
219219
}
220220
} else if ownerutil.AdoptableLabels(existingRole.GetLabels(), true, i.owner) {
221221
logger.Infof("Deleting Role with legacy APIService name %s", existingRole.Name)
222222
err = i.strategyClient.GetOpClient().DeleteRole(namespace, SecretName(apiServiceName), &metav1.DeleteOptions{})
223-
if err != nil && !k8serrors.IsNotFound(err) {
223+
if err != nil && !apierrors.IsNotFound(err) {
224224
return err
225225
}
226226
} else {
@@ -230,13 +230,13 @@ func (i *StrategyDeploymentInstaller) deleteLegacyAPIServiceResources(desc apiSe
230230
// Attempt to delete the legacy secret RoleBinding.
231231
existingRoleBinding, err := i.strategyClient.GetOpClient().GetRoleBinding(namespace, SecretName(apiServiceName))
232232
if err != nil {
233-
if !k8serrors.IsNotFound(err) {
233+
if !apierrors.IsNotFound(err) {
234234
return err
235235
}
236236
} else if ownerutil.AdoptableLabels(existingRoleBinding.GetLabels(), true, i.owner) {
237237
logger.Infof("Deleting RoleBinding with legacy APIService name %s", existingRoleBinding.Name)
238238
err = i.strategyClient.GetOpClient().DeleteRoleBinding(namespace, SecretName(apiServiceName), &metav1.DeleteOptions{})
239-
if err != nil && !k8serrors.IsNotFound(err) {
239+
if err != nil && !apierrors.IsNotFound(err) {
240240
return err
241241
}
242242
} else {
@@ -246,13 +246,13 @@ func (i *StrategyDeploymentInstaller) deleteLegacyAPIServiceResources(desc apiSe
246246
// Attempt to delete the legacy ClusterRoleBinding.
247247
existingClusterRoleBinding, err := i.strategyClient.GetOpClient().GetClusterRoleBinding(apiServiceName + "-system:auth-delegator")
248248
if err != nil {
249-
if !k8serrors.IsNotFound(err) {
249+
if !apierrors.IsNotFound(err) {
250250
return err
251251
}
252252
} else if ownerutil.AdoptableLabels(existingClusterRoleBinding.GetLabels(), true, i.owner) {
253253
logger.Infof("Deleting ClusterRoleBinding with legacy APIService name %s", existingClusterRoleBinding.Name)
254254
err = i.strategyClient.GetOpClient().DeleteClusterRoleBinding(apiServiceName+"-system:auth-delegator", &metav1.DeleteOptions{})
255-
if err != nil && !k8serrors.IsNotFound(err) {
255+
if err != nil && !apierrors.IsNotFound(err) {
256256
return err
257257
}
258258
} else {
@@ -262,13 +262,13 @@ func (i *StrategyDeploymentInstaller) deleteLegacyAPIServiceResources(desc apiSe
262262
// Attempt to delete the legacy AuthReadingRoleBinding.
263263
existingRoleBinding, err = i.strategyClient.GetOpClient().GetRoleBinding(KubeSystem, apiServiceName+"-auth-reader")
264264
if err != nil {
265-
if !k8serrors.IsNotFound(err) {
265+
if !apierrors.IsNotFound(err) {
266266
return err
267267
}
268268
} else if ownerutil.AdoptableLabels(existingRoleBinding.GetLabels(), true, i.owner) {
269269
logger.Infof("Deleting RoleBinding with legacy APIService name %s", existingRoleBinding.Name)
270270
err = i.strategyClient.GetOpClient().DeleteRoleBinding(KubeSystem, apiServiceName+"-auth-reader", &metav1.DeleteOptions{})
271-
if err != nil && !k8serrors.IsNotFound(err) {
271+
if err != nil && !apierrors.IsNotFound(err) {
272272
return err
273273
}
274274
} else {

pkg/controller/install/certresources.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import (
99
appsv1 "k8s.io/api/apps/v1"
1010
corev1 "k8s.io/api/core/v1"
1111
rbacv1 "k8s.io/api/rbac/v1"
12-
k8serrors "k8s.io/apimachinery/pkg/api/errors"
12+
apierrors "k8s.io/apimachinery/pkg/api/errors"
1313
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
1414
"k8s.io/apimachinery/pkg/util/intstr"
1515

@@ -246,7 +246,7 @@ func (i *StrategyDeploymentInstaller) installCertRequirementsForDeployment(deplo
246246

247247
// Delete the Service to replace
248248
deleteErr := i.strategyClient.GetOpClient().DeleteService(service.GetNamespace(), service.GetName(), &metav1.DeleteOptions{})
249-
if deleteErr != nil && !k8serrors.IsNotFound(deleteErr) {
249+
if deleteErr != nil && !apierrors.IsNotFound(deleteErr) {
250250
return nil, nil, fmt.Errorf("could not delete existing service %s", service.GetName())
251251
}
252252
}
@@ -315,11 +315,11 @@ func (i *StrategyDeploymentInstaller) installCertRequirementsForDeployment(deplo
315315
logger.Warnf("could not update secret %s", secret.GetName())
316316
return nil, nil, err
317317
}
318-
} else if k8serrors.IsNotFound(err) {
318+
} else if apierrors.IsNotFound(err) {
319319
// Create the secret
320320
ownerutil.AddNonBlockingOwner(secret, i.owner)
321321
if _, err := i.strategyClient.GetOpClient().CreateSecret(secret); err != nil {
322-
if !k8serrors.IsAlreadyExists(err) {
322+
if !apierrors.IsAlreadyExists(err) {
323323
log.Warnf("could not create secret %s: %v", secret.GetName(), err)
324324
return nil, nil, err
325325
}
@@ -360,7 +360,7 @@ func (i *StrategyDeploymentInstaller) installCertRequirementsForDeployment(deplo
360360
logger.Warnf("could not update secret role %s", secretRole.GetName())
361361
return nil, nil, err
362362
}
363-
} else if k8serrors.IsNotFound(err) {
363+
} else if apierrors.IsNotFound(err) {
364364
// Create the role
365365
ownerutil.AddNonBlockingOwner(secretRole, i.owner)
366366
_, err = i.strategyClient.GetOpClient().CreateRole(secretRole)
@@ -406,7 +406,7 @@ func (i *StrategyDeploymentInstaller) installCertRequirementsForDeployment(deplo
406406
logger.Warnf("could not update secret rolebinding %s", secretRoleBinding.GetName())
407407
return nil, nil, err
408408
}
409-
} else if k8serrors.IsNotFound(err) {
409+
} else if apierrors.IsNotFound(err) {
410410
// Create the role
411411
ownerutil.AddNonBlockingOwner(secretRoleBinding, i.owner)
412412
_, err = i.strategyClient.GetOpClient().CreateRoleBinding(secretRoleBinding)
@@ -451,7 +451,7 @@ func (i *StrategyDeploymentInstaller) installCertRequirementsForDeployment(deplo
451451
logger.Warnf("could not update auth delegator clusterrolebinding %s", authDelegatorClusterRoleBinding.GetName())
452452
return nil, nil, err
453453
}
454-
} else if k8serrors.IsNotFound(err) {
454+
} else if apierrors.IsNotFound(err) {
455455
// Create the role.
456456
if err := ownerutil.AddOwnerLabels(authDelegatorClusterRoleBinding, i.owner); err != nil {
457457
return nil, nil, err
@@ -498,7 +498,7 @@ func (i *StrategyDeploymentInstaller) installCertRequirementsForDeployment(deplo
498498
logger.Warnf("could not update auth reader role binding %s", authReaderRoleBinding.GetName())
499499
return nil, nil, err
500500
}
501-
} else if k8serrors.IsNotFound(err) {
501+
} else if apierrors.IsNotFound(err) {
502502
// Create the role.
503503
if err := ownerutil.AddOwnerLabels(authReaderRoleBinding, i.owner); err != nil {
504504
return nil, nil, err

pkg/controller/install/deployment.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import (
77
log "github.com/sirupsen/logrus"
88
appsv1 "k8s.io/api/apps/v1"
99
corev1 "k8s.io/api/core/v1"
10-
k8serrors "k8s.io/apimachinery/pkg/api/errors"
10+
apierrors "k8s.io/apimachinery/pkg/api/errors"
1111
k8slabels "k8s.io/apimachinery/pkg/labels"
1212
"k8s.io/apimachinery/pkg/util/rand"
1313
"k8s.io/utils/pointer"
@@ -192,7 +192,7 @@ func (i *StrategyDeploymentInstaller) Install(s Strategy) error {
192192
}
193193

194194
if err := i.installDeployments(updatedStrategy.DeploymentSpecs); err != nil {
195-
if k8serrors.IsForbidden(err) {
195+
if apierrors.IsForbidden(err) {
196196
return StrategyError{Reason: StrategyErrInsufficientPermissions, Message: fmt.Sprintf("install strategy failed: %s", err)}
197197
}
198198
return err

pkg/controller/install/rule_checker_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ import (
1818
"k8s.io/client-go/tools/cache"
1919
apiregistrationfake "k8s.io/kube-aggregator/pkg/client/clientset_generated/clientset/fake"
2020

21-
v1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
21+
operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
2222
"github.com/operator-framework/operator-lifecycle-manager/pkg/lib/operatorclient"
2323
)
2424

2525
func TestRuleSatisfied(t *testing.T) {
26-
csv := &v1alpha1.ClusterServiceVersion{}
26+
csv := &operatorsv1alpha1.ClusterServiceVersion{}
2727
csv.SetName("barista-operator")
2828
csv.SetUID(types.UID("barista-operator"))
2929

@@ -572,7 +572,7 @@ func TestRuleSatisfied(t *testing.T) {
572572
}
573573
}
574574

575-
func NewFakeCSVRuleChecker(k8sObjs []runtime.Object, csv *v1alpha1.ClusterServiceVersion, namespace string, stopCh <-chan struct{}) (*CSVRuleChecker, error) {
575+
func NewFakeCSVRuleChecker(k8sObjs []runtime.Object, csv *operatorsv1alpha1.ClusterServiceVersion, namespace string, stopCh <-chan struct{}) (*CSVRuleChecker, error) {
576576
// create client fakes
577577
opClientFake := operatorclient.NewClient(k8sfake.NewSimpleClientset(k8sObjs...), apiextensionsfake.NewSimpleClientset(), apiregistrationfake.NewSimpleClientset())
578578

0 commit comments

Comments
 (0)