Files
@ fdd9f2847b78
Branch filter:
Location: NPO-Accounting/conservancy_beancount/tests/test_meta_income_type.py
fdd9f2847b78
5.0 KiB
text/x-python
plugin: Skip enum value checks with a flag+FIXME.
We've long supported skipping documentation checks by flagging the
transaction. We haven't done the same for enumerated metadata because we
need it less often, and bad values tend to do more damage to reports.
However, occasionally when something very off-process happens, we do need it
as a matter of expediency. So support it.
In order to skip validation of these fields, the plugin requires that the
value start with the string "FIXME". This helps ensure that reports have a
consistent way to detect and warn about unfilled values in flagged
transactions.
We've long supported skipping documentation checks by flagging the
transaction. We haven't done the same for enumerated metadata because we
need it less often, and bad values tend to do more damage to reports.
However, occasionally when something very off-process happens, we do need it
as a matter of expediency. So support it.
In order to skip validation of these fields, the plugin requires that the
value start with the string "FIXME". This helps ensure that reports have a
consistent way to detect and warn about unfilled values in flagged
transactions.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 | """Test handling of income-type metadata"""
# Copyright © 2020 Brett Smith
# License: AGPLv3-or-later WITH Beancount-Plugin-Additional-Permission-1.0
#
# Full copyright and licensing details can be found at toplevel file
# LICENSE.txt in the repository.
import pytest
from . import testutil
from conservancy_beancount.plugin import meta_income_type
VALID_VALUES = {
'Donations': 'Donations',
'Payable-Derecognition': 'Payable-Derecognition',
'RBI': 'RBI',
'UBTI': 'UBTI',
}
INVALID_VALUES = {
'Dontion',
'Payble-Derecognitoin',
'RIB',
'UTBI',
'',
}
TEST_KEY = 'income-type'
@pytest.fixture(scope='module')
def hook():
config = testutil.TestConfig()
return meta_income_type.MetaIncomeType(config)
@pytest.mark.parametrize('src_value,set_value', VALID_VALUES.items())
def test_valid_values_on_postings(hook, src_value, set_value):
txn = testutil.Transaction(postings=[
('Assets:Cash', 25),
('Income:Other', -25, {TEST_KEY: src_value}),
])
errors = list(hook.run(txn))
assert not errors
testutil.check_post_meta(txn, None, {TEST_KEY: set_value})
@pytest.mark.parametrize('src_value', INVALID_VALUES)
def test_invalid_values_on_postings(hook, src_value):
txn = testutil.Transaction(postings=[
('Assets:Cash', 25),
('Income:Other', -25, {TEST_KEY: src_value}),
])
errors = list(hook.run(txn))
assert errors
testutil.check_post_meta(txn, None, {TEST_KEY: src_value})
@pytest.mark.parametrize('src_value,set_value', VALID_VALUES.items())
def test_valid_values_on_transactions(hook, src_value, set_value):
txn = testutil.Transaction(**{TEST_KEY: src_value}, postings=[
('Assets:Cash', 25),
('Income:Other', -25),
])
errors = list(hook.run(txn))
assert not errors
testutil.check_post_meta(txn, None, {TEST_KEY: set_value})
@pytest.mark.parametrize('src_value', INVALID_VALUES)
def test_invalid_values_on_transactions(hook, src_value):
txn = testutil.Transaction(**{TEST_KEY: src_value}, postings=[
('Assets:Cash', 25),
('Income:Other', -25),
])
errors = list(hook.run(txn))
assert errors
testutil.check_post_meta(txn, None, None)
@pytest.mark.parametrize('account', [
'Assets:Cash',
'Assets:Receivable:Accounts',
'Equity:OpeningBalance',
'Expenses:Other',
'Liabilities:CreditCard',
'Liabilities:Payable:Vacation',
])
def test_non_income_accounts_skipped(hook, account):
meta = {TEST_KEY: 'RBI'}
txn = testutil.Transaction(postings=[
(account, 25),
('Income:Other', -25, meta.copy()),
])
errors = list(hook.run(txn))
assert not errors
testutil.check_post_meta(txn, None, meta)
@pytest.mark.parametrize('account,set_value', [
('Income:Conferences:Registrations', 'RBI'),
('Income:Conferences:Sponsorship', 'RBI'),
('Income:Donations', 'Donations'),
('Income:Honoraria', 'RBI'),
('Income:Interest', 'RBI'),
('Income:Interest:Dividend', 'RBI'),
('Income:Royalties', 'RBI'),
('Income:Sales', 'RBI'),
('Income:SoftwareDevelopment', 'RBI'),
('Income:TrademarkLicensing', 'RBI'),
('Income:TrademarkSales', 'RBI'),
])
def test_default_values(hook, account, set_value):
txn = testutil.Transaction(postings=[
('Assets:Cash', 25),
(account, -25),
])
errors = list(hook.run(txn))
assert not errors
testutil.check_post_meta(txn, None, {TEST_KEY: set_value})
@pytest.mark.parametrize('account', [
'Income:Other',
])
def test_no_default_value(hook, account):
txn = testutil.Transaction(postings=[
('Assets:Cash', 25),
(account, -25),
])
errors = list(hook.run(txn))
assert errors
testutil.check_post_meta(txn, None, None)
@pytest.mark.parametrize('date,set_value', [
(testutil.EXTREME_FUTURE_DATE, None),
(testutil.FUTURE_DATE, 'Donations'),
(testutil.FY_START_DATE, 'Donations'),
(testutil.FY_MID_DATE, 'Donations'),
(testutil.PAST_DATE, None),
])
def test_default_value_set_in_date_range(hook, date, set_value):
txn = testutil.Transaction(date=date, postings=[
('Assets:Cash', 25),
('Income:Donations', -25),
])
errors = list(hook.run(txn))
assert not errors
expect_meta = None if set_value is None else {TEST_KEY: set_value}
testutil.check_post_meta(txn, None, expect_meta)
@pytest.mark.parametrize('src_value', INVALID_VALUES)
def test_flagged_txn_checked(hook, src_value):
txn = testutil.Transaction(flag='!', postings=[
('Assets:Cash', 25),
('Income:Other', -25, {TEST_KEY: src_value}),
])
errors = list(hook.run(txn))
assert errors
testutil.check_post_meta(txn, None, {TEST_KEY: src_value})
@pytest.mark.parametrize('src_value', testutil.FIXME_VALUES)
def test_flagged_fixme_ok(hook, src_value):
txn = testutil.Transaction(flag='!', postings=[
('Assets:Cash', 25),
('Income:Other', -25, {TEST_KEY: src_value}),
])
errors = list(hook.run(txn))
assert not errors
testutil.check_post_meta(txn, None, {TEST_KEY: src_value})
|