NPO-Accounting/conservancy_beancount
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

meta_receipt: Start hook.

Browse source
This commit is contained in:
Brett Smith 2020-03-28 22:19:49 -04:00
parent 7658aaedf8
commit 2909c405e6
5 changed files with 330 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
conservancy_beancount/plugin/core.py
View file

@ -252,12 +252,18 @@ class _RequireLinksPostingMetadataHook(_PostingHook):
super().__init_subclass__()
cls.HOOK_GROUPS = cls.HOOK_GROUPS.union(['metadata', cls.METADATA_KEY])
def post_run(self, txn: Transaction, post: data.Posting) -> errormod.Iter:
def _check_links(self, txn: Transaction, post: data.Posting, key: MetaKey) -> None:
try:
problem = not post.meta.get_links(self.METADATA_KEY)
problem = not post.meta.get_links(key)
value = None
except TypeError:
problem = True
value = post.meta[self.METADATA_KEY]
value = post.meta[key]
if problem:
yield errormod.InvalidMetadataError(txn, self.METADATA_KEY, value, post)
raise errormod.InvalidMetadataError(txn, key, value, post)
def post_run(self, txn: Transaction, post: data.Posting) -> errormod.Iter:
try:
self._check_links(txn, post, self.METADATA_KEY)
except errormod.Error as error:
yield error

56
conservancy_beancount/plugin/meta_receipt.py Normal file
View file

@ -0,0 +1,56 @@
"""meta_receipt - Validate receipt 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/>.
from . import core
from .. import data
from .. import errors as errormod
from ..beancount_types import (
MetaValueEnum,
Transaction,
)
class MetaReceipt(core._RequireLinksPostingMetadataHook):
DEFAULT_STOP_AMOUNT = 0
METADATA_KEY = 'receipt'
def _run_on_post(self, txn: Transaction, post: data.Posting) -> bool:
return bool(
(post.account.is_real_asset() or post.account.is_under('Liabilities'))
and post.units.number
and post.units.number < self.DEFAULT_STOP_AMOUNT
)
def post_run(self, txn: Transaction, post: data.Posting) -> errormod.Iter:
try:
self._check_links(txn, post, 'receipt')
except errormod.Error as receipt_error:
# Outgoing check may omit a receipt if they have a check link
# instead.
if ':Check' not in post.account:
yield receipt_error
else:
try:
self._check_links(txn, post, 'check')
except errormod.Error as check_error:
if (receipt_error.message.endswith(" missing receipt")
and check_error.message.endswith(" missing check")):
check_error.message = check_error.message.replace(
" missing check", " missing receipt or check",
)
yield check_error
else:
yield receipt_error
yield check_error

20
tests/test_meta_invoice.py
View file

@ -20,18 +20,6 @@ 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',
@ -55,7 +43,7 @@ def hook():
@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
REQUIRED_ACCOUNTS,
NON_REQUIRED_ACCOUNTS,
VALID_VALUES,
testutil.LINK_METADATA_STRINGS,
))
def test_valid_values_on_postings(hook, acct1, acct2, value):
txn = testutil.Transaction(postings=[
@ -67,7 +55,7 @@ def test_valid_values_on_postings(hook, acct1, acct2, value):
@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
REQUIRED_ACCOUNTS,
NON_REQUIRED_ACCOUNTS,
INVALID_VALUES,
testutil.NON_LINK_METADATA_STRINGS,
))
def test_invalid_values_on_postings(hook, acct1, acct2, value):
txn = testutil.Transaction(postings=[
@ -98,7 +86,7 @@ def test_bad_type_values_on_postings(hook, acct1, acct2, value):
@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
REQUIRED_ACCOUNTS,
NON_REQUIRED_ACCOUNTS,
VALID_VALUES,
testutil.LINK_METADATA_STRINGS,
))
def test_valid_values_on_transaction(hook, acct1, acct2, value):
txn = testutil.Transaction(**{TEST_KEY: value}, postings=[
@ -110,7 +98,7 @@ def test_valid_values_on_transaction(hook, acct1, acct2, value):
@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
REQUIRED_ACCOUNTS,
NON_REQUIRED_ACCOUNTS,
INVALID_VALUES,
testutil.NON_LINK_METADATA_STRINGS,
))
def test_invalid_values_on_transaction(hook, acct1, acct2, value):
txn = testutil.Transaction(**{TEST_KEY: value}, postings=[

248
tests/test_meta_receipt.py Normal file
View file

@ -0,0 +1,248 @@
"""Test validation of receipt 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_receipt
REQUIRED_ACCOUNTS = {
'Assets:Cash',
'Assets:Savings',
'Liabilities:CreditCard',
}
CHECKING_ACCOUNTS = {
'Assets:Checking',
'Assets:CheckCard',
}
TESTABLE_ACCOUNTS = REQUIRED_ACCOUNTS | CHECKING_ACCOUNTS
NON_REQUIRED_ACCOUNTS = {
'Accrued:AccountsPayable',
'Assets:PrepaidExpenses',
'Assets:PrepaidVacation',
'Expenses:Other',
'Income:Other',
'UnearnedIncome:Donations',
}
TEST_KEY = 'receipt'
@pytest.fixture(scope='module')
def hook():
config = testutil.TestConfig()
return meta_receipt.MetaReceipt(config)
@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
TESTABLE_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(
TESTABLE_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(
TESTABLE_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(
TESTABLE_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,value', testutil.combine_values(
CHECKING_ACCOUNTS,
NON_REQUIRED_ACCOUNTS,
testutil.LINK_METADATA_STRINGS,
))
def test_check_fallback_on_postings(hook, acct1, acct2, value):
txn = testutil.Transaction(postings=[
(acct2, 25),
(acct1, -25, {'check': value}),
])
assert not list(hook.run(txn))
@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
CHECKING_ACCOUNTS,
NON_REQUIRED_ACCOUNTS,
testutil.NON_LINK_METADATA_STRINGS,
))
def test_bad_check_fallback_on_postings(hook, acct1, acct2, value):
txn = testutil.Transaction(postings=[
(acct2, 25),
(acct1, -25, {'check': value}),
])
actual = {error.message for error in hook.run(txn)}
assert actual == {"{} missing {} or check".format(acct1, TEST_KEY)}
@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
CHECKING_ACCOUNTS,
NON_REQUIRED_ACCOUNTS,
testutil.NON_STRING_METADATA_VALUES,
))
def test_check_fallback_bad_type_on_postings(hook, acct1, acct2, value):
txn = testutil.Transaction(postings=[
(acct2, 25),
(acct1, -25, {'check': value}),
])
expected = {
"{} missing {}".format(acct1, TEST_KEY),
"{} has wrong type of check: expected str but is a {}".format(
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(
CHECKING_ACCOUNTS,
NON_REQUIRED_ACCOUNTS,
testutil.LINK_METADATA_STRINGS,
))
def test_check_fallback_on_transaction(hook, acct1, acct2, value):
txn = testutil.Transaction(check=value, postings=[
(acct2, 25),
(acct1, -25),
])
assert not list(hook.run(txn))
@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
CHECKING_ACCOUNTS,
NON_REQUIRED_ACCOUNTS,
testutil.NON_LINK_METADATA_STRINGS,
))
def test_bad_check_fallback_on_transaction(hook, acct1, acct2, value):
txn = testutil.Transaction(check=value, postings=[
(acct2, 25),
(acct1, -25),
])
actual = {error.message for error in hook.run(txn)}
assert actual == {"{} missing {} or check".format(acct1, TEST_KEY)}
@pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
CHECKING_ACCOUNTS,
NON_REQUIRED_ACCOUNTS,
testutil.NON_STRING_METADATA_VALUES,
))
def test_check_fallback_bad_type_on_transaction(hook, acct1, acct2, value):
txn = testutil.Transaction(check=value, postings=[
(acct2, 25),
(acct1, -25),
])
expected = {
"{} missing {}".format(acct1, TEST_KEY),
"{} has wrong type of check: expected str but is a {}".format(
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_check_fallback_not_accepted_on_other_accounts(hook, acct1, acct2, value):
txn = testutil.Transaction(postings=[
(acct2, 25),
(acct1, -25, {'check': value}),
])
actual = {error.message for error in hook.run(txn)}
assert actual == {"{} missing {}".format(acct1, TEST_KEY)}
@pytest.mark.parametrize('acct1,acct2', testutil.combine_values(
TESTABLE_ACCOUNTS,
NON_REQUIRED_ACCOUNTS,
))
def test_no_value_required_for_credits(hook, acct1, acct2):
txn = testutil.Transaction(postings=[
(acct2, -25),
(acct1, 25),
])
assert not list(hook.run(txn))

12
tests/testutil.py
View file

@ -77,6 +77,18 @@ def Posting(account, number,
meta,
)
LINK_METADATA_STRINGS = {
'Invoices/304321.pdf',
'rt:123/456',
'rt://ticket/234',
}
NON_LINK_METADATA_STRINGS = {
'',
' ',
' ',
}
NON_STRING_METADATA_VALUES = [
Decimal(5),
FY_MID_DATE,