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

Clear env before test cases requiring empty env #12561

Merged

Conversation

tkonopka
Copy link
Contributor

@tkonopka tkonopka commented Apr 1, 2022

What does this PR do?

Fixes #12551

An existing test case currently runs well with python -m pytest tests/ but fails with make test because the Makefile changes an env variable. The fix updates the test case so that it sees the same env state under the two scenarios.

Does your PR introduce any breaking changes? If yes, please list them.

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • [n/a] Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • [n/a] Did you list all the breaking changes introduced by this pull request?
  • [n/a] Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

@akihironitta akihironitta self-assigned this Apr 2, 2022
@akihironitta
Copy link
Contributor

Thank you @tkonopka for your quick action!

There seem to be other occurrences which I believe need to be updated in the tests. Could you also update the following lines?

$ grep -rnI "os.environ, {}" tests
tests/loggers/test_tensorboard.py:126:@mock.patch.dict(os.environ, {})
tests/callbacks/test_gpu_stats_monitor.py:145:@mock.patch.dict(os.environ, {})
tests/plugins/environments/test_lsf_environment.py:104:    with mock.patch.dict(os.environ, {}):
tests/plugins/environments/test_lightning_environment.py:22:@mock.patch.dict(os.environ, {})
tests/plugins/environments/test_lightning_environment.py:68:@mock.patch.dict(os.environ, {})
tests/plugins/environments/test_slurm_environment.py:23:@mock.patch.dict(os.environ, {})
tests/plugins/environments/test_slurm_environment.py:95:    with mock.patch.dict(os.environ, {}):
tests/plugins/environments/test_torchelastic_environment.py:24:@mock.patch.dict(os.environ, {})
tests/plugins/environments/test_torchelastic_environment.py:77:    with mock.patch.dict(os.environ, {}):
tests/plugins/environments/test_torchelastic_environment.py:95:    with mock.patch.dict(os.environ, {}):
tests/plugins/environments/test_kubeflow_environment.py:23:@mock.patch.dict(os.environ, {})

@akihironitta akihironitta changed the title clear env in a test case test_slurm_environments.py for compatibility with 'make test' Clear env before test cases requiring empty env Apr 2, 2022
@tkonopka
Copy link
Contributor Author

tkonopka commented Apr 2, 2022

Done the additional changes. This will help the suite run in environments that pre-set variables. Thanks.

Earlier, some of the automatic checks seemed stuck (4 expected, and 1 pending checks). I was waiting on those before marking the PR as 'ready', but happy to follow your lead @akihironitta.

@tkonopka tkonopka marked this pull request as ready for review April 4, 2022 17:14
@carmocca carmocca added this to the 1.6.x milestone Apr 6, 2022
@mergify mergify bot added the ready PRs ready to be merged label Apr 6, 2022
Copy link
Contributor

@akihironitta akihironitta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tkonopka Thank you for applying the changes! LGTM!

@akihironitta akihironitta enabled auto-merge (squash) April 7, 2022 11:57
@akihironitta akihironitta merged commit 3bd48b8 into Lightning-AI:master Apr 7, 2022
rohitgr7 pushed a commit that referenced this pull request Apr 12, 2022
* clearing env vars in a test to allow compatibility with "make test"

* added clear=True to more mock environments in testcases

Co-authored-by: Akihiro Nitta <nitta@akihironitta.com>
lexierule pushed a commit that referenced this pull request Apr 13, 2022
* clearing env vars in a test to allow compatibility with "make test"

* added clear=True to more mock environments in testcases

Co-authored-by: Akihiro Nitta <nitta@akihironitta.com>
@rohitgr7 rohitgr7 mentioned this pull request Jul 1, 2022
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready PRs ready to be merged tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants