Files
@ 728db9983ec1
Branch filter:
Location: NPO-Accounting/conservancy_beancount/tests/test_reports_balance.py
728db9983ec1
14.3 KiB
text/x-python
fill: Use program logger over module logger to report problems.
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 | """test_reports_balance - Unit tests for reports.core.Balance"""
# 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 itertools
from decimal import Decimal
import pytest
from . import testutil
import babel.numbers
from conservancy_beancount.reports import core
DEFAULT_STRINGS = [
({}, "Zero balance"),
({'JPY': 0, 'BRL': 0}, "0.00 BRL, 0 JPY"),
({'USD': '20.00'}, "20.00 USD"),
({'EUR': '50.00', 'GBP': '80.00'}, "80.00 GBP, 50.00 EUR"),
({'JPY': '-5500.00', 'BRL': '-8500.00'}, "-8,500.00 BRL, -5,500 JPY"),
({'USD': 10, 'EUR': '.00015'}, "10.00 USD"),
({'JPY': '-.00015'}, "-0 JPY"),
]
TOLERANCES = [Decimal(n) for n in ['.1', '.01', '.001', 0]]
def amounts_from_map(currency_map):
for code, number in currency_map.items():
yield testutil.Amount(number, code)
def test_empty_balance():
balance = core.Balance()
assert not balance
assert len(balance) == 0
assert balance.is_zero()
with pytest.raises(KeyError):
balance['USD']
@pytest.mark.parametrize('currencies', [
'USD',
'EUR GBP',
'JPY INR BRL',
])
def test_zero_balance(currencies):
keys = currencies.split()
balance = core.Balance(testutil.Amount(0, key) for key in keys)
assert balance
assert len(balance) == len(keys)
assert balance.is_zero()
assert all(balance[key].number == 0 for key in keys)
assert all(balance[key].currency == key for key in keys)
@pytest.mark.parametrize('currencies', [
'USD',
'EUR GBP',
'JPY INR BRL',
])
def test_nonzero_balance(currencies):
amounts = dict(zip(currencies.split(), itertools.count(110, 100)))
balance = core.Balance(amounts_from_map(amounts))
assert balance
assert len(balance) == len(amounts)
assert not balance.is_zero()
assert all(balance[key] == testutil.Amount(amt, key) for key, amt in amounts.items())
def test_mixed_balance():
amounts = {'USD': 0, 'EUR': 120}
balance = core.Balance(amounts_from_map(amounts))
assert balance
assert len(balance) == 2
assert not balance.is_zero()
assert all(balance[key] == testutil.Amount(amt, key) for key, amt in amounts.items())
def test_init_recurring_currency():
balance = core.Balance([
testutil.Amount(20),
testutil.Amount(40),
testutil.Amount(60, 'EUR'),
testutil.Amount(-80),
])
assert balance
assert balance['EUR'] == testutil.Amount(60, 'EUR')
assert balance['USD'] == testutil.Amount(-20)
def test_init_zeroed_out():
balance = core.Balance([
testutil.Amount(25),
testutil.Amount(40, 'EUR'),
testutil.Amount(-25),
testutil.Amount(-40, 'EUR'),
])
assert balance.is_zero()
@pytest.mark.parametrize('mapping,expected', [
({}, True),
({'USD': 0}, True),
({'USD': 0, 'EUR': 0}, True),
({'USD': -10, 'EUR': 0}, False),
({'EUR': -10}, False),
({'USD': -10, 'EUR': -20}, False),
({'USD': 10, 'EUR': -20}, False),
({'JPY': 10}, False),
({'JPY': 10, 'BRL': 0}, False),
({'JPY': 10, 'BRL': 20}, False),
({'USD': '0.00015'}, True),
({'EUR': '-0.00052'}, True),
])
def test_eq_zero(mapping, expected):
balance = core.Balance(amounts_from_map(mapping))
assert balance.eq_zero() == expected
assert balance.is_zero() == expected
@pytest.mark.parametrize('mapping,expected', [
({}, True),
({'USD': 0}, True),
({'USD': 0, 'EUR': 0}, True),
({'EUR': -10}, False),
({'USD': 10, 'EUR': -20}, False),
({'USD': -10, 'EUR': -20}, False),
({'JPY': 10}, True),
({'JPY': 10, 'BRL': 0}, True),
({'JPY': 10, 'BRL': 20}, True),
({'USD': '0.00015'}, True),
({'EUR': '-0.00052'}, True),
({'RUB': core.Balance.TOLERANCE}, True),
({'RUB': -core.Balance.TOLERANCE}, False),
])
def test_ge_zero(mapping, expected):
balance = core.Balance(amounts_from_map(mapping))
assert balance.ge_zero() == expected
@pytest.mark.parametrize('mapping,expected', [
({}, True),
({'USD': 0}, True),
({'USD': 0, 'EUR': 0}, True),
({'EUR': -10}, True),
({'USD': 10, 'EUR': -20}, False),
({'USD': -10, 'EUR': -20}, True),
({'JPY': 10}, False),
({'JPY': 10, 'BRL': 0}, False),
({'JPY': 10, 'BRL': 20}, False),
({'USD': '0.00015'}, True),
({'EUR': '-0.00052'}, True),
({'RUB': core.Balance.TOLERANCE}, False),
({'RUB': -core.Balance.TOLERANCE}, True),
])
def test_le_zero(mapping, expected):
balance = core.Balance(amounts_from_map(mapping))
assert balance.le_zero() == expected
@pytest.mark.parametrize('mapping', [
{},
{'USD': 0},
{'EUR': 10},
{'JPY': 20, 'BRL': 30},
{'EUR': -15},
{'JPY': -25, 'BRL': -35},
{'JPY': 40, 'USD': 0, 'EUR': -50},
])
def test_abs(mapping):
actual = abs(core.Balance(amounts_from_map(mapping)))
assert set(actual) == set(mapping)
for key, number in mapping.items():
assert actual[key] == testutil.Amount(abs(number), key)
@pytest.mark.parametrize('mapping', [
{},
{'USD': 0},
{'EUR': 10},
{'JPY': 20, 'BRL': 30},
{'EUR': -15},
{'JPY': -25, 'BRL': -35},
{'JPY': 40, 'USD': 0, 'EUR': -50},
])
def test_neg(mapping):
actual = -core.Balance(amounts_from_map(mapping))
assert set(actual) == set(mapping)
for key, number in mapping.items():
assert actual[key] == testutil.Amount(-number, key)
@pytest.mark.parametrize('mapping', [
{},
{'USD': 0},
{'EUR': 10},
{'JPY': 20, 'BRL': 30},
{'EUR': -15},
{'JPY': -25, 'BRL': -35},
{'JPY': 40, 'USD': 0, 'EUR': -50},
])
def test_pos(mapping):
amounts = frozenset(amounts_from_map(mapping))
actual = +core.Balance(amounts)
assert set(actual.values()) == amounts
@pytest.mark.parametrize('map1,map2,expected', [
({}, {}, True),
({}, {'USD': 0}, True),
({}, {'EUR': 1}, False),
({'USD': 1}, {'EUR': 1}, False),
({'USD': 1}, {'USD': '1.0'}, True),
({'USD': 1}, {'USD': '1.0', 'EUR': '2.0'}, False),
({'USD': 1, 'BRL': '2.0'}, {'USD': '1.0', 'EUR': '2.0'}, False),
({'USD': 1, 'EUR': 2, 'BRL': '3.0'}, {'USD': '1.0', 'EUR': '2.0'}, False),
({'USD': 1, 'EUR': 2}, {'USD': '1.0', 'EUR': '2.0'}, True),
])
def test_eq(map1, map2, expected):
bal1 = core.Balance(amounts_from_map(map1))
bal2 = core.Balance(amounts_from_map(map2))
actual = bal1 == bal2
assert actual == expected
@pytest.mark.parametrize('tolerance', TOLERANCES)
def test_eq_considers_tolerance(tolerance):
tolerance = Decimal(tolerance)
mapping = {'EUR': 100, 'USD': '.002'}
bal1 = core.Balance(amounts_from_map(mapping))
mapping['USD'] = '.004'
bal2 = core.Balance(amounts_from_map(mapping), tolerance)
assert (bal1 == bal2) == (tolerance > Decimal('.002'))
@pytest.mark.parametrize('number,currency', {
(50, 'USD'),
(-50, 'USD'),
(50000, 'BRL'),
(-4000, 'BRL'),
})
def test_add_amount(number, currency):
start_amount = testutil.Amount(500, 'USD')
start_bal = core.Balance([start_amount])
add_amount = testutil.Amount(number, currency)
actual = start_bal + add_amount
if currency == 'USD':
assert len(actual) == 1
assert actual['USD'] == testutil.Amount(500 + number)
else:
assert len(actual) == 2
assert actual['USD'] == start_amount
assert actual[currency] == add_amount
assert start_bal == {'USD': start_amount}
@pytest.mark.parametrize('number,currency', {
(50, 'USD'),
(-50, 'USD'),
(50000, 'BRL'),
(-4000, 'BRL'),
})
def test_iadd_amount(number, currency):
balance = core.MutableBalance([testutil.Amount(500, 'USD')])
add_amount = testutil.Amount(number, currency)
balance += add_amount
if currency == 'USD':
assert len(balance) == 1
assert balance['USD'] == testutil.Amount(500 + number)
else:
assert len(balance) == 2
assert balance['USD'] == testutil.Amount(500)
assert balance[currency] == add_amount
@pytest.mark.parametrize('number,currency', {
(50, 'USD'),
(-50, 'USD'),
(50000, 'BRL'),
(-4000, 'BRL'),
})
def test_sub_amount(number, currency):
start_amount = testutil.Amount(500, 'USD')
start_bal = core.Balance([start_amount])
sub_amount = testutil.Amount(number, currency)
actual = start_bal - sub_amount
if currency == 'USD':
assert len(actual) == 1
assert actual['USD'] == testutil.Amount(500 - number)
else:
assert len(actual) == 2
assert actual['USD'] == start_amount
assert actual[currency] == -sub_amount
assert start_bal == {'USD': start_amount}
@pytest.mark.parametrize('number,currency', {
(50, 'USD'),
(-50, 'USD'),
(50000, 'BRL'),
(-4000, 'BRL'),
})
def test_isub_amount(number, currency):
balance = core.MutableBalance([testutil.Amount(500, 'USD')])
sub_amount = testutil.Amount(number, currency)
balance -= sub_amount
if currency == 'USD':
assert len(balance) == 1
assert balance['USD'] == testutil.Amount(500 - number)
else:
assert len(balance) == 2
assert balance['USD'] == testutil.Amount(500)
assert balance[currency] == -sub_amount
@pytest.mark.parametrize('mapping', [
{},
{'USD': 0},
{'EUR': 10},
{'JPY': 20, 'BRL': 30},
{'EUR': -15},
{'JPY': -25, 'BRL': -35},
{'JPY': 40, 'USD': 0, 'EUR': -50},
])
def test_add_balance(mapping):
expect_numbers = {'USD': 500, 'BRL': 40000}
start_bal = core.Balance(amounts_from_map(expect_numbers))
for code, number in mapping.items():
expect_numbers[code] = expect_numbers.get(code, 0) + number
add_bal = core.Balance(amounts_from_map(mapping))
actual = start_bal + add_bal
expected = core.Balance(amounts_from_map(expect_numbers))
assert actual == expected
@pytest.mark.parametrize('mapping', [
{},
{'USD': 0},
{'EUR': 10},
{'JPY': 20, 'BRL': 30},
{'EUR': -15},
{'JPY': -25, 'BRL': -35},
{'JPY': 40, 'USD': 0, 'EUR': -50},
])
def test_iadd_balance(mapping):
expect_numbers = {'USD': 500, 'BRL': 40000}
balance = core.MutableBalance(amounts_from_map(expect_numbers))
for code, number in mapping.items():
expect_numbers[code] = expect_numbers.get(code, 0) + number
balance += core.Balance(amounts_from_map(mapping))
expected = core.Balance(amounts_from_map(expect_numbers))
assert balance == expected
@pytest.mark.parametrize('tolerance', TOLERANCES)
def test_copy(tolerance):
eur = testutil.Amount('.003', 'EUR')
source = core.Balance([eur], tolerance)
new = source.copy()
assert source is not new
assert dict(source) == dict(new)
assert new.tolerance == tolerance
@pytest.mark.parametrize('tolerance', TOLERANCES)
def test_copy_tolerance_arg(tolerance):
eur = testutil.Amount('.003', 'EUR')
source = core.Balance([eur])
new = source.copy(tolerance)
assert source is not new
assert dict(source) == dict(new)
assert new.tolerance == tolerance
@pytest.mark.parametrize('tolerance', TOLERANCES)
def test_clean_copy(tolerance):
usd = testutil.Amount(10)
eur = testutil.Amount('.002', 'EUR')
actual = core.Balance([usd, eur], tolerance).clean_copy()
if tolerance < eur.number:
expected = {usd, eur}
else:
expected = {usd}
assert frozenset(actual.values()) == expected
assert actual.tolerance == tolerance
@pytest.mark.parametrize('tolerance', TOLERANCES)
def test_clean_copy_arg(tolerance):
usd = testutil.Amount(10)
eur = testutil.Amount('.002', 'EUR')
actual = core.Balance([usd, eur], 0).clean_copy(tolerance)
if tolerance < eur.number:
expected = {usd, eur}
else:
expected = {usd}
assert frozenset(actual.values()) == expected
assert actual.tolerance == tolerance
@pytest.mark.parametrize('mapping,expected', DEFAULT_STRINGS)
def test_str(mapping, expected):
balance = core.Balance(amounts_from_map(mapping))
assert str(balance) == expected
@pytest.mark.parametrize('mapping,expected', DEFAULT_STRINGS)
def test_format_defaults(mapping, expected):
balance = core.Balance(amounts_from_map(mapping))
assert balance.format() == expected
@pytest.mark.parametrize('fmt,expected', [
('¤##0.0', '¥5000, -€1500.00'),
('#,##0.0¤¤', '5,000JPY, -1,500.00EUR'),
('¤+##0.0;¤-##0.0', '¥+5000, €-1500.00'),
('#,##0.0 ¤¤;(#,##0.0 ¤¤)', '5,000 JPY, (1,500.00 EUR)'),
])
def test_format_fmt(fmt, expected):
amounts = [testutil.Amount(5000, 'JPY'), testutil.Amount(-1500, 'EUR')]
balance = core.Balance(amounts)
assert balance.format(fmt) == expected
@pytest.mark.parametrize('sep', [
'; ',
'—',
'\0',
])
def test_format_sep(sep):
mapping, expected = DEFAULT_STRINGS[-1]
expected = expected.replace(', ', sep)
balance = core.Balance(amounts_from_map(mapping))
assert balance.format(sep=sep) == expected
@pytest.mark.parametrize('number', [65000, -77000])
def test_format_none(number):
args = (number, 'BRL')
balance = core.Balance([testutil.Amount(*args)])
expected = babel.numbers.format_currency(*args, format_type='accounting')
assert balance.format(None) == expected
@pytest.mark.parametrize('empty', [
"N/A",
"Zero",
"ø",
])
def test_format_empty(empty):
balance = core.Balance()
assert balance.format(empty=empty) == empty
@pytest.mark.parametrize('currency,fmt', itertools.product(
['USD', 'JPY', 'BRL'],
[None, '¤#,##0.00', '###0.00 ¤¤'],
))
def test_format_zero_balance_fmt(currency, fmt):
zero_amt = testutil.Amount(0, currency)
nonzero_amt = testutil.Amount(9, currency)
zero_bal = core.Balance([zero_amt])
nonzero_bal = core.Balance([nonzero_amt])
expected = nonzero_bal.format(fmt).replace('9', '0')
assert zero_bal.format(fmt) == expected
@pytest.mark.parametrize('currency,fmt', testutil.combine_values(
['USD', 'JPY', 'BRL'],
["N/A", "Zero", "ø"],
))
def test_format_zero_balance_zero_str(currency, fmt):
zero_amt = testutil.Amount(0, currency)
zero_bal = core.Balance([zero_amt])
assert zero_bal.format(zero=fmt) == fmt
@pytest.mark.parametrize('tolerance', TOLERANCES)
def test_format_zero_balance_with_tolerance(tolerance):
chf = testutil.Amount('.005', 'CHF')
actual = core.Balance([chf]).format(zero="ø", tolerance=tolerance)
if tolerance > chf.number:
assert actual == "ø"
else:
assert actual == "0.00 CHF"
|