Deprecate Python 3.8 and test 3.12

mlx/xunit2rst/__init__.py

@@ -0,0 +1 @@
+__import__('pkg_resources').declare_namespace(__name__)

mlx/xunit2rst/__main__.py

@@ -0,0 +1,5 @@
+""" Entry point of swcc.xunit2rst package """
+from .xunit2rst import main
+
+if __name__ == '__main__':
+    main()

mlx/xunit2rst/__xunit2rst_version__.py

@@ -0,0 +1,16 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '1.6.1.dev12+g8488495'
+__version_tuple__ = version_tuple = (1, 6, 1, 'dev12', 'g8488495')

mlx/xunit2rst/assets/xunit2rst.css

@@ -0,0 +1,21 @@
+.xunit2rst {
+    padding: 2px 5px;
+    letter-spacing: 1px;
+    white-space: nowrap;
+    border-radius: 3px;
+}
+
+.xunit2rst.skip {
+    color: black;
+    background-color: #fed84f;
+}
+
+.xunit2rst.pass {
+    color: black;
+    background-color: #97bd61;
+}
+
+.xunit2rst.fail {
+    color: white;
+    background-color: #ce3e01;
+}

mlx/xunit2rst/xunit2rst.mako

@@ -0,0 +1,164 @@
+<%
+import re
+import textwrap
+import xml.etree.ElementTree as ET
+
+title = "{} Test Report for {}".format(info.type.capitalize(), report_name)
+
+
+def _convert_name(name):
+    """ Itemize given test case name """
+    name = name.split('.')[-1]  # cut off suite name if prepended by a dot
+    name = name.upper()
+    name = re.sub(r'\s*:\s*', '-', name)
+    name = name.replace('&', 'AND')
+    name = re.sub(r'[^\w\s_-]', '', name)
+    name = re.sub(r'\s+', '_', name)
+    return name
+
+
+def generate_body(input_string, indent, error_type=None):
+    ''' Transforms the input string to be part of an item's indented body with word wrapping.
+
+    Args:
+        input_string (str): Raw error message.
+        error_type (str/None): The name of the error class, to be prepended to the error message if not None.
+
+    Returns:
+        str: Indented body, which has been word wrapped to not exceed 120 characters
+    '''
+    complete_string = "{}: {}".format(error_type, input_string) if error_type else input_string
+    wrapped = textwrap.fill(complete_string, width=(119 - len(indent)), break_on_hyphens=False, break_long_words=False)
+    return textwrap.indent(wrapped, indent)
+%>\
+.. role:: xunit2rst-skip
+    :class: xunit2rst skip
+.. role:: xunit2rst-fail
+    :class: xunit2rst fail
+.. role:: xunit2rst-pass
+    :class: xunit2rst pass
+
+.. ${info.header_prefix}${report_name}:
+
+${"=" * len(title)}
+${title}
+${"=" * len(title)}
+
+% if log_file:
+The log file that contains details about the executed test cases can be found `here <${log_file}>`_.
+% endif
+
+.. contents:: `Contents`
+    :depth: 2
+    :local:
+
+
+Test Reports
+============
+<%
+suite_names = set()
+test_idx = 0
+%>
+% for suite_idx, suite in enumerate(test_suites):
+<%
+extra_content_map = indexed_extra_content_map.get(suite_idx, {})
+extra_content_map = {_convert_name(key): value for key, value in extra_content_map.items()}
+%>\
+    % if not itemize_suites:  # create traceable item per testcase element
+        % for test in suite:
+<%
+if len(test):
+    if test.findall('skipped'):
+        test_result = 'Skip'
+        relationship = 'skipped'
+    else:
+        test_result = 'Fail'
+        relationship = 'fails'
+else:
+    test_result = 'Pass'
+    relationship = 'passes'
+if add_links:
+    class_name = test.attrib.get('classname', '')
+    if class_name.startswith(f"{suite.attrib.get('name')}."):
+        suite_name = class_name.split('.')[-1]
+        if suite_name not in suite_names:
+            test_idx = 0
+        suite_names.add(suite_name)
+test_idx += 1
+%>\
+${generate_item(test.attrib['name'], relationship, failure_message, [test], (len(suite_names), test_idx), extra_content_map)}\
+        % endfor
+    % else:  # create traceable item per testsuite element
+<%
+test_result = 'Pass'
+relationship = 'passes'
+# skip testsuite elements that have no testcase element (typically the first testsuite element only)
+if not len(suite):
+    continue
+
+skipped_counter = 0
+for test in suite:
+    if test.findall('failure'):
+        test_result = 'Fail'
+        relationship = 'fails'
+        break
+    if test.findall('skipped'):
+        skipped_counter += 1
+else:
+    if skipped_counter == len(suite):
+        test_result = 'Skip'
+        relationship = 'skipped'
+%>\
+${generate_item(suite.attrib['name'], relationship, failure_message, suite, (0, suite_idx + 1), extra_content_map)}\
+    % endif
+% endfor
+Traceability Matrix
+===================
+
+The below table traces the test report to test cases.
+
+.. item-matrix:: Linking these ${info.type} test reports to ${info.type} test cases
+    :source: REPORT_${prefix}
+    :target: ${prefix}
+    :sourcetitle: ${info.type.capitalize()} test report
+    :targettitle: ${info.type.capitalize()} test specification
+    :type: fails passes skipped
+    :stats:
+    :group: top
+    :nocaptions:
+\
+<%def name="generate_item(element_name, relationship, failure_msg, tests, indexes, extra_content_map)">\
+<%
+test_name_no_prefix = _convert_name(element_name)
+extra_content = extra_content_map.get(test_name_no_prefix, "")
+if test_name_no_prefix.startswith(prefix):
+    test_name = test_name_no_prefix
+else:
+    test_name = prefix + test_name_no_prefix
+%>\
+.. item:: REPORT_${test_name} Test report for ${test_name}
+    :${relationship}: ${test_name}
+% if add_links:
+    :ext_robotframeworklog: ${log_file}:${"s1-" if indexes[0] else ""}s${indexes[0] if indexes[0] else 1}-t${indexes[1]}
+% endif
+
+    Test result: :xunit2rst-${test_result.lower()}:`${test_result}`
+
+<% prepend_literal_block = True %>
+% if failure_msg and relationship != 'passes':
+    % for test in tests:
+        % for failure in test.findall('failure') + test.findall('skipped'):
+            % if prepend_literal_block:
+    ::
+<% prepend_literal_block = False %>
+            % endif
+${generate_body(failure.get('message'), ' ' * 6, error_type=failure.get('type'))}
+
+        % endfor
+    % endfor
+% endif
+% if extra_content:
+${textwrap.indent(extra_content, ' ' * 4)}
+
+% endif
+</%def>\