Merge pull request #3307 from vkarak/enhancement/table-format

[enhancement] Update `--table-format` arguments

Author: vkarak

docs/manpage.rst

@@ -1163,19 +1163,15 @@ Miscellaneous options
 
    This option can also be set using the :envvar:`RFM_SYSTEM` environment variable.
 
-.. option:: --table-format=csv|plain|outline|grid
+.. option:: --table-format=csv|plain|pretty
 
    Set the formatting of tabular output printed by the options :option:`--performance-compare`, :option:`--performance-report` and the options controlling the stored sessions.
 
    The acceptable values are the following:
 
    - ``csv``: Generate CSV output
-   - ``grid``: Generate a table with grid lines
-   - ``outline``: (default) Generate a table with lines outlining the table and the header
-   - ``plain``: Generate a plain table without any lines
-
-   Note that the default ``outline`` format will not render correctly multi-line cells.
-   In this cases, prefer the ``grid`` or ``plain`` formats.
+   - ``plain``: Generate a plain table without any vertical lines allowing for easy ``grep``-ing
+   - ``pretty``: (default) Generate a pretty table
 
    .. versionadded:: 4.7
 

docs/tutorial.rst

@@ -655,7 +655,7 @@ def main():
         envvar='RFM_SYSTEM'
     )
     misc_options.add_argument(
-        '--table-format', choices=['csv', 'plain', 'outline', 'grid'],
+        '--table-format', choices=['csv', 'pretty', 'plain'],
         help='Table formatting',
         envvar='RFM_TABLE_FORMAT', configvar='general/table_format'
     )

reframe/frontend/cli.py

@@ -276,10 +276,8 @@ def table(self, data, **kwargs):
 
         # Map our options to tabulate
         if table_format == 'plain':
-            tablefmt = 'plain'
-        elif table_format == 'outline':
-            tablefmt = 'mixed_outline'
-        elif table_format == 'grid':
+            tablefmt = 'simple'
+        elif table_format == 'pretty':
             tablefmt = 'mixed_grid'
         else:
             raise ValueError(f'invalid table format: {table_format}')

reframe/frontend/printer.py

@@ -606,9 +606,12 @@ def _group_testcases(testcases, groups, columns):
 
 @time_function
 def _aggregate_perf(grouped_testcases, aggr_fn, cols):
-    if runtime().get_option('general/0/table_format') == 'csv':
-        # Use a csv friendly delimiter
+    # Update delimiter for joining unique values based on the table format
+    table_foramt = runtime().get_option('general/0/table_format')
+    if table_foramt == 'csv':
         delim = '|'
+    elif table_foramt == 'plain':
+        delim = ','
     else:
         delim = '\n'
 

reframe/frontend/reporting/__init__.py

@@ -599,7 +599,7 @@
         "general/report_junit": null,
         "general/resolve_module_conflicts": true,
         "general/save_log_files": false,
-        "general/table_format": "outline",
+        "general/table_format": "pretty",
         "general/target_systems": ["*"],
         "general/timestamp_dirs": "%Y%m%dT%H%M%S%z",
         "general/trap_job_errors": false,

reframe/schemas/config.json

@@ -1257,7 +1257,7 @@ def test_testlib_inherit_fixture_in_different_files(run_reframe):
     assert 'FAILED' not in stdout
 
 
-@pytest.fixture(params=['csv', 'plain', 'grid', 'outline'])
+@pytest.fixture(params=['csv', 'plain', 'pretty'])
 def table_format(request):
     return request.param