Migrating to ReFrame 3¶
ReFrame 3 brings substantial changes in its configuration. The configuration component was completely revised and rewritten from scratch in order to allow much more flexibility in how the framework’s configuration options are handled, as well as to ensure the maintainability of the framework in the future.
At the same time, ReFrame 3 deprecates some common pre-2.20 test syntax in favor of the more modern and intuitive pipeline hooks, as well as renames some regression test attributes.
This guide details the necessary steps in order to easily migrate to ReFrame 3.
Updating Your Site Configuration¶
As described in Configuring ReFrame for Your Site, ReFrame’s configuration file has changed substantially.
However, you can convert any old configuration file using the command line option
$ ./bin/reframe --upgrade-config-file unittests/resources/settings_old_syntax.py:new_config.py Conversion successful! The converted file can be found at 'new_config.py'.
Changed in version 3.4: The old configuration syntax in no longer supported and it will not be automatically converted by the -C option.
Another important change is that default locations for looking up a configuration file has changed (see Configuring ReFrame for Your Site for more details).
That practically means that if you were relying on ReFrame loading your
reframe/settings.py by default, this is no longer true.
You have to move it to any of the default settings locations or set the corresponding command line option or environment variable.
The conversion tool will create a JSON configuration file if the extension of the target file is
Configuration conversion limitations¶
ReFrame does a pretty good job in converting correctly your old configuration files, but there are some limitations:
Your code formatting will be lost. ReFrame will use its own, which is PEP8 compliant nonetheless.
Any comments will be lost.
Any code that was used to dynamically generate configuration parameters will be lost. ReFrame will generate the new configuration based on what was the actual old configuration after any dynamic generation.
The very old logging configuration syntax (prior to ReFrame 2.13) is no more recognized and the configuration conversion tool does not take it into account.
Updating Your Tests¶
ReFrame 3.0 deprecates particular test syntax as well as certain test attributes. Some more esoteric features have also changed which may cause tests that make use of them to break. In this section we summarize all these changes and how to make these tests compatible with ReFrame 3.0
Pipeline methods and hooks¶
ReFrame 2.20 introduced a new powerful mechanism for attaching arbitrary functions hooks at the different pipeline stages.
This mechanism provides an easy way to configure and extend the functionality of a test, eliminating essentially the need to override pipeline stages for this purpose.
ReFrame 3.0 deprecates the old practice of overriding pipeline stage methods in favor of using pipeline hooks and ReFrame 3.4 disables that by default.
In the old syntax, it was quite common to override the
setup() method, in order to configure your test based on the current programming environment or the current system partition.
The following is a typical example of that:
def setup(self, partition, environ, **job_opts): if environ.name == 'gnu': self.build_system.cflags = ['-fopenmp'] elif environ.name == 'intel': self.build_system.cflags = ['-qopenmp'] super().setup(partition, environ, **job_opts)
Alternatively, this example could have been written as follows:
def setup(self, partition, environ, **job_opts): super().setup(partition, environ, **job_opts) if self.current_environ.name == 'gnu': self.build_system.cflags = ['-fopenmp'] elif self.current_environ.name == 'intel': self.build_system.cflags = ['-qopenmp']
This syntax is no longer valid and it will raise a deprecation warning for ReFrame versions >= 3.0 and a reframe syntax error for versions >=3.4. Rewriting this using pipeline hooks is quite straightforward and leads to nicer and more intuitive code:
@run_before('compile') def setflags(self): if self.current_environ.name == 'gnu': self.build_system.cflags = ['-fopenmp'] elif self.current_environ.name == 'intel': self.build_system.cflags = ['-qopenmp']
You could equally attach this function to run after the “setup” phase with
@run_after('setup'), as in the original example, but attaching it to the “compile” phase makes more sense.
However, you can’t attach this function before the “setup” phase, because the
current_environ will not be available and it will be still
Changed in version 3.4: Overriding a pipeline stage method is no longer allowed and a reframe syntax error is raised.
Force override a pipeline method¶
Although pipeline hooks should be able to cover almost all the cases for writing tests in ReFrame, there might be corner cases that you need to override one of the pipeline methods, e.g., because you want to implement a stage differently. In this case, all you have to do is mark your test class as “special”, and ReFrame will not issue any deprecation warning if you override pipeline stage methods:
class MyExtendedTest(rfm.RegressionTest, special=True): def setup(self, partition, environ, **job_opts): # do your custom stuff super().setup(partition, environ, **job_opts)
If you try to override the
setup() method in any of the subclasses of
MyExtendedTest, it will again result in a reframe syntax error, which is a desired behavior since the subclasses should be normal tests.
Getting schedulers and launchers by name¶
The way to get a scheduler or launcher instance by name has changed. Prior to ReFrame 3, this was written as follows:
from reframe.core.launchers.registry import getlauncher class MyTest(rfm.RegressionTest): ... @run_before('run') def setlauncher(self): self.job.launcher = getlauncher('local')()
Now you have to simply replace the import statement with the following:
from reframe.core.backends import getlauncher
Similarly for schedulers, the
reframe.core.schedulers.registry module must be replaced with
postbuild_cmd test attributes are replaced by the
post_run test attributes are replaced by the
Changed in version 3.4: The
post_run attributes have been removed.
Suppressing deprecation warnings¶
Although not recommended, you can suppress any deprecation warning issued by ReFrame by passing the
ReFrame 3.0-dev0 introduced a change in the way that a search path for checks was constructed in the command-line using the
ReFrame 3.0 reverts the behavior of the
-c to its original one (i.e., ReFrame 2.x behavior), in which multiple paths can be specified by passing multiple times the
Overriding completely the check search path can be achieved in ReFrame 3.0 through the
RFM_CHECK_SEARCH_PATH environment variable or the corresponding configuration option.