cluster-api-provider-aws icon indicating copy to clipboard operation
cluster-api-provider-aws copied to clipboard

refactor: Makes specs for cloud package conformant to a standard naming convention

Open tasdikrahman opened this issue 3 years ago • 5 comments

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

Makes the specs inside the cloud/service/network package conformant to one type of naming convention

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

Special notes for your reviewer:

Checklist:

  • [ ] squashed commits
  • [ ] includes documentation
  • [ ] adds unit tests
  • [ ] adds or updates e2e tests

tasdikrahman avatar Aug 15 '22 21:08 tasdikrahman

@tasdikrahman: This issue is currently awaiting triage.

If CAPA/CAPI contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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.

k8s-ci-robot avatar Aug 15 '22 21:08 k8s-ci-robot

Hi @tasdikrahman. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

k8s-ci-robot avatar Aug 15 '22 21:08 k8s-ci-robot

/ok-to-test

Skarlso avatar Aug 16 '22 04:08 Skarlso

I think we deviated from what was expected here. We were talking about the testcase naming conventions, not function naming convention. For eg. we wanted to correct testcase returns_empty_format_when_format_is_not_set_in_bootstrap_data naming, which is followed differently in different packages/files. As mentioned in the description of the issue, we would use any of the naming convention listed here and would be consistent around whole repo.

Ankitasw avatar Aug 16 '22 10:08 Ankitasw

@Ankitasw I don't see much benefit from adopting that convention, see my comment on the issue

Cluster API repo also uses camel case, and I think it is readable. WDYT?

sedefsavas avatar Aug 16 '22 17:08 sedefsavas

@sedefsavas Yes we can stick to camel case, but this PR just introduce camel case in functions, not for the actual testcase names, which was the intent of the issue.

Ankitasw avatar Aug 17 '22 05:08 Ankitasw

Sample PRs on the issue does the same, so issue has a problem: https://github.com/kubernetes-sigs/cluster-api-provider-aws/pull/3160 https://github.com/kubernetes-sigs/cluster-api-provider-aws/pull/3091

/lgtm /approve

sedefsavas avatar Aug 17 '22 13:08 sedefsavas

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sedefsavas

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:

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 avatar Aug 17 '22 13:08 k8s-ci-robot