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
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
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
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
437
438
439
|
# Copyright 2013-2022 Lawrence Livermore National Security, LLC and other
# Spack Project Developers. See the top-level COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)
import glob
import os
import sys
import py.path
import pytest
import llnl.util.filesystem as fs
import spack.build_systems.autotools
import spack.build_systems.cmake
import spack.environment
import spack.platforms
import spack.repo
from spack.build_environment import ChildError, setup_package
from spack.spec import Spec
from spack.util.executable import which
DATA_PATH = os.path.join(spack.paths.test_path, "data")
pytestmark = pytest.mark.skipif(sys.platform == "win32", reason="does not run on windows")
@pytest.fixture()
def concretize_and_setup(default_mock_concretization):
def _func(spec_str):
s = default_mock_concretization(spec_str)
setup_package(s.package, False)
return s
return _func
@pytest.fixture()
def test_dir(tmpdir):
def _func(dir_str):
py.path.local(dir_str).copy(tmpdir)
return str(tmpdir)
return _func
@pytest.mark.usefixtures("config", "mock_packages", "working_env")
class TestTargets(object):
@pytest.mark.parametrize(
"input_dir", glob.iglob(os.path.join(DATA_PATH, "make", "affirmative", "*"))
)
def test_affirmative_make_check(self, input_dir, test_dir, concretize_and_setup):
"""Tests that Spack correctly detects targets in a Makefile."""
s = concretize_and_setup("mpich")
with fs.working_dir(test_dir(input_dir)):
assert s.package._has_make_target("check")
s.package._if_make_target_execute("check")
@pytest.mark.parametrize(
"input_dir", glob.iglob(os.path.join(DATA_PATH, "make", "negative", "*"))
)
@pytest.mark.regression("9067")
def test_negative_make_check(self, input_dir, test_dir, concretize_and_setup):
"""Tests that Spack correctly ignores false positives in a Makefile."""
s = concretize_and_setup("mpich")
with fs.working_dir(test_dir(input_dir)):
assert not s.package._has_make_target("check")
s.package._if_make_target_execute("check")
@pytest.mark.skipif(not which("ninja"), reason="ninja is not installed")
@pytest.mark.parametrize(
"input_dir", glob.iglob(os.path.join(DATA_PATH, "ninja", "affirmative", "*"))
)
def test_affirmative_ninja_check(self, input_dir, test_dir, concretize_and_setup):
"""Tests that Spack correctly detects targets in a Ninja build script."""
s = concretize_and_setup("mpich")
with fs.working_dir(test_dir(input_dir)):
assert s.package._has_ninja_target("check")
s.package._if_ninja_target_execute("check")
@pytest.mark.skipif(not which("ninja"), reason="ninja is not installed")
@pytest.mark.parametrize(
"input_dir", glob.iglob(os.path.join(DATA_PATH, "ninja", "negative", "*"))
)
def test_negative_ninja_check(self, input_dir, test_dir, concretize_and_setup):
"""Tests that Spack correctly ignores false positives in a Ninja
build script.
"""
s = concretize_and_setup("mpich")
with fs.working_dir(test_dir(input_dir)):
assert not s.package._has_ninja_target("check")
s.package._if_ninja_target_execute("check")
@pytest.mark.usefixtures("config", "mock_packages")
class TestAutotoolsPackage(object):
def test_with_or_without(self, default_mock_concretization):
s = default_mock_concretization("a")
options = s.package.with_or_without("foo")
# Ensure that values that are not representing a feature
# are not used by with_or_without
assert "--without-none" not in options
assert "--with-bar" in options
assert "--without-baz" in options
assert "--no-fee" in options
def activate(value):
return "something"
options = s.package.with_or_without("foo", activation_value=activate)
assert "--without-none" not in options
assert "--with-bar=something" in options
assert "--without-baz" in options
assert "--no-fee" in options
options = s.package.enable_or_disable("foo")
assert "--disable-none" not in options
assert "--enable-bar" in options
assert "--disable-baz" in options
assert "--disable-fee" in options
options = s.package.with_or_without("bvv")
assert "--with-bvv" in options
options = s.package.with_or_without("lorem-ipsum", variant="lorem_ipsum")
assert "--without-lorem-ipsum" in options
def test_none_is_allowed(self, default_mock_concretization):
s = default_mock_concretization("a foo=none")
options = s.package.with_or_without("foo")
# Ensure that values that are not representing a feature
# are not used by with_or_without
assert "--with-none" not in options
assert "--without-bar" in options
assert "--without-baz" in options
assert "--no-fee" in options
def test_libtool_archive_files_are_deleted_by_default(
self, default_mock_concretization, mutable_database
):
# Install a package that creates a mock libtool archive
s = default_mock_concretization("libtool-deletion")
s.package.do_install(explicit=True)
# Assert the libtool archive is not there and we have
# a log of removed files
assert not os.path.exists(s.package.builder.libtool_archive_file)
search_directory = os.path.join(s.prefix, ".spack")
libtool_deletion_log = fs.find(search_directory, "removed_la_files.txt", recursive=True)
assert libtool_deletion_log
def test_libtool_archive_files_might_be_installed_on_demand(
self, mutable_database, monkeypatch, default_mock_concretization
):
# Install a package that creates a mock libtool archive,
# patch its package to preserve the installation
s = default_mock_concretization("libtool-deletion")
monkeypatch.setattr(type(s.package.builder), "install_libtool_archives", True)
s.package.do_install(explicit=True)
# Assert libtool archives are installed
assert os.path.exists(s.package.builder.libtool_archive_file)
def test_autotools_gnuconfig_replacement(self, default_mock_concretization, mutable_database):
"""
Tests whether only broken config.sub and config.guess are replaced with
files from working alternatives from the gnuconfig package.
"""
s = default_mock_concretization(
"autotools-config-replacement +patch_config_files +gnuconfig"
)
s.package.do_install()
with open(os.path.join(s.prefix.broken, "config.sub")) as f:
assert "gnuconfig version of config.sub" in f.read()
with open(os.path.join(s.prefix.broken, "config.guess")) as f:
assert "gnuconfig version of config.guess" in f.read()
with open(os.path.join(s.prefix.working, "config.sub")) as f:
assert "gnuconfig version of config.sub" not in f.read()
with open(os.path.join(s.prefix.working, "config.guess")) as f:
assert "gnuconfig version of config.guess" not in f.read()
def test_autotools_gnuconfig_replacement_disabled(
self, default_mock_concretization, mutable_database
):
"""
Tests whether disabling patch_config_files
"""
s = default_mock_concretization(
"autotools-config-replacement ~patch_config_files +gnuconfig"
)
s.package.do_install()
with open(os.path.join(s.prefix.broken, "config.sub")) as f:
assert "gnuconfig version of config.sub" not in f.read()
with open(os.path.join(s.prefix.broken, "config.guess")) as f:
assert "gnuconfig version of config.guess" not in f.read()
with open(os.path.join(s.prefix.working, "config.sub")) as f:
assert "gnuconfig version of config.sub" not in f.read()
with open(os.path.join(s.prefix.working, "config.guess")) as f:
assert "gnuconfig version of config.guess" not in f.read()
@pytest.mark.disable_clean_stage_check
def test_autotools_gnuconfig_replacement_no_gnuconfig(self, mutable_database, monkeypatch):
"""
Tests whether a useful error message is shown when patch_config_files is
enabled, but gnuconfig is not listed as a direct build dependency.
"""
monkeypatch.setattr(spack.platforms.test.Test, "default", "x86_64")
s = Spec("autotools-config-replacement +patch_config_files ~gnuconfig")
s.concretize()
msg = "Cannot patch config files: missing dependencies: gnuconfig"
with pytest.raises(ChildError, match=msg):
s.package.do_install()
@pytest.mark.disable_clean_stage_check
def test_broken_external_gnuconfig(self, mutable_database, tmpdir):
"""
Tests whether we get a useful error message when gnuconfig is marked
external, but the install prefix is misconfigured and no config.guess
and config.sub substitute files are found in the provided prefix.
"""
env_dir = str(tmpdir.ensure("env", dir=True))
gnuconfig_dir = str(tmpdir.ensure("gnuconfig", dir=True)) # empty dir
with open(os.path.join(env_dir, "spack.yaml"), "w") as f:
f.write(
"""\
spack:
specs:
- 'autotools-config-replacement +patch_config_files +gnuconfig'
packages:
gnuconfig:
buildable: false
externals:
- spec: gnuconfig@1.0.0
prefix: {0}
""".format(
gnuconfig_dir
)
)
msg = "Spack could not find `config.guess`.*misconfigured as an " "external package"
with spack.environment.Environment(env_dir) as e:
e.concretize()
with pytest.raises(ChildError, match=msg):
e.install_all()
@pytest.mark.usefixtures("config", "mock_packages")
class TestCMakePackage(object):
def test_cmake_std_args(self, default_mock_concretization):
# Call the function on a CMakePackage instance
s = default_mock_concretization("cmake-client")
expected = spack.build_systems.cmake.CMakeBuilder.std_args(s.package)
assert s.package.builder.std_cmake_args == expected
# Call it on another kind of package
s = default_mock_concretization("mpich")
assert spack.build_systems.cmake.CMakeBuilder.std_args(s.package)
def test_cmake_bad_generator(self, monkeypatch, default_mock_concretization):
s = default_mock_concretization("cmake-client")
monkeypatch.setattr(type(s.package), "generator", "Yellow Sticky Notes", raising=False)
with pytest.raises(spack.package_base.InstallError):
s.package.builder.std_cmake_args
def test_cmake_secondary_generator(self, default_mock_concretization):
s = default_mock_concretization("cmake-client")
s.package.generator = "CodeBlocks - Unix Makefiles"
assert s.package.builder.std_cmake_args
def test_define(self, default_mock_concretization):
s = default_mock_concretization("cmake-client")
define = s.package.define
for cls in (list, tuple):
assert define("MULTI", cls(["right", "up"])) == "-DMULTI:STRING=right;up"
file_list = fs.FileList(["/foo", "/bar"])
assert define("MULTI", file_list) == "-DMULTI:STRING=/foo;/bar"
assert define("ENABLE_TRUTH", False) == "-DENABLE_TRUTH:BOOL=OFF"
assert define("ENABLE_TRUTH", True) == "-DENABLE_TRUTH:BOOL=ON"
assert define("SINGLE", "red") == "-DSINGLE:STRING=red"
def test_define_from_variant(self):
s = Spec("cmake-client multi=up,right ~truthy single=red").concretized()
arg = s.package.define_from_variant("MULTI")
assert arg == "-DMULTI:STRING=right;up"
arg = s.package.define_from_variant("ENABLE_TRUTH", "truthy")
assert arg == "-DENABLE_TRUTH:BOOL=OFF"
arg = s.package.define_from_variant("SINGLE")
assert arg == "-DSINGLE:STRING=red"
with pytest.raises(KeyError, match="not a variant"):
s.package.define_from_variant("NONEXISTENT")
@pytest.mark.usefixtures("config", "mock_packages")
class TestDownloadMixins(object):
"""Test GnuMirrorPackage, SourceforgePackage, SourcewarePackage and XorgPackage."""
@pytest.mark.parametrize(
"spec_str,expected_url",
[
# GnuMirrorPackage
("mirror-gnu", "https://ftpmirror.gnu.org/make/make-4.2.1.tar.gz"),
# SourceforgePackage
("mirror-sourceforge", "https://prdownloads.sourceforge.net/tcl/tcl8.6.5-src.tar.gz"),
# SourcewarePackage
("mirror-sourceware", "https://sourceware.org/pub/bzip2/bzip2-1.0.8.tar.gz"),
# XorgPackage
(
"mirror-xorg",
"https://www.x.org/archive/individual/util/util-macros-1.19.1.tar.bz2",
),
],
)
def test_attributes_defined(self, default_mock_concretization, spec_str, expected_url):
s = default_mock_concretization(spec_str)
assert s.package.urls[0] == expected_url
@pytest.mark.parametrize(
"spec_str,error_fmt",
[
# GnuMirrorPackage
("mirror-gnu-broken", r"{0} must define a `gnu_mirror_path` attribute"),
# SourceforgePackage
(
"mirror-sourceforge-broken",
r"{0} must define a `sourceforge_mirror_path` attribute",
),
# SourcewarePackage
("mirror-sourceware-broken", r"{0} must define a `sourceware_mirror_path` attribute"),
# XorgPackage
("mirror-xorg-broken", r"{0} must define a `xorg_mirror_path` attribute"),
],
)
def test_attributes_missing(self, default_mock_concretization, spec_str, error_fmt):
s = default_mock_concretization(spec_str)
error_msg = error_fmt.format(type(s.package).__name__)
with pytest.raises(AttributeError, match=error_msg):
s.package.urls
def test_cmake_define_from_variant_conditional(default_mock_concretization):
"""Test that define_from_variant returns empty string when a condition on a variant
is not met. When this is the case, the variant is not set in the spec."""
s = default_mock_concretization("cmake-conditional-variants-test")
assert "example" not in s.variants
assert s.package.define_from_variant("EXAMPLE", "example") == ""
def test_autotools_args_from_conditional_variant(default_mock_concretization):
"""Test that _activate_or_not returns an empty string when a condition on a variant
is not met. When this is the case, the variant is not set in the spec."""
s = default_mock_concretization("autotools-conditional-variants-test")
assert "example" not in s.variants
assert len(s.package.builder._activate_or_not("example", "enable", "disable")) == 0
def test_autoreconf_search_path_args_multiple(default_mock_concretization, tmpdir):
"""autoreconf should receive the right -I flags with search paths for m4 files
for build deps."""
spec = default_mock_concretization("dttop")
aclocal_fst = str(tmpdir.mkdir("fst").mkdir("share").mkdir("aclocal"))
aclocal_snd = str(tmpdir.mkdir("snd").mkdir("share").mkdir("aclocal"))
build_dep_one, build_dep_two = spec.dependencies(deptype="build")
build_dep_one.prefix = str(tmpdir.join("fst"))
build_dep_two.prefix = str(tmpdir.join("snd"))
assert spack.build_systems.autotools._autoreconf_search_path_args(spec) == [
"-I",
aclocal_fst,
"-I",
aclocal_snd,
]
def test_autoreconf_search_path_args_skip_automake(default_mock_concretization, tmpdir):
"""automake's aclocal dir should not be added as -I flag as it is a default
3rd party dir search path, and if it's a system version it usually includes
m4 files shadowing spack deps."""
spec = default_mock_concretization("dttop")
tmpdir.mkdir("fst").mkdir("share").mkdir("aclocal")
aclocal_snd = str(tmpdir.mkdir("snd").mkdir("share").mkdir("aclocal"))
build_dep_one, build_dep_two = spec.dependencies(deptype="build")
build_dep_one.name = "automake"
build_dep_one.prefix = str(tmpdir.join("fst"))
build_dep_two.prefix = str(tmpdir.join("snd"))
assert spack.build_systems.autotools._autoreconf_search_path_args(spec) == ["-I", aclocal_snd]
def test_autoreconf_search_path_args_external_order(default_mock_concretization, tmpdir):
"""When a build dep is external, its -I flag should occur last"""
spec = default_mock_concretization("dttop")
aclocal_fst = str(tmpdir.mkdir("fst").mkdir("share").mkdir("aclocal"))
aclocal_snd = str(tmpdir.mkdir("snd").mkdir("share").mkdir("aclocal"))
build_dep_one, build_dep_two = spec.dependencies(deptype="build")
build_dep_one.external_path = str(tmpdir.join("fst"))
build_dep_two.prefix = str(tmpdir.join("snd"))
assert spack.build_systems.autotools._autoreconf_search_path_args(spec) == [
"-I",
aclocal_snd,
"-I",
aclocal_fst,
]
def test_autoreconf_search_path_skip_nonexisting(default_mock_concretization, tmpdir):
"""Skip -I flags for non-existing directories"""
spec = default_mock_concretization("dttop")
build_dep_one, build_dep_two = spec.dependencies(deptype="build")
build_dep_one.prefix = str(tmpdir.join("fst"))
build_dep_two.prefix = str(tmpdir.join("snd"))
assert spack.build_systems.autotools._autoreconf_search_path_args(spec) == []
def test_autoreconf_search_path_dont_repeat(default_mock_concretization, tmpdir):
"""Do not add the same -I flag twice to keep things readable for humans"""
spec = default_mock_concretization("dttop")
aclocal = str(tmpdir.mkdir("prefix").mkdir("share").mkdir("aclocal"))
build_dep_one, build_dep_two = spec.dependencies(deptype="build")
build_dep_one.external_path = str(tmpdir.join("prefix"))
build_dep_two.external_path = str(tmpdir.join("prefix"))
assert spack.build_systems.autotools._autoreconf_search_path_args(spec) == ["-I", aclocal]
|