pfunk.tests.test_web_login

View Source

from werkzeug.test import Client

from pfunk.tests import User, Group 
from pfunk.exceptions import LoginFailed
from pfunk.testcase import APITestCase


class TestWebLogin(APITestCase):
    collections = [User, Group]

    def setUp(self) -> None:
        super(TestWebLogin, self).setUp()
        self.group = Group.create(name='Power Users', slug='power-users')
        self.user = User.create(username='test', email='tlasso@example.org', first_name='Ted',
                                last_name='Lasso', _credentials='abc123', account_status='ACTIVE',
                                groups=[self.group])
        self.app = self.project.wsgi_app
        self.c = Client(self.app)

    def test_login(self):
        """ Tests `pfunk.contrib.auth.views.LoginView` to return a JWT """
        res = self.c.post('/user/login/',
                          json={"username": "test", "password": "abc123"})

        # check if response has cookies
        self.assertIsNotNone(res.headers['Set-Cookie'])
        self.assertTrue(res.json['success'])

    def test_wrong_login(self):
        """ Tests `pfunk.contrib.auth.views.LoginView` to return an exception when credentials are wrong """
        res = self.c.post('/user/login/',
                          json={"username": "test", "password": "abc123"})

        self.assertRaises(LoginFailed)

    def test_logout(self):
        """ Tests `pfunk.contrib.auth.views.LogoutView` invalidate token login and remove cookie """
        token, exp = User.api_login("test", "abc123")
        res = self.c.post('/user/logout/', headers={
            "Authorization": token,
            "Content-Type": "application/json"
        })

        self.assertTrue(res.json['success'])

    def test_wrong_logout(self):
        """ Tests `pfunk.contrib.auth.views.LogoutView` to return an exception trying to logout a nonexistent token """
        token = ''
        res = self.c.post('/user/logout/', headers={
            "Authorization": token,
            "Content-Type": "application/json"
        })
        expected = {'success': False, 'data': 'Unauthorized'}
        self.assertDictEqual(expected, res.json)

# class TestWebLogin(pfunk.testcase.APITestCase):

View Source

class TestWebLogin(APITestCase):
    collections = [User, Group]

    def setUp(self) -> None:
        super(TestWebLogin, self).setUp()
        self.group = Group.create(name='Power Users', slug='power-users')
        self.user = User.create(username='test', email='tlasso@example.org', first_name='Ted',
                                last_name='Lasso', _credentials='abc123', account_status='ACTIVE',
                                groups=[self.group])
        self.app = self.project.wsgi_app
        self.c = Client(self.app)

    def test_login(self):
        """ Tests `pfunk.contrib.auth.views.LoginView` to return a JWT """
        res = self.c.post('/user/login/',
                          json={"username": "test", "password": "abc123"})

        # check if response has cookies
        self.assertIsNotNone(res.headers['Set-Cookie'])
        self.assertTrue(res.json['success'])

    def test_wrong_login(self):
        """ Tests `pfunk.contrib.auth.views.LoginView` to return an exception when credentials are wrong """
        res = self.c.post('/user/login/',
                          json={"username": "test", "password": "abc123"})

        self.assertRaises(LoginFailed)

    def test_logout(self):
        """ Tests `pfunk.contrib.auth.views.LogoutView` invalidate token login and remove cookie """
        token, exp = User.api_login("test", "abc123")
        res = self.c.post('/user/logout/', headers={
            "Authorization": token,
            "Content-Type": "application/json"
        })

        self.assertTrue(res.json['success'])

    def test_wrong_logout(self):
        """ Tests `pfunk.contrib.auth.views.LogoutView` to return an exception trying to logout a nonexistent token """
        token = ''
        res = self.c.post('/user/logout/', headers={
            "Authorization": token,
            "Content-Type": "application/json"
        })
        expected = {'success': False, 'data': 'Unauthorized'}
        self.assertDictEqual(expected, res.json)

A class whose instances are single test cases.

By default, the test code itself should be placed in a method named 'runTest'.

If the fixture may be used for many test cases, create as many test methods as are needed. When instantiating such a TestCase subclass, specify in the constructor arguments the name of the test method that the instance is to execute.

Test authors should subclass TestCase for their own tests. Construction and deconstruction of the test's environment ('fixture') can be implemented by overriding the 'setUp' and 'tearDown' methods respectively.

If it is necessary to override the __init__ method, the base class __init__ method must always be called. It is important that subclasses should not change the signature of their __init__ method, since instances of the classes are instantiated automatically by parts of the framework in order to be run.

When subclassing TestCase, you can set these attributes:

failureException: determines which exception will be raised when the instance's assertion methods fail; test methods raising this exception will be deemed to have 'failed' rather than 'errored'.
longMessage: determines whether long messages (including repr of objects used in assert methods) will be printed on failure in addition to any explicit message passed.
maxDiff: sets the maximum length of a diff in failure messages by assert methods using difflib. It is looked up as an instance attribute so can be configured by individual tests if required.

# collections = [<class 'pfunk.contrib.auth.collections.User'>, <class 'pfunk.contrib.auth.collections.Group'>]

# def setUp(self) -> None:

View Source

    def setUp(self) -> None:
        super(TestWebLogin, self).setUp()
        self.group = Group.create(name='Power Users', slug='power-users')
        self.user = User.create(username='test', email='tlasso@example.org', first_name='Ted',
                                last_name='Lasso', _credentials='abc123', account_status='ACTIVE',
                                groups=[self.group])
        self.app = self.project.wsgi_app
        self.c = Client(self.app)

Hook method for setting up the test fixture before exercising it.

# def test_login(self):

View Source

    def test_login(self):
        """ Tests `pfunk.contrib.auth.views.LoginView` to return a JWT """
        res = self.c.post('/user/login/',
                          json={"username": "test", "password": "abc123"})

        # check if response has cookies
        self.assertIsNotNone(res.headers['Set-Cookie'])
        self.assertTrue(res.json['success'])

Tests pfunk.contrib.auth.views.LoginView to return a JWT

# def test_wrong_login(self):

View Source

    def test_wrong_login(self):
        """ Tests `pfunk.contrib.auth.views.LoginView` to return an exception when credentials are wrong """
        res = self.c.post('/user/login/',
                          json={"username": "test", "password": "abc123"})

        self.assertRaises(LoginFailed)

Tests pfunk.contrib.auth.views.LoginView to return an exception when credentials are wrong

# def test_logout(self):

View Source

    def test_logout(self):
        """ Tests `pfunk.contrib.auth.views.LogoutView` invalidate token login and remove cookie """
        token, exp = User.api_login("test", "abc123")
        res = self.c.post('/user/logout/', headers={
            "Authorization": token,
            "Content-Type": "application/json"
        })

        self.assertTrue(res.json['success'])

Tests pfunk.contrib.auth.views.LogoutView invalidate token login and remove cookie

# def test_wrong_logout(self):

View Source

    def test_wrong_logout(self):
        """ Tests `pfunk.contrib.auth.views.LogoutView` to return an exception trying to logout a nonexistent token """
        token = ''
        res = self.c.post('/user/logout/', headers={
            "Authorization": token,
            "Content-Type": "application/json"
        })
        expected = {'success': False, 'data': 'Unauthorized'}
        self.assertDictEqual(expected, res.json)

Tests pfunk.contrib.auth.views.LogoutView to return an exception trying to logout a nonexistent token

Inherited Members

unittest.case.TestCase: TestCase; failureException; longMessage; maxDiff; addTypeEqualityFunc; addCleanup; addClassCleanup; setUpClass; tearDownClass; countTestCases; defaultTestResult; shortDescription; id; subTest; run; doCleanups; doClassCleanups; debug; skipTest; fail; assertFalse; assertTrue; assertRaises; assertWarns; assertLogs; assertEqual; assertNotEqual; assertAlmostEqual; assertNotAlmostEqual; assertSequenceEqual; assertListEqual; assertTupleEqual; assertSetEqual; assertIn; assertNotIn; assertIs; assertIsNot; assertDictEqual; assertDictContainsSubset; assertCountEqual; assertMultiLineEqual; assertLess; assertLessEqual; assertGreater; assertGreaterEqual; assertIsNone; assertIsNotNone; assertIsInstance; assertNotIsInstance; assertRaisesRegex; assertWarnsRegex; assertRegex; assertNotRegex; failUnlessRaises; failIf; assertRaisesRegexp; assertRegexpMatches; assertNotRegexpMatches; failUnlessEqual; assertEquals; failIfEqual; assertNotEquals; failUnlessAlmostEqual; assertAlmostEquals; failIfAlmostEqual; assertNotAlmostEquals; failUnless; assert_
pfunk.testcase.APITestCase: tearDown