2020-03-29 15:14:51 +00:00
|
|
|
"""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 = {
|
2020-04-03 14:34:10 +00:00
|
|
|
'Assets:Bank:Checking',
|
2020-03-29 15:14:51 +00:00
|
|
|
'Assets:Cash',
|
|
|
|
'Assets:Savings',
|
|
|
|
}
|
|
|
|
|
|
|
|
NON_REQUIRED_ACCOUNTS = {
|
2020-04-03 14:34:10 +00:00
|
|
|
'Assets:Prepaid:Expenses',
|
2020-04-07 19:45:29 +00:00
|
|
|
# Receivables are checked by meta_receivable_documentation
|
2020-04-03 14:34:10 +00:00
|
|
|
'Assets:Receivable:Accounts',
|
|
|
|
'Equity:QpeningBalance',
|
2020-03-29 15:14:51 +00:00
|
|
|
'Expenses:Other',
|
|
|
|
'Income:Other',
|
2020-04-07 19:45:29 +00:00
|
|
|
# Payables are checked by meta_payable_documentation
|
|
|
|
'Liabilities:Payable:Accounts',
|
2020-04-05 18:43:54 +00:00
|
|
|
'Liabilities:Payable:Vacation',
|
|
|
|
'Liabilities:UnearnedIncome:Donations',
|
2020-03-29 15:14:51 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
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))
|
|
|
|
|
2020-04-05 18:43:54 +00:00
|
|
|
def test_approval_not_required_to_pay_credit_card(hook):
|
2020-03-29 15:14:51 +00:00
|
|
|
txn = testutil.Transaction(postings=[
|
2020-04-05 18:43:54 +00:00
|
|
|
('Assets:Checking', -25),
|
2020-03-29 15:14:51 +00:00
|
|
|
(CREDITCARD_ACCOUNT, 25),
|
|
|
|
])
|
|
|
|
assert not list(hook.run(txn))
|
2020-04-05 18:49:39 +00:00
|
|
|
|
2020-05-01 20:24:24 +00:00
|
|
|
@pytest.mark.parametrize('tax_implication,other_acct', [
|
|
|
|
('Bank-Transfer', 'Assets:Savings'),
|
|
|
|
('Chargeback', 'Income:Donations'),
|
|
|
|
])
|
|
|
|
def test_approval_not_required_for_asset_transfers(hook, tax_implication, other_acct):
|
2020-04-05 18:49:39 +00:00
|
|
|
txn = testutil.Transaction(postings=[
|
2020-05-01 20:24:24 +00:00
|
|
|
('Assets:Checking', -250, {'tax-implication': tax_implication}),
|
|
|
|
(other_acct, 250),
|
2020-04-05 18:49:39 +00:00
|
|
|
])
|
|
|
|
assert not list(hook.run(txn))
|
|
|
|
|
|
|
|
def test_approval_required_for_partial_transfer(hook):
|
|
|
|
# I'm not sure this ever comes up in reality, but just being thorough
|
|
|
|
# out of an abundance of precaution.
|
|
|
|
txn = testutil.Transaction(postings=[
|
|
|
|
('Assets:Checking', -250, {'tax-implication': 'Bank-Transfer'}),
|
|
|
|
('Assets:Savings', 225),
|
|
|
|
('Expenses:BankingFees', 25),
|
|
|
|
])
|
|
|
|
actual = {error.message for error in hook.run(txn)}
|
|
|
|
assert actual == {"Assets:Checking missing {}".format(TEST_KEY)}
|