From d998ea1bd41b4cf7f47caa734b7c7df86178ef0c Mon Sep 17 00:00:00 2001 From: Harmen Stoppels Date: Tue, 5 Oct 2021 20:25:43 +0200 Subject: Move shell aware env into spack.environment.shell (#25608) Cherry-picked from #25564 so this is standalone. With this PR we can activate an environment in Spack itself, without computing changes to environment variables only necessary for "shell aware" env activation. 1. Activating an environment: ```python spack.environment.activate(Environment(xyz)) -> None ``` this basically just sets `_active_environment` and modifies some config scopes. 2. Activating an environment **and** getting environment variable modifications for the shell: ```python spack.environment.shell.activate(Environment(xyz)) -> EnvironmentModifications ``` This should make it easier/faster to do unit tests and scripting with spack, without the cli interface. --- lib/spack/spack/bootstrap.py | 2 +- lib/spack/spack/cmd/common/arguments.py | 2 +- lib/spack/spack/cmd/env.py | 19 +- lib/spack/spack/environment.py | 2183 ---------------------------- lib/spack/spack/environment/__init__.py | 57 + lib/spack/spack/environment/environment.py | 2088 ++++++++++++++++++++++++++ lib/spack/spack/environment/shell.py | 161 ++ lib/spack/spack/main.py | 2 +- lib/spack/spack/subprocess_context.py | 21 +- lib/spack/spack/test/cmd/ci.py | 46 +- lib/spack/spack/test/cmd/env.py | 53 +- lib/spack/spack/test/conftest.py | 8 +- lib/spack/spack/test/env.py | 10 + 13 files changed, 2390 insertions(+), 2262 deletions(-) delete mode 100644 lib/spack/spack/environment.py create mode 100644 lib/spack/spack/environment/__init__.py create mode 100644 lib/spack/spack/environment/environment.py create mode 100644 lib/spack/spack/environment/shell.py (limited to 'lib') diff --git a/lib/spack/spack/bootstrap.py b/lib/spack/spack/bootstrap.py index 8f4119a04d..76fc6f487f 100644 --- a/lib/spack/spack/bootstrap.py +++ b/lib/spack/spack/bootstrap.py @@ -539,7 +539,7 @@ def _add_externals_if_missing(): def ensure_bootstrap_configuration(): bootstrap_store_path = store_path() user_configuration = _read_and_sanitize_configuration() - with spack.environment.deactivate_environment(): + with spack.environment.no_active_environment(): with spack.architecture.use_platform(spack.architecture.real_platform()): with spack.repo.use_repositories(spack.paths.packages_path): with spack.store.use_store(bootstrap_store_path): diff --git a/lib/spack/spack/cmd/common/arguments.py b/lib/spack/spack/cmd/common/arguments.py index 40a30a2618..1b173bf584 100644 --- a/lib/spack/spack/cmd/common/arguments.py +++ b/lib/spack/spack/cmd/common/arguments.py @@ -69,7 +69,7 @@ class ConstraintAction(argparse.Action): # If an environment is provided, we'll restrict the search to # only its installed packages. - env = ev._active_environment + env = ev.active_environment() if env: kwargs['hashes'] = set(env.all_hashes()) diff --git a/lib/spack/spack/cmd/env.py b/lib/spack/spack/cmd/env.py index 5d436624bd..ae45e105de 100644 --- a/lib/spack/spack/cmd/env.py +++ b/lib/spack/spack/cmd/env.py @@ -19,6 +19,7 @@ import spack.cmd.modules import spack.cmd.uninstall import spack.config import spack.environment as ev +import spack.environment.shell import spack.schema.env import spack.util.string as string @@ -81,6 +82,7 @@ def env_activate_setup_parser(subparser): def env_activate(args): env = args.activate_env + if not args.shell: spack.cmd.common.shell_init_instructions( "spack env activate", @@ -110,10 +112,19 @@ def env_activate(args): tty.debug("Environment %s is already active" % args.activate_env) return - cmds = ev.activate( - ev.Environment(spack_env), add_view=args.with_view, shell=args.shell, + # Activate new environment + active_env = ev.Environment(spack_env) + cmds = spack.environment.shell.activate_header( + env=active_env, + shell=args.shell, prompt=env_prompt if args.prompt else None ) + env_mods = spack.environment.shell.activate( + env=active_env, + add_view=args.with_view + ) + cmds += env_mods.shell_modifications(args.shell) + sys.stdout.write(cmds) @@ -150,7 +161,9 @@ def env_deactivate(args): if 'SPACK_ENV' not in os.environ: tty.die('No environment is currently active.') - cmds = ev.deactivate(shell=args.shell) + cmds = spack.environment.shell.deactivate_header(args.shell) + env_mods = spack.environment.shell.deactivate() + cmds += env_mods.shell_modifications(args.shell) sys.stdout.write(cmds) diff --git a/lib/spack/spack/environment.py b/lib/spack/spack/environment.py deleted file mode 100644 index 330d90915e..0000000000 --- a/lib/spack/spack/environment.py +++ /dev/null @@ -1,2183 +0,0 @@ -# Copyright 2013-2021 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 collections -import contextlib -import copy -import os -import re -import shutil -import sys - -import ruamel.yaml as yaml -import six -from ordereddict_backport import OrderedDict - -import llnl.util.filesystem as fs -import llnl.util.tty as tty -from llnl.util.tty.color import colorize - -import spack.concretize -import spack.config -import spack.error -import spack.hash_types as ht -import spack.hooks -import spack.repo -import spack.schema.env -import spack.spec -import spack.stage -import spack.store -import spack.user_environment as uenv -import spack.util.environment -import spack.util.hash -import spack.util.lock as lk -import spack.util.path -import spack.util.spack_json as sjson -import spack.util.spack_yaml as syaml -from spack.filesystem_view import ( - YamlFilesystemView, - inverse_view_func_parser, - view_func_parser, -) -from spack.installer import PackageInstaller -from spack.spec import Spec -from spack.spec_list import InvalidSpecConstraintError, SpecList -from spack.util.path import substitute_path_variables -from spack.variant import UnknownVariantError - -#: environment variable used to indicate the active environment -spack_env_var = 'SPACK_ENV' - - -#: currently activated environment -_active_environment = None - - -#: path where environments are stored in the spack tree -env_path = os.path.join(spack.paths.var_path, 'environments') - - -#: Name of the input yaml file for an environment -manifest_name = 'spack.yaml' - - -#: Name of the input yaml file for an environment -lockfile_name = 'spack.lock' - - -#: Name of the directory where environments store repos, logs, views -env_subdir_name = '.spack-env' - - -#: default spack.yaml file to put in new environments -default_manifest_yaml = """\ -# This is a Spack Environment file. -# -# It describes a set of packages to be installed, along with -# configuration settings. -spack: - # add package specs to the `specs` list - specs: [] - view: true -""" -#: regex for validating enviroment names -valid_environment_name_re = r'^\w[\w-]*$' - -#: version of the lockfile format. Must increase monotonically. -lockfile_format_version = 3 - -# Magic names -# The name of the standalone spec list in the manifest yaml -user_speclist_name = 'specs' -# The name of the default view (the view loaded on env.activate) -default_view_name = 'default' -# Default behavior to link all packages into views (vs. only root packages) -default_view_link = 'all' - - -def valid_env_name(name): - return re.match(valid_environment_name_re, name) - - -def validate_env_name(name): - if not valid_env_name(name): - raise ValueError(( - "'%s': names must start with a letter, and only contain " - "letters, numbers, _, and -.") % name) - return name - - -def activate( - env, use_env_repo=False, add_view=True, shell='sh', prompt=None -): - """Activate an environment. - - To activate an environment, we add its configuration scope to the - existing Spack configuration, and we set active to the current - environment. - - Arguments: - env (Environment): the environment to activate - use_env_repo (bool): use the packages exactly as they appear in the - environment's repository - add_view (bool): generate commands to add view to path variables - shell (str): One of `sh`, `csh`, `fish`. - prompt (str): string to add to the users prompt, or None - - Returns: - str: Shell commands to activate environment. - - TODO: environment to use the activated spack environment. - """ - global _active_environment - - _active_environment = env - prepare_config_scope(_active_environment) - if use_env_repo: - spack.repo.path.put_first(_active_environment.repo) - - tty.debug("Using environment '%s'" % _active_environment.name) - - # Construct the commands to run - cmds = '' - if shell == 'csh': - # TODO: figure out how to make color work for csh - cmds += 'setenv SPACK_ENV %s;\n' % env.path - cmds += 'alias despacktivate "spack env deactivate";\n' - if prompt: - cmds += 'if (! $?SPACK_OLD_PROMPT ) ' - cmds += 'setenv SPACK_OLD_PROMPT "${prompt}";\n' - cmds += 'set prompt="%s ${prompt}";\n' % prompt - elif shell == 'fish': - if os.getenv('TERM') and 'color' in os.getenv('TERM') and prompt: - prompt = colorize('@G{%s} ' % prompt, color=True) - - cmds += 'set -gx SPACK_ENV %s;\n' % env.path - cmds += 'function despacktivate;\n' - cmds += ' spack env deactivate;\n' - cmds += 'end;\n' - # - # NOTE: We're not changing the fish_prompt function (which is fish's - # solution to the PS1 variable) here. This is a bit fiddly, and easy to - # screw up => spend time reasearching a solution. Feedback welcome. - # - else: - if os.getenv('TERM') and 'color' in os.getenv('TERM') and prompt: - prompt = colorize('@G{%s} ' % prompt, color=True) - - cmds += 'export SPACK_ENV=%s;\n' % env.path - cmds += "alias despacktivate='spack env deactivate';\n" - if prompt: - cmds += 'if [ -z ${SPACK_OLD_PS1+x} ]; then\n' - cmds += ' if [ -z ${PS1+x} ]; then\n' - cmds += " PS1='$$$$';\n" - cmds += ' fi;\n' - cmds += ' export SPACK_OLD_PS1="${PS1}";\n' - cmds += 'fi;\n' - cmds += 'export PS1="%s ${PS1}";\n' % prompt - - # - # NOTE in the fish-shell: Path variables are a special kind of variable - # used to support colon-delimited path lists including PATH, CDPATH, - # MANPATH, PYTHONPATH, etc. All variables that end in PATH (case-sensitive) - # become PATH variables. - # - try: - if add_view and default_view_name in env.views: - with spack.store.db.read_transaction(): - cmds += env.add_default_view_to_shell(shell) - except (spack.repo.UnknownPackageError, - spack.repo.UnknownNamespaceError) as e: - tty.error(e) - tty.die( - 'Environment view is broken due to a missing package or repo.\n', - ' To activate without views enabled, activate with:\n', - ' spack env activate -V {0}\n'.format(env.name), - ' To remove it and resolve the issue, ' - 'force concretize with the command:\n', - ' spack -e {0} concretize --force'.format(env.name)) - - return cmds - - -def deactivate(shell='sh'): - """Undo any configuration or repo settings modified by ``activate()``. - - Arguments: - shell (str): One of `sh`, `csh`, `fish`. Shell style to use. - - Returns: - str: shell commands for `shell` to undo environment variables - - """ - global _active_environment - - if not _active_environment: - return - - deactivate_config_scope(_active_environment) - - # use _repo so we only remove if a repo was actually constructed - if _active_environment._repo: - spack.repo.path.remove(_active_environment._repo) - - cmds = '' - if shell == 'csh': - cmds += 'unsetenv SPACK_ENV;\n' - cmds += 'if ( $?SPACK_OLD_PROMPT ) ' - cmds += 'set prompt="$SPACK_OLD_PROMPT" && ' - cmds += 'unsetenv SPACK_OLD_PROMPT;\n' - cmds += 'unalias despacktivate;\n' - elif shell == 'fish': - cmds += 'set -e SPACK_ENV;\n' - cmds += 'functions -e despacktivate;\n' - # - # NOTE: Not changing fish_prompt (above) => no need to restore it here. - # - else: - cmds += 'if [ ! -z ${SPACK_ENV+x} ]; then\n' - cmds += 'unset SPACK_ENV; export SPACK_ENV;\n' - cmds += 'fi;\n' - cmds += 'unalias despacktivate;\n' - cmds += 'if [ ! -z ${SPACK_OLD_PS1+x} ]; then\n' - cmds += ' if [ "$SPACK_OLD_PS1" = \'$$$$\' ]; then\n' - cmds += ' unset PS1; export PS1;\n' - cmds += ' else\n' - cmds += ' export PS1="$SPACK_OLD_PS1";\n' - cmds += ' fi;\n' - cmds += ' unset SPACK_OLD_PS1; export SPACK_OLD_PS1;\n' - cmds += 'fi;\n' - - try: - if default_view_name in _active_environment.views: - with spack.store.db.read_transaction(): - cmds += _active_environment.rm_default_view_from_shell(shell) - except (spack.repo.UnknownPackageError, - spack.repo.UnknownNamespaceError) as e: - tty.warn(e) - tty.warn('Could not fully deactivate view due to missing package ' - 'or repo, shell environment may be corrupt.') - - tty.debug("Deactivated environment '%s'" % _active_environment.name) - _active_environment = None - - return cmds - - -def active_environment(): - """Returns the active environment when there is any""" - return _active_environment - - -def _root(name): - """Non-validating version of root(), to be used internally.""" - return os.path.join(env_path, name) - - -def root(name): - """Get the root directory for an environment by name.""" - validate_env_name(name) - return _root(name) - - -def exists(name): - """Whether an environment with this name exists or not.""" - if not valid_env_name(name): - return False - return os.path.isdir(root(name)) - - -def active(name): - """True if the named environment is active.""" - return _active_environment and name == _active_environment.name - - -def is_env_dir(path): - """Whether a directory contains a spack environment.""" - return os.path.isdir(path) and os.path.exists( - os.path.join(path, manifest_name)) - - -def read(name): - """Get an environment with the supplied name.""" - validate_env_name(name) - if not exists(name): - raise SpackEnvironmentError("no such environment '%s'" % name) - return Environment(root(name)) - - -def create(name, init_file=None, with_view=None, keep_relative=False): - """Create a named environment in Spack.""" - validate_env_name(name) - if exists(name): - raise SpackEnvironmentError("'%s': environment already exists" % name) - return Environment(root(name), init_file, with_view, keep_relative) - - -def config_dict(yaml_data): - """Get the configuration scope section out of an spack.yaml""" - key = spack.config.first_existing(yaml_data, spack.schema.env.keys) - return yaml_data[key] - - -def all_environment_names(): - """List the names of environments that currently exist.""" - # just return empty if the env path does not exist. A read-only - # operation like list should not try to create a directory. - if not os.path.exists(env_path): - return [] - - candidates = sorted(os.listdir(env_path)) - names = [] - for candidate in candidates: - yaml_path = os.path.join(_root(candidate), manifest_name) - if valid_env_name(candidate) and os.path.exists(yaml_path): - names.append(candidate) - return names - - -def all_environments(): - """Generator for all named Environments.""" - for name in all_environment_names(): - yield read(name) - - -def _read_yaml(str_or_file): - """Read YAML from a file for round-trip parsing.""" - data = syaml.load_config(str_or_file) - filename = getattr(str_or_file, 'name', None) - default_data = spack.config.validate( - data, spack.schema.env.schema, filename) - return (data, default_data) - - -def _write_yaml(data, str_or_file): - """Write YAML to a file preserving comments and dict order.""" - filename = getattr(str_or_file, 'name', None) - spack.config.validate(data, spack.schema.env.schema, filename) - syaml.dump_config(data, str_or_file, default_flow_style=False) - - -def _eval_conditional(string): - """Evaluate conditional definitions using restricted variable scope.""" - valid_variables = spack.util.environment.get_host_environment() - valid_variables.update({ - 're': re, - 'env': os.environ, - }) - return eval(string, valid_variables) - - -class ViewDescriptor(object): - def __init__(self, base_path, root, projections={}, select=[], exclude=[], - link=default_view_link, link_type='symlink'): - self.base = base_path - self.root = spack.util.path.canonicalize_path(root) - self.projections = projections - self.select = select - self.exclude = exclude - self.link_type = view_func_parser(link_type) - self.link = link - - def select_fn(self, spec): - return any(spec.satisfies(s) for s in self.select) - - def exclude_fn(self, spec): - return not any(spec.satisfies(e) for e in self.exclude) - - def __eq__(self, other): - return all([self.root == other.root, - self.projections == other.projections, - self.select == other.select, - self.exclude == other.exclude, - self.link == other.link, - self.link_type == other.link_type]) - - def to_dict(self): - ret = syaml.syaml_dict([('root', self.root)]) - if self.projections: - # projections guaranteed to be ordered dict if true-ish - # for python2.6, may be syaml or ruamel.yaml implementation - # so we have to check for both - types = (OrderedDict, syaml.syaml_dict, yaml.comments.CommentedMap) - assert isinstance(self.projections, types) - ret['projections'] = self.projections - if self.select: - ret['select'] = self.select - if self.exclude: - ret['exclude'] = self.exclude - if self.link_type: - ret['link_type'] = inverse_view_func_parser(self.link_type) - if self.link != default_view_link: - ret['link'] = self.link - return ret - - @staticmethod - def from_dict(base_path, d): - return ViewDescriptor(base_path, - d['root'], - d.get('projections', {}), - d.get('select', []), - d.get('exclude', []), - d.get('link', default_view_link), - d.get('link_type', 'symlink')) - - @property - def _current_root(self): - if not os.path.islink(self.root): - return None - - root = os.readlink(self.root) - if os.path.isabs(root): - return root - - root_dir = os.path.dirname(self.root) - return os.path.join(root_dir, root) - - def _next_root(self, specs): - content_hash = self.content_hash(specs) - root_dir = os.path.dirname(self.root) - root_name = os.path.basename(self.root) - return os.path.join(root_dir, '._%s' % root_name, content_hash) - - def content_hash(self, specs): - d = syaml.syaml_dict([ - ('descriptor', self.to_dict()), - ('specs', [(spec.full_hash(), spec.prefix) for spec in sorted(specs)]) - ]) - contents = sjson.dump(d) - return spack.util.hash.b32_hash(contents) - - def get_projection_for_spec(self, spec): - """Get projection for spec relative to view root - - Getting the projection from the underlying root will get the temporary - projection. This gives the permanent projection relative to the root - symlink. - """ - view = self.view() - view_path = view.get_projection_for_spec(spec) - rel_path = os.path.relpath(view_path, self._current_root) - return os.path.join(self.root, rel_path) - - def view(self, new=None): - """ - Generate the FilesystemView object for this ViewDescriptor - - By default, this method returns a FilesystemView object rooted at the - current underlying root of this ViewDescriptor (self._current_root) - - Raise if new is None and there is no current view - - Arguments: - new (str or None): If a string, create a FilesystemView - rooted at that path. Default None. This should only be used to - regenerate the view, and cannot be used to access specs. - """ - root = self._current_root - if new: - root = new - if not root: - # This can only be hit if we write a future bug - msg = ("Attempting to get nonexistent view from environment. " - "View root is at %s" % self.root) - raise SpackEnvironmentViewError(msg) - return YamlFilesystemView(root, spack.store.layout, - ignore_conflicts=True, - projections=self.projections, - link=self.link_type) - - def __contains__(self, spec): - """Is the spec described by the view descriptor - - Note: This does not claim the spec is already linked in the view. - It merely checks that the spec is selected if a select operation is - specified and is not excluded if an exclude operator is specified. - """ - if self.select: - if not self.select_fn(spec): - return False - - if self.exclude: - if not self.exclude_fn(spec): - return False - - return True - - def specs_for_view(self, all_specs, roots): - specs_for_view = [] - specs = all_specs if self.link == 'all' else roots - - for spec in specs: - # The view does not store build deps, so if we want it to - # recognize environment specs (which do store build deps), - # then they need to be stripped. - if spec.concrete: # Do not link unconcretized roots - # We preserve _hash _normal to avoid recomputing DAG - # hashes (DAG hashes don't consider build deps) - spec_copy = spec.copy(deps=('link', 'run')) - spec_copy._hash = spec._hash - spec_copy._normal = spec._normal - specs_for_view.append(spec_copy) - return specs_for_view - - def regenerate(self, all_specs, roots): - specs_for_view = self.specs_for_view(all_specs, roots) - - # regeneration queries the database quite a bit; this read - # transaction ensures that we don't repeatedly lock/unlock. - with spack.store.db.read_transaction(): - installed_specs_for_view = set( - s for s in specs_for_view if s in self and s.package.installed) - - # To ensure there are no conflicts with packages being installed - # that cannot be resolved or have repos that have been removed - # we always regenerate the view from scratch. - # We will do this by hashing the view contents and putting the view - # in a directory by hash, and then having a symlink to the real - # view in the root. The real root for a view at /dirname/basename - # will be /dirname/._basename_. - # This allows for atomic swaps when we update the view - - # cache the roots because the way we determine which is which does - # not work while we are updating - new_root = self._next_root(installed_specs_for_view) - old_root = self._current_root - - if new_root == old_root: - tty.debug("View at %s does not need regeneration." % self.root) - return - - # construct view at new_root - tty.msg("Updating view at {0}".format(self.root)) - - view = self.view(new=new_root) - fs.mkdirp(new_root) - view.add_specs(*installed_specs_for_view, - with_dependencies=False) - - # create symlink from tmpname to new_root - root_dirname = os.path.dirname(self.root) - tmp_symlink_name = os.path.join(root_dirname, '._view_link') - if os.path.exists(tmp_symlink_name): - os.unlink(tmp_symlink_name) - os.symlink(new_root, tmp_symlink_name) - - # mv symlink atomically over root symlink to old_root - if os.path.exists(self.root) and not os.path.islink(self.root): - msg = "Cannot create view: " - msg += "file already exists and is not a link: %s" % self.root - raise SpackEnvironmentViewError(msg) - os.rename(tmp_symlink_name, self.root) - - # remove old_root - if old_root and os.path.exists(old_root): - try: - shutil.rmtree(old_root) - except (IOError, OSError) as e: - msg = "Failed to remove old view at %s\n" % old_root - msg += str(e) - tty.warn(msg) - - -def _create_environment(*args, **kwargs): - return Environment(*args, **kwargs) - - -class Environment(object): - def __init__(self, path, init_file=None, with_view=None, keep_relative=False): - """Create a new environment. - - The environment can be optionally initialized with either a - spack.yaml or spack.lock file. - - Arguments: - path (str): path to the root directory of this environment - init_file (str or file object): filename or file object to - initialize the environment - with_view (str or bool): whether a view should be maintained for - the environment. If the value is a string, it specifies the - path to the view. - keep_relative (bool): if True, develop paths are copied verbatim - into the new environment file, otherwise they are made absolute - when the environment path is different from init_file's - directory. - """ - self.path = os.path.abspath(path) - self.init_file = init_file - self.with_view = with_view - self.keep_relative = keep_relative - - self.txlock = lk.Lock(self._transaction_lock_path) - - # This attribute will be set properly from configuration - # during concretization - self.concretization = None - self.clear() - - if init_file: - # If we are creating the environment from an init file, we don't - # need to lock, because there are no Spack operations that alter - # the init file. - with fs.open_if_filename(init_file) as f: - if hasattr(f, 'name') and f.name.endswith('.lock'): - self._read_manifest(default_manifest_yaml) - self._read_lockfile(f) - self._set_user_specs_from_lockfile() - else: - self._read_manifest(f, raw_yaml=default_manifest_yaml) - - # Rewrite relative develop paths when initializing a new - # environment in a different location from the spack.yaml file. - if not keep_relative and hasattr(f, 'name') and \ - f.name.endswith('.yaml'): - init_file_dir = os.path.abspath(os.path.dirname(f.name)) - self._rewrite_relative_paths_on_relocation(init_file_dir) - else: - with lk.ReadTransaction(self.txlock): - self._read() - - if with_view is False: - self.views = {} - elif with_view is True: - self.views = { - default_view_name: ViewDescriptor(self.path, - self.view_path_default)} - elif isinstance(with_view, six.string_types): - self.views = {default_view_name: ViewDescriptor(self.path, - with_view)} - # If with_view is None, then defer to the view settings determined by - # the manifest file - - def __reduce__(self): - return _create_environment, ( - self.path, self.init_file, self.with_view, self.keep_relative - ) - - def _rewrite_relative_paths_on_relocation(self, init_file_dir): - """When initializing the environment from a manifest file and we plan - to store the environment in a different directory, we have to rewrite - relative paths to absolute ones.""" - if init_file_dir == self.path: - return - - for name, entry in self.dev_specs.items(): - dev_path = entry['path'] - expanded_path = os.path.normpath(os.path.join( - init_file_dir, entry['path'])) - - # Skip if the expanded path is the same (e.g. when absolute) - if dev_path == expanded_path: - continue - - tty.debug("Expanding develop path for {0} to {1}".format( - name, expanded_path)) - - self.dev_specs[name]['path'] = expanded_path - - def _re_read(self): - """Reinitialize the environment object if it has been written (this - may not be true if the environment was just created in this running - instance of Spack).""" - if not os.path.exists(self.manifest_path): - return - - self.clear(re_read=True) - self._read() - - def _read(self): - default_manifest = not os.path.exists(self.manifest_path) - if default_manifest: - # No manifest, use default yaml - self._read_manifest(default_manifest_yaml) - else: - with open(self.manifest_path) as f: - self._read_manifest(f) - - if os.path.exists(self.lock_path): - with open(self.lock_path) as f: - read_lock_version = self._read_lockfile(f) - if default_manifest: - # No manifest, set user specs from lockfile - self._set_user_specs_from_lockfile() - - if read_lock_version == 1: - tty.debug( - "Storing backup of old lockfile {0} at {1}".format( - self.lock_path, self._lock_backup_v1_path)) - shutil.copy(self.lock_path, self._lock_backup_v1_path) - - def write_transaction(self): - """Get a write lock context manager for use in a `with` block.""" - return lk.WriteTransaction(self.txlock, acquire=self._re_read) - - def _read_manifest(self, f, raw_yaml=None): - """Read manifest file and set up user specs.""" - if raw_yaml: - _, self.yaml = _read_yaml(f) - self.raw_yaml, _ = _read_yaml(raw_yaml) - else: - self.raw_yaml, self.yaml = _read_yaml(f) - - self.spec_lists = OrderedDict() - - for item in config_dict(self.yaml).get('definitions', []): - entry = copy.deepcopy(item) - when = _eval_conditional(entry.pop('when', 'True')) - assert len(entry) == 1 - if when: - name, spec_list = next(iter(entry.items())) - user_specs = SpecList(name, spec_list, self.spec_lists.copy()) - if name in self.spec_lists: - self.spec_lists[name].extend(user_specs) - else: - self.spec_lists[name] = user_specs - - spec_list = config_dict(self.yaml).get(user_speclist_name, []) - user_specs = SpecList(user_speclist_name, [s for s in spec_list if s], - self.spec_lists.copy()) - self.spec_lists[user_speclist_name] = user_specs - - enable_view = config_dict(self.yaml).get('view') - # enable_view can be boolean, string, or None - if enable_view is True or enable_view is None: - self.views = { - default_view_name: ViewDescriptor(self.path, - self.view_path_default)} - elif isinstance(enable_view, six.string_types): - self.views = {default_view_name: ViewDescriptor(self.path, - enable_view)} - elif enable_view: - path = self.path - self.views = dict((name, ViewDescriptor.from_dict(path, values)) - for name, values in enable_view.items()) - else: - self.views = {} - # Retrieve the current concretization strategy - configuration = config_dict(self.yaml) - # default concretization to separately - self.concretization = configuration.get('concretization', 'separately') - - # Retrieve dev-build packages: - self.dev_specs = configuration.get('develop', {}) - for name, entry in self.dev_specs.items(): - # spec must include a concrete version - assert Spec(entry['spec']).version.concrete - # default path is the spec name - if 'path' not in entry: - self.dev_specs[name]['path'] = name - - @property - def user_specs(self): - return self.spec_lists[user_speclist_name] - - def _set_user_specs_from_lockfile(self): - """Copy user_specs from a read-in lockfile.""" - self.spec_lists = { - user_speclist_name: SpecList( - user_speclist_name, - [str(s) for s in self.concretized_user_specs] - ) - } - - def clear(self, re_read=False): - """Clear the contents of the environment - - Arguments: - re_read (bool): If True, do not clear ``new_specs`` nor - ``new_installs`` values. These values cannot be read from - yaml, and need to be maintained when re-reading an existing - environment. - """ - self.spec_lists = {user_speclist_name: SpecList()} # specs from yaml - self.dev_specs = {} # dev-build specs from yaml - self.concretized_user_specs = [] # user specs from last concretize - self.concretized_order = [] # roots of last concretize, in order - self.specs_by_hash = {} # concretized specs by hash - self._repo = None # RepoPath for this env (memoized) - self._previous_active = None # previously active environment - if not re_read: - # things that cannot be recreated from file - self.new_specs = [] # write packages for these on write() - self.new_installs = [] # write modules for these on write() - - @property - def internal(self): - """Whether this environment is managed by Spack.""" - return self.path.startswith(env_path) - - @property - def name(self): - """Human-readable representation of the environment. - - This is the path for directory environments, and just the name - for named environments. - """ - if self.internal: - return os.path.basename(self.path) - else: - return self.path - - @property - def active(self): - """True if this environment is currently active.""" - return _active_environment and self.path == _active_environment.path - - @property - def manifest_path(self): - """Path to spack.yaml file in this environment.""" - return os.path.join(self.path, manifest_name) - - @property - def _transaction_lock_path(self): - """The location of the lock file used to synchronize multiple - processes updating the same environment. - """ - return os.path.join(self.env_subdir_path, 'transaction_lock') - - @property - def lock_path(self): - """Path to spack.lock file in this environment.""" - return os.path.join(self.path, lockfile_name) - - @property - def _lock_backup_v1_path(self): - """Path to backup of v1 lockfile before conversion to v2""" - return self.lock_path + '.backup.v1' - - @property - def env_subdir_path(self): - """Path to directory where the env stores repos, logs, views.""" - return os.path.join(self.path, env_subdir_name) - - @property - def repos_path(self): - return os.path.join(self.path, env_subdir_name, 'repos') - - @property - def log_path(self): - return os.path.join(self.path, env_subdir_name, 'logs') - - @property - def view_path_default(self): - # default path for environment views - return os.path.join(self.env_subdir_path, 'view') - - @property - def repo(self): - if self._repo is None: - self._repo = make_repo_path(self.repos_path) - return self._repo - - def included_config_scopes(self): - """List of included configuration scopes from the environment. - - Scopes are listed in the YAML file in order from highest to - lowest precedence, so configuration from earlier scope will take - precedence over later ones. - - This routine returns them in the order they should be pushed onto - the internal scope stack (so, in reverse, from lowest to highest). - """ - scopes = [] - - # load config scopes added via 'include:', in reverse so that - # highest-precedence scopes are last. - includes = config_dict(self.yaml).get('include', []) - missing = [] - for i, config_path in enumerate(reversed(includes)): - # allow paths to contain spack config/environment variables, etc. - config_path = substitute_path_variables(config_path) - - # treat relative paths as relative to the environment - if not os.path.isabs(config_path): - config_path = os.path.join(self.path, config_path) - config_path = os.path.normpath(os.path.realpath(config_path)) - - if os.path.isdir(config_path): - # directories are treated as regular ConfigScopes - config_name = 'env:%s:%s' % ( - self.name, os.path.basename(config_path)) - scope = spack.config.ConfigScope(config_name, config_path) - elif os.path.exists(config_path): - # files are assumed to be SingleFileScopes - config_name = 'env:%s:%s' % (self.name, config_path) - scope = spack.config.SingleFileScope( - config_name, config_path, spack.schema.merged.schema) - else: - missing.append(config_path) - continue - - scopes.append(scope) - - if missing: - msg = 'Detected {0} missing include path(s):'.format(len(missing)) - msg += '\n {0}'.format('\n '.join(missing)) - tty.die('{0}\nPlease correct and try again.'.format(msg)) - - return scopes - - def env_file_config_scope_name(self): - """Name of the config scope of this environment's manifest file.""" - return 'env:%s' % self.name - - def env_file_config_scope(self): - """Get the configuration scope for the environment's manifest file.""" - config_name = self.env_file_config_scope_name() - return spack.config.SingleFileScope( - config_name, - self.manifest_path, - spack.schema.env.schema, - [spack.config.first_existing(self.raw_yaml, - spack.schema.env.keys)]) - - def config_scopes(self): - """A list of all configuration scopes for this environment.""" - return self.included_config_scopes() + [self.env_file_config_scope()] - - def destroy(self): - """Remove this environment from Spack entirely.""" - shutil.rmtree(self.path) - - def update_stale_references(self, from_list=None): - """Iterate over spec lists updating references.""" - if not from_list: - from_list = next(iter(self.spec_lists.keys())) - index = list(self.spec_lists.keys()).index(from_list) - - # spec_lists is an OrderedDict, all list entries after the modified - # list may refer to the modified list. Update stale references - for i, (name, speclist) in enumerate( - list(self.spec_lists.items())[index + 1:], index + 1 - ): - new_reference = dict((n, self.spec_lists[n]) - for n in list(self.spec_lists.keys())[:i]) - speclist.update_reference(new_reference) - - def add(self, user_spec, list_name=user_speclist_name): - """Add a single user_spec (non-concretized) to the Environment - - Returns: - (bool): True if the spec was added, False if it was already - present and did not need to be added - - """ - spec = Spec(user_spec) - - if list_name not in self.spec_lists: - raise SpackEnvironmentError( - 'No list %s exists in environment %s' % (list_name, self.name) - ) - - if list_name == user_speclist_name: - if not spec.name: - raise SpackEnvironmentError( - 'cannot add anonymous specs to an environment!') - elif not spack.repo.path.exists(spec.name): - virtuals = spack.repo.path.provider_index.providers.keys() - if spec.name not in virtuals: - msg = 'no such package: %s' % spec.name - raise SpackEnvironmentError(msg) - - list_to_change = self.spec_lists[list_name] - existing = str(spec) in list_to_change.yaml_list - if not existing: - list_to_change.add(str(spec)) - self.update_stale_references(list_name) - - return bool(not existing) - - def remove(self, query_spec, list_name=user_speclist_name, force=False): - """Remove specs from an environment that match a query_spec""" - query_spec = Spec(query_spec) - - list_to_change = self.spec_lists[list_name] - matches = [] - - if not query_spec.concrete: - matches = [s for s in list_to_change if s.satisfies(query_spec)] - - if not matches: - # concrete specs match against concrete specs in the env - # by *dag hash*, not build hash. - dag_hashes_in_order = [ - self.specs_by_hash[build_hash].dag_hash() - for build_hash in self.concretized_order - ] - - specs_hashes = zip( - self.concretized_user_specs, dag_hashes_in_order - ) - - matches = [ - s for s, h in specs_hashes - if query_spec.dag_hash() == h - ] - - if not matches: - raise SpackEnvironmentError( - "Not found: {0}".format(query_spec)) - - old_specs = set(self.user_specs) - new_specs = set() - for spec in matches: - if spec in list_to_change: - try: - list_to_change.remove(spec) - self.update_stale_references(list_name) - new_specs = set(self.user_specs) - except spack.spec_list.SpecListError: - # define new specs list - new_specs = set(self.user_specs) - msg = "Spec '%s' is part of a spec matrix and " % spec - msg += "cannot be removed from list '%s'." % list_to_change - if force: - msg += " It will be removed from the concrete specs." - # Mock new specs so we can remove this spec from - # concrete spec lists - new_specs.remove(spec) - tty.warn(msg) - - # If force, update stale concretized specs - for spec in old_specs - new_specs: - if force and spec in self.concretized_user_specs: - i = self.concretized_user_specs.index(spec) - del self.concretized_user_specs[i] - - dag_hash = self.concretized_order[i] - del self.concretized_order[i] - del self.specs_by_hash[dag_hash] - - def develop(self, spec, path, clone=False): - """Add dev-build info for package - - Args: - spec (spack.spec.Spec): Set constraints on development specs. Must include a - concrete version. - path (str): Path to find code for developer builds. Relative - paths will be resolved relative to the environment. - clone (bool): Clone the package code to the path. - If clone is False Spack will assume the code is already present - at ``path``. - - Return: - (bool): True iff the environment was changed. - """ - spec = spec.copy() # defensive copy since we access cached attributes - - if not spec.versions.concrete: - raise SpackEnvironmentError( - 'Cannot develop spec %s without a concrete version' % spec) - - for name, entry in self.dev_specs.items(): - if name == spec.name: - e_spec = Spec(entry['spec']) - e_path = entry['path'] - - if e_spec == spec: - if path == e_path: - tty.msg("Spec %s already configured for development" % - spec) - return False - else: - tty.msg("Updating development path for spec %s" % spec) - break - else: - msg = "Updating development spec for package " - msg += "%s with path %s" % (spec.name, path) - tty.msg(msg) - break - else: - tty.msg("Configuring spec %s for development at path %s" % - (spec, path)) - - if clone: - # "steal" the source code via staging API - abspath = os.path.normpath(os.path.join(self.path, path)) - - stage = spec.package.stage - stage.steal_source(abspath) - - # If it wasn't already in the list, append it - self.dev_specs[spec.name] = {'path': path, 'spec': str(spec)} - return True - - def undevelop(self, spec): - """Remove develop info for abstract spec ``spec``. - - returns True on success, False if no entry existed.""" - spec = Spec(spec) # In case it's a spec object - if spec.name in self.dev_specs: - del self.dev_specs[spec.name] - return True - return False - - def is_develop(self, spec): - """Returns true when the spec is built from local sources""" - return spec.name in self.dev_specs - - def concretize(self, force=False, tests=False): - """Concretize user_specs in this environment. - - Only concretizes specs that haven't been concretized yet unless - force is ``True``. - - This only modifies the environment in memory. ``write()`` will - write out a lockfile containing concretized specs. - - Arguments: - force (bool): re-concretize ALL specs, even those that were - already concretized - tests (bool or list or set): False to run no tests, True to test - all packages, or a list of package names to run tests for some - - Returns: - List of specs that have been concretized. Each entry is a tuple of - the user spec and the corresponding concretized spec. - """ - if force: - # Clear previously concretized specs - self.concretized_user_specs = [] - self.concretized_order = [] - self.specs_by_hash = {} - - # Pick the right concretization strategy - if self.concretization == 'together': - return self._concretize_together(tests=tests) - if self.concretization == 'separately': - return self._concretize_separately(tests=tests) - - msg = 'concretization strategy not implemented [{0}]' - raise SpackEnvironmentError(msg.format(self.concretization)) - - def _concretize_together(self, tests=False): - """Concretization strategy that concretizes all the specs - in the same DAG. - """ - # Exit early if the set of concretized specs is the set of user specs - user_specs_did_not_change = not bool( - set(self.user_specs) - set(self.concretized_user_specs) - ) - if user_specs_did_not_change: - return [] - - # Check that user specs don't have duplicate packages - counter = collections.defaultdict(int) - for user_spec in self.user_specs: - counter[user_spec.name] += 1 - - duplicates = [] - for name, count in counter.items(): - if count > 1: - duplicates.append(name) - - if duplicates: - msg = ('environment that are configured to concretize specs' - ' together cannot contain more than one spec for each' - ' package [{0}]'.format(', '.join(duplicates))) - raise SpackEnvironmentError(msg) - - # Proceed with concretization - self.concretized_user_specs = [] - self.concretized_order = [] - self.specs_by_hash = {} - - concrete_specs = spack.concretize.concretize_specs_together( - *self.user_specs, tests=tests) - concretized_specs = [x for x in zip(self.user_specs, concrete_specs)] - for abstract, concrete in concretized_specs: - self._add_concrete_spec(abstract, concrete) - return concretized_specs - - def _concretize_separately(self, tests=False): - """Concretization strategy that concretizes separately one - user spec after the other. - """ - # keep any concretized specs whose user specs are still in the manifest - old_concretized_user_specs = self.concretized_user_specs - old_concretized_order = self.concretized_order - old_specs_by_hash = self.specs_by_hash - - self.concretized_user_specs = [] - self.concretized_order = [] - self.specs_by_hash = {} - - for s, h in zip(old_concretized_user_specs, old_concretized_order): - if s in self.user_specs: - concrete = old_specs_by_hash[h] - self._add_concrete_spec(s, concrete, new=False) - - # Concretize any new user specs that we haven't concretized yet - concretized_specs = [] - for uspec, uspec_constraints in zip( - self.user_specs, self.user_specs.specs_as_constraints): - if uspec not in old_concretized_user_specs: - concrete = _concretize_from_constraints(uspec_constraints, tests=tests) - self._add_concrete_spec(uspec, concrete) - concretized_specs.append((uspec, concrete)) - return concretized_specs - - def concretize_and_add(self, user_spec, concrete_spec=None, tests=False): - """Concretize and add a single spec to the environment. - - Concretize the provided ``user_spec`` and add it along with the - concretized result to the environment. If the given ``user_spec`` was - already present in the environment, this does not add a duplicate. - The concretized spec will be added unless the ``user_spec`` was - already present and an associated concrete spec was already present. - - Args: - concrete_spec: if provided, then it is assumed that it is the - result of concretizing the provided ``user_spec`` - """ - if self.concretization == 'together': - msg = 'cannot install a single spec in an environment that is ' \ - 'configured to be concretized together. Run instead:\n\n' \ - ' $ spack add \n' \ - ' $ spack install\n' - raise SpackEnvironmentError(msg) - - spec = Spec(user_spec) - - if self.add(spec): - concrete = concrete_spec or spec.concretized(tests=tests) - self._add_concrete_spec(spec, concrete) - else: - # spec might be in the user_specs, but not installed. - # TODO: Redo name-based comparison for old style envs - spec = next( - s for s in self.user_specs if s.satisfies(user_spec) - ) - concrete = self.specs_by_hash.get(spec.build_hash()) - if not concrete: - concrete = spec.concretized(tests=tests) - self._add_concrete_spec(spec, concrete) - - return concrete - - @property - def default_view(self): - if not self.views: - raise SpackEnvironmentError( - "{0} does not have a view enabled".format(self.name)) - - if default_view_name not in self.views: - raise SpackEnvironmentError( - "{0} does not have a default view enabled".format(self.name)) - - return self.views[default_view_name] - - def update_default_view(self, viewpath): - name = default_view_name - if name in self.views and self.default_view.root != viewpath: - shutil.rmtree(self.default_view.root) - - if viewpath: - if name in self.views: - self.default_view.root = viewpath - else: - self.views[name] = ViewDescriptor(self.path, viewpath) - else: - self.views.pop(name, None) - - def regenerate_views(self): - if not self.views: - tty.debug("Skip view update, this environment does not" - " maintain a view") - return - - specs = self._get_environment_specs() - for view in self.views.values(): - view.regenerate(specs, self.roots()) - - def check_views(self): - """Checks if the environments default view can be activated.""" - try: - # This is effectively a no-op, but it touches all packages in the - # default view if they are installed. - for view_name, view in self.views.items(): - for _, spec in self.concretized_specs(): - if spec in view and spec.package.installed: - tty.debug( - 'Spec %s in view %s' % (spec.name, view_name)) - except (spack.repo.UnknownPackageError, - spack.repo.UnknownNamespaceError) as e: - tty.warn(e) - tty.warn( - 'Environment %s includes out of date packages or repos. ' - 'Loading the environment view will require reconcretization.' - % self.name) - - def _env_modifications_for_default_view(self, reverse=False): - all_mods = spack.util.environment.EnvironmentModifications() - - visited = set() - - errors = [] - for _, root_spec in self.concretized_specs(): - if root_spec in self.default_view and root_spec.package.installed: - for spec in root_spec.traverse(deptype='run', root=True): - if spec.name in visited: - # It is expected that only one instance of the package - # can be added to the environment - do not attempt to - # add multiple. - tty.debug( - "Not adding {0} to shell modifications: " - "this package has already been added".format( - spec.format("{name}/{hash:7}") - ) - ) - continue - else: - visited.add(spec.name) - - try: - mods = uenv.environment_modifications_for_spec( - spec, self.default_view) - except Exception as e: - msg = ("couldn't get environment settings for %s" - % spec.format("{name}@{version} /{hash:7}")) - errors.append((msg, str(e))) - continue - - all_mods.extend(mods.reversed() if reverse else mods) - - return all_mods, errors - - def add_default_view_to_shell(self, shell): - env_mod = spack.util.environment.EnvironmentModifications() - - if default_view_name not in self.views: - # No default view to add to shell - return env_mod.shell_modifications(shell) - - env_mod.extend(uenv.unconditional_environment_modifications( - self.default_view)) - - mods, errors = self._env_modifications_for_default_view() - env_mod.extend(mods) - if errors: - for err in errors: - tty.warn(*err) - - # deduplicate paths from specs mapped to the same location - for env_var in env_mod.group_by_name(): - env_mod.prune_duplicate_paths(env_var) - - return env_mod.shell_modifications(shell) - - def rm_default_view_from_shell(self, shell): - env_mod = spack.util.environment.EnvironmentModifications() - - if default_view_name not in self.views: - # No default view to add to shell - return env_mod.shell_modifications(shell) - - env_mod.extend(uenv.unconditional_environment_modifications( - self.default_view).reversed()) - - mods, _ = self._env_modifications_for_default_view(reverse=True) - env_mod.extend(mods) - - return env_mod.shell_modifications(shell) - - def _add_concrete_spec(self, spec, concrete, new=True): - """Called when a new concretized spec is added to the environment. - - This ensures that all internal data structures are kept in sync. - - Arguments: - spec (Spec): user spec that resulted in the concrete spec - concrete (Spec): spec concretized within this environment - new (bool): whether to write this spec's package to the env - repo on write() - """ - assert concrete.concrete - - # when a spec is newly concretized, we need to make a note so - # that we can write its package to the env repo on write() - if new: - self.new_specs.append(concrete) - - # update internal lists of specs - self.concretized_user_specs.append(spec) - - h = concrete.build_hash() - self.concretized_order.append(h) - self.specs_by_hash[h] = concrete - - def _spec_needs_overwrite(self, spec): - # Overwrite the install if it's a dev build (non-transitive) - # and the code has been changed since the last install - # or one of the dependencies has been reinstalled since - # the last install - - # if it's not installed, we don't need to overwrite it - if not spec.package.installed: - return False - - # if spec and all deps aren't dev builds, we don't need to overwrite it - if not any(spec.satisfies(c) - for c in ('dev_path=*', '^dev_path=*')): - return False - - # if any dep needs overwrite, or any dep is missing and is a dev build - # then overwrite this package - if any( - self._spec_needs_overwrite(dep) or - ((not dep.package.installed) and dep.satisfies('dev_path=*')) - for dep in spec.traverse(root=False) - ): - return True - - # if it's not a direct dev build and its dependencies haven't - # changed, it hasn't changed. - # We don't merely check satisfaction (spec.satisfies('dev_path=*') - # because we need the value of the variant in the next block of code - dev_path_var = spec.variants.get('dev_path', None) - if not dev_path_var: - return False - - # if it is a direct dev build, check whether the code changed - # we already know it is installed - _, record = spack.store.db.query_by_spec_hash(spec.dag_hash()) - mtime = fs.last_modification_time_recursive(dev_path_var.value) - return mtime > record.installation_time - - def _get_overwrite_specs(self): - ret = [] - for dag_hash in self.concretized_order: - spec = self.specs_by_hash[dag_hash] - ret.extend([d.dag_hash() for d in spec.traverse(root=True) - if self._spec_needs_overwrite(d)]) - - return ret - - def _install_log_links(self, spec): - if not spec.external: - # Make sure log directory exists - log_path = self.log_path - fs.mkdirp(log_path) - - with fs.working_dir(self.path): - # Link the resulting log file into logs dir - build_log_link = os.path.join( - log_path, '%s-%s.log' % (spec.name, spec.dag_hash(7))) - if os.path.lexists(build_log_link): - os.remove(build_log_link) - os.symlink(spec.package.build_log_path, build_log_link) - - def uninstalled_specs(self): - """Return a list of all uninstalled (and non-dev) specs.""" - # Do the installed check across all specs within a single - # DB read transaction to reduce time spent in lock acquisition. - uninstalled_specs = [] - with spack.store.db.read_transaction(): - for concretized_hash in self.concretized_order: - spec = self.specs_by_hash[concretized_hash] - if not spec.package.installed or ( - spec.satisfies('dev_path=*') or - spec.satisfies('^dev_path=*') - ): - uninstalled_specs.append(spec) - return uninstalled_specs - - def install_all(self, **install_args): - """Install all concretized specs in an environment. - - Note: this does not regenerate the views for the environment; - that needs to be done separately with a call to write(). - - Args: - install_args (dict): keyword install arguments - """ - self.install_specs(None, **install_args) - - def install_specs(self, specs=None, **install_args): - tty.debug('Assessing installation status of environment packages') - # If "spack install" is invoked repeatedly for a large environment - # where all specs are already installed, the operation can take - # a large amount of time due to repeatedly acquiring and releasing - # locks, this does an initial check across all specs within a single - # DB read transaction to reduce time spent in this case. In the next - # three lines we remove any already-installed root specs from the list - # to install. However, uninstalled_specs() only considers root specs, - # so this will allow dep specs to be unnecessarily re-installed. - uninstalled_roots = self.uninstalled_specs() - specs_to_install = specs or uninstalled_roots - specs_to_install = [s for s in specs_to_install - if s not in self.roots() or s in uninstalled_roots] - - # ensure specs already installed are marked explicit - all_specs = specs or [cs for _, cs in self.concretized_specs()] - specs_installed = [s for s in all_specs if s.package.installed] - with spack.store.db.write_transaction(): # do all in one transaction - for spec in specs_installed: - spack.store.db.update_explicit(spec, True) - - if not specs_to_install: - tty.msg('All of the packages are already installed') - return - - tty.debug('Processing {0} uninstalled specs'.format( - len(specs_to_install))) - - install_args['overwrite'] = install_args.get( - 'overwrite', []) + self._get_overwrite_specs() - - installs = [] - for spec in specs_to_install: - installs.append((spec.package, install_args)) - - try: - builder = PackageInstaller(installs) - builder.install() - finally: - # Ensure links are set appropriately - for spec in specs_to_install: - if spec.package.installed: - self.new_installs.append(spec) - try: - self._install_log_links(spec) - except OSError as e: - tty.warn('Could not install log links for {0}: {1}' - .format(spec.name, str(e))) - - with self.write_transaction(): - self.regenerate_views() - - def all_specs(self): - """Return all specs, even those a user spec would shadow.""" - all_specs = set() - for h in self.concretized_order: - all_specs.update(self.specs_by_hash[h].traverse()) - - return sorted(all_specs) - - def all_hashes(self): - """Return hashes of all specs. - - Note these hashes exclude build dependencies.""" - return list(set(s.dag_hash() for s in self.all_specs())) - - def roots(self): - """Specs explicitly requested by the user *in this environment*. - - Yields both added and installed specs that have user specs in - `spack.yaml`. - """ - concretized = dict(self.concretized_specs()) - for spec in self.user_specs: - concrete = concretized.get(spec) - yield concrete if concrete else spec - - def added_specs(self): - """Specs that are not yet installed. - - Yields the user spec for non-concretized specs, and the concrete - spec for already concretized but not yet installed specs. - """ - # use a transaction to avoid overhead of repeated calls - # to `package.installed` - with spack.store.db.read_transaction(): - concretized = dict(self.concretized_specs()) - for spec in self.user_specs: - concrete = concretized.get(spec) - if not concrete: - yield spec - elif not concrete.package.installed: - yield concrete - - def concretized_specs(self): - """Tuples of (user spec, concrete spec) for all concrete specs.""" - for s, h in zip(self.concretized_user_specs, self.concretized_order): - yield (s, self.specs_by_hash[h]) - - def matching_spec(self, spec): - """ - Given a spec (likely not concretized), find a matching concretized - spec in the environment. - - The matching spec does not have to be installed in the environment, - but must be concrete (specs added with `spack add` without an - intervening `spack concretize` will not be matched). - - If there is a single root spec that matches the provided spec or a - single dependency spec that matches the provided spec, then the - concretized instance of that spec will be returned. - - If multiple root specs match the provided spec, or no root specs match - and multiple dependency specs match, then this raises an error - and reports all matching specs. - """ - # Root specs will be keyed by concrete spec, value abstract - # Dependency-only specs will have value None - matches = {} - - if not isinstance(spec, spack.spec.Spec): - spec = spack.spec.Spec(spec) - - for user_spec, concretized_user_spec in self.concretized_specs(): - # Deal with concrete specs differently - if spec.concrete: - # Matching a concrete spec is more restrictive - # than just matching the dag hash - is_match = ( - spec in concretized_user_spec and - concretized_user_spec[spec.name].build_hash() == spec.build_hash() - ) - if is_match: - matches[spec] = spec - continue - - if concretized_user_spec.satisfies(spec): - matches[concretized_user_spec] = user_spec - for dep_spec in concretized_user_spec.traverse(root=False): - if dep_spec.satisfies(spec): - # Don't overwrite the abstract spec if present - # If not present already, set to None - matches[dep_spec] = matches.get(dep_spec, None) - - if not matches: - return None - elif len(matches) == 1: - return list(matches.keys())[0] - - root_matches = dict((concrete, abstract) - for concrete, abstract in matches.items() - if abstract) - - if len(root_matches) == 1: - return list(root_matches.items())[0][0] - - # More than one spec matched, and either multiple roots matched or - # none of the matches were roots - # If multiple root specs match, it is assumed that the abstract - # spec will most-succinctly summarize the difference between them - # (and the user can enter one of these to disambiguate) - match_strings = [] - fmt_str = '{hash:7} ' + spack.spec.default_format - for concrete, abstract in matches.items(): - if abstract: - s = 'Root spec %s\n %s' % (abstract, concrete.format(fmt_str)) - else: - s = 'Dependency spec\n %s' % concrete.format(fmt_str) - match_strings.append(s) - matches_str = '\n'.join(match_strings) - - msg = ("{0} matches multiple specs in the environment {1}: \n" - "{2}".format(str(spec), self.name, matches_str)) - raise SpackEnvironmentError(msg) - - def removed_specs(self): - """Tuples of (user spec, concrete spec) for all specs that will be - removed on nexg concretize.""" - needed = set() - for s, c in self.concretized_specs(): - if s in self.user_specs: - for d in c.traverse(): - needed.add(d) - - for s, c in self.concretized_specs(): - for d in c.traverse(): - if d not in needed: - yield d - - def _get_environment_specs(self, recurse_dependencies=True): - """Returns the specs of all the packages in an environment. - - If these specs appear under different user_specs, only one copy - is added to the list returned. - """ - spec_list = list() - - for spec_hash in self.concretized_order: - spec = self.specs_by_hash[spec_hash] - - specs = (spec.traverse(deptype=('link', 'run')) - if recurse_dependencies else (spec,)) - - spec_list.extend(specs) - - return spec_list - - def _to_lockfile_dict(self): - """Create a dictionary to store a lockfile for this environment.""" - concrete_specs = {} - for spec in self.specs_by_hash.values(): - for s in spec.traverse(): - build_hash = s.build_hash() - if build_hash not in concrete_specs: - spec_dict = s.to_node_dict(hash=ht.build_hash) - # Assumes no legacy formats, since this was just created. - spec_dict[ht.dag_hash.name] = s.dag_hash() - concrete_specs[build_hash] = spec_dict - - hash_spec_list = zip( - self.concretized_order, self.concretized_user_specs) - - # this is the lockfile we'll write out - data = { - # metadata about the format - '_meta': { - 'file-type': 'spack-lockfile', - 'lockfile-version': lockfile_format_version, - 'specfile-version': spack.spec.specfile_format_version - }, - - # users specs + hashes are the 'roots' of the environment - 'roots': [{ - 'hash': h, - 'spec': str(s) - } for h, s in hash_spec_list], - - # Concrete specs by hash, including dependencies - 'concrete_specs': concrete_specs, - } - - return data - - def _read_lockfile(self, file_or_json): - """Read a lockfile from a file or from a raw string.""" - lockfile_dict = sjson.load(file_or_json) - self._read_lockfile_dict(lockfile_dict) - return lockfile_dict['_meta']['lockfile-version'] - - def _read_lockfile_dict(self, d): - """Read a lockfile dictionary into this environment.""" - roots = d['roots'] - self.concretized_user_specs = [Spec(r['spec']) for r in roots] - self.concretized_order = [r['hash'] for r in roots] - - json_specs_by_hash = d['concrete_specs'] - root_hashes = set(self.concretized_order) - - specs_by_hash = {} - for build_hash, node_dict in json_specs_by_hash.items(): - spec = Spec.from_node_dict(node_dict) - if d['_meta']['lockfile-version'] > 1: - # Build hash is stored as a key, but not as part of the node dict - # To ensure build hashes are not recomputed, we reattach here - setattr(spec, ht.build_hash.attr, build_hash) - specs_by_hash[build_hash] = spec - - for build_hash, node_dict in json_specs_by_hash.items(): - for _, dep_hash, deptypes, _ in ( - Spec.dependencies_from_node_dict(node_dict)): - specs_by_hash[build_hash]._add_dependency( - specs_by_hash[dep_hash], deptypes) - - # If we are reading an older lockfile format (which uses dag hashes - # that exclude build deps), we use this to convert the old - # concretized_order to the full hashes (preserving the order) - old_hash_to_new = {} - self.specs_by_hash = {} - for _, spec in specs_by_hash.items(): - dag_hash = spec.dag_hash() - build_hash = spec.build_hash() - if dag_hash in root_hashes: - old_hash_to_new[dag_hash] = build_hash - - if (dag_hash in root_hashes or build_hash in root_hashes): - self.specs_by_hash[build_hash] = spec - - if old_hash_to_new: - # Replace any older hashes in concretized_order with hashes - # that include build deps - self.concretized_order = [ - old_hash_to_new.get(h, h) for h in self.concretized_order] - - def write(self, regenerate=True): - """Writes an in-memory environment to its location on disk. - - Write out package files for each newly concretized spec. Also - regenerate any views associated with the environment and run post-write - hooks, if regenerate is True. - - Arguments: - regenerate (bool): regenerate views and run post-write hooks as - well as writing if True. - """ - # Intercept environment not using the latest schema format and prevent - # them from being modified - manifest_exists = os.path.exists(self.manifest_path) - if manifest_exists and not is_latest_format(self.manifest_path): - msg = ('The environment "{0}" needs to be written to disk, but ' - 'is currently using a deprecated format. Please update it ' - 'using:\n\n' - '\tspack env update {0}\n\n' - 'Note that previous versions of Spack will not be able to ' - 'use the updated configuration.') - raise RuntimeError(msg.format(self.name)) - - # ensure path in var/spack/environments - fs.mkdirp(self.path) - - yaml_dict = config_dict(self.yaml) - raw_yaml_dict = config_dict(self.raw_yaml) - - if self.specs_by_hash: - # ensure the prefix/.env directory exists - fs.mkdirp(self.env_subdir_path) - - for spec in self.new_specs: - for dep in spec.traverse(): - if not dep.concrete: - raise ValueError('specs passed to environment.write() ' - 'must be concrete!') - - root = os.path.join(self.repos_path, dep.namespace) - repo = spack.repo.create_or_construct(root, dep.namespace) - pkg_dir = repo.dirname_for_package_name(dep.name) - - fs.mkdirp(pkg_dir) - spack.repo.path.dump_provenance(dep, pkg_dir) - - # write the lock file last - with fs.write_tmp_and_move(self.lock_path) as f: - sjson.dump(self._to_lockfile_dict(), stream=f) - self._update_and_write_manifest(raw_yaml_dict, yaml_dict) - else: - with fs.safe_remove(self.lock_path): - self._update_and_write_manifest(raw_yaml_dict, yaml_dict) - - # TODO: rethink where this needs to happen along with - # writing. For some of the commands (like install, which write - # concrete specs AND regen) this might as well be a separate - # call. But, having it here makes the views consistent witht the - # concretized environment for most operations. Which is the - # special case? - if regenerate: - self.regenerate_views() - - # Run post_env_hooks - spack.hooks.post_env_write(self) - - # new specs and new installs reset at write time - self.new_specs = [] - self.new_installs = [] - - def _update_and_write_manifest(self, raw_yaml_dict, yaml_dict): - """Update YAML manifest for this environment based on changes to - spec lists and views and write it. - """ - # invalidate _repo cache - self._repo = None - # put any changes in the definitions in the YAML - for name, speclist in self.spec_lists.items(): - if name == user_speclist_name: - # The primary list is handled differently - continue - - active_yaml_lists = [x for x in yaml_dict.get('definitions', []) - if name in x and - _eval_conditional(x.get('when', 'True'))] - - # Remove any specs in yaml that are not in internal representation - for ayl in active_yaml_lists: - # If it's not a string, it's a matrix. Those can't have changed - # If it is a string that starts with '$', it's a reference. - # Those also can't have changed. - ayl[name][:] = [s for s in ayl.setdefault(name, []) - if (not isinstance(s, six.string_types)) or - s.startswith('$') or Spec(s) in speclist.specs] - - # Put the new specs into the first active list from the yaml - new_specs = [entry for entry in speclist.yaml_list - if isinstance(entry, six.string_types) and - not any(entry in ayl[name] - for ayl in active_yaml_lists)] - list_for_new_specs = active_yaml_lists[0].setdefault(name, []) - list_for_new_specs[:] = list_for_new_specs + new_specs - # put the new user specs in the YAML. - # This can be done directly because there can't be multiple definitions - # nor when clauses for `specs` list. - yaml_spec_list = yaml_dict.setdefault(user_speclist_name, - []) - yaml_spec_list[:] = self.user_specs.yaml_list - # Construct YAML representation of view - default_name = default_view_name - if self.views and len(self.views) == 1 and default_name in self.views: - path = self.default_view.root - if self.default_view == ViewDescriptor(self.path, - self.view_path_default): - view = True - elif self.default_view == ViewDescriptor(self.path, path): - view = path - else: - view = dict((name, view.to_dict()) - for name, view in self.views.items()) - elif self.views: - view = dict((name, view.to_dict()) - for name, view in self.views.items()) - else: - view = False - yaml_dict['view'] = view - - if self.dev_specs: - # Remove entries that are mirroring defaults - write_dev_specs = copy.deepcopy(self.dev_specs) - for name, entry in write_dev_specs.items(): - if entry['path'] == name: - del entry['path'] - yaml_dict['develop'] = write_dev_specs - else: - yaml_dict.pop('develop', None) - - # Remove yaml sections that are shadowing defaults - # construct garbage path to ensure we don't find a manifest by accident - with fs.temp_cwd() as env_dir: - bare_env = Environment(env_dir, with_view=self.view_path_default) - keys_present = list(yaml_dict.keys()) - for key in keys_present: - if yaml_dict[key] == config_dict(bare_env.yaml).get(key, None): - if key not in raw_yaml_dict: - del yaml_dict[key] - # if all that worked, write out the manifest file at the top level - # (we used to check whether the yaml had changed and not write it out - # if it hadn't. We can't do that anymore because it could be the only - # thing that changed is the "override" attribute on a config dict, - # which would not show up in even a string comparison between the two - # keys). - changed = not yaml_equivalent(self.yaml, self.raw_yaml) - written = os.path.exists(self.manifest_path) - if changed or not written: - self.raw_yaml = copy.deepcopy(self.yaml) - with fs.write_tmp_and_move(os.path.realpath(self.manifest_path)) as f: - _write_yaml(self.yaml, f) - - def __enter__(self): - self._previous_active = _active_environment - activate(self) - return self - - def __exit__(self, exc_type, exc_val, exc_tb): - deactivate() - if self._previous_active: - activate(self._previous_active) - - -def yaml_equivalent(first, second): - """Returns whether two spack yaml items are equivalent, including overrides - """ - if isinstance(first, dict): - return isinstance(second, dict) and _equiv_dict(first, second) - elif isinstance(first, list): - return isinstance(second, list) and _equiv_list(first, second) - else: # it's a string - return isinstance(second, six.string_types) and first == second - - -def _equiv_list(first, second): - """Returns whether two spack yaml lists are equivalent, including overrides - """ - if len(first) != len(second): - return False - return all(yaml_equivalent(f, s) for f, s in zip(first, second)) - - -def _equiv_dict(first, second): - """Returns whether two spack yaml dicts are equivalent, including overrides - """ - if len(first) != len(second): - return False - same_values = all(yaml_equivalent(fv, sv) - for fv, sv in zip(first.values(), second.values())) - same_keys_with_same_overrides = all( - fk == sk and getattr(fk, 'override', False) == getattr(sk, 'override', - False) - for fk, sk in zip(first.keys(), second.keys())) - return same_values and same_keys_with_same_overrides - - -def display_specs(concretized_specs): - """Displays the list of specs returned by `Environment.concretize()`. - - Args: - concretized_specs (list): list of specs returned by - `Environment.concretize()` - """ - def _tree_to_display(spec): - return spec.tree( - recurse_dependencies=True, - status_fn=spack.spec.Spec.install_status, - hashlen=7, hashes=True) - - for user_spec, concrete_spec in concretized_specs: - tty.msg('Concretized {0}'.format(user_spec)) - sys.stdout.write(_tree_to_display(concrete_spec)) - print('') - - -def _concretize_from_constraints(spec_constraints, tests=False): - # Accept only valid constraints from list and concretize spec - # Get the named spec even if out of order - root_spec = [s for s in spec_constraints if s.name] - if len(root_spec) != 1: - m = 'The constraints %s are not a valid spec ' % spec_constraints - m += 'concretization target. all specs must have a single name ' - m += 'constraint for concretization.' - raise InvalidSpecConstraintError(m) - spec_constraints.remove(root_spec[0]) - - invalid_constraints = [] - while True: - # Attach all anonymous constraints to one named spec - s = root_spec[0].copy() - for c in spec_constraints: - if c not in invalid_constraints: - s.constrain(c) - try: - return s.concretized(tests=tests) - except spack.spec.InvalidDependencyError as e: - invalid_deps_string = ['^' + d for d in e.invalid_deps] - invalid_deps = [c for c in spec_constraints - if any(c.satisfies(invd, strict=True) - for invd in invalid_deps_string)] - if len(invalid_deps) != len(invalid_deps_string): - raise e - invalid_constraints.extend(invalid_deps) - except UnknownVariantError as e: - invalid_variants = e.unknown_variants - inv_variant_constraints = [c for c in spec_constraints - if any(name in c.variants - for name in invalid_variants)] - if len(inv_variant_constraints) != len(invalid_variants): - raise e - invalid_constraints.extend(inv_variant_constraints) - - -def make_repo_path(root): - """Make a RepoPath from the repo subdirectories in an environment.""" - path = spack.repo.RepoPath() - - if os.path.isdir(root): - for repo_root in os.listdir(root): - repo_root = os.path.join(root, repo_root) - - if not os.path.isdir(repo_root): - continue - - repo = spack.repo.Repo(repo_root) - path.put_last(repo) - - return path - - -def prepare_config_scope(env): - """Add env's scope to the global configuration search path.""" - for scope in env.config_scopes(): - spack.config.config.push_scope(scope) - - -def deactivate_config_scope(env): - """Remove any scopes from env from the global config path.""" - for scope in env.config_scopes(): - spack.config.config.remove_scope(scope.name) - - -def manifest_file(env_name_or_dir): - """Return the absolute path to a manifest file given the environment - name or directory. - - Args: - env_name_or_dir (str): either the name of a valid environment - or a directory where a manifest file resides - - Raises: - AssertionError: if the environment is not found - """ - env_dir = None - if is_env_dir(env_name_or_dir): - env_dir = os.path.abspath(env_name_or_dir) - elif exists(env_name_or_dir): - env_dir = os.path.abspath(root(env_name_or_dir)) - - assert env_dir, "environment not found [env={0}]".format(env_name_or_dir) - return os.path.join(env_dir, manifest_name) - - -def update_yaml(manifest, backup_file): - """Update a manifest file from an old format to the current one. - - Args: - manifest (str): path to a manifest file - backup_file (str): file where to copy the original manifest - - Returns: - True if the manifest was updated, False otherwise. - - Raises: - AssertionError: in case anything goes wrong during the update - """ - # Check if the environment needs update - with open(manifest) as f: - data = syaml.load(f) - - top_level_key = _top_level_key(data) - needs_update = spack.schema.env.update(data[top_level_key]) - if not needs_update: - msg = "No update needed [manifest={0}]".format(manifest) - tty.debug(msg) - return False - - # Copy environment to a backup file and update it - msg = ('backup file "{0}" already exists on disk. Check its content ' - 'and remove it before trying to update again.') - assert not os.path.exists(backup_file), msg.format(backup_file) - - shutil.copy(manifest, backup_file) - with open(manifest, 'w') as f: - syaml.dump_config(data, f) - return True - - -def _top_level_key(data): - """Return the top level key used in this environment - - Args: - data (dict): raw yaml data of the environment - - Returns: - Either 'spack' or 'env' - """ - msg = ('cannot find top level attribute "spack" or "env"' - 'in the environment') - assert any(x in data for x in ('spack', 'env')), msg - if 'spack' in data: - return 'spack' - return 'env' - - -def is_latest_format(manifest): - """Return True if the manifest file is at the latest schema format, - False otherwise. - - Args: - manifest (str): manifest file to be analyzed - """ - with open(manifest) as f: - data = syaml.load(f) - top_level_key = _top_level_key(data) - changed = spack.schema.env.update(data[top_level_key]) - return not changed - - -@contextlib.contextmanager -def deactivate_environment(): - """Deactivate an active environment for the duration of the context.""" - global _active_environment - current, _active_environment = _active_environment, None - try: - yield - finally: - _active_environment = current - - -class SpackEnvironmentError(spack.error.SpackError): - """Superclass for all errors to do with Spack environments.""" - - -class SpackEnvironmentViewError(SpackEnvironmentError): - """Class for errors regarding view generation.""" diff --git a/lib/spack/spack/environment/__init__.py b/lib/spack/spack/environment/__init__.py new file mode 100644 index 0000000000..0f04162b35 --- /dev/null +++ b/lib/spack/spack/environment/__init__.py @@ -0,0 +1,57 @@ +# Copyright 2013-2021 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) +from .environment import ( + Environment, + SpackEnvironmentError, + activate, + active, + active_environment, + all_environment_names, + all_environments, + config_dict, + create, + deactivate, + default_manifest_yaml, + default_view_name, + display_specs, + exists, + is_env_dir, + is_latest_format, + lockfile_name, + manifest_file, + manifest_name, + no_active_environment, + read, + root, + spack_env_var, + update_yaml, +) + +__all__ = [ + 'Environment', + 'SpackEnvironmentError', + 'activate', + 'active', + 'active_environment', + 'all_environment_names', + 'all_environments', + 'config_dict', + 'create', + 'deactivate', + 'default_manifest_yaml', + 'default_view_name', + 'display_specs', + 'exists', + 'is_env_dir', + 'is_latest_format', + 'lockfile_name', + 'manifest_file', + 'manifest_name', + 'no_active_environment', + 'read', + 'root', + 'spack_env_var', + 'update_yaml', +] diff --git a/lib/spack/spack/environment/environment.py b/lib/spack/spack/environment/environment.py new file mode 100644 index 0000000000..88dd545398 --- /dev/null +++ b/lib/spack/spack/environment/environment.py @@ -0,0 +1,2088 @@ +# Copyright 2013-2021 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 collections +import contextlib +import copy +import os +import re +import shutil +import sys + +import ruamel.yaml as yaml +import six +from ordereddict_backport import OrderedDict + +import llnl.util.filesystem as fs +import llnl.util.tty as tty + +import spack.concretize +import spack.config +import spack.error +import spack.hash_types as ht +import spack.hooks +import spack.paths +import spack.repo +import spack.schema.env +import spack.spec +import spack.stage +import spack.store +import spack.user_environment as uenv +import spack.util.environment +import spack.util.hash +import spack.util.lock as lk +import spack.util.path +import spack.util.spack_json as sjson +import spack.util.spack_yaml as syaml +from spack.filesystem_view import ( + YamlFilesystemView, + inverse_view_func_parser, + view_func_parser, +) +from spack.installer import PackageInstaller +from spack.spec import Spec +from spack.spec_list import InvalidSpecConstraintError, SpecList +from spack.util.path import substitute_path_variables +from spack.variant import UnknownVariantError + +#: environment variable used to indicate the active environment +spack_env_var = 'SPACK_ENV' + + +#: currently activated environment +_active_environment = None + + +#: path where environments are stored in the spack tree +env_path = os.path.join(spack.paths.var_path, 'environments') + + +#: Name of the input yaml file for an environment +manifest_name = 'spack.yaml' + + +#: Name of the input yaml file for an environment +lockfile_name = 'spack.lock' + + +#: Name of the directory where environments store repos, logs, views +env_subdir_name = '.spack-env' + + +#: default spack.yaml file to put in new environments +default_manifest_yaml = """\ +# This is a Spack Environment file. +# +# It describes a set of packages to be installed, along with +# configuration settings. +spack: + # add package specs to the `specs` list + specs: [] + view: true +""" +#: regex for validating enviroment names +valid_environment_name_re = r'^\w[\w-]*$' + +#: version of the lockfile format. Must increase monotonically. +lockfile_format_version = 3 + +# Magic names +# The name of the standalone spec list in the manifest yaml +user_speclist_name = 'specs' +# The name of the default view (the view loaded on env.activate) +default_view_name = 'default' +# Default behavior to link all packages into views (vs. only root packages) +default_view_link = 'all' + + +def valid_env_name(name): + return re.match(valid_environment_name_re, name) + + +def validate_env_name(name): + if not valid_env_name(name): + raise ValueError(( + "'%s': names must start with a letter, and only contain " + "letters, numbers, _, and -.") % name) + return name + + +def activate(env, use_env_repo=False): + """Activate an environment. + + To activate an environment, we add its configuration scope to the + existing Spack configuration, and we set active to the current + environment. + + Arguments: + env (Environment): the environment to activate + use_env_repo (bool): use the packages exactly as they appear in the + environment's repository + """ + global _active_environment + + # Fail early to avoid ending in an invalid state + if not isinstance(env, Environment): + raise TypeError("`env` should be of type {0}".format(Environment.__name__)) + + prepare_config_scope(env) + + if use_env_repo: + spack.repo.path.put_first(env.repo) + + tty.debug("Using environment '%s'" % env.name) + + # Do this last, because setting up the config must succeed first. + _active_environment = env + + +def deactivate(): + """Undo any configuration or repo settings modified by ``activate()``.""" + global _active_environment + + if not _active_environment: + return + + deactivate_config_scope(_active_environment) + + # use _repo so we only remove if a repo was actually constructed + if _active_environment._repo: + spack.repo.path.remove(_active_environment._repo) + + tty.debug("Deactivated environment '%s'" % _active_environment.name) + + _active_environment = None + + +def active_environment(): + """Returns the active environment when there is any""" + return _active_environment + + +def _root(name): + """Non-validating version of root(), to be used internally.""" + return os.path.join(env_path, name) + + +def root(name): + """Get the root directory for an environment by name.""" + validate_env_name(name) + return _root(name) + + +def exists(name): + """Whether an environment with this name exists or not.""" + if not valid_env_name(name): + return False + return os.path.isdir(root(name)) + + +def active(name): + """True if the named environment is active.""" + return _active_environment and name == _active_environment.name + + +def is_env_dir(path): + """Whether a directory contains a spack environment.""" + return os.path.isdir(path) and os.path.exists( + os.path.join(path, manifest_name)) + + +def read(name): + """Get an environment with the supplied name.""" + validate_env_name(name) + if not exists(name): + raise SpackEnvironmentError("no such environment '%s'" % name) + return Environment(root(name)) + + +def create(name, init_file=None, with_view=None, keep_relative=False): + """Create a named environment in Spack.""" + validate_env_name(name) + if exists(name): + raise SpackEnvironmentError("'%s': environment already exists" % name) + return Environment(root(name), init_file, with_view, keep_relative) + + +def config_dict(yaml_data): + """Get the configuration scope section out of an spack.yaml""" + key = spack.config.first_existing(yaml_data, spack.schema.env.keys) + return yaml_data[key] + + +def all_environment_names(): + """List the names of environments that currently exist.""" + # just return empty if the env path does not exist. A read-only + # operation like list should not try to create a directory. + if not os.path.exists(env_path): + return [] + + candidates = sorted(os.listdir(env_path)) + names = [] + for candidate in candidates: + yaml_path = os.path.join(_root(candidate), manifest_name) + if valid_env_name(candidate) and os.path.exists(yaml_path): + names.append(candidate) + return names + + +def all_environments(): + """Generator for all named Environments.""" + for name in all_environment_names(): + yield read(name) + + +def _read_yaml(str_or_file): + """Read YAML from a file for round-trip parsing.""" + data = syaml.load_config(str_or_file) + filename = getattr(str_or_file, 'name', None) + default_data = spack.config.validate( + data, spack.schema.env.schema, filename) + return (data, default_data) + + +def _write_yaml(data, str_or_file): + """Write YAML to a file preserving comments and dict order.""" + filename = getattr(str_or_file, 'name', None) + spack.config.validate(data, spack.schema.env.schema, filename) + syaml.dump_config(data, str_or_file, default_flow_style=False) + + +def _eval_conditional(string): + """Evaluate conditional definitions using restricted variable scope.""" + valid_variables = spack.util.environment.get_host_environment() + valid_variables.update({ + 're': re, + 'env': os.environ, + }) + return eval(string, valid_variables) + + +class ViewDescriptor(object): + def __init__(self, base_path, root, projections={}, select=[], exclude=[], + link=default_view_link, link_type='symlink'): + self.base = base_path + self.root = spack.util.path.canonicalize_path(root) + self.projections = projections + self.select = select + self.exclude = exclude + self.link_type = view_func_parser(link_type) + self.link = link + + def select_fn(self, spec): + return any(spec.satisfies(s) for s in self.select) + + def exclude_fn(self, spec): + return not any(spec.satisfies(e) for e in self.exclude) + + def __eq__(self, other): + return all([self.root == other.root, + self.projections == other.projections, + self.select == other.select, + self.exclude == other.exclude, + self.link == other.link, + self.link_type == other.link_type]) + + def to_dict(self): + ret = syaml.syaml_dict([('root', self.root)]) + if self.projections: + # projections guaranteed to be ordered dict if true-ish + # for python2.6, may be syaml or ruamel.yaml implementation + # so we have to check for both + types = (OrderedDict, syaml.syaml_dict, yaml.comments.CommentedMap) + assert isinstance(self.projections, types) + ret['projections'] = self.projections + if self.select: + ret['select'] = self.select + if self.exclude: + ret['exclude'] = self.exclude + if self.link_type: + ret['link_type'] = inverse_view_func_parser(self.link_type) + if self.link != default_view_link: + ret['link'] = self.link + return ret + + @staticmethod + def from_dict(base_path, d): + return ViewDescriptor(base_path, + d['root'], + d.get('projections', {}), + d.get('select', []), + d.get('exclude', []), + d.get('link', default_view_link), + d.get('link_type', 'symlink')) + + @property + def _current_root(self): + if not os.path.islink(self.root): + return None + + root = os.readlink(self.root) + if os.path.isabs(root): + return root + + root_dir = os.path.dirname(self.root) + return os.path.join(root_dir, root) + + def _next_root(self, specs): + content_hash = self.content_hash(specs) + root_dir = os.path.dirname(self.root) + root_name = os.path.basename(self.root) + return os.path.join(root_dir, '._%s' % root_name, content_hash) + + def content_hash(self, specs): + d = syaml.syaml_dict([ + ('descriptor', self.to_dict()), + ('specs', [(spec.full_hash(), spec.prefix) for spec in sorted(specs)]) + ]) + contents = sjson.dump(d) + return spack.util.hash.b32_hash(contents) + + def get_projection_for_spec(self, spec): + """Get projection for spec relative to view root + + Getting the projection from the underlying root will get the temporary + projection. This gives the permanent projection relative to the root + symlink. + """ + view = self.view() + view_path = view.get_projection_for_spec(spec) + rel_path = os.path.relpath(view_path, self._current_root) + return os.path.join(self.root, rel_path) + + def view(self, new=None): + """ + Generate the FilesystemView object for this ViewDescriptor + + By default, this method returns a FilesystemView object rooted at the + current underlying root of this ViewDescriptor (self._current_root) + + Raise if new is None and there is no current view + + Arguments: + new (str or None): If a string, create a FilesystemView + rooted at that path. Default None. This should only be used to + regenerate the view, and cannot be used to access specs. + """ + root = self._current_root + if new: + root = new + if not root: + # This can only be hit if we write a future bug + msg = ("Attempting to get nonexistent view from environment. " + "View root is at %s" % self.root) + raise SpackEnvironmentViewError(msg) + return YamlFilesystemView(root, spack.store.layout, + ignore_conflicts=True, + projections=self.projections, + link=self.link_type) + + def __contains__(self, spec): + """Is the spec described by the view descriptor + + Note: This does not claim the spec is already linked in the view. + It merely checks that the spec is selected if a select operation is + specified and is not excluded if an exclude operator is specified. + """ + if self.select: + if not self.select_fn(spec): + return False + + if self.exclude: + if not self.exclude_fn(spec): + return False + + return True + + def specs_for_view(self, all_specs, roots): + specs_for_view = [] + specs = all_specs if self.link == 'all' else roots + + for spec in specs: + # The view does not store build deps, so if we want it to + # recognize environment specs (which do store build deps), + # then they need to be stripped. + if spec.concrete: # Do not link unconcretized roots + # We preserve _hash _normal to avoid recomputing DAG + # hashes (DAG hashes don't consider build deps) + spec_copy = spec.copy(deps=('link', 'run')) + spec_copy._hash = spec._hash + spec_copy._normal = spec._normal + specs_for_view.append(spec_copy) + return specs_for_view + + def regenerate(self, all_specs, roots): + specs_for_view = self.specs_for_view(all_specs, roots) + + # regeneration queries the database quite a bit; this read + # transaction ensures that we don't repeatedly lock/unlock. + with spack.store.db.read_transaction(): + installed_specs_for_view = set( + s for s in specs_for_view if s in self and s.package.installed) + + # To ensure there are no conflicts with packages being installed + # that cannot be resolved or have repos that have been removed + # we always regenerate the view from scratch. + # We will do this by hashing the view contents and putting the view + # in a directory by hash, and then having a symlink to the real + # view in the root. The real root for a view at /dirname/basename + # will be /dirname/._basename_. + # This allows for atomic swaps when we update the view + + # cache the roots because the way we determine which is which does + # not work while we are updating + new_root = self._next_root(installed_specs_for_view) + old_root = self._current_root + + if new_root == old_root: + tty.debug("View at %s does not need regeneration." % self.root) + return + + # construct view at new_root + tty.msg("Updating view at {0}".format(self.root)) + + view = self.view(new=new_root) + fs.mkdirp(new_root) + view.add_specs(*installed_specs_for_view, + with_dependencies=False) + + # create symlink from tmpname to new_root + root_dirname = os.path.dirname(self.root) + tmp_symlink_name = os.path.join(root_dirname, '._view_link') + if os.path.exists(tmp_symlink_name): + os.unlink(tmp_symlink_name) + os.symlink(new_root, tmp_symlink_name) + + # mv symlink atomically over root symlink to old_root + if os.path.exists(self.root) and not os.path.islink(self.root): + msg = "Cannot create view: " + msg += "file already exists and is not a link: %s" % self.root + raise SpackEnvironmentViewError(msg) + os.rename(tmp_symlink_name, self.root) + + # remove old_root + if old_root and os.path.exists(old_root): + try: + shutil.rmtree(old_root) + except (IOError, OSError) as e: + msg = "Failed to remove old view at %s\n" % old_root + msg += str(e) + tty.warn(msg) + + +def _create_environment(*args, **kwargs): + return Environment(*args, **kwargs) + + +class Environment(object): + def __init__(self, path, init_file=None, with_view=None, keep_relative=False): + """Create a new environment. + + The environment can be optionally initialized with either a + spack.yaml or spack.lock file. + + Arguments: + path (str): path to the root directory of this environment + init_file (str or file object): filename or file object to + initialize the environment + with_view (str or bool): whether a view should be maintained for + the environment. If the value is a string, it specifies the + path to the view. + keep_relative (bool): if True, develop paths are copied verbatim + into the new environment file, otherwise they are made absolute + when the environment path is different from init_file's + directory. + """ + self.path = os.path.abspath(path) + self.init_file = init_file + self.with_view = with_view + self.keep_relative = keep_relative + + self.txlock = lk.Lock(self._transaction_lock_path) + + # This attribute will be set properly from configuration + # during concretization + self.concretization = None + self.clear() + + if init_file: + # If we are creating the environment from an init file, we don't + # need to lock, because there are no Spack operations that alter + # the init file. + with fs.open_if_filename(init_file) as f: + if hasattr(f, 'name') and f.name.endswith('.lock'): + self._read_manifest(default_manifest_yaml) + self._read_lockfile(f) + self._set_user_specs_from_lockfile() + else: + self._read_manifest(f, raw_yaml=default_manifest_yaml) + + # Rewrite relative develop paths when initializing a new + # environment in a different location from the spack.yaml file. + if not keep_relative and hasattr(f, 'name') and \ + f.name.endswith('.yaml'): + init_file_dir = os.path.abspath(os.path.dirname(f.name)) + self._rewrite_relative_paths_on_relocation(init_file_dir) + else: + with lk.ReadTransaction(self.txlock): + self._read() + + if with_view is False: + self.views = {} + elif with_view is True: + self.views = { + default_view_name: ViewDescriptor(self.path, + self.view_path_default)} + elif isinstance(with_view, six.string_types): + self.views = {default_view_name: ViewDescriptor(self.path, + with_view)} + # If with_view is None, then defer to the view settings determined by + # the manifest file + + def __reduce__(self): + return _create_environment, ( + self.path, self.init_file, self.with_view, self.keep_relative + ) + + def _rewrite_relative_paths_on_relocation(self, init_file_dir): + """When initializing the environment from a manifest file and we plan + to store the environment in a different directory, we have to rewrite + relative paths to absolute ones.""" + if init_file_dir == self.path: + return + + for name, entry in self.dev_specs.items(): + dev_path = entry['path'] + expanded_path = os.path.normpath(os.path.join( + init_file_dir, entry['path'])) + + # Skip if the expanded path is the same (e.g. when absolute) + if dev_path == expanded_path: + continue + + tty.debug("Expanding develop path for {0} to {1}".format( + name, expanded_path)) + + self.dev_specs[name]['path'] = expanded_path + + def _re_read(self): + """Reinitialize the environment object if it has been written (this + may not be true if the environment was just created in this running + instance of Spack).""" + if not os.path.exists(self.manifest_path): + return + + self.clear(re_read=True) + self._read() + + def _read(self): + default_manifest = not os.path.exists(self.manifest_path) + if default_manifest: + # No manifest, use default yaml + self._read_manifest(default_manifest_yaml) + else: + with open(self.manifest_path) as f: + self._read_manifest(f) + + if os.path.exists(self.lock_path): + with open(self.lock_path) as f: + read_lock_version = self._read_lockfile(f) + if default_manifest: + # No manifest, set user specs from lockfile + self._set_user_specs_from_lockfile() + + if read_lock_version == 1: + tty.debug( + "Storing backup of old lockfile {0} at {1}".format( + self.lock_path, self._lock_backup_v1_path)) + shutil.copy(self.lock_path, self._lock_backup_v1_path) + + def write_transaction(self): + """Get a write lock context manager for use in a `with` block.""" + return lk.WriteTransaction(self.txlock, acquire=self._re_read) + + def _read_manifest(self, f, raw_yaml=None): + """Read manifest file and set up user specs.""" + if raw_yaml: + _, self.yaml = _read_yaml(f) + self.raw_yaml, _ = _read_yaml(raw_yaml) + else: + self.raw_yaml, self.yaml = _read_yaml(f) + + self.spec_lists = OrderedDict() + + for item in config_dict(self.yaml).get('definitions', []): + entry = copy.deepcopy(item) + when = _eval_conditional(entry.pop('when', 'True')) + assert len(entry) == 1 + if when: + name, spec_list = next(iter(entry.items())) + user_specs = SpecList(name, spec_list, self.spec_lists.copy()) + if name in self.spec_lists: + self.spec_lists[name].extend(user_specs) + else: + self.spec_lists[name] = user_specs + + spec_list = config_dict(self.yaml).get(user_speclist_name, []) + user_specs = SpecList(user_speclist_name, [s for s in spec_list if s], + self.spec_lists.copy()) + self.spec_lists[user_speclist_name] = user_specs + + enable_view = config_dict(self.yaml).get('view') + # enable_view can be boolean, string, or None + if enable_view is True or enable_view is None: + self.views = { + default_view_name: ViewDescriptor(self.path, + self.view_path_default)} + elif isinstance(enable_view, six.string_types): + self.views = {default_view_name: ViewDescriptor(self.path, + enable_view)} + elif enable_view: + path = self.path + self.views = dict((name, ViewDescriptor.from_dict(path, values)) + for name, values in enable_view.items()) + else: + self.views = {} + # Retrieve the current concretization strategy + configuration = config_dict(self.yaml) + # default concretization to separately + self.concretization = configuration.get('concretization', 'separately') + + # Retrieve dev-build packages: + self.dev_specs = configuration.get('develop', {}) + for name, entry in self.dev_specs.items(): + # spec must include a concrete version + assert Spec(entry['spec']).version.concrete + # default path is the spec name + if 'path' not in entry: + self.dev_specs[name]['path'] = name + + @property + def user_specs(self): + return self.spec_lists[user_speclist_name] + + def _set_user_specs_from_lockfile(self): + """Copy user_specs from a read-in lockfile.""" + self.spec_lists = { + user_speclist_name: SpecList( + user_speclist_name, + [str(s) for s in self.concretized_user_specs] + ) + } + + def clear(self, re_read=False): + """Clear the contents of the environment + + Arguments: + re_read (bool): If True, do not clear ``new_specs`` nor + ``new_installs`` values. These values cannot be read from + yaml, and need to be maintained when re-reading an existing + environment. + """ + self.spec_lists = {user_speclist_name: SpecList()} # specs from yaml + self.dev_specs = {} # dev-build specs from yaml + self.concretized_user_specs = [] # user specs from last concretize + self.concretized_order = [] # roots of last concretize, in order + self.specs_by_hash = {} # concretized specs by hash + self._repo = None # RepoPath for this env (memoized) + self._previous_active = None # previously active environment + if not re_read: + # things that cannot be recreated from file + self.new_specs = [] # write packages for these on write() + self.new_installs = [] # write modules for these on write() + + @property + def internal(self): + """Whether this environment is managed by Spack.""" + return self.path.startswith(env_path) + + @property + def name(self): + """Human-readable representation of the environment. + + This is the path for directory environments, and just the name + for named environments. + """ + if self.internal: + return os.path.basename(self.path) + else: + return self.path + + @property + def active(self): + """True if this environment is currently active.""" + return _active_environment and self.path == _active_environment.path + + @property + def manifest_path(self): + """Path to spack.yaml file in this environment.""" + return os.path.join(self.path, manifest_name) + + @property + def _transaction_lock_path(self): + """The location of the lock file used to synchronize multiple + processes updating the same environment. + """ + return os.path.join(self.env_subdir_path, 'transaction_lock') + + @property + def lock_path(self): + """Path to spack.lock file in this environment.""" + return os.path.join(self.path, lockfile_name) + + @property + def _lock_backup_v1_path(self): + """Path to backup of v1 lockfile before conversion to v2""" + return self.lock_path + '.backup.v1' + + @property + def env_subdir_path(self): + """Path to directory where the env stores repos, logs, views.""" + return os.path.join(self.path, env_subdir_name) + + @property + def repos_path(self): + return os.path.join(self.path, env_subdir_name, 'repos') + + @property + def log_path(self): + return os.path.join(self.path, env_subdir_name, 'logs') + + @property + def view_path_default(self): + # default path for environment views + return os.path.join(self.env_subdir_path, 'view') + + @property + def repo(self): + if self._repo is None: + self._repo = make_repo_path(self.repos_path) + return self._repo + + def included_config_scopes(self): + """List of included configuration scopes from the environment. + + Scopes are listed in the YAML file in order from highest to + lowest precedence, so configuration from earlier scope will take + precedence over later ones. + + This routine returns them in the order they should be pushed onto + the internal scope stack (so, in reverse, from lowest to highest). + """ + scopes = [] + + # load config scopes added via 'include:', in reverse so that + # highest-precedence scopes are last. + includes = config_dict(self.yaml).get('include', []) + missing = [] + for i, config_path in enumerate(reversed(includes)): + # allow paths to contain spack config/environment variables, etc. + config_path = substitute_path_variables(config_path) + + # treat relative paths as relative to the environment + if not os.path.isabs(config_path): + config_path = os.path.join(self.path, config_path) + config_path = os.path.normpath(os.path.realpath(config_path)) + + if os.path.isdir(config_path): + # directories are treated as regular ConfigScopes + config_name = 'env:%s:%s' % ( + self.name, os.path.basename(config_path)) + scope = spack.config.ConfigScope(config_name, config_path) + elif os.path.exists(config_path): + # files are assumed to be SingleFileScopes + config_name = 'env:%s:%s' % (self.name, config_path) + scope = spack.config.SingleFileScope( + config_name, config_path, spack.schema.merged.schema) + else: + missing.append(config_path) + continue + + scopes.append(scope) + + if missing: + msg = 'Detected {0} missing include path(s):'.format(len(missing)) + msg += '\n {0}'.format('\n '.join(missing)) + tty.die('{0}\nPlease correct and try again.'.format(msg)) + + return scopes + + def env_file_config_scope_name(self): + """Name of the config scope of this environment's manifest file.""" + return 'env:%s' % self.name + + def env_file_config_scope(self): + """Get the configuration scope for the environment's manifest file.""" + config_name = self.env_file_config_scope_name() + return spack.config.SingleFileScope( + config_name, + self.manifest_path, + spack.schema.env.schema, + [spack.config.first_existing(self.raw_yaml, + spack.schema.env.keys)]) + + def config_scopes(self): + """A list of all configuration scopes for this environment.""" + return self.included_config_scopes() + [self.env_file_config_scope()] + + def destroy(self): + """Remove this environment from Spack entirely.""" + shutil.rmtree(self.path) + + def update_stale_references(self, from_list=None): + """Iterate over spec lists updating references.""" + if not from_list: + from_list = next(iter(self.spec_lists.keys())) + index = list(self.spec_lists.keys()).index(from_list) + + # spec_lists is an OrderedDict, all list entries after the modified + # list may refer to the modified list. Update stale references + for i, (name, speclist) in enumerate( + list(self.spec_lists.items())[index + 1:], index + 1 + ): + new_reference = dict((n, self.spec_lists[n]) + for n in list(self.spec_lists.keys())[:i]) + speclist.update_reference(new_reference) + + def add(self, user_spec, list_name=user_speclist_name): + """Add a single user_spec (non-concretized) to the Environment + + Returns: + (bool): True if the spec was added, False if it was already + present and did not need to be added + + """ + spec = Spec(user_spec) + + if list_name not in self.spec_lists: + raise SpackEnvironmentError( + 'No list %s exists in environment %s' % (list_name, self.name) + ) + + if list_name == user_speclist_name: + if not spec.name: + raise SpackEnvironmentError( + 'cannot add anonymous specs to an environment!') + elif not spack.repo.path.exists(spec.name): + virtuals = spack.repo.path.provider_index.providers.keys() + if spec.name not in virtuals: + msg = 'no such package: %s' % spec.name + raise SpackEnvironmentError(msg) + + list_to_change = self.spec_lists[list_name] + existing = str(spec) in list_to_change.yaml_list + if not existing: + list_to_change.add(str(spec)) + self.update_stale_references(list_name) + + return bool(not existing) + + def remove(self, query_spec, list_name=user_speclist_name, force=False): + """Remove specs from an environment that match a query_spec""" + query_spec = Spec(query_spec) + + list_to_change = self.spec_lists[list_name] + matches = [] + + if not query_spec.concrete: + matches = [s for s in list_to_change if s.satisfies(query_spec)] + + if not matches: + # concrete specs match against concrete specs in the env + # by *dag hash*, not build hash. + dag_hashes_in_order = [ + self.specs_by_hash[build_hash].dag_hash() + for build_hash in self.concretized_order + ] + + specs_hashes = zip( + self.concretized_user_specs, dag_hashes_in_order + ) + + matches = [ + s for s, h in specs_hashes + if query_spec.dag_hash() == h + ] + + if not matches: + raise SpackEnvironmentError( + "Not found: {0}".format(query_spec)) + + old_specs = set(self.user_specs) + new_specs = set() + for spec in matches: + if spec in list_to_change: + try: + list_to_change.remove(spec) + self.update_stale_references(list_name) + new_specs = set(self.user_specs) + except spack.spec_list.SpecListError: + # define new specs list + new_specs = set(self.user_specs) + msg = "Spec '%s' is part of a spec matrix and " % spec + msg += "cannot be removed from list '%s'." % list_to_change + if force: + msg += " It will be removed from the concrete specs." + # Mock new specs so we can remove this spec from + # concrete spec lists + new_specs.remove(spec) + tty.warn(msg) + + # If force, update stale concretized specs + for spec in old_specs - new_specs: + if force and spec in self.concretized_user_specs: + i = self.concretized_user_specs.index(spec) + del self.concretized_user_specs[i] + + dag_hash = self.concretized_order[i] + del self.concretized_order[i] + del self.specs_by_hash[dag_hash] + + def develop(self, spec, path, clone=False): + """Add dev-build info for package + + Args: + spec (spack.spec.Spec): Set constraints on development specs. Must include a + concrete version. + path (str): Path to find code for developer builds. Relative + paths will be resolved relative to the environment. + clone (bool): Clone the package code to the path. + If clone is False Spack will assume the code is already present + at ``path``. + + Return: + (bool): True iff the environment was changed. + """ + spec = spec.copy() # defensive copy since we access cached attributes + + if not spec.versions.concrete: + raise SpackEnvironmentError( + 'Cannot develop spec %s without a concrete version' % spec) + + for name, entry in self.dev_specs.items(): + if name == spec.name: + e_spec = Spec(entry['spec']) + e_path = entry['path'] + + if e_spec == spec: + if path == e_path: + tty.msg("Spec %s already configured for development" % + spec) + return False + else: + tty.msg("Updating development path for spec %s" % spec) + break + else: + msg = "Updating development spec for package " + msg += "%s with path %s" % (spec.name, path) + tty.msg(msg) + break + else: + tty.msg("Configuring spec %s for development at path %s" % + (spec, path)) + + if clone: + # "steal" the source code via staging API + abspath = os.path.normpath(os.path.join(self.path, path)) + + stage = spec.package.stage + stage.steal_source(abspath) + + # If it wasn't already in the list, append it + self.dev_specs[spec.name] = {'path': path, 'spec': str(spec)} + return True + + def undevelop(self, spec): + """Remove develop info for abstract spec ``spec``. + + returns True on success, False if no entry existed.""" + spec = Spec(spec) # In case it's a spec object + if spec.name in self.dev_specs: + del self.dev_specs[spec.name] + return True + return False + + def is_develop(self, spec): + """Returns true when the spec is built from local sources""" + return spec.name in self.dev_specs + + def concretize(self, force=False, tests=False): + """Concretize user_specs in this environment. + + Only concretizes specs that haven't been concretized yet unless + force is ``True``. + + This only modifies the environment in memory. ``write()`` will + write out a lockfile containing concretized specs. + + Arguments: + force (bool): re-concretize ALL specs, even those that were + already concretized + tests (bool or list or set): False to run no tests, True to test + all packages, or a list of package names to run tests for some + + Returns: + List of specs that have been concretized. Each entry is a tuple of + the user spec and the corresponding concretized spec. + """ + if force: + # Clear previously concretized specs + self.concretized_user_specs = [] + self.concretized_order = [] + self.specs_by_hash = {} + + # Pick the right concretization strategy + if self.concretization == 'together': + return self._concretize_together(tests=tests) + if self.concretization == 'separately': + return self._concretize_separately(tests=tests) + + msg = 'concretization strategy not implemented [{0}]' + raise SpackEnvironmentError(msg.format(self.concretization)) + + def _concretize_together(self, tests=False): + """Concretization strategy that concretizes all the specs + in the same DAG. + """ + # Exit early if the set of concretized specs is the set of user specs + user_specs_did_not_change = not bool( + set(self.user_specs) - set(self.concretized_user_specs) + ) + if user_specs_did_not_change: + return [] + + # Check that user specs don't have duplicate packages + counter = collections.defaultdict(int) + for user_spec in self.user_specs: + counter[user_spec.name] += 1 + + duplicates = [] + for name, count in counter.items(): + if count > 1: + duplicates.append(name) + + if duplicates: + msg = ('environment that are configured to concretize specs' + ' together cannot contain more than one spec for each' + ' package [{0}]'.format(', '.join(duplicates))) + raise SpackEnvironmentError(msg) + + # Proceed with concretization + self.concretized_user_specs = [] + self.concretized_order = [] + self.specs_by_hash = {} + + concrete_specs = spack.concretize.concretize_specs_together( + *self.user_specs, tests=tests) + concretized_specs = [x for x in zip(self.user_specs, concrete_specs)] + for abstract, concrete in concretized_specs: + self._add_concrete_spec(abstract, concrete) + return concretized_specs + + def _concretize_separately(self, tests=False): + """Concretization strategy that concretizes separately one + user spec after the other. + """ + # keep any concretized specs whose user specs are still in the manifest + old_concretized_user_specs = self.concretized_user_specs + old_concretized_order = self.concretized_order + old_specs_by_hash = self.specs_by_hash + + self.concretized_user_specs = [] + self.concretized_order = [] + self.specs_by_hash = {} + + for s, h in zip(old_concretized_user_specs, old_concretized_order): + if s in self.user_specs: + concrete = old_specs_by_hash[h] + self._add_concrete_spec(s, concrete, new=False) + + # Concretize any new user specs that we haven't concretized yet + concretized_specs = [] + for uspec, uspec_constraints in zip( + self.user_specs, self.user_specs.specs_as_constraints): + if uspec not in old_concretized_user_specs: + concrete = _concretize_from_constraints(uspec_constraints, tests=tests) + self._add_concrete_spec(uspec, concrete) + concretized_specs.append((uspec, concrete)) + return concretized_specs + + def concretize_and_add(self, user_spec, concrete_spec=None, tests=False): + """Concretize and add a single spec to the environment. + + Concretize the provided ``user_spec`` and add it along with the + concretized result to the environment. If the given ``user_spec`` was + already present in the environment, this does not add a duplicate. + The concretized spec will be added unless the ``user_spec`` was + already present and an associated concrete spec was already present. + + Args: + concrete_spec: if provided, then it is assumed that it is the + result of concretizing the provided ``user_spec`` + """ + if self.concretization == 'together': + msg = 'cannot install a single spec in an environment that is ' \ + 'configured to be concretized together. Run instead:\n\n' \ + ' $ spack add \n' \ + ' $ spack install\n' + raise SpackEnvironmentError(msg) + + spec = Spec(user_spec) + + if self.add(spec): + concrete = concrete_spec or spec.concretized(tests=tests) + self._add_concrete_spec(spec, concrete) + else: + # spec might be in the user_specs, but not installed. + # TODO: Redo name-based comparison for old style envs + spec = next( + s for s in self.user_specs if s.satisfies(user_spec) + ) + concrete = self.specs_by_hash.get(spec.build_hash()) + if not concrete: + concrete = spec.concretized(tests=tests) + self._add_concrete_spec(spec, concrete) + + return concrete + + @property + def default_view(self): + if not self.views: + raise SpackEnvironmentError( + "{0} does not have a view enabled".format(self.name)) + + if default_view_name not in self.views: + raise SpackEnvironmentError( + "{0} does not have a default view enabled".format(self.name)) + + return self.views[default_view_name] + + def update_default_view(self, viewpath): + name = default_view_name + if name in self.views and self.default_view.root != viewpath: + shutil.rmtree(self.default_view.root) + + if viewpath: + if name in self.views: + self.default_view.root = viewpath + else: + self.views[name] = ViewDescriptor(self.path, viewpath) + else: + self.views.pop(name, None) + + def regenerate_views(self): + if not self.views: + tty.debug("Skip view update, this environment does not" + " maintain a view") + return + + specs = self._get_environment_specs() + for view in self.views.values(): + view.regenerate(specs, self.roots()) + + def check_views(self): + """Checks if the environments default view can be activated.""" + try: + # This is effectively a no-op, but it touches all packages in the + # default view if they are installed. + for view_name, view in self.views.items(): + for _, spec in self.concretized_specs(): + if spec in view and spec.package.installed: + tty.debug( + 'Spec %s in view %s' % (spec.name, view_name)) + except (spack.repo.UnknownPackageError, + spack.repo.UnknownNamespaceError) as e: + tty.warn(e) + tty.warn( + 'Environment %s includes out of date packages or repos. ' + 'Loading the environment view will require reconcretization.' + % self.name) + + def _env_modifications_for_default_view(self, reverse=False): + all_mods = spack.util.environment.EnvironmentModifications() + + visited = set() + + errors = [] + for _, root_spec in self.concretized_specs(): + if root_spec in self.default_view and root_spec.package.installed: + for spec in root_spec.traverse(deptype='run', root=True): + if spec.name in visited: + # It is expected that only one instance of the package + # can be added to the environment - do not attempt to + # add multiple. + tty.debug( + "Not adding {0} to shell modifications: " + "this package has already been added".format( + spec.format("{name}/{hash:7}") + ) + ) + continue + else: + visited.add(spec.name) + + try: + mods = uenv.environment_modifications_for_spec( + spec, self.default_view) + except Exception as e: + msg = ("couldn't get environment settings for %s" + % spec.format("{name}@{version} /{hash:7}")) + errors.append((msg, str(e))) + continue + + all_mods.extend(mods.reversed() if reverse else mods) + + return all_mods, errors + + def add_default_view_to_env(self, env_mod): + """ + Collect the environment modifications to activate an environment using the + default view. Removes duplicate paths. + + Args: + env_mod (spack.util.environment.EnvironmentModifications): the environment + modifications object that is modified. + """ + if default_view_name not in self.views: + # No default view to add to shell + return env_mod + + env_mod.extend(uenv.unconditional_environment_modifications( + self.default_view)) + + mods, errors = self._env_modifications_for_default_view() + env_mod.extend(mods) + if errors: + for err in errors: + tty.warn(*err) + + # deduplicate paths from specs mapped to the same location + for env_var in env_mod.group_by_name(): + env_mod.prune_duplicate_paths(env_var) + + return env_mod + + def rm_default_view_from_env(self, env_mod): + """ + Collect the environment modifications to deactivate an environment using the + default view. Reverses the action of ``add_default_view_to_env``. + + Args: + env_mod (spack.util.environment.EnvironmentModifications): the environment + modifications object that is modified. + """ + if default_view_name not in self.views: + # No default view to add to shell + return env_mod + + env_mod.extend(uenv.unconditional_environment_modifications( + self.default_view).reversed()) + + mods, _ = self._env_modifications_for_default_view(reverse=True) + env_mod.extend(mods) + + return env_mod + + def _add_concrete_spec(self, spec, concrete, new=True): + """Called when a new concretized spec is added to the environment. + + This ensures that all internal data structures are kept in sync. + + Arguments: + spec (Spec): user spec that resulted in the concrete spec + concrete (Spec): spec concretized within this environment + new (bool): whether to write this spec's package to the env + repo on write() + """ + assert concrete.concrete + + # when a spec is newly concretized, we need to make a note so + # that we can write its package to the env repo on write() + if new: + self.new_specs.append(concrete) + + # update internal lists of specs + self.concretized_user_specs.append(spec) + + h = concrete.build_hash() + self.concretized_order.append(h) + self.specs_by_hash[h] = concrete + + def _spec_needs_overwrite(self, spec): + # Overwrite the install if it's a dev build (non-transitive) + # and the code has been changed since the last install + # or one of the dependencies has been reinstalled since + # the last install + + # if it's not installed, we don't need to overwrite it + if not spec.package.installed: + return False + + # if spec and all deps aren't dev builds, we don't need to overwrite it + if not any(spec.satisfies(c) + for c in ('dev_path=*', '^dev_path=*')): + return False + + # if any dep needs overwrite, or any dep is missing and is a dev build + # then overwrite this package + if any( + self._spec_needs_overwrite(dep) or + ((not dep.package.installed) and dep.satisfies('dev_path=*')) + for dep in spec.traverse(root=False) + ): + return True + + # if it's not a direct dev build and its dependencies haven't + # changed, it hasn't changed. + # We don't merely check satisfaction (spec.satisfies('dev_path=*') + # because we need the value of the variant in the next block of code + dev_path_var = spec.variants.get('dev_path', None) + if not dev_path_var: + return False + + # if it is a direct dev build, check whether the code changed + # we already know it is installed + _, record = spack.store.db.query_by_spec_hash(spec.dag_hash()) + mtime = fs.last_modification_time_recursive(dev_path_var.value) + return mtime > record.installation_time + + def _get_overwrite_specs(self): + ret = [] + for dag_hash in self.concretized_order: + spec = self.specs_by_hash[dag_hash] + ret.extend([d.dag_hash() for d in spec.traverse(root=True) + if self._spec_needs_overwrite(d)]) + + return ret + + def _install_log_links(self, spec): + if not spec.external: + # Make sure log directory exists + log_path = self.log_path + fs.mkdirp(log_path) + + with fs.working_dir(self.path): + # Link the resulting log file into logs dir + build_log_link = os.path.join( + log_path, '%s-%s.log' % (spec.name, spec.dag_hash(7))) + if os.path.lexists(build_log_link): + os.remove(build_log_link) + os.symlink(spec.package.build_log_path, build_log_link) + + def uninstalled_specs(self): + """Return a list of all uninstalled (and non-dev) specs.""" + # Do the installed check across all specs within a single + # DB read transaction to reduce time spent in lock acquisition. + uninstalled_specs = [] + with spack.store.db.read_transaction(): + for concretized_hash in self.concretized_order: + spec = self.specs_by_hash[concretized_hash] + if not spec.package.installed or ( + spec.satisfies('dev_path=*') or + spec.satisfies('^dev_path=*') + ): + uninstalled_specs.append(spec) + return uninstalled_specs + + def install_all(self, **install_args): + """Install all concretized specs in an environment. + + Note: this does not regenerate the views for the environment; + that needs to be done separately with a call to write(). + + Args: + install_args (dict): keyword install arguments + """ + self.install_specs(None, **install_args) + + def install_specs(self, specs=None, **install_args): + tty.debug('Assessing installation status of environment packages') + # If "spack install" is invoked repeatedly for a large environment + # where all specs are already installed, the operation can take + # a large amount of time due to repeatedly acquiring and releasing + # locks, this does an initial check across all specs within a single + # DB read transaction to reduce time spent in this case. In the next + # three lines we remove any already-installed root specs from the list + # to install. However, uninstalled_specs() only considers root specs, + # so this will allow dep specs to be unnecessarily re-installed. + uninstalled_roots = self.uninstalled_specs() + specs_to_install = specs or uninstalled_roots + specs_to_install = [s for s in specs_to_install + if s not in self.roots() or s in uninstalled_roots] + + # ensure specs already installed are marked explicit + all_specs = specs or [cs for _, cs in self.concretized_specs()] + specs_installed = [s for s in all_specs if s.package.installed] + with spack.store.db.write_transaction(): # do all in one transaction + for spec in specs_installed: + spack.store.db.update_explicit(spec, True) + + if not specs_to_install: + tty.msg('All of the packages are already installed') + return + + tty.debug('Processing {0} uninstalled specs'.format( + len(specs_to_install))) + + install_args['overwrite'] = install_args.get( + 'overwrite', []) + self._get_overwrite_specs() + + installs = [] + for spec in specs_to_install: + installs.append((spec.package, install_args)) + + try: + builder = PackageInstaller(installs) + builder.install() + finally: + # Ensure links are set appropriately + for spec in specs_to_install: + if spec.package.installed: + self.new_installs.append(spec) + try: + self._install_log_links(spec) + except OSError as e: + tty.warn('Could not install log links for {0}: {1}' + .format(spec.name, str(e))) + + with self.write_transaction(): + self.regenerate_views() + + def all_specs(self): + """Return all specs, even those a user spec would shadow.""" + all_specs = set() + for h in self.concretized_order: + all_specs.update(self.specs_by_hash[h].traverse()) + + return sorted(all_specs) + + def all_hashes(self): + """Return hashes of all specs. + + Note these hashes exclude build dependencies.""" + return list(set(s.dag_hash() for s in self.all_specs())) + + def roots(self): + """Specs explicitly requested by the user *in this environment*. + + Yields both added and installed specs that have user specs in + `spack.yaml`. + """ + concretized = dict(self.concretized_specs()) + for spec in self.user_specs: + concrete = concretized.get(spec) + yield concrete if concrete else spec + + def added_specs(self): + """Specs that are not yet installed. + + Yields the user spec for non-concretized specs, and the concrete + spec for already concretized but not yet installed specs. + """ + # use a transaction to avoid overhead of repeated calls + # to `package.installed` + with spack.store.db.read_transaction(): + concretized = dict(self.concretized_specs()) + for spec in self.user_specs: + concrete = concretized.get(spec) + if not concrete: + yield spec + elif not concrete.package.installed: + yield concrete + + def concretized_specs(self): + """Tuples of (user spec, concrete spec) for all concrete specs.""" + for s, h in zip(self.concretized_user_specs, self.concretized_order): + yield (s, self.specs_by_hash[h]) + + def matching_spec(self, spec): + """ + Given a spec (likely not concretized), find a matching concretized + spec in the environment. + + The matching spec does not have to be installed in the environment, + but must be concrete (specs added with `spack add` without an + intervening `spack concretize` will not be matched). + + If there is a single root spec that matches the provided spec or a + single dependency spec that matches the provided spec, then the + concretized instance of that spec will be returned. + + If multiple root specs match the provided spec, or no root specs match + and multiple dependency specs match, then this raises an error + and reports all matching specs. + """ + # Root specs will be keyed by concrete spec, value abstract + # Dependency-only specs will have value None + matches = {} + + if not isinstance(spec, spack.spec.Spec): + spec = spack.spec.Spec(spec) + + for user_spec, concretized_user_spec in self.concretized_specs(): + # Deal with concrete specs differently + if spec.concrete: + # Matching a concrete spec is more restrictive + # than just matching the dag hash + is_match = ( + spec in concretized_user_spec and + concretized_user_spec[spec.name].build_hash() == spec.build_hash() + ) + if is_match: + matches[spec] = spec + continue + + if concretized_user_spec.satisfies(spec): + matches[concretized_user_spec] = user_spec + for dep_spec in concretized_user_spec.traverse(root=False): + if dep_spec.satisfies(spec): + # Don't overwrite the abstract spec if present + # If not present already, set to None + matches[dep_spec] = matches.get(dep_spec, None) + + if not matches: + return None + elif len(matches) == 1: + return list(matches.keys())[0] + + root_matches = dict((concrete, abstract) + for concrete, abstract in matches.items() + if abstract) + + if len(root_matches) == 1: + return list(root_matches.items())[0][0] + + # More than one spec matched, and either multiple roots matched or + # none of the matches were roots + # If multiple root specs match, it is assumed that the abstract + # spec will most-succinctly summarize the difference between them + # (and the user can enter one of these to disambiguate) + match_strings = [] + fmt_str = '{hash:7} ' + spack.spec.default_format + for concrete, abstract in matches.items(): + if abstract: + s = 'Root spec %s\n %s' % (abstract, concrete.format(fmt_str)) + else: + s = 'Dependency spec\n %s' % concrete.format(fmt_str) + match_strings.append(s) + matches_str = '\n'.join(match_strings) + + msg = ("{0} matches multiple specs in the environment {1}: \n" + "{2}".format(str(spec), self.name, matches_str)) + raise SpackEnvironmentError(msg) + + def removed_specs(self): + """Tuples of (user spec, concrete spec) for all specs that will be + removed on nexg concretize.""" + needed = set() + for s, c in self.concretized_specs(): + if s in self.user_specs: + for d in c.traverse(): + needed.add(d) + + for s, c in self.concretized_specs(): + for d in c.traverse(): + if d not in needed: + yield d + + def _get_environment_specs(self, recurse_dependencies=True): + """Returns the specs of all the packages in an environment. + + If these specs appear under different user_specs, only one copy + is added to the list returned. + """ + spec_list = list() + + for spec_hash in self.concretized_order: + spec = self.specs_by_hash[spec_hash] + + specs = (spec.traverse(deptype=('link', 'run')) + if recurse_dependencies else (spec,)) + + spec_list.extend(specs) + + return spec_list + + def _to_lockfile_dict(self): + """Create a dictionary to store a lockfile for this environment.""" + concrete_specs = {} + for spec in self.specs_by_hash.values(): + for s in spec.traverse(): + build_hash = s.build_hash() + if build_hash not in concrete_specs: + spec_dict = s.to_node_dict(hash=ht.build_hash) + # Assumes no legacy formats, since this was just created. + spec_dict[ht.dag_hash.name] = s.dag_hash() + concrete_specs[build_hash] = spec_dict + + hash_spec_list = zip( + self.concretized_order, self.concretized_user_specs) + + # this is the lockfile we'll write out + data = { + # metadata about the format + '_meta': { + 'file-type': 'spack-lockfile', + 'lockfile-version': lockfile_format_version, + 'specfile-version': spack.spec.specfile_format_version + }, + + # users specs + hashes are the 'roots' of the environment + 'roots': [{ + 'hash': h, + 'spec': str(s) + } for h, s in hash_spec_list], + + # Concrete specs by hash, including dependencies + 'concrete_specs': concrete_specs, + } + + return data + + def _read_lockfile(self, file_or_json): + """Read a lockfile from a file or from a raw string.""" + lockfile_dict = sjson.load(file_or_json) + self._read_lockfile_dict(lockfile_dict) + return lockfile_dict['_meta']['lockfile-version'] + + def _read_lockfile_dict(self, d): + """Read a lockfile dictionary into this environment.""" + roots = d['roots'] + self.concretized_user_specs = [Spec(r['spec']) for r in roots] + self.concretized_order = [r['hash'] for r in roots] + + json_specs_by_hash = d['concrete_specs'] + root_hashes = set(self.concretized_order) + + specs_by_hash = {} + for build_hash, node_dict in json_specs_by_hash.items(): + spec = Spec.from_node_dict(node_dict) + if d['_meta']['lockfile-version'] > 1: + # Build hash is stored as a key, but not as part of the node dict + # To ensure build hashes are not recomputed, we reattach here + setattr(spec, ht.build_hash.attr, build_hash) + specs_by_hash[build_hash] = spec + + for build_hash, node_dict in json_specs_by_hash.items(): + for _, dep_hash, deptypes, _ in ( + Spec.dependencies_from_node_dict(node_dict)): + specs_by_hash[build_hash]._add_dependency( + specs_by_hash[dep_hash], deptypes) + + # If we are reading an older lockfile format (which uses dag hashes + # that exclude build deps), we use this to convert the old + # concretized_order to the full hashes (preserving the order) + old_hash_to_new = {} + self.specs_by_hash = {} + for _, spec in specs_by_hash.items(): + dag_hash = spec.dag_hash() + build_hash = spec.build_hash() + if dag_hash in root_hashes: + old_hash_to_new[dag_hash] = build_hash + + if (dag_hash in root_hashes or build_hash in root_hashes): + self.specs_by_hash[build_hash] = spec + + if old_hash_to_new: + # Replace any older hashes in concretized_order with hashes + # that include build deps + self.concretized_order = [ + old_hash_to_new.get(h, h) for h in self.concretized_order] + + def write(self, regenerate=True): + """Writes an in-memory environment to its location on disk. + + Write out package files for each newly concretized spec. Also + regenerate any views associated with the environment and run post-write + hooks, if regenerate is True. + + Arguments: + regenerate (bool): regenerate views and run post-write hooks as + well as writing if True. + """ + # Intercept environment not using the latest schema format and prevent + # them from being modified + manifest_exists = os.path.exists(self.manifest_path) + if manifest_exists and not is_latest_format(self.manifest_path): + msg = ('The environment "{0}" needs to be written to disk, but ' + 'is currently using a deprecated format. Please update it ' + 'using:\n\n' + '\tspack env update {0}\n\n' + 'Note that previous versions of Spack will not be able to ' + 'use the updated configuration.') + raise RuntimeError(msg.format(self.name)) + + # ensure path in var/spack/environments + fs.mkdirp(self.path) + + yaml_dict = config_dict(self.yaml) + raw_yaml_dict = config_dict(self.raw_yaml) + + if self.specs_by_hash: + # ensure the prefix/.env directory exists + fs.mkdirp(self.env_subdir_path) + + for spec in self.new_specs: + for dep in spec.traverse(): + if not dep.concrete: + raise ValueError('specs passed to environment.write() ' + 'must be concrete!') + + root = os.path.join(self.repos_path, dep.namespace) + repo = spack.repo.create_or_construct(root, dep.namespace) + pkg_dir = repo.dirname_for_package_name(dep.name) + + fs.mkdirp(pkg_dir) + spack.repo.path.dump_provenance(dep, pkg_dir) + + # write the lock file last + with fs.write_tmp_and_move(self.lock_path) as f: + sjson.dump(self._to_lockfile_dict(), stream=f) + self._update_and_write_manifest(raw_yaml_dict, yaml_dict) + else: + with fs.safe_remove(self.lock_path): + self._update_and_write_manifest(raw_yaml_dict, yaml_dict) + + # TODO: rethink where this needs to happen along with + # writing. For some of the commands (like install, which write + # concrete specs AND regen) this might as well be a separate + # call. But, having it here makes the views consistent witht the + # concretized environment for most operations. Which is the + # special case? + if regenerate: + self.regenerate_views() + + # Run post_env_hooks + spack.hooks.post_env_write(self) + + # new specs and new installs reset at write time + self.new_specs = [] + self.new_installs = [] + + def _update_and_write_manifest(self, raw_yaml_dict, yaml_dict): + """Update YAML manifest for this environment based on changes to + spec lists and views and write it. + """ + # invalidate _repo cache + self._repo = None + # put any changes in the definitions in the YAML + for name, speclist in self.spec_lists.items(): + if name == user_speclist_name: + # The primary list is handled differently + continue + + active_yaml_lists = [x for x in yaml_dict.get('definitions', []) + if name in x and + _eval_conditional(x.get('when', 'True'))] + + # Remove any specs in yaml that are not in internal representation + for ayl in active_yaml_lists: + # If it's not a string, it's a matrix. Those can't have changed + # If it is a string that starts with '$', it's a reference. + # Those also can't have changed. + ayl[name][:] = [s for s in ayl.setdefault(name, []) + if (not isinstance(s, six.string_types)) or + s.startswith('$') or Spec(s) in speclist.specs] + + # Put the new specs into the first active list from the yaml + new_specs = [entry for entry in speclist.yaml_list + if isinstance(entry, six.string_types) and + not any(entry in ayl[name] + for ayl in active_yaml_lists)] + list_for_new_specs = active_yaml_lists[0].setdefault(name, []) + list_for_new_specs[:] = list_for_new_specs + new_specs + # put the new user specs in the YAML. + # This can be done directly because there can't be multiple definitions + # nor when clauses for `specs` list. + yaml_spec_list = yaml_dict.setdefault(user_speclist_name, + []) + yaml_spec_list[:] = self.user_specs.yaml_list + # Construct YAML representation of view + default_name = default_view_name + if self.views and len(self.views) == 1 and default_name in self.views: + path = self.default_view.root + if self.default_view == ViewDescriptor(self.path, + self.view_path_default): + view = True + elif self.default_view == ViewDescriptor(self.path, path): + view = path + else: + view = dict((name, view.to_dict()) + for name, view in self.views.items()) + elif self.views: + view = dict((name, view.to_dict()) + for name, view in self.views.items()) + else: + view = False + yaml_dict['view'] = view + + if self.dev_specs: + # Remove entries that are mirroring defaults + write_dev_specs = copy.deepcopy(self.dev_specs) + for name, entry in write_dev_specs.items(): + if entry['path'] == name: + del entry['path'] + yaml_dict['develop'] = write_dev_specs + else: + yaml_dict.pop('develop', None) + + # Remove yaml sections that are shadowing defaults + # construct garbage path to ensure we don't find a manifest by accident + with fs.temp_cwd() as env_dir: + bare_env = Environment(env_dir, with_view=self.view_path_default) + keys_present = list(yaml_dict.keys()) + for key in keys_present: + if yaml_dict[key] == config_dict(bare_env.yaml).get(key, None): + if key not in raw_yaml_dict: + del yaml_dict[key] + # if all that worked, write out the manifest file at the top level + # (we used to check whether the yaml had changed and not write it out + # if it hadn't. We can't do that anymore because it could be the only + # thing that changed is the "override" attribute on a config dict, + # which would not show up in even a string comparison between the two + # keys). + changed = not yaml_equivalent(self.yaml, self.raw_yaml) + written = os.path.exists(self.manifest_path) + if changed or not written: + self.raw_yaml = copy.deepcopy(self.yaml) + with fs.write_tmp_and_move(os.path.realpath(self.manifest_path)) as f: + _write_yaml(self.yaml, f) + + def __enter__(self): + self._previous_active = _active_environment + activate(self) + return self + + def __exit__(self, exc_type, exc_val, exc_tb): + deactivate() + if self._previous_active: + activate(self._previous_active) + + +def yaml_equivalent(first, second): + """Returns whether two spack yaml items are equivalent, including overrides + """ + if isinstance(first, dict): + return isinstance(second, dict) and _equiv_dict(first, second) + elif isinstance(first, list): + return isinstance(second, list) and _equiv_list(first, second) + else: # it's a string + return isinstance(second, six.string_types) and first == second + + +def _equiv_list(first, second): + """Returns whether two spack yaml lists are equivalent, including overrides + """ + if len(first) != len(second): + return False + return all(yaml_equivalent(f, s) for f, s in zip(first, second)) + + +def _equiv_dict(first, second): + """Returns whether two spack yaml dicts are equivalent, including overrides + """ + if len(first) != len(second): + return False + same_values = all(yaml_equivalent(fv, sv) + for fv, sv in zip(first.values(), second.values())) + same_keys_with_same_overrides = all( + fk == sk and getattr(fk, 'override', False) == getattr(sk, 'override', + False) + for fk, sk in zip(first.keys(), second.keys())) + return same_values and same_keys_with_same_overrides + + +def display_specs(concretized_specs): + """Displays the list of specs returned by `Environment.concretize()`. + + Args: + concretized_specs (list): list of specs returned by + `Environment.concretize()` + """ + def _tree_to_display(spec): + return spec.tree( + recurse_dependencies=True, + status_fn=spack.spec.Spec.install_status, + hashlen=7, hashes=True) + + for user_spec, concrete_spec in concretized_specs: + tty.msg('Concretized {0}'.format(user_spec)) + sys.stdout.write(_tree_to_display(concrete_spec)) + print('') + + +def _concretize_from_constraints(spec_constraints, tests=False): + # Accept only valid constraints from list and concretize spec + # Get the named spec even if out of order + root_spec = [s for s in spec_constraints if s.name] + if len(root_spec) != 1: + m = 'The constraints %s are not a valid spec ' % spec_constraints + m += 'concretization target. all specs must have a single name ' + m += 'constraint for concretization.' + raise InvalidSpecConstraintError(m) + spec_constraints.remove(root_spec[0]) + + invalid_constraints = [] + while True: + # Attach all anonymous constraints to one named spec + s = root_spec[0].copy() + for c in spec_constraints: + if c not in invalid_constraints: + s.constrain(c) + try: + return s.concretized(tests=tests) + except spack.spec.InvalidDependencyError as e: + invalid_deps_string = ['^' + d for d in e.invalid_deps] + invalid_deps = [c for c in spec_constraints + if any(c.satisfies(invd, strict=True) + for invd in invalid_deps_string)] + if len(invalid_deps) != len(invalid_deps_string): + raise e + invalid_constraints.extend(invalid_deps) + except UnknownVariantError as e: + invalid_variants = e.unknown_variants + inv_variant_constraints = [c for c in spec_constraints + if any(name in c.variants + for name in invalid_variants)] + if len(inv_variant_constraints) != len(invalid_variants): + raise e + invalid_constraints.extend(inv_variant_constraints) + + +def make_repo_path(root): + """Make a RepoPath from the repo subdirectories in an environment.""" + path = spack.repo.RepoPath() + + if os.path.isdir(root): + for repo_root in os.listdir(root): + repo_root = os.path.join(root, repo_root) + + if not os.path.isdir(repo_root): + continue + + repo = spack.repo.Repo(repo_root) + path.put_last(repo) + + return path + + +def prepare_config_scope(env): + """Add env's scope to the global configuration search path.""" + for scope in env.config_scopes(): + spack.config.config.push_scope(scope) + + +def deactivate_config_scope(env): + """Remove any scopes from env from the global config path.""" + for scope in env.config_scopes(): + spack.config.config.remove_scope(scope.name) + + +def manifest_file(env_name_or_dir): + """Return the absolute path to a manifest file given the environment + name or directory. + + Args: + env_name_or_dir (str): either the name of a valid environment + or a directory where a manifest file resides + + Raises: + AssertionError: if the environment is not found + """ + env_dir = None + if is_env_dir(env_name_or_dir): + env_dir = os.path.abspath(env_name_or_dir) + elif exists(env_name_or_dir): + env_dir = os.path.abspath(root(env_name_or_dir)) + + assert env_dir, "environment not found [env={0}]".format(env_name_or_dir) + return os.path.join(env_dir, manifest_name) + + +def update_yaml(manifest, backup_file): + """Update a manifest file from an old format to the current one. + + Args: + manifest (str): path to a manifest file + backup_file (str): file where to copy the original manifest + + Returns: + True if the manifest was updated, False otherwise. + + Raises: + AssertionError: in case anything goes wrong during the update + """ + # Check if the environment needs update + with open(manifest) as f: + data = syaml.load(f) + + top_level_key = _top_level_key(data) + needs_update = spack.schema.env.update(data[top_level_key]) + if not needs_update: + msg = "No update needed [manifest={0}]".format(manifest) + tty.debug(msg) + return False + + # Copy environment to a backup file and update it + msg = ('backup file "{0}" already exists on disk. Check its content ' + 'and remove it before trying to update again.') + assert not os.path.exists(backup_file), msg.format(backup_file) + + shutil.copy(manifest, backup_file) + with open(manifest, 'w') as f: + syaml.dump_config(data, f) + return True + + +def _top_level_key(data): + """Return the top level key used in this environment + + Args: + data (dict): raw yaml data of the environment + + Returns: + Either 'spack' or 'env' + """ + msg = ('cannot find top level attribute "spack" or "env"' + 'in the environment') + assert any(x in data for x in ('spack', 'env')), msg + if 'spack' in data: + return 'spack' + return 'env' + + +def is_latest_format(manifest): + """Return True if the manifest file is at the latest schema format, + False otherwise. + + Args: + manifest (str): manifest file to be analyzed + """ + with open(manifest) as f: + data = syaml.load(f) + top_level_key = _top_level_key(data) + changed = spack.schema.env.update(data[top_level_key]) + return not changed + + +@contextlib.contextmanager +def no_active_environment(): + """Deactivate the active environment for the duration of the context. Has no + effect when there is no active environment.""" + env = active_environment() + try: + deactivate() + yield + finally: + # TODO: we don't handle `use_env_repo` here. + if env: + activate(env) + + +class SpackEnvironmentError(spack.error.SpackError): + """Superclass for all errors to do with Spack environments.""" + + +class SpackEnvironmentViewError(SpackEnvironmentError): + """Class for errors regarding view generation.""" diff --git a/lib/spack/spack/environment/shell.py b/lib/spack/spack/environment/shell.py new file mode 100644 index 0000000000..1ffd6cd171 --- /dev/null +++ b/lib/spack/spack/environment/shell.py @@ -0,0 +1,161 @@ +# Copyright 2013-2021 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 os + +import llnl.util.tty as tty +from llnl.util.tty.color import colorize + +import spack.environment as ev +import spack.repo +import spack.store +from spack.util.environment import EnvironmentModifications + + +def activate_header(env, shell, prompt=None): + # Construct the commands to run + cmds = '' + if shell == 'csh': + # TODO: figure out how to make color work for csh + cmds += 'setenv SPACK_ENV %s;\n' % env.path + cmds += 'alias despacktivate "spack env deactivate";\n' + if prompt: + cmds += 'if (! $?SPACK_OLD_PROMPT ) ' + cmds += 'setenv SPACK_OLD_PROMPT "${prompt}";\n' + cmds += 'set prompt="%s ${prompt}";\n' % prompt + elif shell == 'fish': + if 'color' in os.getenv('TERM', '') and prompt: + prompt = colorize('@G{%s} ' % prompt, color=True) + + cmds += 'set -gx SPACK_ENV %s;\n' % env.path + cmds += 'function despacktivate;\n' + cmds += ' spack env deactivate;\n' + cmds += 'end;\n' + # + # NOTE: We're not changing the fish_prompt function (which is fish's + # solution to the PS1 variable) here. This is a bit fiddly, and easy to + # screw up => spend time reasearching a solution. Feedback welcome. + # + else: + if 'color' in os.getenv('TERM', '') and prompt: + prompt = colorize('@G{%s} ' % prompt, color=True) + + cmds += 'export SPACK_ENV=%s;\n' % env.path + cmds += "alias despacktivate='spack env deactivate';\n" + if prompt: + cmds += 'if [ -z ${SPACK_OLD_PS1+x} ]; then\n' + cmds += ' if [ -z ${PS1+x} ]; then\n' + cmds += " PS1='$$$$';\n" + cmds += ' fi;\n' + cmds += ' export SPACK_OLD_PS1="${PS1}";\n' + cmds += 'fi;\n' + cmds += 'export PS1="%s ${PS1}";\n' % prompt + + return cmds + + +def deactivate_header(shell): + cmds = '' + if shell == 'csh': + cmds += 'unsetenv SPACK_ENV;\n' + cmds += 'if ( $?SPACK_OLD_PROMPT ) ' + cmds += 'set prompt="$SPACK_OLD_PROMPT" && ' + cmds += 'unsetenv SPACK_OLD_PROMPT;\n' + cmds += 'unalias despacktivate;\n' + elif shell == 'fish': + cmds += 'set -e SPACK_ENV;\n' + cmds += 'functions -e despacktivate;\n' + # + # NOTE: Not changing fish_prompt (above) => no need to restore it here. + # + else: + cmds += 'if [ ! -z ${SPACK_ENV+x} ]; then\n' + cmds += 'unset SPACK_ENV; export SPACK_ENV;\n' + cmds += 'fi;\n' + cmds += 'unalias despacktivate;\n' + cmds += 'if [ ! -z ${SPACK_OLD_PS1+x} ]; then\n' + cmds += ' if [ "$SPACK_OLD_PS1" = \'$$$$\' ]; then\n' + cmds += ' unset PS1; export PS1;\n' + cmds += ' else\n' + cmds += ' export PS1="$SPACK_OLD_PS1";\n' + cmds += ' fi;\n' + cmds += ' unset SPACK_OLD_PS1; export SPACK_OLD_PS1;\n' + cmds += 'fi;\n' + + return cmds + + +def activate(env, use_env_repo=False, add_view=True): + """ + Activate an environment and append environment modifications + + To activate an environment, we add its configuration scope to the + existing Spack configuration, and we set active to the current + environment. + + Arguments: + env (spack.environment.Environment): the environment to activate + use_env_repo (bool): use the packages exactly as they appear in the + environment's repository + add_view (bool): generate commands to add view to path variables + + Returns: + spack.util.environment.EnvironmentModifications: Environment variables + modifications to activate environment. + """ + ev.activate(env, use_env_repo=use_env_repo) + + env_mods = EnvironmentModifications() + + # + # NOTE in the fish-shell: Path variables are a special kind of variable + # used to support colon-delimited path lists including PATH, CDPATH, + # MANPATH, PYTHONPATH, etc. All variables that end in PATH (case-sensitive) + # become PATH variables. + # + try: + if add_view and ev.default_view_name in env.views: + with spack.store.db.read_transaction(): + env.add_default_view_to_env(env_mods) + except (spack.repo.UnknownPackageError, + spack.repo.UnknownNamespaceError) as e: + tty.error(e) + tty.die( + 'Environment view is broken due to a missing package or repo.\n', + ' To activate without views enabled, activate with:\n', + ' spack env activate -V {0}\n'.format(env.name), + ' To remove it and resolve the issue, ' + 'force concretize with the command:\n', + ' spack -e {0} concretize --force'.format(env.name)) + + return env_mods + + +def deactivate(): + """ + Deactivate an environment and collect corresponding environment modifications + + Returns: + spack.util.environment.EnvironmentModifications: Environment variables + modifications to activate environment. + """ + env_mods = EnvironmentModifications() + active = ev.active_environment() + + if active is None: + return env_mods + + if ev.default_view_name in active.views: + try: + with spack.store.db.read_transaction(): + active.rm_default_view_from_env(env_mods) + except (spack.repo.UnknownPackageError, + spack.repo.UnknownNamespaceError) as e: + tty.warn(e) + tty.warn('Could not fully deactivate view due to missing package ' + 'or repo, shell environment may be corrupt.') + + ev.deactivate() + + return env_mods diff --git a/lib/spack/spack/main.py b/lib/spack/spack/main.py index 8ead8c8f4e..b0c665df0d 100644 --- a/lib/spack/spack/main.py +++ b/lib/spack/spack/main.py @@ -745,7 +745,7 @@ def main(argv=None): if not args.no_env: env = spack.cmd.find_environment(args) if env: - ev.activate(env, args.use_env_repo, add_view=False) + ev.activate(env, args.use_env_repo) if args.print_shell_vars: print_setup_info(*args.print_shell_vars.split(',')) diff --git a/lib/spack/spack/subprocess_context.py b/lib/spack/spack/subprocess_context.py index bfba6b0acc..9e3e3581f6 100644 --- a/lib/spack/spack/subprocess_context.py +++ b/lib/spack/spack/subprocess_context.py @@ -22,6 +22,10 @@ from types import ModuleType import spack.architecture import spack.config +import spack.environment +import spack.main +import spack.repo +import spack.store _serialize = sys.version_info >= (3, 8) and sys.platform == 'darwin' @@ -63,26 +67,23 @@ class PackageInstallContext(object): needs to be transmitted to a child process. """ def __init__(self, pkg): - import spack.environment as ev # break import cycle if _serialize: self.serialized_pkg = serialize(pkg) - self.serialized_env = serialize(ev._active_environment) + self.serialized_env = serialize(spack.environment.active_environment()) else: self.pkg = pkg - self.env = ev._active_environment + self.env = spack.environment.active_environment() self.spack_working_dir = spack.main.spack_working_dir self.test_state = TestState() def restore(self): - import spack.environment as ev # break import cycle self.test_state.restore() spack.main.spack_working_dir = self.spack_working_dir - if _serialize: - ev._active_environment = pickle.load(self.serialized_env) - return pickle.load(self.serialized_pkg) - else: - ev._active_environment = self.env - return self.pkg + env = pickle.load(self.serialized_env) if _serialize else self.env + pkg = pickle.load(self.serialized_pkg) if _serialize else self.pkg + if env: + spack.environment.activate(env) + return pkg class TestState(object): diff --git a/lib/spack/spack/test/cmd/ci.py b/lib/spack/spack/test/cmd/ci.py index d596e71401..3feef4443f 100644 --- a/lib/spack/spack/test/cmd/ci.py +++ b/lib/spack/spack/test/cmd/ci.py @@ -54,13 +54,6 @@ def project_dir_env(): os.environ.pop('CI_PROJECT_DIR') -@pytest.fixture() -def env_deactivate(): - yield - ev._active_environment = None - os.environ.pop('SPACK_ENV', None) - - def set_env_var(key, val): os.environ[key] = val @@ -124,7 +117,7 @@ and then 'd', 'b', and 'a' to be put in the next three stages, respectively. assert (spec_a_label in stages[3]) -def test_ci_generate_with_env(tmpdir, mutable_mock_env_path, env_deactivate, +def test_ci_generate_with_env(tmpdir, mutable_mock_env_path, install_mockery, mock_packages, project_dir_env): """Make sure we can get a .gitlab-ci.yml from an environment file which has the gitlab-ci, cdash, and mirrors sections.""" @@ -220,7 +213,7 @@ def _validate_needs_graph(yaml_contents, needs_graph, artifacts): def test_ci_generate_bootstrap_gcc(tmpdir, mutable_mock_env_path, - env_deactivate, install_mockery, + install_mockery, mock_packages, project_dir_env): """Test that we can bootstrap a compiler and use it as the compiler for a spec in the environment""" @@ -283,7 +276,6 @@ spack: def test_ci_generate_bootstrap_artifacts_buildcache(tmpdir, mutable_mock_env_path, - env_deactivate, install_mockery, mock_packages, project_dir_env): @@ -350,7 +342,7 @@ spack: def test_ci_generate_with_env_missing_section(tmpdir, mutable_mock_env_path, - env_deactivate, install_mockery, + install_mockery, mock_packages, project_dir_env): """Make sure we get a reasonable message if we omit gitlab-ci section""" project_dir_env(tmpdir.strpath) @@ -375,7 +367,7 @@ spack: def test_ci_generate_with_cdash_token(tmpdir, mutable_mock_env_path, - env_deactivate, install_mockery, + install_mockery, mock_packages, project_dir_env): """Make sure we it doesn't break if we configure cdash""" project_dir_env(tmpdir.strpath) @@ -430,7 +422,7 @@ spack: def test_ci_generate_with_custom_scripts(tmpdir, mutable_mock_env_path, - env_deactivate, install_mockery, + install_mockery, mock_packages, monkeypatch, project_dir_env): """Test use of user-provided scripts""" @@ -521,7 +513,7 @@ spack: def test_ci_generate_pkg_with_deps(tmpdir, mutable_mock_env_path, - env_deactivate, install_mockery, + install_mockery, mock_packages, project_dir_env): """Test pipeline generation for a package w/ dependencies""" project_dir_env(tmpdir.strpath) @@ -575,7 +567,7 @@ spack: def test_ci_generate_for_pr_pipeline(tmpdir, mutable_mock_env_path, - env_deactivate, install_mockery, + install_mockery, mock_packages, monkeypatch, project_dir_env): """Test that PR pipelines do not include a final stage job for @@ -639,7 +631,7 @@ spack: def test_ci_generate_with_external_pkg(tmpdir, mutable_mock_env_path, - env_deactivate, install_mockery, + install_mockery, mock_packages, monkeypatch, project_dir_env): """Make sure we do not generate jobs for external pkgs""" @@ -682,7 +674,7 @@ spack: assert not any('externaltool' in key for key in yaml_contents) -def test_ci_rebuild(tmpdir, mutable_mock_env_path, env_deactivate, +def test_ci_rebuild(tmpdir, mutable_mock_env_path, install_mockery, mock_packages, monkeypatch, mock_gnupghome, mock_fetch, project_dir_env): project_dir_env(tmpdir.strpath) @@ -840,7 +832,7 @@ spack: env_cmd('deactivate') -def test_ci_nothing_to_rebuild(tmpdir, mutable_mock_env_path, env_deactivate, +def test_ci_nothing_to_rebuild(tmpdir, mutable_mock_env_path, install_mockery, mock_packages, monkeypatch, mock_fetch, project_dir_env): project_dir_env(tmpdir.strpath) @@ -915,7 +907,7 @@ spack: @pytest.mark.disable_clean_stage_check -def test_push_mirror_contents(tmpdir, mutable_mock_env_path, env_deactivate, +def test_push_mirror_contents(tmpdir, mutable_mock_env_path, install_mockery_mutable_config, mock_packages, mock_fetch, mock_stage, mock_gnupghome, project_dir_env): @@ -1086,7 +1078,7 @@ def test_push_mirror_contents_exceptions(monkeypatch, capsys): def test_ci_generate_override_runner_attrs(tmpdir, mutable_mock_env_path, - env_deactivate, install_mockery, + install_mockery, mock_packages, monkeypatch, project_dir_env): """Test that we get the behavior we want with respect to the provision @@ -1231,7 +1223,7 @@ spack: def test_ci_generate_with_workarounds(tmpdir, mutable_mock_env_path, - env_deactivate, install_mockery, + install_mockery, mock_packages, monkeypatch, project_dir_env): """Make sure the post-processing cli workarounds do what they should""" @@ -1282,7 +1274,7 @@ spack: @pytest.mark.disable_clean_stage_check -def test_ci_rebuild_index(tmpdir, mutable_mock_env_path, env_deactivate, +def test_ci_rebuild_index(tmpdir, mutable_mock_env_path, install_mockery, mock_packages, mock_fetch, mock_stage): working_dir = tmpdir.join('working_dir') @@ -1336,7 +1328,7 @@ spack: def test_ci_generate_bootstrap_prune_dag( install_mockery_mutable_config, mock_packages, mock_fetch, mock_archive, mutable_config, monkeypatch, tmpdir, - mutable_mock_env_path, env_deactivate, project_dir_env): + mutable_mock_env_path, project_dir_env): """Test compiler bootstrapping with DAG pruning. Specifically, make sure that if we detect the bootstrapped compiler needs to be rebuilt, we ensure the spec we want to build with that compiler is scheduled @@ -1468,7 +1460,7 @@ spack: def test_ci_subcommands_without_mirror(tmpdir, mutable_mock_env_path, - env_deactivate, mock_packages, + mock_packages, install_mockery, project_dir_env): """Make sure we catch if there is not a mirror and report an error""" project_dir_env(tmpdir.strpath) @@ -1546,7 +1538,7 @@ def test_ensure_only_one_temporary_storage(): def test_ci_generate_temp_storage_url(tmpdir, mutable_mock_env_path, - env_deactivate, install_mockery, + install_mockery, mock_packages, monkeypatch, project_dir_env, mock_binary_index): """Verify correct behavior when using temporary-storage-url-prefix""" @@ -1602,7 +1594,7 @@ spack: def test_ci_generate_read_broken_specs_url(tmpdir, mutable_mock_env_path, - env_deactivate, install_mockery, + install_mockery, mock_packages, monkeypatch, project_dir_env): """Verify that `broken-specs-url` works as intended""" @@ -1658,7 +1650,7 @@ spack: assert(ex not in output) -def test_ci_reproduce(tmpdir, mutable_mock_env_path, env_deactivate, +def test_ci_reproduce(tmpdir, mutable_mock_env_path, install_mockery, mock_packages, monkeypatch, last_two_git_commits, project_dir_env, mock_binary_index): project_dir_env(tmpdir.strpath) diff --git a/lib/spack/spack/test/cmd/env.py b/lib/spack/spack/test/cmd/env.py index 10b9dee981..3d1725a3f0 100644 --- a/lib/spack/spack/test/cmd/env.py +++ b/lib/spack/spack/test/cmd/env.py @@ -14,8 +14,10 @@ import llnl.util.link_tree import spack.cmd.env import spack.environment as ev +import spack.environment.shell import spack.hash_types as ht import spack.modules +import spack.repo import spack.util.spack_json as sjson from spack.cmd.env import _env_create from spack.main import SpackCommand, SpackCommandError @@ -52,13 +54,6 @@ def check_viewdir_removal(viewdir): os.listdir(str(viewdir.join('.spack'))) == ['projections.yaml']) -@pytest.fixture() -def env_deactivate(): - yield - ev._active_environment = None - os.environ.pop('SPACK_ENV', None) - - def test_add(): e = ev.create('test') e.add('mpileaks') @@ -213,8 +208,8 @@ def test_env_modifications_error_on_activate( pkg = spack.repo.path.get_pkg_class("cmake-client") monkeypatch.setattr(pkg, "setup_run_environment", setup_error) - with e: - pass + + spack.environment.shell.activate(e) _, err = capfd.readouterr() assert "cmake-client had issues!" in err @@ -230,8 +225,9 @@ def test_activate_adds_transitive_run_deps_to_path( with e: install('depends-on-run-env') - cmds = ev.activate(e) - assert 'DEPENDENCY_ENV_VAR=1' in cmds + env_variables = {} + spack.environment.shell.activate(e).apply_modifications(env_variables) + assert env_variables['DEPENDENCY_ENV_VAR'] == '1' def test_env_install_same_spec_twice(install_mockery, mock_fetch): @@ -574,15 +570,11 @@ packages: e.install_all() e.write() - env_modifications = e.add_default_view_to_shell('sh') - individual_modifications = env_modifications.split('\n') - - def path_includes_fake_prefix(cmd): - return 'export PATH' in cmd and str(fake_bin) in cmd - - assert any( - path_includes_fake_prefix(cmd) for cmd in individual_modifications - ) + env_mod = spack.util.environment.EnvironmentModifications() + e.add_default_view_to_env(env_mod) + env_variables = {} + env_mod.apply_modifications(env_variables) + assert str(fake_bin) in env_variables['PATH'] def test_init_with_file_and_remove(tmpdir): @@ -630,7 +622,7 @@ env: for x in e._get_environment_specs()) -def test_with_config_bad_include(env_deactivate, capfd): +def test_with_config_bad_include(capfd): env_name = 'test_bad_include' test_config = """\ spack: @@ -650,6 +642,7 @@ spack: assert 'missing include' in err assert '/no/such/directory' in err assert 'no/such/file.yaml' in err + assert ev.active_environment() is None def test_env_with_include_config_files_same_basename(): @@ -1288,7 +1281,7 @@ def test_env_updates_view_force_remove( def test_env_activate_view_fails( - tmpdir, mock_stage, mock_fetch, install_mockery, env_deactivate): + tmpdir, mock_stage, mock_fetch, install_mockery): """Sanity check on env activate to make sure it requires shell support""" out = env('activate', 'test') assert "To set up shell support" in out @@ -2039,8 +2032,7 @@ env: def test_stack_view_activate_from_default(tmpdir, mock_fetch, mock_packages, - mock_archive, install_mockery, - env_deactivate): + mock_archive, install_mockery): filename = str(tmpdir.join('spack.yaml')) viewdir = str(tmpdir.join('view')) with open(filename, 'w') as f: @@ -2072,8 +2064,7 @@ env: def test_stack_view_no_activate_without_default(tmpdir, mock_fetch, mock_packages, mock_archive, - install_mockery, - env_deactivate): + install_mockery): filename = str(tmpdir.join('spack.yaml')) viewdir = str(tmpdir.join('view')) with open(filename, 'w') as f: @@ -2102,8 +2093,7 @@ env: def test_stack_view_multiple_views(tmpdir, mock_fetch, mock_packages, - mock_archive, install_mockery, - env_deactivate): + mock_archive, install_mockery): filename = str(tmpdir.join('spack.yaml')) default_viewdir = str(tmpdir.join('default-view')) combin_viewdir = str(tmpdir.join('combinatorial-view')) @@ -2150,7 +2140,7 @@ env: def test_env_activate_sh_prints_shell_output( - tmpdir, mock_stage, mock_fetch, install_mockery, env_deactivate + tmpdir, mock_stage, mock_fetch, install_mockery ): """Check the shell commands output by ``spack env activate --sh``. @@ -2171,7 +2161,7 @@ def test_env_activate_sh_prints_shell_output( def test_env_activate_csh_prints_shell_output( - tmpdir, mock_stage, mock_fetch, install_mockery, env_deactivate + tmpdir, mock_stage, mock_fetch, install_mockery ): """Check the shell commands output by ``spack env activate --csh``.""" env('create', 'test', add_view=True) @@ -2188,8 +2178,7 @@ def test_env_activate_csh_prints_shell_output( @pytest.mark.regression('12719') -def test_env_activate_default_view_root_unconditional(env_deactivate, - mutable_mock_env_path): +def test_env_activate_default_view_root_unconditional(mutable_mock_env_path): """Check that the root of the default view in the environment is added to the shell unconditionally.""" env('create', 'test', add_view=True) diff --git a/lib/spack/spack/test/conftest.py b/lib/spack/spack/test/conftest.py index 7ef3429383..f071d19b06 100644 --- a/lib/spack/spack/test/conftest.py +++ b/lib/spack/spack/test/conftest.py @@ -195,7 +195,7 @@ def no_path_access(monkeypatch): @pytest.fixture(scope='session', autouse=True) def clean_user_environment(): spack_env_value = os.environ.pop(ev.spack_env_var, None) - with ev.deactivate_environment(): + with ev.no_active_environment(): yield if spack_env_value: os.environ[ev.spack_env_var] = spack_env_value @@ -1386,11 +1386,11 @@ def mock_svn_repository(tmpdir_factory): @pytest.fixture() def mutable_mock_env_path(tmpdir_factory): """Fixture for mocking the internal spack environments directory.""" - saved_path = ev.env_path + saved_path = ev.environment.env_path mock_path = tmpdir_factory.mktemp('mock-env-path') - ev.env_path = str(mock_path) + ev.environment.env_path = str(mock_path) yield mock_path - ev.env_path = saved_path + ev.environment.env_path = saved_path @pytest.fixture() diff --git a/lib/spack/spack/test/env.py b/lib/spack/spack/test/env.py index 023c621445..3dfe6e90ce 100644 --- a/lib/spack/spack/test/env.py +++ b/lib/spack/spack/test/env.py @@ -5,6 +5,8 @@ """Test environment internals without CLI""" +import pytest + import spack.environment as ev import spack.spec @@ -36,3 +38,11 @@ def test_hash_change_no_rehash_concrete(tmpdir, mock_packages, config): assert read_in.concretized_order assert read_in.concretized_order[0] in read_in.specs_by_hash assert read_in.specs_by_hash[read_in.concretized_order[0]]._build_hash == new_hash + + +def test_activate_should_require_an_env(): + with pytest.raises(TypeError): + ev.activate(env='name') + + with pytest.raises(TypeError): + ev.activate(env=None) -- cgit v1.2.3-60-g2f50