72b36ac144
This adds a `SetupContext` class which is responsible for setting package.py module globals, and computing the changes to environment variables for the build, test or run context. The class uses `effective_deptypes` which takes a list of specs (e.g. single item of a spec to build, or a list of environment roots) and a context (build, run, test), and outputs a flat list of specs that affect the environment together with a flag in what way they do so. This list is topologically ordered from root to leaf, so that one can be assured that dependents override variables set by dependencies, not the other way around. This is used to replace the logic in `modifications_from_dependencies`, which has several issues: missing calls to `setup_run_environment`, and the order in which operations are applied. Further, it should improve performance a bit in certain cases, since `effective_deptypes` run in O(v + e) time, whereas `spack env activate` currently can take up to O(v^2 + e) time due to loops over roots. Each edge in the DAG is visited once by calling `effective_deptypes` with `env.concrete_roots()`. By marking and propagating flags through the DAG, this commit also fixes a bug where Spack wouldn't call `setup_run_environment` for runtime dependencies of link dependencies. And this PR ensures that Spack correctly sets up the runtime environment of direct build dependencies. Regarding test dependencies: in a build context they are are build-time test deps, whereas in a test context they are install-time test deps. Since there are no means to distinguish the build/install type test deps, they're both. Further changes: - all `package.py` module globals are guaranteed to be set before any of the `setup_(dependent)_(run|build)_env` functions is called - traversal order during setup: first the group of externals, then the group of non-externals, with specs in each group traversed topological (dependencies are setup before dependents) - modules: only ever call `setup_dependent_run_environment` of *direct* link/run type deps - the marker in `set_module_variables_for_package` is dropped, since we should call the method once per spec. This allows us to set only a cheap subset of globals on the module: for example it's not necessary to compute the expensive `cmake_args` and w/e if the spec under consideration is not the root node to be built. - `spack load`'s `--only` is deprecated (it has no effect now), and `spack load x` now means: do everything that's required for `x` to work at runtime, which requires runtime deps to be setup -- just like `spack env activate`. - `spack load` no longer loads build deps (of build deps) ... - `spack env activate` on partially installed or broken environments: this is all or nothing now. If some spec errors during setup of its runtime env, you'll only get the unconditional variables + a warning that says the runtime changes for specs couldn't be applied. - Remove traversal in upward direction from `setup_dependent_*` in packages. Upward traversal may iterate to specs that aren't children of the roots (e.g. zlib / python have hundreds of dependents, only a small fraction is reachable from the roots. Packages should only modify the direct dependent they receive as an argument)
438 lines
11 KiB
Fish
Executable File
438 lines
11 KiB
Fish
Executable File
#!/usr/bin/env fish
|
|
#
|
|
# Copyright 2013-2023 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)
|
|
|
|
#
|
|
# This script tests that Spack's setup-env.fish init script works.
|
|
#
|
|
|
|
|
|
function allocate_testing_global -d "allocate global variables used for testing"
|
|
|
|
# Colors for output
|
|
set -gx __spt_red '\033[1;31m'
|
|
set -gx __spt_cyan '\033[1;36m'
|
|
set -gx __spt_green '\033[1;32m'
|
|
set -gx __spt_reset '\033[0m'
|
|
|
|
# counts of test successes and failures.
|
|
set -gx __spt_success 0
|
|
set -gx __spt_errors 0
|
|
end
|
|
|
|
|
|
function delete_testing_global -d "deallocate global variables used for testing"
|
|
|
|
set -e __spt_red
|
|
set -e __spt_cyan
|
|
set -e __spt_green
|
|
set -e __spt_reset
|
|
|
|
set -e __spt_success
|
|
set -e __spt_errors
|
|
end
|
|
|
|
# ------------------------------------------------------------------------
|
|
# Functions for color output.
|
|
# ------------------------------------------------------------------------
|
|
|
|
|
|
function echo_red
|
|
printf "$__spt_red$argv$__spt_reset\n"
|
|
end
|
|
|
|
function echo_green
|
|
printf "$__spt_green$argv$__spt_reset\n"
|
|
end
|
|
|
|
function echo_msg
|
|
printf "$__spt_cyan$argv$__spt_reset\n"
|
|
end
|
|
|
|
|
|
|
|
# ------------------------------------------------------------------------
|
|
# Generic functions for testing fish code.
|
|
# ------------------------------------------------------------------------
|
|
|
|
|
|
# Print out a header for a group of tests.
|
|
function title
|
|
|
|
echo
|
|
echo_msg "$argv"
|
|
echo_msg "---------------------------------"
|
|
|
|
end
|
|
|
|
# echo FAIL in red text; increment failures
|
|
function fail
|
|
echo_red FAIL
|
|
set __spt_errors (math $__spt_errors+1)
|
|
end
|
|
|
|
# echo SUCCESS in green; increment successes
|
|
function pass
|
|
echo_green SUCCESS
|
|
set __spt_success (math $__spt_success+1)
|
|
end
|
|
|
|
|
|
#
|
|
# Run a command and suppress output unless it fails.
|
|
# On failure, echo the exit code and output.
|
|
#
|
|
function spt_succeeds
|
|
printf "'$argv' succeeds ... "
|
|
|
|
set -l output ($argv 2>&1)
|
|
|
|
# Save the command result
|
|
set cmd_status $status
|
|
|
|
if test $cmd_status -ne 0
|
|
fail
|
|
echo_red "Command failed with error $cmd_status"
|
|
if test -n "$output"
|
|
echo_msg "Output:"
|
|
echo "$output"
|
|
else
|
|
echo_msg "No output."
|
|
end
|
|
else
|
|
pass
|
|
end
|
|
end
|
|
|
|
|
|
#
|
|
# Run a command and suppress output unless it succeeds.
|
|
# If the command succeeds, echo the output.
|
|
#
|
|
function spt_fails
|
|
printf "'$argv' fails ... "
|
|
|
|
set -l output ($argv 2>&1)
|
|
|
|
if test $status -eq 0
|
|
fail
|
|
echo_red "Command succeeded, but should fail"
|
|
if test -n "$output"
|
|
echo_msg "Output:"
|
|
echo "$output"
|
|
else
|
|
echo_msg "No output."
|
|
end
|
|
else
|
|
pass
|
|
end
|
|
end
|
|
|
|
|
|
#
|
|
# Ensure that a string is in the output of a command.
|
|
# Suppresses output on success.
|
|
# On failure, echo the exit code and output.
|
|
#
|
|
function spt_contains
|
|
set -l target_string $argv[1]
|
|
set -l remaining_args $argv[2..-1]
|
|
|
|
printf "'$remaining_args' output contains '$target_string' ... "
|
|
|
|
set -l output ($remaining_args 2>&1)
|
|
|
|
# Save the command result
|
|
set cmd_status $status
|
|
|
|
if not echo "$output" | string match -q -r ".*$target_string.*"
|
|
fail
|
|
if test $cmd_status -ne 0
|
|
echo_red "Command exited with error $cmd_status"
|
|
end
|
|
echo_red "'$target_string' was not in output."
|
|
if test -n "$output"
|
|
echo_msg "Output:"
|
|
echo "$output"
|
|
else
|
|
echo_msg "No output."
|
|
end
|
|
else
|
|
pass
|
|
end
|
|
end
|
|
|
|
|
|
#
|
|
# Ensure that a string is not in the output of a command. The command must have a 0 exit
|
|
# status to guard against false positives. Suppresses output on success.
|
|
# On failure, echo the exit code and output.
|
|
#
|
|
function spt_does_not_contain
|
|
set -l target_string $argv[1]
|
|
set -l remaining_args $argv[2..-1]
|
|
|
|
printf "'$remaining_args' does not contain '$target_string' ... "
|
|
|
|
set -l output ($remaining_args 2>&1)
|
|
|
|
# Save the command result
|
|
set cmd_status $status
|
|
|
|
if test $cmd_status -ne 0
|
|
fail
|
|
echo_red "Command exited with error $cmd_status."
|
|
else if not echo "$output" | string match -q -r ".*$target_string.*"
|
|
pass
|
|
return
|
|
else
|
|
fail
|
|
echo_red "'$target_string' was in the output."
|
|
end
|
|
if test -n "$output"
|
|
echo_msg "Output:"
|
|
echo "$output"
|
|
else
|
|
echo_msg "No output."
|
|
end
|
|
end
|
|
|
|
|
|
#
|
|
# Ensure that a variable is set.
|
|
#
|
|
function is_set
|
|
printf "'$argv[1]' is set ... "
|
|
|
|
if test -z "$$argv[1]"
|
|
fail
|
|
echo_msg "'$argv[1]' was not set!"
|
|
else
|
|
pass
|
|
end
|
|
end
|
|
|
|
|
|
#
|
|
# Ensure that a variable is not set.
|
|
# Fails and prints the value of the variable if it is set.
|
|
#
|
|
function is_not_set
|
|
printf "'$argv[1]' is not set ... "
|
|
|
|
if test -n "$$argv[1]"
|
|
fail
|
|
echo_msg "'$argv[1]' was set!"
|
|
echo " $$argv[1]"
|
|
else
|
|
pass
|
|
end
|
|
end
|
|
|
|
|
|
|
|
# -----------------------------------------------------------------------
|
|
# Setup test environment and do some preliminary checks
|
|
# -----------------------------------------------------------------------
|
|
|
|
# Make sure no environment is active
|
|
set -e SPACK_ENV
|
|
true # ignore failing `set -e`
|
|
|
|
# Source setup-env.sh before tests
|
|
set -gx QA_DIR (dirname (status --current-filename))
|
|
source $QA_DIR/../setup-env.fish
|
|
|
|
|
|
|
|
# -----------------------------------------------------------------------
|
|
# Instead of invoking the module and cd commands, we print the arguments that
|
|
# Spack invokes the command with, so we can check that Spack passes the expected
|
|
# arguments in the tests below.
|
|
#
|
|
# We make that happen by defining the fish functions below. NOTE: these overwrite
|
|
# existing functions => define them last
|
|
# -----------------------------------------------------------------------
|
|
|
|
|
|
function module
|
|
echo "module $argv"
|
|
end
|
|
|
|
function cd
|
|
echo "cd $argv"
|
|
end
|
|
|
|
|
|
allocate_testing_global
|
|
|
|
|
|
|
|
# -----------------------------------------------------------------------
|
|
# Let the testing begin!
|
|
# -----------------------------------------------------------------------
|
|
|
|
|
|
title "Testing setup-env.fish with $_sp_shell"
|
|
|
|
# spack command is now available
|
|
spt_succeeds which spack
|
|
|
|
|
|
# create a fake mock package install and store its location for later
|
|
title "Setup"
|
|
echo "Creating a mock package installation"
|
|
spack -m install --fake shell-a
|
|
|
|
# create a test environment for testing environment commands
|
|
echo "Creating a mock environment"
|
|
spt_succeeds spack env create spack_test_env
|
|
spt_succeeds spack env create spack_test_2_env
|
|
|
|
# ensure that we uninstall b on exit
|
|
function spt_cleanup -p %self
|
|
echo "Removing test environment before exiting."
|
|
spack env deactivate > /dev/null 2>&1
|
|
spack env rm -y spack_test_env spack_test_2_env
|
|
|
|
title "Cleanup"
|
|
echo "Removing test packages before exiting."
|
|
spack -m uninstall -yf shell-b shell-a
|
|
|
|
echo
|
|
echo "$__spt_success tests succeeded."
|
|
echo "$__spt_errors tests failed."
|
|
|
|
delete_testing_global
|
|
end
|
|
|
|
# -----------------------------------------------------------------------
|
|
# Test all spack commands with special env support
|
|
# -----------------------------------------------------------------------
|
|
title 'Testing `spack`'
|
|
spt_contains 'usage: spack ' spack
|
|
spt_contains "usage: spack " spack -h
|
|
spt_contains "usage: spack " spack help
|
|
spt_contains "usage: spack " spack -H
|
|
spt_contains "usage: spack " spack help --all
|
|
|
|
title 'Testing `spack cd`'
|
|
spt_contains "usage: spack cd " spack cd -h
|
|
spt_contains "usage: spack cd " spack cd --help
|
|
spt_contains "cd $b_install" spack cd -i shell-b
|
|
|
|
title 'Testing `spack module`'
|
|
spt_contains "usage: spack module " spack -m module -h
|
|
spt_contains "usage: spack module " spack -m module --help
|
|
spt_contains "usage: spack module " spack -m module
|
|
|
|
title 'Testing `spack load`'
|
|
set _b_loc (spack -m location -i shell-b)
|
|
set _b_bin $_b_loc"/bin"
|
|
set _a_loc (spack -m location -i shell-a)
|
|
set _a_bin $_a_loc"/bin"
|
|
|
|
spt_contains "set -gx PATH $_b_bin" spack -m load --fish shell-b
|
|
spt_succeeds spack -m load shell-b
|
|
set LIST_CONTENT (spack -m load shell-b; spack load --list)
|
|
spt_contains "shell-b@" echo $LIST_CONTENT
|
|
spt_does_not_contain "shell-a@" echo $LIST_CONTENT
|
|
# test a variable MacOS clears and one it doesn't for recursive loads
|
|
|
|
spt_succeeds spack -m load shell-a
|
|
spt_fails spack -m load d
|
|
spt_contains "usage: spack load " spack -m load -h
|
|
spt_contains "usage: spack load " spack -m load -h d
|
|
spt_contains "usage: spack load " spack -m load --help
|
|
|
|
title 'Testing `spack unload`'
|
|
spack -m load shell-b shell-a # setup
|
|
# spt_contains "module unload $b_module" spack -m unload shell-b
|
|
spt_succeeds spack -m unload shell-b
|
|
spt_succeeds spack -m unload --all
|
|
spack -m unload --all # cleanup
|
|
spt_fails spack -m unload -l
|
|
# spt_contains "module unload -l --arg $b_module" spack -m unload -l --arg shell-b
|
|
spt_fails spack -m unload shell-d
|
|
spt_contains "usage: spack unload " spack -m unload -h
|
|
spt_contains "usage: spack unload " spack -m unload -h d
|
|
spt_contains "usage: spack unload " spack -m unload --help
|
|
|
|
title 'Testing `spack env`'
|
|
spt_contains "usage: spack env " spack env -h
|
|
spt_contains "usage: spack env " spack env --help
|
|
|
|
title 'Testing `spack env list`'
|
|
spt_contains " spack env list " spack env list -h
|
|
spt_contains " spack env list " spack env list --help
|
|
|
|
title 'Testing `spack env activate`'
|
|
spt_contains "No such environment:" spack env activate no_such_environment
|
|
spt_contains "env activate requires an environment " spack env activate
|
|
spt_contains "usage: spack env activate " spack env activate -h
|
|
spt_contains "usage: spack env activate " spack env activate --help
|
|
|
|
title 'Testing `spack env deactivate`'
|
|
spt_contains "Error: No environment is currently active" spack env deactivate
|
|
spt_contains "usage: spack env deactivate " spack env deactivate no_such_environment
|
|
spt_contains "usage: spack env deactivate " spack env deactivate -h
|
|
spt_contains "usage: spack env deactivate " spack env deactivate --help
|
|
|
|
title 'Testing activate and deactivate together'
|
|
echo "Testing 'spack env activate spack_test_env'"
|
|
spt_succeeds spack env activate spack_test_env
|
|
spack env activate spack_test_env
|
|
is_set SPACK_ENV
|
|
|
|
echo "Testing 'spack env deactivate'"
|
|
spt_succeeds spack env deactivate
|
|
spack env deactivate
|
|
is_not_set SPACK_ENV
|
|
|
|
echo "Testing 'spack env activate spack_test_env'"
|
|
spt_succeeds spack env activate spack_test_env
|
|
spack env activate spack_test_env
|
|
is_set SPACK_ENV
|
|
|
|
echo "Testing 'despacktivate'"
|
|
despacktivate
|
|
is_not_set SPACK_ENV
|
|
|
|
echo "Testing 'spack env activate --temp'"
|
|
spt_succeeds spack env activate --temp
|
|
spack env activate --temp
|
|
is_set SPACK_ENV
|
|
spack env deactivate
|
|
is_not_set SPACK_ENV
|
|
|
|
echo "Testing spack env activate repeatedly"
|
|
spack env activate spack_test_env
|
|
spack env activate spack_test_2_env
|
|
spt_contains 'spack_test_2_env' 'fish' '-c' 'echo $PATH'
|
|
spt_does_not_contain 'spack_test_env' 'fish' '-c' 'echo $PATH'
|
|
despacktivate
|
|
|
|
echo "Correct error exit codes for activate and deactivate"
|
|
spt_fails spack env activate nonexisiting_environment
|
|
spt_fails spack env deactivate
|
|
|
|
|
|
#
|
|
# NOTE: `--prompt` on fish does nothing => currently not implemented.
|
|
#
|
|
|
|
# echo "Testing 'spack env activate --prompt spack_test_env'"
|
|
# spack env activate --prompt spack_test_env
|
|
# is_set SPACK_ENV
|
|
# is_set SPACK_OLD_PS1
|
|
#
|
|
# echo "Testing 'despacktivate'"
|
|
# despacktivate
|
|
# is_not_set SPACK_ENV
|
|
# is_not_set SPACK_OLD_PS1
|
|
|
|
test "$__spt_errors" -eq 0
|