Files @ 5a8da108b983
Branch filter:

Location: NPO-Accounting/conservancy_beancount/tests/test_meta_invoice.py

bsturmfels
statement_reconciler: Add initial Chase bank CSV statement matching

We currently don't have many examples to work with, so haven't done any
significant testing of the matching accuracy between statement and books.
"""Test validation of invoice metadata"""
# Copyright © 2020  Brett Smith
# License: AGPLv3-or-later WITH Beancount-Plugin-Additional-Permission-1.0
#
# Full copyright and licensing details can be found at toplevel file
# LICENSE.txt in the repository.

import pytest

from . import testutil

from conservancy_beancount.plugin import meta_invoice

REQUIRED_ACCOUNTS = {
    'Assets:Receivable:Accounts',
    'Assets:Receivable:Loans',
    'Liabilities:Payable:Accounts',
    'Liabilities:Payable:Vacation',
}

NON_REQUIRED_ACCOUNTS = {
    'Assets:Cash',
    'Equity:Retained',
    'Expenses:Other',
    'Income:Other',
    'Liabilities:CreditCard',
}

TEST_KEY = 'invoice'

MISSING_MSG = f'{{}} missing {TEST_KEY}'.format
WRONG_TYPE_MSG = f'{{}} has wrong type of {TEST_KEY}: expected str but is a {{}}'.format

@pytest.fixture(scope='module')
def hook():
    config = testutil.TestConfig()
    return meta_invoice.MetaInvoice(config)

@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
    REQUIRED_ACCOUNTS,
    NON_REQUIRED_ACCOUNTS,
    testutil.LINK_METADATA_STRINGS,
))
def test_valid_values_on_postings(hook, acct1, acct2, value):
    txn = testutil.Transaction(postings=[
        (acct2, -25),
        (acct1, 25, {TEST_KEY: value}),
    ])
    assert not list(hook.run(txn))

@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
    REQUIRED_ACCOUNTS,
    NON_REQUIRED_ACCOUNTS,
    testutil.NON_LINK_METADATA_STRINGS,
))
def test_invalid_values_on_postings(hook, acct1, acct2, value):
    txn = testutil.Transaction(postings=[
        (acct2, -25),
        (acct1, 25, {TEST_KEY: value}),
    ])
    actual = {error.message for error in hook.run(txn)}
    assert actual == {"{} missing {}".format(acct1, TEST_KEY)}

@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
    REQUIRED_ACCOUNTS,
    NON_REQUIRED_ACCOUNTS,
    testutil.NON_STRING_METADATA_VALUES,
))
def test_bad_type_values_on_postings(hook, acct1, acct2, value):
    txn = testutil.Transaction(postings=[
        (acct2, -25),
        (acct1, 25, {TEST_KEY: value}),
    ])
    expected = {
        MISSING_MSG(acct1),
        WRONG_TYPE_MSG(acct1, type(value).__name__),
    }
    actual = {error.message for error in hook.run(txn)}
    assert actual == expected

@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
    REQUIRED_ACCOUNTS,
    NON_REQUIRED_ACCOUNTS,
    testutil.LINK_METADATA_STRINGS,
))
def test_valid_values_on_transaction(hook, acct1, acct2, value):
    txn = testutil.Transaction(**{TEST_KEY: value}, postings=[
        (acct2, -25),
        (acct1, 25),
    ])
    assert not list(hook.run(txn))

@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
    REQUIRED_ACCOUNTS,
    NON_REQUIRED_ACCOUNTS,
    testutil.NON_LINK_METADATA_STRINGS,
))
def test_invalid_values_on_transaction(hook, acct1, acct2, value):
    txn = testutil.Transaction(**{TEST_KEY: value}, postings=[
        (acct2, -25),
        (acct1, 25),
    ])
    actual = {error.message for error in hook.run(txn)}
    assert actual == {"{} missing {}".format(acct1, TEST_KEY)}

@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
    REQUIRED_ACCOUNTS,
    NON_REQUIRED_ACCOUNTS,
    testutil.NON_STRING_METADATA_VALUES,
))
def test_bad_type_values_on_transaction(hook, acct1, acct2, value):
    txn = testutil.Transaction(**{TEST_KEY: value}, postings=[
        (acct2, -25),
        (acct1, 25),
    ])
    expected = {
        MISSING_MSG(acct1),
        WRONG_TYPE_MSG(acct1, type(value).__name__),
    }
    actual = {error.message for error in hook.run(txn)}
    assert actual == expected

@pytest.mark.parametrize('acct1,acct2', testutil.combine_values(
    REQUIRED_ACCOUNTS,
    NON_REQUIRED_ACCOUNTS,
))
def test_missing_invoice(hook, acct1, acct2):
    txn = testutil.Transaction(postings=[
        (acct2, -25),
        (acct1, 25),
    ])
    actual = {error.message for error in hook.run(txn)}
    assert actual == {"{} missing {}".format(acct1, TEST_KEY)}

def test_not_required_on_opening(hook):
    txn = testutil.OpeningBalance()
    assert not list(hook.run(txn))

@pytest.mark.parametrize('acct1,acct2', testutil.combine_values(
    REQUIRED_ACCOUNTS,
    NON_REQUIRED_ACCOUNTS,
))
def test_not_required_on_flagged(acct1, acct2, hook):
    txn = testutil.Transaction(flag='!', postings=[
        (acct1, 25),
        (acct2, -25),
    ])
    assert not list(hook.run(txn))