2 files changed, 276 insertions, 0 deletions
diff --git a/sources/pyside2/tests/util/helper/__init__.py b/sources/pyside2/tests/util/helper/__init__.py
new file mode 100644
index 000000000..ff7af6999
--- /dev/null
+++ b/sources/pyside2/tests/util/helper/__init__.py
@@ -0,0 +1,160 @@
+#############################################################################
+##
+## Copyright (C) 2016 The Qt Company Ltd.
+## Contact: https://www.qt.io/licensing/
+##
+## This file is part of the test suite of PySide2.
+##
+## $QT_BEGIN_LICENSE:GPL-EXCEPT$
+## Commercial License Usage
+## Licensees holding valid commercial Qt licenses may use this file in
+## accordance with the commercial license agreement provided with the
+## Software or, alternatively, in accordance with the terms contained in
+## a written agreement between you and The Qt Company. For licensing terms
+## and conditions see https://www.qt.io/terms-conditions. For further
+## information use the contact form at https://www.qt.io/contact-us.
+##
+## GNU General Public License Usage
+## Alternatively, this file may be used under the terms of the GNU
+## General Public License version 3 as published by the Free Software
+## Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+## included in the packaging of this file. Please review the following
+## information to ensure the GNU General Public License requirements will
+## be met: https://www.gnu.org/licenses/gpl-3.0.html.
+##
+## $QT_END_LICENSE$
+##
+#############################################################################
+
+'''Helper classes and functions'''
+
+import os
+import unittest
+
+from random import randint
+
+from PySide2.QtCore import QCoreApplication, QTimer
+
+try:
+    from PySide2.QtWidgets import QApplication
+except ImportError:
+    has_gui = False
+else:
+    has_gui = True
+
+def adjust_filename(filename, orig_mod_filename):
+    dirpath = os.path.dirname(os.path.abspath(orig_mod_filename))
+    return os.path.join(dirpath, filename)
+
+class NoQtGuiError(Exception):
+    def __init__(self):
+        Exception.__init__(self, 'No QtGui found')
+
+class BasicPySlotCase(object):
+    '''Base class that tests python slots and signal emissions.
+
+    Python slots are defined as any callable passed to QObject.connect().
+    '''
+    def setUp(self):
+        self.called = False
+
+    def tearDown(self):
+        try:
+            del self.args
+        except:
+            pass
+
+    def cb(self, *args):
+        '''Simple callback with arbitrary arguments.
+
+        The test function must setup the 'args' attribute with a sequence
+        containing the arguments expected to be received by this slot.
+        Currently only a single connection is supported.
+        '''
+        if tuple(self.args) == args:
+            self.called = True
+        else:
+            raise ValueError('Invalid arguments for callback')
+
+
+_instance = None
+_timed_instance = None
+
+if has_gui:
+    class UsesQApplication(unittest.TestCase):
+        '''Helper class to provide QApplication instances'''
+
+        qapplication = True
+
+        def setUp(self):
+            '''Creates the QApplication instance'''
+
+            # Simple way of making instance a singleton
+            super(UsesQApplication, self).setUp()
+            global _instance
+            if _instance is None:
+                _instance = QApplication([])
+
+            self.app = _instance
+
+        def tearDown(self):
+            '''Deletes the reference owned by self'''
+            del self.app
+            super(UsesQApplication, self).tearDown()
+
+
+    class TimedQApplication(unittest.TestCase):
+        '''Helper class with timed QApplication exec loop'''
+
+        def setUp(self, timeout=100):
+            '''Setups this Application.
+
+            timeout - timeout in milisseconds'''
+            global _timed_instance
+            if _timed_instance is None:
+                _timed_instance = QApplication([])
+
+            self.app = _timed_instance
+            QTimer.singleShot(timeout, self.app.quit)
+
+        def tearDown(self):
+            '''Delete resources'''
+            del self.app
+else:
+    class UsesQApplication(unittest.TestCase):
+        def setUp(self):
+            raise NoQtGuiError()
+    class TimedQapplication(unittest.TestCase):
+        def setUp(self):
+            raise NoQtGuiError()
+
+
+_core_instance = None
+
+class UsesQCoreApplication(unittest.TestCase):
+    '''Helper class for test cases that require an QCoreApplication
+    Just connect or call self.exit_app_cb. When called, will ask
+    self.app to exit.
+    '''
+
+    def setUp(self):
+        '''Set up resources'''
+
+        global _core_instance
+        if _core_instance is None:
+            _core_instance = QCoreApplication([])
+
+        self.app = _core_instance
+
+    def tearDown(self):
+        '''Release resources'''
+        del self.app
+
+    def exit_app_cb(self):
+        '''Quits the application'''
+        self.app.exit(0)
+
+
+def random_string(size=5):
+    '''Generate random string with the given size'''
+    return ''.join(map(chr, [randint(33, 126) for x in range(size)]))
diff --git a/sources/pyside2/tests/util/helper/docmodifier.py b/sources/pyside2/tests/util/helper/docmodifier.py
new file mode 100644
index 000000000..16d3e28ad
--- /dev/null
+++ b/sources/pyside2/tests/util/helper/docmodifier.py
@@ -0,0 +1,116 @@
+#############################################################################
+##
+## Copyright (C) 2016 The Qt Company Ltd.
+## Contact: https://www.qt.io/licensing/
+##
+## This file is part of the test suite of PySide2.
+##
+## $QT_BEGIN_LICENSE:GPL-EXCEPT$
+## Commercial License Usage
+## Licensees holding valid commercial Qt licenses may use this file in
+## accordance with the commercial license agreement provided with the
+## Software or, alternatively, in accordance with the terms contained in
+## a written agreement between you and The Qt Company. For licensing terms
+## and conditions see https://www.qt.io/terms-conditions. For further
+## information use the contact form at https://www.qt.io/contact-us.
+##
+## GNU General Public License Usage
+## Alternatively, this file may be used under the terms of the GNU
+## General Public License version 3 as published by the Free Software
+## Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+## included in the packaging of this file. Please review the following
+## information to ensure the GNU General Public License requirements will
+## be met: https://www.gnu.org/licenses/gpl-3.0.html.
+##
+## $QT_END_LICENSE$
+##
+#############################################################################
+
+'''Helper metaclass do 'decorate' docstrings from base test case classes'''
+
+import types
+
+
+def copy_func(func):
+    '''Helper function to copy a function object (except docstring)'''
+    return types.FunctionType(func.func_code, func.func_globals, func.func_name,
+                              func.func_defaults, func.func_closure)
+
+
+class DocModifier(type):
+    '''Metaclass for modifiying method documentation.
+
+    It allows the managed class to modify the method documentation, adding
+    prefixes and suffixes to a given set of methods.
+
+    For example, you have some unittest.TestCases that run on different set
+    of data. These methods could be written once in a base class and the
+    inheriting class just setup different setUp/tearDown methods with the
+    proper data. To differentiate the methods when using docstrings, you
+    can add a suffix or prefix to the docstring.
+
+    Variables in the implementing class:
+
+    doc_prefix - The prefix to the docstring
+    doc_suffix - The suffix to the docstring
+    doc_filter - The function to filter the methods. If not provided, this
+                 no docstrings are changed.'''
+
+    def __new__(mcs, name, bases, dct):
+
+        # FIXME currently we have to define doc_filter on each subclass
+        filter_function = dct.get('doc_filter')
+        if not filter_function:
+            filter_function = lambda x: False
+
+        for base in bases:
+            for attr in [x for x in base.__dict__ if filter_function(x)]:
+                original = getattr(base, attr)
+
+                if original.__doc__:
+                    copy = copy_func(original)
+                    copy.__doc__ = (dct.get('doc_prefix', '') +
+                                    original.__doc__ +
+                                    dct.get('doc_suffix', ''))
+                    dct[attr] = copy
+
+        return type.__new__(mcs, name, bases, dct)
+
+    def __init__(mcs, name, bases, dct):
+        super(DocModifier, mcs).__init__(name, bases, dct)
+
+
+if __name__ == '__main__':
+
+    # tests
+    class BaseTest(object):
+        __metaclass__ = DocModifier
+
+        def testBase(self):
+            '''base'''
+
+        def testWithoutDoc(self):
+            pass
+
+    class Implementing(BaseTest):
+
+        doc_filter = lambda x: x.startswith('test')
+        doc_prefix = 'prefix'
+        doc_suffix = 'suffix'
+
+    class OnlyPrefix(BaseTest):
+
+        doc_filter = lambda x: x.startswith('test')
+        doc_prefix = 'prefix'
+
+    class OnlySuffix(BaseTest):
+
+        doc_filter = lambda x: x.startswith('test')
+        doc_suffix = 'suffix'
+
+    assert(Implementing.testBase.__doc__ == 'prefixbasesuffix')
+    assert(Implementing.testWithoutDoc.__doc__ == None)
+    assert(OnlySuffix.testBase.__doc__ == 'basesuffix')
+    assert(OnlySuffix.testWithoutDoc.__doc__ == None)
+    assert(OnlyPrefix.testBase.__doc__ == 'prefixbase')
+    assert(OnlyPrefix.testWithoutDoc.__doc__ == None)