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

Make sure optional dependencies are optional for tests #260

Merged
merged 3 commits into from
Dec 11, 2020
Merged

Make sure optional dependencies are optional for tests #260

merged 3 commits into from
Dec 11, 2020

Conversation

aaronayres35
Copy link
Contributor

@aaronayres35 aaronayres35 commented Dec 10, 2020 •
edited
Loading

fixes #99

This PR uses the existing apptools._testing.optional_dependencies to ensure that optional dependencies are optional for tests. The test suite should no longer fail if certain optional dependencies are not installed.

Checklist

  • Add a news fragment if this PR is news-worthy for end users. (see docs/releases/README.rst)

aaronayres35
aaronayres35 commented Dec 10, 2020
View reviewed changes
apptools/persistence/tests/test_state_pickler.py Outdated
self.tuple = (1, 2, "a", A())
self.list = [1, 1.1, "a", 1j, self.inst]
self.dict = {"a": 1, "b": 2, "ref": self.inst}
self.ref = self.numeric
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was a bit awkward, but these classes should only be defined if we have numpy, so I moved them inside the above if statement. There is probably a cleaner way to do this

Copy link
Contributor

@kitchoi kitchoi Dec 11, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Since all of the tests in this module requires NumPy, this is a case where one may consider raising SkipTest at the module, like this: https://github.com/enthought/traitsui/blob/464b20200eef30f23317ffd3f6a125520329f7e2/traitsui/tests/ui_editors/test_data_frame_editor.py#L11-L14

With that, when we run the test with discover, the entire module will be skipped. And if one wants to run the test module on its own, e.g. python -m unittest apptools.persistence.tests.test_state_pickler, they ought to have NumPy because the subject state_pickler requires NumPy. It is understandable to get an exception there.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think I flip flop between the two (wrapping code in a condition VS raising SkipTest at the module) depending on the situation (e.g. how optional the dependency is, how much code needs to be wrapped in an if-block, ...). This is an option for consideration.

Copy link
Contributor

Choose a reason for hiding this comment

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

The approach here means in both run scenarios (unittest discover) and (unittest <module-name>), the tests are consistently skipped in the absence of numpy.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In this particular case I went with the approach you described as it is cleaner IMO. For the rest I left them as is.

@aaronayres35
Copy link
Contributor Author

I am curious to test the new news fragment system with this scenario, as this is a PR that will need to be backported for the 5.0.0 release and it has a news fragment.

kitchoi
kitchoi approved these changes Dec 11, 2020
View reviewed changes
Copy link
Contributor

@kitchoi kitchoi left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LVGTM. Thank you.

There is an alternative way to skip the entire test module for you to consider. (I don't have a particular preference over which one.)

@kitchoi kitchoi added the need backport to 5.0 PRs that need to be backported to maint/5.0 label Dec 11, 2020
@aaronayres35
Copy link
Contributor Author

@kitchoi still looking okay to merge?

@kitchoi
Copy link
Contributor

kitchoi commented Dec 11, 2020

still looking okay to merge?

Yes. Thank you!

@aaronayres35 aaronayres35 merged commit a9885f5 into master Dec 11, 2020
@aaronayres35 aaronayres35 deleted the optional-deps-optional-for-tests branch December 11, 2020 14:59
aaronayres35 added a commit that referenced this pull request Dec 16, 2020
@aaronayres35
Make sure optional dependencies are optional for tests (#260)
de6231f 
* make sure optional dependencies are optional for tests

* add a news fragment

* apply suggestion from code review
aaronayres35 added a commit that referenced this pull request Dec 17, 2020
@aaronayres35 @kitchoi
Backports for 5.0.0 and update Changelog (#263)
2e6e9cb 
* Make sure optional dependencies are optional for tests (#260)

* make sure optional dependencies are optional for tests

* add a news fragment

* apply suggestion from code review

* Add extras_require to setup.py for optional dependencies (#257)

* add optional dependencies for specific cub packages to extras_require

* add details to README about optional dependencies

* list io imports as standard library imports

* add prefrences/configobj to extras_rrequire as well (leave configobj in install_requires too)

* add specific install instructions

* formatting

* remove unneeded back ticks

* move install instructions into a separate section

* add news fragment

* add PR number to news fragment

* Remove image license files (#262)

* remove image license files

* move internal image license file to root directory

* add image_LICENSE_CP.txt and include it in manifest

* Apply suggestions from code review

Co-authored-by: Poruri Sai Rahul <rporuri@enthought.com>

Co-authored-by: Poruri Sai Rahul <rporuri@enthought.com>

* Add a new category for build system related changes (#261)

* update changelog

Co-authored-by: Poruri Sai Rahul <rporuri@enthought.com>
Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com>
aaronayres35 added a commit that referenced this pull request Dec 17, 2020
@aaronayres35 @kitchoi
Backports for 5.0.0 and update Changelog (#263)
7aa72d5 
* Make sure optional dependencies are optional for tests (#260)

* make sure optional dependencies are optional for tests

* add a news fragment

* apply suggestion from code review

* Add extras_require to setup.py for optional dependencies (#257)

* add optional dependencies for specific cub packages to extras_require

* add details to README about optional dependencies

* list io imports as standard library imports

* add prefrences/configobj to extras_rrequire as well (leave configobj in install_requires too)

* add specific install instructions

* formatting

* remove unneeded back ticks

* move install instructions into a separate section

* add news fragment

* add PR number to news fragment

* Remove image license files (#262)

* remove image license files

* move internal image license file to root directory

* add image_LICENSE_CP.txt and include it in manifest

* Apply suggestions from code review

Co-authored-by: Poruri Sai Rahul <rporuri@enthought.com>

Co-authored-by: Poruri Sai Rahul <rporuri@enthought.com>

* Add a new category for build system related changes (#261)

* update changelog

Co-authored-by: Poruri Sai Rahul <rporuri@enthought.com>
Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kitchoi kitchoi kitchoi approved these changes

Assignees
No one assigned
Labels
need backport to 5.0 PRs that need to be backported to maint/5.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make sure that optional dependencies are also optional for tests
2 participants
@aaronayres35 @kitchoi