Files
@ f8758e28473d
Branch filter:
Location: NPO-Accounting/conservancy_beancount/tests/test_meta_rt_links.py
f8758e28473d
5.5 KiB
text/x-python
audit_report: More docstring.
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 169 170 171 172 173 174 175 176 | """Test link checker for RT links"""
# 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 itertools
import pytest
from . import testutil
from conservancy_beancount import errors as errormod
from conservancy_beancount.plugin import meta_rt_links
METADATA_KEYS = [
'approval',
'bank-statement',
'check',
'contract',
'invoice',
'purchase-order',
'receipt',
'rt-id',
'statement',
'tax-statement',
]
GOOD_LINKS = [
'rt:1',
'rt:1/5',
'rt://ticket/2',
'rt://ticket/3/attachments/15',
]
MALFORMED_LINKS = [
'rt:one',
'rt:two/three',
'rt://4',
'rt://ticket/5/attach/6',
]
NOT_FOUND_LINKS = [
'rt:1/10',
'rt:10',
'rt://ticket/9',
'rt://ticket/3/attachments/99',
]
MALFORMED_MSG = '{} link is malformed: {}'.format
NOT_FOUND_MSG = '{} not found in RT: {}'.format
def build_meta(keys=None, *sources):
if keys is None:
keys = iter(METADATA_KEYS)
sources = (itertools.cycle(src) for src in sources)
return {key: ' '.join(str(x) for x in rest)
for key, *rest in zip(keys, *sources)}
@pytest.fixture(scope='module')
def hook():
config = testutil.TestConfig(rt_client=testutil.RTClient())
return meta_rt_links.MetaRTLinks(config)
def test_error_with_no_rt():
config = testutil.TestConfig()
with pytest.raises(errormod.ConfigurationError):
meta_rt_links.MetaRTLinks(config)
def test_good_txn_links(hook):
meta = build_meta(None, GOOD_LINKS)
txn = testutil.Transaction(**meta, postings=[
('Income:Donations', -5),
('Assets:Cash', 5),
])
assert not list(hook.run(txn))
def test_good_post_links(hook):
meta = build_meta(None, GOOD_LINKS)
txn = testutil.Transaction(postings=[
('Income:Donations', -5, meta),
('Assets:Cash', 5),
])
assert not list(hook.run(txn))
@pytest.mark.parametrize('link_source,format_error', [
(MALFORMED_LINKS, MALFORMED_MSG),
(NOT_FOUND_LINKS, NOT_FOUND_MSG),
])
def test_bad_txn_links(hook, link_source, format_error):
meta = build_meta(None, link_source)
txn = testutil.Transaction(**meta, postings=[
('Income:Donations', -5),
('Assets:Cash', 5),
])
expected = {format_error(key, value) for key, value in meta.items()}
actual = {error.message for error in hook.run(txn)}
assert expected == actual
@pytest.mark.parametrize('link_source,format_error', [
(MALFORMED_LINKS, MALFORMED_MSG),
(NOT_FOUND_LINKS, NOT_FOUND_MSG),
])
def test_bad_post_links(hook, link_source, format_error):
meta = build_meta(None, link_source)
txn = testutil.Transaction(postings=[
('Income:Donations', -5, meta.copy()),
('Assets:Cash', 5),
])
expected = {format_error(key, value) for key, value in meta.items()}
actual = {error.message for error in hook.run(txn)}
assert expected == actual
@pytest.mark.parametrize('value', testutil.NON_STRING_METADATA_VALUES)
def test_bad_metadata_type(hook, value):
txn = testutil.Transaction(**{'rt-id': value}, postings=[
('Income:Donations', -5),
('Assets:Cash', 5),
])
expected = {'transaction has wrong type of rt-id: expected str but is a {}'.format(
type(value).__name__,
)}
actual = {error.message for error in hook.run(txn)}
assert expected == actual
@pytest.mark.parametrize('ext_doc', [
'statement.txt',
'https://example.org/',
])
def test_docs_outside_rt_not_checked(hook, ext_doc):
txn = testutil.Transaction(
receipt='{} {} {}'.format(GOOD_LINKS[0], ext_doc, MALFORMED_LINKS[1]),
postings=[
('Income:Donations', -5),
('Assets:Cash', 5),
])
expected = {MALFORMED_MSG('receipt', MALFORMED_LINKS[1])}
actual = {error.message for error in hook.run(txn)}
assert expected == actual
def test_flagged_txn_not_checked(hook):
txn_meta = build_meta(None, MALFORMED_LINKS)
txn_meta['flag'] = '!'
keys = iter(METADATA_KEYS)
txn = testutil.Transaction(**txn_meta, postings=[
('Income:Donations', -5, build_meta(keys, MALFORMED_LINKS)),
('Assets:Checking', 5, build_meta(keys, NOT_FOUND_LINKS)),
])
assert not list(hook.run(txn))
def test_mixed_results(hook):
txn = testutil.Transaction(
approval='{} {}'.format(*GOOD_LINKS),
contract='{} {}'.format(MALFORMED_LINKS[0], GOOD_LINKS[1]),
postings=[
('Income:Donations', -5, {'invoice': '{} {}'.format(*NOT_FOUND_LINKS)}),
('Assets:Cash', 5, {'statement': '{} {}'.format(GOOD_LINKS[0], MALFORMED_LINKS[1])}),
])
expected = {
MALFORMED_MSG('contract', MALFORMED_LINKS[0]),
NOT_FOUND_MSG('invoice', NOT_FOUND_LINKS[0]),
NOT_FOUND_MSG('invoice', NOT_FOUND_LINKS[1]),
MALFORMED_MSG('statement', MALFORMED_LINKS[1]),
}
actual = {error.message for error in hook.run(txn)}
assert expected == actual
|