Files
@ c7fbf5b5d586
Branch filter:
Location: NPO-Accounting/conservancy_beancount/tests/test_meta_project.py
c7fbf5b5d586
5.5 KiB
text/x-python
config: s/XDG_CACHE_DIR/XDG_CACHE_HOME/g
Per the spec.
Per the spec.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 | """Test handling of project 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/>.
from pathlib import Path
import pytest
from . import testutil
from conservancy_beancount import errors as errormod
from conservancy_beancount.plugin import meta_project
VALID_VALUES = {
'Conservancy': 'Conservancy',
'Alpha': 'Alpha',
'Bravo': 'Bravo',
'Charles': 'Charlie',
'Chuck': 'Charlie',
}
INVALID_VALUES = {
'Alhpa',
'Yankee',
'',
}
TEST_KEY = 'project'
DEFAULT_VALUE = 'Conservancy'
@pytest.fixture(scope='module')
def hook():
config = testutil.TestConfig(repo_path='repository')
return meta_project.MetaProject(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,required', [
('Assets:Cash', False),
('Assets:Receivable:Accounts', True),
('Assets:Receivable:Loans', True),
('Equity:OpeningBalance', False),
('Equity:Funds:Restricted', True),
('Equity:Funds:Unrestricted', False),
('Expenses:General', True),
('Income:Donations', True),
('Liabilities:CreditCard', False),
('Liabilities:Payable:Accounts', True),
# We do want a "project" for Lia:Pay:Vacation but it has a default value
('Liabilities:Payable:Vacation', False),
('Liabilities:UnearnedIncome:Donations', True),
])
def test_which_accounts_required_on(hook, account, required):
txn = testutil.Transaction(postings=[
('Assets:Checking', 25),
(account, 25),
])
errors = list(hook.run(txn))
assert required == any(errors)
@pytest.mark.parametrize('account', [
'Expenses:Payroll:Salary',
'Expenses:Payroll:Tax',
'Liabilities:Payable:Vacation',
])
def test_default_values(hook, account):
txn = testutil.Transaction(postings=[
('Assets:Checking', -25),
(account, 25),
])
errors = list(hook.run(txn))
assert not errors
testutil.check_post_meta(txn, None, {TEST_KEY: DEFAULT_VALUE})
@pytest.mark.parametrize('date,required', [
(testutil.EXTREME_FUTURE_DATE, False),
(testutil.FUTURE_DATE, True),
(testutil.FY_START_DATE, True),
(testutil.FY_MID_DATE, True),
(testutil.PAST_DATE, None),
])
def test_default_value_set_in_date_range(hook, date, required):
txn = testutil.Transaction(date=date, postings=[
('Expenses:Payroll:Benefits', 25),
('Liabilities:Payable:Vacation', -25),
])
errors = list(hook.run(txn))
assert not errors
expect_meta = {TEST_KEY: DEFAULT_VALUE} if required else None
testutil.check_post_meta(txn, expect_meta, expect_meta)
@pytest.mark.parametrize('repo_path', [
None,
'..',
])
def test_missing_project_data(repo_path):
config = testutil.TestConfig(repo_path=repo_path)
with pytest.raises(errormod.ConfigurationError):
meta_project.MetaProject(config)
@pytest.mark.parametrize('repo_path_s,data_path_s', [
('repository', 'Projects/project-list.yml'),
('..', 'LICENSE.txt'),
])
def test_invalid_project_data(repo_path_s, data_path_s):
config = testutil.TestConfig(repo_path=repo_path_s)
with pytest.raises(errormod.ConfigurationError):
meta_project.MetaProject(config, Path(data_path_s))
def test_not_required_on_opening(hook):
txn = testutil.Transaction.opening_balance('Equity:Funds:Unrestricted')
assert not list(hook.run(txn))
def test_always_required_on_restricted_funds(hook):
acct = 'Equity:Funds:Restricted'
txn = testutil.Transaction.opening_balance(acct)
actual = {error.message for error in hook.run(txn)}
assert actual == {f'{acct} missing project'}
|