Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Developer guideline to write unit/integration tests in CAPA repo #3289

Merged
merged 1 commit into from Mar 15, 2022

Conversation

Ankitasw
Copy link
Member

@Ankitasw Ankitasw commented Mar 8, 2022

What type of PR is this?
/kind documentation

What this PR does / why we need it:
As part of #2910, we have added few integration and unit tests in controllers. We have separated two files *_unit_test.go specifically for unit tests and *_test.go for integration tests.
This PR makes clear distinction between the two files and convention of how to differentiate integration vs unit tests.

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 #3288

Checklist:

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

Release note:

Updated the test conventions used for CAPA controllers.

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-priority needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Mar 8, 2022
@k8s-ci-robot
Copy link
Contributor

@Ankitasw: 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 k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Mar 8, 2022
@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Mar 8, 2022
@sedefsavas
Copy link
Contributor

/approve

cc @pydctw if there is any comment.

@k8s-ci-robot
Copy link
Contributor

[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 k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 10, 2022
@Ankitasw Ankitasw force-pushed the dev-doc-update branch 2 times, most recently from 8de2aa8 to 9984a9f Compare March 10, 2022 07:42
@Ankitasw
Copy link
Member Author

@sedefsavas @pydctw please let me know if you have any comments here.

@Ankitasw Ankitasw force-pushed the dev-doc-update branch 3 times, most recently from 14e0310 to f7ce935 Compare March 15, 2022 15:42
@pydctw
Copy link
Contributor

pydctw commented Mar 15, 2022

+1 discussing naming conventions during office hours.

@pydctw
Copy link
Contributor

pydctw commented Mar 15, 2022

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 15, 2022
@k8s-ci-robot k8s-ci-robot merged commit 6ab9562 into kubernetes-sigs:main Mar 15, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.x milestone Mar 15, 2022
@Ankitasw Ankitasw requested a review from pydctw March 16, 2022 05:50
@Ankitasw Ankitasw deleted the dev-doc-update branch March 16, 2022 05:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update developer guide for clear distinction between unit and integration tests
5 participants