-
Notifications
You must be signed in to change notification settings - Fork 1
/
uberenv.py
executable file
·1212 lines (1030 loc) · 49.5 KB
/
uberenv.py
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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
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
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
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
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/bin/sh
"exec" "python" "-u" "-B" "$0" "$@"
###############################################################################
# Copyright (c) 2014-2021, Lawrence Livermore National Security, LLC.
#
# Produced at the Lawrence Livermore National Laboratory
#
# LLNL-CODE-666778
#
# All rights reserved.
#
# This file is part of Conduit.
#
# For details, see https://lc.llnl.gov/conduit/.
#
# Please also read conduit/LICENSE
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions and the disclaimer below.
#
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the disclaimer (as noted below) in the
# documentation and/or other materials provided with the distribution.
#
# * Neither the name of the LLNS/LLNL nor the names of its contributors may
# be used to endorse or promote products derived from this software without
# specific prior written permission.
#
# 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 LAWRENCE LIVERMORE NATIONAL SECURITY,
# LLC, THE U.S. DEPARTMENT OF ENERGY 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.
#
###############################################################################
"""
file: uberenv.py
description: automates using a package manager to install a project.
Uses spack on Unix-based systems and Vcpkg on Windows-based systems.
"""
import os
import sys
import subprocess
import shutil
import socket
import platform
import json
import datetime
import glob
import re
from optparse import OptionParser
from os import environ as env
from os.path import join as pjoin
from os.path import abspath as pabs
def sexe(cmd,ret_output=False,echo=False):
""" Helper for executing shell commands. """
if echo:
print("[exe: {0}]".format(cmd))
if ret_output:
p = subprocess.Popen(cmd,
shell=True,
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT)
out = p.communicate()[0]
out = out.decode('utf8')
return p.returncode,out
else:
return subprocess.call(cmd,shell=True)
def parse_args():
"Parses args from command line"
parser = OptionParser()
parser.add_option("--install",
action="store_true",
dest="install",
default=False,
help="Install `package_name`, not just its dependencies.")
# where to install
parser.add_option("--prefix",
dest="prefix",
default=None,
help="destination directory")
# what compiler to use
parser.add_option("--spec",
dest="spec",
default=None,
help="spack compiler spec")
# for vcpkg, what architecture to target
parser.add_option("--triplet",
dest="vcpkg_triplet",
default=None,
help="vcpkg architecture triplet")
# optional location of spack mirror
parser.add_option("--mirror",
dest="mirror",
default=None,
help="spack mirror directory")
# flag to create mirror
parser.add_option("--create-mirror",
action="store_true",
dest="create_mirror",
default=False,
help="Create spack mirror")
# optional location of spack upstream
parser.add_option("--upstream",
dest="upstream",
default=None,
help="add an external spack instance as upstream")
# this option allows a user to explicitly to select a
# group of spack settings files (compilers.yaml , packages.yaml)
parser.add_option("--spack-config-dir",
dest="spack_config_dir",
default=None,
help="dir with spack settings files (compilers.yaml, packages.yaml, etc)")
# this option allows a user to set the directory for their vcpkg ports on Windows
parser.add_option("--vcpkg-ports-path",
dest="vcpkg_ports_path",
default=None,
help="dir with vckpkg ports")
# overrides package_name
parser.add_option("--package-name",
dest="package_name",
default=None,
help="override the default package name")
# uberenv spack tpl build mode
parser.add_option("--spack-build-mode",
dest="spack_build_mode",
default=None,
help="set mode used to build third party dependencies with spack"
"(options: 'dev-build' 'uberenv-pkg' 'install' "
"[default: 'dev-build'] )\n")
# controls after which package phase spack should stop
parser.add_option("--package-final-phase",
dest="package_final_phase",
default=None,
help="override the default phase after which spack should stop")
# controls source_dir spack should use to build the package
parser.add_option("--package-source-dir",
dest="package_source_dir",
default=None,
help="override the default source dir spack should use")
# a file that holds settings for a specific project
# using uberenv.py
parser.add_option("--project-json",
dest="project_json",
default=pjoin(uberenv_script_dir(),"project.json"),
help="uberenv project settings json file")
# option to explicitly set the number of build jobs
parser.add_option("-j",
dest="build_jobs",
default=None,
help="Explicitly set build jobs")
# flag to use insecure curl + git
parser.add_option("-k",
action="store_true",
dest="ignore_ssl_errors",
default=False,
help="Ignore SSL Errors")
# option to force a pull of the package manager
parser.add_option("--pull",
action="store_true",
dest="repo_pull",
default=False,
help="Pull from package manager, if repo already exists")
# option to force for clean of packages specified to
# be cleaned in the project.json
parser.add_option("--clean",
action="store_true",
dest="spack_clean",
default=False,
help="Force uninstall of packages specified in project.json")
# option to tell spack to run tests
parser.add_option("--run_tests",
action="store_true",
dest="run_tests",
default=False,
help="Invoke build tests during spack install")
# option to init osx sdk env flags
parser.add_option("--macos-sdk-env-setup",
action="store_true",
dest="macos_sdk_env_setup",
default=False,
help="Set several env vars to select OSX SDK settings."
"This was necessary for older versions of macOS "
" but can cause issues with macOS versions >= 10.13. "
" so it is disabled by default.")
# option to stop after spack download and setup
parser.add_option("--setup-only",
action="store_true",
dest="setup_only",
default=False,
help="Only download and setup Spack. No further Spack command will be run.")
###############
# parse args
###############
opts, extras = parser.parse_args()
# we want a dict b/c the values could
# be passed without using optparse
opts = vars(opts)
if opts["spack_config_dir"] is not None:
opts["spack_config_dir"] = pabs(opts["spack_config_dir"])
if not os.path.isdir(opts["spack_config_dir"]):
print("[ERROR: invalid spack config dir: {0} ]".format(opts["spack_config_dir"]))
sys.exit(-1)
# if rel path is given for the mirror, we need to evaluate here -- before any
# chdirs to avoid confusion related to what it is relative to.
# (it should be relative to where uberenv is run from, so it matches what you expect
# from shell completion, etc)
if opts["mirror"] is not None:
if not opts["mirror"].startswith("http") and not os.path.isabs(opts["mirror"]):
opts["mirror"] = pabs(opts["mirror"])
return opts, extras
def pretty_print_dictionary(dictionary):
for key, value in dictionary.items():
print(" {0}: {1}".format(key, value))
def uberenv_script_dir():
# returns the directory of the uberenv.py script
return os.path.dirname(os.path.abspath(__file__))
def load_json_file(json_file):
# reads json file
return json.load(open(json_file))
def is_darwin():
return "darwin" in platform.system().lower()
def is_windows():
return "windows" in platform.system().lower()
def find_project_config(opts):
project_json_file = opts["project_json"]
# Default case: "project.json" seats next to uberenv.py or is given on command line.
if os.path.isfile(project_json_file):
return project_json_file
# Submodule case: Look for ".uberenv_config.json" in current then search parent dirs
else:
lookup_path = pabs(uberenv_script_dir())
end_of_search = False
while not end_of_search:
if os.path.dirname(lookup_path) == lookup_path:
end_of_search = True
project_json_file = pjoin(lookup_path,".uberenv_config.json")
if os.path.isfile(project_json_file):
return project_json_file
else:
lookup_path = pabs(os.path.join(lookup_path, os.pardir))
print("ERROR: No configuration json file found")
sys.exit(-1)
class UberEnv():
""" Base class for package manager """
def __init__(self, opts, extra_opts):
self.opts = opts
self.extra_opts = extra_opts
# load project settings
self.project_opts = load_json_file(opts["project_json"])
# setup main package name
self.pkg_name = self.set_from_args_or_json("package_name")
# Set project.json defaults
if not "force_commandline_prefix" in self.project_opts:
self.project_opts["force_commandline_prefix"] = False
print("[uberenv project settings: ")
pretty_print_dictionary(self.project_opts)
print("]")
print("[uberenv command line options: ")
pretty_print_dictionary(self.opts)
print("]")
def setup_paths_and_dirs(self):
self.uberenv_path = uberenv_script_dir()
# setup destination paths
if not self.opts["prefix"]:
if self.project_opts["force_commandline_prefix"]:
# project has specified prefix must be on command line
print("[ERROR: --prefix flag for library destination is required]")
sys.exit(1)
# otherwise set default
self.opts["prefix"] = "uberenv_libs"
self.dest_dir = pabs(self.opts["prefix"])
# print a warning if the dest path already exists
if not os.path.isdir(self.dest_dir):
os.mkdir(self.dest_dir)
else:
print("[info: destination '{0}' already exists]".format(self.dest_dir))
def set_from_args_or_json(self,setting, optional=True):
"""
When optional=False:
If the setting key is not in the json file, error and raise an exception.
When optional=True:
If the setting key is not in the json file or opts, return None.
"""
setting_value = None
try:
setting_value = self.project_opts[setting]
except (KeyError):
if not optional:
print("ERROR: '{0}' must at least be defined in project.json".format(setting))
raise
if self.opts[setting]:
setting_value = self.opts[setting]
return setting_value
def set_from_json(self,setting, optional=True):
"""
When optional=False:
If the setting key is not in the json file, error and raise an exception.
When optional=True:
If the setting key is not in the json file or opts, return None.
"""
setting_value = None
try:
setting_value = self.project_opts[setting]
except (KeyError):
if not optional:
print("ERROR: '{0}' must at least be defined in project.json".format(setting))
raise
return setting_value
def detect_platform(self):
# find supported sets of compilers.yaml, packages,yaml
res = None
if is_darwin():
res = "darwin"
elif "SYS_TYPE" in os.environ.keys():
sys_type = os.environ["SYS_TYPE"].lower()
res = sys_type
return res
class VcpkgEnv(UberEnv):
""" Helper to clone vcpkg and install libraries on Windows """
def __init__(self, opts, extra_opts):
UberEnv.__init__(self,opts,extra_opts)
# setup architecture triplet
self.vcpkg_triplet = self.set_from_args_or_json("vcpkg_triplet")
print("Vcpkg triplet: {}".format(self.vcpkg_triplet))
if self.vcpkg_triplet is None:
self.vcpkg_triplet = os.getenv("VCPKG_DEFAULT_TRIPLET", "x86-windows")
def setup_paths_and_dirs(self):
# get the current working path, and the glob used to identify the
# package files we want to hot-copy to vcpkg
UberEnv.setup_paths_and_dirs(self)
# Find path to vcpkg ports
_errmsg = ""
if self.opts["vcpkg_ports_path"]:
# Command line option case
self.vcpkg_ports_path = pabs(self.opts["vcpkg_ports_path"])
_errmsg = "Given path for command line option `vcpkg-ports-path` does not exist"
elif "vcpkg_ports_path" in self.project_opts:
# .uberenv_config.json case
new_path = self.project_opts["vcpkg_ports_path"]
if new_path is not None:
self.vcpkg_ports_path = pabs(new_path)
_errmsg = "Given path in config file option 'vcpkg_ports_path' does not exist"
else:
# next to uberenv.py script (backwards compatibility)
self.vcpkg_ports_path = pabs(pjoin(self.uberenv_path, "vcpkg_ports"))
_errmsg = "Could not find any directory for vcpkg ports. " \
"Use either command line option 'vcpkg-ports-path', " \
"config file option 'vcpkg_ports_path', or " \
"defaulted directory 'vcpkg_ports' next to 'uberenv.py'"
if not os.path.isdir(self.vcpkg_ports_path):
print("[ERROR: {0}: {1}]".format(_errmsg, self.vcpkg_ports_path))
sys.exit(1)
# setup path for vcpkg repo
print("[installing to: {0}]".format(self.dest_dir))
self.dest_vcpkg = pjoin(self.dest_dir,"vcpkg")
if os.path.isdir(self.dest_vcpkg):
print("[info: destination '{0}' already exists]".format(self.dest_vcpkg))
def clone_repo(self):
if not os.path.isdir(self.dest_vcpkg):
# compose clone command for the dest path, vcpkg url and branch
vcpkg_branch = self.project_opts.get("vcpkg_branch", "master")
vcpkg_url = self.project_opts.get("vcpkg_url", "https://github.com/microsoft/vcpkg")
print("[info: cloning vcpkg '{0}' branch from {1} into {2}]"
.format(vcpkg_branch,vcpkg_url, self.dest_vcpkg))
os.chdir(self.dest_dir)
clone_opts = ("-c http.sslVerify=false "
if self.opts["ignore_ssl_errors"] else "")
clone_cmd = "git {0} clone --single-branch -b {1} {2} vcpkg".format(clone_opts, vcpkg_branch,vcpkg_url)
sexe(clone_cmd, echo=True)
# optionally, check out a specific commit
if "vcpkg_commit" in self.project_opts:
sha1 = self.project_opts["vcpkg_commit"]
print("[info: using vcpkg commit {0}]".format(sha1))
os.chdir(self.dest_vcpkg)
sexe("git checkout {0}".format(sha1),echo=True)
if self.opts["repo_pull"]:
# do a pull to make sure we have the latest
os.chdir(self.dest_vcpkg)
sexe("git stash", echo=True)
res = sexe("git pull", echo=True)
if res != 0:
#Usually untracked files that would be overwritten
print("[ERROR: Git failed to pull]")
sys.exit(-1)
# Bootstrap vcpkg
os.chdir(self.dest_vcpkg)
print("[info: bootstrapping vcpkg]")
sexe("bootstrap-vcpkg.bat -disableMetrics")
def patch(self):
""" hot-copy our ports into vcpkg """
import distutils.dir_util
dest_vcpkg_ports = pjoin(self.dest_vcpkg, "ports")
print("[info: copying from {0} to {1}]".format(self.vcpkg_ports_path, dest_vcpkg_ports))
distutils.dir_util.copy_tree(self.vcpkg_ports_path, dest_vcpkg_ports)
def clean_build(self):
pass
def show_info(self):
os.chdir(self.dest_vcpkg)
print("[info: Details for package '{0}']".format(self.pkg_name))
sexe("vcpkg.exe search " + self.pkg_name, echo=True)
print("[info: Dependencies for package '{0}']".format(self.pkg_name))
sexe("vcpkg.exe depend-info " + self.pkg_name, echo=True)
def create_mirror(self):
pass
def use_mirror(self):
pass
def install(self):
os.chdir(self.dest_vcpkg)
install_cmd = "vcpkg.exe "
install_cmd += "install {0}:{1}".format(self.pkg_name, self.vcpkg_triplet)
res = sexe(install_cmd, echo=True)
# Running the install_cmd eventually generates the host config file,
# which we copy to the target directory.
src_hc = pjoin(self.dest_vcpkg, "installed", self.vcpkg_triplet, "include", self.pkg_name, "hc.cmake")
hcfg_fname = pjoin(self.dest_dir, "{0}.{1}.cmake".format(platform.uname()[1], self.vcpkg_triplet))
print("[info: copying host config file to {0}]".format(hcfg_fname))
shutil.copy(os.path.abspath(src_hc), hcfg_fname)
print("")
print("[install complete!]")
return res
class SpackEnv(UberEnv):
""" Helper to clone spack and install libraries on MacOS an Linux """
def __init__(self, opts, extra_opts):
UberEnv.__init__(self,opts,extra_opts)
self.pkg_version = self.set_from_json("package_version")
self.pkg_src_dir = self.set_from_args_or_json("package_source_dir", True)
self.pkg_final_phase = self.set_from_args_or_json("package_final_phase",True)
# get build mode
self.build_mode = self.set_from_args_or_json("spack_build_mode",True)
# default spack build mode is dev-build
if self.build_mode is None:
self.build_mode = "dev-build"
# NOTE: install always overrides the build mode to "install"
if self.opts["install"]:
self.build_mode = "install"
# if we are using fake package mode, adjust the pkg name
if self.build_mode == "uberenv-pkg":
self.pkg_name = "uberenv-" + self.pkg_name
print("[uberenv spack build mode: {0}]".format(self.build_mode))
self.packages_paths = []
self.spec_hash = ""
self.use_install = False
if "spack_concretizer" in self.project_opts and self.project_opts["spack_concretizer"] == "clingo":
self.use_clingo = True
self.setup_clingo()
else:
self.use_clingo = False
# Some additional setup for macos
if is_darwin():
if opts["macos_sdk_env_setup"]:
# setup osx deployment target and sdk settings
setup_osx_sdk_env_vars()
else:
print("[skipping MACOSX env var setup]")
# setup default spec
if opts["spec"] is None:
if is_darwin():
# Note: newer spack, for macOS we need to use `apple-clang`
opts["spec"] = "%apple-clang"
else:
opts["spec"] = "%gcc"
self.opts["spec"] = "@{0}{1}".format(self.pkg_version,opts["spec"])
elif not opts["spec"].startswith("@"):
self.opts["spec"] = "@{0}{1}".format(self.pkg_version,opts["spec"])
else:
self.opts["spec"] = "{0}".format(opts["spec"])
print("[spack spec: {0}]".format(self.opts["spec"]))
def print_spack_python_info(self):
spack_dir = self.dest_spack
cmd = pjoin(spack_dir,"bin","spack")
cmd += " python "
cmd += '-c "import sys; print(sys.executable);"'
res, out = sexe( cmd, ret_output = True)
print("[spack python: {0}]".format(out.strip()))
def append_path_to_packages_paths(self, path, errorOnNonexistant=True):
path = pabs(path)
if not os.path.exists(path):
if errorOnNonexistant:
print("[ERROR: Given path in 'spack_packages_path' does not exist: {0}]".format(path))
sys.exit(1)
else:
return
self.packages_paths.append(path)
def setup_paths_and_dirs(self):
# get the current working path, and the glob used to identify the
# package files we want to hot-copy to spack
UberEnv.setup_paths_and_dirs(self)
# Find Spack yaml configs path (compilers.yaml, packages.yaml, etc.)
# Next to uberenv.py (backwards compatility)
spack_configs_path = pabs(pjoin(self.uberenv_path,"spack_configs"))
# In project config file
if "spack_configs_path" in self.project_opts.keys():
new_path = self.project_opts["spack_configs_path"]
if new_path is not None:
spack_configs_path = pabs(new_path)
if not os.path.isdir(spack_configs_path):
print("[ERROR: Given path in 'spack_configs_path' does not exist: {0}]".format(spack_configs_path))
sys.exit(1)
# Test if the override option was used (--spack-config-dir)
self.spack_config_dir = self.opts["spack_config_dir"]
if self.spack_config_dir is None:
# If command line option is not used, search for platform under
# given directory
uberenv_plat = self.detect_platform()
if uberenv_plat is not None:
self.spack_config_dir = pabs(pjoin(spack_configs_path,uberenv_plat))
# Find project level packages to override spack's internal packages
if "spack_packages_path" in self.project_opts.keys():
# packages directories listed in project.json
_paths = self.project_opts["spack_packages_path"]
if not isinstance(_paths, list):
# user gave a single string
self.append_path_to_packages_paths(_paths)
else:
# user gave a list of strings
for _path in _paths:
self.append_path_to_packages_paths(_path)
else:
# default to packages living next to uberenv script if it exists
self.append_path_to_packages_paths(pjoin(self.uberenv_path,"packages"), errorOnNonexistant=False)
print("[installing to: {0}]".format(self.dest_dir))
self.dest_spack = pjoin(self.dest_dir,"spack")
if os.path.isdir(self.dest_spack):
print("[info: destination '{0}' already exists]".format(self.dest_spack))
if self.build_mode == "dev-build":
self.pkg_src_dir = os.path.abspath(os.path.join(self.uberenv_path,self.pkg_src_dir))
if not os.path.isdir(self.pkg_src_dir):
print("[ERROR: package_source_dir '{0}' does not exist]".format(self.pkg_src_dir))
sys.exit(-1)
def find_spack_pkg_path_from_hash(self, pkg_name, pkg_hash):
res, out = sexe("spack/bin/spack find -p /{0}".format(pkg_hash), ret_output = True)
for l in out.split("\n"):
if l.startswith(pkg_name):
return {"name": pkg_name, "path": l.split()[-1]}
print("[ERROR: failed to find package named '{0}']".format(pkg_name))
sys.exit(-1)
def find_spack_pkg_path(self, pkg_name, spec = ""):
res, out = sexe("spack/bin/spack find -p " + pkg_name + spec,ret_output = True)
for l in out.split("\n"):
# TODO: at least print a warning when several choices exist. This will
# pick the first in the list.
if l.startswith(pkg_name):
return {"name": pkg_name, "path": l.split()[-1]}
print("[ERROR: failed to find package named '{0}']".format(pkg_name))
sys.exit(-1)
# Extract the first line of the full spec
def read_spack_full_spec(self,pkg_name,spec):
res, out = sexe("spack/bin/spack spec " + pkg_name + " " + spec, ret_output=True)
for l in out.split("\n"):
if l.startswith(pkg_name) and l.count("@") > 0 and l.count("arch=") > 0:
return l.strip()
def clone_repo(self):
if not os.path.isdir(self.dest_spack):
# compose clone command for the dest path, spack url and branch
print("[info: cloning spack develop branch from github]")
os.chdir(self.dest_dir)
clone_opts = ("-c http.sslVerify=false "
if self.opts["ignore_ssl_errors"] else "")
spack_url = self.project_opts.get("spack_url", "https://github.com/spack/spack.git")
spack_branch = self.project_opts.get("spack_branch", "develop")
clone_cmd = "git {0} clone --single-branch --depth=1 -b {1} {2} spack".format(clone_opts, spack_branch, spack_url)
sexe(clone_cmd, echo=True)
if "spack_commit" in self.project_opts:
# optionally, check out a specific commit
os.chdir(pjoin(self.dest_dir,"spack"))
sha1 = self.project_opts["spack_commit"]
res, current_sha1 = sexe("git log -1 --pretty=%H", ret_output=True)
if sha1 != current_sha1:
print("[info: using spack commit {0}]".format(sha1))
sexe("git stash", echo=True)
sexe("git fetch --depth=1 origin {0}".format(sha1),echo=True)
res = sexe("git checkout {0}".format(sha1),echo=True)
if res != 0:
# Usually untracked files that would be overwritten
print("[ERROR: Git failed to checkout]")
sys.exit(-1)
if self.opts["repo_pull"]:
# do a pull to make sure we have the latest
os.chdir(pjoin(self.dest_dir,"spack"))
sexe("git stash", echo=True)
res = sexe("git pull", echo=True)
if res != 0:
#Usually untracked files that would be overwritten
print("[ERROR: Git failed to pull]")
sys.exit(-1)
def disable_spack_config_scopes(self,spack_dir):
# disables all config scopes except "defaults", which we will
# force our settings into
spack_lib_config = pjoin(spack_dir,"lib","spack","spack","config.py")
print("[disabling config scope (except defaults) in: {0}]".format(spack_lib_config))
cfg_script = open(spack_lib_config).read()
#
# For newer versions of spack, we can use the SPACK_DISABLE_LOCAL_CONFIG
# env var plumbing. We patch it to True to make a permanent change.
#
# Note: This path does not disable the 'site' config, but disabling 'user' config
# is our primary goal.
#
spack_disable_env_stmt = 'disable_local_config = "SPACK_DISABLE_LOCAL_CONFIG" in os.environ'
spack_disable_env_stmt_perm = "disable_local_config = True"
if cfg_script.count(spack_disable_env_stmt) > 0:
cfg_script = cfg_script.replace(spack_disable_env_stmt,
spack_disable_env_stmt_perm)
# path for older versions of spack
elif cfg_script.count(spack_disable_env_stmt_perm) == 0:
for cfg_scope_stmt in ["('system', os.path.join(spack.paths.system_etc_path, 'spack')),",
"('site', os.path.join(spack.paths.etc_path, 'spack')),",
"('user', spack.paths.user_config_path)"]:
cfg_script = cfg_script.replace(cfg_scope_stmt,
"#DISABLED BY UBERENV: " + cfg_scope_stmt)
open(spack_lib_config,"w").write(cfg_script)
def patch(self):
cfg_dir = self.spack_config_dir
spack_dir = self.dest_spack
# this is an opportunity to show spack python info post obtaining spack
self.print_spack_python_info()
# force spack to use only "defaults" config scope
self.disable_spack_config_scopes(spack_dir)
spack_etc_defaults_dir = pjoin(spack_dir,"etc","spack","defaults")
if cfg_dir is not None:
# copy in "defaults" config.yaml
config_yaml = pabs(pjoin(cfg_dir,"..","config.yaml"))
if os.path.isfile(config_yaml):
sexe("cp {0} {1}/".format(config_yaml, spack_etc_defaults_dir), echo=True)
mirrors_yaml = pabs(pjoin(cfg_dir,"..","mirrors.yaml"))
if os.path.isfile(mirrors_yaml):
sexe("cp {0} {1}/".format(mirrors_yaml, spack_etc_defaults_dir), echo=True)
# copy in other settings per platform
print("[copying uberenv compiler and packages settings from {0}]".format(cfg_dir))
config_yaml = pjoin(cfg_dir,"config.yaml")
mirrors_yaml = pjoin(cfg_dir,"mirrors.yaml")
compilers_yaml = pjoin(cfg_dir,"compilers.yaml")
packages_yaml = pjoin(cfg_dir,"packages.yaml")
if os.path.isfile(config_yaml):
sexe("cp {0} {1}/".format(config_yaml , spack_etc_defaults_dir ), echo=True)
if os.path.isfile(mirrors_yaml):
sexe("cp {0} {1}/".format(mirrors_yaml , spack_etc_defaults_dir ), echo=True)
if os.path.isfile(compilers_yaml):
sexe("cp {0} {1}/".format(compilers_yaml, spack_etc_defaults_dir ), echo=True)
if os.path.isfile(packages_yaml):
sexe("cp {0} {1}/".format(packages_yaml, spack_etc_defaults_dir ), echo=True)
else:
# let spack try to auto find compilers
sexe("spack/bin/spack compiler find", echo=True)
# hot-copy our packages into spack
if len(self.packages_paths) > 0:
dest_spack_pkgs = pjoin(spack_dir,"var","spack","repos","builtin","packages")
for _base_path in self.packages_paths:
_src_glob = pjoin(_base_path, "*")
print("[copying patched packages from {0}]".format(_src_glob))
sexe("cp -Rf {0} {1}".format(_src_glob, dest_spack_pkgs))
# Update spack's config.yaml if clingo was requested
if self.use_clingo:
concretizer_cmd = "spack/bin/spack config --scope defaults add config:concretizer:clingo"
res = sexe(concretizer_cmd, echo=True)
if res != 0:
print("[ERROR: Failed to update spack configuration to use new concretizer]")
sys.exit(-1)
def clean_build(self):
# clean out any spack cached stuff (except build stages, downloads, &
# spack's bootstrapping software)
cln_cmd = "spack/bin/spack clean --misc-cache --failures --python-cache"
res = sexe(cln_cmd, echo=True)
# check if we need to force uninstall of selected packages
if self.opts["spack_clean"]:
if self.project_opts.has_key("spack_clean_packages"):
for cln_pkg in self.project_opts["spack_clean_packages"]:
if self.find_spack_pkg_path(cln_pkg) is not None:
unist_cmd = "spack/bin/spack uninstall -f -y --all --dependents " + cln_pkg
res = sexe(unist_cmd, echo=True)
def show_info(self):
# print concretized spec with install info
# default case prints install status and 32 characters hash
options="--install-status --very-long"
spec_cmd = "spack/bin/spack spec {0} {1}{2}".format(options,self.pkg_name,self.opts["spec"])
res, out = sexe(spec_cmd, ret_output=True, echo=True)
print(out)
#Check if spec is already installed
for line in out.split("\n"):
# Example of matching line: ("status" "hash" "package"...)
# [+] hf3cubkgl74ryc3qwen73kl4yfh2ijgd serac@develop%[email protected]~debug~devtools~glvis arch=darwin-mojave-x86_64
if re.match(r"^(\[\+\]| - ) [a-z0-9]{32} " + re.escape(self.pkg_name), line):
self.spec_hash = line.split(" ")[1]
# if spec already installed
if line.startswith("[+]"):
pkg_path = self.find_spack_pkg_path_from_hash(self.pkg_name,self.spec_hash)
install_path = pkg_path["path"]
# testing that the path exists is mandatory until Spack team fixes
# https://github.com/spack/spack/issues/16329
if os.path.isdir(install_path):
print("[Warning: {0} {1} has already been installed in {2}]".format(self.pkg_name, self.opts["spec"],install_path))
print("[Warning: Uberenv will proceed using this directory]".format(self.pkg_name))
self.use_install = True
return res
def install(self):
# use the uberenv package to trigger the right builds
# and build an host-config.cmake file
if not self.use_install:
install_cmd = "spack/bin/spack "
if self.opts["ignore_ssl_errors"]:
install_cmd += "-k "
# build mode -- install path
if self.build_mode == "install":
install_cmd += "install "
if self.opts["run_tests"]:
install_cmd += "--test=root "
# build mode - dev build path
elif self.build_mode == "dev-build":
# dev build path
install_cmd += "dev-build --quiet -d {0} ".format(self.pkg_src_dir)
if self.pkg_final_phase:
install_cmd += "-u {0} ".format(self.pkg_final_phase)
# build mode -- original fake package path
elif self.build_mode == "uberenv-pkg":
install_cmd += "install "
if self.pkg_final_phase:
install_cmd += "-u {0} ".format(self.pkg_final_phase)
else:
print("[ERROR: unsupported build mode: {0}]".format(self.build_mode))
return -1
if self.opts["build_jobs"]:
install_cmd += "-j {0} ".format(self.opts["build_jobs"])
# for all cases we use the pkg name and spec
install_cmd += self.pkg_name + self.opts["spec"]
res = sexe(install_cmd, echo=True)
if res != 0:
print("[ERROR: failure of spack install/dev-build]")
return res
full_spec = self.read_spack_full_spec(self.pkg_name,self.opts["spec"])
if "spack_activate" in self.project_opts:
print("[activating dependent packages]")
# get the full spack spec for our project
pkg_names = self.project_opts["spack_activate"].keys()
for pkg_name in pkg_names:
pkg_spec_requirements = self.project_opts["spack_activate"][pkg_name]
activate=True
for req in pkg_spec_requirements:
if req not in full_spec:
activate=False
break
if activate:
activate_cmd = "spack/bin/spack activate " + pkg_name
res = sexe(activate_cmd, echo=True)
if res != 0:
return res
print("[done activating dependent packages]")
# note: this assumes package extends python when +python
# this may fail general cases
if self.build_mode == "install" and "+python" in full_spec:
activate_cmd = "spack/bin/spack activate /" + self.spec_hash
res = sexe(activate_cmd, echo=True)
if res != 0:
return res
# when using install or uberenv-pkg mode, create a symlink to the host config
if self.build_mode == "install" or \
self.build_mode == "uberenv-pkg" \
or self.use_install:
# use spec_hash to locate b/c other helper won't work if complex
# deps are provided in the spec (e.g: @ver+variant ^package+variant)
pkg_path = self.find_spack_pkg_path_from_hash(self.pkg_name, self.spec_hash)
if self.pkg_name != pkg_path["name"]:
print("[ERROR: Could not find install of {0} with hash {1}]".format(self.pkg_name,self.spec_hash))
return -1
else:
# Symlink host-config file
hc_glob = glob.glob(pjoin(pkg_path["path"],"*.cmake"))
if len(hc_glob) > 0:
hc_path = hc_glob[0]
hc_fname = os.path.split(hc_path)[1]
if os.path.islink(hc_fname):
os.unlink(hc_fname)
elif os.path.isfile(hc_fname):
sexe("rm -f {0}".format(hc_fname))
print("[symlinking host config file to {0}]".format(pjoin(self.dest_dir,hc_fname)))
os.symlink(hc_path,hc_fname)
# if user opt'd for an install, we want to symlink the final
# install to an easy place:
# Symlink install directory
if self.build_mode == "install":
pkg_lnk_dir = "{0}-install".format(self.pkg_name)
if os.path.islink(pkg_lnk_dir):
os.unlink(pkg_lnk_dir)
print("")
print("[symlinking install to {0}]".format(pjoin(self.dest_dir,pkg_lnk_dir)))
os.symlink(pkg_path["path"],pabs(pkg_lnk_dir))
print("")
print("[install complete!]")
elif self.build_mode == "dev-build":
# we are in the "only dependencies" dev build case and the host-config
# file has to be copied from the do-be-deleted spack-build dir.
build_base = pjoin(self.dest_dir,"{0}-build".format(self.pkg_name))
build_dir = pjoin(build_base,"spack-build")
pattern = "*{0}.cmake".format(self.pkg_name)
build_dir = pjoin(self.pkg_src_dir,"spack-build")
hc_glob = glob.glob(pjoin(build_dir,pattern))
if len(hc_glob) > 0:
hc_path = hc_glob[0]
hc_fname = os.path.split(hc_path)[1]
if os.path.islink(hc_fname):
os.unlink(hc_fname)
print("[copying host config file to {0}]".format(pjoin(self.dest_dir,hc_fname)))
sexe("cp {0} {1}".format(hc_path,hc_fname))
print("[removing project build directory {0}]".format(pjoin(build_dir)))
sexe("rm -rf {0}".format(build_dir))
else:
print("[ERROR: Unsupported build mode {0}]".format(self.build_mode))
return -1
def get_mirror_path(self):
mirror_path = self.opts["mirror"]
if not mirror_path:
print("[--create-mirror requires a mirror directory]")
sys.exit(-1)
return mirror_path
def create_mirror(self):
"""
Creates a spack mirror for pkg_name at mirror_path.
"""
mirror_path = self.get_mirror_path()
mirror_cmd = "spack/bin/spack "
if self.opts["ignore_ssl_errors"]:
mirror_cmd += "-k "
mirror_cmd += "mirror create -d {0} --dependencies {1}{2}".format(mirror_path,
self.pkg_name,
self.opts["spec"])
return sexe(mirror_cmd, echo=True)
def find_spack_mirror(self, mirror_name):
"""
Returns the path of a defaults scoped spack mirror with the
given name, or None if no mirror exists.
"""
res, out = sexe("spack/bin/spack mirror list", ret_output=True)
mirror_path = None
for mirror in out.split('\n'):
if mirror:
parts = mirror.split()
if parts[0] == mirror_name:
mirror_path = parts[1]
return mirror_path
def use_mirror(self):