Merge pull request #2514 from rsarm/ci-cli-options

[feat] Add `--mode` option to GitLab CI pipeline command

Author: Vasileios Karakasis

docs/tutorial_tips_tricks.rst

@@ -385,10 +385,12 @@ The following is an example of ``.gitlab-ci.yml`` file that does exactly that:
 It defines two stages.
 The first one, called ``generate``, will call ReFrame to generate the pipeline specification for the desired tests.
 All the usual `test selection options <manpage.html#test-filtering>`__ can be used to select specific tests.
-ReFrame will process them as usual, but instead of running the selected tests, it will generate the correct steps
-for running each test individually as a Gitlab job. We then pass the generated CI pipeline file to second phase as
-an artifact and we are done! If ``image`` keyword is defined in ``.gitlab-ci.yml``, the emitted pipeline will use
-the same image as the one defined in the parent pipeline.
+ReFrame will process them as usual, but instead of running the selected tests, it will generate the correct steps for running each test individually as a Gitlab job in a child pipeline.
+The generated ReFrame command that will run each individual test reuses the :option:`-C`, :option:`-R`, :option:`-v` and :option:`--mode` options passed to the initial invocation of ReFrame that was used to generate the pipeline.
+Users can define CI-specific execution modes in their configuration in order to pass arbitrary options to the ReFrame invocation in the child pipeline.
+
+Finally, we pass the generated CI pipeline file to second phase as an artifact and we are done!
+If ``image`` keyword is defined in ``.gitlab-ci.yml``, the emitted pipeline will use the same image as the one defined in the parent pipeline.
 Besides, each job in the generated pipeline will output a separate junit report which can be used to create GitLab badges.
 
 The following figure shows one part of the automatically generated pipeline for the test graph depicted `above <#fig-deps-complex>`__.

reframe/frontend/ci.py

@@ -11,7 +11,7 @@
 import reframe.core.runtime as runtime
 
 
-def _emit_gitlab_pipeline(testcases):
+def _emit_gitlab_pipeline(testcases, child_pipeline_opts):
     config = runtime.runtime().site_config
 
     # Collect the necessary ReFrame invariants
@@ -44,7 +44,8 @@ def rfm_command(testcase):
             f'--restore-session={restore_files}' if restore_files else '',
             f'--report-junit={testcase.check.unique_name}-report.xml',
             f'{"".join("-" + verbosity)}' if verbosity else '',
-            '-n', f"'^{testcase.check.unique_name}$'", '-r'
+            '-n', f"'^{testcase.check.unique_name}$'", '-r',
+            *child_pipeline_opts
         ])
 
     max_level = 0   # We need the maximum level to generate the stages section
@@ -77,9 +78,10 @@ def rfm_command(testcase):
     return json
 
 
-def emit_pipeline(fp, testcases, backend='gitlab'):
+def emit_pipeline(fp, testcases, child_pipeline_opts=None, backend='gitlab'):
     if backend != 'gitlab':
         raise errors.ReframeError(f'unknown CI backend {backend!r}')
 
-    yaml.dump(_emit_gitlab_pipeline(testcases), stream=fp,
+    child_pipeline_opts = child_pipeline_opts or []
+    yaml.dump(_emit_gitlab_pipeline(testcases, child_pipeline_opts), stream=fp,
               indent=2, sort_keys=False, width=sys.maxsize)

reframe/frontend/cli.py

@@ -1110,7 +1110,11 @@ def _case_failed(t):
             list_checks(testcases, printer)
             printer.info('[Generate CI]')
             with open(options.ci_generate, 'wt') as fp:
-                ci.emit_pipeline(fp, testcases)
+                child_pipeline_opts = []
+                if options.mode:
+                    child_pipeline_opts.append(f'--mode={options.mode}')
+
+                ci.emit_pipeline(fp, testcases, child_pipeline_opts)
 
             printer.info(
                 f'  Gitlab pipeline generated successfully '