File: conftest.py

package info (click to toggle)
python-azure 20250603%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 851,724 kB
  • sloc: python: 7,362,925; ansic: 804; javascript: 287; makefile: 195; sh: 145; xml: 109
file content (119 lines) | stat: -rw-r--r-- 4,638 bytes parent folder | download
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
# --------------------------------------------------------------------------
#
# Copyright (c) Microsoft Corporation. All rights reserved.
#
# The MIT License (MIT)
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the ""Software""), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
#
# --------------------------------------------------------------------------
import os
import pytest

# In instances where packages do not require azure-sdk-tools we need to make sure that the following imports do not fail.
# This is because this conftest is always activated, and we don't want to fail the pytest run if azure-sdk-tools is not installed.
try:
    from devtools_testutils import environment_variables, recorded_test, test_proxy, variable_recorder
except ImportError:
    print("Failed to import test-proxy fixtures from azure-sdk-tools. If these are necessary, install tools/azure-sdk-tools.")

def pytest_configure(config):
    # register an additional marker
    config.addinivalue_line("markers", "live_test_only: mark test to be a live test only")
    config.addinivalue_line("markers", "playback_test_only: mark test to be a playback test only")


def pytest_runtest_setup(item):
    is_live_only_test_marked = bool([mark for mark in item.iter_markers(name="live_test_only")])
    if is_live_only_test_marked:
        from devtools_testutils import is_live

        if not is_live():
            pytest.skip("live test only")

    is_playback_test_marked = bool([mark for mark in item.iter_markers(name="playback_test_only")])
    if is_playback_test_marked:
        from devtools_testutils import is_live

        if is_live() and os.environ.get("AZURE_SKIP_LIVE_RECORDING", "").lower() == "true":
            pytest.skip("playback test only")


@pytest.fixture(scope="session", autouse=True)
def clean_cached_resources():
    yield
    try:
        from devtools_testutils.preparers import AbstractPreparer
        AbstractPreparer._perform_pending_deletes()
    except ImportError:
        print("Failed to clean up due to missing azure-sdk-tools dependency. \
              For proper cleanup, install the azure-sdk-tools package from this repo.")


@pytest.hookimpl(tryfirst=True, hookwrapper=True)
def pytest_runtest_makereport(item, call) -> None:
    """Captures test exception info and makes it available to other fixtures."""
    # execute all other hooks to obtain the report object
    outcome = yield
    result = outcome.get_result()
    if result.outcome == "failed":
        error = call.excinfo.value
        # set a test_error attribute on the item (available to other fixtures from request.node)
        setattr(item, "test_error", error)


@pytest.fixture(autouse=True)
def reduce_logging_volume(caplog, pytestconfig):
    # Unless specific log level is requested, raise minimum log level in captured call logs to WARNING
    # By default, all INFO-level logs from test execution are printed if tests fail, making output hard to read
    if not (pytestconfig.getoption("log_level") or pytestconfig.getoption("log_cli_level")):
        caplog.set_level(30)
    yield


@pytest.fixture(scope="session")
def patch_async_sleep():
    from unittest import mock
    from devtools_testutils import is_live

    async def immediate_return(_):
        return

    if not is_live():
        with mock.patch("asyncio.sleep", immediate_return):
            yield

    else:
        yield


@pytest.fixture(scope="session")
def patch_sleep():
    from unittest import mock
    from devtools_testutils import is_live

    def immediate_return(_):
        return

    if not is_live():
        with mock.patch("time.sleep", immediate_return):
            yield

    else:
        yield