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 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
|
import base64
import getpass
import logging
import platform
import re
import time
import typing as t
import pytest
import requests.auth
from twine import auth
from twine import exceptions
from twine import utils
@pytest.fixture
def config() -> utils.RepositoryConfig:
return dict(repository="system")
def test_get_username_keyring_defers_to_prompt(monkeypatch, entered_username, config):
class MockKeyring:
@staticmethod
def get_credential(system, user):
return None
monkeypatch.setattr(auth, "keyring", MockKeyring)
username = auth.Resolver(config, auth.CredentialInput()).username
assert username == "entered user"
def test_get_username_keyring_not_installed_defers_to_prompt(
monkeypatch, entered_username, config
):
monkeypatch.setattr(auth, "keyring", None)
username = auth.Resolver(config, auth.CredentialInput()).username
assert username == "entered user"
def test_get_password_keyring_defers_to_prompt(monkeypatch, entered_password, config):
class MockKeyring:
@staticmethod
def get_password(system, user):
return None
monkeypatch.setattr(auth, "keyring", MockKeyring)
pw = auth.Resolver(config, auth.CredentialInput("user")).password
assert pw == "entered pw"
def test_get_password_keyring_not_installed_defers_to_prompt(
monkeypatch, entered_password, config
):
monkeypatch.setattr(auth, "keyring", None)
pw = auth.Resolver(config, auth.CredentialInput("user")).password
assert pw == "entered pw"
def test_no_password_defers_to_prompt(monkeypatch, entered_password, config):
config.update(password=None)
pw = auth.Resolver(config, auth.CredentialInput("user")).password
assert pw == "entered pw"
def test_empty_password_bypasses_prompt(monkeypatch, entered_password, config):
config.update(password="")
pw = auth.Resolver(config, auth.CredentialInput("user")).password
assert pw == ""
def test_no_username_non_interactive_aborts(config):
with pytest.raises(exceptions.NonInteractive):
auth.Private(config, auth.CredentialInput()).username
def test_no_password_non_interactive_aborts(config):
with pytest.raises(exceptions.NonInteractive):
auth.Private(config, auth.CredentialInput("user")).password
def test_get_username_and_password_keyring_overrides_prompt(
monkeypatch, config, caplog
):
caplog.set_level(logging.INFO, "twine")
class MockKeyring:
@staticmethod
def get_credential(system, user):
return auth.CredentialInput(
"real_user", f"real_user@{system} sekure pa55word"
)
@staticmethod
def get_password(system, user):
cred = MockKeyring.get_credential(system, user)
if user != cred.username:
raise RuntimeError("unexpected username")
return cred.password
monkeypatch.setattr(auth, "keyring", MockKeyring)
res = auth.Resolver(config, auth.CredentialInput())
assert res.username == "real_user"
assert res.password == "real_user@system sekure pa55word"
assert caplog.messages == [
"Querying keyring for username",
"username set from keyring",
"Querying keyring for password",
"password set from keyring",
]
@pytest.fixture
def keyring_missing_get_credentials(monkeypatch):
"""Simulate keyring prior to 15.2 that does not have the 'get_credential' API."""
monkeypatch.delattr(auth.keyring, "get_credential")
@pytest.fixture
def entered_username(monkeypatch):
monkeypatch.setattr(auth, "input", lambda prompt: "entered user", raising=False)
def test_get_username_keyring_missing_get_credentials_prompts(
entered_username, keyring_missing_get_credentials, config
):
assert auth.Resolver(config, auth.CredentialInput()).username == "entered user"
def test_get_username_keyring_missing_non_interactive_aborts(
entered_username, keyring_missing_get_credentials, config
):
with pytest.raises(exceptions.NonInteractive):
auth.Private(config, auth.CredentialInput()).username
def test_get_password_keyring_missing_non_interactive_aborts(
entered_username, keyring_missing_get_credentials, config
):
with pytest.raises(exceptions.NonInteractive):
auth.Private(config, auth.CredentialInput("user")).password
def test_get_username_keyring_runtime_error_logged(
entered_username, monkeypatch, config, caplog
):
class FailKeyring:
"""Simulate missing keyring backend raising RuntimeError on get_credential."""
@staticmethod
def get_credential(system, username):
raise RuntimeError("fail!")
monkeypatch.setattr(auth, "keyring", FailKeyring)
assert auth.Resolver(config, auth.CredentialInput()).username == "entered user"
assert re.search(
r"Error getting username from keyring.+Traceback.+RuntimeError: fail!",
caplog.text,
re.DOTALL,
)
def test_get_password_keyring_runtime_error_logged(
entered_username, entered_password, monkeypatch, config, caplog
):
class FailKeyring:
"""Simulate missing keyring backend raising RuntimeError on get_password."""
@staticmethod
def get_password(system, username):
raise RuntimeError("fail!")
monkeypatch.setattr(auth, "keyring", FailKeyring)
assert auth.Resolver(config, auth.CredentialInput()).password == "entered pw"
assert re.search(
r"Error getting password from keyring.+Traceback.+RuntimeError: fail!",
caplog.text,
re.DOTALL,
)
def _raise_home_key_error():
"""Simulate environment from https://github.com/pypa/twine/issues/889."""
try:
raise KeyError("HOME")
except KeyError:
raise KeyError("uid not found: 999")
def test_get_username_keyring_key_error_logged(
entered_username, monkeypatch, config, caplog
):
class FailKeyring:
@staticmethod
def get_credential(system, username):
_raise_home_key_error()
monkeypatch.setattr(auth, "keyring", FailKeyring)
assert auth.Resolver(config, auth.CredentialInput()).username == "entered user"
assert re.search(
r"Error getting username from keyring"
r".+Traceback"
r".+KeyError: 'HOME'"
r".+KeyError: 'uid not found: 999'",
caplog.text,
re.DOTALL,
)
def test_get_password_keyring_key_error_logged(
entered_username, entered_password, monkeypatch, config, caplog
):
class FailKeyring:
@staticmethod
def get_password(system, username):
_raise_home_key_error()
monkeypatch.setattr(auth, "keyring", FailKeyring)
assert auth.Resolver(config, auth.CredentialInput()).password == "entered pw"
assert re.search(
r"Error getting password from keyring"
r".+Traceback"
r".+KeyError: 'HOME'"
r".+KeyError: 'uid not found: 999'",
caplog.text,
re.DOTALL,
)
def test_logs_cli_values(caplog, config):
caplog.set_level(logging.INFO, "twine")
res = auth.Resolver(config, auth.CredentialInput("username", "password"))
assert res.username == "username"
assert res.password == "password"
assert caplog.messages == [
"username set by command options",
"password set by command options",
]
def test_logs_config_values(config, caplog):
caplog.set_level(logging.INFO, "twine")
config.update(username="username", password="password")
res = auth.Resolver(config, auth.CredentialInput())
assert res.username == "username"
assert res.password == "password"
assert caplog.messages == [
"username set from config file",
"password set from config file",
]
@pytest.mark.parametrize(
"password, warning",
[
("", "Your password is empty"),
("\x16", "Your password contains control characters"),
("entered\x16pw", "Your password contains control characters"),
],
)
def test_warns_for_empty_password(
password,
warning,
monkeypatch,
entered_username,
config,
caplog,
):
# Avoiding additional warning "No recommended backend was available"
monkeypatch.setattr(auth.keyring, "get_password", lambda system, user: None)
monkeypatch.setattr(getpass, "getpass", lambda prompt: password)
assert auth.Resolver(config, auth.CredentialInput()).password == password
assert caplog.messages[0].startswith(warning)
@pytest.mark.skipif(
platform.machine() in {"ppc64le", "s390x"},
reason="keyring module is optional on ppc64le and s390x",
)
def test_keyring_module():
assert auth.keyring is not None
def test_resolver_authenticator_config_authentication(config):
config.update(username="username", password="password")
res = auth.Resolver(config, auth.CredentialInput())
assert isinstance(res.authenticator, requests.auth.HTTPBasicAuth)
def test_resolver_authenticator_credential_input_authentication(config):
res = auth.Resolver(config, auth.CredentialInput("username", "password"))
assert isinstance(res.authenticator, requests.auth.HTTPBasicAuth)
def test_resolver_authenticator_trusted_publishing_authentication(config):
res = auth.Resolver(
config, auth.CredentialInput(username="__token__", password="skip-stdin")
)
res._tp_token = auth.TrustedPublishingToken(
success=True,
token="fake-tp-token",
)
assert isinstance(res.authenticator, auth.TrustedPublishingAuthenticator)
class MockResponse:
def __init__(self, status_code: int, json: t.Any) -> None:
self.status_code = status_code
self._json = json
def json(self, *args, **kwargs) -> t.Any:
return self._json
def raise_for_status(self) -> None:
if 400 <= self.status_code:
raise requests.exceptions.HTTPError()
def ok(self) -> bool:
return self.status_code == 200
class MockSession:
def __init__(
self,
get_response_list: t.List[MockResponse],
post_response_list: t.List[MockResponse],
) -> None:
self.post_counter = self.get_counter = 0
self.get_response_list = get_response_list
self.post_response_list = post_response_list
def get(self, url: str, **kwargs) -> MockResponse:
response = self.get_response_list[self.get_counter]
self.get_counter += 1
return response
def post(self, url: str, **kwargs) -> MockResponse:
response = self.post_response_list[self.post_counter]
self.post_counter += 1
return response
def test_trusted_publish_authenticator_refreshes_token(monkeypatch, config):
def make_session():
return MockSession(
get_response_list=[
MockResponse(status_code=200, json={"audience": "fake-aud"})
],
post_response_list=[
MockResponse(
status_code=200,
json={
"success": True,
"token": "new-token",
"expires": int(time.time()) + 900,
},
),
],
)
def detect_credential(*args, **kwargs) -> str:
return "fake-oidc-token"
config.update({"repository": utils.TEST_REPOSITORY})
res = auth.Resolver(config, auth.CredentialInput(username="__token__"))
res._tp_token = auth.TrustedPublishingToken(
success=True,
token="expiring-tp-token",
)
res._expires = int(time.time()) + 4 * 60
monkeypatch.setattr(auth, "detect_credential", detect_credential)
monkeypatch.setattr(auth.utils, "make_requests_session", make_session)
authenticator = auth.TrustedPublishingAuthenticator(resolver=res)
prepped_req = requests.models.PreparedRequest()
prepped_req.prepare_headers({})
request = authenticator(prepped_req)
assert (
request.headers["Authorization"]
== f"Basic {base64.b64encode(b'__token__:new-token').decode()}"
)
def test_trusted_publish_authenticator_reuses_token(monkeypatch, config):
def make_session():
return MockSession(
get_response_list=[
MockResponse(status_code=200, json={"audience": "fake-aud"})
],
post_response_list=[
MockResponse(
status_code=200,
json={
"success": True,
"token": "new-token",
"expires": int(time.time()) + 900,
},
),
],
)
def detect_credential(*args, **kwargs) -> str:
return "fake-oidc-token"
config.update({"repository": utils.TEST_REPOSITORY})
res = auth.Resolver(config, auth.CredentialInput(username="__token__"))
res._tp_token = auth.TrustedPublishingToken(
success=True,
token="valid-tp-token",
)
res._expires = int(time.time()) + 900
monkeypatch.setattr(auth, "detect_credential", detect_credential)
monkeypatch.setattr(auth.utils, "make_requests_session", make_session)
authenticator = auth.TrustedPublishingAuthenticator(resolver=res)
prepped_req = requests.models.PreparedRequest()
prepped_req.prepare_headers({})
request = authenticator(prepped_req)
assert (
request.headers["Authorization"]
== f"Basic {base64.b64encode(b'__token__:valid-tp-token').decode()}"
)
def test_inability_to_make_token_raises_error():
class MockResolver:
def make_trusted_publishing_token(self) -> None:
return None
authenticator = auth.TrustedPublishingAuthenticator(
resolver=MockResolver(),
)
with pytest.raises(exceptions.TrustedPublishingFailure):
authenticator(None)
|