conftest.py

import sys
import os
import pytest
from unittest.mock import MagicMock

sys.path.insert(0,
                os.path.abspath(os.path.join(os.path.dirname(__file__), '../..')))

import notecard  # noqa: E402


@pytest.fixture
def card():
    """Create a mock Notecard instance for testing."""
    card = notecard.Notecard()
    card.Transaction = MagicMock()
    return card


@pytest.fixture
def run_fluent_api_notecard_api_mapping_test():
    def _run_test(fluent_api, notecard_api_name, req_params, rename_map=None):
        card = notecard.Notecard()
        card.Transaction = MagicMock()

        fluent_api(card, **req_params)
        expected_notecard_api_req = {'req': notecard_api_name, **req_params}

        # There are certain fluent APIs that have keyword arguments that don't
        # map exactly onto the Notecard API. For example, note.changes takes a
        # 'maximum' parameter, but in the JSON request that gets sent to the
        # Notecard, it's sent as 'max'. The rename_map allows a test to specify
        # how a fluent API's keyword args map to Notecard API args, in cases
        # where they differ.
        if rename_map is not None:
            for old_key, new_key in rename_map.items():
                expected_notecard_api_req[new_key] = expected_notecard_api_req.pop(old_key)

        card.Transaction.assert_called_once_with(expected_notecard_api_req)

    return _run_test


@pytest.fixture
def run_fluent_api_invalid_notecard_test():
    def _run_test(fluent_api, req_params):
        with pytest.raises(Exception, match='Notecard object required'):
            # Call with None instead of a valid Notecard object.
            fluent_api(None, **req_params)

    return _run_test