Merge branch 'develop' into feat/results-db-enhancements

Author: vkarak

.github/workflows/test-flux.yaml

@@ -28,8 +28,8 @@ jobs:
 
       - name: Install Reframe
         run: |
-          apt-get update && apt-get install -y python3-pip curl
-          /bin/bash ./bootstrap.sh
+          apt-get update && apt-get install -y python3-pip
+          ./bootstrap.sh
           export PATH=$PWD/bin:$PATH
           which reframe
 

.github/workflows/test-schedulers.yaml

@@ -19,6 +19,6 @@ jobs:
     - name: Build Images
       run: |
         docker compose -f .github/pseudo-cluster/docker-compose.yml build
-    - name: Run Unittests with ${{ matrix.scheduler }} sceduler
+    - name: Run Unittests with ${{ matrix.scheduler }} scheduler
       run: |
         BACKEND=${{ matrix.scheduler }} docker compose -f .github/pseudo-cluster/docker-compose.yml up --abort-on-container-exit --exit-code-from frontend

bootstrap.sh

@@ -101,23 +101,16 @@ py_pkg_prefix=external/$(uname -m)
 # Install a fresh pip in the current environment
 pyver=$(python3 -c 'import sys; print(".".join(str(s) for s in sys.version_info[:2]))')
 if [ "$pyver" == "3.6" ]; then
-    get_pip_url="https://bootstrap.pypa.io/pip/3.6/get-pip.py"
+    get_pip="$PWD/tools/python/3.6/get-pip.py"
 elif [ "$pyver" == "3.7" ]; then
-    get_pip_url="https://bootstrap.pypa.io/pip/3.7/get-pip.py"
+    get_pip="$PWD/tools/python/3.7/get-pip.py"
 else
-    get_pip_url="https://bootstrap.pypa.io/get-pip.py"
+    get_pip="$PWD/tools/python/get-pip.py"
 fi
 
-if ! type "curl" > /dev/null 2>&1; then
-    echo -e "could not find \`curl': please install curl and try again"
-    exit 1
-fi
-
-INFO "curl -s $get_pip_url | $python"
-curl -s $get_pip_url | $python
-
-export PATH=$(pwd)/$py_pkg_prefix/usr/bin:$PATH
-export PYTHONPATH=$(pwd)/$py_pkg_prefix:$PYTHONPATH
+$python $get_pip
+export PATH=$PWD/$py_pkg_prefix/usr/bin:$PATH
+export PYTHONPATH=$PWD/$py_pkg_prefix:$PYTHONPATH
 if [ -n "$PYGELF" ]; then
     tmp_requirements=$(mktemp)
     sed -e 's/^#+pygelf%//g' requirements.txt > $tmp_requirements

ci-scripts/dockerfiles/eb-spack-howto.dockerfile

@@ -5,8 +5,8 @@
 
 FROM ghcr.io/reframe-hpc/lmod:8.4.12
 
-ENV _SPACK_VER=0.16
-ENV _EB_VER=4.4.1
+ENV _SPACK_VER=0.22.2
+ENV _EB_VER=4.9.4
 
 
 # Install ReFrame unit test requirements
@@ -19,7 +19,7 @@ RUN useradd -ms /bin/bash rfmuser
 USER rfmuser
 
 # Install Spack
-RUN git clone --branch releases/v${_SPACK_VER} https://github.com/spack/spack ~/spack && \
+RUN git clone --branch v${_SPACK_VER} https://github.com/spack/spack ~/spack && \
     cd ~/spack
 
 RUN pip3 install easybuild==${_EB_VER}

ci-scripts/dockerfiles/reframe-lmod.dockerfile

@@ -7,7 +7,7 @@ FROM ghcr.io/reframe-hpc/lmod:8.4.12
 
 # Install ReFrame unit test requirements
 RUN apt-get -y update && \
-    apt-get -y install gcc git make python3 python3-pip curl
+    apt-get -y install gcc git make python3 python3-pip
 
 # ReFrame user
 RUN useradd -ms /bin/bash rfmuser

ci-scripts/dockerfiles/reframe-lmod77.dockerfile

@@ -7,7 +7,7 @@ FROM ghcr.io/reframe-hpc/lmod:7.7
 
 # Install ReFrame unit test requirements
 RUN apt-get -y update && \
-    apt-get -y install gcc make python3 python3-pip curl
+    apt-get -y install gcc make python3 python3-pip
 
 # ReFrame user
 RUN useradd -ms /bin/bash rfmuser

ci-scripts/dockerfiles/reframe-tmod4.dockerfile

@@ -8,7 +8,7 @@ FROM ghcr.io/reframe-hpc/tmod:4.6.0
 # ReFrame requirements
 RUN \
     apt-get -y update && \
-    apt-get -y install gcc make git python3 python3-pip curl
+    apt-get -y install gcc make git python3 python3-pip
 
 # ReFrame user
 RUN useradd -ms /bin/bash rfmuser

docs/howto.rst

@@ -1162,3 +1162,63 @@ If you use a Python-based configuration file, you can define your custom launche
 .. note::
 
    In versions prior to 4.0, launchers could only be implemented inside the source code tree of ReFrame.
+
+
+.. _custom-loggers:
+
+Implementing a custom log handler
+---------------------------------
+
+.. versionadded:: 4.7
+
+ReFrame allows you to define custom log handlers and attach them to the framework.
+Here's an example implementation of a custom log handler and how it can be used in a Python-based configuration file.
+
+Define a custom log handler class based on :class:`~logging.Handler` which uses a custom logging API:
+
+.. code-block:: python
+
+   import logging
+   import mylogger
+
+   class MyLoggerHandler(logging.Handler):
+       def __init__(self, key):
+           super().__init__()
+           self.key = key
+
+       def emit(self, record):
+           myrecord = {
+               'value': record.check_perf_value,
+           }
+           mylogger.log(self.key, myrecord)
+
+Applying the :func:`@register_log_handler <reframe.core.logging.register_log_handler>` decorator to a function returns an instance of the custom log handler:
+
+.. code-block:: python
+
+   from reframe.core.logging import register_log_handler
+
+   @register_log_handler("mylogger")
+   def _create_mylogger_handler(site_config, config_prefix):
+       key = site_config.get(f'{config_prefix}/key')
+       return MyLoggerHandler(key)
+
+
+Finally, add a handler entry with type matching the registered name for the custom log handler to the site config:
+
+.. code-block:: python
+
+   site_configuration = {
+       'logging': [
+           {
+               'handlers': [
+                   {
+                       'type': 'mylogger',
+                       'key': 'abc',
+                   },
+                   ...
+               ]
+           }
+       ],
+       ...
+   }

reframe/core/decorators.py

@@ -104,7 +104,7 @@ def instantiate_all(self, reset_sysenv=0, external_vars=None):
                     kwargs['reset_sysenv'] = reset_sysenv
                     leaf_tests.append(test(*args, **kwargs))
                 except SkipTestError as e:
-                    getlogger().warning(
+                    getlogger().verbose(
                         f'skipping test {test.__qualname__!r}: {e}'
                     )
                 except Exception:

reframe/core/logging.py

@@ -412,6 +412,20 @@ def stream_handler_kind(handler):
     return logger
 
 
+# Registry for log handler creation functions
+_create_handlers = {}
+
+
+def register_log_handler(name):
+    '''Register the decorated log handler creation function'''
+    def _create_handler_wrapper(fn):
+        _create_handlers[name] = fn
+        return fn
+
+    return _create_handler_wrapper
+
+
+@register_log_handler('file')
 def _create_file_handler(site_config, config_prefix):
     filename = os.path.expandvars(site_config.get(f'{config_prefix}/name'))
     if not filename:
@@ -431,6 +445,7 @@ def _create_file_handler(site_config, config_prefix):
                                                 mode='a+' if append else 'w+')
 
 
+@register_log_handler('filelog')
 def _create_filelog_handler(site_config, config_prefix):
     basedir = os.path.abspath(os.path.join(
         site_config.get('systems/0/prefix'),
@@ -447,6 +462,7 @@ def _create_filelog_handler(site_config, config_prefix):
                             ignore_keys=ignore_keys)
 
 
+@register_log_handler('syslog')
 def _create_syslog_handler(site_config, config_prefix):
     address = site_config.get(f'{config_prefix}/address')
 
@@ -485,6 +501,7 @@ def _create_syslog_handler(site_config, config_prefix):
     return logging.handlers.SysLogHandler(address, facility_type, socket_type)
 
 
+@register_log_handler('stream')
 def _create_stream_handler(site_config, config_prefix):
     stream = site_config.get(f'{config_prefix}/name')
     if stream == 'stdout':
@@ -496,6 +513,7 @@ def _create_stream_handler(site_config, config_prefix):
         raise AssertionError(f'unknown stream: {stream}')
 
 
+@register_log_handler('graylog')
 def _create_graylog_handler(site_config, config_prefix):
     try:
         import pygelf
@@ -528,6 +546,7 @@ def _create_graylog_handler(site_config, config_prefix):
                                   json_default=jsonext.encode)
 
 
+@register_log_handler('httpjson')
 def _create_httpjson_handler(site_config, config_prefix):
     url = site_config.get(f'{config_prefix}/url')
     extras = site_config.get(f'{config_prefix}/extras')
@@ -684,35 +703,18 @@ def _extract_handlers(site_config, handlers_group):
     handlers = []
     for i, handler_config in enumerate(handlers_list):
         handler_type = handler_config['type']
-        if handler_type == 'file':
-            hdlr = _create_file_handler(site_config, f'{handler_prefix}/{i}')
-        elif handler_type == 'filelog':
-            hdlr = _create_filelog_handler(
-                site_config, f'{handler_prefix}/{i}'
-            )
-        elif handler_type == 'syslog':
-            hdlr = _create_syslog_handler(site_config, f'{handler_prefix}/{i}')
-        elif handler_type == 'stream':
-            hdlr = _create_stream_handler(site_config, f'{handler_prefix}/{i}')
-        elif handler_type == 'graylog':
-            hdlr = _create_graylog_handler(
-                site_config, f'{handler_prefix}/{i}'
-            )
-            if hdlr is None:
-                getlogger().warning('could not initialize the '
-                                    'graylog handler; ignoring ...')
-                continue
-        elif handler_type == 'httpjson':
-            hdlr = _create_httpjson_handler(
-                site_config, f'{handler_prefix}/{i}'
-            )
-            if hdlr is None:
-                getlogger().warning('could not initialize the '
-                                    'httpjson handler; ignoring ...')
-                continue
-        else:
-            # Should not enter here
-            raise AssertionError(f'unknown handler type: {handler_type}')
+
+        try:
+            create_handler = _create_handlers[handler_type]
+        except KeyError:
+            raise ConfigError(
+                f'unknown handler type: {handler_type}') from None
+
+        hdlr = create_handler(site_config, f'{handler_prefix}/{i}')
+        if hdlr is None:
+            getlogger().warning('could not initialize the '
+                                f'{handler_type} handler; ignoring ...')
+            continue
 
         level = site_config.get(f'{handler_prefix}/{i}/level')
         fmt = site_config.get(f'{handler_prefix}/{i}/format')