Common functions in API unit test modules should be moved to utils

[NamesJ]

Modules in the tests package for testing API resources in certain namespaces (e.g. test_transfer_api.py', 'test_offer_api.py') repeat similar code for functions which use a session client to send a request and return a response -- functions usually named something like create_()', get_<entity>_data(), etc.. For example in test_transfer_api.py, the function get_transfer_data().

Because resources are designed such that request data (if any) is expected to always be JSON, the implementation of these functions are (usually) virtually identical.

So I think they should be consolidated somewhere in utils sub-package of the tests package.

[NamesJ]

Proposed changes:

Old way

# test_transfer_api.py
...


def get_transfer_data(self, access_token, id):
    return self.client.get(
        f'/api/transfer',
        headers={'Authorization': f'Bearer {access_token}'},
        content_type='application/json',
        data=json.dumps({ 'id': id })
    )


class TestTransferBlueprint(BaseTestCase):
    def test_transfer_get(self):
        ...


        transfer = Transfer(...)
        ...


        transfer_response = get_transfer_data(self, access_token, transfer.id)
        ...

New way

# tests/utils/common.py
...


from app import db
...


def get_entity_data(client, access_token, entity_name, payload):
    return self.client.get(
        f'/api/{entity_name}',
        headers={'Authorization': f'Bearer {access_token}'},
        content_type='application/json',
        data=json.dumps(payload)
    )

# tests/test_transfer_api.py
from tests.utils.common import get_entity_data
...


class TestTransferBlueprint(BaseTestCase):
    def test_transfer_get(self):
        ...


        transfer = Transfer(...)
        ...


        payload = { 'id': transfer.id }
        transfer_response = get_entity_data(self, access_token, 'transfer', payload)
        ...