conservancy_beancount/tests/test_meta_invoice.py
2020-03-28 14:31:17 -04:00

139 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
VALID_VALUES = {
'Invoices/304321.pdf',
'rt:123/456',
'rt://ticket/234',
}
INVALID_VALUES = {
'',
' ',
' ',
}
REQUIRED_ACCOUNTS = {
'Accrued:AccountsPayable',
'Accrued:AccountsReceivable',
}
NON_REQUIRED_ACCOUNTS = {
'Assets:Cash',
'Expenses:Other',
'Income:Other',
'Liabilities:CreditCard',
'UnearnedIncome:Donations',
}
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,
VALID_VALUES,
))
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,
INVALID_VALUES,
))
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,
VALID_VALUES,
))
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,
INVALID_VALUES,
))
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}