Remove some binary test files #1206
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dnicolodi
force-pushed
the
rm-binary-blobs-part1
branch
2 times, most recently
from
75da1e3 to
79c7d4e
Compare
woodruffw
reviewed
Dec 26, 2024
This test file was added in 8b8790b (Add tests to ensure version parsing does not regress, part of pypa#147) with the intent of testing the target Python version from wheel file names. However, the filename is identical to the one of the other text fixture tests/fixtures/twine-1.5.0-py2.py3-none-any.whl thus it does not appear to add any additional coverage to the code extracting the target Python version.
dnicolodi
force-pushed
the
rm-binary-blobs-part1
branch
from
79c7d4e to
b2832de
Compare
woodruffw
approved these changes
Jan 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I have noticed (well, a little more than noticed, I've contributed one) that there are a few binary files used as fixtures for test. I think that these are problematic for a couple of reasons.
First and most importantly, it is difficult to determine what aspect of the code these files are testing or what peculiarity of these files is used in the test This could be solved with better code comments at the location where these files are used, but I believe it is much easier and self explanatory to have the test create and consume test files in nearby code locations that can be easily inspected. For the case of one of the files removed here, for example, it seems that it does not contribute anything to the testing, at is identical to another test file. Generating the test files as part of the test suite is easy and, as I'll show with patches in another PR, most of the tests just need a minimal test files that passes twine internal validation, thus a big test file as used now are definitely overkill.
Second, especially after the
xzaccident, people is rightfully worried when they see binary blobs into the source of software packages. This is especially true for archive file formats, for which it is notoriously hard to properly verify the content.Third, they increase the size of the source distribution without adding much value.
Here I am removing two test files the really do nothing, thus I think the patches should be relatively uncontroversial.