NPO-Accounting/conservancy_beancount Files · tests/test_meta_invoice.py

Files @ e22e63dcca78

Branch filter:

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

e22e63dcca78 4.8 KiB text/x-python Show Annotation Show as Raw Download as Raw

Brett Smith

accrual: Make accruals consistent by entity on the accrual side.

It is more common than I realized that we split an invoice by
entity on the accrual side, so this supports that better.

It still disregards inconsistency between accrual entity and payment entity
for reporting purposes, to help keep reporting clean around automatic
imports.

The changes to BaseReport._report shook out because at this point, the group
key is effectively arbitrary and shouldn't be used for any reporting
purposes.

"""Test validation of invoice 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_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))