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
|
# SPDX-License-Identifier: BSD-2-Clause
""" This module provides utility functions. """
# Copyright (C) 2020, 2021 embedded brains GmbH & Co. KG
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
import argparse
import base64
import binascii
import logging
import os
from pathlib import Path
import shutil
import subprocess
from typing import Any, List, Optional, Union
import yaml
def base64_to_hex(data: str) -> str:
""" Converts the data from base64 to hex. """
binary = base64.urlsafe_b64decode(data)
return binascii.hexlify(binary).decode('ascii')
def copy_file(src_file: str, dst_file: str, log_context: str) -> None:
""" Copies the source file to the destination file. """
os.makedirs(os.path.dirname(dst_file), exist_ok=True)
logging.info("%s: copy '%s' to '%s'", log_context, src_file, dst_file)
shutil.copy2(src_file, dst_file)
def copy_files(src_dir: str, dst_dir: str, files: List[str],
log_context: str) -> None:
"""
Copies a list of files in the source directory to the destination
directory preserving the directory of the files relative to the source
directory.
"""
for a_file in files:
src_file = os.path.join(src_dir, a_file)
dst_file = os.path.join(dst_dir, a_file)
os.makedirs(os.path.dirname(dst_file), exist_ok=True)
logging.info("%s: copy '%s' to '%s'", log_context, src_file, dst_file)
shutil.copy2(src_file, dst_file)
def load_config(config_filename: str) -> Any:
""" Loads the configuration file with recursive includes. """
class IncludeLoader(yaml.SafeLoader): # pylint: disable=too-many-ancestors
""" YAML loader customization to process custom include tags. """
_filenames = [config_filename]
def include(self, node):
""" Processes the custom include tag. """
container = IncludeLoader._filenames[0]
dirname = os.path.dirname(container)
filename = os.path.join(dirname, self.construct_scalar(node))
IncludeLoader._filenames.insert(0, filename)
with open(filename, "r", encoding="utf-8") as included_file:
data = yaml.load(included_file, IncludeLoader)
IncludeLoader._filenames.pop()
return data
IncludeLoader.add_constructor("!include", IncludeLoader.include)
with open(config_filename, "r", encoding="utf-8") as config_file:
return yaml.load(config_file.read(), Loader=IncludeLoader)
def run_command(args: List[str],
cwd: Union[str, Path] = ".",
stdout: Optional[List[str]] = None,
env=None) -> int:
"""
Runs the command in a subprocess in the working directory and environment.
Optionally, the standard output of the subprocess is returned. Returns the
exit status of the subprocess.
"""
logging.info("run in '%s': %s", cwd, " ".join(f"'{arg}'" for arg in args))
with subprocess.Popen(args,
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
cwd=cwd,
env=env) as task:
assert task.stdout is not None
while True:
raw_line = task.stdout.readline()
if raw_line:
line = raw_line.decode("utf-8", "ignore").rstrip("\r\n")
if stdout is None:
logging.debug("%s", line)
else:
stdout.append(line)
elif task.poll() is not None:
break
return task.wait()
def create_argument_parser(
default_log_level: str = "INFO") -> argparse.ArgumentParser:
""" Creates an argument parser with default logging options. """
parser = argparse.ArgumentParser()
parser.add_argument(
'--log-level',
choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
type=str.upper,
default=default_log_level,
help="log level")
parser.add_argument('--log-file',
type=str,
default=None,
help="log to this file")
return parser
def init_logging(args: argparse.Namespace) -> None:
""" Initializes the logging module. """
handlers: List[Any] = [logging.StreamHandler()]
if args.log_file is not None:
handlers.append(logging.FileHandler(args.log_file, mode="a"))
logging.basicConfig(level=args.log_level,
datefmt="%Y-%m-%dT%H:%M:%S",
format='%(asctime)s %(levelname)-8s %(message)s',
handlers=handlers)
|
