pywb icon indicating copy to clipboard operation
pywb copied to clipboard

Published 20 hours ago • verified publisher icon webrecorder

Update test docs

Open edsu opened this issue 2 years ago • 1 comments

Description

Running the tests with python setup.py test does not work due to various version mismatches. However they do run with tox, as they are being run by GitHub actions. This is a small docfix change to alert anyone trying to run the tests that they should use tox.

Motivation and Context

It's important for contributors to know how to run the tests!

Types of changes

  • [ ] Replay fix (fixes a replay specific issue)
  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • [X] My change requires a change to the documentation.
  • [X] I have updated the documentation accordingly.
  • [ ] I have added or updated tests to cover my changes.
  • [ ] All new and existing tests passed.

edsu avatar Jul 19 '22 13:07 edsu

I am able to get it to run via python setup.py test, though this command is deprecated, so should not recommend it. Is plain tox what we want, though, as that runs in multiple python environments? For non-CI testing, probably just want to have it run in the current env?

ikreymer avatar Aug 09 '22 22:08 ikreymer

Looks like there's https://pypi.org/project/tox-current-env which allows you to run tox --current-env which runs tox in the current environment, if available, instead of all of them. I'll open a new PR that recommends using this approach

ikreymer avatar Aug 20 '22 19:08 ikreymer

Replacing with #754. @edsu if you have a chance, can you take a look at #754 to see if it makes sense / works for you?

ikreymer avatar Aug 20 '22 20:08 ikreymer