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
|
# -*- coding: utf-8 eval: (blacken-mode 1) -*-
# SPDX-License-Identifier: GPL-2.0-or-later
#
# April 22 2022, Christian Hopps <chopps@gmail.com>
#
# Copyright (c) 2022, LabN Consulting, L.L.C
#
"""A module that implements pytest hooks.
To use in your project, in your conftest.py add:
from munet.testing.hooks import *
"""
import logging
import os
import sys
import traceback
import pytest
from ..base import BaseMunet # pylint: disable=import-error
from ..cli import cli # pylint: disable=import-error
from .util import pause_test
# ===================
# Hooks (non-fixture)
# ===================
def pytest_addoption(parser):
parser.addoption(
"--cli-on-error",
action="store_true",
help="CLI on test failure",
)
parser.addoption(
"--coverage",
action="store_true",
help="Enable coverage gathering if supported",
)
parser.addoption(
"--gdb",
default="",
metavar="HOST[,HOST...]",
help="Comma-separated list of nodes to launch gdb on, or 'all'",
)
parser.addoption(
"--gdb-breakpoints",
default="",
metavar="BREAKPOINT[,BREAKPOINT...]",
help="Comma-separated list of breakpoints",
)
parser.addoption(
"--gdb-use-emacs",
action="store_true",
help="Use emacsclient to run gdb instead of a shell",
)
parser.addoption(
"--pcap",
default="",
metavar="NET[,NET...]",
help="Comma-separated list of networks to capture packets on, or 'all'",
)
parser.addoption(
"--pause",
action="store_true",
help="Pause after each test",
)
parser.addoption(
"--pause-at-end",
action="store_true",
help="Pause before taking munet down",
)
parser.addoption(
"--pause-on-error",
action="store_true",
help="Pause after (disables default when --shell or -vtysh given)",
)
parser.addoption(
"--no-pause-on-error",
dest="pause_on_error",
action="store_false",
help="Do not pause after (disables default when --shell or -vtysh given)",
)
parser.addoption(
"--shell",
default="",
metavar="NODE[,NODE...]",
help="Comma-separated list of nodes to spawn shell on, or 'all'",
)
parser.addoption(
"--stdout",
default="",
metavar="NODE[,NODE...]",
help="Comma-separated list of nodes to open tail-f stdout window on, or 'all'",
)
parser.addoption(
"--stderr",
default="",
metavar="NODE[,NODE...]",
help="Comma-separated list of nodes to open tail-f stderr window on, or 'all'",
)
def pytest_configure(config):
if "PYTEST_XDIST_WORKER" not in os.environ:
os.environ["PYTEST_XDIST_MODE"] = config.getoption("dist", "no")
os.environ["PYTEST_IS_WORKER"] = ""
is_xdist = os.environ["PYTEST_XDIST_MODE"] != "no"
is_worker = False
else:
os.environ["PYTEST_IS_WORKER"] = os.environ["PYTEST_XDIST_WORKER"]
is_xdist = True
is_worker = True
# Turn on live logging if user specified verbose and the config has a CLI level set
if config.getoption("--verbose") and not is_xdist and not config.getini("log_cli"):
if config.getoption("--log-cli-level", None) is None:
# By setting the CLI option to the ini value it enables log_cli=1
cli_level = config.getini("log_cli_level")
if cli_level is not None:
config.option.log_cli_level = cli_level
have_tmux = bool(os.getenv("TMUX", ""))
have_screen = not have_tmux and bool(os.getenv("STY", ""))
have_xterm = not have_tmux and not have_screen and bool(os.getenv("DISPLAY", ""))
have_windows = have_tmux or have_screen or have_xterm
have_windows_pause = have_tmux or have_xterm
xdist_no_windows = is_xdist and not is_worker and not have_windows_pause
for winopt in ["--shell", "--stdout", "--stderr"]:
b = config.getoption(winopt)
if b and xdist_no_windows:
pytest.exit(
f"{winopt} use requires byobu/TMUX/XTerm "
f"under dist {os.environ['PYTEST_XDIST_MODE']}"
)
elif b and not is_xdist and not have_windows:
pytest.exit(f"{winopt} use requires byobu/TMUX/SCREEN/XTerm")
def pytest_runtest_makereport(item, call):
"""Pause or invoke CLI as directed by config."""
isatty = sys.stdout.isatty()
pause = bool(item.config.getoption("--pause"))
skipped = False
if call.excinfo is None:
error = False
elif call.excinfo.typename == "Skipped":
skipped = True
error = False
pause = False
else:
error = True
modname = item.parent.module.__name__
exval = call.excinfo.value
logging.error(
"test %s/%s failed: %s: stdout: '%s' stderr: '%s'",
modname,
item.name,
exval,
exval.stdout if hasattr(exval, "stdout") else "NA",
exval.stderr if hasattr(exval, "stderr") else "NA",
)
if not pause:
pause = item.config.getoption("--pause-on-error")
if error and isatty and item.config.getoption("--cli-on-error"):
if not BaseMunet.g_unet:
logging.error("Could not launch CLI b/c no munet exists yet")
else:
print(f"\nCLI-ON-ERROR: {call.excinfo.typename}")
print(f"CLI-ON-ERROR:\ntest {modname}/{item.name} failed: {exval}")
if hasattr(exval, "stdout") and exval.stdout:
print("stdout: " + exval.stdout.replace("\n", "\nstdout: "))
if hasattr(exval, "stderr") and exval.stderr:
print("stderr: " + exval.stderr.replace("\n", "\nstderr: "))
cli(BaseMunet.g_unet)
if pause:
if skipped:
item.skip_more_pause = True
elif hasattr(item, "skip_more_pause"):
pass
elif call.when == "setup":
if error:
item.skip_more_pause = True
# we can't asyncio.run() (which pause does) if we are not unhsare_inline
# at this point, count on an autouse fixture to pause instead in this
# case
if BaseMunet.g_unet and BaseMunet.g_unet.unshare_inline:
pause_test(f"before test '{item.nodeid}'")
# check for a result to try and catch setup (or module setup) failure
# e.g., after a module level fixture fails, we do not want to pause on every
# skipped test.
elif call.when == "teardown" and call.excinfo:
logging.warning(
"Caught exception during teardown: %s\n:Traceback:\n%s",
call.excinfo,
"".join(traceback.format_tb(call.excinfo.tb)),
)
pause_test(f"after teardown after test '{item.nodeid}'")
elif call.when == "teardown" and call.result:
pause_test(f"after test '{item.nodeid}'")
elif error:
item.skip_more_pause = True
print(f"\nPAUSE-ON-ERROR: {call.excinfo.typename}")
print(f"PAUSE-ON-ERROR:\ntest {modname}/{item.name} failed: {exval}")
if hasattr(exval, "stdout") and exval.stdout:
print("stdout: " + exval.stdout.replace("\n", "\nstdout: "))
if hasattr(exval, "stderr") and exval.stderr:
print("stderr: " + exval.stderr.replace("\n", "\nstderr: "))
pause_test(f"PAUSE-ON-ERROR: '{item.nodeid}'")
|
