1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
|
# Copyright 2015 Ian Cordasco
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import logging
from contextlib import contextmanager
import packaging
import pretend
import pytest
import requests
from packaging import version
from twine import package
from twine import repository
from twine import utils
@pytest.fixture()
def default_repo():
return repository.Repository(
repository_url=utils.DEFAULT_REPOSITORY,
username="username",
password="password",
)
def test_gpg_signature_structure_is_preserved():
"""Preserve 'gpg_signature' key when converting metadata."""
data = {
"gpg_signature": ("filename.asc", "filecontent"),
}
tuples = repository.Repository._convert_metadata_to_list_of_tuples(data)
assert tuples == [("gpg_signature", ("filename.asc", "filecontent"))]
def test_iterables_are_flattened():
"""Flatten iterable metadata to list of tuples."""
data = {
"platform": ["UNKNOWN"],
}
tuples = repository.Repository._convert_metadata_to_list_of_tuples(data)
assert tuples == [("platform", "UNKNOWN")]
data = {
"platform": ["UNKNOWN", "ANOTHERPLATFORM"],
}
tuples = repository.Repository._convert_metadata_to_list_of_tuples(data)
assert tuples == [("platform", "UNKNOWN"), ("platform", "ANOTHERPLATFORM")]
def test_all_metadata_fields_are_flattened(monkeypatch):
"""Verify that package metadata fields are correctly flattened."""
if version.Version(packaging.__version__) < version.Version("24.1"):
# All metadata fields up to metadata version 2.3
metadata = open("tests/fixtures/everything.metadata23")
else:
# All metadata fields up to metadata version 2.4
metadata = open("tests/fixtures/everything.metadata24")
monkeypatch.setattr(package.wheel.Wheel, "read", metadata.read)
filename = "tests/fixtures/twine-1.5.0-py2.py3-none-any.whl"
data = package.PackageFile.from_filename(
filename, comment="comment"
).metadata_dictionary()
tuples = repository.Repository._convert_metadata_to_list_of_tuples(data)
# Verifies that all metadata fields parsed by ``packaging.metadata`` are
# correctly flattened into a list of (str, str) tuples. This does not
# apply to the ``gpg_signature`` field, but this field is not added here
# as there are specific tests for it.
for key, value in tuples:
assert isinstance(key, str)
assert isinstance(value, str)
def test_set_client_certificate(default_repo):
"""Set client certificate for session."""
assert default_repo.session.cert is None
default_repo.set_client_certificate(("/path/to/cert", "/path/to/key"))
assert default_repo.session.cert == ("/path/to/cert", "/path/to/key")
def test_set_certificate_authority(default_repo):
"""Set certificate authority for session."""
assert default_repo.session.verify is True
default_repo.set_certificate_authority("/path/to/cert")
assert default_repo.session.verify == "/path/to/cert"
def test_make_user_agent_string(default_repo):
"""Add twine to User-Agent session header."""
assert "twine/" in default_repo.session.headers["User-Agent"]
def response_with(**kwattrs):
resp = requests.Response()
for attr, value in kwattrs.items():
if hasattr(resp, attr):
setattr(resp, attr, value)
return resp
def test_package_is_uploaded_404s(default_repo):
"""Return False when the project API response status isn't 200."""
default_repo.session = pretend.stub(
get=lambda url, headers: response_with(status_code=404)
)
package = pretend.stub(safe_name="fake", version="2.12.0")
assert default_repo.package_is_uploaded(package) is False
def test_package_is_uploaded_200s_with_no_releases(default_repo):
"""Return False when the list of releases for a project is empty."""
default_repo.session = pretend.stub(
get=lambda url, headers: response_with(
status_code=200, _content=b'{"releases": {}}', _content_consumed=True
),
)
package = pretend.stub(safe_name="fake", version="2.12.0")
assert default_repo.package_is_uploaded(package) is False
def test_package_is_uploaded_with_releases_using_cache(default_repo):
"""Return True when the package is in the releases cache."""
default_repo._releases_json_data = {"fake": {"0.1": [{"filename": "fake.whl"}]}}
package = pretend.stub(
safe_name="fake",
version="0.1",
basefilename="fake.whl",
)
assert default_repo.package_is_uploaded(package) is True
def test_package_is_uploaded_with_releases_not_using_cache(default_repo):
"""Return True when the package is in the list of releases for a project."""
default_repo.session = pretend.stub(
get=lambda url, headers: response_with(
status_code=200,
_content=b'{"releases": {"0.1": [{"filename": "fake.whl"}]}}',
_content_consumed=True,
),
)
package = pretend.stub(
safe_name="fake",
version="0.1",
basefilename="fake.whl",
)
assert default_repo.package_is_uploaded(package, bypass_cache=True) is True
def test_package_is_uploaded_different_filenames(default_repo):
"""Return False when the package is not in the list of releases for a project."""
default_repo.session = pretend.stub(
get=lambda url, headers: response_with(
status_code=200,
_content=b'{"releases": {"0.1": [{"filename": "fake.whl"}]}}',
_content_consumed=True,
),
)
package = pretend.stub(
safe_name="fake",
version="0.1",
basefilename="foo.whl",
)
assert default_repo.package_is_uploaded(package) is False
def test_package_is_registered(default_repo):
"""Return API response from registering a package."""
package = pretend.stub(
basefilename="fake.whl", metadata_dictionary=lambda: {"name": "fake"}
)
resp = response_with(status_code=200)
setattr(resp, "raw", pretend.stub())
setattr(resp.raw, "close", lambda: None)
default_repo.session = pretend.stub(
post=lambda url, data, allow_redirects, headers: resp
)
assert default_repo.register(package)
@pytest.mark.parametrize("disable_progress_bar", [True, False])
def test_disable_progress_bar_is_forwarded_to_rich(
monkeypatch, tmpdir, disable_progress_bar, default_repo
):
"""Toggle display of upload progress bar."""
@contextmanager
def ProgressStub(*args, **kwargs):
assert "disable" in kwargs
assert kwargs["disable"] == disable_progress_bar
yield pretend.stub(
add_task=lambda description, total: None,
update=lambda task_id, completed: None,
)
monkeypatch.setattr(repository.rich.progress, "Progress", ProgressStub)
default_repo.disable_progress_bar = disable_progress_bar
default_repo.session = pretend.stub(
post=lambda url, data, allow_redirects, headers: response_with(status_code=200)
)
fakefile = tmpdir.join("fake.whl")
fakefile.write(".")
def dictfunc():
return {"name": "fake"}
package = pretend.stub(
safe_name="fake",
metadata=pretend.stub(version="2.12.0"),
basefilename="fake.whl",
filename=str(fakefile),
metadata_dictionary=dictfunc,
)
default_repo.upload(package)
def test_upload_retry(tmpdir, default_repo, caplog):
"""Print retry messages when the upload response indicates a server error."""
default_repo.disable_progress_bar = True
default_repo.session = pretend.stub(
post=lambda url, data, allow_redirects, headers: response_with(
status_code=500, reason="Internal server error"
)
)
fakefile = tmpdir.join("fake.whl")
fakefile.write(".")
package = pretend.stub(
safe_name="fake",
metadata=pretend.stub(version="2.12.0"),
basefilename="fake.whl",
filename=str(fakefile),
metadata_dictionary=lambda: {"name": "fake"},
)
# Upload with default max_redirects of 5
default_repo.upload(package)
assert caplog.messages == [
(
'Received "500: Internal server error"\n'
f"Package upload appears to have failed. Retry {i} of 5."
)
for i in range(1, 6)
]
caplog.clear()
# Upload with custom max_redirects of 3
default_repo.upload(package, 3)
assert caplog.messages == [
(
'Received "500: Internal server error"\n'
f"Package upload appears to have failed. Retry {i} of 3."
)
for i in range(1, 4)
]
@pytest.mark.parametrize(
"package_meta,repository_url,release_urls",
[
# Single package
(
[("fake", "2.12.0")],
utils.DEFAULT_REPOSITORY,
{"https://pypi.org/project/fake/2.12.0/"},
),
# Single package to testpypi
(
[("fake", "2.12.0")],
utils.TEST_REPOSITORY,
{"https://test.pypi.org/project/fake/2.12.0/"},
),
# Multiple packages (faking a wheel and an sdist)
(
[("fake", "2.12.0"), ("fake", "2.12.0")],
utils.DEFAULT_REPOSITORY,
{"https://pypi.org/project/fake/2.12.0/"},
),
# Multiple releases
(
[("fake", "2.12.0"), ("fake", "2.12.1")],
utils.DEFAULT_REPOSITORY,
{
"https://pypi.org/project/fake/2.12.0/",
"https://pypi.org/project/fake/2.12.1/",
},
),
# Not pypi
([("fake", "2.12.0")], "http://devpi.example.com", set()),
# No packages
([], utils.DEFAULT_REPOSITORY, set()),
],
)
def test_release_urls(package_meta, repository_url, release_urls):
"""Generate a set of PyPI release URLs for a list of packages."""
packages = [
pretend.stub(safe_name=name, version=version) for name, version in package_meta
]
repo = repository.Repository(
repository_url=repository_url,
username="username",
password="password",
)
assert repo.release_urls(packages) == release_urls
def test_package_is_uploaded_incorrect_repo_url():
"""Return False when using an incorrect repository URL."""
repo = repository.Repository(
repository_url="https://bad.repo.com/legacy",
username="username",
password="password",
)
repo.url = "https://bad.repo.com/legacy"
assert repo.package_is_uploaded(None) is False
@pytest.mark.parametrize(
"username, password, messages",
[
(None, None, ["username: <empty>", "password: <empty>"]),
("", "", ["username: <empty>", "password: <empty>"]),
("username", "password", ["username: username", "password: <hidden>"]),
],
)
def test_logs_username_and_password(username, password, messages, caplog):
caplog.set_level(logging.INFO, "twine")
repository.Repository(
repository_url=utils.DEFAULT_REPOSITORY,
username=username,
password=password,
)
assert caplog.messages == messages
|