refactoring test code for reusability

Author: jcuna

api/core/__init__.py

@@ -97,7 +97,7 @@ def run(self):
                             app.logger.debug(threading.current_thread().name + ' new audit record')
                             if is_prod:
                                 task.payload = encryptor.encrypt(task.payload)
-                            task.ip = struct.unpack("!I", socket.inet_aton(task.ip))[0]
+                            task.ip = struct.unpack('!I', socket.inet_aton(task.ip))[0]
                             db.session.add(task)
                         self.tasks.clear()
                         db.session.commit()

api/dal/models.py

@@ -46,7 +46,7 @@ class User(db.Model, ModelIter):
     audit = relationship('Audit')
 
     def hash_password(self):
-        self.password = generate_password_hash(str(self.password).encode("ascii"), method='sha256')
+        self.password = generate_password_hash(str(self.password).encode('ascii'), method='sha256')
 
     def password_correct(self, plain_password):
         return check_password_hash(self.password, plain_password)

api/tests/__init__.py

@@ -1,4 +1,5 @@
 import os
+from datetime import datetime, time
 
 config = """
 TESTING = True
@@ -31,3 +32,7 @@ def tear_files():
 
 def endpoint(uri):
     return '/v1.0' + uri
+
+
+def front_end_date(date: datetime = datetime.utcnow(), _time: str = str(time.min)):
+    return ' '.join([str(date.date()), _time])

api/tests/conftest.py

@@ -1,5 +1,8 @@
+from base64 import b64encode
 import pytest
-from tests import tear_files, init
+from tests import tear_files, init, endpoint
+from tests.seeders import seed_admin
+
 
 @pytest.fixture(scope='module')
 def client():
@@ -34,3 +37,20 @@ def no_db_client():
     with app.test_client() as client:
         yield client
     tear_files()
+
+
+@pytest.fixture(scope='module')
+def admin_login(client):
+
+    admin_resp = seed_admin(client)
+    assert b'Redirecting...' in admin_resp.data, 'Must redirect upon valid admin creation'
+    assert admin_resp.status_code == 302
+
+    auth = {
+        'Authorization': 'Basic ' + b64encode(b'[email protected]:' + b'secured').decode()
+    }
+    # create a session
+    login_resp = client.post(endpoint('/login'), headers=auth)
+    assert 'token' in login_resp.json, 'token expected'
+    assert login_resp.status_code == 200
+    return login_resp.json

api/tests/seeders.py

@@ -1,6 +1,5 @@
 from flask.testing import FlaskClient
-
-from tests import endpoint
+from tests import endpoint, front_end_date
 
 admin_sample = {
     'first_name': 'Test',
@@ -11,9 +10,9 @@
 
 project_sample = {
     'active': True,
-    'address': "1500 Sample St. Sunnyside CA 98996",
-    'name': "Sample",
-    'phone': "1234567890",
+    'address': '1500 Sample St. Sunnyside CA 98996',
+    'name': 'Sample',
+    'phone': '1234567890',
 }
 
 tenant_sample = {
@@ -25,20 +24,20 @@
 }
 
 room_sample = {
-    'description': "room number 1000",
-    'name': "MA-1000",
-    'picture': "",
+    'description': 'room number 1000',
+    'name': 'MA-1000',
+    'picture': '',
     'project_id': 1,
 }
 
 registration_sample = {
-    'date': "2019-09-26 20:18:36",
-    'deposit': "4400.00",
-    'interval': "100",
-    'rate': "1500.00",
-    'reference1': "5555555555",
-    'reference2': "",
-    'reference3': "",
+    'date': front_end_date(),
+    'deposit': '4400.00',
+    'interval': '100',
+    'rate': '1500.00',
+    'reference1': '5555555555',
+    'reference2': '',
+    'reference3': '',
     'room_id': 1,
     'tenant_id': 1
 }

api/tests/test_balance_payments.py

@@ -1,52 +1,43 @@
-from base64 import b64encode
 from flask.testing import FlaskClient
-from tests import endpoint
-from tests.seeders import seed_admin, seed_tenant, seed_new_agreement, seed_project, seed_room
+from tests.seeders import seed_tenant, seed_new_agreement, seed_project, seed_room
 
 
-def test_seeding_data(client: FlaskClient):
+def test_seeding_data(client: FlaskClient, admin_login: dict):
 
-    admin_resp = seed_admin(client)
-    assert b'Redirecting...' in admin_resp.data
-    assert admin_resp.status_code == 302
-
-    # we need a cookie
-    auth = {
-        'Authorization': 'Basic ' + b64encode(b'[email protected]:' + b'secured').decode()
-    }
-    # create a session
-    login_resp = client.post(endpoint('/login'), headers=auth)
-    assert 'token' in login_resp.json
-    assert login_resp.status_code == 200
-
-    token = login_resp.json['token']['value']
-
-    project_resp = seed_project(client, token)
+    project_resp = seed_project(client, admin_login['token']['value'])
     assert 'id' in project_resp.json
     assert project_resp.status_code == 200
 
-    room_resp = seed_room(client, token, {'project_id': project_resp.json['id']})
+    room_resp = seed_room(client, admin_login['token']['value'], {'project_id': project_resp.json['id']})
     assert 'id' in room_resp.json
     assert room_resp.status_code == 200
 
-    tenant_resp = seed_tenant(client, token)
+    tenant_resp = seed_tenant(client, admin_login['token']['value'])
     assert 'id' in tenant_resp.json
     assert tenant_resp.status_code == 200
 
-    user_id = tenant_resp.json['id']
 
-    agreement_resp = seed_new_agreement(client, token, {'tenant_id': user_id})
-    assert 'id' in agreement_resp.json
-    assert agreement_resp.status_code == 200
+def test_agreement(client: FlaskClient, admin_login: dict):
+    from dal.models import Balance, RentalAgreement, Tenant
 
+    tenants = Tenant.query.all()
+    assert len(tenants) == 1
+    tenant = tenants.pop()
+    assert hasattr(tenant, 'id')
 
-def test_init_balance_created(client: FlaskClient):
-    from dal.models import Balance
-    from dal.models import RentalAgreement
+    tenant_id = tenant.id
+
+    agreement_resp = seed_new_agreement(client, admin_login['token']['value'], {'tenant_id': tenant_id})
+    assert 'id' in agreement_resp.json
+    assert agreement_resp.status_code == 200
 
     balances = Balance.query.all()
-    assert len(balances) == 1
-    balance = Balance.query.first()
+    assert len(balances) == 1, 'only one balance should exist'
+    balance = balances.pop()
     assert isinstance(balance.agreement_id, int)
-    assert balance.init_processed == False
+    assert balance.init_processed == False, 'first balance must not be init processed'
     assert isinstance(balance.agreement, RentalAgreement)
+
+
+def test_new_balance(client, admin_login: dict):
+    assert 'bro' in 'bron'