Coverage for pyEDAA/Reports/Unittesting/JUnit/AntJUnit4.py: 59%

1# ==================================================================================================================== # 

2# _____ ____ _ _ ____ _ # 

3# _ __ _ _| ____| _ \ / \ / \ | _ \ ___ _ __ ___ _ __| |_ ___ # 

4# | '_ \| | | | _| | | | |/ _ \ / _ \ | |_) / _ \ '_ \ / _ \| '__| __/ __| # 

5# | |_) | |_| | |___| |_| / ___ \ / ___ \ _| _ < __/ |_) | (_) | | | |_\__ \ # 

6# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)_| \_\___| .__/ \___/|_| \__|___/ # 

7# |_| |___/ |_| # 

8# ==================================================================================================================== # 

9# Authors: # 

10# Patrick Lehmann # 

11# # 

12# License: # 

13# ==================================================================================================================== # 

14# Copyright 2024-2025 Electronic Design Automation Abstraction (EDA²) # 

15# Copyright 2023-2023 Patrick Lehmann - Bötzingen, Germany # 

16# # 

17# Licensed under the Apache License, Version 2.0 (the "License"); # 

18# you may not use this file except in compliance with the License. # 

19# You may obtain a copy of the License at # 

20# # 

21# http://www.apache.org/licenses/LICENSE-2.0 # 

22# # 

23# Unless required by applicable law or agreed to in writing, software # 

24# distributed under the License is distributed on an "AS IS" BASIS, # 

25# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # 

26# See the License for the specific language governing permissions and # 

27# limitations under the License. # 

28# # 

29# SPDX-License-Identifier: Apache-2.0 # 

30# ==================================================================================================================== # 

31# 

32""" 

33Reader for JUnit unit testing summary files in XML format. 

34""" 

35from pathlib import Path 

36from time import perf_counter_ns 

37from typing import Optional as Nullable, Generator, Tuple, Union, TypeVar, Type, ClassVar 

38 

39from lxml.etree import ElementTree, Element, SubElement, tostring, _Element 

40from pyTooling.Common import firstValue 

41from pyTooling.Decorators import export, InheritDocString 

42 

43from pyEDAA.Reports.Unittesting import UnittestException, TestsuiteKind 

44from pyEDAA.Reports.Unittesting import TestcaseStatus, TestsuiteStatus, IterationScheme 

45from pyEDAA.Reports.Unittesting import TestsuiteSummary as ut_TestsuiteSummary, Testsuite as ut_Testsuite 

46from pyEDAA.Reports.Unittesting.JUnit import Testcase as ju_Testcase, Testclass as ju_Testclass, Testsuite as ju_Testsuite 

47from pyEDAA.Reports.Unittesting.JUnit import TestsuiteSummary as ju_TestsuiteSummary, Document as ju_Document 

48 

49TestsuiteType = TypeVar("TestsuiteType", bound="Testsuite") 

50TestcaseAggregateReturnType = Tuple[int, int, int] 

51TestsuiteAggregateReturnType = Tuple[int, int, int, int, int] 

52 

53 

54@export 

55@InheritDocString(ju_Testcase, merge=True) 

56class Testcase(ju_Testcase): 

57 """ 

58 This is a derived implementation for the Ant + JUnit4 dialect. 

59 """ 

60 

61 

62@export 

63@InheritDocString(ju_Testclass, merge=True) 

64class Testclass(ju_Testclass): 

65 """ 

66 This is a derived implementation for the Ant + JUnit4 dialect. 

67 """ 

68 

69 

70@export 

71@InheritDocString(ju_Testsuite, merge=True) 

72class Testsuite(ju_Testsuite): 

73 """ 

74 This is a derived implementation for the Ant + JUnit4 dialect. 

75 """ 

76 

77 @classmethod 

78 def FromTestsuite(cls, testsuite: ut_Testsuite) -> "Testsuite": 

79 """ 

80 Convert a test suite of the unified test entity data model to the JUnit specific data model's test suite object 

81 adhering to the Ant + JUnit4 dialect. 

82 

83 :param testsuite: Test suite from unified data model. 

84 :return: Test suite from JUnit specific data model (Ant + JUnit4 dialect). 

85 """ 

86 juTestsuite = cls( 

87 testsuite._name, 

88 startTime=testsuite._startTime, 

89 duration=testsuite._totalDuration, 

90 status= testsuite._status, 

91 ) 

92 

93 juTestsuite._tests = testsuite._tests 

94 juTestsuite._skipped = testsuite._skipped 

95 juTestsuite._errored = testsuite._errored 

96 juTestsuite._failed = testsuite._failed 

97 juTestsuite._passed = testsuite._passed 

98 

99 for tc in testsuite.IterateTestcases(): 

100 ts = tc._parent 

101 if ts is None: 

102 raise UnittestException(f"Testcase '{tc._name}' is not part of a hierarchy.") 

103 

104 classname = ts._name 

105 ts = ts._parent 

106 while ts is not None and ts._kind > TestsuiteKind.Logical: 

107 classname = f"{ts._name}.{classname}" 

108 ts = ts._parent 

109 

110 if classname in juTestsuite._testclasses: 

111 juClass = juTestsuite._testclasses[classname] 

112 else: 

113 juClass = Testclass(classname, parent=juTestsuite) 

114 

115 juClass.AddTestcase(Testcase.FromTestcase(tc)) 

116 

117 return juTestsuite 

118 

119 

120@export 

121@InheritDocString(ju_TestsuiteSummary, merge=True) 

122class TestsuiteSummary(ju_TestsuiteSummary): 

123 """ 

124 This is a derived implementation for the Ant + JUnit4 dialect. 

125 """ 

126 

127 @classmethod 

128 def FromTestsuiteSummary(cls, testsuiteSummary: ut_TestsuiteSummary) -> "TestsuiteSummary": 

129 """ 

130 Convert a test suite summary of the unified test entity data model to the JUnit specific data model's test suite 

131 summary object adhering to the Ant + JUnit4 dialect. 

132 

133 :param testsuiteSummary: Test suite summary from unified data model. 

134 :return: Test suite summary from JUnit specific data model (Ant + JUnit4 dialect). 

135 """ 

136 return cls( 

137 testsuiteSummary._name, 

138 startTime=testsuiteSummary._startTime, 

139 duration=testsuiteSummary._totalDuration, 

140 status=testsuiteSummary._status, 

141 testsuites=(ut_Testsuite.FromTestsuite(testsuite) for testsuite in testsuiteSummary._testsuites.values()) 

142 ) 

143 

144 

145@export 

146class Document(ju_Document): 

147 """ 

148 A document reader and writer for the Ant + JUnit4 XML file format. 

149 

150 This class reads, validates and transforms an XML file in the Ant + JUnit4 format into a JUnit data model. It can then 

151 be converted into a unified test entity data model. 

152 

153 In reverse, a JUnit data model instance with the specific Ant + JUnit4 file format can be created from a unified test 

154 entity data model. This data model can be written as XML into a file. 

155 """ 

156 

157 _TESTCASE: ClassVar[Type[Testcase]] = Testcase 

158 _TESTCLASS: ClassVar[Type[Testclass]] = Testclass 

159 _TESTSUITE: ClassVar[Type[Testsuite]] = Testsuite 

160 

161 @classmethod 

162 def FromTestsuiteSummary(cls, xmlReportFile: Path, testsuiteSummary: ut_TestsuiteSummary): 

163 doc = cls(xmlReportFile) 

164 doc._name = testsuiteSummary._name 

165 doc._startTime = testsuiteSummary._startTime 

166 doc._duration = testsuiteSummary._totalDuration 

167 doc._status = testsuiteSummary._status 

168 doc._tests = testsuiteSummary._tests 

169 doc._skipped = testsuiteSummary._skipped 

170 doc._errored = testsuiteSummary._errored 

171 doc._failed = testsuiteSummary._failed 

172 doc._passed = testsuiteSummary._passed 

173 

174 doc.AddTestsuites(Testsuite.FromTestsuite(testsuite) for testsuite in testsuiteSummary._testsuites.values()) 

175 

176 return doc 

177 

178 def Analyze(self) -> None: 

179 """ 

180 Analyze the XML file, parse the content into an XML data structure and validate the data structure using an XML 

181 schema. 

182 

183 .. hint:: 

184 

185 The time spend for analysis will be made available via property :data:`AnalysisDuration`.. 

186 

187 The used XML schema definition is specific to the Ant JUnit4 dialect. 

188 """ 

189 xmlSchemaFile = "Ant-JUnit4.xsd" 

190 self._Analyze(xmlSchemaFile) 

191 

192 def Write(self, path: Nullable[Path] = None, overwrite: bool = False, regenerate: bool = False) -> None: 

193 """ 

194 Write the data model as XML into a file adhering to the Ant + JUnit4 dialect. 

195 

196 :param path: Optional path to the XMl file, if internal path shouldn't be used. 

197 :param overwrite: If true, overwrite an existing file. 

198 :param regenerate: If true, regenerate the XML structure from data model. 

199 :raises UnittestException: If the file cannot be overwritten. 

200 :raises UnittestException: If the internal XML data structure wasn't generated. 

201 :raises UnittestException: If the file cannot be opened or written. 

202 """ 

203 if path is None: 203 ↛ 204line 203 didn't jump to line 204 because the condition on line 203 was never true

204 path = self._path 

205 

206 if not overwrite and path.exists(): 206 ↛ 207line 206 didn't jump to line 207 because the condition on line 206 was never true

207 raise UnittestException(f"JUnit XML file '{path}' can not be overwritten.") \ 

208 from FileExistsError(f"File '{path}' already exists.") 

209 

210 if regenerate: 210 ↛ 213line 210 didn't jump to line 213 because the condition on line 210 was always true

211 self.Generate(overwrite=True) 

212 

213 if self._xmlDocument is None: 213 ↛ 214line 213 didn't jump to line 214 because the condition on line 213 was never true

214 ex = UnittestException(f"Internal XML document tree is empty and needs to be generated before write is possible.") 

215 ex.add_note(f"Call 'JUnitDocument.Generate()' or 'JUnitDocument.Write(..., regenerate=True)'.") 

216 raise ex 

217 

218 try: 

219 with path.open("wb") as file: 

220 file.write(tostring(self._xmlDocument, encoding="utf-8", xml_declaration=True, pretty_print=True)) 

221 except Exception as ex: 

222 raise UnittestException(f"JUnit XML file '{path}' can not be written.") from ex 

223 

224 def Convert(self) -> None: 

225 """ 

226 Convert the parsed and validated XML data structure into a JUnit test entity hierarchy. 

227 

228 This method converts the root element. 

229 

230 .. hint:: 

231 

232 The time spend for model conversion will be made available via property :data:`ModelConversionDuration`. 

233 

234 :raises UnittestException: If XML was not read and parsed before. 

235 """ 

236 if self._xmlDocument is None: 236 ↛ 237line 236 didn't jump to line 237 because the condition on line 236 was never true

237 ex = UnittestException(f"JUnit XML file '{self._path}' needs to be read and analyzed by an XML parser.") 

238 ex.add_note(f"Call 'JUnitDocument.Analyze()' or create the document using 'JUnitDocument(path, parse=True)'.") 

239 raise ex 

240 

241 startConversion = perf_counter_ns() 

242 rootElement: _Element = self._xmlDocument.getroot() 

243 

244 self._name = self._ConvertName(rootElement, optional=True) 

245 self._startTime =self._ConvertTimestamp(rootElement, optional=True) 

246 self._duration = self._ConvertTime(rootElement, optional=True) 

247 

248 # tests = rootElement.getAttribute("tests") 

249 # skipped = rootElement.getAttribute("skipped") 

250 # errors = rootElement.getAttribute("errors") 

251 # failures = rootElement.getAttribute("failures") 

252 # assertions = rootElement.getAttribute("assertions") 

253 

254 ts = Testsuite(self._name, startTime=self._startTime, duration=self._duration, parent=self) 

255 self._ConvertTestsuiteChildren(rootElement, ts) 

256 

257 self.Aggregate() 

258 endConversation = perf_counter_ns() 

259 self._modelConversion = (endConversation - startConversion) / 1e9 

260 

261 def _ConvertTestsuite(self, parent: TestsuiteSummary, testsuitesNode: _Element) -> None: 

262 """ 

263 Convert the XML data structure of a ``<testsuite>`` to a test suite. 

264 

265 This method uses private helper methods provided by the base-class. 

266 

267 :param parent: The test suite summary as a parent element in the test entity hierarchy. 

268 :param testsuitesNode: The current XML element node representing a test suite. 

269 """ 

270 newTestsuite = Testsuite( 

271 self._ConvertName(testsuitesNode, optional=False), 

272 self._ConvertHostname(testsuitesNode, optional=False), 

273 self._ConvertTimestamp(testsuitesNode, optional=False), 

274 self._ConvertTime(testsuitesNode, optional=False), 

275 parent=parent 

276 ) 

277 

278 self._ConvertTestsuiteChildren(testsuitesNode, newTestsuite) 

279 

280 def Generate(self, overwrite: bool = False) -> None: 

281 """ 

282 Generate the internal XML data structure from test suites and test cases. 

283 

284 This method generates the XML root element (``<testsuite>``) and recursively calls other generated methods. 

285 

286 :param overwrite: Overwrite the internal XML data structure. 

287 :raises UnittestException: If overwrite is false and the internal XML data structure is not empty. 

288 """ 

289 if not overwrite and self._xmlDocument is not None: 289 ↛ 290line 289 didn't jump to line 290 because the condition on line 289 was never true

290 raise UnittestException(f"Internal XML document is populated with data.") 

291 

292 if self.TestsuiteCount != 1: 292 ↛ 293line 292 didn't jump to line 293 because the condition on line 292 was never true

293 ex = UnittestException(f"The Ant + JUnit4 format requires exactly one test suite.") 

294 ex.add_note(f"Found {self.TestsuiteCount} test suites.") 

295 raise ex 

296 

297 testsuite = firstValue(self._testsuites) 

298 

299 rootElement = Element("testsuite") 

300 rootElement.attrib["name"] = self._name 

301 if self._startTime is not None: 301 ↛ 303line 301 didn't jump to line 303 because the condition on line 301 was always true

302 rootElement.attrib["timestamp"] = f"{self._startTime.isoformat()}" 

303 if self._duration is not None: 303 ↛ 305line 303 didn't jump to line 305 because the condition on line 303 was always true

304 rootElement.attrib["time"] = f"{self._duration.total_seconds():.6f}" 

305 rootElement.attrib["tests"] = str(self._tests) 

306 rootElement.attrib["failures"] = str(self._failed) 

307 rootElement.attrib["errors"] = str(self._errored) 

308 rootElement.attrib["skipped"] = str(self._skipped) 

309 # if self._assertionCount is not None: 

310 # rootElement.attrib["assertions"] = f"{self._assertionCount}" 

311 if testsuite._hostname is not None: 311 ↛ 312line 311 didn't jump to line 312 because the condition on line 311 was never true

312 rootElement.attrib["hostname"] = testsuite._hostname 

313 

314 self._xmlDocument = ElementTree(rootElement) 

315 

316 for testclass in testsuite._testclasses.values(): 

317 for tc in testclass._testcases.values(): 

318 self._GenerateTestcase(tc, rootElement) 

319 

320 def _GenerateTestcase(self, testcase: Testcase, parentElement: _Element) -> None: 

321 """ 

322 Generate the internal XML data structure for a test case. 

323 

324 This method generates the XML element (``<testcase>``) and recursively calls other generated methods. 

325 

326 :param testcase: The test case to convert to an XML data structures. 

327 :param parentElement: The parent XML data structure element, this data structure part will be added to. 

328 :return: 

329 """ 

330 testcaseElement = SubElement(parentElement, "testcase") 

331 if testcase.Classname is not None: 331 ↛ 333line 331 didn't jump to line 333 because the condition on line 331 was always true

332 testcaseElement.attrib["classname"] = testcase.Classname 

333 testcaseElement.attrib["name"] = testcase._name 

334 if testcase._duration is not None: 334 ↛ 336line 334 didn't jump to line 336 because the condition on line 334 was always true

335 testcaseElement.attrib["time"] = f"{testcase._duration.total_seconds():.6f}" 

336 if testcase._assertionCount is not None: 336 ↛ 337line 336 didn't jump to line 337 because the condition on line 336 was never true

337 testcaseElement.attrib["assertions"] = f"{testcase._assertionCount}" 

338 

339 if testcase._status is TestcaseStatus.Passed: 

340 pass 

341 elif testcase._status is TestcaseStatus.Failed: 341 ↛ 343line 341 didn't jump to line 343 because the condition on line 341 was always true

342 failureElement = SubElement(testcaseElement, "failure") 

343 elif testcase._status is TestcaseStatus.Skipped: 

344 skippedElement = SubElement(testcaseElement, "skipped") 

345 else: 

346 errorElement = SubElement(testcaseElement, "error")