🌱 Standardize api import aliases by sbueringer · Pull Request #5830 · kubernetes-sigs/cluster-api

sbueringer · 2021-12-09T09:14:19Z

What this PR does / why we need it:
This PR standardizes our import aliases (follow-up to: #5788 (comment))

Upsides of standardizing aliases:

Consistent importing, i.e. whenever you see an import alias somewhere in the code you can be sure your using the right package / version of the package
- So no more cases of the v1alpha4 package being aliased as v1beta1 and vice versa.
it makes especially the conversion files way more readable if every package just has one alias we're always using
no more nits on PRs for import aliases of one of the enforced packages
it should help as an additional validation layer when we're introducing the next api version as we can just adjust the expected aliases in golangci.yaml and the linter will catch a bunch of mistakes for us.

Not sure how it works in other IDEs, but in Intellij you can just write bootstrapv1.<struct-name> and it will automatically import the correct package because it tracks all known aliases. This works better if there is a clear alias=>package mapping.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

k8s-ci-robot · 2021-12-09T09:15:49Z

@sbueringer: 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-e2e-ipv6-main	`83d5a61`	link	false	`/test pull-cluster-api-e2e-ipv6-main`

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.

Details

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.

fabriziopandini · 2021-12-09T13:10:39Z

nice one!

sbueringer · 2021-12-09T13:37:49Z

/reopen

k8s-ci-robot · 2021-12-09T13:37:59Z

@sbueringer: Failed to re-open PR: state cannot be changed. There are no new commits on the sbueringer:pr-standardize-api-import-aliases branch.

Details

In response to this:

/reopen

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.

sbueringer · 2021-12-09T13:39:39Z

Something broke my rebase workflow. I'll open a new PR

sbueringer · 2021-12-09T13:47:27Z

Okay I just revived that branch/PR instead

/reopen

k8s-ci-robot · 2021-12-09T13:47:39Z

@sbueringer: Reopened this PR.

Details

In response to this:

/reopen

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.

Signed-off-by: Stefan Büringer buringerst@vmware.com

sbueringer · 2021-12-09T14:08:46Z

Rebased and self-reviewed the PR. Should be ready for review now.

sbueringer · 2021-12-09T14:09:14Z

/assign @fabriziopandini @vincepri

(cc @stmcginnis, might be also interesting for you)

killianmuldoon

Thanks for doing this! It should help clarify things.
We should add this as a task for releasing a new API version somewhere too, but that can be outside of this PR.

/lgtm

enxebre · 2021-12-09T17:07:22Z

.golangci.yml

+      - pkg: sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1alpha4
+        alias: bootstrapv1alpha4
+      - pkg: sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1beta1
+        alias: bootstrapv1


should we reserve v1 for real v1 and let the beta imports be consistent e.g bootstrapv1beta1?

Hm good question. Up until know we used v1 everywhere (and with everywhere I also mean in a bunch of providers :))

I think the main idea behind that is that when we upgrade the version only the import changes and not huge parts of the codebase

yes. this is for avoiding churn in the codebase at each release and it kind of makes sense if you read it as the last version in the v1 series (or at least that was the original idea)

fabriziopandini · 2021-12-09T17:42:18Z

/lgtm
I'm definitely +1 to standardize common imports on well know names (whatever they are).
looking for others' opinions.

sbueringer · 2021-12-10T08:28:24Z

/assign @vincepri
If you've got some time, would be great if you can take a look :)

enxebre · 2021-12-10T11:46:03Z

.golangci.yml

+        alias: clusterv1
+      # CAPI exp
+      - pkg: sigs.k8s.io/cluster-api/exp/api/v1alpha3
+        alias: expv1alpha3


nit: clusterexp*?

Would be fine for me. I just used the currently most commonly used alias. But I'm not sure which one would be better (same would probably apply to addonsv1 => clusteraddonsv1, too)

On one side having the cluster prefix would be more consistent with infraexp on the other side it's ab it longer

@fabriziopandini WDYT?

using cluster prefix seems kind of redundant to me, but no strong opinions

Similar here.

enxebre · 2021-12-10T11:46:14Z

/lgtm

vincepri

/approve

k8s-ci-robot · 2021-12-10T15:56:39Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [vincepri]

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 added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Dec 9, 2021

k8s-ci-robot requested review from JoelSpeed and randomvariable December 9, 2021 09:14

k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Dec 9, 2021

sbueringer changed the title ~~[WIP] 🌱 Standardize api import aliases~~ 🌱 Standardize api import aliases Dec 9, 2021

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 9, 2021

sbueringer force-pushed the pr-standardize-api-import-aliases branch 2 times, most recently from 64264bc to d411869 Compare December 9, 2021 13:33

sbueringer closed this Dec 9, 2021

sbueringer force-pushed the pr-standardize-api-import-aliases branch from d411869 to e889246 Compare December 9, 2021 13:36

k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Dec 9, 2021

k8s-ci-robot reopened this Dec 9, 2021

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Dec 9, 2021

Standardize import aliases

b0797b3

Signed-off-by: Stefan Büringer buringerst@vmware.com

sbueringer force-pushed the pr-standardize-api-import-aliases branch from 2e4c350 to b0797b3 Compare December 9, 2021 14:08

k8s-ci-robot assigned fabriziopandini Dec 9, 2021

k8s-ci-robot assigned vincepri Dec 9, 2021

killianmuldoon reviewed Dec 9, 2021

View reviewed changes

k8s-ci-robot assigned killianmuldoon Dec 9, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 9, 2021

tobiasgiese mentioned this pull request Dec 9, 2021

🌱 Standardize api import aliases kubernetes-sigs/cluster-api-provider-openstack#1082

Merged

3 tasks

enxebre reviewed Dec 9, 2021

View reviewed changes

enxebre reviewed Dec 10, 2021

View reviewed changes

k8s-ci-robot assigned enxebre Dec 10, 2021

vincepri approved these changes Dec 10, 2021

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 10, 2021

k8s-ci-robot merged commit c1730d3 into kubernetes-sigs:main Dec 10, 2021

k8s-ci-robot added this to the v1.1 milestone Dec 10, 2021

sbueringer deleted the pr-standardize-api-import-aliases branch December 10, 2021 16:20

Conversation

sbueringer commented Dec 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-ci-robot commented Dec 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fabriziopandini commented Dec 9, 2021

Uh oh!

sbueringer commented Dec 9, 2021

Uh oh!

k8s-ci-robot commented Dec 9, 2021

Uh oh!

sbueringer commented Dec 9, 2021

Uh oh!

sbueringer commented Dec 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-ci-robot commented Dec 9, 2021

Uh oh!

sbueringer commented Dec 9, 2021

Uh oh!

sbueringer commented Dec 9, 2021

Uh oh!

killianmuldoon left a comment

Choose a reason for hiding this comment

Uh oh!

enxebre Dec 9, 2021

Choose a reason for hiding this comment

Uh oh!

sbueringer Dec 9, 2021

Choose a reason for hiding this comment

Uh oh!

sbueringer Dec 9, 2021

Choose a reason for hiding this comment

Uh oh!

fabriziopandini Dec 9, 2021

Choose a reason for hiding this comment

Uh oh!

fabriziopandini commented Dec 9, 2021

Uh oh!

sbueringer commented Dec 10, 2021

Uh oh!

enxebre Dec 10, 2021

Choose a reason for hiding this comment

Uh oh!

sbueringer Dec 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabriziopandini Dec 10, 2021

Choose a reason for hiding this comment

Uh oh!

sbueringer Dec 10, 2021

Choose a reason for hiding this comment

Uh oh!

enxebre commented Dec 10, 2021

Uh oh!

vincepri left a comment

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Dec 10, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

sbueringer commented Dec 9, 2021 •

edited

Loading

k8s-ci-robot commented Dec 9, 2021 •

edited

Loading

sbueringer commented Dec 9, 2021 •

edited

Loading

sbueringer Dec 10, 2021 •

edited

Loading