conservancy_beancount/tests/test_meta_expense_allocation.py

"""Test handling of expense-allocation metadata"""
# Copyright © 2020  Brett Smith
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

import pytest

from . import testutil

from conservancy_beancount.plugin import meta_expense_allocation

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

INVALID_VALUES = {
    'invalid',
    'porgram',
    'adimn',
    'fundrasing',
    '',
}

TEST_KEY = 'expense-allocation'

@pytest.mark.parametrize('src_value,set_value', VALID_VALUES.items())
def test_valid_values_on_postings(src_value, set_value):
    txn = testutil.Transaction(postings=[
        ('Assets:Cash', -25),
        ('Expenses:General', 25, {TEST_KEY: src_value}),
    ])
    checker = meta_expense_allocation.MetaExpenseAllocation()
    errors = checker.run(txn, txn.postings[-1], -1)
    assert not errors
    assert txn.postings[-1].meta.get(TEST_KEY) == set_value

@pytest.mark.parametrize('src_value', INVALID_VALUES)
def test_invalid_values_on_postings(src_value):
    txn = testutil.Transaction(postings=[
        ('Assets:Cash', -25),
        ('Expenses:General', 25, {TEST_KEY: src_value}),
    ])
    checker = meta_expense_allocation.MetaExpenseAllocation()
    errors = checker.run(txn, txn.postings[-1], -1)
    assert errors

@pytest.mark.parametrize('src_value,set_value', VALID_VALUES.items())
def test_valid_values_on_transactions(src_value, set_value):
    txn = testutil.Transaction(**{TEST_KEY: src_value}, postings=[
        ('Assets:Cash', -25),
        ('Expenses:General', 25),
    ])
    checker = meta_expense_allocation.MetaExpenseAllocation()
    errors = checker.run(txn, txn.postings[-1], -1)
    assert not errors
    assert txn.postings[-1].meta.get(TEST_KEY) == set_value

@pytest.mark.parametrize('src_value', INVALID_VALUES)
def test_invalid_values_on_transactions(src_value):
    txn = testutil.Transaction(**{TEST_KEY: src_value}, postings=[
        ('Assets:Cash', -25),
        ('Expenses:General', 25),
    ])
    checker = meta_expense_allocation.MetaExpenseAllocation()
    errors = checker.run(txn, txn.postings[-1], -1)
    assert errors

@pytest.mark.parametrize('account', [
    'Accrued:AccountsReceivable',
    'Assets:Cash',
    'Income:Donations',
    'Liabilities:CreditCard',
    'UnearnedIncome:Donations',
])
def test_non_expense_accounts_skipped(account):
    txn = testutil.Transaction(postings=[
        (account, -25),
        ('Expenses:General', 25, {TEST_KEY: 'program'}),
    ])
    checker = meta_expense_allocation.MetaExpenseAllocation()
    errors = checker.run(txn, txn.postings[0], 0)
    assert not errors

@pytest.mark.parametrize('account,set_value', [
    ('Expenses:Services:Accounting', 'administration'),
    ('Expenses:Services:Administration', 'administration'),
    ('Expenses:Services:Advocacy', 'program'),
    ('Expenses:Services:Development', 'program'),
    ('Expenses:Services:Fundraising', 'fundraising'),
])
def test_default_values(account, set_value):
    txn = testutil.Transaction(postings=[
        ('Liabilites:CreditCard', -25),
        (account, 25),
    ])
    checker = meta_expense_allocation.MetaExpenseAllocation()
    errors = checker.run(txn, txn.postings[-1], -1)
    assert not errors
    assert txn.postings[-1].meta[TEST_KEY] == set_value

@pytest.mark.parametrize('date,set_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_default_value_set_in_date_range(date, set_value):
    txn = testutil.Transaction(date=date, postings=[
        ('Liabilites:CreditCard', -25),
        ('Expenses:General', 25),
    ])
    checker = meta_expense_allocation.MetaExpenseAllocation()
    errors = checker.run(txn, txn.postings[-1], -1)
    assert not errors
    got_value = (txn.postings[-1].meta or {}).get(TEST_KEY)
    assert bool(got_value) == bool(set_value)