meta_approval: Start hook.
This commit is contained in:
Brett Smith
parent
30d371278a
commit
043644d194
2 changed files with 204 additions and 0 deletions
47
conservancy_beancount/plugin/meta_approval.py
Normal file
47
conservancy_beancount/plugin/meta_approval.py
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
"""meta_approval - Validate approval 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 decimal
|
||||
|
||||
from . import core
|
||||
from .. import config as configmod
|
||||
from .. import data
|
||||
from .. import errors as errormod
|
||||
from ..beancount_types import (
|
||||
Transaction,
|
||||
)
|
||||
|
||||
class MetaApproval(core._RequireLinksPostingMetadataHook):
|
||||
METADATA_KEY = 'approval'
|
||||
CREDIT_CARD_ACCT = 'Liabilities:CreditCard'
|
||||
|
||||
def __init__(self, config: configmod.Config) -> None:
|
||||
self.payment_threshold = -abs(config.payment_threshold())
|
||||
|
||||
def _run_on_txn(self, txn: Transaction) -> bool:
|
||||
if not super()._run_on_txn(txn):
|
||||
return False
|
||||
assets_sum = decimal.Decimal(0)
|
||||
creditcard_sum = decimal.Decimal(0)
|
||||
for post in data.iter_postings(txn):
|
||||
if post.is_payment():
|
||||
assets_sum += post.units.number or 0
|
||||
elif post.account.is_under(self.CREDIT_CARD_ACCT):
|
||||
creditcard_sum += post.units.number or 0
|
||||
return (assets_sum + creditcard_sum) < 0
|
||||
|
||||
def _run_on_post(self, txn: Transaction, post: data.Posting) -> bool:
|
||||
return post.is_payment()
|
||||
157
tests/test_meta_approval.py
Normal file
157
tests/test_meta_approval.py
Normal file
|
|
@ -0,0 +1,157 @@
|
|||
"""Test validation of approval 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_approval
|
||||
|
||||
REQUIRED_ACCOUNTS = {
|
||||
'Assets:Cash',
|
||||
'Assets:Checking',
|
||||
'Assets:Savings',
|
||||
}
|
||||
|
||||
NON_REQUIRED_ACCOUNTS = {
|
||||
'Accrued:AccountsPayable',
|
||||
'Assets:PrepaidExpenses',
|
||||
'Assets:PrepaidVacation',
|
||||
'Expenses:Other',
|
||||
'Income:Other',
|
||||
'UnearnedIncome:Donations',
|
||||
}
|
||||
|
||||
CREDITCARD_ACCOUNT = 'Liabilities:CreditCard'
|
||||
|
||||
TEST_KEY = 'approval'
|
||||
|
||||
@pytest.fixture(scope='module')
|
||||
def hook():
|
||||
config = testutil.TestConfig()
|
||||
return meta_approval.MetaApproval(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 expected_msg in actual
|
||||
|
||||
@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 expected_msg in actual
|
||||
|
||||
@pytest.mark.parametrize('acct1,acct2', testutil.combine_values(
|
||||
REQUIRED_ACCOUNTS,
|
||||
NON_REQUIRED_ACCOUNTS,
|
||||
))
|
||||
def test_approval_not_required_on_credits(hook, acct1, acct2):
|
||||
txn = testutil.Transaction(postings=[
|
||||
(acct2, -25),
|
||||
(acct1, 25),
|
||||
])
|
||||
assert not list(hook.run(txn))
|
||||
|
||||
def test_approval_not_required_to_charge_credit_card(hook):
|
||||
txn = testutil.Transaction(postings=[
|
||||
('Expenses:Other', 25),
|
||||
(CREDITCARD_ACCOUNT, 25),
|
||||
])
|
||||
assert not list(hook.run(txn))
|
||||
|
||||
@pytest.mark.parametrize('acct', REQUIRED_ACCOUNTS)
|
||||
def test_approval_not_required_to_pay_credit_card(hook, acct):
|
||||
txn = testutil.Transaction(postings=[
|
||||
(acct, -25),
|
||||
(CREDITCARD_ACCOUNT, 25),
|
||||
])
|
||||
assert not list(hook.run(txn))
|
||||
Loading…
Reference in a new issue