Stav 23.06.2026
This commit is contained in:
@@ -0,0 +1,470 @@
|
||||
"""Tests for distutils.command.sdist."""
|
||||
|
||||
import os
|
||||
import pathlib
|
||||
import shutil # noqa: F401
|
||||
import tarfile
|
||||
import zipfile
|
||||
from distutils.archive_util import ARCHIVE_FORMATS
|
||||
from distutils.command.sdist import sdist, show_formats
|
||||
from distutils.core import Distribution
|
||||
from distutils.errors import DistutilsOptionError
|
||||
from distutils.filelist import FileList
|
||||
from os.path import join
|
||||
from textwrap import dedent
|
||||
|
||||
import jaraco.path
|
||||
import path
|
||||
import pytest
|
||||
from more_itertools import ilen
|
||||
|
||||
from . import support
|
||||
from .unix_compat import grp, pwd, require_uid_0, require_unix_id
|
||||
|
||||
SETUP_PY = """
|
||||
from distutils.core import setup
|
||||
import somecode
|
||||
|
||||
setup(name='fake')
|
||||
"""
|
||||
|
||||
MANIFEST = """\
|
||||
# file GENERATED by distutils, do NOT edit
|
||||
README
|
||||
buildout.cfg
|
||||
inroot.txt
|
||||
setup.py
|
||||
data%(sep)sdata.dt
|
||||
scripts%(sep)sscript.py
|
||||
some%(sep)sfile.txt
|
||||
some%(sep)sother_file.txt
|
||||
somecode%(sep)s__init__.py
|
||||
somecode%(sep)sdoc.dat
|
||||
somecode%(sep)sdoc.txt
|
||||
"""
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True)
|
||||
def project_dir(request, distutils_managed_tempdir):
|
||||
self = request.instance
|
||||
self.tmp_dir = self.mkdtemp()
|
||||
jaraco.path.build(
|
||||
{
|
||||
'somecode': {
|
||||
'__init__.py': '#',
|
||||
},
|
||||
'README': 'xxx',
|
||||
'setup.py': SETUP_PY,
|
||||
},
|
||||
self.tmp_dir,
|
||||
)
|
||||
with path.Path(self.tmp_dir):
|
||||
yield
|
||||
|
||||
|
||||
def clean_lines(filepath):
|
||||
with pathlib.Path(filepath).open(encoding='utf-8') as f:
|
||||
yield from filter(None, map(str.strip, f))
|
||||
|
||||
|
||||
class TestSDist(support.TempdirManager):
|
||||
def get_cmd(self, metadata=None):
|
||||
"""Returns a cmd"""
|
||||
if metadata is None:
|
||||
metadata = {
|
||||
'name': 'ns.fake--pkg',
|
||||
'version': '1.0',
|
||||
'url': 'xxx',
|
||||
'author': 'xxx',
|
||||
'author_email': 'xxx',
|
||||
}
|
||||
dist = Distribution(metadata)
|
||||
dist.script_name = 'setup.py'
|
||||
dist.packages = ['somecode']
|
||||
dist.include_package_data = True
|
||||
cmd = sdist(dist)
|
||||
cmd.dist_dir = 'dist'
|
||||
return dist, cmd
|
||||
|
||||
@pytest.mark.usefixtures('needs_zlib')
|
||||
def test_prune_file_list(self):
|
||||
# this test creates a project with some VCS dirs and an NFS rename
|
||||
# file, then launches sdist to check they get pruned on all systems
|
||||
|
||||
# creating VCS directories with some files in them
|
||||
os.mkdir(join(self.tmp_dir, 'somecode', '.svn'))
|
||||
self.write_file((self.tmp_dir, 'somecode', '.svn', 'ok.py'), 'xxx')
|
||||
|
||||
os.mkdir(join(self.tmp_dir, 'somecode', '.hg'))
|
||||
self.write_file((self.tmp_dir, 'somecode', '.hg', 'ok'), 'xxx')
|
||||
|
||||
os.mkdir(join(self.tmp_dir, 'somecode', '.git'))
|
||||
self.write_file((self.tmp_dir, 'somecode', '.git', 'ok'), 'xxx')
|
||||
|
||||
self.write_file((self.tmp_dir, 'somecode', '.nfs0001'), 'xxx')
|
||||
|
||||
# now building a sdist
|
||||
dist, cmd = self.get_cmd()
|
||||
|
||||
# zip is available universally
|
||||
# (tar might not be installed under win32)
|
||||
cmd.formats = ['zip']
|
||||
|
||||
cmd.ensure_finalized()
|
||||
cmd.run()
|
||||
|
||||
# now let's check what we have
|
||||
dist_folder = join(self.tmp_dir, 'dist')
|
||||
files = os.listdir(dist_folder)
|
||||
assert files == ['ns_fake_pkg-1.0.zip']
|
||||
|
||||
zip_file = zipfile.ZipFile(join(dist_folder, 'ns_fake_pkg-1.0.zip'))
|
||||
try:
|
||||
content = zip_file.namelist()
|
||||
finally:
|
||||
zip_file.close()
|
||||
|
||||
# making sure everything has been pruned correctly
|
||||
expected = [
|
||||
'',
|
||||
'PKG-INFO',
|
||||
'README',
|
||||
'setup.py',
|
||||
'somecode/',
|
||||
'somecode/__init__.py',
|
||||
]
|
||||
assert sorted(content) == ['ns_fake_pkg-1.0/' + x for x in expected]
|
||||
|
||||
@pytest.mark.usefixtures('needs_zlib')
|
||||
@pytest.mark.skipif("not shutil.which('tar')")
|
||||
@pytest.mark.skipif("not shutil.which('gzip')")
|
||||
def test_make_distribution(self):
|
||||
# now building a sdist
|
||||
dist, cmd = self.get_cmd()
|
||||
|
||||
# creating a gztar then a tar
|
||||
cmd.formats = ['gztar', 'tar']
|
||||
cmd.ensure_finalized()
|
||||
cmd.run()
|
||||
|
||||
# making sure we have two files
|
||||
dist_folder = join(self.tmp_dir, 'dist')
|
||||
result = os.listdir(dist_folder)
|
||||
result.sort()
|
||||
assert result == ['ns_fake_pkg-1.0.tar', 'ns_fake_pkg-1.0.tar.gz']
|
||||
|
||||
os.remove(join(dist_folder, 'ns_fake_pkg-1.0.tar'))
|
||||
os.remove(join(dist_folder, 'ns_fake_pkg-1.0.tar.gz'))
|
||||
|
||||
# now trying a tar then a gztar
|
||||
cmd.formats = ['tar', 'gztar']
|
||||
|
||||
cmd.ensure_finalized()
|
||||
cmd.run()
|
||||
|
||||
result = os.listdir(dist_folder)
|
||||
result.sort()
|
||||
assert result == ['ns_fake_pkg-1.0.tar', 'ns_fake_pkg-1.0.tar.gz']
|
||||
|
||||
@pytest.mark.usefixtures('needs_zlib')
|
||||
def test_add_defaults(self):
|
||||
# https://bugs.python.org/issue2279
|
||||
|
||||
# add_default should also include
|
||||
# data_files and package_data
|
||||
dist, cmd = self.get_cmd()
|
||||
|
||||
# filling data_files by pointing files
|
||||
# in package_data
|
||||
dist.package_data = {'': ['*.cfg', '*.dat'], 'somecode': ['*.txt']}
|
||||
self.write_file((self.tmp_dir, 'somecode', 'doc.txt'), '#')
|
||||
self.write_file((self.tmp_dir, 'somecode', 'doc.dat'), '#')
|
||||
|
||||
# adding some data in data_files
|
||||
data_dir = join(self.tmp_dir, 'data')
|
||||
os.mkdir(data_dir)
|
||||
self.write_file((data_dir, 'data.dt'), '#')
|
||||
some_dir = join(self.tmp_dir, 'some')
|
||||
os.mkdir(some_dir)
|
||||
# make sure VCS directories are pruned (#14004)
|
||||
hg_dir = join(self.tmp_dir, '.hg')
|
||||
os.mkdir(hg_dir)
|
||||
self.write_file((hg_dir, 'last-message.txt'), '#')
|
||||
# a buggy regex used to prevent this from working on windows (#6884)
|
||||
self.write_file((self.tmp_dir, 'buildout.cfg'), '#')
|
||||
self.write_file((self.tmp_dir, 'inroot.txt'), '#')
|
||||
self.write_file((some_dir, 'file.txt'), '#')
|
||||
self.write_file((some_dir, 'other_file.txt'), '#')
|
||||
|
||||
dist.data_files = [
|
||||
('data', ['data/data.dt', 'buildout.cfg', 'inroot.txt', 'notexisting']),
|
||||
'some/file.txt',
|
||||
'some/other_file.txt',
|
||||
]
|
||||
|
||||
# adding a script
|
||||
script_dir = join(self.tmp_dir, 'scripts')
|
||||
os.mkdir(script_dir)
|
||||
self.write_file((script_dir, 'script.py'), '#')
|
||||
dist.scripts = [join('scripts', 'script.py')]
|
||||
|
||||
cmd.formats = ['zip']
|
||||
cmd.use_defaults = True
|
||||
|
||||
cmd.ensure_finalized()
|
||||
cmd.run()
|
||||
|
||||
# now let's check what we have
|
||||
dist_folder = join(self.tmp_dir, 'dist')
|
||||
files = os.listdir(dist_folder)
|
||||
assert files == ['ns_fake_pkg-1.0.zip']
|
||||
|
||||
zip_file = zipfile.ZipFile(join(dist_folder, 'ns_fake_pkg-1.0.zip'))
|
||||
try:
|
||||
content = zip_file.namelist()
|
||||
finally:
|
||||
zip_file.close()
|
||||
|
||||
# making sure everything was added
|
||||
expected = [
|
||||
'',
|
||||
'PKG-INFO',
|
||||
'README',
|
||||
'buildout.cfg',
|
||||
'data/',
|
||||
'data/data.dt',
|
||||
'inroot.txt',
|
||||
'scripts/',
|
||||
'scripts/script.py',
|
||||
'setup.py',
|
||||
'some/',
|
||||
'some/file.txt',
|
||||
'some/other_file.txt',
|
||||
'somecode/',
|
||||
'somecode/__init__.py',
|
||||
'somecode/doc.dat',
|
||||
'somecode/doc.txt',
|
||||
]
|
||||
assert sorted(content) == ['ns_fake_pkg-1.0/' + x for x in expected]
|
||||
|
||||
# checking the MANIFEST
|
||||
manifest = pathlib.Path(self.tmp_dir, 'MANIFEST').read_text(encoding='utf-8')
|
||||
assert manifest == MANIFEST % {'sep': os.sep}
|
||||
|
||||
@staticmethod
|
||||
def warnings(messages, prefix='warning: '):
|
||||
return [msg for msg in messages if msg.startswith(prefix)]
|
||||
|
||||
@pytest.mark.usefixtures('needs_zlib')
|
||||
def test_metadata_check_option(self, caplog):
|
||||
# testing the `medata-check` option
|
||||
dist, cmd = self.get_cmd(metadata={})
|
||||
|
||||
# this should raise some warnings !
|
||||
# with the `check` subcommand
|
||||
cmd.ensure_finalized()
|
||||
cmd.run()
|
||||
assert len(self.warnings(caplog.messages, 'warning: check: ')) == 1
|
||||
|
||||
# trying with a complete set of metadata
|
||||
caplog.clear()
|
||||
dist, cmd = self.get_cmd()
|
||||
cmd.ensure_finalized()
|
||||
cmd.metadata_check = False
|
||||
cmd.run()
|
||||
assert len(self.warnings(caplog.messages, 'warning: check: ')) == 0
|
||||
|
||||
def test_show_formats(self, capsys):
|
||||
show_formats()
|
||||
|
||||
# the output should be a header line + one line per format
|
||||
num_formats = len(ARCHIVE_FORMATS.keys())
|
||||
output = [
|
||||
line
|
||||
for line in capsys.readouterr().out.split('\n')
|
||||
if line.strip().startswith('--formats=')
|
||||
]
|
||||
assert len(output) == num_formats
|
||||
|
||||
def test_finalize_options(self):
|
||||
dist, cmd = self.get_cmd()
|
||||
cmd.finalize_options()
|
||||
|
||||
# default options set by finalize
|
||||
assert cmd.manifest == 'MANIFEST'
|
||||
assert cmd.template == 'MANIFEST.in'
|
||||
assert cmd.dist_dir == 'dist'
|
||||
|
||||
# formats has to be a string splitable on (' ', ',') or
|
||||
# a stringlist
|
||||
cmd.formats = 1
|
||||
with pytest.raises(DistutilsOptionError):
|
||||
cmd.finalize_options()
|
||||
cmd.formats = ['zip']
|
||||
cmd.finalize_options()
|
||||
|
||||
# formats has to be known
|
||||
cmd.formats = 'supazipa'
|
||||
with pytest.raises(DistutilsOptionError):
|
||||
cmd.finalize_options()
|
||||
|
||||
# the following tests make sure there is a nice error message instead
|
||||
# of a traceback when parsing an invalid manifest template
|
||||
|
||||
def _check_template(self, content, caplog):
|
||||
dist, cmd = self.get_cmd()
|
||||
os.chdir(self.tmp_dir)
|
||||
self.write_file('MANIFEST.in', content)
|
||||
cmd.ensure_finalized()
|
||||
cmd.filelist = FileList()
|
||||
cmd.read_template()
|
||||
assert len(self.warnings(caplog.messages)) == 1
|
||||
|
||||
def test_invalid_template_unknown_command(self, caplog):
|
||||
self._check_template('taunt knights *', caplog)
|
||||
|
||||
def test_invalid_template_wrong_arguments(self, caplog):
|
||||
# this manifest command takes one argument
|
||||
self._check_template('prune', caplog)
|
||||
|
||||
@pytest.mark.skipif("platform.system() != 'Windows'")
|
||||
def test_invalid_template_wrong_path(self, caplog):
|
||||
# on Windows, trailing slashes are not allowed
|
||||
# this used to crash instead of raising a warning: #8286
|
||||
self._check_template('include examples/', caplog)
|
||||
|
||||
@pytest.mark.usefixtures('needs_zlib')
|
||||
def test_get_file_list(self):
|
||||
# make sure MANIFEST is recalculated
|
||||
dist, cmd = self.get_cmd()
|
||||
|
||||
# filling data_files by pointing files in package_data
|
||||
dist.package_data = {'somecode': ['*.txt']}
|
||||
self.write_file((self.tmp_dir, 'somecode', 'doc.txt'), '#')
|
||||
cmd.formats = ['gztar']
|
||||
cmd.ensure_finalized()
|
||||
cmd.run()
|
||||
|
||||
assert ilen(clean_lines(cmd.manifest)) == 5
|
||||
|
||||
# adding a file
|
||||
self.write_file((self.tmp_dir, 'somecode', 'doc2.txt'), '#')
|
||||
|
||||
# make sure build_py is reinitialized, like a fresh run
|
||||
build_py = dist.get_command_obj('build_py')
|
||||
build_py.finalized = False
|
||||
build_py.ensure_finalized()
|
||||
|
||||
cmd.run()
|
||||
|
||||
manifest2 = list(clean_lines(cmd.manifest))
|
||||
|
||||
# do we have the new file in MANIFEST ?
|
||||
assert len(manifest2) == 6
|
||||
assert 'doc2.txt' in manifest2[-1]
|
||||
|
||||
@pytest.mark.usefixtures('needs_zlib')
|
||||
def test_manifest_marker(self):
|
||||
# check that autogenerated MANIFESTs have a marker
|
||||
dist, cmd = self.get_cmd()
|
||||
cmd.ensure_finalized()
|
||||
cmd.run()
|
||||
|
||||
assert (
|
||||
next(clean_lines(cmd.manifest))
|
||||
== '# file GENERATED by distutils, do NOT edit'
|
||||
)
|
||||
|
||||
@pytest.mark.usefixtures('needs_zlib')
|
||||
def test_manifest_comments(self):
|
||||
# make sure comments don't cause exceptions or wrong includes
|
||||
contents = dedent(
|
||||
"""\
|
||||
# bad.py
|
||||
#bad.py
|
||||
good.py
|
||||
"""
|
||||
)
|
||||
dist, cmd = self.get_cmd()
|
||||
cmd.ensure_finalized()
|
||||
self.write_file((self.tmp_dir, cmd.manifest), contents)
|
||||
self.write_file((self.tmp_dir, 'good.py'), '# pick me!')
|
||||
self.write_file((self.tmp_dir, 'bad.py'), "# don't pick me!")
|
||||
self.write_file((self.tmp_dir, '#bad.py'), "# don't pick me!")
|
||||
cmd.run()
|
||||
assert cmd.filelist.files == ['good.py']
|
||||
|
||||
@pytest.mark.usefixtures('needs_zlib')
|
||||
def test_manual_manifest(self):
|
||||
# check that a MANIFEST without a marker is left alone
|
||||
dist, cmd = self.get_cmd()
|
||||
cmd.formats = ['gztar']
|
||||
cmd.ensure_finalized()
|
||||
self.write_file((self.tmp_dir, cmd.manifest), 'README.manual')
|
||||
self.write_file(
|
||||
(self.tmp_dir, 'README.manual'),
|
||||
'This project maintains its MANIFEST file itself.',
|
||||
)
|
||||
cmd.run()
|
||||
assert cmd.filelist.files == ['README.manual']
|
||||
|
||||
assert list(clean_lines(cmd.manifest)) == ['README.manual']
|
||||
|
||||
archive_name = join(self.tmp_dir, 'dist', 'ns_fake_pkg-1.0.tar.gz')
|
||||
archive = tarfile.open(archive_name)
|
||||
try:
|
||||
filenames = [tarinfo.name for tarinfo in archive]
|
||||
finally:
|
||||
archive.close()
|
||||
assert sorted(filenames) == [
|
||||
'ns_fake_pkg-1.0',
|
||||
'ns_fake_pkg-1.0/PKG-INFO',
|
||||
'ns_fake_pkg-1.0/README.manual',
|
||||
]
|
||||
|
||||
@pytest.mark.usefixtures('needs_zlib')
|
||||
@require_unix_id
|
||||
@require_uid_0
|
||||
@pytest.mark.skipif("not shutil.which('tar')")
|
||||
@pytest.mark.skipif("not shutil.which('gzip')")
|
||||
def test_make_distribution_owner_group(self):
|
||||
# now building a sdist
|
||||
dist, cmd = self.get_cmd()
|
||||
|
||||
# creating a gztar and specifying the owner+group
|
||||
cmd.formats = ['gztar']
|
||||
cmd.owner = pwd.getpwuid(0)[0]
|
||||
cmd.group = grp.getgrgid(0)[0]
|
||||
cmd.ensure_finalized()
|
||||
cmd.run()
|
||||
|
||||
# making sure we have the good rights
|
||||
archive_name = join(self.tmp_dir, 'dist', 'ns_fake_pkg-1.0.tar.gz')
|
||||
archive = tarfile.open(archive_name)
|
||||
try:
|
||||
for member in archive.getmembers():
|
||||
assert member.uid == 0
|
||||
assert member.gid == 0
|
||||
finally:
|
||||
archive.close()
|
||||
|
||||
# building a sdist again
|
||||
dist, cmd = self.get_cmd()
|
||||
|
||||
# creating a gztar
|
||||
cmd.formats = ['gztar']
|
||||
cmd.ensure_finalized()
|
||||
cmd.run()
|
||||
|
||||
# making sure we have the good rights
|
||||
archive_name = join(self.tmp_dir, 'dist', 'ns_fake_pkg-1.0.tar.gz')
|
||||
archive = tarfile.open(archive_name)
|
||||
|
||||
# note that we are not testing the group ownership here
|
||||
# because, depending on the platforms and the container
|
||||
# rights (see #7408)
|
||||
try:
|
||||
for member in archive.getmembers():
|
||||
assert member.uid == os.getuid()
|
||||
finally:
|
||||
archive.close()
|
||||
Reference in New Issue
Block a user