2020-03-15 14:36:49 +00:00
|
|
|
"""Test handling of tax-implication metadata"""
|
2020-03-05 20:48:10 +00:00
|
|
|
# Copyright © 2020 Brett Smith
|
2021-01-08 21:57:43 +00:00
|
|
|
# License: AGPLv3-or-later WITH Beancount-Plugin-Additional-Permission-1.0
|
2020-03-05 20:48:10 +00:00
|
|
|
#
|
2021-01-08 21:57:43 +00:00
|
|
|
# Full copyright and licensing details can be found at toplevel file
|
|
|
|
# LICENSE.txt in the repository.
|
2020-03-05 20:48:10 +00:00
|
|
|
|
|
|
|
import pytest
|
|
|
|
|
|
|
|
from . import testutil
|
|
|
|
|
|
|
|
from conservancy_beancount.plugin import meta_tax_implication
|
|
|
|
|
|
|
|
VALID_VALUES = {
|
2020-07-28 20:41:34 +00:00
|
|
|
'1099': '1099-NEC',
|
|
|
|
'1099-NEC': '1099-NEC',
|
|
|
|
'1099nec': '1099-NEC',
|
|
|
|
'1099-MISC-Other': '1099-MISC-Other',
|
|
|
|
'1099misc-other': '1099-MISC-Other',
|
2020-03-05 20:48:10 +00:00
|
|
|
'Bank-Transfer': 'Bank-Transfer',
|
2020-05-01 19:54:40 +00:00
|
|
|
'Chargeback': 'Chargeback',
|
2020-03-05 20:48:10 +00:00
|
|
|
'Foreign-Corporation': 'Foreign-Corporation',
|
2021-01-18 20:49:39 +00:00
|
|
|
'foreign-corp': 'Foreign-Corporation',
|
2021-01-18 20:45:31 +00:00
|
|
|
'Foreign-Grantee': 'Foreign-Grantee',
|
2020-03-05 20:48:10 +00:00
|
|
|
'Foreign-Individual-Contractor': 'Foreign-Individual-Contractor',
|
|
|
|
'Loan': 'Loan',
|
|
|
|
'Refund': 'Refund',
|
|
|
|
'Reimbursement': 'Reimbursement',
|
|
|
|
'Retirement-Pretax': 'Retirement-Pretax',
|
|
|
|
'Tax-Payment': 'Tax-Payment',
|
|
|
|
'USA-501c3': 'USA-501c3',
|
|
|
|
'USA-Corporation': 'USA-Corporation',
|
2021-01-18 20:49:39 +00:00
|
|
|
'us-corp': 'USA-Corporation',
|
2021-01-18 20:45:31 +00:00
|
|
|
'USA-Grantee': 'USA-Grantee',
|
|
|
|
'US-Grantee': 'USA-Grantee',
|
2020-03-05 20:48:10 +00:00
|
|
|
'W2': 'W2',
|
|
|
|
}
|
|
|
|
|
|
|
|
INVALID_VALUES = {
|
|
|
|
'199',
|
|
|
|
'W3',
|
|
|
|
'Payrol',
|
|
|
|
'',
|
|
|
|
}
|
|
|
|
|
2020-03-15 14:36:49 +00:00
|
|
|
TEST_KEY = 'tax-implication'
|
|
|
|
|
2020-03-19 19:04:53 +00:00
|
|
|
@pytest.fixture(scope='module')
|
|
|
|
def hook():
|
2020-03-19 21:23:27 +00:00
|
|
|
config = testutil.TestConfig()
|
|
|
|
return meta_tax_implication.MetaTaxImplication(config)
|
2020-03-19 19:04:53 +00:00
|
|
|
|
2020-03-05 20:48:10 +00:00
|
|
|
@pytest.mark.parametrize('src_value,set_value', VALID_VALUES.items())
|
2020-03-19 19:04:53 +00:00
|
|
|
def test_valid_values_on_postings(hook, src_value, set_value):
|
2020-03-05 20:48:10 +00:00
|
|
|
txn = testutil.Transaction(postings=[
|
2020-04-03 14:34:10 +00:00
|
|
|
('Liabilities:Payable:Accounts', 25),
|
2020-03-15 14:36:49 +00:00
|
|
|
('Assets:Cash', -25, {TEST_KEY: src_value}),
|
2020-03-05 20:48:10 +00:00
|
|
|
])
|
2020-03-19 19:04:53 +00:00
|
|
|
errors = list(hook.run(txn))
|
2020-03-05 20:48:10 +00:00
|
|
|
assert not errors
|
2020-03-16 14:15:31 +00:00
|
|
|
testutil.check_post_meta(txn, None, {TEST_KEY: set_value})
|
2020-03-05 20:48:10 +00:00
|
|
|
|
|
|
|
@pytest.mark.parametrize('src_value', INVALID_VALUES)
|
2020-03-19 19:04:53 +00:00
|
|
|
def test_invalid_values_on_postings(hook, src_value):
|
2020-03-05 20:48:10 +00:00
|
|
|
txn = testutil.Transaction(postings=[
|
2020-04-03 14:34:10 +00:00
|
|
|
('Liabilities:Payable:Accounts', 25),
|
2020-03-15 14:36:49 +00:00
|
|
|
('Assets:Cash', -25, {TEST_KEY: src_value}),
|
2020-03-05 20:48:10 +00:00
|
|
|
])
|
2020-03-19 19:04:53 +00:00
|
|
|
errors = list(hook.run(txn))
|
2020-03-05 20:48:10 +00:00
|
|
|
assert errors
|
2020-03-16 14:15:31 +00:00
|
|
|
testutil.check_post_meta(txn, None, {TEST_KEY: src_value})
|
2020-03-05 20:48:10 +00:00
|
|
|
|
|
|
|
@pytest.mark.parametrize('src_value,set_value', VALID_VALUES.items())
|
2020-03-19 19:04:53 +00:00
|
|
|
def test_valid_values_on_transactions(hook, src_value, set_value):
|
2020-03-15 14:36:49 +00:00
|
|
|
txn = testutil.Transaction(**{TEST_KEY: src_value}, postings=[
|
2020-04-03 14:34:10 +00:00
|
|
|
('Liabilities:Payable:Accounts', 25),
|
2020-03-05 20:48:10 +00:00
|
|
|
('Assets:Cash', -25),
|
|
|
|
])
|
2020-03-19 19:04:53 +00:00
|
|
|
errors = list(hook.run(txn))
|
2020-03-05 20:48:10 +00:00
|
|
|
assert not errors
|
2020-03-16 14:15:31 +00:00
|
|
|
testutil.check_post_meta(txn, None, {TEST_KEY: set_value})
|
2020-03-05 20:48:10 +00:00
|
|
|
|
|
|
|
@pytest.mark.parametrize('src_value', INVALID_VALUES)
|
2020-03-19 19:04:53 +00:00
|
|
|
def test_invalid_values_on_transactions(hook, src_value):
|
2020-03-15 14:36:49 +00:00
|
|
|
txn = testutil.Transaction(**{TEST_KEY: src_value}, postings=[
|
2020-04-03 14:34:10 +00:00
|
|
|
('Liabilities:Payable:Accounts', 25),
|
2020-03-05 20:48:10 +00:00
|
|
|
('Assets:Cash', -25),
|
|
|
|
])
|
2020-03-19 19:04:53 +00:00
|
|
|
errors = list(hook.run(txn))
|
2020-03-05 20:48:10 +00:00
|
|
|
assert errors
|
2020-03-16 14:15:31 +00:00
|
|
|
testutil.check_post_meta(txn, None, None)
|
2020-03-05 20:48:10 +00:00
|
|
|
|
2020-04-03 14:34:10 +00:00
|
|
|
@pytest.mark.parametrize('count,account', enumerate([
|
|
|
|
'Assets:Payable:Accounts',
|
|
|
|
'Assets:Prepaid:Expenses',
|
|
|
|
'Equity:OpeningBalance',
|
|
|
|
'Expenses:Other',
|
|
|
|
'Income:Other',
|
2020-03-05 20:48:10 +00:00
|
|
|
'Liabilities:CreditCard',
|
2020-04-03 14:34:10 +00:00
|
|
|
'Liabilities:Payable:Accounts',
|
|
|
|
'Liabilities:UnearnedIncome:Donations',
|
|
|
|
], 1))
|
|
|
|
def test_non_payment_accounts_skipped(hook, account, count):
|
|
|
|
amount = count * 100
|
2020-03-16 14:15:31 +00:00
|
|
|
meta = {TEST_KEY: 'USA-Corporation'}
|
2020-03-05 20:48:10 +00:00
|
|
|
txn = testutil.Transaction(postings=[
|
2020-04-03 14:34:10 +00:00
|
|
|
(account, amount),
|
|
|
|
('Assets:Checking', -amount, meta.copy()),
|
2020-03-05 20:48:10 +00:00
|
|
|
])
|
2020-03-19 19:04:53 +00:00
|
|
|
errors = list(hook.run(txn))
|
2020-03-05 20:48:10 +00:00
|
|
|
assert not errors
|
2020-03-16 14:15:31 +00:00
|
|
|
testutil.check_post_meta(txn, None, meta)
|
2020-03-05 20:48:10 +00:00
|
|
|
|
2020-05-22 01:57:29 +00:00
|
|
|
def test_asset_credits_skipped(hook):
|
2020-03-05 20:48:10 +00:00
|
|
|
txn = testutil.Transaction(postings=[
|
|
|
|
('Income:Donations', -25),
|
|
|
|
('Assets:Cash', 25),
|
|
|
|
])
|
2020-03-19 19:04:53 +00:00
|
|
|
errors = list(hook.run(txn))
|
2020-03-05 20:48:10 +00:00
|
|
|
assert not errors
|
2020-03-16 14:15:31 +00:00
|
|
|
testutil.check_post_meta(txn, None, None)
|
2020-03-05 20:48:10 +00:00
|
|
|
|
|
|
|
@pytest.mark.parametrize('date,need_value', [
|
|
|
|
(testutil.EXTREME_FUTURE_DATE, False),
|
|
|
|
(testutil.FUTURE_DATE, True),
|
|
|
|
(testutil.FY_START_DATE, True),
|
|
|
|
(testutil.FY_MID_DATE, True),
|
|
|
|
(testutil.PAST_DATE, False),
|
|
|
|
])
|
2020-03-19 19:04:53 +00:00
|
|
|
def test_validation_only_in_date_range(hook, date, need_value):
|
2020-03-05 20:48:10 +00:00
|
|
|
txn = testutil.Transaction(date=date, postings=[
|
|
|
|
('Liabilites:CreditCard', 25),
|
|
|
|
('Assets:Cash', -25),
|
|
|
|
])
|
2020-03-19 19:04:53 +00:00
|
|
|
errors = list(hook.run(txn))
|
2020-03-05 20:48:10 +00:00
|
|
|
assert bool(errors) == bool(need_value)
|
2020-03-16 14:15:31 +00:00
|
|
|
testutil.check_post_meta(txn, None, None)
|
2020-05-22 01:58:48 +00:00
|
|
|
|
|
|
|
@pytest.mark.parametrize('src_value', INVALID_VALUES)
|
2021-01-29 14:38:37 +00:00
|
|
|
def test_flagged_txn_checked(hook, src_value):
|
2020-05-22 01:58:48 +00:00
|
|
|
txn = testutil.Transaction(flag='!', **{TEST_KEY: src_value}, postings=[
|
|
|
|
('Liabilities:Payable:Accounts', 25),
|
|
|
|
('Assets:Cash', -25),
|
|
|
|
])
|
2021-01-29 14:38:37 +00:00
|
|
|
assert list(hook.run(txn))
|
|
|
|
|
|
|
|
@pytest.mark.parametrize('src_value', testutil.FIXME_VALUES)
|
|
|
|
def test_flagged_fixme_ok(hook, src_value):
|
|
|
|
txn = testutil.Transaction(flag='!', postings=[
|
|
|
|
('Liabilities:Payable:Accounts', 25),
|
|
|
|
('Assets:Cash', -25, {TEST_KEY: src_value}),
|
|
|
|
])
|
2020-05-22 01:58:48 +00:00
|
|
|
assert not list(hook.run(txn))
|
2021-01-29 14:38:37 +00:00
|
|
|
testutil.check_post_meta(txn, None, {TEST_KEY: src_value})
|