Standardize more package import aliases

[mboersma]

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

Standardizes several popular import aliases by adding them to the importas linter configuration. This is an area of code where creativity is ultimately unhelpful. The CAPI sections were copied from CAPI's golangci config.

Which issue(s) this PR fixes:

Refs #2289

Special notes for your reviewer:

TODOs:

• squashed commits
• includes documentation
• adds unit tests

Release note:

NONE

[mboersma]

This was a misleading alias.

[invidian]

Thanks for the PR @mboersma! I left some thoughts in the comments.

[invidian]

Maybe it should be expclusterv1alpha3 to be consistent with the above?

[mboersma]

The CAPI rules for importas were copied from CAPI's golangci-lint configuration. I think we should just use them as-is to make it easier to move between codebases. I notice that's what CAPA did as well.

[invidian]

Well, some say you should always question things and there is always room for the improvement... 😄 But perhaps less optimal consistency is better than better inconsistency, so I guess that's OK. Thanks for explaining! Feel free to mark as resolved.

[invidian]

It's expv1alpha4 with exp prefix, but infrav1alpha4exp with exp suffix, maybe we can make it more consistent?

[mboersma]

Yes, we could--I chose the infrav1exp pattern for CAPZ imports because it was already the most-used, so that minimized the churn in the codebase. But infraexpv1 and infraexpv1alpha4 are arguably more consistent with CAPI's imports.

[invidian]

I wonder, if source file imports only single package named v1alpha3, will the linter still require an alias?

[mboersma]

It will, because we have no-unaliased: true set in .golangci.yml.

[invidian]

All good if that's deliberate. I think I like it this way, similar to , ending the last entry in the lists. It won't make you change unrelated stuff when you add new import. Feel free to mark as resolved.

[mboersma]

@invidian I noticed that this only really fixes half of the problem, since there are still randomly-named imports of these packages in conversion.go and related files. We completely ignore those files in linting, but that's overkill as far as I can tell; I have a PR ready to follow this one that enables linting and standardizes those imports as well.

When we're all happy with the naming here, I'll update that branch and put a followup PR out.

[jackfrancis]

/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jackfrancis

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [jackfrancis]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[k8s-ci-robot]

@mboersma: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-cluster-api-provider-azure-e2e	9428cc0	link	unknown	/test pull-cluster-api-provider-azure-e2e

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

[jackfrancis]

/cherry-pick release-1.4

[k8s-infra-cherrypick-robot]

@jackfrancis: #2529 failed to apply on top of branch "release-1.4":

Applying: Standardize more package import aliases
Using index info to reconstruct a base tree...
M	.golangci.yml
M	azure/scope/machinepool.go
M	azure/scope/machinepoolmachine.go
M	azure/scope/machinepoolmachine_test.go
Falling back to patching base and 3-way merge...
Auto-merging azure/scope/machinepoolmachine_test.go
CONFLICT (content): Merge conflict in azure/scope/machinepoolmachine_test.go
Auto-merging azure/scope/machinepoolmachine.go
Auto-merging azure/scope/machinepool.go
Auto-merging .golangci.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Standardize more package import aliases
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick release-1.4

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.