Files
@ 97a05003f345
Branch filter:
Location: NPO-Accounting/conservancy_beancount/tests/test_books_loader.py - annotation
97a05003f345
9.2 KiB
text/x-python
reconcile: Fix linter warnings.
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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 | 855c1c2bf025 855c1c2bf025 1b7fdf4f3b00 855c1c2bf025 1b7fdf4f3b00 1b7fdf4f3b00 855c1c2bf025 9595d3334d5b f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 072937eff508 96a363633f5e 855c1c2bf025 855c1c2bf025 855c1c2bf025 855c1c2bf025 855c1c2bf025 855c1c2bf025 855c1c2bf025 9595d3334d5b f3c3ebcf59e2 855c1c2bf025 2bd3e8b462d2 2bd3e8b462d2 072937eff508 855c1c2bf025 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 855c1c2bf025 855c1c2bf025 2bd3e8b462d2 855c1c2bf025 9595d3334d5b 9595d3334d5b 9595d3334d5b 9595d3334d5b 9595d3334d5b 9595d3334d5b 9595d3334d5b 9595d3334d5b 2bd3e8b462d2 fea306b2783f 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 9595d3334d5b f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 f3c3ebcf59e2 aa488effb0f5 aa488effb0f5 aa488effb0f5 aa488effb0f5 aa488effb0f5 aa488effb0f5 aa488effb0f5 aa488effb0f5 aa488effb0f5 aa488effb0f5 aa488effb0f5 aa488effb0f5 855c1c2bf025 aa488effb0f5 aa488effb0f5 072937eff508 5601ece2ac43 5601ece2ac43 5601ece2ac43 aa488effb0f5 aa488effb0f5 aa488effb0f5 9595d3334d5b 072937eff508 96a363633f5e 96a363633f5e 072937eff508 96a363633f5e f3c3ebcf59e2 9595d3334d5b 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 5601ece2ac43 5601ece2ac43 5601ece2ac43 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 2bd3e8b462d2 9595d3334d5b 9595d3334d5b 5601ece2ac43 5601ece2ac43 5601ece2ac43 a23d075add0e a23d075add0e a23d075add0e a23d075add0e a23d075add0e a23d075add0e a23d075add0e a23d075add0e a23d075add0e a23d075add0e a23d075add0e a23d075add0e a23d075add0e a23d075add0e 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe 3721226d17fe | """test_books_loader - Unit tests for books Loader class"""
# 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 collections
import io
import itertools
import os
import re
from datetime import date
from pathlib import Path
import pytest
from . import testutil
from beancount.core import data as bc_data
from conservancy_beancount import books, data
FY_START_MONTH = 3
books_path = testutil.test_path('books')
class MockError(Exception):
def __init__(self, message, lineno=0):
self.message = message
self.entry = None
self.source = {'filename': 'test_books_loader.py', 'lineno': lineno}
class MockSearchTerm:
def __init__(self, pred):
self.pred = pred
def filter_postings(self, postings):
return (post for post in postings if self.pred(post))
rewrite = filter_postings
SEARCH_TERMS = [
MockSearchTerm(lambda post: post.account.startswith('Expenses:')),
MockSearchTerm(lambda post: post.units.number >= 10),
]
clean_account_meta = pytest.fixture()(testutil.clean_account_meta)
@pytest.fixture(scope='module')
def conservancy_loader():
return books.Loader(books_path, books.FiscalYear(FY_START_MONTH))
def check_openings(entries):
openings = collections.defaultdict(int)
for entry in entries:
if isinstance(entry, bc_data.Open):
openings[entry.account] += 1
for account, count in openings.items():
assert count == 1, f"found {count} open directives for {account}"
def txn_dates(entries):
for entry in entries:
if isinstance(entry, bc_data.Transaction):
yield entry.date
def txn_years(entries):
return frozenset(date.year for date in txn_dates(entries))
def test_load_result_returncode_ok():
options_map = {'filename': 'test_load_result_returncode_ok'}
result = books.LoadResult([testutil.Transaction()], [], options_map)
assert result.returncode() == 0
def test_load_result_beancount_errors():
error = MockError("empty transaction", lineno=65)
options_map = dict(error.source)
result = books.LoadResult([testutil.Transaction()], [error], options_map)
assert 10 <= result.returncode() < 64
def test_load_result_config_error():
error = MockError("no books available")
result = books.LoadResult.empty(error)
assert result.returncode() == os.EX_CONFIG
def test_load_result_no_entries():
result = books.LoadResult.empty()
assert result.returncode() == os.EX_NOINPUT
@pytest.mark.parametrize('arg_index,end_index', itertools.product(
range(2),
range(len(SEARCH_TERMS)),
))
def test_load_result_iter_postings_one_filter_set(arg_index, end_index):
txn = testutil.Transaction(postings=[
('Expenses:Other', 20),
('Expenses:BankingFees', 2),
('Assets:Checking', -22),
])
result = books.LoadResult.empty()
result.entries.append(txn)
args = (SEARCH_TERMS[:end_index], ())
if arg_index:
args = (args[1], args[0])
actual = list(result.iter_postings(*args))
expected = txn.postings[:-end_index or None]
assert len(actual) == len(expected)
for act_post, exp_post in zip(actual, expected):
assert act_post.account == exp_post.account
assert act_post.units == exp_post.units
def test_load_result_iter_postings_both_filter_sets():
txn = testutil.Transaction(postings=[
('Expenses:Other', 20),
('Expenses:BankingFees', 2),
('Assets:Checking', -22),
])
result = books.LoadResult.empty()
result.entries.append(txn)
actual = list(result.iter_postings(SEARCH_TERMS[:1], SEARCH_TERMS[1:]))
assert len(actual) == 1
assert actual[0].account == txn.postings[0].account
assert actual[0].units == txn.postings[0].units
def test_load_result_account_metadata(clean_account_meta):
accounts = ['Assets:Checking', 'Assets:Savings']
result = books.LoadResult.empty()
result.options_map['name_liabilities'] = 'Problems'
result.entries.extend(
bc_data.Open({}, date(2017, 3, day), name, None, None)
for day, name in enumerate(accounts, 1)
)
result.load_account_metadata()
for day, name in enumerate(accounts, 1):
assert data.Account(name).meta.open_date == date(2017, 3, day)
@pytest.mark.parametrize('count', range(3))
def test_print_errors(count):
error_lines = [75 + n for n in range(count)]
result = books.LoadResult.empty()
result.errors.extend(
MockError("printed error", lineno=lineno)
for lineno in error_lines
)
with io.StringIO() as out_file:
actual = result.print_errors(out_file)
matches = list(re.finditer(
r'^test_books_loader\.py:(\d+):\s+printed error',
out_file.getvalue(),
re.MULTILINE,
))
assert actual is bool(error_lines)
assert len(error_lines) == len(matches)
assert all(lineno == int(match.group(1)) for lineno, match in zip(error_lines, matches))
@pytest.mark.parametrize('from_fy,to_fy,expect_years', [
(2019, 2019, range(2019, 2020)),
(0, 2019, range(2019, 2020)),
(2018, 2019, range(2018, 2020)),
(1, 2018, range(2018, 2020)),
(-1, 2019, range(2018, 2020)),
(2019, 2020, range(2019, 2021)),
(1, 2019, range(2019, 2021)),
(-1, 2020, range(2019, 2021)),
(2010, 2030, range(2018, 2021)),
(20, 2010, range(2018, 2021)),
(-20, 2030, range(2018, 2021)),
])
def test_load_fy_range(conservancy_loader, from_fy, to_fy, expect_years):
entries, errors, options_map = conservancy_loader.load_fy_range(from_fy, to_fy)
assert not errors
actual_years = txn_years(entries)
assert actual_years.issuperset(expect_years)
assert min(actual_years) == expect_years.start
def test_load_fy_range_does_not_duplicate_openings(conservancy_loader):
entries, errors, options_map = conservancy_loader.load_fy_range(2010, 2030)
check_openings(entries)
def test_load_fy_range_empty(conservancy_loader):
entries, errors, options_map = conservancy_loader.load_fy_range(2020, 2019)
assert not errors
assert not entries
assert options_map.get('filename') is None
@pytest.mark.parametrize('from_year', [None, *range(2018, 2021)])
def test_load_all(conservancy_loader, from_year):
entries, errors, options_map = conservancy_loader.load_all(from_year)
from_year = from_year or 2018
assert not errors
check_openings(entries)
actual_years = txn_years(entries)
assert actual_years.issuperset(range(from_year, 2021))
assert min(actual_years) == from_year
@pytest.mark.parametrize('from_date', [
date(2019, 2, 1),
date(2019, 9, 15),
date(2020, 1, 20),
date(2020, 5, 31),
])
def test_load_all_from_date(conservancy_loader, from_date):
from_year = from_date.year
if from_date.month < FY_START_MONTH:
from_year -= 1
entries, errors, options_map = conservancy_loader.load_all(from_date)
assert not errors
check_openings(entries)
actual_years = txn_years(entries)
assert actual_years.issuperset(range(from_year, 2021))
assert min(actual_years) == from_year
def test_load_none_full_args():
entries, errors, options_map = books.Loader.load_none('test.cfg', 42)
assert not entries
assert errors
assert all(err.source['filename'] == 'test.cfg' for err in errors)
assert all(err.source['lineno'] == 42 for err in errors)
def test_load_none_no_args():
entries, errors, options_map = books.Loader.load_none()
assert not entries
assert errors
assert all(isinstance(err.source['filename'], str) for err in errors)
assert all(isinstance(err.source['lineno'], int) for err in errors)
def test_dispatch_empty():
result = books.Loader.dispatch(None)
assert not result.entries
assert result.errors
@pytest.mark.parametrize('from_arg', [
None,
*range(2018, 2021),
date(2019, 2, 1),
date(2019, 9, 15),
date(2020, 1, 20),
date(2020, 5, 31),
])
def test_dispatch_load_all_from_year(conservancy_loader, from_arg):
try:
from_year = from_arg.year
except AttributeError:
from_year = from_arg or 2018
else:
if from_arg.month < FY_START_MONTH:
from_year -= 1
result = books.Loader.dispatch(conservancy_loader, from_arg)
check_openings(result.entries)
actual_years = txn_years(result.entries)
assert actual_years.issuperset(range(from_year, 2021))
assert min(actual_years) == from_year
assert not result.errors
@pytest.mark.parametrize('from_arg,to_arg,expected', [
(2019, 2019, range(2019, 2020)),
(0, 2019, range(2019, 2020)),
(2018, 2019, range(2018, 2020)),
(1, 2018, range(2018, 2020)),
(-1, 2019, range(2018, 2020)),
(2019, 2020, range(2019, 2021)),
(1, 2019, range(2019, 2021)),
(-1, 2020, range(2019, 2021)),
(2010, 2030, range(2018, 2021)),
(20, 2010, range(2018, 2021)),
(-20, 2030, range(2018, 2021)),
])
def test_dispatch_load_all_fy_range(conservancy_loader, from_arg, to_arg, expected):
result = books.Loader.dispatch(conservancy_loader, from_arg, to_arg)
check_openings(result.entries)
actual_years = txn_years(result.entries)
assert actual_years.issuperset(iter(expected))
assert min(actual_years) == expected.start
assert not result.errors
|