conservancy_beancount/tests/test_meta_receipt.py

"""Test validation of receipt metadata"""
# Copyright © 2020  Brett Smith
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

import pytest

from . import testutil

from conservancy_beancount.plugin import meta_receipt

REQUIRED_ACCOUNTS = {
    'Assets:Cash',
    'Assets:Savings',
    'Liabilities:CreditCard',
}

CHECKING_ACCOUNTS = {
    'Assets:Checking',
    'Assets:CheckCard',
}

TESTABLE_ACCOUNTS = REQUIRED_ACCOUNTS | CHECKING_ACCOUNTS

NON_REQUIRED_ACCOUNTS = {
    'Accrued:AccountsPayable',
    'Assets:PrepaidExpenses',
    'Assets:PrepaidVacation',
    'Expenses:Other',
    'Income:Other',
    'UnearnedIncome:Donations',
}

TEST_KEY = 'receipt'

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

@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
    TESTABLE_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(
    TESTABLE_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_msg = "{} has wrong type of {}: expected str but is a {}".format(
        acct1,
        TEST_KEY,
        type(value).__name__,
    )
    actual = {error.message for error in hook.run(txn)}
    assert expected_msg in actual

@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
    TESTABLE_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(
    TESTABLE_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_msg = "{} has wrong type of {}: expected str but is a {}".format(
        acct1,
        TEST_KEY,
        type(value).__name__,
    )
    actual = {error.message for error in hook.run(txn)}
    assert expected_msg in actual

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

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

@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
    CHECKING_ACCOUNTS,
    NON_REQUIRED_ACCOUNTS,
    testutil.NON_STRING_METADATA_VALUES,
))
def test_check_fallback_bad_type_on_postings(hook, acct1, acct2, value):
    txn = testutil.Transaction(postings=[
        (acct2, 25),
        (acct1, -25, {'check': value}),
    ])
    expected = {
        "{} missing {}".format(acct1, TEST_KEY),
        "{} has wrong type of check: expected str but is a {}".format(
            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(
    CHECKING_ACCOUNTS,
    NON_REQUIRED_ACCOUNTS,
    testutil.LINK_METADATA_STRINGS,
))
def test_check_fallback_on_transaction(hook, acct1, acct2, value):
    txn = testutil.Transaction(check=value, postings=[
        (acct2, 25),
        (acct1, -25),
    ])
    assert not list(hook.run(txn))

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

@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
    CHECKING_ACCOUNTS,
    NON_REQUIRED_ACCOUNTS,
    testutil.NON_STRING_METADATA_VALUES,
))
def test_check_fallback_bad_type_on_transaction(hook, acct1, acct2, value):
    txn = testutil.Transaction(check=value, postings=[
        (acct2, 25),
        (acct1, -25),
    ])
    expected = {
        "{} missing {}".format(acct1, TEST_KEY),
        "{} has wrong type of check: expected str but is a {}".format(
            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_check_fallback_not_accepted_on_other_accounts(hook, acct1, acct2, value):
    txn = testutil.Transaction(postings=[
        (acct2, 25),
        (acct1, -25, {'check': value}),
    ])
    actual = {error.message for error in hook.run(txn)}
    assert actual == {"{} missing {}".format(acct1, TEST_KEY)}

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