Remove sh binding from YAML configuration

- Introduce also some additional basic bindings

Author: vkarak

docs/config_reference.rst

@@ -2316,10 +2316,12 @@ Since the configuration is loaded as a Python module, you can generate parts of
 The YAML configuration on the other hand is more static, although not fully.
 Code generation can still be used with the YAML configuration as it is treated as a Jinja2 template, where ReFrame provides the following bindings:
 
-- ``hostname``: The local host's hostname.
 - ``getenv(<envvar>)``: Retrieve an environment variable.
-- ``sh(<command>)``: Retrieve the standard output of a shell command.
- The command must be successful.
+- ``gid``: The real group id of the ReFrame process.
+- ``group``: The group name of the ReFrame process.
+- ``hostname``: The local host's hostname.
+- ``uid``: The real user id of the ReFrame process.
+- ``user``: The user name of the ReFrame process.
 
 These are two examples of YAML logging configuration that uses one of those bindings:
 
@@ -2339,17 +2341,7 @@ These are two examples of YAML logging configuration that uses one of those bind
  logging:
  - handlers:
  - type: file
- name: reframe-{{ sh("hostname -s") }}.log
- level: debug2
- format: "[%(asctime)s.%(msecs)03d] %(levelname)s: %(check_info)s: %(message)s"
- append: false
-
-.. code-block:: yaml
-
- logging:
- - handlers:
- - type: file
- name: reframe-{{ getenv("USER") }}.log
+ name: reframe-{{ getenv("FOO") }}.log
  level: debug2
  format: "[%(asctime)s.%(msecs)03d] %(levelname)s: %(check_info)s: %(message)s"
  append: false

reframe/core/config.py

@@ -10,22 +10,21 @@
 import importlib
 import io
 import itertools
-import jinja2
 import json
 import jsonschema
 import os
 import re
 import socket
 import yaml
+from jinja2.sandbox import SandboxedEnvironment
 
 import reframe
 import reframe.core.settings as settings
 import reframe.utility as util
 import reframe.utility.jsonext as jsonext
 import reframe.utility.osext as osext
 from reframe.core.environments import normalize_module_list
-from reframe.core.exceptions import (ConfigError, ReframeFatalError,
- SpawnedProcessError)
+from reframe.core.exceptions import ConfigError, ReframeFatalError
 from reframe.core.logging import getlogger
 from reframe.utility import ScopedDict
 
@@ -365,20 +364,19 @@ def load_config_json(self, filename):
  self.update_config(config, filename)
 
  def load_config_yaml(self, filename):
- def _shell(cmd):
- '''Jinja wrapper for executing shell commands'''
- try:
-  completed = osext.run_command(cmd, check=True)
- except (FileNotFoundError, SpawnedProcessError) as err:
-  raise ConfigError('failed to run shell command') from err
- else:
-  return completed.stdout.strip()
+ bindings = {
+ 'getenv': os.getenv,
+ 'gid': os.getgid(),
+ 'group': osext.osgroup(),
+ 'hostname': socket.gethostname(),
+ 'uid': os.getuid(),
+ 'user': osext.osuser(),
+ }
 
  with open(filename) as fp:
- environment = jinja2.Environment()
+ environment = SandboxedEnvironment()
  template = environment.from_string(fp.read())
- yaml_src = template.render(hostname=socket.gethostname(),
- sh=_shell, getenv=os.getenv)
+ yaml_src = template.render(**bindings)
  try:
  config = yaml.safe_load(io.StringIO(yaml_src))
  except Exception as err:

unittests/resources/config/bindings.yaml

@@ -0,0 +1,22 @@
+# Copyright 2016-2025 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
+# ReFrame Project Developers. See the top-level LICENSE file for details.
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+# Config file for testing the YAML bindings
+
+systems:
+- name: testsys
+ hostnames: ['.*']
+ partitions:
+ - name: default
+ scheduler: local
+ launcher: local
+ environs: ['builtin']
+ extras:
+ getenv: {{ getenv("_FOO_") }}
+ gid: {{ gid }}
+ group: {{ group }}
+ hostname: {{ hostname }}
+ uid: {{ uid }}
+ user: {{ user }}

unittests/test_config.py

@@ -511,6 +511,26 @@ def test_system_create(site_config):
  assert system.partitions[0].container_runtime == 'Docker'
 
 
+def test_yaml_bindings(monkeypatch):
+ import os
+ import socket
+ import reframe.utility.osext as osext
+
+ monkeypatch.setenv('_FOO_', 'bar')
+ site_config = config.load_config(
+ 'unittests/resources/config/bindings.yaml'
+ )
+ site_config.select_subconfig('testsys:default')
+ system = System.create(site_config)
+ extras = system.partitions[0].extras
+ assert extras['getenv'] == os.getenv('_FOO_')
+ assert extras['gid'] == os.getgid()
+ assert extras['group'] == osext.osgroup()
+ assert extras['hostname'] == socket.gethostname()
+ assert extras['uid'] == os.getuid()
+ assert extras['user'] == osext.osuser()
+
+
 def test_variables(tmp_path):
  # Test that the old syntax using `variables` instead of `env_vars` still
  # works