Merge branch 'master' into patch-1

Author: ekouts

docs/config_reference.rst

@@ -323,6 +323,14 @@ System Partition Configuration
    - ``upcrun``: Parallel programs will be launched using the `UPC <https://upc.lbl.gov/>`__ ``upcrun`` command.
    - ``upcxx-run``: Parallel programs will be launched using the `UPC++ <https://bitbucket.org/berkeleylab/upcxx/wiki/Home>`__ ``upcxx-run`` command.
 
+   .. tip::
+
+      .. versionadded:: 4.0.0
+
+        ReFrame also allows you to register your own custom launchers simply by defining them in the configuration.
+        You can follow a small tutorial `here <tutorial_advanced.html#adding-a-custom-launcher-to-a-partition>`__.
+
+
 .. js:attribute:: .systems[].partitions[].access
 
    :required: No
@@ -1180,6 +1188,15 @@ The additional properties for the ``httpjson`` handler are the following:
    A set of optional key/value pairs to be passed with each log record to the server.
    These may depend on the server configuration.
 
+.. js:attribute:: .logging[].handlers[].ignore_keys
+
+.. object:: .logging[].handlers_perflog[].ignore_keys
+
+   :required: No
+   :default: ``[]``
+
+   These keys will be excluded from the log record that will be sent to the server.
+
 
 The ``httpjson`` handler sends log messages in JSON format using an HTTP POST request to the specified URL.
 
@@ -1194,7 +1211,8 @@ An example configuration of this handler for performance logging is shown here:
        'extras': {
            'facility': 'reframe',
            'data-version': '1.0'
-       }
+       },
+       'ignore_keys': ['check_perfvalues']
    }
 
 

docs/tutorial_advanced.rst

@@ -576,8 +576,6 @@ The trick here is to replace the parallel launcher with the local one, which pra
 The :func:`~reframe.core.backends.getlauncher` function takes the `registered <config_reference.html#systems-.partitions-.launcher>`__ name of a launcher and returns the class that implements it.
 You then instantiate the launcher and assign to the :attr:`~reframe.core.schedulers.Job.launcher` attribute of the job descriptor.
 
-An alternative to this approach would be to define your own custom parallel launcher and register it with the framework.
-You could then use it as the scheduler of a system partition in the configuration, but this approach is less test-specific.
 
 Adding more parallel launch commands
 ====================================
@@ -628,6 +626,65 @@ Let's see how the generated job script looks like:
 The first three ``srun`` commands are emitted through the :attr:`prerun_cmds` whereas the last one comes from the test's :attr:`executable` attribute.
 
 
+Adding a custom launcher to a partition
+=======================================
+
+.. versionadded:: 4.0.0
+
+An alternative to the approaches above would be to define your own custom parallel launcher and register it with the framework.
+You could then use it as the launcher of a system partition in the configuration and use it in multiple tests.
+
+Each `launcher <regression_test_api.html#reframe.core.launchers.JobLauncher>`__ needs to implement the :func:`~reframe.core.launchers.JobLauncher.command` method and can optionally change the default :func:`~reframe.core.launchers.JobLauncher.run_command` method.
+
+As an example of how easy it is to define a new parallel launcher backend, here is the actual implementation of the ``mpirun`` launcher:
+
+.. code:: python
+
+    from reframe.core.backends import register_launcher
+    from reframe.core.launchers import JobLauncher
+
+
+    @register_launcher('mpirun')
+    class MpirunLauncher(JobLauncher):
+        def command(self, job):
+            return ['mpirun', '-np', str(job.num_tasks)]
+
+
+The :func:`~reframe.core.launchers.JobLauncher.command` returns a list of command tokens that will be combined with any user-supplied `options <regression_test_api.html#reframe.core.launchers.JobLauncher.options>`__ by the :func:`~reframe.core.launchers.JobLauncher.run_command` method to generate the actual launcher command line.
+Notice you can use the ``job`` argument to get job-specific information that will allow you to construct the correct launcher invocation.
+
+If you use a Python-based configuration file, you can define your custom launcher directly inside your config as follows:
+
+.. code:: python
+
+   from reframe.core.backends import register_launcher
+   from reframe.core.launchers import JobLaucher
+
+
+   @register_launcher('slrun')
+   class MySmartLauncher(JobLauncher):
+       def command(self, job):
+           return ['slrun', ...]
+
+   site_configuration = {
+       'systems': [
+           {
+               'name': 'my_system',
+               'partitions': [
+                   {
+                       'name': 'my_partition',
+                       'launcher': 'slrun'
+                       ...
+                   }
+               ],
+               ...
+           },
+           ...
+       ],
+       ...
+   }
+
+
 Flexible Regression Tests
 -------------------------
 

reframe/core/launchers/__init__.py

@@ -15,11 +15,11 @@ class JobLauncher(abc.ABC):
     A job launcher is the executable that actually launches a distributed
     program to multiple nodes, e.g., ``mpirun``, ``srun`` etc.
 
-    .. warning::
-
-       Users may not create job launchers directly.
 
     .. note::
+       .. versionchanged:: 4.0.0
+          Users may create job launchers directly.
+
        .. versionchanged:: 2.8
           Job launchers do not get a reference to a job during their
           initialization.

reframe/core/logging.py

@@ -371,7 +371,8 @@ def _create_httpjson_handler(site_config, config_prefix):
         return None
 
     extras = site_config.get(f'{config_prefix}/extras')
-    return HTTPJSONHandler(url, extras)
+    ignore_keys = site_config.get(f'{config_prefix}/ignore_keys')
+    return HTTPJSONHandler(url, extras, ignore_keys)
 
 
 class HTTPJSONHandler(logging.Handler):
@@ -386,20 +387,25 @@ class HTTPJSONHandler(logging.Handler):
         'stack_info', 'thread', 'threadName', 'exc_text'
     }
 
-    def __init__(self, url, extras=None):
+    def __init__(self, url, extras=None, ignore_keys=None):
         super().__init__()
         self._url = url
         self._extras = extras
+        self._ignore_keys = ignore_keys
 
     def _record_to_json(self, record):
+        def _can_send(key):
+            return not (
+                key.startswith('_') or key in HTTPJSONHandler.LOG_ATTRS
+                or (self._ignore_keys and key in self._ignore_keys)
+            )
+
         json_record = {
-            k: v for k, v in record.__dict__.items()
-            if not (k.startswith('_') or k in HTTPJSONHandler.LOG_ATTRS)
+            k: v for k, v in record.__dict__.items() if _can_send(k)
         }
         if self._extras:
             json_record.update({
-                k: v for k, v in self._extras.items()
-                if not (k.startswith('_') or k in HTTPJSONHandler.LOG_ATTRS)
+                k: v for k, v in self._extras.items() if _can_send(k)
             })
 
         return _xfmt(json_record).encode('utf-8')

reframe/frontend/cli.py

@@ -600,7 +600,7 @@ def main():
         envvar='RFM_IGNORE_REQNODENOTAVAIL',
         configvar='schedulers/ignore_reqnodenotavail',
         action='store_true',
-        help='Graylog server address'
+        help='Ignore ReqNodeNotAvail Slurm error'
     )
     argparser.add_argument(
         dest='dump_pipeline_progress',

reframe/schemas/config.json

@@ -146,7 +146,11 @@
                 {
                     "properties": {
                         "url": {"type": "string"},
-                        "extras": {"type": "object"}
+                        "extras": {"type": "object"},
+                        "ignore_keys": {
+                            "type": "array",
+                            "items": {"type": "string"}
+                        }
                     },
                     "required": ["url"]
                 }
@@ -251,12 +255,7 @@
                                     ]
                                 },
                                 "launcher": {
-                                    "type": "string",
-                                    "enum": [
-                                        "alps",  "ibrun", "local", "mpirun",
-                                        "mpiexec", "srun", "srunalloc", "ssh",
-                                        "upcrun", "upcxx-run", "lrun", "lrun-gpu"
-                                    ]
+                                    "type": "string"
                                 },
                                 "access": {
                                     "type": "array",
@@ -551,6 +550,7 @@
         "logging/handlers*/filelog_basedir": "./perflogs",
         "logging/handlers*/graylog_extras": {},
         "logging/handlers*/httpjson_extras": {},
+        "logging/handlers*/httpjson_ignore_keys": [],
         "logging/handlers*/stream_name": "stdout",
         "logging/handlers*/syslog_socktype": "udp",
         "logging/handlers*/syslog_facility": "user",