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
|
"""Record information about tox environments"""
from __future__ import annotations
from typing import Any
from tox.execute import Outcome
class EnvJournal:
"""Report the status of a tox environment"""
def __init__(self, enabled: bool, name: str) -> None:
self._enabled = enabled
self.name = name
self._content: dict[str, Any] = {}
self._executes: list[tuple[str, Outcome]] = []
def __setitem__(self, key: str, value: Any) -> None:
"""
Add a new entry under key into the event journal.
:param key: the key under what to add the data
:param value: the data to add
"""
self._content[key] = value
def __bool__(self) -> bool:
""":return: a flag indicating if the event journal is on or not"""
return self._enabled
def add_execute(self, outcome: Outcome, run_id: str) -> None:
"""
Add a command execution to the journal.
:param outcome: the execution outcome
:param run_id: the execution id
"""
self._executes.append((run_id, outcome))
@property
def content(self) -> dict[str, Any]:
""":return: the env journal content (merges explicit keys and execution commands)"""
tests: list[dict[str, Any]] = []
setup: list[dict[str, Any]] = []
for run_id, outcome in self._executes:
one = {
"command": outcome.cmd,
"output": outcome.out,
"err": outcome.err,
"retcode": outcome.exit_code,
"elapsed": outcome.elapsed,
"show_on_standard": outcome.show_on_standard,
"run_id": run_id,
"start": outcome.start,
"end": outcome.end,
}
if run_id.startswith("commands") or run_id.startswith("build"):
tests.append(one)
else:
setup.append(one)
if tests:
self["test"] = tests
if setup:
self["setup"] = setup
return self._content
__all__ = ("EnvJournal",)
|