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
|
############################################################################
# Copyright (C) SchedMD LLC.
############################################################################
import inspect
import logging
import os
import pathlib
from py.io import TerminalWriter
import pwd
import pytest
import _pytest
import re
import shutil
import sys
sys.path.append(sys.path[0] + '/lib')
import atf
# Add test description (docstring) as a junit property
def pytest_itemcollected(item):
node = item.obj
desc = node.__doc__.strip() if node.__doc__ else node.__name__
if desc:
item.user_properties.append(("description", desc))
def pytest_addoption(parser):
config_group = parser.getgroup('config mode')
config_group.addoption('--auto-config', action='store_true', help="the slurm configuration will be altered as needed by the test")
config_group.addoption('--local-config', action='store_false', dest='auto_config', help="the slurm configuration will not be altered")
def color_log_level(level, **color_kwargs):
for handler in logging.getLogger().handlers:
if isinstance(handler, _pytest.logging.LogCaptureHandler):
formatter = handler.formatter
if match := formatter.LEVELNAME_FMT_REGEX.search(formatter._fmt):
levelname_fmt = match.group()
formatted_levelname = levelname_fmt % {
'levelname': logging.getLevelName(level)
}
colorized_formatted_levelname = TerminalWriter().markup(
formatted_levelname, **color_kwargs
)
formatter._level_to_fmt_mapping[level] = formatter.LEVELNAME_FMT_REGEX.sub(
colorized_formatted_levelname, formatter._fmt
)
@pytest.fixture(scope="session", autouse=True)
def session_setup(request):
# Set the auto-config property from the option
atf.properties['auto-config'] = request.config.getoption("--auto-config")
# Customize logging level colors
color_log_level(logging.CRITICAL, red=True, bold=True)
color_log_level(logging.ERROR, red=True)
color_log_level(logging.WARNING, yellow=True)
color_log_level(logging.INFO, green=True)
color_log_level(logging.NOTE, cyan=True)
color_log_level(logging.DEBUG, blue=True, bold=True)
color_log_level(logging.TRACE, purple=True, bold=True)
@pytest.fixture(scope="module", autouse=True)
def module_setup(request, tmp_path_factory):
atf.properties['slurm-started'] = False
atf.properties['configurations-modified'] = set()
atf.properties['accounting-database-modified'] = False
atf.properties['orig-environment'] = dict(os.environ)
#print(f"properties = {atf.properties}")
# Creating a module level tmp_path mimicing what tmp_path does
name = request.node.name
name = re.sub(r'[\W]', '_', name)
name = name[:30]
atf.module_tmp_path = tmp_path_factory.mktemp(name, numbered=True)
# Module-level fixtures should run from within the module_tmp_path
os.chdir(atf.module_tmp_path)
# Stop Slurm if using auto-config and Slurm is already running
if atf.properties['auto-config'] and atf.is_slurmctld_running(quiet=True):
logging.warning("Auto-config requires Slurm to be initially stopped but Slurm was found running. Stopping Slurm")
atf.stop_slurm(quiet=True)
yield
# Return to the folder from which pytest was executed
os.chdir(request.config.invocation_dir)
# Teardown
module_teardown()
def module_teardown():
failures = []
if atf.properties['auto-config']:
if atf.properties['slurm-started'] == True:
# Cancel all jobs
if not atf.cancel_all_jobs(quiet=True):
failures.append("Not all jobs were successfully cancelled")
# Stop Slurm if we started it
if not atf.stop_slurm(fatal=False, quiet=True):
failures.append("Not all Slurm daemons were successfully stopped")
# Restore any backed up configuration files
for config in set(atf.properties['configurations-modified']):
atf.restore_config_file(config)
# Restore the Slurm database if modified
if atf.properties['accounting-database-modified']:
atf.restore_accounting_database()
# Restore the prior environment
os.environ.clear()
os.environ.update(atf.properties['orig-environment'])
if failures:
pytest.fail(failures[0])
@pytest.fixture(scope="function", autouse=True)
def function_setup(request, monkeypatch, tmp_path):
# Log function docstring (test description) if present
if request.function.__doc__ is not None:
logging.info(request.function.__doc__)
# Start each test inside the tmp_path
monkeypatch.chdir(tmp_path)
@pytest.fixture(scope="class", autouse=True)
def class_setup(request):
# Log class docstring (test description) if present
if request.cls.__doc__ is not None:
logging.info(request.cls.__doc__)
def pytest_fixture_setup(fixturedef, request):
# Log fixture docstring when invoked if present
if fixturedef.func.__doc__ is not None:
logging.info(fixturedef.func.__doc__)
def pytest_keyboard_interrupt(excinfo):
""" Called for keyboard interrupt """
module_teardown()
|