pfunk.testcase

View Source 
import unittest

import uuid
import os

from valley.utils import import_util
from werkzeug.test import Client
from pfunk import Project
from pfunk.client import FaunaClient, q
from pfunk.template import key_template


class PFunkTestCase(unittest.TestCase):

    def setUp(self) -> None:
        os.environ['PFUNK_TEST_MODE'] = 'True'
        os.environ['TEMPLATE_ROOT_DIR'] = '/tmp'
        self.client = FaunaClient(secret='secret')
        self.db_name = str(uuid.uuid4())
        self.client.query(
            q.create_database({'name': self.db_name})
        )
        self.secret = self.client.query(
            q.create_key({
                "database": q.database(self.db_name),
                "role": "admin"
            })
        ).get('secret')
        os.environ['FAUNA_SECRET'] = self.secret

    def tearDown(self) -> None:
        client = FaunaClient(secret='secret')
        client.query(
            q.delete(q.database(self.db_name))
        )


class CollectionTestCase(PFunkTestCase):
    collections = []

    def setUp(self) -> None:
        super(CollectionTestCase, self).setUp()
        self.project = Project()

        self.project.add_resources(self.collections)
        self.project.publish()


class APITestCase(CollectionTestCase):

    def setUp(self) -> None:
        super(APITestCase, self).setUp()
        self.app = self.project.wsgi_app
        self.c = Client(self.app)
        os.environ.setdefault('KEY_MODULE', 'pfunk.tests.unittest_keys.KEYS')
        Key = import_util('pfunk.contrib.auth.collections.Key')
        keys = Key.create_keys()
        self.keys_path = 'pfunk/tests/unittest_keys.py'
        with open(self.keys_path, 'w+') as f:
            f.write(key_template.render(keys=keys))


    def tearDown(self) -> None:
        super(APITestCase, self).tearDown()
        if os.path.exists(self.keys_path):
            os.remove(self.keys_path)
        else:
            print("The file does not exist")
#   class PFunkTestCase(unittest.case.TestCase):
View Source 
class PFunkTestCase(unittest.TestCase):

    def setUp(self) -> None:
        os.environ['PFUNK_TEST_MODE'] = 'True'
        os.environ['TEMPLATE_ROOT_DIR'] = '/tmp'
        self.client = FaunaClient(secret='secret')
        self.db_name = str(uuid.uuid4())
        self.client.query(
            q.create_database({'name': self.db_name})
        )
        self.secret = self.client.query(
            q.create_key({
                "database": q.database(self.db_name),
                "role": "admin"
            })
        ).get('secret')
        os.environ['FAUNA_SECRET'] = self.secret

    def tearDown(self) -> None:
        client = FaunaClient(secret='secret')
        client.query(
            q.delete(q.database(self.db_name))
        )

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.
#   def setUp(self) -> None:
View Source 
    def setUp(self) -> None:
        os.environ['PFUNK_TEST_MODE'] = 'True'
        os.environ['TEMPLATE_ROOT_DIR'] = '/tmp'
        self.client = FaunaClient(secret='secret')
        self.db_name = str(uuid.uuid4())
        self.client.query(
            q.create_database({'name': self.db_name})
        )
        self.secret = self.client.query(
            q.create_key({
                "database": q.database(self.db_name),
                "role": "admin"
            })
        ).get('secret')
        os.environ['FAUNA_SECRET'] = self.secret

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

#   def tearDown(self) -> None:
View Source 
    def tearDown(self) -> None:
        client = FaunaClient(secret='secret')
        client.query(
            q.delete(q.database(self.db_name))
        )

Hook method for deconstructing the test fixture after testing it.

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_
#   class CollectionTestCase(PFunkTestCase):
View Source 
class CollectionTestCase(PFunkTestCase):
    collections = []

    def setUp(self) -> None:
        super(CollectionTestCase, self).setUp()
        self.project = Project()

        self.project.add_resources(self.collections)
        self.project.publish()

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 = []
#   def setUp(self) -> None:
View Source 
    def setUp(self) -> None:
        super(CollectionTestCase, self).setUp()
        self.project = Project()

        self.project.add_resources(self.collections)
        self.project.publish()

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

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_
PFunkTestCase
tearDown
#   class APITestCase(CollectionTestCase):
View Source 
class APITestCase(CollectionTestCase):

    def setUp(self) -> None:
        super(APITestCase, self).setUp()
        self.app = self.project.wsgi_app
        self.c = Client(self.app)
        os.environ.setdefault('KEY_MODULE', 'pfunk.tests.unittest_keys.KEYS')
        Key = import_util('pfunk.contrib.auth.collections.Key')
        keys = Key.create_keys()
        self.keys_path = 'pfunk/tests/unittest_keys.py'
        with open(self.keys_path, 'w+') as f:
            f.write(key_template.render(keys=keys))


    def tearDown(self) -> None:
        super(APITestCase, self).tearDown()
        if os.path.exists(self.keys_path):
            os.remove(self.keys_path)
        else:
            print("The file does not exist")

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.
#   def setUp(self) -> None:
View Source 
    def setUp(self) -> None:
        super(APITestCase, self).setUp()
        self.app = self.project.wsgi_app
        self.c = Client(self.app)
        os.environ.setdefault('KEY_MODULE', 'pfunk.tests.unittest_keys.KEYS')
        Key = import_util('pfunk.contrib.auth.collections.Key')
        keys = Key.create_keys()
        self.keys_path = 'pfunk/tests/unittest_keys.py'
        with open(self.keys_path, 'w+') as f:
            f.write(key_template.render(keys=keys))

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

#   def tearDown(self) -> None:
View Source 
    def tearDown(self) -> None:
        super(APITestCase, self).tearDown()
        if os.path.exists(self.keys_path):
            os.remove(self.keys_path)
        else:
            print("The file does not exist")

Hook method for deconstructing the test fixture after testing it.

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_
CollectionTestCase
collections