TestingUtilities Class Reference

Inheritance diagram for TestingUtilities:

Collaboration diagram for TestingUtilities:

Public Member Functions
def	__init__ (self, args, kwargs)
def	setUp (self)
def	diffMatchPatchAssertEqual (self, expected, actual, msg=None)
def	tearDown (self)
def	assertTextEqual (self, goal, results, msg=None, trim_tabs=' ', trim_spaces=' ', trim_plus='+', trim_lines=None, indent="")
def	unidiff_output (self, expected, actual)

Public Attributes
	diffMode

Static Public Attributes
	maxDiff = None
	Set the maximum size of the assertion error message when Unit Test fail.
int	diffMode = 1
	Whether characters diff=0, words diff=1 or lines diff=2 will be used.

Detailed Description

    Holds common features across all Unit Tests.

Definition at line 115 of file testing_utilities.py.

Member Function Documentation

assertTextEqual()

def assertTextEqual	(		self,
			goal,
			results,
			msg = None,
			trim_tabs = '  ',
			trim_spaces = ' ',
			trim_plus = '+',
			trim_lines = None,
			indent = ""
	)

    Remove both input texts indentation and trailing white spaces, then assertEquals() both
    of the inputs.

Definition at line 180 of file testing_utilities.py.

References TestingUtilities.diffMatchPatchAssertEqual().

    def assertTextEqual(self, goal, results, msg=None, trim_tabs='  ', trim_spaces=' ', trim_plus='+', trim_lines=None, indent=""):
        """
            Remove both input texts indentation and trailing white spaces, then assertEquals() both
            of the inputs.
        """
        goal = wrap_text( goal, trim_tabs=trim_tabs, trim_spaces=trim_spaces,
                trim_plus=trim_plus, indent=indent, trim_lines=trim_lines )

        results = wrap_text( results, trim_tabs=trim_tabs, trim_spaces=trim_spaces,
                trim_plus=trim_plus, indent=indent, trim_lines=trim_lines )

        if diff_match_patch:
            self.diffMatchPatchAssertEqual( goal, results, msg=msg )

        else:
            super( TestingUtilities, self ).assertEqual( goal, results, msg )

Here is the call graph for this function:

diffMatchPatchAssertEqual()

def diffMatchPatchAssertEqual	(		self,
			expected,
			actual,
			msg = None
	)

    How to wrap correctly the unit testing diff?
    https://stackoverflow.com/questions/52682351/how-to-wrap-correctly-the-unit-testing-diff

Definition at line 135 of file testing_utilities.py.

References TestingUtilities.diffMode.

Referenced by TestingUtilities.assertTextEqual().

    def diffMatchPatchAssertEqual(self, expected, actual, msg=None):
        """
            How to wrap correctly the unit testing diff?
            https://stackoverflow.com/questions/52682351/how-to-wrap-correctly-the-unit-testing-diff
        """
        # print( '\n\nexpected\n%s' % expected )
        # print( '\n\nactual\n%s' % actual )

        # print( goal.encode( 'ascii' ) )
        # print( results.encode( 'ascii' ) )

        # self.unidiff_output( goal, results )
        if expected != actual:
            diff_match = diffmatchpatch()

            if self.diffMode == 0:
                diffs = diff_match.diff_main(expected, actual)

            else:
                diff_struct = diff_match.diff_linesToWords(expected, actual,
                        re.compile(r'\b| ') if self.diffMode == 1 else re.compile(r'\n|\r\n') )

                lineText1 = diff_struct[0] # .chars1;
                lineText2 = diff_struct[1] # .chars2;
                lineArray = diff_struct[2] # .lineArray;

                diffs = diff_match.diff_main(lineText1, lineText2, False);
                diff_match.diff_charsToLines(diffs, lineArray);
                diff_match.diff_cleanupSemantic(diffs)

            if msg:
                msg += '\n'

            else:
                msg = "The strings does not match...\n"

            self.fail( msg + diff_match.diff_prettyText(diffs) )

Here is the caller graph for this function:

tearDown()

def tearDown

(

self

)

    Called right after each Unit Test finish its execution, to clean up settings values.

Definition at line 173 of file testing_utilities.py.

    def tearDown(self):
        """
            Called right after each Unit Test finish its execution, to clean up settings values.
        """
        LockableType.USE_STRING = True
        super(TestingUtilities, self).tearDown()

unidiff_output()

def unidiff_output	(		self,
			expected,
			actual
	)

    Helper function. Returns a string containing the unified diff of two multiline strings.

    https://stackoverflow.com/questions/845276/how-to-print-the-comparison-of-two-multiline-strings-in-unified-diff-format
    https://stackoverflow.com/questions/15864641/python-difflib-comparing-files
    https://stackoverflow.com/questions/32359402/comparison-of-multi-line-strings-in-python-unit-test

Definition at line 197 of file testing_utilities.py.

    def unidiff_output(self, expected, actual):
        """
            Helper function. Returns a string containing the unified diff of two multiline strings.

            https://stackoverflow.com/questions/845276/how-to-print-the-comparison-of-two-multiline-strings-in-unified-diff-format
            https://stackoverflow.com/questions/15864641/python-difflib-comparing-files
            https://stackoverflow.com/questions/32359402/comparison-of-multi-line-strings-in-python-unit-test
        """
        expected = expected.splitlines( 1 )
        actual = actual.splitlines( 1 )

        # diff = difflib.ndiff( expected, actual )
        if expected != actual:
            diff = difflib.context_diff( expected, actual, fromfile='expected input', tofile='actual output', lineterm='\n' )
            self.fail( '\n' + ''.join( diff ) )

---

The documentation for this class was generated from the following file:

• testing_utilities.py