summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorrobgics <32717310+robgics@users.noreply.github.com>2022-05-18 21:26:42 -0400
committerGitHub <noreply@github.com>2022-05-18 18:26:42 -0700
commit1f6b880fffb161016e81da03fb06e5553bb74c09 (patch)
tree8fcdfeb4431511b139679a1212a5e80c7ccc437d /lib
parent2c211d95ee7257d9ca258fac4f6ccb0f56d63e39 (diff)
downloadspack-1f6b880fffb161016e81da03fb06e5553bb74c09.tar.gz
spack-1f6b880fffb161016e81da03fb06e5553bb74c09.tar.bz2
spack-1f6b880fffb161016e81da03fb06e5553bb74c09.tar.xz
spack-1f6b880fffb161016e81da03fb06e5553bb74c09.zip
Add license dir to config (#30135)
* Change license dir from hard-coded to a configurable item * Change config item to be a string not an array Co-authored-by: Todd Gamblin <tgamblin@llnl.gov>
Diffstat (limited to 'lib')
-rw-r--r--lib/spack/spack/config.py5
-rw-r--r--lib/spack/spack/package.py16
-rw-r--r--lib/spack/spack/paths.py6
-rw-r--r--lib/spack/spack/schema/config.py1
-rw-r--r--lib/spack/spack/test/bindist.py10
-rw-r--r--lib/spack/spack/test/cmd/external.py2
-rw-r--r--lib/spack/spack/test/config.py14
-rw-r--r--lib/spack/spack/test/conftest.py2
8 files changed, 40 insertions, 16 deletions
diff --git a/lib/spack/spack/config.py b/lib/spack/spack/config.py
index 2761be01ed..ce90ed231e 100644
--- a/lib/spack/spack/config.py
+++ b/lib/spack/spack/config.py
@@ -88,7 +88,7 @@ all_schemas.update(dict((key, spack.schema.env.schema)
#: Path to the default configuration
configuration_defaults_path = (
- 'defaults', os.path.join(spack.paths.etc_path, 'spack', 'defaults')
+ 'defaults', os.path.join(spack.paths.etc_path, 'defaults')
)
#: Hard-coded default values for some key configuration options.
@@ -104,6 +104,7 @@ config_defaults = {
'build_jobs': min(16, cpus_available()),
'build_stage': '$tempdir/spack-stage',
'concretizer': 'clingo',
+ 'license_dir': spack.paths.default_license_dir,
}
}
@@ -815,7 +816,7 @@ def _config():
# Site configuration is per spack instance, for sites or projects
# No site-level configs should be checked into spack by default.
configuration_paths.append(
- ('site', os.path.join(spack.paths.etc_path, 'spack')),
+ ('site', os.path.join(spack.paths.etc_path)),
)
# User configuration can override both spack defaults and site config
diff --git a/lib/spack/spack/package.py b/lib/spack/spack/package.py
index 1ca619b974..549c71f52b 100644
--- a/lib/spack/spack/package.py
+++ b/lib/spack/spack/package.py
@@ -53,6 +53,7 @@ import spack.repo
import spack.store
import spack.url
import spack.util.environment
+import spack.util.path
import spack.util.web
from spack.filesystem_view import YamlFilesystemView
from spack.install_test import TestFailure, TestSuite
@@ -60,7 +61,6 @@ from spack.installer import InstallError, PackageInstaller
from spack.stage import ResourceStage, Stage, StageComposite, stage_prefix
from spack.util.executable import ProcessError, which
from spack.util.package_hash import package_hash
-from spack.util.path import win_exe_ext
from spack.util.prefix import Prefix
from spack.version import Version
@@ -200,9 +200,9 @@ class DetectablePackageMeta(object):
def platform_executables(self):
def to_windows_exe(exe):
if exe.endswith('$'):
- exe = exe.replace('$', '%s$' % win_exe_ext())
+ exe = exe.replace('$', '%s$' % spack.util.path.win_exe_ext())
else:
- exe += win_exe_ext()
+ exe += spack.util.path.win_exe_ext()
return exe
plat_exe = []
if hasattr(self, 'executables'):
@@ -438,6 +438,11 @@ class PackageMeta(
self._name = self._name[self._name.rindex('.') + 1:]
return self._name
+ @property
+ def global_license_dir(self):
+ """Returns the directory where license files for all packages are stored."""
+ return spack.util.path.canonicalize_path(spack.config.get('config:license_dir'))
+
def run_before(*phases):
"""Registers a method of a package to be run before a given phase"""
@@ -938,9 +943,8 @@ class PackageBase(six.with_metaclass(PackageMeta, PackageViewMixin, object)):
@property
def global_license_dir(self):
- """Returns the directory where global license files for all
- packages are stored."""
- return os.path.join(spack.paths.prefix, 'etc', 'spack', 'licenses')
+ """Returns the directory where global license files are stored."""
+ return type(self).global_license_dir
@property
def global_license_file(self):
diff --git a/lib/spack/spack/paths.py b/lib/spack/spack/paths.py
index b423e9e6c5..fcf98aac29 100644
--- a/lib/spack/spack/paths.py
+++ b/lib/spack/spack/paths.py
@@ -43,8 +43,12 @@ test_path = os.path.join(module_path, "test")
hooks_path = os.path.join(module_path, "hooks")
opt_path = os.path.join(prefix, "opt")
share_path = os.path.join(prefix, "share", "spack")
-etc_path = os.path.join(prefix, "etc")
+etc_path = os.path.join(prefix, "etc", "spack")
+#
+# Things in $spack/etc/spack
+#
+default_license_dir = os.path.join(etc_path, "licenses")
#
# Things in $spack/var/spack
diff --git a/lib/spack/spack/schema/config.py b/lib/spack/spack/schema/config.py
index 1000fcb5a8..2de54a6179 100644
--- a/lib/spack/spack/schema/config.py
+++ b/lib/spack/spack/schema/config.py
@@ -56,6 +56,7 @@ properties = {
'type': 'array',
'items': {'type': 'string'}
},
+ 'license_dir': {'type': 'string'},
'source_cache': {'type': 'string'},
'misc_cache': {'type': 'string'},
'connect_timeout': {'type': 'integer', 'minimum': 0},
diff --git a/lib/spack/spack/test/bindist.py b/lib/spack/spack/test/bindist.py
index 24214d6467..5ef35e3407 100644
--- a/lib/spack/spack/test/bindist.py
+++ b/lib/spack/spack/test/bindist.py
@@ -78,13 +78,13 @@ def config_directory(tmpdir_factory):
tmpdir = tmpdir_factory.mktemp('test_configs')
# restore some sane defaults for packages and config
config_path = py.path.local(spack.paths.etc_path)
- modules_yaml = config_path.join('spack', 'defaults', 'modules.yaml')
- os_modules_yaml = config_path.join('spack', 'defaults', '%s' %
+ modules_yaml = config_path.join('defaults', 'modules.yaml')
+ os_modules_yaml = config_path.join('defaults', '%s' %
platform.system().lower(),
'modules.yaml')
- packages_yaml = config_path.join('spack', 'defaults', 'packages.yaml')
- config_yaml = config_path.join('spack', 'defaults', 'config.yaml')
- repos_yaml = config_path.join('spack', 'defaults', 'repos.yaml')
+ packages_yaml = config_path.join('defaults', 'packages.yaml')
+ config_yaml = config_path.join('defaults', 'config.yaml')
+ repos_yaml = config_path.join('defaults', 'repos.yaml')
tmpdir.ensure('site', dir=True)
tmpdir.ensure('user', dir=True)
tmpdir.ensure('site/%s' % platform.system().lower(), dir=True)
diff --git a/lib/spack/spack/test/cmd/external.py b/lib/spack/spack/test/cmd/external.py
index bfdcb0b4eb..abcdec680a 100644
--- a/lib/spack/spack/test/cmd/external.py
+++ b/lib/spack/spack/test/cmd/external.py
@@ -32,7 +32,7 @@ def _platform_executables(monkeypatch):
def _win_exe_ext():
return '.bat'
- monkeypatch.setattr(spack.package, 'win_exe_ext', _win_exe_ext)
+ monkeypatch.setattr(spack.util.path, 'win_exe_ext', _win_exe_ext)
def define_plat_exe(exe):
diff --git a/lib/spack/spack/test/config.py b/lib/spack/spack/test/config.py
index 4a27acf9ca..eae3afa265 100644
--- a/lib/spack/spack/test/config.py
+++ b/lib/spack/spack/test/config.py
@@ -18,6 +18,7 @@ import spack.config
import spack.environment as ev
import spack.main
import spack.paths
+import spack.repo
import spack.schema.compilers
import spack.schema.config
import spack.schema.env
@@ -1157,6 +1158,19 @@ def test_bad_path_double_override(config):
pass
+def test_license_dir_config(mutable_config, mock_packages):
+ """Ensure license directory is customizable"""
+ assert spack.config.get("config:license_dir") == spack.paths.default_license_dir
+ assert spack.package.Package.global_license_dir == spack.paths.default_license_dir
+ assert spack.repo.get("a").global_license_dir == spack.paths.default_license_dir
+
+ rel_path = os.path.join(os.path.sep, "foo", "bar", "baz")
+ spack.config.set("config:license_dir", rel_path)
+ assert spack.config.get("config:license_dir") == rel_path
+ assert spack.package.Package.global_license_dir == rel_path
+ assert spack.repo.get("a").global_license_dir == rel_path
+
+
@pytest.mark.regression('22547')
def test_single_file_scope_cache_clearing(env_yaml):
scope = spack.config.SingleFileScope(
diff --git a/lib/spack/spack/test/conftest.py b/lib/spack/spack/test/conftest.py
index 8bd90eb1ce..7298fc804f 100644
--- a/lib/spack/spack/test/conftest.py
+++ b/lib/spack/spack/test/conftest.py
@@ -576,7 +576,7 @@ def default_config():
This ensures we can test the real default configuration without having
tests fail when the user overrides the defaults that we test against."""
- defaults_path = os.path.join(spack.paths.etc_path, 'spack', 'defaults')
+ defaults_path = os.path.join(spack.paths.etc_path, 'defaults')
if is_windows:
defaults_path = os.path.join(defaults_path, "windows")
with spack.config.use_configuration(defaults_path) as defaults_config: