Files @ c230f91ab7a7
Branch filter:

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

Brett Smith
meta_payroll_type: Add values for Exp:Pay:Benefits:Other.
"""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})