Cache extra test sources update (#45493)

* stand-alone test API update: self.cache_extra_test_sources(...) -> cache_extra_test_sources(self, ...)
* superlu: switch to new cache_extra_test_sources API

---------

Co-authored-by: Tamara Dahlgren <dahlgren1@llnl.gov>

var/spack/repos/builtin/packages/adios2/package.py

@@ -364,7 +364,7 @@ def setup_install_tests(self):
         install test subdirectory for use during `spack test run`.
         """
         extra_install_tests = [join_path("testing", "install", "C")]
-        self.cache_extra_test_sources(extra_install_tests)
+        cache_extra_test_sources(self, extra_install_tests)
 
     def test_run_executables(self):
         """Run installed adios2 executables"""

var/spack/repos/builtin/packages/aml/package.py

@@ -115,7 +115,7 @@ def configure_args(self):
     def cache_test_sources(self):
         """Copy the example source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources(self.smoke_test_src)
+        cache_extra_test_sources(self, self.smoke_test_src)
 
     def test_check_tutorial(self):
         """Compile and run the tutorial tests as install checks"""

var/spack/repos/builtin/packages/amrex/package.py

@@ -357,7 +357,7 @@ def setup_standalone_test(self):
         if self.spec.satisfies("@:21.11"):
             return
 
-        self.cache_extra_test_sources(["Tests"])
+        cache_extra_test_sources(self, ["Tests"])
 
     def test_run_install_test(self):
         """build and run AmrCore test"""

var/spack/repos/builtin/packages/arborx/package.py

@@ -129,7 +129,7 @@ def cmake_args(self):
     def setup_build_tests(self):
         """Copy the example source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources([self.examples_src_dir])
+        cache_extra_test_sources(self, [self.examples_src_dir])
 
     @property
     def cached_tests_work_dir(self):

var/spack/repos/builtin/packages/archer/package.py

@@ -50,7 +50,7 @@ def cmake_args(self):
     def cache_test_sources(self):
         """Copy the example source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources(["test"])
+        cache_extra_test_sources(self, ["test"])
 
     def test_run_parallel_example(self):
         """build and run parallel-simple"""

var/spack/repos/builtin/packages/biobambam2/package.py

@@ -38,7 +38,7 @@ def configure_args(self):
     def cache_test_sources(self):
         """Copy the test source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources(self.test_src_dir)
+        cache_extra_test_sources(self, self.test_src_dir)
 
         # Fix test scripts to run installed binaries
         scripts_dir = join_path(install_test_root(self), self.test_src_dir)

var/spack/repos/builtin/packages/bolt/package.py

@@ -56,7 +56,7 @@ def cmake_args(self):
     def cache_test_sources(self):
         """Copy the example source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources(["examples"])
+        cache_extra_test_sources(self, ["examples"])
 
     def test_sample_nested_example(self):
         """build and run sample_nested"""

var/spack/repos/builtin/packages/bricks/package.py

@@ -76,7 +76,7 @@ def copy_test_sources(self):
             join_path("examples", "external", "main.cpp"),
             join_path("examples", "external", "7pt.py"),
         ]
-        self.cache_extra_test_sources(srcs)
+        cache_extra_test_sources(self, srcs)
 
     def test_bricklib_example(self):
         """build and run pre-built example"""

var/spack/repos/builtin/packages/caliper/package.py

@@ -202,7 +202,7 @@ def cmake_args(self):
     def cache_test_sources(self):
         """Copy the example source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources([join_path("examples", "apps")])
+        cache_extra_test_sources(self, [join_path("examples", "apps")])
 
     def test_cxx_example(self):
         """build and run cxx-example"""

var/spack/repos/builtin/packages/darshan-runtime/package.py

@@ -149,7 +149,7 @@ def basepath(self):
     @run_after("install")
     def _copy_test_inputs(self):
         test_inputs = [join_path(self.basepath, "mpi-io-test.c")]
-        self.cache_extra_test_sources(test_inputs)
+        cache_extra_test_sources(self, test_inputs)
 
     def test_mpi_io_test(self):
         """build, run, and check outputs"""

var/spack/repos/builtin/packages/darshan-util/package.py

@@ -113,7 +113,7 @@ def tests_log_path(self):
     @run_after("install")
     def _copy_test_inputs(self):
         test_inputs = [self.tests_log_path]
-        self.cache_extra_test_sources(test_inputs)
+        cache_extra_test_sources(self, test_inputs)
 
     def test_parser(self):
         """process example log and check counters"""

var/spack/repos/builtin/packages/dssp/package.py

@@ -53,7 +53,7 @@ def edit(self):
     @run_after("install")
     def cache_test_sources(self):
         """Save off the pdb sources for stand-alone testing."""
-        self.cache_extra_test_sources("pdb")
+        cache_extra_test_sources(self, "pdb")
 
     def test_mkdssp(self):
         """calculate structure for example"""

var/spack/repos/builtin/packages/eigenexa/package.py

@@ -74,7 +74,7 @@ def setup_build_environment(self, env):
     @run_after("install")
     def cache_test_sources(self):
         """Save off benchmark files for stand-alone tests."""
-        self.cache_extra_test_sources("benchmark")
+        cache_extra_test_sources(self, "benchmark")
 
     def test_benchmarks(self):
         """run benchmark checks"""

var/spack/repos/builtin/packages/flibcpp/package.py

@@ -73,7 +73,7 @@ def cmake_args(self):
     def setup_smoke_tests(self):
         """Copy the example source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources([self.examples_src_dir])
+        cache_extra_test_sources(self, [self.examples_src_dir])
 
     @property
     def cached_tests_work_dir(self):

var/spack/repos/builtin/packages/formetis/package.py

@@ -53,7 +53,7 @@ def cmake_args(self):
     def setup_smoke_tests(self):
         """Copy the example source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources([self.examples_src_dir])
+        cache_extra_test_sources(self, [self.examples_src_dir])
 
     @property
     def cached_tests_work_dir(self):

var/spack/repos/builtin/packages/fortrilinos/package.py

@@ -96,7 +96,7 @@ def cached_tests_work_dir(self):
     def setup_smoke_tests(self):
         """Copy the example source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources([self.examples_src_dir])
+        cache_extra_test_sources(self, [self.examples_src_dir])
 
     def test_installation(self):
         """build and run ctest against the installed software"""

var/spack/repos/builtin/packages/genesis/package.py

@@ -117,4 +117,4 @@ def cached_tests_work_dir(self):
     def cache_test_sources(self):
         """Copy test files after the package is installed for test()."""
         if self.spec.satisfies("@master"):
-            self.cache_extra_test_sources(["tests"])
+            cache_extra_test_sources(self, ["tests"])

var/spack/repos/builtin/packages/ginkgo/package.py

@@ -214,7 +214,7 @@ def extra_install_tests(self):
 
     @run_after("install")
     def cache_test_sources(self):
-        self.cache_extra_test_sources(self.extra_install_tests)
+        cache_extra_test_sources(self, self.extra_install_tests)
 
     def _cached_tests_src_dir(self, script):
         """The cached smoke test source directory for the script."""

var/spack/repos/builtin/packages/hdf/package.py

@@ -218,7 +218,7 @@ def cached_tests_work_dir(self):
     def setup_build_tests(self):
         """Copy the build test files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources(self.extra_install_tests)
+        cache_extra_test_sources(self, self.extra_install_tests)
 
     def _check_version_match(self, exe):
         """Ensure exe version check yields spec version."""

var/spack/repos/builtin/packages/hip/package.py

@@ -594,9 +594,9 @@ def cache_test_sources(self):
         """Copy the tests source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
         if self.spec.satisfies("@5.1:5.5"):
-            self.cache_extra_test_sources([self.test_src_dir_old])
+            cache_extra_test_sources(self, [self.test_src_dir_old])
         elif self.spec.satisfies("@5.6:"):
-            self.cache_extra_test_sources([self.test_src_dir])
+            cache_extra_test_sources(self, [self.test_src_dir])
 
     def test_samples(self):
         # configure, build and run all hip samples

var/spack/repos/builtin/packages/kokkos/package.py

@@ -395,7 +395,7 @@ def setup_build_tests(self):
             "-DSPACK_PACKAGE_INSTALL_DIR:PATH={0}".format(self.prefix),
         ]
         cmake(*cmake_args)
-        self.cache_extra_test_sources(cmake_out_path)
+        cache_extra_test_sources(self, cmake_out_path)
 
     def test_run(self):
         """Test if kokkos builds and runs"""

var/spack/repos/builtin/packages/legion/package.py

@@ -495,7 +495,7 @@ def install(self, spec, prefix):
     def cache_test_sources(self):
         """Copy the example source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources([join_path("examples", "local_function_tasks")])
+        cache_extra_test_sources(self, [join_path("examples", "local_function_tasks")])
 
     def test_run_local_function_tasks(self):
         """Build and run external application example"""

var/spack/repos/builtin/packages/libsigsegv/package.py

@@ -36,7 +36,7 @@ def configure_args(self):
     def setup_tests(self):
         """Copy the build test files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources(self.extra_install_tests)
+        cache_extra_test_sources(self, self.extra_install_tests)
 
     def test_smoke_test(self):
         """build and run smoke test"""

var/spack/repos/builtin/packages/mfem/package.py

@@ -1223,7 +1223,7 @@ def cache_test_sources(self):
         # Clean the 'examples' directory -- at least one example is always built
         # and we do not want to cache executables.
         make("examples/clean", parallel=False)
-        self.cache_extra_test_sources([self.examples_src_dir, self.examples_data_dir])
+        cache_extra_test_sources(self, [self.examples_src_dir, self.examples_data_dir])
 
     def test_ex10(self):
         """build and run ex10(p)"""

var/spack/repos/builtin/packages/mpich/package.py

@@ -649,7 +649,7 @@ def configure_args(self):
     def cache_test_sources(self):
         """Copy the example source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources(["examples", join_path("test", "mpi")])
+        cache_extra_test_sources(self, ["examples", join_path("test", "mpi")])
 
     def mpi_launcher(self):
         """Determine the appropriate launcher."""

var/spack/repos/builtin/packages/openmpi/package.py

@@ -1298,7 +1298,7 @@ def setup_install_tests(self):
         Copy the example files after the package is installed to an
         install test subdirectory for use during `spack test run`.
         """
-        self.cache_extra_test_sources(self.extra_install_tests)
+        cache_extra_test_sources(self, self.extra_install_tests)
 
     def run_installed_binary(self, bin, options, expected):
         """run and check outputs for the installed binary"""

var/spack/repos/builtin/packages/papi/package.py

@@ -209,7 +209,7 @@ def cache_test_sources(self):
         """Copy the example source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
         if os.path.exists(self.test_src_dir):
-            self.cache_extra_test_sources([self.test_src_dir])
+            cache_extra_test_sources(self, [self.test_src_dir])
 
     def test_smoke(self):
         """Compile and run simple code against the installed papi library."""

var/spack/repos/builtin/packages/papyrus/package.py

@@ -42,7 +42,7 @@ def setup_run_environment(self, env):
     def cache_test_sources(self):
         """Copy the example source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources(join_path("kv", "tests"))
+        cache_extra_test_sources(self, join_path("kv", "tests"))
 
     @property
     def _lib_dir(self):

var/spack/repos/builtin/packages/petsc/package.py

@@ -697,8 +697,9 @@ def setup_build_tests(self):
             tty.warn("Stand-alone tests only available for v3.13:")
             return
 
-        self.cache_extra_test_sources(
+        cache_extra_test_sources(
-            [join_path("src", "ksp", "ksp", "tutorials"), join_path("src", "snes", "tutorials")]
+            self,
+            [join_path("src", "ksp", "ksp", "tutorials"), join_path("src", "snes", "tutorials")],
         )
 
     def get_runner(self):

var/spack/repos/builtin/packages/py-chainer/package.py

@@ -52,7 +52,7 @@ class PyChainer(PythonPackage):
     @run_after("install")
     def cache_test_sources(self):
         if "+mn" in self.spec:
-            self.cache_extra_test_sources("examples")
+            cache_extra_test_sources(self, "examples")
 
     def test_chainermn(self):
         """run the ChainerMN test"""

var/spack/repos/builtin/packages/py-libensemble/package.py

@@ -92,7 +92,9 @@ class PyLibensemble(PythonPackage):
     def cache_test_sources(self):
         """Copy the example source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources(join_path("examples", "calling_scripts", "regression_tests"))
+        cache_extra_test_sources(
+            self, join_path("examples", "calling_scripts", "regression_tests")
+        )
 
     def run_tutorial_script(self, script):
         """run the tutorial example regression test"""

var/spack/repos/builtin/packages/qthreads/package.py

@@ -114,7 +114,7 @@ def configure_args(self):
     def setup_build_tests(self):
         """Copy the build test files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources([join_path("test", "argparsing.h"), self.test_base_path])
+        cache_extra_test_sources(self, [join_path("test", "argparsing.h"), self.test_base_path])
 
     def _build_and_run_test(self, test):
         """Build and run the test."""

var/spack/repos/builtin/packages/rocm-clang-ocl/package.py

@@ -83,7 +83,7 @@ class RocmClangOcl(CMakePackage):
     def cache_test_sources(self):
         """Copy the tests source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources([self.test_src_dir])
+        cache_extra_test_sources(self, [self.test_src_dir])
 
     def test_make(self):
         """Test make"""

var/spack/repos/builtin/packages/rocm-cmake/package.py

@@ -63,7 +63,7 @@ class RocmCmake(CMakePackage):
     def cache_test_sources(self):
         """Copy the tests source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources([self.test_src_dir])
+        cache_extra_test_sources(self, [self.test_src_dir])
 
     def test_cmake(self):
         """Test cmake"""

var/spack/repos/builtin/packages/slate/package.py

@@ -158,7 +158,7 @@ def cache_test_sources(self):
             return
         """Copy the example source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources(["examples"])
+        cache_extra_test_sources(self, ["examples"])
 
     def mpi_launcher(self):
         searchpath = [self.spec["mpi"].prefix.bin]

var/spack/repos/builtin/packages/strumpack/package.py

@@ -208,7 +208,7 @@ def test_data_dir(self):
     def cache_test_sources(self):
         """Copy the example source files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources([self.test_data_dir, self.test_src_dir])
+        cache_extra_test_sources(self, [self.test_data_dir, self.test_src_dir])
 
     def _test_example(self, test_prog, test_cmd, pre_args=[]):
         test_dir = join_path(self.test_suite.current_test_cache_dir, self.test_src_dir)

var/spack/repos/builtin/packages/superlu-dist/package.py

@@ -169,7 +169,7 @@ def flag_handler(self, name, flags):
     def cache_test_sources(self):
         """Copy the example matrices after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources([self.examples_src_dir])
+        cache_extra_test_sources(self, [self.examples_src_dir])
 
     def test_pddrive(self):
         """run cached pddrive"""

var/spack/repos/builtin/packages/superlu/package.py

@@ -116,7 +116,7 @@ def setup_standalone_tests(self):
         filter_file(r"include \.\./" + filename, "include ./" + filename, makefile)
 
         # Cache the examples directory for use by stand-alone tests
-        self.pkg.cache_extra_test_sources(self.pkg.examples_src_dir)
+        cache_extra_test_sources(self.pkg, self.pkg.examples_src_dir)
 
     def _make_hdr_for_test(self, lib):
         """Standard configure arguments for make.inc"""

var/spack/repos/builtin/packages/tau/package.py

@@ -462,23 +462,23 @@ def setup_run_environment(self, env):
     def setup_build_tests(self):
         """Copy the build test files after the package is installed to an
         install test subdirectory for use during `spack test run`."""
-        self.cache_extra_test_sources(self.matmult_test)
+        cache_extra_test_sources(self, self.matmult_test)
-        self.cache_extra_test_sources(self.makefile_test)
+        cache_extra_test_sources(self, self.makefile_test)
-        self.cache_extra_test_sources(self.makefile_inc_test)
+        cache_extra_test_sources(self, self.makefile_inc_test)
         if "+dyninst" in self.spec:
-            self.cache_extra_test_sources(self.dyninst_test)
+            cache_extra_test_sources(self, self.dyninst_test)
         if "+cuda" in self.spec:
-            self.cache_extra_test_sources(self.cuda_test)
+            cache_extra_test_sources(self, self.cuda_test)
         if "+level_zero" in self.spec:
-            self.cache_extra_test_sources(self.level_zero_test)
+            cache_extra_test_sources(self, self.level_zero_test)
         if "+rocm" in self.spec:
-            self.cache_extra_test_sources(self.rocm_test)
+            cache_extra_test_sources(self, self.rocm_test)
         if "+syscall" in self.spec:
-            self.cache_extra_test_sources(self.syscall_test)
+            cache_extra_test_sources(self, self.syscall_test)
         if "+ompt" in self.spec:
-            self.cache_extra_test_sources(self.ompt_test)
+            cache_extra_test_sources(self, self.ompt_test)
         if "+python" in self.spec:
-            self.cache_extra_test_sources(self.python_test)
+            cache_extra_test_sources(self, self.python_test)
 
     def _run_python_test(self, test_name, purpose, work_dir):
         tau_python = which(self.prefix.bin.tau_python)