mia-accounting/tests/test_summary_helper.py

# The Mia! Accounting Flask Project.
# Author: imacat@mail.imacat.idv.tw (imacat), 2023/2/28

#  Copyright (c) 2023 imacat.
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
"""The test for the summary helper.

"""
import unittest
from datetime import date

from click.testing import Result
from flask import Flask
from flask.testing import FlaskCliRunner

from test_site import create_app
from testlib import get_client
from testlib_txn import Accounts, NEXT_URI, add_txn


class SummeryHelperTestCase(unittest.TestCase):
    """The summary helper test case."""

    def setUp(self) -> None:
        """Sets up the test.
        This is run once per test.

        :return: None.
        """
        self.app: Flask = create_app(is_testing=True)

        runner: FlaskCliRunner = self.app.test_cli_runner()
        with self.app.app_context():
            from accounting.models import BaseAccount, Transaction, \
                JournalEntry
            result: Result
            result = runner.invoke(args="init-db")
            self.assertEqual(result.exit_code, 0)
            if BaseAccount.query.first() is None:
                result = runner.invoke(args="accounting-init-base")
                self.assertEqual(result.exit_code, 0)
            result = runner.invoke(args=["accounting-init-currencies",
                                         "-u", "editor"])
            self.assertEqual(result.exit_code, 0)
            result = runner.invoke(args=["accounting-init-accounts",
                                         "-u", "editor"])
            self.assertEqual(result.exit_code, 0)
            Transaction.query.delete()
            JournalEntry.query.delete()

        self.client, self.csrf_token = get_client(self.app, "editor")

    def test_summary_helper(self) -> None:
        """Test the summary helper.

        :return: None.
        """
        from accounting.transaction.summary_helper import SummaryHelper
        for form in get_form_data(self.csrf_token):
            add_txn(self.client, form)
        with self.app.app_context():
            helper: SummaryHelper = SummaryHelper()

        # Debit-General
        self.assertEqual(len(helper.debit.general.tags), 2)
        self.assertEqual(helper.debit.general.tags[0].name, "Lunch")
        self.assertEqual(len(helper.debit.general.tags[0].accounts), 2)
        self.assertEqual(helper.debit.general.tags[0].accounts[0].code,
                         Accounts.MEAL)
        self.assertEqual(helper.debit.general.tags[0].accounts[1].code,
                         Accounts.PAYABLE)
        self.assertEqual(helper.debit.general.tags[1].name, "Dinner")
        self.assertEqual(len(helper.debit.general.tags[1].accounts), 2)
        self.assertEqual(helper.debit.general.tags[1].accounts[0].code,
                         Accounts.MEAL)
        self.assertEqual(helper.debit.general.tags[1].accounts[1].code,
                         Accounts.PAYABLE)

        # Debit-Travel
        self.assertEqual(len(helper.debit.travel.tags), 3)
        self.assertEqual(helper.debit.travel.tags[0].name, "Bike")
        self.assertEqual(len(helper.debit.travel.tags[0].accounts), 1)
        self.assertEqual(helper.debit.travel.tags[0].accounts[0].code,
                         Accounts.TRAVEL)
        self.assertEqual(helper.debit.travel.tags[1].name, "Taxi")
        self.assertEqual(len(helper.debit.travel.tags[1].accounts), 1)
        self.assertEqual(helper.debit.travel.tags[1].accounts[0].code,
                         Accounts.TRAVEL)
        self.assertEqual(helper.debit.travel.tags[2].name, "Airplane")
        self.assertEqual(len(helper.debit.travel.tags[2].accounts), 1)
        self.assertEqual(helper.debit.travel.tags[2].accounts[0].code,
                         Accounts.TRAVEL)

        # Debit-Bus
        self.assertEqual(len(helper.debit.bus.tags), 2)
        self.assertEqual(helper.debit.bus.tags[0].name, "Train")
        self.assertEqual(len(helper.debit.bus.tags[0].accounts), 1)
        self.assertEqual(helper.debit.bus.tags[0].accounts[0].code,
                         Accounts.TRAVEL)
        self.assertEqual(helper.debit.bus.tags[1].name, "Bus")
        self.assertEqual(len(helper.debit.bus.tags[1].accounts), 1)
        self.assertEqual(helper.debit.bus.tags[1].accounts[0].code,
                         Accounts.TRAVEL)

        # Credit-General
        self.assertEqual(len(helper.credit.general.tags), 2)
        self.assertEqual(helper.credit.general.tags[0].name, "Lunch")
        self.assertEqual(len(helper.credit.general.tags[0].accounts), 3)
        self.assertEqual(helper.credit.general.tags[0].accounts[0].code,
                         Accounts.PAYABLE)
        self.assertEqual(helper.credit.general.tags[0].accounts[1].code,
                         Accounts.BANK)
        self.assertEqual(helper.credit.general.tags[0].accounts[2].code,
                         Accounts.CASH)
        self.assertEqual(helper.credit.general.tags[1].name, "Dinner")
        self.assertEqual(len(helper.credit.general.tags[1].accounts), 2)
        self.assertEqual(helper.credit.general.tags[1].accounts[0].code,
                         Accounts.BANK)
        self.assertEqual(helper.credit.general.tags[1].accounts[1].code,
                         Accounts.PAYABLE)

        # Credit-Travel
        self.assertEqual(len(helper.credit.travel.tags), 2)
        self.assertEqual(helper.credit.travel.tags[0].name, "Bike")
        self.assertEqual(len(helper.credit.travel.tags[0].accounts), 2)
        self.assertEqual(helper.credit.travel.tags[0].accounts[0].code,
                         Accounts.PAYABLE)
        self.assertEqual(helper.credit.travel.tags[0].accounts[1].code,
                         Accounts.PREPAID)
        self.assertEqual(helper.credit.travel.tags[1].name, "Taxi")
        self.assertEqual(len(helper.credit.travel.tags[1].accounts), 2)
        self.assertEqual(helper.credit.travel.tags[1].accounts[0].code,
                         Accounts.PAYABLE)
        self.assertEqual(helper.credit.travel.tags[1].accounts[1].code,
                         Accounts.CASH)

        # Credit-Bus
        self.assertEqual(len(helper.credit.bus.tags), 2)
        self.assertEqual(helper.credit.bus.tags[0].name, "Train")
        self.assertEqual(len(helper.credit.bus.tags[0].accounts), 2)
        self.assertEqual(helper.credit.bus.tags[0].accounts[0].code,
                         Accounts.PREPAID)
        self.assertEqual(helper.credit.bus.tags[0].accounts[1].code,
                         Accounts.PAYABLE)
        self.assertEqual(helper.credit.bus.tags[1].name, "Bus")
        self.assertEqual(len(helper.credit.bus.tags[1].accounts), 1)
        self.assertEqual(helper.credit.bus.tags[1].accounts[0].code,
                         Accounts.PREPAID)


def get_form_data(csrf_token: str) -> list[dict[str, str]]:
    """Returns the form data for multiple transaction forms.

    :param csrf_token: The CSRF token.
    :return: A list of the form data.
    """
    txn_date: str = date.today().isoformat()
    return [{"csrf_token": csrf_token,
             "next": NEXT_URI,
             "date": txn_date,
             "currency-0-code": "USD",
             "currency-0-credit-0-account_code": Accounts.SERVICE,
             "currency-0-credit-0-summary": " Salary ",
             "currency-0-credit-0-amount": "2500"},
            {"csrf_token": csrf_token,
             "next": NEXT_URI,
             "date": txn_date,
             "currency-0-code": "USD",
             "currency-0-debit-0-account_code": Accounts.MEAL,
             "currency-0-debit-0-summary": " Lunch—Fish ",
             "currency-0-debit-0-amount": "4.7",
             "currency-0-credit-0-account_code": Accounts.BANK,
             "currency-0-credit-0-summary": " Lunch—Fish ",
             "currency-0-credit-0-amount": "4.7",
             "currency-0-debit-1-account_code": Accounts.MEAL,
             "currency-0-debit-1-summary": " Lunch—Fries ",
             "currency-0-debit-1-amount": "2.15",
             "currency-0-credit-1-account_code": Accounts.PAYABLE,
             "currency-0-credit-1-summary": " Lunch—Fries ",
             "currency-0-credit-1-amount": "2.15",
             "currency-0-debit-2-account_code": Accounts.MEAL,
             "currency-0-debit-2-summary": " Dinner—Hamburger ",
             "currency-0-debit-2-amount": "4.25",
             "currency-0-credit-2-account_code": Accounts.BANK,
             "currency-0-credit-2-summary": " Dinner—Hamburger ",
             "currency-0-credit-2-amount": "4.25"},
            {"csrf_token": csrf_token,
             "next": NEXT_URI,
             "date": txn_date,
             "currency-0-code": "USD",
             "currency-0-debit-0-account_code": Accounts.MEAL,
             "currency-0-debit-0-summary": " Lunch—Salad ",
             "currency-0-debit-0-amount": "4.99",
             "currency-0-credit-0-account_code": Accounts.CASH,
             "currency-0-credit-0-summary": " Lunch—Salad ",
             "currency-0-credit-0-amount": "4.99",
             "currency-0-debit-1-account_code": Accounts.MEAL,
             "currency-0-debit-1-summary": " Dinner—Steak  ",
             "currency-0-debit-1-amount": "8.28",
             "currency-0-credit-1-account_code": Accounts.PAYABLE,
             "currency-0-credit-1-summary": " Dinner—Steak ",
             "currency-0-credit-1-amount": "8.28"},
            {"csrf_token": csrf_token,
             "next": NEXT_URI,
             "date": txn_date,
             "currency-0-code": "USD",
             "currency-0-debit-0-account_code": Accounts.MEAL,
             "currency-0-debit-0-summary": " Lunch—Pizza  ",
             "currency-0-debit-0-amount": "5.49",
             "currency-0-credit-0-account_code": Accounts.PAYABLE,
             "currency-0-credit-0-summary": " Lunch—Pizza ",
             "currency-0-credit-0-amount": "5.49",
             "currency-0-debit-1-account_code": Accounts.MEAL,
             "currency-0-debit-1-summary": " Lunch—Noodles ",
             "currency-0-debit-1-amount": "7.47",
             "currency-0-credit-1-account_code": Accounts.PAYABLE,
             "currency-0-credit-1-summary": " Lunch—Noodles ",
             "currency-0-credit-1-amount": "7.47"},
            {"csrf_token": csrf_token,
             "next": NEXT_URI,
             "date": txn_date,
             "currency-0-code": "USD",
             "currency-0-debit-0-account_code": Accounts.TRAVEL,
             "currency-0-debit-0-summary": " Airplane—Lake City↔Hill Town ",
             "currency-0-debit-0-amount": "800"},
            {"csrf_token": csrf_token,
             "next": NEXT_URI,
             "date": txn_date,
             "currency-0-code": "USD",
             "currency-0-debit-0-account_code": Accounts.TRAVEL,
             "currency-0-debit-0-summary": " Bus—323—Downtown→Museum ",
             "currency-0-debit-0-amount": "2.5",
             "currency-0-credit-0-account_code": Accounts.PREPAID,
             "currency-0-credit-0-summary": " Bus—323—Downtown→Museum ",
             "currency-0-credit-0-amount": "2.5",
             "currency-0-debit-1-account_code": Accounts.TRAVEL,
             "currency-0-debit-1-summary": " Train—Blue—Museum→Central ",
             "currency-0-debit-1-amount": "3.2",
             "currency-0-credit-1-account_code": Accounts.PREPAID,
             "currency-0-credit-1-summary": " Train—Blue—Museum→Central ",
             "currency-0-credit-1-amount": "3.2",
             "currency-0-debit-2-account_code": Accounts.TRAVEL,
             "currency-0-debit-2-summary": " Train—Green—Central→Mall ",
             "currency-0-debit-2-amount": "3.2",
             "currency-0-credit-2-account_code": Accounts.PREPAID,
             "currency-0-credit-2-summary": " Train—Green—Central→Mall ",
             "currency-0-credit-2-amount": "3.2",
             "currency-0-debit-3-account_code": Accounts.TRAVEL,
             "currency-0-debit-3-summary": " Train—Red—Mall→Museum ",
             "currency-0-debit-3-amount": "4.4",
             "currency-0-credit-3-account_code": Accounts.PAYABLE,
             "currency-0-credit-3-summary": " Train—Red—Mall→Museum ",
             "currency-0-credit-3-amount": "4.4"},
            {"csrf_token": csrf_token,
             "next": NEXT_URI,
             "date": txn_date,
             "currency-0-code": "USD",
             "currency-0-debit-0-account_code": Accounts.TRAVEL,
             "currency-0-debit-0-summary": " Taxi—Museum→Office ",
             "currency-0-debit-0-amount": "15.5",
             "currency-0-credit-0-account_code": Accounts.CASH,
             "currency-0-credit-0-summary": " Taxi—Museum→Office ",
             "currency-0-credit-0-amount": "15.5",
             "currency-0-debit-1-account_code": Accounts.TRAVEL,
             "currency-0-debit-1-summary": " Taxi—Office→Restaurant ",
             "currency-0-debit-1-amount": "12",
             "currency-0-credit-1-account_code": Accounts.PAYABLE,
             "currency-0-credit-1-summary": " Taxi—Office→Restaurant ",
             "currency-0-credit-1-amount": "12",
             "currency-0-debit-2-account_code": Accounts.TRAVEL,
             "currency-0-debit-2-summary": " Taxi—Restaurant→City Hall ",
             "currency-0-debit-2-amount": "8",
             "currency-0-credit-2-account_code": Accounts.PAYABLE,
             "currency-0-credit-2-summary": " Taxi—Restaurant→City Hall ",
             "currency-0-credit-2-amount": "8",
             "currency-0-debit-3-account_code": Accounts.TRAVEL,
             "currency-0-debit-3-summary": " Bike—City Hall→Office ",
             "currency-0-debit-3-amount": "3.5",
             "currency-0-credit-3-account_code": Accounts.PAYABLE,
             "currency-0-credit-3-summary": " Bike—City Hall→Office ",
             "currency-0-credit-3-amount": "3.5",
             "currency-0-debit-4-account_code": Accounts.TRAVEL,
             "currency-0-debit-4-summary": " Bike—Restaurant→Office ",
             "currency-0-debit-4-amount": "4",
             "currency-0-credit-4-account_code": Accounts.PAYABLE,
             "currency-0-credit-4-summary": " Bike—Restaurant→Office ",
             "currency-0-credit-4-amount": "4",
             "currency-0-debit-5-account_code": Accounts.TRAVEL,
             "currency-0-debit-5-summary": " Bike—Office→Theatre ",
             "currency-0-debit-5-amount": "1.5",
             "currency-0-credit-5-account_code": Accounts.PAYABLE,
             "currency-0-credit-5-summary": " Bike—Office→Theatre ",
             "currency-0-credit-5-amount": "1.5",
             "currency-0-debit-6-account_code": Accounts.TRAVEL,
             "currency-0-debit-6-summary": " Bike—Theatre→Home ",
             "currency-0-debit-6-amount": "5.5",
             "currency-0-credit-6-account_code": Accounts.PREPAID,
             "currency-0-credit-6-summary": " Bike—Theatre→Home ",
             "currency-0-credit-6-amount": "5.5"},
            {"csrf_token": csrf_token,
             "next": NEXT_URI,
             "date": txn_date,
             "currency-0-code": "USD",
             "currency-0-debit-0-account_code": Accounts.PAYABLE,
             "currency-0-debit-0-summary": " Dinner—Steak  ",
             "currency-0-debit-0-amount": "8.28",
             "currency-0-credit-0-account_code": Accounts.BANK,
             "currency-0-credit-0-summary": " Dinner—Steak ",
             "currency-0-credit-0-amount": "8.28",
             "currency-0-debit-1-account_code": Accounts.PAYABLE,
             "currency-0-debit-1-summary": " Lunch—Pizza ",
             "currency-0-debit-1-amount": "5.49",
             "currency-0-credit-1-account_code": Accounts.BANK,
             "currency-0-credit-1-summary": " Lunch—Pizza  ",
             "currency-0-credit-1-amount": "5.49"}]