conservancy_beancount/tests/test_meta_approval.py

"""Test validation of approval 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_approval

REQUIRED_ACCOUNTS = {
    'Assets:Bank:Checking',
    'Assets:Cash',
    'Assets:Savings',
    'Liabilities:Payable:Accounts',
}

NON_REQUIRED_ACCOUNTS = {
    'Assets:Prepaid:Expenses',
    'Assets:Receivable:Accounts',
    'Equity:QpeningBalance',
    'Expenses:Other',
    'Income:Other',
    'Liabilities:Payable:Vacation',
    'Liabilities:UnearnedIncome:Donations',
}

CREDITCARD_ACCOUNT = 'Liabilities:CreditCard'

TEST_KEY = 'approval'

@pytest.fixture(scope='module')
def hook():
    config = testutil.TestConfig()
    return meta_approval.MetaApproval(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_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(
    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_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', testutil.combine_values(
    REQUIRED_ACCOUNTS,
    NON_REQUIRED_ACCOUNTS,
))
def test_approval_not_required_on_credits(hook, acct1, acct2):
    txn = testutil.Transaction(postings=[
        (acct2, -25),
        (acct1, 25),
    ])
    assert not list(hook.run(txn))

def test_approval_not_required_to_charge_credit_card(hook):
    txn = testutil.Transaction(postings=[
        ('Expenses:Other', 25),
        (CREDITCARD_ACCOUNT, 25),
    ])
    assert not list(hook.run(txn))

def test_approval_not_required_to_pay_credit_card(hook):
    txn = testutil.Transaction(postings=[
        ('Assets:Checking', -25),
        (CREDITCARD_ACCOUNT, 25),
    ])
    assert not list(hook.run(txn))

def test_approval_not_required_for_asset_transfers(hook):
    txn = testutil.Transaction(postings=[
        ('Assets:Checking', -250, {'tax-implication': 'Bank-Transfer'}),
        ('Assets:Savings', 250),
    ])
    assert not list(hook.run(txn))

def test_approval_required_for_partial_transfer(hook):
    # I'm not sure this ever comes up in reality, but just being thorough
    # out of an abundance of precaution.
    txn = testutil.Transaction(postings=[
        ('Assets:Checking', -250, {'tax-implication': 'Bank-Transfer'}),
        ('Assets:Savings', 225),
        ('Expenses:BankingFees', 25),
    ])
    actual = {error.message for error in hook.run(txn)}
    assert actual == {"Assets:Checking missing {}".format(TEST_KEY)}