Files @ 6a3d64ff2250
Branch filter:

Location: NPO-Accounting/conservancy_beancount/tests/test_meta_tax_implication.py

Brett Smith
fields: Change FieldType capitalization.

This is friendlier to the YAML input and consistent with FieldFlags.
Less consistent with the rest of the codebase, but local consistency matters
more IMO.
"""Test handling of tax-implication 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_tax_implication

VALID_VALUES = {
    '1099': '1099-NEC',
    '1099-NEC': '1099-NEC',
    '1099nec': '1099-NEC',
    '1099-MISC-Other': '1099-MISC-Other',
    '1099misc-other': '1099-MISC-Other',
    'Bank-Transfer': 'Bank-Transfer',
    'Chargeback': 'Chargeback',
    'Foreign-Corporation': 'Foreign-Corporation',
    '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',
    'W2': 'W2',
}

INVALID_VALUES = {
    '199',
    'W3',
    'Payrol',
    '',
}

TEST_KEY = 'tax-implication'

@pytest.fixture(scope='module')
def hook():
    config = testutil.TestConfig()
    return meta_tax_implication.MetaTaxImplication(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=[
        ('Liabilities:Payable:Accounts', 25),
        ('Assets:Cash', -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=[
        ('Liabilities:Payable:Accounts', 25),
        ('Assets:Cash', -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=[
        ('Liabilities:Payable:Accounts', 25),
        ('Assets:Cash', -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=[
        ('Liabilities:Payable:Accounts', 25),
        ('Assets:Cash', -25),
    ])
    errors = list(hook.run(txn))
    assert errors
    testutil.check_post_meta(txn, None, None)

@pytest.mark.parametrize('count,account', enumerate([
    'Assets:Payable:Accounts',
    'Assets:Prepaid:Expenses',
    'Equity:OpeningBalance',
    'Expenses:Other',
    'Income:Other',
    'Liabilities:CreditCard',
    'Liabilities:Payable:Accounts',
    'Liabilities:UnearnedIncome:Donations',
], 1))
def test_non_payment_accounts_skipped(hook, account, count):
    amount = count * 100
    meta = {TEST_KEY: 'USA-Corporation'}
    txn = testutil.Transaction(postings=[
        (account, amount),
        ('Assets:Checking', -amount, meta.copy()),
    ])
    errors = list(hook.run(txn))
    assert not errors
    testutil.check_post_meta(txn, None, meta)

def test_asset_credits_skipped(hook):
    txn = testutil.Transaction(postings=[
        ('Income:Donations', -25),
        ('Assets:Cash', 25),
    ])
    errors = list(hook.run(txn))
    assert not errors
    testutil.check_post_meta(txn, None, None)

@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),
])
def test_validation_only_in_date_range(hook, date, need_value):
    txn = testutil.Transaction(date=date, postings=[
        ('Liabilites:CreditCard', 25),
        ('Assets:Cash', -25),
    ])
    errors = list(hook.run(txn))
    assert bool(errors) == bool(need_value)
    testutil.check_post_meta(txn, None, None)

@pytest.mark.parametrize('src_value', INVALID_VALUES)
def test_flagged_txn_skipped(hook, src_value):
    txn = testutil.Transaction(flag='!', **{TEST_KEY: src_value}, postings=[
        ('Liabilities:Payable:Accounts', 25),
        ('Assets:Cash', -25),
    ])
    assert not list(hook.run(txn))