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.

Sign up for GitHub

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

Jump to bottom

Replace os.Setenv with testing.T.Setenv in tests #117426

Merged
merged 2 commits into from May 6, 2023
Merged

Replace os.Setenv with testing.T.Setenv in tests #117426

merged 2 commits into from May 6, 2023

Conversation

cbandy
Copy link
Contributor

@cbandy cbandy commented Apr 18, 2023

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

This replaces os.Setenv with testing.T.Setenv for its automatic cleanup and protection against accidental use in parallel tests.

This also cleans up after os.Unsetenv calls in tests using testing.T.Cleanup. The latter correctly runs after any parallel sub-tests, while defer does not.

Special notes for your reviewer:

Broken out from #117395.

Does this PR introduce a user-facing change?

NONE

/sig cli

@cbandy
Replace os.Setenv with testing.T.Setenv in tests
2181eea 
T.Setenv ensures that the environment is returned to its prior state
when the test ends. It also panics when called from a parallel test to
prevent racy test interdependencies.
@cbandy
Cleanup environment in tests that call os.Unsetenv
e8d3a4a 
testing.T.Cleanup ensures the environment is restored after a test and
any of its parallel sub-tests. It's possible that some of these can be
simplified further to T.Setenv(key, ""), but I did not investigate.
@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. sig/cli Categorizes an issue or PR as relevant to SIG CLI. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Apr 18, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @cbandy. Thanks for your PR.

I'm waiting for a kubernetes 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 k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Apr 18, 2023
@KnVerey
Copy link
Contributor

KnVerey commented May 2, 2023

/ok-to-test
/triage accepted
/priority important-longterm
/approve

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. triage/accepted Indicates an issue or PR is ready to be actively worked on. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels May 2, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cbandy, KnVerey

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 May 2, 2023
@cbandy
Copy link
Contributor Author

cbandy commented May 4, 2023

@KnVerey should I ping another reviewer for a /lgtm?

@dims
Copy link
Member

dims commented May 6, 2023

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 6, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: baf3238c4b58b50c4acb7c8f9b193e8a568cedd6

@k8s-ci-robot k8s-ci-robot merged commit 54da29d into kubernetes:master May 6, 2023
12 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.28 milestone May 6, 2023
@cbandy cbandy deleted the kubectl-testing-setenv branch June 6, 2023 01:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@KnVerey KnVerey Awaiting requested review from KnVerey

@seans3 seans3 Awaiting requested review from seans3

Assignees

@dims dims

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/kubectl cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. release-note-none Denotes a PR that doesn't merit a release note. sig/cli Categorizes an issue or PR as relevant to SIG CLI. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
v1.28
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@cbandy @k8s-ci-robot @KnVerey @dims