Changeset - 877bcf22bf71
Parent rev.
Child rev.
[Not reviewed]
default
0 1 0
Thomas De Schampheleire - 10 years ago 2016-02-10 18:28:42
thomas.de.schampheleire@gmail.com
pytest migration: introduce TestControllerPytest

In order to allow tests to benefit from pytest specific functionality, like
fixtures, they can no longer derive from unittest.TestCase. What's more,
while they can derive from any user-defined class, none of the classes
involved (the test class itself nor any of the base classes) can have an
__init__ method.

Converting all tests from unittest-style to pytest-style in one commit is
not realistic. Hence, a more gradual approach is needed.

Most existing test classes derive from TestController, which in turn derives
from BaseTestCase, which derives from unittest.TestCase. Some test classes
derive directly from BaseTestCase.
Supporting both unittest-style and pytest-style from TestController directly
is not possible: pytest-style _cannot_ and unittest-style _must_ derive from
unittest.TestCase. Thus, in any case, an extra level in the class hierarchy
is needed (TestController deriving from Foo and from unittest.TestCase;
pytest-style test classes would then directly derive from Foo).

The requirement that pytest-style test classes cannot have an __init__
method anywhere in the class hierarchy imposes another restriction that
makes it difficult to support both unittest-style and pytest-style test
classes with one class. Any init code needs to be placed in another method
than __init__ and be called explicitly when the test class is initialized.
For unittest-style test classes this would naturally be done with a
setupClass method, but several test classes already use that. Thus, there
would need to be explicit 'super' calls from the test classes. This is
technically possible but not very nice.

A more transparent approach (from the existing test classes point of view),
implemented by this patch, works as follows:
- the implementation of the existing TestController class is now put under
a new class BaseTestController. To accomodate pytest, the __init__ method
is renamed init.
- contrary to the original TestController, BaseTestController does not
derive from BaseTestCase (and neither from unittest.TestCase). Instead,
the 'new' TestController derives both from BaseTestCase, which is
untouched, and from BaseTestController.
- TestController has an __init__ method that calls the base classes'
__init__ methods and the renamed 'init' method of BaseTestController.
- a new class TestControllerPytest is introduced that derives from
BaseTestController but not from BaseTestCase. It uses a pytest fixture to
automatically call the setup functionality previously provided by
BaseTestCase and also calls 'init' on BaseTestController. This means a
little code duplication but is hard to avoid.

The app setup fixture is scoped on the test method, which means that the app
is recreated for every test (unlike for the unittest-style tests where the
app is created per test class). This has the advantage of detecting current
inter-test dependencies and thus improve the health of our test suite. This
in turn is one step closer to allowing parallel test execution.

The unittest-style assert methods (assertEqual, assertIn, ...) do not exist
for pytest-style tests. To avoid having to change all existing test cases
upfront, provide transitional implementations of these methods. The
conversion of the unittest asserts to the pytest/python asserts can happen
gradually over time.
1 file changed with 47 insertions and 6 deletions:
kallithea/tests/__init__.py
47
6
0 comments (0 inline, 0 general)
kallithea/tests/__init__.py
➞
Show inline comments
 
@@ -15,97 +15,97 @@
 
"""
 
Pylons application test package
 

			




	
	
	
		
 
This package assumes the Pylons environment is already loaded.

			




	
	
	
		
 

			




	
	
	
		
 
This module initializes the application via ``websetup`` (`paster

			




	
	
	
		
 
setup-app`) and provides the base testing objects.

			




	
	
	
		
 

			




	
	
	
		
 
Refer to docs/contributing.rst for details on running the test suite.

			




	
	
	
		
 
"""

			




	
	
	
		
 
import os

			




	
	
	
		
 
import re

			




	
	
	
		
 
import time

			




	
	
	
		
 
import logging

			




	
	
	
		
 
import datetime

			




	
	
	
		
 
import hashlib

			




	
	
	
		
 
import tempfile

			




	
	
	
		
 
from os.path import join as jn

			




	
	
	
		
 

			




	
	
	
		
 
from tempfile import _RandomNameSequence

			




	
	
	
		
 

			




	
	
	
		
 
import pylons

			




	
	
	
		
 
import pylons.test

			




	
	
	
		
 
from pylons import config, url

			




	
	
	
		
 
from pylons.i18n.translation import _get_translator

			




	
	
	
		
 
from pylons.util import ContextObj

			




	
	
	
		
 

			




	
	
	
		
 
from routes.util import URLGenerator

			




	
	
	
		
 
from webtest import TestApp

			




	
	
	
		
 
import pytest

			




	
	
	
		
 

			




	
	
	
		
 
from kallithea.lib.compat import unittest

			




	
	
	
		
 
from kallithea import is_windows

			




	
	
	
		
 
from kallithea.model.db import Notification, User, UserNotification

			




	
	
	
		
 
from kallithea.model.meta import Session

			




	
	
	
		
 
from kallithea.tests.parameterized import parameterized

			




	
	
	
		
 
from kallithea.lib.utils2 import safe_str

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
os.environ['TZ'] = 'UTC'

			




	
	
	
		
 
if not is_windows:

			




	
	
	
		
 
    time.tzset()

			




	
	
	
		
 

			




	
	
	
		
 
log = logging.getLogger(__name__)

			




	
	
	
		
 

			




	
	
	
		
 
skipif = pytest.mark.skipif

			




	
	
	
		
 

			




	
	
	
		
 
__all__ = [

			




	
	
	
		
 
    'skipif', 'parameterized', 'environ', 'url', 'TestController',

			




	
	
	
		
 
    'skipif', 'parameterized', 'environ', 'url', 'TestController', 'TestControllerPytest',

			




	
	
	
		
 
    'ldap_lib_installed', 'pam_lib_installed', 'BaseTestCase', 'init_stack',

			




	
	
	
		
 
    'TESTS_TMP_PATH', 'HG_REPO', 'GIT_REPO', 'NEW_HG_REPO', 'NEW_GIT_REPO',

			




	
	
	
		
 
    'HG_FORK', 'GIT_FORK', 'TEST_USER_ADMIN_LOGIN', 'TEST_USER_ADMIN_PASS',

			




	
	
	
		
 
    'TEST_USER_ADMIN_EMAIL', 'TEST_USER_REGULAR_LOGIN', 'TEST_USER_REGULAR_PASS',

			




	
	
	
		
 
    'TEST_USER_REGULAR_EMAIL', 'TEST_USER_REGULAR2_LOGIN',

			




	
	
	
		
 
    'TEST_USER_REGULAR2_PASS', 'TEST_USER_REGULAR2_EMAIL', 'TEST_HG_REPO',

			




	
	
	
		
 
    'TEST_HG_REPO_CLONE', 'TEST_HG_REPO_PULL', 'TEST_GIT_REPO',

			




	
	
	
		
 
    'TEST_GIT_REPO_CLONE', 'TEST_GIT_REPO_PULL', 'HG_REMOTE_REPO',

			




	
	
	
		
 
    'GIT_REMOTE_REPO', 'SCM_TESTS', 'remove_all_notifications',

			




	
	
	
		
 
]

			




	
	
	
		
 

			




	
	
	
		
 
# Invoke websetup with the current config file

			




	
	
	
		
 
# SetupCommand('setup-app').run([config_file])

			




	
	
	
		
 

			




	
	
	
		
 
environ = {}

			




	
	
	
		
 

			




	
	
	
		
 
#SOME GLOBALS FOR TESTS

			




	
	
	
		
 

			




	
	
	
		
 
TESTS_TMP_PATH = jn('/', 'tmp', 'rc_test_%s' % _RandomNameSequence().next())

			




	
	
	
		
 
TEST_USER_ADMIN_LOGIN = 'test_admin'

			




	
	
	
		
 
TEST_USER_ADMIN_PASS = 'test12'

			




	
	
	
		
 
TEST_USER_ADMIN_EMAIL = 'test_admin@example.com'

			




	
	
	
		
 

			




	
	
	
		
 
TEST_USER_REGULAR_LOGIN = 'test_regular'

			




	
	
	
		
 
TEST_USER_REGULAR_PASS = 'test12'

			




	
	
	
		
 
TEST_USER_REGULAR_EMAIL = 'test_regular@example.com'

			




	
	
	
		
 

			




	
	
	
		
 
TEST_USER_REGULAR2_LOGIN = 'test_regular2'

			




	
	
	
		
 
TEST_USER_REGULAR2_PASS = 'test12'

			




	
	
	
		
 
TEST_USER_REGULAR2_EMAIL = 'test_regular2@example.com'

			




	
	
	
		
 

			




	
	
	
		
 
HG_REPO = u'vcs_test_hg'

			




	
	
	
		
 
GIT_REPO = u'vcs_test_git'

			




	
	
	
		
 

			




	
	
	
		
 
NEW_HG_REPO = u'vcs_test_hg_new'

			




	
	
	
		
 
NEW_GIT_REPO = u'vcs_test_git_new'

			




	
	
	
		
 

			




	
	
	
		
 
HG_FORK = u'vcs_test_hg_fork'

			




	
	
	
		
 
GIT_FORK = u'vcs_test_git_fork'

			




	
	
	
		
 

			




	
	
	
		
 
## VCS

			




	
	
	
		
 
SCM_TESTS = ['hg', 'git']

			




	
	
	
		
 
uniq_suffix = str(int(time.mktime(datetime.datetime.now().timetuple())))

			




	
	
	
		
 

			




	
	
	
		
 
GIT_REMOTE_REPO = 'git://github.com/codeinn/vcs.git'

			




	
	
	
		
 

			




	
	
	
		
 
TEST_GIT_REPO = jn(TESTS_TMP_PATH, GIT_REPO)

			




	
	
	
		
 
TEST_GIT_REPO_CLONE = jn(TESTS_TMP_PATH, 'vcsgitclone%s' % uniq_suffix)

			




	
	
		
 
@@ -125,108 +125,149 @@ TEST_REPO_PREFIX = 'vcs-test'

			




	
	
	
		
 
# comment out to get some other repos from bb or github

			




	
	
	
		
 
GIT_REMOTE_REPO = jn(TESTS_TMP_PATH, GIT_REPO)

			




	
	
	
		
 
HG_REMOTE_REPO = jn(TESTS_TMP_PATH, HG_REPO)

			




	
	
	
		
 

			




	
	
	
		
 
#skip ldap tests if LDAP lib is not installed

			




	
	
	
		
 
ldap_lib_installed = False

			




	
	
	
		
 
try:

			




	
	
	
		
 
    import ldap

			




	
	
	
		
 
    ldap.API_VERSION

			




	
	
	
		
 
    ldap_lib_installed = True

			




	
	
	
		
 
except ImportError:

			




	
	
	
		
 
    # means that python-ldap is not installed

			




	
	
	
		
 
    pass

			




	
	
	
		
 

			




	
	
	
		
 
try:

			




	
	
	
		
 
    import pam

			




	
	
	
		
 
    pam.PAM_TEXT_INFO

			




	
	
	
		
 
    pam_lib_installed = True

			




	
	
	
		
 
except ImportError:

			




	
	
	
		
 
    pam_lib_installed = False

			




	
	
	
		
 

			




	
	
	
		
 
class NullHandler(logging.Handler):

			




	
	
	
		
 
    def emit(self, record):

			




	
	
	
		
 
        pass

			




	
	
	
		
 

			




	
	
	
		
 
def init_stack(config=None):

			




	
	
	
		
 
    if not config:

			




	
	
	
		
 
        config = pylons.test.pylonsapp.config

			




	
	
	
		
 
    url._push_object(URLGenerator(config['routes.map'], environ))

			




	
	
	
		
 
    pylons.app_globals._push_object(config['pylons.app_globals'])

			




	
	
	
		
 
    pylons.config._push_object(config)

			




	
	
	
		
 
    pylons.tmpl_context._push_object(ContextObj())

			




	
	
	
		
 
    # Initialize a translator for tests that utilize i18n

			




	
	
	
		
 
    translator = _get_translator(pylons.config.get('lang'))

			




	
	
	
		
 
    pylons.translator._push_object(translator)

			




	
	
	
		
 
    h = NullHandler()

			




	
	
	
		
 
    logging.getLogger("kallithea").addHandler(h)

			




	
	
	
		
 

			




	
	
	
		
 
def remove_all_notifications():

			




	
	
	
		
 
    Notification.query().delete()

			




	
	
	
		
 

			




	
	
	
		
 
    # Because query().delete() does not (by default) trigger cascades.

			




	
	
	
		
 
    # http://docs.sqlalchemy.org/en/rel_0_7/orm/collections.html#passive-deletes

			




	
	
	
		
 
    UserNotification.query().delete()

			




	
	
	
		
 

			




	
	
	
		
 
    Session().commit()

			




	
	
	
		
 

			




	
	
	
		
 
class BaseTestCase(unittest.TestCase):

			




	
	
	
		
 
    """Unittest-style base test case. Deprecated in favor of pytest style."""

			




	
	
	
		
 

			




	
	
	
		
 
    def __init__(self, *args, **kwargs):

			




	
	
	
		
 
        self.wsgiapp = pylons.test.pylonsapp

			




	
	
	
		
 
        init_stack(self.wsgiapp.config)

			




	
	
	
		
 
        unittest.TestCase.__init__(self, *args, **kwargs)

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
class BaseTestController(object):

			




	
	
	
		
 
    """Base test controller used by pytest and unittest tests controllers."""

			




	
	
	
		
 

			




	
	
	
		
 
class TestController(BaseTestCase):

			




	
	
	
		
 
    # Note: pytest base classes cannot have an __init__ method

			




	
	
	
		
 

			




	
	
	
		
 
    def __init__(self, *args, **kwargs):

			




	
	
	
		
 
        BaseTestCase.__init__(self, *args, **kwargs)

			




	
	
	
		
 
    def init(self):

			




	
	
	
		
 
        self.app = TestApp(self.wsgiapp)

			




	
	
	
		
 
        self.maxDiff = None

			




	
	
	
		
 
        self.index_location = config['app_conf']['index_dir']

			




	
	
	
		
 

			




	
	
	
		
 
    def log_user(self, username=TEST_USER_ADMIN_LOGIN,

			




	
	
	
		
 
                 password=TEST_USER_ADMIN_PASS):

			




	
	
	
		
 
        self._logged_username = username

			




	
	
	
		
 
        response = self.app.post(url(controller='login', action='index'),

			




	
	
	
		
 
                                 {'username': username,

			




	
	
	
		
 
                                  'password': password})

			




	
	
	
		
 

			




	
	
	
		
 
        if 'Invalid username or password' in response.body:

			




	
	
	
		
 
            self.fail('could not login using %s %s' % (username, password))

			




	
	
	
		
 

			




	
	
	
		
 
        self.assertEqual(response.status, '302 Found')

			




	
	
	
		
 
        self.assert_authenticated_user(response, username)

			




	
	
	
		
 

			




	
	
	
		
 
        response = response.follow()

			




	
	
	
		
 
        return response.session['authuser']

			




	
	
	
		
 

			




	
	
	
		
 
    def _get_logged_user(self):

			




	
	
	
		
 
        return User.get_by_username(self._logged_username)

			




	
	
	
		
 

			




	
	
	
		
 
    def assert_authenticated_user(self, response, expected_username):

			




	
	
	
		
 
        cookie = response.session.get('authuser')

			




	
	
	
		
 
        user = cookie and cookie.get('user_id')

			




	
	
	
		
 
        user = user and User.get(user)

			




	
	
	
		
 
        user = user and user.username

			




	
	
	
		
 
        self.assertEqual(user, expected_username)

			




	
	
	
		
 

			




	
	
	
		
 
    def authentication_token(self):

			




	
	
	
		
 
        return self.app.get(url('authentication_token')).body

			




	
	
	
		
 

			




	
	
	
		
 
    def checkSessionFlash(self, response, msg=None, skip=0, _matcher=lambda msg, m: msg in m):

			




	
	
	
		
 
        if 'flash' not in response.session:

			




	
	
	
		
 
            self.fail(safe_str(u'msg `%s` not found - session has no flash:\n%s' % (msg, response)))

			




	
	
	
		
 
        try:

			




	
	
	
		
 
            level, m = response.session['flash'][-1 - skip]

			




	
	
	
		
 
            if _matcher(msg, m):

			




	
	
	
		
 
                return

			




	
	
	
		
 
        except IndexError:

			




	
	
	
		
 
            pass

			




	
	
	
		
 
        self.fail(safe_str(u'msg `%s` not found in session flash (skipping %s): %s' %

			




	
	
	
		
 
                           (msg, skip,

			




	
	
	
		
 
                            ', '.join('`%s`' % m for level, m in response.session['flash']))))

			




	
	
	
		
 

			




	
	
	
		
 
    def checkSessionFlashRegex(self, response, regex, skip=0):

			




	
	
	
		
 
        self.checkSessionFlash(response, regex, skip=skip, _matcher=re.search)

			




	
	
	
		
 

			




	
	
	
		
 
class TestController(BaseTestCase, BaseTestController):

			




	
	
	
		
 
    """Deprecated unittest-style test controller"""

			




	
	
	
		
 

			




	
	
	
		
 
    def __init__(self, *args, **kwargs):

			




	
	
	
		
 
        super(TestController, self).__init__(*args, **kwargs)

			




	
	
	
		
 
        self.init()

			




	
	
	
		
 

			




	
	
	
		
 
class TestControllerPytest(BaseTestController):

			




	
	
	
		
 
    """Pytest-style test controller"""

			




	
	
	
		
 

			




	
	
	
		
 
    # Note: pytest base classes cannot have an __init__ method

			




	
	
	
		
 

			




	
	
	
		
 
    @pytest.fixture(autouse=True)

			




	
	
	
		
 
    def app_fixture(self):

			




	
	
	
		
 
        self.wsgiapp = pylons.test.pylonsapp

			




	
	
	
		
 
        init_stack(self.wsgiapp.config)

			




	
	
	
		
 
        self.init()

			




	
	
	
		
 
        return self.app

			




	
	
	
		
 

			




	
	
	
		
 
    # transitional implementations of unittest.TestCase asserts

			




	
	
	
		
 
    # Users of these should be converted to pytest's single 'assert' call

			




	
	
	
		
 
    def assertEqual(self, first, second, msg=None):

			




	
	
	
		
 
        assert first == second

			




	
	
	
		
 
    def assertNotEqual(self, first, second, msg=None):

			




	
	
	
		
 
        assert first != second

			




	
	
	
		
 
    def assertTrue(self, expr, msg=None):

			




	
	
	
		
 
        assert bool(expr) is True

			




	
	
	
		
 
    def assertFalse(self, expr, msg=None):

			




	
	
	
		
 
        assert bool(expr) is False

			




	
	
	
		
 
    def assertIn(self, first, second, msg=None):

			




	
	
	
		
 
        assert first in second

			




	
	
	
		
 
    def assertNotIn(self, first, second, msg=None):

			




	
	
	
		
 
        assert first not in second

			




	
	
	
		
 
    def assertSetEqual(self, first, second, msg=None):

			




	
	
	
		
 
        assert first == second

			




	
	
	
		
 
    def assertListEqual(self, first, second, msg=None):

			




	
	
	
		
 
        assert first == second

			




	
	
	
		
 
    def assertDictEqual(self, first, second, msg=None):

			




	
	
	
		
 
        assert first == second

			




        

    



    


    



    



      

      





    
    0 comments (0 inline, 0 general)
    





    


  

  







  


    




    








    
        
    
    
        This site is powered by
            Kallithea 0.7.0,
        which is
        © 2010–2025 by various authors & licensed under GPLv3.