Repository navigation
1.12.1 pypi dist file doesn't include gitlab/tests/json.data #907
Description
Activity
@derekschrock Hi. Could you elaborate why you need the testdata files in the distribution?
- On Mon, Oct 21, 2019 at 11:34:46AM EDT, Max Wittig wrote: ***@***.*** Hi. Could you elaborate why you need the testdata files in the distribution?The FreeBSD Port Collection has an option to test the built software via a make target test: make test. This will run the equivalent to `python setup.py test` [1] . Normally this is ran when ports are updated or CI. By default FreeBSD python ports use pypi as the source for distribution files if the package is maintained there. Running this test results in a failed test since todo.json is missing. I assumed that gitlab/tests/data/todo.json was missing since the test scripts are also included in the dist. file. If not including this data was on purpose and you have no plans to include it, which I could understand why you would exclude it, then we can close this issue. The current work around is to just pull the data directly from a different distribution source (github [2]). [1] https://github.com/freebsd/freebsd-ports/blob/master/devel/py-python-gitlab/Makefile#L55 [2] https://github.com/freebsd/freebsd-ports/blob/master/devel/py-python-gitlab/Makefile#L7
PyPI sdists are designed to be canonical and complete "source distributions" available to consumers, which may be processed or otherwise different from the underlying repository files.
Consumers of source distributions (PyPI sdists in this case, but not only pypi source distributions) ought to be able to test/verify the software locally. This test/verification use-case is separate from and independent to the "running tests for development purposes" use-case.
While it just happens to be the case that downstream OS packagers are a subset/subclass of "consumers" like regular users, it is by no means the case that the ability to test/verify source distributions is only required for OS packagers.
The additional benefit to ensuring that the source distribution is canonical and complete is that the entire Python packaging pipeline is correctly used and tested
If there is a concern that test data files constitute an "undue size burden" (ie: "we want our sdist to be small"), there is an option available to package the test data files separately, so that this package may:
setup.py: tests_require: gitlab-testdata
We did this for the cryptography package which had its test vectors packaged separately [1][2]
In this particular case though, the test vectors were huge and represented a very compelling case to package separately. For the vast majority of Python packages, this is not necessary, and should be the exception rather than the rule.
[1] https://pypi.org/project/cryptography-vectors/
[2] https://cryptography.io/en/latest/development/test-vectors/That makes sense. I guess we should bundle these then.
- added a commit that references this issue on Oct 22, 2019
@max-wittig Much appreciated Max, thank you! This helps us all ensure a quality experience for users of your software on our OS's
@koobs @derekschrock Thanks for the heads up!
- locked as resolved and limited conversation to collaborators on Nov 8, 2021
FreeBSD ports system uses the distfile from pypi. When running test on python-gitlab with the dist file from pypi it appears gitlab/tests/json.data isn't included.
... test_todo (gitlab.tests.test_gitlab.TestGitlab) ... ERROR ... ====================================================================== ERROR: test_todo (gitlab.tests.test_gitlab.TestGitlab) ---------------------------------------------------------------------- Traceback (most recent call last): File "/wrkdirs/usr/ports/devel/py-python-gitlab/work-py36/python-gitlab-1.12.1/gitlab/tests/test_gitlab.py", line 676, in test_todo todo_content = open(os.path.dirname(__file__) + "/data/todo.json", "r").read() FileNotFoundError: [Errno 2] No such file or directory: '/wrkdirs/usr/ports/devel/py-python-gitlab/work-py36/python-gitlab-1.12.1/gitlab/tests/data/todo.json' Ran 103 tests in 0.510s FAILED (errors=1) Test failed: <unittest.runner.TextTestResult run=103 errors=1 failures=0> error: Test failed: <unittest.runner.TextTestResult run=103 errors=1 failures=0> *** Error code 1Manually placing the file allows all tests to pass.