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
|
"""Script that runs various CLI commands and collects the result for use
in the documentation.
The commands are run in a limited environment (no color, limited width) to
make the output more readable in the documentation.
"""
from __future__ import annotations
import os
import subprocess
import sys
from pathlib import Path
from typing import NamedTuple
from typing import Optional
from typing import Protocol
try:
import tomllib
except ImportError:
import tomli as tomllib
import tomli_w
sys.path.append(Path(__file__).parent.as_posix())
from common import DATA_DIR # noqa: I001
from common import add_path_placeholders
# Set up environment variables for the CLI
env = os.environ.copy()
env["LINES"] = "40"
env["COLUMNS"] = "90" # limit width so it looks nicer in MD code blocks
env["TERM"] = "dumb" # disable color output (color codes mangle it)
class CommandCallback(Protocol):
def __call__(self, output: str) -> str: ...
class Command(NamedTuple):
command: list[str]
filename: str
callback: Optional[CommandCallback] = None
def add_config_bogus_defaults(output: str) -> str:
"""Give bogus defaults to certain config values."""
config = tomllib.loads(output)
# TODO: replace local username with a default value
out = tomli_w.dumps(config)
out = add_path_placeholders(out)
return out
COMMAND_HELP = Command(["zabbix-cli", "--help"], "help.txt")
COMMAND_SAMPLE_CONFIG = Command(
["zabbix-cli", "sample_config"],
"sample_config.toml",
callback=add_config_bogus_defaults,
)
# List of commands to run
COMMANDS = [
COMMAND_HELP,
COMMAND_SAMPLE_CONFIG,
]
def main() -> None:
"""Run the commands and save the output to files."""
for cmd in COMMANDS:
output = subprocess.check_output(cmd.command, env=env).decode("utf-8")
if cmd.callback:
output = cmd.callback(output)
with open(DATA_DIR / cmd.filename, "w") as f:
f.write(output)
if __name__ == "__main__":
main()
|
