ExtraTestCaseResult.py

Go to the documentation of this file.

#
# Copyright 2012, MeVis Medical Solutions AG
#
# The user may use this file in accordance with the license agreement provided with
# the Software or, alternatively, in accordance with the terms contained in a
# written agreement between the user and MeVis Medical Solutions AG.
#
# For further information use the contact form at https://www.mevislab.de/contact
#
 
import xml.etree.cElementTree as etree
 
import os
 
# NOTE: The etree has a problem when serializing "newstr" objects,
# so we have to cast all strings that we get from the outside to str()
 
 
class ExtraTestCaseResultFunction:
    INFO = "Info"
    WARNING = "Warning"
    ERROR = "Error"
 
    def __init__(self, xml):
        self._xml = xml
        self._status = 0
        self._xml.set("status", "0")
        self._xml.set("try", "1")
        self._events = etree.SubElement(self._xml, "Events")
 
    def status(self):
        return self._status
 
    def info(self, message, timestamp, file=None, line=None):
        self._addMessage(message, self.INFOINFO, timestamp, file, line)
 
    def warning(self, message, timestamp, file=None, line=None):
        self._addMessage(message, self.WARNINGWARNING, timestamp, file, line)
        if self._status == 0:
            self._status = 1
            self._xml.set("status", "1")
 
    def error(self, message, timestamp, file=None, line=None):
        self._addMessage(message, self.ERRORERROR, timestamp, file, line)
        if self._status < 2:
            self._status = 2
            self._xml.set("status", "2")
 
    def showImage(self, description, filenames, timestamp, file=None, line=None):
        self.showFile(description, filenames, timestamp, file, line, command="ImageShow")
 
    def showFile(self, description, filenames, timestamp, file=None, line=None, command="FileShow"):
        if len(filenames) == 0:
            self.error("No images given!", timestamp)
        else:
            fileList = []
            for filename in filenames:
                if not os.path.isfile(filename):
                    self.error("File (%s) does not exist" % (filename), timestamp, file, line)
                else:
                    hash = Base_getHash(filename)
                    fileList.append("%s|%s" % (hash, filename))
 
            if len(fileList) > 0:
                event = self._addMessage(description, "Command", timestamp, file, line)
                event.attrib["command"] = command
 
                parameters = etree.SubElement(event, "Parameters")
                parameters.text = ",".join(fileList)
 
    def _addMessage(self, message, msgType, timestamp, file=None, line=None):
        assert isinstance(message, str)
        event = etree.SubElement(self._events, "Event")
        event.set("type", str(msgType))
        event.set("timestamp", str(timestamp))
        if file is not None and line is not None:
            event.set("file", str(file))
            event.set("line", str(line))
        etree.SubElement(event, "Message").text = str(message)
        return event
 
 
class ExtraTestCaseResult:
 
    def __init__(
        self,
        testCaseName,
        package,
        author,
        duration,
        maintainer=None,
        file=None,
        line=None,
        comment=None,
        showTestFunctionSortingLiterals=False,
    ):
        assert isinstance(testCaseName, str)
 
        self._status = 0
        self._functions = []
 
        commonAttributes = {"name": str(testCaseName), "type": "FunctionalTestCase"}
 
        self._xml = etree.Element("ExtraTestCaseResult")
 
        information = etree.SubElement(self._xml, "Information")
        testCaseInfo = etree.SubElement(information, "TestCase")
        infoAttributes = {"timeout": "0"}
        infoAttributes.update(commonAttributes)
        for key in infoAttributes:
            testCaseInfo.set(key, infoAttributes[key])
        etree.SubElement(testCaseInfo, "Author").text = str(author)
        etree.SubElement(testCaseInfo, "Package").text = str(package)
        etree.SubElement(testCaseInfo, "Maintainer").text = str(maintainer) if maintainer else ""
        etree.SubElement(testCaseInfo, "Comment").text = str(comment) if comment else ""
        etree.SubElement(testCaseInfo, "File").text = str(file) if file else ""
        etree.SubElement(testCaseInfo, "Line").text = str(line) if line else ""
        etree.SubElement(testCaseInfo, "showTestFunctionSortingLiterals").text = (
            "1" if showTestFunctionSortingLiterals else "0"
        )
 
        self._testFunctions = etree.SubElement(testCaseInfo, "TestFunctions")
 
        result = etree.SubElement(self._xml, "Result")
        self._testCaseResult = etree.SubElement(result, "TestCase")
        resultAttributes = {"retries": "0", "duration": str(duration)}
        resultAttributes.update(commonAttributes)
        for key in resultAttributes:
            self._testCaseResult.set(key, resultAttributes[key])
 
    def createTestFunction(self, name, duration):
        basename = name
        number = len(self._functions) + 1
        if number < 10:
            number = "00" + str(number)
        elif number < 100:
            number = "0" + str(number)
        else:
            number = str(number)
        name = "TEST" + number + "_" + name
        assert isinstance(name, str)
        info = etree.SubElement(self._testFunctions, "Function")
        info.set("name", str(name))
        info.set("basename", str(basename))
        info.set("is_disabled", "False")
        result = etree.SubElement(self._testCaseResult, "Function")
        result.set("name", str(name))
        result.set("duration", str(duration))
        result.set("is_disabled", "False")
        f = ExtraTestCaseResultFunction(result)
        self._functions.append(f)
        return f
 
    def toXML(self):
        for f in self._functions:
            if self._status < f.status():
                self._status = f.status()
        self._testCaseResult.set("status", str(self._status))
        return self._xml
 
 
from .Base import getHash as Base_getHash