Merge branch 'master' into doc/perf-functions

Author: vkarak

ci-scripts/genrelnotes.py

@@ -5,7 +5,6 @@
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
-import collections
 import re
 import sys
 import subprocess
@@ -15,8 +14,8 @@ def usage():
     sys.stderr.write('Usage: %s PREV_RELEASE CURR_RELEASE\n' % sys.argv[0])
 
 
-def extract_release_notes(git_output, tag):
-    return re.findall(r'pull request (#\d+).*\s*\[%s\] (.*)' % tag, git_output)
+def extract_release_notes(git_output):
+    return re.findall(r'pull request (#\d+).*\s*\[(\S+)\] (.*)', git_output)
 
 
 if __name__ == '__main__':
@@ -39,21 +38,30 @@ def extract_release_notes(git_output, tag):
         sys.stderr.write(e.stdout)
         sys.exit(1)
 
-    titles = {
-        'feat': '## New features and enhancements',
+    tag_mapping = {
+        'feat': '## New features',
+        'enhancement': '## Enhancements',
+        'doc': '## Enhancements',
         'bugfix': '## Bug fixes',
         'testlib': '## Test library'
     }
-    sections = collections.OrderedDict()
-    for tag in ['feat', 'bugfix', 'testlib', 'ci', 'doc']:
-        title_line = titles.get(tag, '## Other')
-        sections.setdefault(title_line, [])
-        for pr, descr in extract_release_notes(completed.stdout, tag):
-            descr_line = '- %s (%s)' % (descr, pr)
-            sections[title_line].append(descr_line)
+    sections = {
+        '## New features': [],
+        '## Enhancements': [],
+        '## Bug fixes': [],
+        '## Test library': [],
+        '## Other': []
+    }
+    for pr, tag, descr in extract_release_notes(completed.stdout):
+        title_line = tag_mapping.get(tag, '## Other')
+        descr_line = f'- {descr} ({pr})'
+        sections[title_line].append(descr_line)
 
     print('# Release Notes')
     for sec_title, sec_lines in sections.items():
+        if not sec_lines:
+            continue
+
         print()
         print(sec_title)
         print()

docs/conf.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 #
-# Copyright 2016-2022 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
+# Copyright 2016-2023 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
 # ReFrame Project Developers. See the top-level LICENSE file for details.
 #
 # SPDX-License-Identifier: BSD-3-Clause
@@ -85,7 +85,7 @@
 
 # General information about the project.
 project = 'ReFrame'
-copyright = '2016-2022, CSCS/ETH Zurich and other ReFrame Project Developers'
+copyright = '2016-2023, CSCS/ETH Zurich, ReFrame Project Developers'
 author = 'ReFrame Project Developers'
 
 # The version info for the project you're documenting, acts as replacement for

docs/manpage.rst

@@ -220,6 +220,10 @@ An action must always be specified.
    .. versionadded:: 3.10.0
       Support for different types of listing is added.
 
+   .. versionchanged:: 4.0.5
+      The variable names to which fixtures are bound are also listed.
+      See :ref:`test_naming_scheme` for more information.
+
 .. option:: -l, --list[=T|C]
 
    List selected tests and their dependencies.
@@ -234,6 +238,10 @@ An action must always be specified.
    .. versionadded:: 3.10.0
       Support for different types of listing is added.
 
+   .. versionchanged:: 4.0.5
+      The variable names to which fixtures are bound are also listed.
+      See :ref:`test_naming_scheme` for more information.
+
 .. option:: --list-tags
 
    List the unique tags of the selected tests.
@@ -510,7 +518,8 @@ Options controlling ReFrame execution
 
    ``TEST`` can have the form ``[TEST.][FIXT.]*``, in which case ``VAR`` will be set in fixture ``FIXT`` of ``TEST``.
    Note that this syntax is recursive on fixtures, so that a variable can be set in a fixture arbitrarily deep.
-   ``TEST`` prefix refers to the test class name, *not* the test name, but ``FIXT`` refers to the fixture name *inside* the referenced test.
+   ``TEST`` prefix refers to the test class name, *not* the test name and ``FIXT`` refers to the fixture *variable name* inside the referenced test, i.e., the test variable to which the fixture is bound.
+   The fixture variable name is referred to as ``'<varname>`` when listing tests with the :option:`-l` and :option:`-L` options.
 
    Multiple variables can be set at the same time by passing this option multiple times.
    This option *cannot* change arbitrary test attributes, but only test variables declared with the :attr:`~reframe.core.pipeline.RegressionMixin.variable` built-in.
@@ -951,24 +960,29 @@ Here is how this test is listed where the various components of the display name
 
 .. code-block:: console
 
-   - TestA %x=4 %l.foo=10 %t.p=2 /1c51609b
-       ^Myfixture %p=1 ~TestA_3 /f027ee75
-       ^MyFixture %p=2 ~TestA_3 /830323a4
-       ^X %foo=10 ~generic:default+builtin /7dae3cc5
-   - TestA %x=3 %l.foo=10 %t.p=2 /707b752c
-       ^MyFixture %p=1 ~TestA_2 /02368516
-       ^MyFixture %p=2 ~TestA_2 /854b99b5
-       ^X %foo=10 ~generic:default+builtin /7dae3cc5
-   - TestA %x=4 %l.foo=10 %t.p=1 /c65657d5
-       ^MyFixture %p=2 ~TestA_1 /f0383f7f
-       ^MyFixture %p=1 ~TestA_1 /d07f4281
-       ^X %foo=10 ~generic:default+builtin /7dae3cc5
-   - TestA %x=3 %l.foo=10 %t.p=1 /1b9f44df
-       ^MyFixture %p=2 ~TestA_0 /b894ab05
-       ^MyFixture %p=1 ~TestA_0 /ca376ca8
-       ^X %foo=10 ~generic:default+builtin /7dae3cc5
+   - TestA %x=4 %l.foo=10 %t.p=2 /8804be5d
+       ^MyFixture %p=1 ~TestA_3 't 'f /f027ee75
+       ^MyFixture %p=2 ~TestA_3 't 'f /830323a4
+       ^X %foo=10 ~generic:default+builtin 'l /7dae3cc5
+   - TestA %x=3 %l.foo=10 %t.p=2 /89f6f5d1
+       ^MyFixture %p=1 ~TestA_2 't 'f /02368516
+       ^MyFixture %p=2 ~TestA_2 't 'f /854b99b5
+       ^X %foo=10 ~generic:default+builtin 'l /7dae3cc5
+   - TestA %x=4 %l.foo=10 %t.p=1 /af9b2941
+       ^MyFixture %p=2 ~TestA_1 't 'f /f0383f7f
+       ^MyFixture %p=1 ~TestA_1 't 'f /d07f4281
+       ^X %foo=10 ~generic:default+builtin 'l /7dae3cc5
+   - TestA %x=3 %l.foo=10 %t.p=1 /a9e50aa3
+       ^MyFixture %p=2 ~TestA_0 't 'f /b894ab05
+       ^MyFixture %p=1 ~TestA_0 't 'f /ca376ca8
+       ^X %foo=10 ~generic:default+builtin 'l /7dae3cc5
    Found 4 check(s)
 
+Notice that the variable name to which every fixture is bound in its parent test is also listed as ``'<varname>``.
+This is useful for setting variables down the fixture hierarchy using the :option:`-S` option.
+
+
+
 Display names may not always be unique.
 Assume the following test:
 

hpctestlib/interactive/jupyter/ipcmagic/src/tf-hvd-sgd-ipc-tf2.ipynb

@@ -25,7 +25,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%ipcluster start -n 2 --mpi"
+    "%ipcluster start -n 2"
    ]
   },
   {
@@ -43,7 +43,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%ipcluster start -n 2 --mpi"
+    "%ipcluster start -n 2"
    ]
   },
   {
@@ -52,7 +52,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%ipcluster start -n 2 --mpi"
+    "%ipcluster start -n 2"
    ]
   },
   {
@@ -61,7 +61,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%ipcluster start -n 2 --mpi"
+    "%ipcluster start -n 2"
    ]
   },
   {
@@ -70,7 +70,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%ipcluster start -n 2 --mpi"
+    "%ipcluster start -n 2"
    ]
   },
   {
@@ -94,6 +94,15 @@
     "print('cluster ids:', c.ids)"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "c.close()"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,

reframe/__init__.py

@@ -1,12 +1,12 @@
-# Copyright 2016-2022 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
+# Copyright 2016-2023 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
 # ReFrame Project Developers. See the top-level LICENSE file for details.
 #
 # SPDX-License-Identifier: BSD-3-Clause
 
 import os
 import sys
 
-VERSION = '4.0.3'
+VERSION = '4.0.4'
 INSTALL_PREFIX = os.path.normpath(
     os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
 )

reframe/core/backends.py

@@ -1,4 +1,4 @@
-# Copyright 2016-2022 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
+# Copyright 2016-2023 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
 # ReFrame Project Developers. See the top-level LICENSE file for details.
 #
 # SPDX-License-Identifier: BSD-3-Clause

reframe/core/buildsystems.py

@@ -1,4 +1,4 @@
-# Copyright 2016-2022 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
+# Copyright 2016-2023 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
 # ReFrame Project Developers. See the top-level LICENSE file for details.
 #
 # SPDX-License-Identifier: BSD-3-Clause

reframe/core/builtins.py

@@ -1,4 +1,4 @@
-# Copyright 2016-2022 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
+# Copyright 2016-2023 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
 # ReFrame Project Developers. See the top-level LICENSE file for details.
 #
 # SPDX-License-Identifier: BSD-3-Clause

reframe/core/config.py

@@ -1,4 +1,4 @@
-# Copyright 2016-2022 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
+# Copyright 2016-2023 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
 # ReFrame Project Developers. See the top-level LICENSE file for details.
 #
 # SPDX-License-Identifier: BSD-3-Clause

reframe/core/containers.py

@@ -1,4 +1,4 @@
-# Copyright 2016-2022 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
+# Copyright 2016-2023 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
 # ReFrame Project Developers. See the top-level LICENSE file for details.
 #
 # SPDX-License-Identifier: BSD-3-Clause