Merge pull request #4 from proteanhq/enhancements/protean-0.0.11

Enhancements to become compatible with Protean 0.0.11

- Upgrade to be compatible with Python 3.7+ only
- Upgrade other packages where possible
- Remove Schemas
- Change Test cases to use Fixtures

.travis.yml

@@ -1,6 +1,7 @@
 language: python
+dist: xenial
 python:
-  - '3.6'
+  - '3.7'
 install:
   - pip install -r requirements/test.txt
   - python setup.py install

MANIFEST.in

@@ -7,7 +7,6 @@ include .bumpversion.cfg
 include .coveragerc
 include .cookiecutterrc
 include .editorconfig
-include .pylintrc
 
 include AUTHORS.rst
 include CHANGELOG.rst

README.rst

@@ -59,7 +59,7 @@ Development
 
 ::
 
-    pyenv virtualenv -p python3.6 3.6.5 protean-flask-dev
+    pyenv virtualenv -p python3.7 3.7.2 protean-flask-dev
 
 To run the all tests run::
 

requirements.txt

@@ -1,5 +1 @@
-click==7.0
-protean==0.0.9
-authentic==0.0.9
-protean-flask==0.0.9
--r requirements/dev.txt
+-r requirements/prod.txt

requirements/dev.txt

@@ -1,7 +1,5 @@
-check-manifest==0.37
-coverage==4.5.1
+-r prod.txt
+
+check-manifest==0.38
+coverage==4.5.3
 docutils==0.14
-flake8==3.5.0
-pylint==2.0.0
-tox==3.1.2
-twine==1.11.0

requirements/prod.txt

@@ -0,0 +1,4 @@
+click==7.0
+protean==0.0.11
+authentic==0.0.11
+protean-flask==0.0.11

requirements/test.txt

@@ -1,8 +1,8 @@
 -r dev.txt
 
 mock==2.0.0
-pytest==3.6.3
-pytest-cov==2.5.1
-pytest-travis-fold==1.3.0
+pluggy==0.9.0
+pytest-cov==2.6.1
 pytest-flake8==1.0.4
-pluggy==0.6.0
+pytest-travis-fold==1.3.0
+pytest==4.4.1

setup.py

@@ -54,7 +54,7 @@ def read(*names, **kwargs):
         'Operating System :: POSIX :: Linux',
         'Operating System :: OS/2',
         'Programming Language :: Python',
-        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3 :: Only',
         'Topic :: Database',
         'Topic :: Software Development :: Libraries',
@@ -66,9 +66,9 @@ def read(*names, **kwargs):
     ],
     install_requires=[
         'click==7.0',
-        'protean==0.0.9',
-        'authentic==0.0.9',
-        'protean-flask==0.0.9'
+        'protean==0.0.11',
+        'authentic==0.0.11',
+        'protean-flask==0.0.11'
     ],
     extras_require={
         # eg:

tests/conftest.py

@@ -1,4 +1,57 @@
 """Module to setup Factories and other required artifacts for tests"""
 import os
 
+import pytest
+
 os.environ['PROTEAN_CONFIG'] = 'tests.support.sample_config'
+
+
+def pytest_addoption(parser):
+    """Additional options for running tests with pytest"""
+    parser.addoption(
+        "--slow", action="store_true", default=False, help="run slow tests"
+    )
+
+
+def pytest_collection_modifyitems(config, items):
+    """Configure special markers on tests, so as to control execution"""
+    if config.getoption("--slow"):
+        # --slow given in cli: do not skip slow tests
+        return
+    skip_slow = pytest.mark.skip(reason="need --slow option to run")
+    for item in items:
+        if "slow" in item.keywords:
+            item.add_marker(skip_slow)
+
+
+@pytest.fixture(scope="session", autouse=True)
+def register_models():
+    """Register Test Models with Dict Repo
+
+       Run only once for the entire test suite
+    """
+    from protean.core.repository import repo_factory
+    from authentic.utils import get_account_entity
+
+    from .support.sample_app.entities import Human
+
+    Account = get_account_entity()
+
+    repo_factory.register(Account)
+    repo_factory.register(Human)
+
+
+@pytest.fixture(autouse=True)
+def run_around_tests():
+    """Cleanup Database after each test run"""
+    from protean.core.repository import repo_factory
+    from authentic.utils import get_account_entity
+    from .support.sample_app.entities import Human
+
+    Account = get_account_entity()
+
+    # A test function will be run at this point
+    yield
+
+    repo_factory.get_repository(Account).delete_all()
+    repo_factory.get_repository(Human).delete_all()

tests/support/sample_config.py

@@ -16,9 +16,9 @@
 TESTING = True
 
 # Define the repositories
-REPOSITORIES = {
+DATABASES = {
     'default': {
-        'PROVIDER': 'protean.impl.repository.dict_repo'
+        'PROVIDER': 'protean.impl.repository.dict_repo.DictProvider'
     }
 }
 

tests/test_account_views.py

@@ -2,9 +2,9 @@
 import base64
 import json
 
+import pytest
 from authentic.utils import get_account_entity
 from passlib.hash import pbkdf2_sha256
-from protean.core.repository import repo_factory
 
 from .support.sample_app import app
 
@@ -14,32 +14,34 @@
 class TestViews:
     """Class to test all the account blueprint views"""
 
-    @classmethod
-    def setup_class(cls):
-        """ Setup for this test case"""
+    @pytest.fixture(scope="function", autouse=True)
+    def client(self):
+        """ Setup client for test cases """
+        yield app.test_client()
 
-        # Create the test client
-        cls.client = app.test_client()
-        cls.auth_header = {
+    @pytest.fixture(scope="function", autouse=True)
+    def auth_header(self):
+        """ Setup auth header for test cases """
+        header = {
             'Authorization': b'Basic ' +
                              base64.b64encode(b'janedoe:duMmy@123')
         }
+        yield header
 
-        # Create a test account
-        cls.account = Account.create({
+    @pytest.fixture(scope="function", autouse=True)
+    def account(self):
+        """ Setup dummy account for test cases """
+
+        new_account = Account.create({
             'email': '[email protected]',
             'username': 'janedoe',
             'name': 'Jane Doe',
             'password': pbkdf2_sha256.hash('duMmy@123'),
             'phone': '90080000800',
         })
+        yield new_account
 
-    @classmethod
-    def teardown_class(cls):
-        """ Teardown for this test case """
-        repo_factory.Account.delete_all()
-
-    def test_create(self):
+    def test_create(self, client, auth_header):
         """ Test creating an account """
 
         # Create an account object
@@ -50,9 +52,9 @@ def test_create(self):
             'password': 'heLLo@123',
             'confirm_password': 'heLLo@123',
         }
-        rv = self.client.post(
+        rv = client.post(
             '/auth/accounts', data=json.dumps(account_info),
-            headers=self.auth_header, content_type='application/json')
+            headers=auth_header, content_type='application/json')
         assert rv.status_code == 201
 
         expected_resp = {
@@ -69,20 +71,20 @@ def test_create(self):
         }
         assert rv.json == expected_resp
 
-    def test_update(self):
+    def test_update(self, client, auth_header, account):
         """ Test updating an existing account """
 
         # update an account object
         update_info = {
             'phone': '9007007007',
         }
-        rv = self.client.put(
-            f'/auth/accounts/{self.account.id}', data=json.dumps(update_info),
-            headers=self.auth_header, content_type='application/json')
+        rv = client.put(
+            f'/auth/accounts/{account.id}', data=json.dumps(update_info),
+            headers=auth_header, content_type='application/json')
         assert rv.status_code == 200
         expected_resp = {
             'account': {'email': '[email protected]',
-                        'id': self.account.id,
+                        'id': account.id,
                         'is_active': True,
                         'is_locked': False,
                         'is_verified': False,
@@ -94,35 +96,48 @@ def test_update(self):
         }
         assert rv.json == expected_resp
 
-    def test_show(self):
+    def test_show(self, client, auth_header, account):
         """ Test showing an existing account """
 
-        rv = self.client.get(
-            f'/auth/accounts/{self.account.id}', headers=self.auth_header)
+        rv = client.get(
+            f'/auth/accounts/{account.id}', headers=auth_header)
         assert rv.status_code == 200
         expected_resp = {
             'account': {'email': '[email protected]',
-                        'id': self.account.id,
+                        'id': account.id,
                         'is_active': True,
                         'is_locked': False,
                         'is_verified': False,
                         'name': 'Jane Doe',
-                        'phone': '9007007007',
+                        'phone': '90080000800',
                         'timezone': None,
                         'title': None,
                         'username': 'janedoe'}
         }
         assert rv.json == expected_resp
 
-    def test_login(self):
+    def test_login(self, client, auth_header):
         """ Test logging in using account credentials """
 
+        # Create an account object
+        account_info = {
+            'username': 'johnny',
+            'email': '[email protected]',
+            'name': 'John Doe',
+            'password': 'heLLo@123',
+            'confirm_password': 'heLLo@123',
+        }
+        rv = client.post(
+            '/auth/accounts', data=json.dumps(account_info),
+            headers=auth_header, content_type='application/json')
+        assert rv.status_code == 201
+
         # Send the login request
         credentials = {
             'username_or_email': 'johnny',
             'password': 'heLLo@79',
         }
-        rv = self.client.post(
+        rv = client.post(
             f'/auth/login', data=json.dumps(credentials),
             content_type='application/json')
         assert rv.status_code == 422
@@ -131,24 +146,24 @@ def test_login(self):
 
         # Try using the right credentials
         credentials['password'] = 'heLLo@123'
-        rv = self.client.post(
+        rv = client.post(
             f'/auth/login', data=json.dumps(credentials),
             content_type='application/json')
         assert rv.status_code == 200
         assert rv.json['username'] == 'johnny'
 
-    def test_logout(self):
+    def test_logout(self, client, auth_header):
         """ Test logging out of the application """
 
         # Send the logout request
-        rv = self.client.post(
-            '/auth/logout', data=json.dumps({}), headers=self.auth_header,
+        rv = client.post(
+            '/auth/logout', data=json.dumps({}), headers=auth_header,
             content_type='application/json')
 
         assert rv.status_code == 200
         assert rv.json == {'message': 'success'}
 
-    def test_update_password(self):
+    def test_update_password(self, client, auth_header):
         """ Test updating password of an account """
 
         # update an account object
@@ -157,19 +172,19 @@ def test_update_password(self):
             'new_password': 'duMmy@456',
             'confirm_password': 'duMmy@456',
         }
-        rv = self.client.post(
+        rv = client.post(
             '/auth/accounts/change-password', data=json.dumps(password_update),
-            headers=self.auth_header, content_type='application/json')
+            headers=auth_header, content_type='application/json')
         assert rv.status_code == 200
 
         expected_resp = {'message': 'Success'}
         assert rv.json == expected_resp
 
-    def test_reset_password(self):
+    def test_reset_password(self, client, account):
         """ Test resetting the password for an account """
 
         # Send a reset password request
-        rv = self.client.post(
+        rv = client.post(
             '/auth/accounts/reset-password',
             data=json.dumps({'email': '[email protected]'}),
             content_type='application/json')
@@ -179,15 +194,15 @@ def test_reset_password(self):
         assert rv.json == expected_resp
 
         # Get the verification token for the account
-        account = Account.get(self.account.id)
+        account = Account.get(account.id)
         assert account.verification_token is not None
 
         # Send the reset password request
         password_update = {
             'new_password': 'duMmy@789',
             'confirm_password': 'duMmy@789',
         }
-        rv = self.client.post(
+        rv = client.post(
             f'/auth/accounts/reset-password/{account.verification_token}',
             data=json.dumps(password_update),
             content_type='application/json')
@@ -196,12 +211,12 @@ def test_reset_password(self):
         expected_resp = {'message': 'Success'}
         assert rv.json == expected_resp
 
-    def test_delete(self):
+    def test_delete(self, client, account):
         """ Test deleting an existing account """
         auth_header = {
             'Authorization': b'Basic ' +
-                             base64.b64encode(b'janedoe:duMmy@789')
+                             base64.b64encode(b'janedoe:duMmy@123')
         }
-        rv = self.client.delete(
-            f'/auth/accounts/{self.account.id}', headers=auth_header)
+        rv = client.delete(
+            f'/auth/accounts/{account.id}', headers=auth_header)
         assert rv.status_code == 204