Merge branch 'master' into feat/post-init-hook

Author: Vasileios Karakasis

cscs-checks/prgenv/cuda-fortran/cuda_fortran_check.py

@@ -13,10 +13,7 @@ def __init__(self):
         self.valid_systems = ['daint:gpu', 'dom:gpu']
         self.valid_prog_environs = ['PrgEnv-pgi']
         self.sourcepath = 'vecAdd_cuda.cuf'
-
-        # FIXME: PGI 20.x does not support CUDA 11, see case #275674
-        self.modules = ['craype-accel-nvidia60',
-                        'cudatoolkit/10.2.89_3.29-7.0.2.1_3.5__g67354b4']
+        self.modules = ['craype-accel-nvidia60']
         self.build_system = 'SingleSource'
         self.build_system.fflags = ['-ta=tesla:cc60']
         self.num_gpus_per_node = 1
@@ -25,3 +22,13 @@ def __init__(self):
         self.sanity_patterns = sn.assert_reference(result, 1., -1e-5, 1e-5)
         self.maintainers = ['TM', 'AJ']
         self.tags = {'production', 'craype'}
+
+    # FIXME: PGI 20.x does not support CUDA 11, see case #275674
+    @rfm.run_before('compile')
+    def cudatoolkit_pgi_20x_workaround(self):
+        if self.current_system.name == 'daint':
+            cudatoolkit_version = '10.2.89_3.29-7.0.2.1_3.5__g67354b4'
+        else:
+            cudatoolkit_version = '10.2.89_3.29-7.0.2.1_3.27__g67354b4'
+
+        self.modules += [f'cudatoolkit/{cudatoolkit_version}']

docs/requirements.txt

@@ -1,4 +1,4 @@
 jsonschema==3.2.0
 semver==2.13.0
-Sphinx==3.5.2
+Sphinx==3.5.3
 sphinx-rtd-theme==0.5.1

docs/tutorial_advanced.rst

@@ -790,3 +790,63 @@ Therefore, the ``release.txt`` file can now be used in the subsequent sanity che
 
 For a complete list of the available attributes of a specific container platform, please have a look at the :ref:`container-platforms` section of the :doc:`regression_test_api` guide.
 On how to configure ReFrame for running containerized tests, please have a look at the :ref:`container-platform-configuration` section of the :doc:`config_reference`.
+
+
+Writing reusable tests
+----------------------
+
+.. versionadded:: 3.5.0
+
+So far, all the examples shown above were tight to a particular system or configuration, which makes reusing these tests in other systems not straightforward.
+However, the introduction of the :py:func:`~reframe.core.pipeline.RegressionTest.parameter` and :py:func:`~reframe.core.pipeline.RegressionTest.variable` ReFrame built-ins solves this problem, eliminating the need to specify any of the test variables in the :func:`__init__` method.
+Hence, these parameters and variables can be treated as simple class attributes, which allows us to leverage Python's class inheritance and write more modular tests.
+For simplicity, we illustrate this concept with the above :class:`ContainerTest` example, where the goal here is to re-write this test as a library that users can simply import from and derive their tests without having to rewrite the bulk of the test.
+Also, for illustrative purposes, we parameterize this library test on a few different image tags (the above example just used ``ubuntu:18.04``) and throw the container commands into a separate bash script just to create some source files.
+Thus, removing all the system and configuration specific variables, and moving as many assignments as possible into the class body, the system agnostic library test looks as follows:
+
+.. code-block:: console
+
+   cat tutorials/advanced/library/lib/__init__.py
+
+
+.. literalinclude:: ../tutorials/advanced/library/lib/__init__.py
+   :lines: 6-
+   :emphasize-lines: 8-17
+
+Note that the class :class:`ContainerBase` is not decorated since it does not specify the required variables ``valid_systems`` and ``valid_prog_environs``, and it declares the ``platform`` parameter without any defined values assigned.
+Hence, the user can simply derive from this test and specialize it to use the desired container platforms.
+Since the parameters are defined directly in the class body, the user is also free to override or extend any of the other parameters in a derived test.
+In this example, we have parametrized the base test to run with the ``ubuntu:18.04`` and ``ubuntu:20.04`` images, but these values from ``dist`` (and also the ``dist_name`` variable) could be modified by the derived class if needed.
+
+On the other hand, the rest of the test depends on the values from the test parameters, and a parameter is only assigned a specific value after the class has been instantiated.
+Thus, the rest of the test is expressed as hooks, without the need to write anything in the :func:`__init__` method.
+In fact, writing the test in this way permits having hooks that depend on undefined variables or parameters.
+This is the case with the :func:`set_container_platform` hook, which depends on the undefined parameter ``platform``.
+Hence, the derived test **must** define all the required parameters and variables; otherwise ReFrame will notice that the test is not well defined and will raise an error accordingly.
+
+Before moving onwards to the derived test, note that the :class:`ContainerBase` class takes the additional argument ``pin_prefix=True``, which locks the prefix of all derived tests to this base test.
+This will allow the retrieval of the sources located in the library by any derived test, regardless of what their containing directory is.
+
+.. code-block:: console
+
+   cat tutorials/advanced/library/lib/src/get_os_release.sh
+
+
+.. literalinclude:: ../tutorials/advanced/library/lib/src/get_os_release.sh
+   :lines: 1-
+
+Now from the user's perspective, the only thing to do is to import the above base test and specify the required variables and parameters.
+For consistency with the above example, we set the ``platform`` parameter to use Sarus and Singularity, and we configure the test to run on Piz Daint with the built-in programming environment.
+Hence, the above :class:`ContainerTest` is now reduced to the following:
+
+.. code-block:: console
+
+   cat tutorials/advanced/library/usr/container_test.py
+
+
+.. literalinclude:: ../tutorials/advanced/library/usr/container_test.py
+   :lines: 6-
+
+In a similar fashion, any other user could reuse the above :class:`ContainerBase` class and write the test for their own system with a few lines of code.
+
+*Happy test sharing!*

reframe/core/buildsystems.py

@@ -147,7 +147,11 @@ def post_build(self, buildjob):
         Build systems may use this information to do some post processing and
         provide additional, build system-specific, functionality to the users.
 
+        This function will always be executed from the test's stage directory.
+
         .. versionadded:: 3.5.0
+        .. versionchanged:: 3.5.2
+           The function is executed from the stage directory.
 
         :meta private:
 
@@ -741,7 +745,6 @@ def __init__(self):
         self.package_opts = {}
         self.prefix = 'easybuild'
         self._eb_modules = []
-        self._prefix_save = None
 
     def emit_build_commands(self, environ):
         if not self.easyconfigs:
@@ -755,7 +758,6 @@ def emit_build_commands(self, environ):
 
         prefix = os.path.join(os.getcwd(), self.prefix)
         options = ' '.join(self.options)
-        self._prefix_save = prefix
         return [f'export EASYBUILD_BUILDPATH={prefix}/build',
                 f'export EASYBUILD_INSTALLPATH={prefix}',
                 f'export EASYBUILD_PREFIX={prefix}',
@@ -765,7 +767,8 @@ def emit_build_commands(self, environ):
     def post_build(self, buildjob):
         # Store the modules generated by EasyBuild
 
-        modulesdir = os.path.join(self._prefix_save, 'modules', 'all')
+        modulesdir = os.path.join(os.getcwd(), self.prefix,
+                                  'modules', 'all')
         with open(buildjob.stdout) as fp:
             out = fp.read()
 

reframe/core/decorators.py

@@ -85,8 +85,8 @@ def _validate_test(cls):
                                  'subclass of RegressionTest')
 
     if (cls.is_abstract()):
-        raise ValueError(f'decorated test ({cls.__qualname__!r}) is an'
-                         f' abstract test')
+        raise ValueError(f'decorated test ({cls.__qualname__!r}) has one or '
+                         f'more undefined parameters')
 
 
 def simple_test(cls):

reframe/core/meta.py

@@ -220,13 +220,12 @@ def param_space(cls):
         return cls._rfm_param_space
 
     def is_abstract(cls):
-        '''Check if the test is an abstract test.
+        '''Check if the class is an abstract test.
 
-        If the parameter space has undefined parameters, the test is considered
-        an abstract test. If that is the case, the length of the parameter
-        space is just 0.
+        This is the case when some parameters are undefined, which results in
+        the length of the parameter space being 0.
 
-        :return: bool indicating wheteher the test is abstract or not
+        :return: bool indicating wheteher the test has undefined parameters.
 
         :meta private:
         '''

reframe/core/pipeline.py

@@ -826,8 +826,8 @@ def __rfm_init__(self, name=None, prefix=None):
 
         # Static directories of the regression check
         self._prefix = os.path.abspath(prefix)
-        if (not os.path.isdir(os.path.join(self._prefix, self.sourcesdir)) and
-            not osext.is_url(self.sourcesdir)):
+        if (self.sourcesdir == 'src' and
+            not os.path.isdir(os.path.join(self._prefix, self.sourcesdir))):
             self.sourcesdir = None
 
         # Runtime information of the test
@@ -1282,7 +1282,8 @@ def compile_wait(self):
             raise BuildError(self._build_job.stdout,
                              self._build_job.stderr, self._stagedir)
 
-        self.build_system.post_build(self._build_job)
+        with osext.change_dir(self._stagedir):
+            self.build_system.post_build(self._build_job)
 
     @final
     def run(self):

reframe/core/schedulers/slurm.py

@@ -551,6 +551,10 @@ class SqueueJobScheduler(SlurmJobScheduler):
     SQUEUE_DELAY = 2
 
     def poll(self, *jobs):
+        if jobs:
+            # Filter out non-jobs
+            jobs = [job for job in jobs if job is not None]
+
         if not jobs:
             return
 

reframe/frontend/executors/policies.py

@@ -409,7 +409,7 @@ def runcase(self, case):
             else:
                 self.printer.status('HOLD', task.check.info(), just='right')
         except TaskExit:
-            if not task.failed or not task.skipped:
+            if not task.failed and not task.skipped:
                 with contextlib.suppress(TaskExit):
                     self._reschedule(task)
 

requirements.txt

@@ -1,13 +1,13 @@
 argcomplete==1.12.2
-coverage==5.3
-importlib_metadata==2.0.0
+coverage==5.5
+importlib_metadata==3.10.0; python_version < '3.8'
 jsonschema==3.2.0
-pytest==6.2.0
+pytest==6.2.2
 pytest-forked==1.3.0
 pytest-parallel==0.1.0
-PyYAML==5.4
+PyYAML==5.4.1
 requests==2.25.1
 semver==2.13.0
-setuptools==50.3.0
+setuptools==54.2.0
 wcwidth==0.2.5
-#+pygelf%pygelf==0.3.6
+#+pygelf%pygelf==0.4.0