Files
@ d8f4eac53bb7
Branch filter:
Location: NPO-Accounting/conservancy_beancount/tests/test_reports_ledger.py - annotation
d8f4eac53bb7
20.8 KiB
text/x-python
reconcile: Improve reconciler matching and add test cases.
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 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 | 9782e7203a61 9782e7203a61 1b7fdf4f3b00 9782e7203a61 1b7fdf4f3b00 1b7fdf4f3b00 9782e7203a61 9782e7203a61 3f0b201d1603 9782e7203a61 9782e7203a61 9782e7203a61 46fe18809c6f 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 3f0b201d1603 3f0b201d1603 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 087b3274e7d2 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 52e7f3a22165 9782e7203a61 9782e7203a61 9782e7203a61 087b3274e7d2 55b347271c35 55b347271c35 55b347271c35 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 46fe18809c6f 46fe18809c6f 46fe18809c6f 55b347271c35 46fe18809c6f 46fe18809c6f 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 e8a754c387fc e8a754c387fc e8a754c387fc 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 46fe18809c6f 46fe18809c6f 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 6c7603fa6c73 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 6c7603fa6c73 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 7441f4ef0ce1 6c7603fa6c73 6c7603fa6c73 9782e7203a61 9782e7203a61 9782e7203a61 7441f4ef0ce1 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 9782e7203a61 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 55b347271c35 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 55b347271c35 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 46fe18809c6f 46fe18809c6f 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 46fe18809c6f 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 46fe18809c6f 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 46fe18809c6f 46fe18809c6f 46fe18809c6f 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 46fe18809c6f 46fe18809c6f 46fe18809c6f 6c7603fa6c73 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 6c7603fa6c73 46fe18809c6f 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 46fe18809c6f 46fe18809c6f 6c7603fa6c73 6c7603fa6c73 46fe18809c6f 46fe18809c6f 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 6c7603fa6c73 46fe18809c6f 46fe18809c6f 46fe18809c6f 6c7603fa6c73 6c7603fa6c73 9782e7203a61 46fe18809c6f 52e7f3a22165 9782e7203a61 9782e7203a61 9782e7203a61 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 6c7603fa6c73 6c7603fa6c73 46fe18809c6f 46fe18809c6f 087b3274e7d2 087b3274e7d2 087b3274e7d2 087b3274e7d2 087b3274e7d2 46fe18809c6f 6c7603fa6c73 9782e7203a61 46fe18809c6f 46fe18809c6f 46fe18809c6f 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 3f0b201d1603 3f0b201d1603 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 52e7f3a22165 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 9782e7203a61 3f0b201d1603 3f0b201d1603 3f0b201d1603 3f0b201d1603 3f0b201d1603 3f0b201d1603 3f0b201d1603 3f0b201d1603 3f0b201d1603 3f0b201d1603 3f0b201d1603 3f0b201d1603 3f0b201d1603 55b347271c35 3f0b201d1603 3f0b201d1603 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 3f0b201d1603 3f0b201d1603 3f0b201d1603 3f0b201d1603 3f0b201d1603 3f0b201d1603 3f0b201d1603 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 55b347271c35 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 6c7603fa6c73 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 55b347271c35 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 9782e7203a61 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 6c7603fa6c73 9782e7203a61 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 55b347271c35 46fe18809c6f 55b347271c35 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 46fe18809c6f 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 52e7f3a22165 9782e7203a61 9782e7203a61 8597a526d787 9782e7203a61 | """test_reports_ledger.py - Unit tests for general ledger report"""
# 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 contextlib
import copy
import datetime
import io
import itertools
import re
import pytest
from . import testutil
import odf.table
import odf.text
from beancount.core import data as bc_data
from beancount import loader as bc_loader
from conservancy_beancount import data
from conservancy_beancount.reports import core
from conservancy_beancount.reports import ledger
clean_account_meta = contextlib.contextmanager(testutil.clean_account_meta)
Acct = data.Account
_ledger_load = bc_loader.load_file(testutil.test_path('books/ledger.beancount'))
DEFAULT_REPORT_SHEETS = [
'Income',
'Expenses:Payroll',
'Expenses',
'Equity',
'Assets:Receivable',
'Liabilities:Payable',
'Assets:PayPal',
'Assets',
'Liabilities',
]
PROJECT_REPORT_SHEETS = [
'Balance',
'Income',
*DEFAULT_REPORT_SHEETS[2:5],
'Assets:Prepaid',
'Liabilities:UnearnedIncome',
'Liabilities:Payable',
]
OVERSIZE_RE = re.compile(
r'^([A-Za-z0-9:]+) has ([0-9,]+) rows, over size ([0-9,]+)$'
)
START_DATE = datetime.date(2018, 3, 1)
MID_DATE = datetime.date(2019, 3, 1)
STOP_DATE = datetime.date(2020, 3, 1)
REPORT_KWARGS = [
{'report_class': ledger.LedgerODS},
*({'report_class': ledger.TransactionODS, 'txn_filter': flags}
for flags in ledger.ReportType if flags & ledger.ReportType.ALL_TRANSACTIONS),
]
@pytest.fixture
def ledger_entries():
return copy.deepcopy(_ledger_load[0])
def iter_accounts(entries):
for entry in entries:
if isinstance(entry, bc_data.Open):
yield entry.account
class NotFound(Exception): pass
class NoSheet(NotFound): pass
class NoHeader(NotFound): pass
class ExpectedPostings(core.RelatedPostings):
@classmethod
def find_section(cls, ods, account):
for sheet in ods.getElementsByType(odf.table.Table):
sheet_account = sheet.getAttribute('name').replace(' ', ':')
if sheet_account and account.is_under(sheet_account):
break
else:
raise NoSheet(account)
rows = iter(sheet.getElementsByType(odf.table.TableRow))
for row in rows:
cells = row.childNodes
if (len(cells) >= 3
and cells[1].text == account
and not cells[0].text):
break
else:
raise NoHeader(account)
return rows
@classmethod
def check_not_in_report(cls, ods, *accounts):
for account in accounts:
with pytest.raises(NotFound):
cls.find_section(ods, data.Account(account))
@classmethod
def check_in_report(cls, ods, account,
start_date=START_DATE, end_date=STOP_DATE, txn_filter=None):
date = end_date + datetime.timedelta(days=1)
txn = testutil.Transaction(date=date, postings=[
(account, 0),
])
related = cls(data.Posting.from_txn(txn))
if txn_filter is None:
related.check_report(ods, start_date, end_date)
else:
related.check_txn_report(ods, txn_filter, start_date, end_date)
def slice_date_range(self, start_date, end_date):
postings = enumerate(self)
for start_index, post in postings:
if start_date <= post.meta.date:
break
else:
start_index += 1
if end_date <= post.meta.date:
end_index = start_index
else:
for end_index, post in postings:
if end_date <= post.meta.date:
break
else:
end_index = None
return (self[:start_index].balance_at_cost(),
self[start_index:end_index])
def check_report(self, ods, start_date, end_date, expect_totals=True):
account = self[0].account
norm_func = core.normalize_amount_func(account)
open_bal, expect_posts = self.slice_date_range(start_date, end_date)
open_bal = norm_func(open_bal)
closing_bal = norm_func(expect_posts.balance_at_cost())
rows = self.find_section(ods, account)
if expect_totals and account.is_under('Assets', 'Liabilities'):
opening_row = testutil.ODSCell.from_row(next(rows))
assert opening_row[0].value == start_date
assert opening_row[4].text == open_bal.format(None, empty='0', sep='\0')
closing_bal += open_bal
for expected in expect_posts:
cells = iter(testutil.ODSCell.from_row(next(rows)))
assert next(cells).value == expected.meta.date
assert next(cells).text == (expected.meta.get('entity') or '')
assert next(cells).text == (expected.meta.txn.narration or '')
if expected.cost is None:
assert not next(cells).text
assert next(cells).value == norm_func(expected.units.number)
else:
assert next(cells).value == norm_func(expected.units.number)
assert next(cells).value == norm_func(expected.at_cost().number)
if expect_totals:
closing_row = testutil.ODSCell.from_row(next(rows))
assert closing_row[0].value == end_date
empty = '$0.00' if expect_posts else '0'
assert closing_row[4].text == closing_bal.format(None, empty=empty, sep='\0')
def _post_data_from_row(self, row):
if row[4].text:
number = row[4].value
match = re.search(r'([A-Z]{3})\d*Cell', row[4].getAttribute('stylename') or '')
assert match
currency = match.group(1)
else:
number = row[5].value
currency = 'USD'
return (row[2].text, row[3].text, number, currency)
def _post_data_from_post(self, post, norm_func):
return (
post.account,
post.meta.get('entity') or '',
norm_func(post.units.number),
post.units.currency,
)
def check_txn_report(self, ods, txn_filter, start_date, end_date, expect_totals=True):
account = self[0].account
norm_func = core.normalize_amount_func(account)
open_bal, expect_posts = self.slice_date_range(start_date, end_date)
open_bal = norm_func(open_bal)
period_bal = core.MutableBalance()
rows = self.find_section(ods, account)
if (expect_totals
and txn_filter == ledger.ReportType.ALL_TRANSACTIONS
and account.is_under('Assets', 'Liabilities')):
opening_row = testutil.ODSCell.from_row(next(rows))
assert opening_row[0].value == start_date
assert opening_row[5].text == open_bal.format(None, empty='0', sep='\0')
period_bal += open_bal
last_txn = None
for post in expect_posts:
txn = post.meta.txn
post_flag = ledger.ReportType.post_flag(post)
if txn is last_txn or (not txn_filter & post_flag):
continue
last_txn = txn
row1 = testutil.ODSCell.from_row(next(rows))
assert row1[0].value == txn.date
assert row1[1].text == (txn.narration or '')
expected = {self._post_data_from_post(post, norm_func)
for post in txn.postings}
actual = {self._post_data_from_row(testutil.ODSCell.from_row(row))
for row in itertools.islice(rows, len(txn.postings) - 1)}
actual.add(self._post_data_from_row(row1))
assert actual == expected
for post_acct, _, number, currency in expected:
if post_acct == account:
period_bal += testutil.Amount(number, currency)
if expect_totals:
closing_row = testutil.ODSCell.from_row(next(rows))
assert closing_row[0].value == end_date
empty = '$0.00' if period_bal else '0'
assert closing_row[5].text == period_bal.format(None, empty=empty, sep='\0')
def get_sheet_names(ods):
return [sheet.getAttribute('name').replace(' ', ':')
for sheet in ods.getElementsByType(odf.table.Table)]
def check_oversize_logs(caplog, accounts, sheet_size):
actual = {}
for log in caplog.records:
match = OVERSIZE_RE.match(log.message)
if match:
assert int(match.group(3).replace(',', '')) == sheet_size
actual[match.group(1)] = int(match.group(2).replace(',', ''))
expected = {name: size for name, size in accounts.items() if size > sheet_size}
assert actual == expected
def test_plan_sheets_no_change():
have = {
Acct('Assets:Cash'): 10,
Acct('Income:Donations'): 20,
}
want = ['Assets', 'Income']
actual = ledger.LedgerODS.plan_sheets(have, want.copy(), 100)
assert actual == want
@pytest.mark.parametrize('have', [
{},
{Acct('Income:Other'): 10},
{Acct('Assets:Checking'): 20, Acct('Expenses:Other'): 15},
])
def test_plan_sheets_includes_accounts_without_transactions(have):
want = ['Assets', 'Income', 'Expenses']
actual = ledger.LedgerODS.plan_sheets(have, want.copy(), 100)
assert actual == want
def test_plan_sheets_single_split():
have = {
Acct('Assets:Cash'): 60,
Acct('Assets:Checking'): 80,
Acct('Income:Donations'): 50,
Acct('Expenses:Travel'): 90,
Acct('Expenses:FilingFees'): 25,
}
want = ['Assets', 'Income', 'Expenses']
actual = ledger.LedgerODS.plan_sheets(have, want, 100)
assert actual == [
'Assets:Checking',
'Assets',
'Income',
'Expenses:Travel',
'Expenses',
]
def test_plan_sheets_split_subtree():
have = {
Acct('Assets:Bank1:Checking'): 80,
Acct('Assets:Bank1:Savings'): 10,
Acct('Assets:Cash:USD'): 20,
Acct('Assets:Cash:EUR'): 15,
}
actual = ledger.LedgerODS.plan_sheets(have, ['Assets'], 100)
assert actual == ['Assets:Bank1', 'Assets']
def test_plan_sheets_ambiguous_split():
have = {
Acct('Assets:Bank1:Checking'): 80,
Acct('Assets:Bank1:Savings'): 40,
Acct('Assets:Receivable:Accounts'): 40,
Acct('Assets:Cash'): 10,
}
actual = ledger.LedgerODS.plan_sheets(have, ['Assets'], 100)
# :Savings cannot fit with :Checking, so it's important that the return
# value disambiguate that.
assert actual == ['Assets:Bank1:Checking', 'Assets']
def test_plan_sheets_oversize(caplog):
have = {
Acct('Assets:Checking'): 150,
Acct('Assets:Cash'): 50,
}
actual = ledger.LedgerODS.plan_sheets(have, ['Assets'], 100)
assert actual == ['Assets:Checking', 'Assets']
check_oversize_logs(caplog, have, 100)
def test_plan_sheets_all_oversize(caplog):
have = {
Acct('Assets:Checking'): 150,
Acct('Assets:Cash'): 150,
}
actual = ledger.LedgerODS.plan_sheets(have, ['Assets'], 100)
# In this case, each account should appear in alphabetical order.
assert actual == ['Assets:Cash', 'Assets:Checking']
check_oversize_logs(caplog, have, 100)
def test_plan_sheets_full_split_required(caplog):
have = {
Acct('Assets:Bank:Savings'): 98,
Acct('Assets:Bank:Checking'): 96,
Acct('Assets:Bank:Investment'): 94,
}
actual = ledger.LedgerODS.plan_sheets(have, ['Assets'], 100)
assert actual == ['Assets:Bank:Checking', 'Assets:Bank:Savings', 'Assets']
assert not caplog.records
def build_report(ledger_entries, start_date, stop_date, *args,
report_class=ledger.LedgerODS, **kwargs):
postings = list(data.Posting.from_entries(iter(ledger_entries)))
with clean_account_meta():
data.Account.load_openings_and_closings(iter(ledger_entries))
report = report_class(start_date, stop_date, *args, **kwargs)
report.write(iter(postings))
return postings, report
@pytest.mark.parametrize('report_kwargs', iter(REPORT_KWARGS))
@pytest.mark.parametrize('start_date,stop_date', [
(START_DATE, STOP_DATE),
(START_DATE, MID_DATE),
(MID_DATE, STOP_DATE),
(START_DATE.replace(month=6), START_DATE.replace(month=12)),
(STOP_DATE, STOP_DATE.replace(month=12)),
])
def test_date_range_report(ledger_entries, start_date, stop_date, report_kwargs):
txn_filter = report_kwargs.get('txn_filter')
postings, report = build_report(ledger_entries, start_date, stop_date, **report_kwargs)
expected = dict(ExpectedPostings.group_by_account(postings))
for account in iter_accounts(ledger_entries):
try:
related = expected[account]
except KeyError:
ExpectedPostings.check_in_report(
report.document, account, start_date, stop_date, txn_filter,
)
else:
if txn_filter is None:
related.check_report(report.document, start_date, stop_date)
else:
related.check_txn_report(
report.document, txn_filter, start_date, stop_date,
)
@pytest.mark.parametrize('report_kwargs', iter(REPORT_KWARGS))
@pytest.mark.parametrize('tot_accts', [
(),
('Assets', 'Liabilities'),
('Income', 'Expenses'),
('Assets', 'Liabilities', 'Income', 'Expenses'),
])
def test_report_filter_totals(ledger_entries, tot_accts, report_kwargs):
txn_filter = report_kwargs.get('txn_filter')
postings, report = build_report(ledger_entries, START_DATE, STOP_DATE,
totals_with_entries=tot_accts,
totals_without_entries=tot_accts,
**report_kwargs)
expected = dict(ExpectedPostings.group_by_account(postings))
for account in iter_accounts(ledger_entries):
expect_totals = account.startswith(tot_accts)
if account in expected and expected[account][-1].meta.date >= START_DATE:
if txn_filter is None:
expected[account].check_report(
report.document, START_DATE, STOP_DATE, expect_totals=expect_totals,
)
else:
expected[account].check_txn_report(
report.document, txn_filter,
START_DATE, STOP_DATE, expect_totals=expect_totals,
)
elif expect_totals:
ExpectedPostings.check_in_report(
report.document, account, START_DATE, STOP_DATE, txn_filter,
)
else:
ExpectedPostings.check_not_in_report(report.document, account)
@pytest.mark.parametrize('report_kwargs', iter(REPORT_KWARGS))
@pytest.mark.parametrize('accounts', [
('Income', 'Expenses'),
('Assets:Receivable', 'Liabilities:Payable'),
])
def test_account_names_report(ledger_entries, accounts, report_kwargs):
txn_filter = report_kwargs.get('txn_filter')
postings, report = build_report(ledger_entries, START_DATE, STOP_DATE,
accounts, **report_kwargs)
expected = dict(ExpectedPostings.group_by_account(postings))
for account in iter_accounts(ledger_entries):
if not account.startswith(accounts):
ExpectedPostings.check_not_in_report(report.document, account)
# This account is reportable but has no postings
elif account == 'Expenses:Payroll':
ExpectedPostings.check_in_report(
report.document, account, START_DATE, STOP_DATE, txn_filter,
)
elif txn_filter is None:
expected[account].check_report(report.document, START_DATE, STOP_DATE)
else:
expected[account].check_txn_report(
report.document, txn_filter, START_DATE, STOP_DATE,
)
def run_main(arglist, config=None):
if config is None:
config = testutil.TestConfig(
books_path=testutil.test_path('books/ledger.beancount'),
rt_client=testutil.RTClient(),
)
arglist.insert(0, '--output-file=-')
output = io.BytesIO()
errors = io.StringIO()
with clean_account_meta():
retcode = ledger.main(arglist, output, errors, config)
output.seek(0)
return retcode, output, errors
def test_main(ledger_entries):
retcode, output, errors = run_main([
'-b', START_DATE.isoformat(),
'-e', STOP_DATE.isoformat(),
])
output.seek(0)
assert not errors.getvalue()
assert retcode == 0
ods = odf.opendocument.load(output)
assert get_sheet_names(ods) == DEFAULT_REPORT_SHEETS[:]
postings = data.Posting.from_entries(iter(ledger_entries))
expected = dict(ExpectedPostings.group_by_account(postings))
for account in iter_accounts(ledger_entries):
try:
expected[account].check_report(ods, START_DATE, STOP_DATE)
except KeyError:
ExpectedPostings.check_in_report(ods, account)
@pytest.mark.parametrize('acct_arg', [
'Liabilities',
'Accounts payable',
])
def test_main_account_limit(ledger_entries, acct_arg):
retcode, output, errors = run_main([
'-a', acct_arg,
'-b', START_DATE.isoformat(),
'-e', STOP_DATE.isoformat(),
])
assert not errors.getvalue()
assert retcode == 0
ods = odf.opendocument.load(output)
assert get_sheet_names(ods) == ['Liabilities']
postings = data.Posting.from_entries(ledger_entries)
for account, expected in ExpectedPostings.group_by_account(postings):
if account == 'Liabilities:UnearnedIncome':
should_find = acct_arg == 'Liabilities'
else:
should_find = account.startswith('Liabilities')
try:
expected.check_report(ods, START_DATE, STOP_DATE)
except NotFound:
assert not should_find
else:
assert should_find
def test_main_account_classification_splits_hierarchy(ledger_entries):
retcode, output, errors = run_main([
'-a', 'Cash',
'-b', START_DATE.isoformat(),
'-e', STOP_DATE.isoformat(),
])
assert not errors.getvalue()
assert retcode == 0
ods = odf.opendocument.load(output)
assert get_sheet_names(ods) == ['Assets']
postings = data.Posting.from_entries(ledger_entries)
for account, expected in ExpectedPostings.group_by_account(postings):
should_find = (account == 'Assets:Checking' or account == 'Assets:PayPal')
try:
expected.check_report(ods, START_DATE, STOP_DATE)
except NotFound:
assert not should_find, f"{account} not found in report"
else:
assert should_find, f"{account} in report but should be excluded"
@pytest.mark.parametrize('project,start_date,stop_date', [
('eighteen', START_DATE, MID_DATE.replace(day=30)),
('nineteen', MID_DATE, STOP_DATE),
])
def test_main_project_report(ledger_entries, project, start_date, stop_date):
postings = data.Posting.from_entries(iter(ledger_entries))
for key, related in ExpectedPostings.group_by_meta(postings, 'project'):
if key == project:
break
assert key == project
retcode, output, errors = run_main([
f'--begin={start_date.isoformat()}',
f'--end={stop_date.isoformat()}',
'--report-type=fund_ledger',
project,
])
assert not errors.getvalue()
assert retcode == 0
ods = odf.opendocument.load(output)
assert get_sheet_names(ods) == PROJECT_REPORT_SHEETS[:]
expected = dict(ExpectedPostings.group_by_account(related))
for account in iter_accounts(ledger_entries):
try:
expected[account].check_report(ods, start_date, stop_date)
except KeyError:
ExpectedPostings.check_not_in_report(ods, account)
@pytest.mark.parametrize('flag', [
'--disbursements',
'--receipts',
])
def test_main_cash_report(ledger_entries, flag):
if flag == '--receipts':
txn_filter = ledger.ReportType.CREDIT_TRANSACTIONS
else:
txn_filter = ledger.ReportType.DEBIT_TRANSACTIONS
retcode, output, errors = run_main([
flag,
'-b', START_DATE.isoformat(),
'-e', STOP_DATE.isoformat(),
])
assert not errors.getvalue()
assert retcode == 0
ods = odf.opendocument.load(output)
postings = data.Posting.from_entries(ledger_entries)
for account, expected in ExpectedPostings.group_by_account(postings):
if account == 'Assets:Checking' or account == 'Assets:PayPal':
expected.check_txn_report(ods, txn_filter, START_DATE, STOP_DATE)
else:
expected.check_not_in_report(ods)
@pytest.mark.parametrize('arg', [
'Assets:NoneSuchBank',
'Funny money',
])
def test_main_invalid_account(caplog, arg):
retcode, output, errors = run_main(['-a', arg])
assert retcode == 2
assert any(log.message.endswith(f': {arg!r}') for log in caplog.records)
def test_main_no_postings(caplog):
retcode, output, errors = run_main(['NonexistentProject'])
assert retcode == 65
assert any(log.levelname == 'WARNING' for log in caplog.records)
|