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
|
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
import os
import sys
import pytest
from azure.identity._constants import DEVELOPER_SIGN_ON_CLIENT_ID, EnvironmentVariables
if sys.version_info < (3, 5, 3):
collect_ignore_glob = ["*_async.py"]
def pytest_addoption(parser):
parser.addoption("--manual", action="store_true", default=False, help="run manual tests")
def pytest_configure(config):
config.addinivalue_line("markers", "manual: mark test as requiring manual interaction")
config.addinivalue_line("markers", "prints: mark test as printing important information to stdout")
def pytest_collection_modifyitems(config, items):
stdout_captured = config.getoption("capture") != "no"
run_manual_tests = config.getoption("--manual")
if not stdout_captured and run_manual_tests:
return
# skip manual tests or tests which print to stdout, as appropriate
skip_manual = pytest.mark.skip(reason="run pytest with '--manual' to run manual tests")
skip_prints = pytest.mark.skip(reason="this test prints to stdout, run pytest with '-s' to make output visible")
for test in items:
if not run_manual_tests and "manual" in test.keywords:
test.add_marker(skip_manual)
elif stdout_captured and "prints" in test.keywords:
test.add_marker(skip_prints)
@pytest.fixture()
def live_service_principal(): # pylint:disable=inconsistent-return-statements
"""Fixture for live Identity tests. Skips them when environment configuration is incomplete."""
missing_variables = [
v
for v in (
EnvironmentVariables.AZURE_CLIENT_ID,
EnvironmentVariables.AZURE_CLIENT_SECRET,
EnvironmentVariables.AZURE_TENANT_ID,
)
if not os.environ.get(v)
]
if any(missing_variables):
pytest.skip("Environment has no value for {}".format(missing_variables))
else:
return {
"client_id": os.environ[EnvironmentVariables.AZURE_CLIENT_ID],
"client_secret": os.environ[EnvironmentVariables.AZURE_CLIENT_SECRET],
"tenant_id": os.environ[EnvironmentVariables.AZURE_TENANT_ID],
}
@pytest.fixture()
def live_certificate(live_service_principal): # pylint:disable=inconsistent-return-statements,redefined-outer-name
"""Provides a path to a PEM-encoded certificate with no password"""
pem_content = os.environ.get("PEM_CONTENT")
if not pem_content:
pytest.skip("Expected PEM content in environment variable 'PEM_CONTENT'")
return
pem_path = os.path.join(os.path.dirname(__file__), "certificate.pem")
try:
with open(pem_path, "w") as pem_file:
pem_file.write(pem_content)
return dict(live_service_principal, cert_path=pem_path)
except IOError as ex:
pytest.skip("Failed to write file '{}': {}".format(pem_path, ex))
@pytest.fixture()
def live_certificate_with_password(live_service_principal):
"""Provides a path to a PEM-encoded, password-protected certificate, and its password"""
pem_content = os.environ.get("PEM_CONTENT_PASSWORD_PROTECTED")
password = os.environ.get("CERTIFICATE_PASSWORD")
if not (pem_content and password):
pytest.skip(
"Expected password-protected PEM content in environment variable 'PEM_CONTENT_PASSWORD_PROTECTED'"
+ " and the password in 'CERTIFICATE_PASSWORD'"
)
return
pem_path = os.path.join(os.path.dirname(__file__), "certificate-with-password.pem")
try:
with open(pem_path, "w") as pem_file:
pem_file.write(pem_content)
return dict(live_service_principal, cert_path=pem_path, password=password)
except IOError as ex:
pytest.skip("Failed to write file '{}': {}".format(pem_path, ex))
@pytest.fixture()
def live_user_details():
user_details = {
"client_id": DEVELOPER_SIGN_ON_CLIENT_ID,
"username": os.environ.get(EnvironmentVariables.AZURE_USERNAME),
"password": os.environ.get(EnvironmentVariables.AZURE_PASSWORD),
"tenant": os.environ.get("USER_TENANT"),
}
if None in user_details.values():
pytest.skip("To test username/password authentication, set $AZURE_USERNAME, $AZURE_PASSWORD, $USER_TENANT")
else:
return user_details
@pytest.fixture()
def event_loop():
"""Ensure the event loop used by pytest-asyncio on Windows is ProactorEventLoop, which supports subprocesses.
This is necessary because SelectorEventLoop, which does not support subprocesses, is the default on Python < 3.8.
"""
try:
import asyncio
except:
return
if sys.platform.startswith("win"):
loop = asyncio.ProactorEventLoop()
else:
loop = asyncio.new_event_loop()
yield loop
loop.close()
|