conservancy_beancount/tests/test_meta_invoice.py
Brett Smith c712105bed Revise chart of accounts used throughout.
The main impetus of this change is to rename accounts that were outside
Beancount's accepted five root accounts, to move them into that
structure. This includes:

  Accrued:*Payable: → Liabilities:Payable:*
  Accrued:*Receivable: → Assets:Receivable:*
  UneanedIncome:* → Liabilities:UnearnedIncome:*

Note the last change did inspire in a change to our validation rules. We no
longer require income-type on unearned income, because it's no longer
considered income at all. Once it's earned and converted to an Income
account, that has an income-type of course.

This did inspire another rename that was not required, but
provided more consistency with the other account names above:

  Assets:Prepaid* → Assets:Prepaid:*

Where applicable, I have generally extended tests to make sure one of each
of the five account types is tested. (This mostly meant adding an Equity
account to the tests.) I also added tests for key parts of the hierarchy,
like Assets:Receivable and Liabilities:Payable, where applicable.

As part of this change, Account.is_real_asset() got renamed to
Account.is_cash_equivalent(), to better self-document its purpose.
2020-04-03 10:34:10 -04:00

129 lines
4 KiB
Python

"""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:OpeningBalance',
'Expenses:Other',
'Income:Other',
'Liabilities:CreditCard',
}
TEST_KEY = 'invoice'
@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_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 actual == {expected_msg}
@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 actual == {expected_msg}