|
| 1 | +from typing import Dict, Optional, Union |
| 2 | + |
| 3 | +import robot.result |
| 4 | +from robot.api import ExecutionResult, ResultVisitor |
| 5 | + |
| 6 | +from strictdoc.backend.sdoc.document_reference import DocumentReference |
| 7 | +from strictdoc.backend.sdoc.models.document import SDocDocument |
| 8 | +from strictdoc.backend.sdoc.models.document_grammar import DocumentGrammar |
| 9 | +from strictdoc.backend.sdoc.models.node import SDocNode, SDocNodeField |
| 10 | +from strictdoc.backend.sdoc.models.reference import FileReference |
| 11 | +from strictdoc.backend.sdoc.models.section import SDocSection |
| 12 | +from strictdoc.backend.sdoc.models.type_system import FileEntry, FileEntryFormat |
| 13 | +from strictdoc.core.file_tree import File |
| 14 | +from strictdoc.core.project_config import ProjectConfig |
| 15 | +from strictdoc.helpers.paths import path_to_posix_path |
| 16 | + |
| 17 | + |
| 18 | +class SdocVisitor(ResultVisitor): |
| 19 | + def __init__(self, project_config: ProjectConfig): |
| 20 | + self.project_config = project_config |
| 21 | + self.suites: Dict[str, Union[SDocDocument, SDocSection]] = {} |
| 22 | + self.document: Optional[SDocDocument] = None |
| 23 | + |
| 24 | + def visit_suite(self, suite: robot.result.TestSuite) -> None: |
| 25 | + """Create document for top level suite and sections for nested suites.""" |
| 26 | + assert suite.full_name not in self.suites |
| 27 | + |
| 28 | + if suite.parent is None: |
| 29 | + self.document = SDocDocument( |
| 30 | + mid=None, |
| 31 | + title=f"Test report: {suite.name}", |
| 32 | + config=None, |
| 33 | + view=None, |
| 34 | + grammar=None, |
| 35 | + section_contents=[], |
| 36 | + ) |
| 37 | + self.document.ng_including_document_reference = DocumentReference() |
| 38 | + grammar = DocumentGrammar.create_for_test_report(self.document) |
| 39 | + self.document.grammar = grammar |
| 40 | + self.document.config.requirement_style = "Table" |
| 41 | + self.suites[suite.full_name] = self.document |
| 42 | + summary = self.summary_from_suite(suite, self.document) |
| 43 | + self.document.section_contents.append(summary) |
| 44 | + else: |
| 45 | + assert self.document |
| 46 | + assert suite.parent.full_name in self.suites, ( |
| 47 | + "depth-first traversal expected" |
| 48 | + ) |
| 49 | + parent_sdoc_node = self.suites[suite.parent.full_name] |
| 50 | + section = SDocSection( |
| 51 | + parent=parent_sdoc_node, |
| 52 | + mid=None, |
| 53 | + uid=None, |
| 54 | + custom_level=None, |
| 55 | + title=suite.name, |
| 56 | + requirement_prefix=None, |
| 57 | + section_contents=[], |
| 58 | + ) |
| 59 | + section.ng_including_document_reference = DocumentReference() |
| 60 | + section.ng_document_reference = DocumentReference() |
| 61 | + section.ng_document_reference.set_document(self.document) |
| 62 | + self.suites[suite.full_name] = section |
| 63 | + parent_sdoc_node.section_contents.append(section) |
| 64 | + summary_sdoc_node = self.summary_from_suite(suite, section) |
| 65 | + section.section_contents.append(summary_sdoc_node) |
| 66 | + |
| 67 | + super().visit_suite(suite) |
| 68 | + |
| 69 | + def visit_test(self, test: robot.result.TestCase) -> None: |
| 70 | + """Create TEST_RESULT node for each test case.""" |
| 71 | + assert self.document |
| 72 | + assert test.parent and test.parent.full_name in self.suites, ( |
| 73 | + "depth-first traversal expected" |
| 74 | + ) |
| 75 | + parent_section = self.suites[test.parent.full_name] |
| 76 | + testcase_node = SDocNode( |
| 77 | + parent=parent_section, |
| 78 | + node_type="TEST_RESULT", |
| 79 | + fields=[], |
| 80 | + relations=[], |
| 81 | + ) |
| 82 | + testcase_node.ng_document_reference = DocumentReference() |
| 83 | + testcase_node.ng_document_reference.set_document(self.document) |
| 84 | + testcase_node.ng_including_document_reference = DocumentReference() |
| 85 | + |
| 86 | + # Only executed tests will become traceable. |
| 87 | + if not test.skipped: |
| 88 | + testcase_node.set_field_value( |
| 89 | + field_name="UID", |
| 90 | + form_field_index=0, |
| 91 | + value=SDocNodeField( |
| 92 | + parent=testcase_node, |
| 93 | + field_name="UID", |
| 94 | + parts=[test.full_name.upper()], |
| 95 | + multiline__=None, |
| 96 | + ), |
| 97 | + ) |
| 98 | + |
| 99 | + # Absolute path will be replaced with relative path to strictdoc root |
| 100 | + # in FileTraceabilityIndex. |
| 101 | + abs_path_on_exec_machine = path_to_posix_path(str(test.source)) |
| 102 | + if test.source is not None: |
| 103 | + testcase_node.set_field_value( |
| 104 | + field_name="TEST_PATH", |
| 105 | + form_field_index=0, |
| 106 | + value=SDocNodeField( |
| 107 | + parent=testcase_node, |
| 108 | + field_name="TEST_PATH", |
| 109 | + parts=[abs_path_on_exec_machine], |
| 110 | + multiline__=None, |
| 111 | + ), |
| 112 | + ) |
| 113 | + |
| 114 | + testcase_node.set_field_value( |
| 115 | + field_name="TEST_FUNCTION", |
| 116 | + form_field_index=0, |
| 117 | + value=SDocNodeField( |
| 118 | + parent=testcase_node, |
| 119 | + field_name="TEST_FUNCTION", |
| 120 | + parts=[test.name], |
| 121 | + multiline__=None, |
| 122 | + ), |
| 123 | + ) |
| 124 | + |
| 125 | + testcase_node.set_field_value( |
| 126 | + field_name="DURATION", |
| 127 | + form_field_index=0, |
| 128 | + value=SDocNodeField( |
| 129 | + parent=testcase_node, |
| 130 | + field_name="DURATION", |
| 131 | + parts=[str(test.elapsed_time.total_seconds())], |
| 132 | + multiline__=None, |
| 133 | + ), |
| 134 | + ) |
| 135 | + |
| 136 | + testcase_node.set_field_value( |
| 137 | + field_name="STATUS", |
| 138 | + form_field_index=0, |
| 139 | + value=SDocNodeField( |
| 140 | + parent=testcase_node, |
| 141 | + field_name="STATUS", |
| 142 | + parts=[test.status], |
| 143 | + multiline__=None, |
| 144 | + ), |
| 145 | + ) |
| 146 | + |
| 147 | + testcase_node.set_field_value( |
| 148 | + field_name="TITLE", |
| 149 | + form_field_index=0, |
| 150 | + value=SDocNodeField( |
| 151 | + parent=testcase_node, |
| 152 | + field_name="TITLE", |
| 153 | + parts=[test.name], |
| 154 | + multiline__=None, |
| 155 | + ), |
| 156 | + ) |
| 157 | + |
| 158 | + if not test.skipped: |
| 159 | + # File path will be resolved in FileTraceabilityIndex. |
| 160 | + testcase_node.relations.append( |
| 161 | + FileReference( |
| 162 | + parent=testcase_node, |
| 163 | + g_file_entry=FileEntry( |
| 164 | + parent=None, |
| 165 | + g_file_format=FileEntryFormat.SOURCECODE, |
| 166 | + g_file_path="#FORWARD#", |
| 167 | + g_line_range=None, |
| 168 | + function=test.name, |
| 169 | + clazz=None, |
| 170 | + ), |
| 171 | + ) |
| 172 | + ) |
| 173 | + |
| 174 | + parent_section.section_contents.append(testcase_node) |
| 175 | + |
| 176 | + def summary_from_suite( |
| 177 | + self, |
| 178 | + suite: robot.result.TestSuite, |
| 179 | + parent: Union[SDocDocument, SDocSection], |
| 180 | + ) -> SDocNode: |
| 181 | + assert self.document |
| 182 | + summary_table = f"""\ |
| 183 | +.. list-table:: Test suite summary |
| 184 | + :widths: 25 10 |
| 185 | + :header-rows: 0 |
| 186 | +
|
| 187 | + * - **Number of tests:** |
| 188 | + - {suite.statistics.total} |
| 189 | + * - **Number of successful tests:** |
| 190 | + - {suite.statistics.passed} |
| 191 | + * - **Number of failed tests:** |
| 192 | + - {suite.statistics.failed} |
| 193 | + * - **Number of skipped tests:** |
| 194 | + - {suite.statistics.skipped} |
| 195 | +""" |
| 196 | + summary_node = SDocNode( |
| 197 | + parent=parent, |
| 198 | + node_type="TEXT", |
| 199 | + fields=[], |
| 200 | + relations=[], |
| 201 | + ) |
| 202 | + summary_node.ng_document_reference = DocumentReference() |
| 203 | + summary_node.ng_document_reference.set_document(self.document) |
| 204 | + summary_node.ng_including_document_reference = DocumentReference() |
| 205 | + summary_node.set_field_value( |
| 206 | + field_name="STATEMENT", |
| 207 | + form_field_index=0, |
| 208 | + value=SDocNodeField( |
| 209 | + parent=summary_node, |
| 210 | + field_name="STATEMENT", |
| 211 | + parts=[summary_table], |
| 212 | + multiline__="True", |
| 213 | + ), |
| 214 | + ) |
| 215 | + return summary_node |
| 216 | + |
| 217 | + |
| 218 | +class RobotOutputXMLReader: |
| 219 | + @classmethod |
| 220 | + def read_from_file( |
| 221 | + cls: "RobotOutputXMLReader", |
| 222 | + doc_file: File, |
| 223 | + project_config: ProjectConfig, |
| 224 | + ) -> SDocDocument: |
| 225 | + execution_result = ExecutionResult(doc_file.get_full_path()) |
| 226 | + sdoc_visitor = SdocVisitor(project_config) |
| 227 | + execution_result.visit(sdoc_visitor) |
| 228 | + if sdoc_visitor.document is None: |
| 229 | + raise RuntimeError( |
| 230 | + f"No test suite could be parsed from {doc_file.get_full_path()}" |
| 231 | + ) |
| 232 | + return sdoc_visitor.document |
0 commit comments