Newer
Older
from .utils import run_ioc_get_output
RE_MISSING_FILE = "No rule to make target [`']{filename}'"
RE_MISSING_VERSION = "Module '{module}' version '{version}' does not exist."
RE_MODULE_VERSION_EXISTS = "Error .*{module}/{version}.* already exists"
def create_patch_file(path, desc):
path.parent.mkdir(parents=True, exist_ok=True)
patch_file_contents = """
diff --git database.db database.db
index 1806ff6..8701832 100644
--- database.db
+++ database.db
@@ -1,3 +1,3 @@
record(ai, "TEST") {{
f.write(patch_file_contents.format(desc=desc))
db_file_contents = """record(ai, "TEST") {
}
"""
create_patch_file(patch_dir / "apply.p0.patch", "OK")
create_patch_file(patch_dir / MODULE_VERSION / "do-not-apply.p0.patch", "Bad")
rc, _, _ = wrapper.run_make("patch", module_version=MODULE_VERSION)
db_contents = f.read()
assert 'field(DESC, "OK")' in db_contents
rc, _, _ = wrapper.run_make("build", module_version=MODULE_VERSION)
rc, _, _ = wrapper.run_make("cellinstall", module_version=MODULE_VERSION)
assert any((wrapper.path / "cellMods").glob("**/*.db"))
rc, outs, _ = wrapper.run_make(
"init",
module_version=MODULE_VERSION,
)
assert rc == 0
assert "You are in the local source mode" in outs
wrapper.add_var_to_module_makefile("DBDS", "nonexistent.dbd")
assert rc == 2
assert re.search(
RE_MISSING_FILE.format(filename=re.escape("../nonexistent.dbd")),
def test_missing_source_file(wrapper: Wrapper):
wrapper.add_var_to_module_makefile("SOURCES", "nonexistent.c")
assert rc == 2
assert re.search(
RE_MISSING_FILE.format(filename=re.escape("nonexistent.o")),
def test_missing_requirement(wrapper: Wrapper):
assert rc == 0
assert 'Invalid dependency "FOO_DEP_VERSION"; pruning' in errs
def test_missing_dependent_version(wrappers):
wrapper_dep = wrappers.get()
wrapper_main = wrappers.get()
cell_path = wrapper_main.path / "cellMods"
rc, *_ = wrapper_dep.run_make("cellinstall", cell_path=cell_path)
assert rc == 0
missing_version = "not_a_real_version"
wrapper_main.add_var_to_config_module(
f"{wrapper_dep.name}_DEP_VERSION", missing_version
)
rc, _, errs = wrapper_main.run_make("cellbuild")
assert rc == 2
assert re.search(
RE_MISSING_VERSION.format(module=wrapper_dep.name, version=missing_version),
errs,
)
def test_header_install_location(wrapper: Wrapper):
subdir = wrapper.module_dir / "db" / "subdir"
subdir.mkdir(parents=True)
extensions = ["h", "hpp", "hxx", "hh"]
wrapper.add_var_to_module_makefile("HEADERS", f"db/subdir/header.{ext}")
wrapper.add_var_to_module_makefile("KEEP_HEADER_SUBDIRS", "db")
for ext in extensions:
(subdir / f"header.{ext}").touch()
rc, *_ = wrapper.run_make("cellinstall")
cell_path = wrapper.get_env_var("E3_MODULES_INSTALL_LOCATION")
for ext in extensions:
assert (Path(cell_path) / "include" / "subdir" / f"header.{ext}").is_file()
assert not (Path(cell_path) / "include" / f"header.{ext}").is_file()
def test_updated_dependencies(wrappers):
wrapper_dep = wrappers.get()
wrapper_main = wrappers.get()
cell_path = wrapper_main.path / "cellMods"
old_version = "0.0.0+0"
wrapper_main.add_var_to_config_module(
f"{wrapper_dep.name}_DEP_VERSION", old_version, modifier=""
module_version=old_version,
cell_path=cell_path,
rc, *_ = wrapper_main.run_make("cellinstall", module_version=old_version)
assert rc == 0
new_version = "1.0.0+0"
module_version=new_version,
cell_path=cell_path,
wrapper_main.add_var_to_config_module(
f"{wrapper_dep.name}_DEP_VERSION", new_version, modifier=""
rc, *_ = wrapper_main.run_make("cellinstall", module_version=new_version)
wrapper_main.name, new_version, wrapper_main.path / "cellMods"
)
assert rc == 0
assert f"Loaded {wrapper_dep.name} version {new_version}" in outs
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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
def test_match_versions(wrappers):
"""Test match version scenario.
This test checks if inconsistent versions are correctly verified during
build time. This tests if the dependecies B->A->C and B->C with A and B
both requesting the same version of C will be correctly built.
"""
wrapper_dep = wrappers.get()
wrapper_a = wrappers.get()
wrapper_b = wrappers.get()
cell_path = wrapper_b.path / "cellmods"
dep_version = "1.0.0+0"
a_version = "0.0.0+0"
b_version = "0.0.0+0"
# Wrapper a dependes on dep,1.0.0+0
wrapper_a.add_var_to_config_module(
f"{wrapper_dep.name}_DEP_VERSION", dep_version, modifier=""
)
# Wrapper b depends on dep,1.0.0+0
wrapper_b.add_var_to_config_module(
f"{wrapper_dep.name}_DEP_VERSION", dep_version, modifier=""
)
# Wrapper b also depends on a
wrapper_b.add_var_to_config_module(
f"{wrapper_a.name}_DEP_VERSION", a_version, modifier=""
)
rc, *_ = wrapper_dep.run_make(
"cellinstall", module_version=dep_version, cell_path=cell_path
)
assert rc == 0
rc, *_ = wrapper_a.run_make(
"cellinstall", module_version=a_version, cell_path=cell_path
)
assert rc == 0
# As wrappers a and b both depends on dep,1.0.0+0 this build should finish
# corretly.
rc, *_ = wrapper_b.run_make(
"cellinstall", module_version=b_version, cell_path=cell_path
)
assert rc == 0
def test_unmatching_versions(wrappers):
"""Test unmatching version scenarion.
This test checks if inconsistent versions are correctly verified during
build time. This checks for the scenarion where B->A->C and B->C however
A depends on a version of C different than B.
"""
wrapper_dep = wrappers.get()
wrapper_a = wrappers.get()
wrapper_b = wrappers.get()
cell_path = wrapper_b.path / "cellmods"
dep_version_1 = "1.0.0+0"
dep_version_2 = "2.0.0+0"
a_version = "0.0.0+0"
b_version = "0.0.0+0"
# Wrapper a dependes on dep v1
wrapper_a.add_var_to_config_module(
f"{wrapper_dep.name}_DEP_VERSION", dep_version_1, modifier=""
)
# Wrapper b depends on dep v2
wrapper_b.add_var_to_config_module(
f"{wrapper_dep.name}_DEP_VERSION", dep_version_2, modifier=""
)
# Wrapper b also depends on wrapper_a
wrapper_b.add_var_to_config_module(
f"{wrapper_a.name}_DEP_VERSION", a_version, modifier=""
)
rc, *_ = wrapper_dep.run_make(
"cellinstall", module_version=dep_version_1, cell_path=cell_path
)
assert rc == 0
rc, *_ = wrapper_a.run_make(
"cellinstall", module_version=a_version, cell_path=cell_path
)
assert rc == 0
# Now a second installation of wrapper_dep but with version 2
rc, *_ = wrapper_dep.run_make(
"cellinstall", module_version=dep_version_2, cell_path=cell_path
)
assert rc == 0
# This next installation should fail because B depends on A
# that depends on DEP. However A needs DEP 1.0.0+0 and B
# needs DEP 2.0.0+0
rc, *_ = wrapper_b.run_make(
"cellinstall", module_version=b_version, cell_path=cell_path
)
assert rc != 0
def test_indirect_unmatching_versions(wrappers):
"""Test indirect unmatching version scenarion.
This test checks if inconsistend versions are correctly verified during
build time. This checks for the scenarion where B->A->C and B->D->C
however A depends on a version of C different than D.
"""
wrapper_c = wrappers.get()
wrapper_a = wrappers.get()
wrapper_b = wrappers.get()
wrapper_d = wrappers.get()
cell_path = wrapper_b.path / "cellmods"
c_version_a = "1.0.0+0"
c_version_d = "2.0.0+0"
a_version = "0.0.0+0"
d_version = "0.0.0+0"
b_version = "0.0.0+0"
# Wrapper a dependes on c
wrapper_a.add_var_to_config_module(
f"{wrapper_c.name}_DEP_VERSION", c_version_a, modifier=""
)
# Wrapper d dependes on c
wrapper_d.add_var_to_config_module(
f"{wrapper_c.name}_DEP_VERSION", c_version_d, modifier=""
)
# Wrapper b depends on d
wrapper_b.add_var_to_config_module(
f"{wrapper_d.name}_DEP_VERSION", d_version, modifier=""
)
# Wrapper b also depends on a
wrapper_b.add_var_to_config_module(
f"{wrapper_a.name}_DEP_VERSION", a_version, modifier=""
)
rc, *_ = wrapper_c.run_make(
"cellinstall", module_version=c_version_a, cell_path=cell_path
)
assert rc == 0
rc, *_ = wrapper_a.run_make(
"cellinstall", module_version=a_version, cell_path=cell_path
)
assert rc == 0
# Now a second installation of wrapper_dep but with version 2
rc, *_ = wrapper_c.run_make(
"cellinstall", module_version=c_version_d, cell_path=cell_path
)
assert rc == 0
rc, *_ = wrapper_d.run_make(
"cellinstall", module_version=d_version, cell_path=cell_path
)
assert rc == 0
# This next installation should fail because A depends on C
# with a different version that D depends on C.
rc, *_ = wrapper_b.run_make(
"cellinstall", module_version=b_version, cell_path=cell_path
)
assert rc != 0
def test_automated_dependency(wrappers):
wrapper_a = wrappers.get()
wrapper_b = wrappers.get()
cell_path = wrapper_a.path / "cellMods"
module_version = "0.0.0+0"
wrapper_a.add_var_to_config_module(f"{wrapper_b.name}_DEP_VERSION", module_version)
rc, *_ = wrapper_b.run_make(
"cellinstall", module_version=module_version, cell_path=cell_path
)
assert rc == 0
rc, *_ = wrapper_a.run_make(
"cellinstall", module_version=module_version, cell_path=cell_path
)
assert rc == 0
for dep_file in (cell_path / wrapper_a.name).rglob("*.dep"):
with open(dep_file, "r") as f:
contents = f.readlines()
assert len(contents) == 2
assert contents[0].strip() == "# Generated file. Do not edit."
assert f"{wrapper_b.name} {module_version}" == contents[1]
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
def test_architecture_dependent_dependency(wrappers):
wrapper_a = wrappers.get()
wrapper_b = wrappers.get()
wrapper_c = wrappers.get()
cell_path = wrapper_a.path / "cellMods"
module_version = "0.0.0+0"
wrapper_a.add_var_to_config_module(
f"{wrapper_b.name}_DEP_VERSION_linux", module_version
)
wrapper_a.add_var_to_config_module(
f"{wrapper_c.name}_DEP_VERSION_not_an_arch", module_version
)
rc, *_ = wrapper_c.run_make(
"cellinstall", module_version=module_version, cell_path=cell_path
)
assert rc == 0
rc, *_ = wrapper_b.run_make(
"cellinstall", module_version=module_version, cell_path=cell_path
)
assert rc == 0
rc, *_ = wrapper_a.run_make(
"cellinstall", module_version=module_version, cell_path=cell_path
)
assert rc == 0
rc, outs, _ = run_ioc_get_output(
wrapper_a.name, module_version, wrapper_a.path / "cellMods"
)
assert rc == 0
assert f"Loaded {wrapper_b.name} version {module_version}" in outs
assert f"Loaded {wrapper_c.name} version {module_version}" not in outs
def test_recursive_header_include(wrappers):
wrapper_a = wrappers.get()
wrapper_b = wrappers.get()
wrapper_c = wrappers.get()
cell_path = wrapper_a.path / "cellMods"
module_version = "0.0.0+0"
wrapper_b.add_var_to_config_module(f"{wrapper_c.name}_DEP_VERSION", module_version)
wrapper_a.add_var_to_config_module(f"{wrapper_b.name}_DEP_VERSION", module_version)
wrapper_c.add_var_to_module_makefile("HEADERS", f"{wrapper_c.name}.h")
(wrapper_c.module_dir / f"{wrapper_c.name}.h").touch()
wrapper_a.add_var_to_module_makefile("SOURCES", f"{wrapper_a.name}.c")
with open(wrapper_a.module_dir / f"{wrapper_a.name}.c", "w") as f:
f.write(f'#include "{wrapper_c.name}.h"')
rc, *_ = wrapper_c.run_make(
"cellinstall", module_version=module_version, cell_path=cell_path
)
assert rc == 0
rc, *_ = wrapper_b.run_make(
"cellinstall", module_version=module_version, cell_path=cell_path
)
rc, *_ = wrapper_a.run_make(
"cellinstall", module_version=module_version, cell_path=cell_path
)
rc, outs, _ = run_ioc_get_output(
wrapper_a.name, module_version, wrapper_a.path / "cellMods"
)
assert f"Loaded {wrapper_c.name} version {module_version}" in outs
def test_updated_template_files(wrapper: Wrapper):
wrapper.add_var_to_module_makefile("SUBS", "x.substitutions")
substitution_file = wrapper.module_dir / "x.substitutions"
substitution_file.write_text("file x.template {pattern {x} {y}}")
template_file = wrapper.module_dir / "x.template"
base_version = wrapper.get_env_var("EPICS_VERSION_NUMBER")
db_file = wrapper.module_dir / f"O.{base_version}_Common" / "x.db"
rc, *_ = wrapper.run_make("db_internal")
assert rc == 0
rc, *_ = wrapper.run_make("db_internal")
assert rc == 0
"""Test that the automated template/substitution file expansion works."""
wrapper.add_var_to_module_makefile("TMPS", "templates/a.template")
wrapper.add_var_to_module_makefile("SUBS", "b.substitutions")
wrapper.add_var_to_module_makefile("USR_DBFLAGS", "-I templates")
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
template_dir = wrapper.module_dir / "templates"
template_dir.mkdir()
template_file = template_dir / "a.template"
template_file_contents = "record (ai, $(P)) {}"
template_file.write_text(template_file_contents)
substitution_file = wrapper.module_dir / "b.substitutions"
substitution_file.write_text(
"""file "a.template"
{
pattern { P }
{ "$(PREF)" }
}
"""
)
base_version = wrapper.get_env_var("EPICS_VERSION_NUMBER")
common_dir = wrapper.module_dir / f"O.{base_version}_Common"
rc, *_ = wrapper.run_make("db_internal")
assert rc == 0
expanded_template_file = common_dir / "a.db"
assert expanded_template_file.read_text() == template_file_contents
expanded_substitution_file = common_dir / "b.db"
assert expanded_substitution_file.read_text() == template_file_contents.replace(
"$(P)", "$(PREF)"
)
@pytest.mark.parametrize(
"installed_archs, param, expected",
[
("foo bar baz foo-bar", "ARCH_FILTER=foo", ["foo"]),
("foo", "EXCLUDE_ARCHS=foo", []),
("foo-bar foo-baz baz baz-qux", "EXCLUDE_ARCHS=foo", ["baz", "baz-qux"]),
],
)
def test_arch_filter(wrapper: Wrapper, installed_archs, param, expected):
arch_regex = re.compile(r"Pass 2: T_A =\s*([^\s]+)")
"CROSS_COMPILER_TARGET_ARCHS", installed_archs, modifier=""
)
rc, o, _ = wrapper.run_make("debug", param)
assert rc == 0
host_arch = os.getenv("EPICS_HOST_ARCH")
build_archs = [arch for arch in arch_regex.findall(o) if arch != host_arch]
assert build_archs == expected
@pytest.mark.parametrize("archs,failing_arch", [("foo bar", "foo"), ("foo bar", "bar")])
def test_build_fails_if_nth_architecture_fails(wrapper: Wrapper, archs, failing_arch):
# LIBOBJS is determined in part based on configuration data coming from
# $(CONFIG)/os/CONFIG.Common.$(T_A); since our architectures do not actually
# exist, we need to manually define these /before/ driver.makefile is included.
makefile_content = wrapper.module_makefile.read_text()
with open(wrapper.module_makefile, "w") as f:
f.write(
f"""ifeq ($(T_A),{failing_arch})
LIBOBJS = nonexistent_{failing_arch}.o
endif
"""
)
f.write(makefile_content)
wrapper.add_var_to_config_module("OS_CLASS", "Linux")
# Skip the host architecture, we are not testing it.
host_arch = os.getenv("EPICS_HOST_ARCH")
wrapper.add_var_to_module_makefile("EXCLUDE_ARCHS", host_arch)
wrapper.add_var_to_module_makefile(
"CROSS_COMPILER_TARGET_ARCHS", archs, modifier=""
)
wrapper.add_var_to_module_makefile("SOURCES", "-none-")
rc, _, errs = wrapper.run_make("build")
assert rc == 2
assert re.search(
RE_MISSING_FILE.format(filename=re.escape(f"nonexistent_{failing_arch}.o")),
errs,
)
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
def test_double_install_fails(wrapper: Wrapper):
RE_ERR_MOD_VER_EXISTS = ".*{module}/{version}.* already exists"
rc, *_ = wrapper.run_make("install", module_version=MODULE_VERSION)
assert rc == 0
rc, _, errs = wrapper.run_make("install", module_version=MODULE_VERSION)
assert rc == 2
assert re.search(
RE_ERR_MOD_VER_EXISTS.format(
module=re.escape(wrapper.name), version=re.escape(MODULE_VERSION)
),
errs,
)
def test_double_install_test_version_succeeds(wrapper: Wrapper):
RE_WARN_MOD_VER_EXISTS = "Re-installing .*{module}/{version}.*"
test_version = "test"
wrapper.write_dot_local_data("CONFIG_MODULE", {"E3_MODULE_VERSION": test_version})
cell_path = wrapper.get_env_var("E3_MODULES_INSTALL_LOCATION")
wrapper.add_file("header.h")
rc, _, errs = wrapper.run_make("install")
assert rc == 0
assert not re.search(
RE_WARN_MOD_VER_EXISTS.format(
module=re.escape(wrapper.name), version=test_version
),
errs,
)
assert not (Path(cell_path) / "include" / "header.h").is_file()
wrapper.add_var_to_module_makefile("HEADERS", "header.h")
rc, _, errs = wrapper.run_make("install")
assert rc == 0
assert re.search(
RE_WARN_MOD_VER_EXISTS.format(
module=re.escape(wrapper.name), version=test_version
),
errs,
)
assert (Path(cell_path) / "include" / "header.h").is_file()