conservancy_beancount/tests/test_books_loader.py

"""test_books_loader - Unit tests for books Loader class"""
# 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 collections
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

books_path = testutil.test_path('books')

@pytest.fixture(scope='module')
def conservancy_loader():
    return books.Loader(books_path, books.FiscalYear(3))

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 check_narrations(entries, expected):
    expected = iter(expected)
    expected_next = next(expected)
    for entry in entries:
        if (isinstance(entry, bc_data.Transaction)
            and entry.narration == expected_next):
            try:
                expected_next = next(expected)
            except StopIteration:
                break
    else:
        assert None, f"{expected_next} not found in entry narrations"

@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
    check_narrations(entries, [f'{year} donation' for year in expect_years])

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 not options_map

def test_load_all(conservancy_loader):
    entries, errors, options_map = conservancy_loader.load_all()
    assert not errors
    check_narrations(entries, [f'{year} donation' for year in range(2018, 2021)])
    check_openings(entries)