Merge pull request #220 from smoors/readonly

use readonly_files

CI/run_reframe.sh

@@ -1,8 +1,11 @@
 #!/bin/bash
 # Author: Caspar van Leeuwen
 # Description: This script can be used to do regular runs of the ReFrame test suite, e.g. from a cronjob.
-# Setup instructions: make sure you have your github access key configured in your .ssh/config
-# i.e. configure an entry with HostName github.com and IdentityFile pointing to the ssh key registered with Github
+# Setup instructions:
+# 1) make sure you have your github access key configured in your .ssh/config
+#    i.e. configure an entry with HostName github.com and IdentityFile pointing to the ssh key registered with Github
+# 2) set environment variable EESSI_CI_TEMPROOT, a path in a shared filesystem in which the temporary directory will be created
+#    if $EESSI_CI_TEMPROOT is not set, $HOME will be used.
 
 # Print on which host this CI is running
 echo "Running CI on host $(hostname)"
@@ -27,7 +30,7 @@ fi
 
 # Create temporary directory
 if [ -z "${TEMPDIR}" ]; then
-    TEMPDIR=$(mktemp --directory --tmpdir=/tmp  -t rfm.XXXXXXXXXX)
+    TEMPDIR=$(mktemp --directory --tmpdir=${EESSI_CI_TEMPROOT:-HOME}  -t rfm.XXXXXXXXXX)
 fi
 
 # Set the CI configuration for this system

eessi/testsuite/common_config.py

@@ -1,6 +1,6 @@
 import os
 
-import reframe.core.logging as rlog
+import reframe.core.logging as rflog
 
 perflog_format = '|'.join([
     '%(check_job_completion_time)s',
@@ -97,7 +97,7 @@ def common_eessi_init(eessi_version=None):
     eessi_cvmfs_repo = os.getenv('EESSI_CVMFS_REPO', None)
 
     if eessi_cvmfs_repo is None:
-        rlog.getlogger().warning('\n'.join([
+        rflog.getlogger().warning(' '.join([
             "Environment variable 'EESSI_CVMFS_REPO' is not defined.",
             "If you do not intend to use the EESSI software stack, this is perfectly fine.",
             "To use EESSI, initialize the EESSI environment before running the test suite.",

eessi/testsuite/eessi_mixin.py

@@ -65,6 +65,14 @@ def __init_subclass__(cls, **kwargs):
         cls.valid_systems = ['*']
         if not cls.time_limit:
             cls.time_limit = '1h'
+        if not cls.readonly_files:
+            msg = ' '.join([
+                "Built-in attribute `readonly_files` is empty. To avoid excessive copying, it's highly recommended",
+                "to add all files and/or dirs in `sourcesdir` that are needed but not modified during the test,",
+                "thus can be symlinked into the stage dirs. If you are sure there are no such files,",
+                "set `readonly_files = ['']`.",
+            ])
+            raise ReframeFatalError(msg)
 
     # Helper function to validate if an attribute is present it item_dict.
     # If not, print it's current name, value, and the valid_values

eessi/testsuite/tests/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/MetalWalls.py

@@ -49,6 +49,8 @@ class EESSI_MetalWalls_MW(MetalWallsCheck):
     valid_systems = ['*']
     valid_prog_environs = ['default']
     time_limit = '60m'
+    # input files are downloaded
+    readonly_files = ['']
 
     module_name = parameter(find_modules('MetalWalls'))
     # For now, MetalWalls is being build for CPU targets only

eessi/testsuite/tests/apps/PyTorch/PyTorch_torchvision.py

@@ -19,6 +19,7 @@ class EESSI_PyTorch_torchvision(rfm.RunOnlyRegressionTest, EESSI_Mixin):
     module_name = parameter(chain(find_modules('torchvision'), find_modules('PyTorch-bundle')))
     executable = 'python'
     time_limit = '30m'
+    readonly_files = ['get_free_socket.py', 'pytorch_synthetic_benchmark.py']
 
     def required_mem_per_node(self):
         return self.num_tasks_per_node * 1024

eessi/testsuite/tests/apps/PyTorch/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/PyTorch/src/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/QuantumESPRESSO.py

@@ -43,6 +43,7 @@ class EESSI_QuantumESPRESSO_PW(QEspressoPWCheck, EESSI_Mixin):
     module_name = parameter(find_modules('QuantumESPRESSO'))
     # For now, QE is built for CPU targets only
     device_type = parameter([DEVICE_TYPES[CPU]])
+    readonly_files = ['']
 
     def required_mem_per_node(self):
         return (self.num_tasks_per_node * 0.9 + 4) * 1024

eessi/testsuite/tests/apps/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/cp2k/cp2k_staging/src/README.md → eessi/testsuite/tests/apps/cp2k/README.md

@@ -1,4 +1,4 @@
-# Input files for the CP2K test
+# Input files for the CP2K test in src/QS
 
 The following input files have been copied from the v2024.1 sources under benchmarks/QS,
 but with `&SCF` option `IGNORE_CONVERGENCE_FAILURE` commented out as this option is only supported in versions >= 2023.1

eessi/testsuite/tests/apps/cp2k/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/cp2k/cp2k.py

@@ -1,18 +1,15 @@
 import reframe as rfm
-from reframe.core.builtins import parameter, run_after, performance_function, sanity_function, fixture
+from reframe.core.builtins import parameter, run_after, performance_function, sanity_function
 import reframe.utility.sanity as sn
 
 from eessi.testsuite.constants import SCALES, COMPUTE_UNIT, DEVICE_TYPES, CPU
 from eessi.testsuite.eessi_mixin import EESSI_Mixin
 from eessi.testsuite.utils import find_modules
-from eessi.testsuite.tests.apps.cp2k.cp2k_staging.cp2k_stage_input import EESSI_CP2K_stage_input
 
 
 @rfm.simple_test
 class EESSI_CP2K(rfm.RunOnlyRegressionTest, EESSI_Mixin):
 
-    stage_files = fixture(EESSI_CP2K_stage_input, scope='session')
-
     benchmark_info = parameter([
         # (bench_name, energy_ref, energy_tol)
         ('QS/H2O-32', -550.5055, 1e-4),
@@ -28,6 +25,7 @@ class EESSI_CP2K(rfm.RunOnlyRegressionTest, EESSI_Mixin):
     device_type = DEVICE_TYPES[CPU]
     compute_unit = COMPUTE_UNIT[CPU]
     bench_name_ci = 'QS/H2O-32'  # set CI on smallest benchmark
+    readonly_files = ['QS']
 
     def required_mem_per_node(self):
         mems = {
@@ -45,7 +43,7 @@ def set_bench_name(self):
 
     @run_after('setup')
     def prepare_test(self):
-        self.executable_opts += ['-i', f'{self.stage_files.stagedir}/{self.bench_name}.inp']
+        self.executable_opts += ['-i', f'{self.bench_name}.inp']
 
     @sanity_function
     def assert_energy(self):

eessi/testsuite/tests/apps/cp2k/src/QS/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/cp2k/src/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/espresso/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/espresso/espresso.py

@@ -110,6 +110,8 @@ class EESSI_ESPRESSO_P3M_IONIC_CRYSTALS(EESSI_ESPRESSO):
     time_limit = '300m'
 
     executable = 'python3 madelung.py'
+    sourcesdir = 'src/p3m'
+    readonly_files = ['madelung.py']
 
     default_weak_scaling_system_size = 6
 
@@ -161,6 +163,8 @@ class EESSI_ESPRESSO_LJ_PARTICLES(EESSI_ESPRESSO):
     time_limit = '300m'
 
     executable = 'python3 lj.py'
+    sourcesdir = 'src/lj'
+    readonly_files = ['lj.py']
 
     @run_after('init')
     def set_tag_ci(self):

eessi/testsuite/tests/apps/espresso/src/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/espresso/src/lj/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/espresso/src/p3m/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/gromacs.py

@@ -52,6 +52,8 @@ class EESSI_GROMACS(EESSI_GROMACS_base, EESSI_Mixin):
     time_limit = '30m'
     module_name = parameter(find_modules('GROMACS'))
     bench_name_ci = 'HECBioSim/Crambin'
+    # input files are downloaded
+    readonly_files = ['']
 
     def required_mem_per_node(self):
         return self.num_tasks_per_node * 1024

eessi/testsuite/tests/apps/lammps/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/lammps/lammps.py

@@ -10,10 +10,8 @@
 from eessi.testsuite.constants import *  # noqa
 from eessi.testsuite.eessi_mixin import EESSI_Mixin
 
-from eessi.testsuite.tests.apps.lammps.lammps_staging.lammps_stage_input import EESSI_LAMMPS_stage_input
 
-
-class EESSI_LAMMPS_base(rfm.RunOnlyRegressionTest, EESSI_Mixin):
+class EESSI_LAMMPS_base(rfm.RunOnlyRegressionTest):
     time_limit = '30m'
     device_type = parameter([DEVICE_TYPES[CPU], DEVICE_TYPES[GPU]])
 
@@ -64,10 +62,11 @@ def set_compute_unit(self):
 
 
 @rfm.simple_test
-class EESSI_LAMMPS_lj(EESSI_LAMMPS_base):
+class EESSI_LAMMPS_lj(EESSI_LAMMPS_base, EESSI_Mixin):
     tags = {TAGS['CI']}
 
     sourcesdir = 'src/lj'
+    readonly_files = ['in.lj']
     executable = 'lmp -in in.lj'
 
     @deferrable
@@ -125,19 +124,10 @@ def set_executable_opts(self):
 
 
 @rfm.simple_test
-class EESSI_LAMMPS_rhodo(EESSI_LAMMPS_base):
+class EESSI_LAMMPS_rhodo(EESSI_LAMMPS_base, EESSI_Mixin):
     sourcesdir = 'src/rhodo'
     executable = 'lmp -in in.rhodo'
-
-    stage_input = fixture(EESSI_LAMMPS_stage_input, scope='session')
-
-    @run_after('setup')
-    def symlink_lammps_data(self):
-        '''Create a symlink to the data.rhodo file staged by the EESSI_LAMMPS_stage_input fixture.
-        Lammps needs this in the current working directory'''
-        self.prerun_cmds = [
-            f'ln -s {self.stage_input.stagedir}/rhodo/data.rhodo data.rhodo'
-        ]
+    readonly_files = ['data.rhodo', 'in.rhodo']
 
     @deferrable
     def check_number_neighbors(self):

eessi/testsuite/tests/apps/lammps/src/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/lammps/src/lj/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/lammps/src/rhodo/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/osu.py

@@ -52,6 +52,7 @@ class EESSI_OSU_Micro_Benchmarks_pt2pt(osu_benchmark):
     device_type = parameter([DEVICE_TYPES[CPU], DEVICE_TYPES[GPU]])
     # unset num_tasks_per_node from the hpctestlib.
     num_tasks_per_node = None
+    readonly_files = ['']
 
     # Set num_warmup_iters to 5 to reduce execution time, especially on slower interconnects
     num_warmup_iters = 5

eessi/testsuite/tests/apps/tensorflow/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/tensorflow/src/__init__.py

@@ -0,0 +1,2 @@
+# WARNING: do not remove this file.
+# It is needed to autogenerate documentation from this repo.

eessi/testsuite/tests/apps/tensorflow/tensorflow.py

@@ -23,6 +23,7 @@ class EESSI_TensorFlow(rfm.RunOnlyRegressionTest, EESSI_Mixin):
     device_type = parameter([DEVICE_TYPES[CPU], DEVICE_TYPES[GPU]])
 
     executable = 'python tf_test.py'
+    readonly_files = ['mnist_setup.py', 'tf_test.py']
 
     time_limit = '30m'
 

tutorial/mpi4py/mpi4py_portable_mixin.py

@@ -62,6 +62,9 @@ class EESSI_MPI4PY(rfm.RunOnlyRegressionTest, EESSI_Mixin):
     # Specify the benchmark to be tested in CI (will be marked with a `CI` tag).
     bench_name_ci = 'mpi4pi'
 
+    # Define the files and/or dirs inside sourcesdir (default=src) that should be symlinked into the stage dir
+    readonly_files = ['mpi4py_reduce.py']
+
     # Define the class method that returns the required memory per node
     def required_mem_per_node(self):
         return self.num_tasks_per_node * 100 + 250