/usr/lib/python2.7/dist-packages/dogtail/tc.py is in python-dogtail 0.9.9-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227  | # -*- coding: utf-8 -*-
from __future__ import absolute_import, division, print_function, unicode_literals
from dogtail.config import config
from dogtail.logging import ResultsLogger
"""
Test Case magic
FIXME: This module has not been tested since while. Use it with caution!
(and even better - avoid it and use dogtail.tree)
"""
__author__ = "Ed Rousseau <rousseau@redhat.com>"
class TC(object):  # pragma: no cover
    """
    The Test Case Superclass
    """
    logger = ResultsLogger()
    def __init__(self):
        self.encoding = config.encoding
        # ascii + unicode. 8 bit extended char has been ripped out
        self.supportedtypes = (
            "ascii", "utf-8", "utf-16", "utf-16-be", "utf-16-le", "unicode-escape", "raw-unicode-escape",
            "big5", "gb18030", "eucJP", "eucKR", "shiftJIS")
    # String comparison function
    def compare(self, label, baseline, undertest, encoding=config.encoding):
        """
        Compares 2 strings to see if they are the same. The user may specify
        the encoding to which the two strings are to be normalized for the
        comparison. Default encoding is the default system encoding.
        Normalization to extended 8 bit charactersets is not supported.
        When the origin of either baseline or undertest is a text file whose
        encoding is something other than ASCII, it is necessary to use
        codecs.open() instead of open(), so the file's encoding may be
        specified.
        """
        self.label = label.strip()
        self.baseline = baseline
        self.undertest = undertest
        for string in [self.baseline, self.undertest]:
            try:
                string = str(string, 'utf-8')
            except TypeError:
                pass
        self.encoding = encoding
        # Normalize the encoding type for the comparaison based on
        # self.encoding
        if self.encoding in self.supportedtypes:
            self.baseline = (self.baseline).encode(self.encoding)
            self.undertest = (self.undertest).encode(self.encoding)
            # Compare the strings
            if self.baseline == self.undertest:
                self.result = {self.label: "Passed"}
            else:
                self.result = {self.label: "Failed - " + self.encoding +
                               " strings do not match. " + self.baseline +
                               " expected: Got " + self.undertest}
            # Pass the test result to the ResultsLogger for writing
            TC.logger.log(self.result)
            return self.result
        else:
            # We should probably raise an exception here
            self.result = {
                self.label: "ERROR - " + self.encoding + " is not a supported encoding type"}
            TC.logger.log(self.result)
            return self.result
# String Test Case subclass
class TCString(TC):  # pragma: no cover
    """
    String Test Case Class
    """
    def __init__(self):
        TC.__init__(self)
# TODO: rewrite to Python3 compatible image library
#from PIL import Image, ImageChops, ImageStat
# TODO: rewrite to Python3 compatible image library OR remove
# Image test case subclass
#class TCImage(TC):  # pragma: no cover
#
#    """
#    Image Test Case Class.
#    """
#
#    def compare(self, label, baseline, undertest):
#        for _file in (baseline, undertest):
#            if type(_file) is not str and type(_file) is not str:
#                raise TypeError("Need filenames!")
#        self.label = label.strip()
#        self.baseline = baseline.strip()
#        self.undertest = undertest.strip()
#        diffName = TimeStamp().fileStamp("diff") + ".png"
#        self.diff = os.path.normpath(
#            os.path.sep.join((config.scratchDir, diffName)))
#
#        self.baseImage = Image.open(self.baseline)
#        self.testImage = Image.open(self.undertest)
#        try:
#            if self.baseImage.size != self.testImage.size:
#                self.result = {
#                    self.label: "Failed - images are different sizes"}
#                raise StopIteration
#
#            self.diffImage = ImageChops.difference(self.baseImage,
#                                                   self.testImage)
#            self.diffImage.save(self.diff)
#            result = False
#            for stat in ('stddev', 'mean', 'sum2'):
#                for item in getattr(ImageStat.Stat(self.diffImage), stat):
#                    if item:
#                        self.result = {self.label: "Failed - see %s" %
#                                       self.diff}
#                        raise StopIteration
#                    else:
#                        result = True
#        except StopIteration:
#            result = False
#
#        if result:
#            self.result = {self.label: "Passed"}
#
#        TC.logger.log(self.result)
#        return self.result
class TCNumber(TC):
    """
    Number Comparaison Test Case Class
    """
    def __init__(self):
        TC.__init__(self)
        self.supportedtypes = ("int", "float", "complex", "oct", "hex")
    # Compare 2 numbers by the type provided in the type arg
    def compare(self, label, baseline, undertest, type):
        """
        Compares 2 numbers to see if they are the same. The user may specify
        how to normalize mixed type comparisons via the type argument.
        """
        self.label = label.strip()
        self.baseline = baseline
        self.undertest = undertest
        self.type = type.strip()
        # If we get a valid type, convert to that type and compare
        if self.type in self.supportedtypes:
            # Normalize for comparison
            if self.type == "int":
                self.baseline = int(self.baseline)
                self.undertest = int(self.undertest)
            elif self.type == "float":
                self.baseline = float(self.baseline)
                self.undertest = float(self.undertest)
            else:
                self.baseline = complex(self.baseline)
                self.undertest = complex(self.undertest)
            # compare
            if self.baseline == self.undertest:
                self.result = {self.label: "Passed - numbers are the same"}
            else:
                self.result = {self.label: "Failed - " + str(
                    self.baseline) + " expected: Got " + str(self.undertest)}
            TC.logger.log(self.result)
            return self.result
        else:
            self.result = {
                self.label: "Failed - " + self.type + " is not in list of supported types"}
            TC.logger.log(self.result)
            return self.result
class TCBool(TC):  # pragma: no cover
    def __init__(self):
        pass
    def compare(self, label, _bool):
        """
        If _bool is True, pass.
        If _bool is False, fail.
        """
        if type(_bool) is not bool:
            raise TypeError
        if _bool:
            result = {label: "Passed"}
        else:
            result = {label: "Failed"}
        TC.logger.log(result)
from dogtail.tree import Node
class TCNode(TC):  # pragma: no cover
    def __init__(self):
        pass
    def compare(self, label, baseline, undertest):
        """
        If baseline is None, simply check that undertest is a Node.
        If baseline is a Node, check that it is equal to undertest.
        """
        if baseline is not None and not isinstance(baseline, Node):
            raise TypeError
        if not isinstance(undertest, Node):
            result = {label: "Failed - %s is not a Node" % undertest}
        elif baseline is None:
            result = {label: "Passed - %s is a Node" % undertest}
        elif isinstance(baseline, Node):
            if baseline == undertest:
                result = {label: "Passed - %s == %s" % (baseline, undertest)}
            else:
                result = {label: "Failed - %s != %s" % (baseline, undertest)}
        TC.logger.log(result)
 |