Files @ fdd9f2847b78
Branch filter:

Location: NPO-Accounting/conservancy_beancount/tests/test_meta_expense_type.py - annotation

Brett Smith
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.
123508ef8882
786291902231
1b7fdf4f3b00
786291902231
1b7fdf4f3b00
1b7fdf4f3b00
786291902231
786291902231
786291902231
786291902231
786291902231
123508ef8882
786291902231
2ac434b61639
2ac434b61639
2ac434b61639
123508ef8882
123508ef8882
123508ef8882
123508ef8882
2ac434b61639
2ac434b61639
2ac434b61639
a1ec25a33de4
123508ef8882
a1ec25a33de4
2ac434b61639
123508ef8882
2ac434b61639
2ac434b61639
123508ef8882
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
c9ff4ab74617
501bd251cbf3
501bd251cbf3
0d370c445b9e
123508ef8882
501bd251cbf3
2ac434b61639
501bd251cbf3
786291902231
786291902231
c9ff4ab74617
2ac434b61639
501bd251cbf3
2ac434b61639
e7720b8fb866
2ac434b61639
2ac434b61639
501bd251cbf3
2ac434b61639
2ac434b61639
c9ff4ab74617
2ac434b61639
501bd251cbf3
2ac434b61639
e7720b8fb866
2ac434b61639
2ac434b61639
501bd251cbf3
c9ff4ab74617
2ac434b61639
2ac434b61639
2ac434b61639
501bd251cbf3
2ac434b61639
e7720b8fb866
2ac434b61639
2ac434b61639
501bd251cbf3
c9ff4ab74617
2ac434b61639
2ac434b61639
786291902231
501bd251cbf3
2ac434b61639
e7720b8fb866
d436a388f7fb
d436a388f7fb
d436a388f7fb
c712105bed3c
c712105bed3c
c712105bed3c
d436a388f7fb
c712105bed3c
d436a388f7fb
501bd251cbf3
e7720b8fb866
d436a388f7fb
d436a388f7fb
e7720b8fb866
d436a388f7fb
501bd251cbf3
d436a388f7fb
e7720b8fb866
34090df23f06
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
34090df23f06
95fb8ce4815e
34090df23f06
34090df23f06
95fb8ce4815e
95fb8ce4815e
34090df23f06
501bd251cbf3
34090df23f06
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
95fb8ce4815e
16c47c64b23d
16c47c64b23d
e7720b8fb866
e7720b8fb866
e7720b8fb866
e7720b8fb866
e7720b8fb866
16c47c64b23d
501bd251cbf3
16c47c64b23d
16c47c64b23d
16c47c64b23d
16c47c64b23d
501bd251cbf3
16c47c64b23d
e7720b8fb866
e7720b8fb866
552ef45f47df
552ef45f47df
552ef45f47df
552ef45f47df
552ef45f47df
552ef45f47df
552ef45f47df
552ef45f47df
552ef45f47df
552ef45f47df
fdd9f2847b78
fdd9f2847b78
fdd9f2847b78
fdd9f2847b78
fdd9f2847b78
fdd9f2847b78
fdd9f2847b78
fdd9f2847b78
fdd9f2847b78
fdd9f2847b78
"""Test handling of expense-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_expense_type

VALID_VALUES = {
    'program': 'program',
    'fundraising': 'fundraising',
    'management': 'management',
    'admin': 'management',
    'administration': 'management',
    'mgmt': 'management',
}

INVALID_VALUES = {
    'porgram',
    'mangement',
    'fundrasing',
    '',
    *testutil.NON_STRING_METADATA_VALUES,
}

TEST_KEY = 'expense-type'
PROJECT_KEY = 'project'
UNRESTRICTED_FUND = 'Conservancy'
RESTRICTED_FUND = 'Alpha'

@pytest.fixture(scope='module')
def hook():
    config = testutil.TestConfig()
    return meta_expense_type.MetaExpenseType(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),
        ('Expenses:General', 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),
        ('Expenses:General', 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),
        ('Expenses:General', 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),
        ('Expenses:General', 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',
    'Income:Other',
    'Liabilities:CreditCard',
    'Liabilities:Payable:Vacation',
])
def test_non_expense_accounts_skipped(hook, account):
    meta = {TEST_KEY: 'program'}
    txn = testutil.Transaction(postings=[
        (account, -25),
        ('Expenses:General', 25, meta.copy()),
    ])
    errors = list(hook.run(txn))
    assert not errors
    testutil.check_post_meta(txn, None, meta)

@pytest.mark.parametrize('account,exp_unrestricted,exp_restricted', [
    ('Expenses:Accounting', 'management', 'management'),
    ('Expenses:BadDebt', 'management', 'program'),
    ('Expenses:BankingFees', 'management', 'management'),
    ('Expenses:ComputerEquipment', 'management', 'program'),
    ('Expenses:Fines', 'management', 'program'),
    ('Expenses:FilingFees', 'management', 'program'),
    ('Expenses:Hosting', 'management', 'program'),
    ('Expenses:Insurance', 'management', 'management'),
    ('Expenses:Office', 'management', 'program'),
    ('Expenses:Other', 'management', 'program'),
    ('Expenses:Phones', 'management', 'program'),
    ('Expenses:Postage', 'management', 'program'),
    ('Expenses:ProfessionalMemberships', 'management', 'program'),
    ('Expenses:Services:Accounting', 'management', 'management'),
    ('Expenses:Services:Administration', 'management', 'management'),
    ('Expenses:Services:Advocacy', 'program', 'program'),
    ('Expenses:Services:Development', 'program', 'program'),
    ('Expenses:Services:Fundraising', 'fundraising', 'fundraising'),
    ('Expenses:Travel', 'management', 'management'),
])
def test_default_values(hook, account, exp_unrestricted, exp_restricted):
    txn = testutil.Transaction(postings=[
        ('Liabilites:CreditCard', -25),
        (account, 20, {PROJECT_KEY: UNRESTRICTED_FUND}),
        (account, 5, {PROJECT_KEY: RESTRICTED_FUND}),
    ])
    errors = list(hook.run(txn))
    assert not errors
    testutil.check_post_meta(
        txn, None,
        {TEST_KEY: exp_unrestricted, PROJECT_KEY: UNRESTRICTED_FUND},
        {TEST_KEY: exp_restricted, PROJECT_KEY: RESTRICTED_FUND},
    )

@pytest.mark.parametrize('date,set_value', [
    (testutil.EXTREME_FUTURE_DATE, None),
    (testutil.FUTURE_DATE, 'program'),
    (testutil.FY_START_DATE, 'program'),
    (testutil.FY_MID_DATE, 'program'),
    (testutil.PAST_DATE, None),
])
def test_default_value_set_in_date_range(hook, date, set_value):
    txn = testutil.Transaction(date=date, postings=[
        ('Liabilites:CreditCard', -25),
        ('Expenses:General', 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),
        ('Expenses:General', 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),
        ('Expenses:General', 25, {TEST_KEY: src_value}),
    ])
    errors = list(hook.run(txn))
    assert not errors
    testutil.check_post_meta(txn, None, {TEST_KEY: src_value})