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
|
# kas - setup tool for bitbake based projects
#
# Copyright (c) Siemens AG, 2019-2024
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
import signal
import pytest
import os
import subprocess
import shutil
from pathlib import Path
from kas import kas
ENVVARS_KAS = [
'KAS_WORK_DIR',
'KAS_BUILD_DIR',
'KAS_REPO_REF_DIR',
'KAS_DISTRO',
'KAS_MACHINE',
'KAS_TARGET',
'KAS_TASK',
'KAS_PREMIRRORS',
'KAS_CLONE_DEPTH',
'KAS_CONTAINER_SCRIPT_VERSION',
'SSH_PRIVATE_KEY',
'SSH_PRIVATE_KEY_FILE',
'SSH_AUTH_SOCK',
'CI_SERVER_HOST',
'CI_JOB_TOKEN',
'CI_PROJECT_DIR',
'GITLAB_CI',
'GITHUB_ACTIONS',
'REMOTE_CONTAINERS'
]
ENVVARS_TOOLS = [
'EMAIL'
]
class KasEnvConfig:
def __init__(self, work_dir: str, build_dir: str):
self.work_dir = work_dir
self.build_dir = build_dir
KAS_OPERATING_DIRS = [
KasEnvConfig(None, None),
KasEnvConfig("kas-work", None),
KasEnvConfig("kas-work", "kas-build"),
]
KAS_OPERATING_IDS = ["noenv", "work", "workbuild"]
# only fan-out offline tests
def pytest_generate_tests(metafunc):
if "monkeykas" not in metafunc.fixturenames:
return
if next(metafunc.definition.iter_markers("dirsfromenv"), None):
metafunc.parametrize("monkeykas",
KAS_OPERATING_DIRS,
ids=KAS_OPERATING_IDS,
indirect=True)
else:
metafunc.parametrize("monkeykas",
[KAS_OPERATING_DIRS[0]],
ids=[KAS_OPERATING_IDS[0]],
indirect=True)
@pytest.fixture(autouse=True)
def prepare_kas_for_tests(monkeypatch):
"""
Patch-out some global logic kas modifies. The strategy is as
following: kas implements the problematic parts as dedicated
functions which we monkeypatch here.
"""
def _register_signal_handlers(loop):
loop.add_signal_handler(signal.SIGTERM, kas.interruption)
# do not handle signal.SIGINT
def _set_global_loglevel(level):
# do not set global log level as this is handled by pytest
pass
monkeypatch.setattr(kas, "register_signal_handlers",
_register_signal_handlers)
monkeypatch.setattr(kas, "set_global_loglevel", _set_global_loglevel)
@pytest.fixture()
def monkeykas(request, monkeypatch, tmpdir):
def get_kas_work_dir():
work_dir = os.environ.get('KAS_WORK_DIR', '.')
return Path(work_dir).absolute()
def get_kas_build_dir():
build_dir = os.environ.get('KAS_BUILD_DIR')
if (not build_dir):
return get_kas_work_dir() / 'build'
return Path(build_dir).absolute()
def move_to_workdir(orig_path):
kas_wd = get_kas_work_dir()
_orig = Path(orig_path)
if not _orig.parent.samefile(kas_wd):
shutil.move(_orig, kas_wd / _orig.basename())
monkeypatch.get_kwd = get_kas_work_dir
monkeypatch.get_kbd = get_kas_build_dir
monkeypatch.move_to_kwd = move_to_workdir
_work_dir = request.param.work_dir
if _work_dir:
workdir = tmpdir / _work_dir
workdir.mkdir()
monkeypatch.setenv('KAS_WORK_DIR', str(workdir))
_build_dir = request.param.build_dir
if _build_dir:
builddir = workdir / _build_dir
builddir.mkdir()
monkeypatch.setenv('KAS_BUILD_DIR', str(builddir))
for var in ENVVARS_KAS + ENVVARS_TOOLS:
monkeypatch.delenv(var, raising=False)
# Set HOME to a temporary directory
homedir = tmpdir / '_home'
homedir.mkdir()
monkeypatch.setenv('HOME', str(homedir))
# remove all VSCode devcontainers related variables
for var in os.environ.keys():
if var.startswith('REMOTE_CONTAINERS_'):
monkeypatch.delenv(var)
# remove all git related variables
for var in os.environ.keys():
if var.startswith('GIT_'):
monkeypatch.delenv(var)
# provide minimal git environment
monkeypatch.setenv('GIT_AUTHOR_NAME', 'kas')
monkeypatch.setenv('GIT_AUTHOR_EMAIL', 'kas@example.com')
monkeypatch.setenv('GIT_COMMITTER_NAME', 'kas')
monkeypatch.setenv('GIT_COMMITTER_EMAIL', 'kas@example.com')
yield monkeypatch
class MercurialRepo:
"""
Create a new Mercurial repository with a single commit.
"""
def __init__(self, tmpdir, name, branch=None):
"""
Creates a new Mercurial repository with a single commit.
The content resembles the Makefile from the hello world example.
"""
self.repo = tmpdir / name
self.repo.mkdir()
subprocess.check_call(['hg', 'init'], cwd=self.repo)
if branch:
subprocess.check_call(['hg', 'branch', branch], cwd=self.repo)
with open(self.repo / 'Makefile', 'w') as f:
f.write('all:\n\techo hello\n')
subprocess.check_call(['hg', 'add', 'Makefile'], cwd=self.repo)
subprocess.check_call(['hg', '--config', 'ui.username=kas',
'commit', '-m', 'initial commit',
'--date', '2024-11-10 08:00'], cwd=self.repo)
def __enter__(self):
return self.repo
def get_commit(self):
return subprocess.check_output(
['hg', 'log', '-r', '.', '--template', '{rev}:{node}'],
cwd=self.repo).decode('utf-8').strip()
def __exit__(self, exc_type, exc_value, traceback):
self.repo.remove()
@pytest.fixture
def mercurial():
def make_hg_repo(tmpdir, name, branch=None):
return MercurialRepo(tmpdir, name, branch)
return make_hg_repo
|
