Source code for spack.cmd.test

# Copyright 2013-2022 Lawrence Livermore National Security, LLC and other
# Spack Project Developers. See the top-level COPYRIGHT file for details.
# SPDX-License-Identifier: (Apache-2.0 OR MIT)

from __future__ import print_function

import argparse
import fnmatch
import os
import re
import shutil
import sys
import textwrap

import llnl.util.tty as tty
import llnl.util.tty.colify as colify

import spack.cmd
import spack.cmd.common.arguments as arguments
import spack.environment as ev
import spack.install_test
import spack.package
import spack.repo

description = "run spack's tests for an install"
section = "admin"
level = "long"

[docs]def first_line(docstring): """Return the first line of the docstring.""" return docstring.split('\n')[0]
[docs]def setup_parser(subparser): sp = subparser.add_subparsers(metavar='SUBCOMMAND', dest='test_command') # Run run_parser = sp.add_parser('run', description=test_run.__doc__, help=first_line(test_run.__doc__)) alias_help_msg = "Provide an alias for this test-suite" alias_help_msg += " for subsequent access." run_parser.add_argument('--alias', help=alias_help_msg) run_parser.add_argument( '--fail-fast', action='store_true', help="Stop tests for each package after the first failure." ) run_parser.add_argument( '--fail-first', action='store_true', help="Stop after the first failed package." ) run_parser.add_argument( '--externals', action='store_true', help="Test packages that are externally installed." ) run_parser.add_argument( '--keep-stage', action='store_true', help='Keep testing directory for debugging' ) run_parser.add_argument( '--log-format', default=None,, help="format to be used for log files" ) run_parser.add_argument( '--log-file', default=None, help="filename for the log file. if not passed a default will be used" ) arguments.add_cdash_args(run_parser, False) run_parser.add_argument( '--help-cdash', action='store_true', help="Show usage instructions for CDash reporting" ) cd_group = run_parser.add_mutually_exclusive_group() arguments.add_common_arguments(cd_group, ['clean', 'dirty']) arguments.add_common_arguments(run_parser, ['installed_specs']) # List list_parser = sp.add_parser('list', description=test_list.__doc__, help=first_line(test_list.__doc__)) list_parser.add_argument( "-a", "--all", action="store_true", dest="list_all", help="list all packages with tests (not just installed)") list_parser.add_argument( 'tag', nargs='*', help="limit packages to those with all listed tags" ) # Find find_parser = sp.add_parser('find', description=test_find.__doc__, help=first_line(test_find.__doc__)) find_parser.add_argument( 'filter', nargs=argparse.REMAINDER, help='optional case-insensitive glob patterns to filter results.') # Status status_parser = sp.add_parser('status', description=test_status.__doc__, help=first_line(test_status.__doc__)) status_parser.add_argument( 'names', nargs=argparse.REMAINDER, help="Test suites for which to print status") # Results results_parser = sp.add_parser('results', description=test_results.__doc__, help=first_line(test_results.__doc__)) results_parser.add_argument( '-l', '--logs', action='store_true', help="print the test log for each matching package") results_parser.add_argument( '-f', '--failed', action='store_true', help="only show results for failed tests of matching packages") results_parser.add_argument( 'names', nargs=argparse.REMAINDER, metavar='[name(s)] [-- installed_specs]...', help="suite names and installed package constraints") results_parser.epilog = 'Test results will be filtered by space-' \ 'separated suite name(s) and installed\nspecs when provided. '\ 'If names are provided, then only results for those test\nsuites '\ 'will be shown. If installed specs are provided, then ony results'\ '\nmatching those specs will be shown.' # Remove remove_parser = sp.add_parser('remove', description=test_remove.__doc__, help=first_line(test_remove.__doc__)) arguments.add_common_arguments(remove_parser, ['yes_to_all']) remove_parser.add_argument( 'names', nargs=argparse.REMAINDER, help="Test suites to remove from test stage")
[docs]def test_run(args): """Run tests for the specified installed packages. If no specs are listed, run tests for all packages in the current environment or all installed packages if there is no active environment. """ if args.alias: suites = spack.install_test.get_named_test_suites(args.alias) if suites: tty.die('Test suite "{0}" already exists. Try another alias.' .format(args.alias)) # cdash help option if args.help_cdash: parser = argparse.ArgumentParser( formatter_class=argparse.RawDescriptionHelpFormatter, epilog=textwrap.dedent('''\ environment variables: SPACK_CDASH_AUTH_TOKEN authentication token to present to CDash ''')) arguments.add_cdash_args(parser, True) parser.print_help() return # set config option for fail-fast if args.fail_fast: spack.config.set('config:fail_fast', True, scope='command_line') # Get specs to test env = ev.active_environment() hashes = env.all_hashes() if env else None specs = spack.cmd.parse_specs(args.specs) if args.specs else [None] specs_to_test = [] for spec in specs: matching =, hashes=hashes) if spec and not matching: tty.warn("No installed packages match spec %s" % spec) specs_to_test.extend(matching) # test_stage_dir test_suite = spack.install_test.TestSuite(specs_to_test, args.alias) test_suite.ensure_stage() tty.msg("Spack test %s" % # Set up reporter setattr(args, 'package', [s.format() for s in test_suite.specs]) reporter = spack.package.PackageBase, 'do_test', args.log_format, args) if not reporter.filename: if args.log_file: if os.path.isabs(args.log_file): log_file = args.log_file else: log_dir = os.getcwd() log_file = os.path.join(log_dir, args.log_file) else: log_file = os.path.join( os.getcwd(), 'test-%s' % reporter.filename = log_file reporter.specs = specs_to_test with reporter('test', test_suite.stage): test_suite(remove_directory=not args.keep_stage, dirty=args.dirty, fail_first=args.fail_first, externals=args.externals)
[docs]def test_list(args): """List installed packages with available tests.""" tagged = set(spack.repo.path.packages_with_tags(*args.tag)) if args.tag \ else set() def has_test_and_tags(pkg_class): return spack.package.has_test_method(pkg_class) and \ (not args.tag or in tagged) if args.list_all: report_packages = [ for pkg_class in spack.repo.path.all_package_classes() if has_test_and_tags(pkg_class) ] if sys.stdout.isatty(): filtered = ' tagged' if args.tag else '' tty.msg("{0}{1} packages with tests.". format(len(report_packages), filtered)) colify.colify(report_packages) return # TODO: This can be extended to have all of the output formatting options # from `spack find`. env = ev.active_environment() hashes = env.all_hashes() if env else None specs = specs = list(filter(lambda s: has_test_and_tags(s.package_class), specs)) spack.cmd.display_specs(specs, long=True)
[docs]def test_find(args): # TODO: merge with status (noargs) """Find tests that are running or have available results. Displays aliases for tests that have them, otherwise test suite content hashes.""" test_suites = spack.install_test.get_all_test_suites() # Filter tests by filter argument if args.filter: def create_filter(f): raw = fnmatch.translate('f' if '*' in f or '?' in f else '*' + f + '*') return re.compile(raw, flags=re.IGNORECASE) filters = [create_filter(f) for f in args.filter] def match(t, f): return f.match(t) test_suites = [t for t in test_suites if any(match(t.alias, f) for f in filters) and os.path.isdir(t.stage)] names = [ for t in test_suites] if names: # TODO: Make these specify results vs active msg = "Spack test results available for the following tests:\n" msg += " %s\n" % ' '.join(names) msg += " Run `spack test remove` to remove all tests" tty.msg(msg) else: msg = "No test results match the query\n" msg += " Tests may have been removed using `spack test remove`" tty.msg(msg)
[docs]def test_status(args): """Get the current status for the specified Spack test suite(s).""" if args.names: test_suites = [] for name in args.names: test_suite = spack.install_test.get_test_suite(name) if test_suite: test_suites.append(test_suite) else: tty.msg("No test suite %s found in test stage" % name) else: test_suites = spack.install_test.get_all_test_suites() if not test_suites: tty.msg("No test suites with status to report") for test_suite in test_suites: # TODO: Make this handle capability tests too # TODO: Make this handle tests running in another process tty.msg("Test suite %s completed" %
def _report_suite_results(test_suite, args, constraints): """Report the relevant test suite results.""" # TODO: Make this handle capability tests too # The results file may turn out to be a placeholder for future work if constraints: # TBD: Should I be refactoring or re-using ConstraintAction? qspecs = spack.cmd.parse_specs(constraints) specs = {} for spec in qspecs: for s in, installed=True): specs[s.dag_hash()] = s specs = sorted(specs.values()) test_specs = dict((test_suite.test_pkg_id(s), s) for s in test_suite.specs if s in specs) else: test_specs = dict((test_suite.test_pkg_id(s), s) for s in test_suite.specs) if not test_specs: return if os.path.exists(test_suite.results_file): results_desc = 'Failing results' if args.failed else 'Results' matching = ", spec matching '{0}'".format(' '.join(constraints)) \ if constraints else '' tty.msg("{0} for test suite '{1}'{2}:" .format(results_desc,, matching)) results = {} with open(test_suite.results_file, 'r') as f: for line in f: pkg_id, status = line.split() results[pkg_id] = status tty.msg('test specs:') failed, skipped, untested = 0, 0, 0 for pkg_id in test_specs: if pkg_id in results: status = results[pkg_id] if status == 'FAILED': failed += 1 elif status == 'NO-TESTS': untested += 1 elif status == 'SKIPPED': skipped += 1 if args.failed and status != 'FAILED': continue msg = " {0} {1}".format(pkg_id, status) if args.logs: spec = test_specs[pkg_id] log_file = test_suite.log_file_for_spec(spec) if os.path.isfile(log_file): with open(log_file, 'r') as f: msg += '\n{0}'.format(''.join(f.readlines())) tty.msg(msg) spack.install_test.write_test_summary( failed, skipped, untested, len(test_specs)) else: msg = "Test %s has no results.\n" % msg += " Check if it is running with " msg += "`spack test status %s`" % tty.msg(msg)
[docs]def test_results(args): """Get the results from Spack test suite(s) (default all).""" if args.names: try: sep_index = args.names.index('--') names = args.names[:sep_index] constraints = args.names[sep_index + 1:] except ValueError: names = args.names constraints = None else: names, constraints = None, None if names: test_suites = [spack.install_test.get_test_suite(name) for name in names] test_suites = list(filter(lambda ts: ts is not None, test_suites)) if not test_suites: tty.msg('No test suite(s) found in test stage: {0}' .format(', '.join(names))) else: test_suites = spack.install_test.get_all_test_suites() if not test_suites: tty.msg("No test suites with results to report") for test_suite in test_suites: _report_suite_results(test_suite, args, constraints)
[docs]def test_remove(args): """Remove results from Spack test suite(s) (default all). If no test suite is listed, remove results for all suites. Removed tests can no longer be accessed for results or status, and will not appear in `spack test list` results.""" if args.names: test_suites = [] for name in args.names: test_suite = spack.install_test.get_test_suite(name) if test_suite: test_suites.append(test_suite) else: tty.msg("No test suite %s found in test stage" % name) else: test_suites = spack.install_test.get_all_test_suites() if not test_suites: tty.msg("No test suites to remove") return if not args.yes_to_all: msg = 'The following test suites will be removed:\n\n' msg += ' ' + ' '.join( for test in test_suites) + '\n' tty.msg(msg) answer = tty.get_yes_or_no('Do you want to proceed?', default=False) if not answer: tty.msg('Aborting removal of test suites') return for test_suite in test_suites: shutil.rmtree(test_suite.stage)
[docs]def test(parser, args): globals()['test_%s' % args.test_command](args)