fdb62dd1c6
Extend the base class from checking 1 metadata value to checking N. This is preparation for RT#10643, letting payables be documented with invoice or contract. This does unify error reporting, because now we always report all type/invalid value errors *plus* a missing error if appropriate. I think this consistency and thoroughness is appropriate, although it did require some adjustments to the tests.
142 lines
4.4 KiB
Python
142 lines
4.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'
|
|
|
|
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)}
|