account-financial-reporting/account_financial_report/tests/test_general_ledger.py

# Author: Julien Coux
# Copyright 2016 Camptocamp SA
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).

import time
from datetime import date

from odoo import fields
from odoo.tests import common

from . import abstract_test_foreign_currency as a_t_f_c


class TestGeneralLedger(a_t_f_c.AbstractTestForeignCurrency):
    """
        Technical tests for General Ledger Report.
    """

    def _getReportModel(self):
        return self.env["report_general_ledger"]

    def _getQwebReportName(self):
        return "account_financial_report.report_general_ledger_qweb"

    def _getXlsxReportName(self):
        return "a_f_r.report_general_ledger_xlsx"

    def _getXlsxReportActionName(self):
        return "account_financial_report." "action_report_general_ledger_xlsx"

    def _getReportTitle(self):
        return "Odoo"

    def _getBaseFilters(self):
        return {
            "date_from": date(date.today().year, 1, 1),
            "date_to": date(date.today().year, 12, 31),
            "company_id": self.company.id,
            "fy_start_date": date(date.today().year, 1, 1),
            "foreign_currency": True,
        }

    def _getAdditionalFiltersToBeTested(self):

        additional_filters = [
            {"only_posted_moves": True},
            {"hide_account_at_0": True},
            {"centralize": True},
            {"only_posted_moves": True, "hide_account_at_0": True},
            {"only_posted_moves": True, "centralize": True},
            {"hide_account_at_0": True, "centralize": True},
            {"only_posted_moves": True, "hide_account_at_0": True, "centralize": True},
        ]
        # Add `show_analytic_tags` filter on each cases
        additional_filters_with_show_tags = []
        for additional_filter in additional_filters:
            additional_filter["show_analytic_tags"] = True
            additional_filters_with_show_tags.append(additional_filter)
        additional_filters += additional_filters_with_show_tags
        # Add `filter_analytic_tag_ids` filter on each cases
        analytic_tag = self.env["account.analytic.tag"].create({"name": "TEST tag"})
        # Define all move lines on this tag
        # (this test just check with the all filters, all works technically)
        move_lines = self.env["account.move.line"].search([])
        move_lines.write(
            {"analytic_tag_ids": [(6, False, analytic_tag.ids)],}
        )
        additional_filters_with_filter_tags = []
        for additional_filter in additional_filters:
            additional_filter["filter_analytic_tag_ids"] = [
                (6, False, analytic_tag.ids)
            ]
            additional_filters_with_filter_tags.append(additional_filter)
        additional_filters += additional_filters_with_filter_tags
        return additional_filters


class TestGeneralLedgerReport(common.TransactionCase):
    def setUp(self):
        super(TestGeneralLedgerReport, self).setUp()
        self.before_previous_fy_year = fields.Date.from_string("2014-05-05")
        self.previous_fy_date_start = fields.Date.from_string("2015-01-01")
        self.previous_fy_date_end = fields.Date.from_string("2015-12-31")
        self.fy_date_start = fields.Date.from_string("2016-01-01")
        self.fy_date_end = fields.Date.from_string("2016-12-31")
        self.receivable_account = self.env["account.account"].search(
            [("user_type_id.name", "=", "Receivable")], limit=1
        )
        self.income_account = self.env["account.account"].search(
            [("user_type_id.name", "=", "Income")], limit=1
        )
        self.unaffected_account = self.env["account.account"].search(
            [
                (
                    "user_type_id",
                    "=",
                    self.env.ref("account.data_unaffected_earnings").id,
                )
            ],
            limit=1,
        )

    def _add_move(
        self,
        date,
        receivable_debit,
        receivable_credit,
        income_debit,
        income_credit,
        unaffected_debit=0,
        unaffected_credit=0,
    ):
        move_name = "expense accrual"
        journal = self.env["account.journal"].search([], limit=1)
        partner = self.env.ref("base.res_partner_12")
        move_vals = {
            "journal_id": journal.id,
            "name": move_name,
            "date": date,
            "line_ids": [
                (
                    0,
                    0,
                    {
                        "name": move_name,
                        "debit": receivable_debit,
                        "credit": receivable_credit,
                        "account_id": self.receivable_account.id,
                        "partner_id": partner.id,
                    },
                ),
                (
                    0,
                    0,
                    {
                        "name": move_name,
                        "debit": income_debit,
                        "credit": income_credit,
                        "account_id": self.income_account.id,
                        "partner_id": partner.id,
                    },
                ),
                (
                    0,
                    0,
                    {
                        "name": move_name,
                        "debit": unaffected_debit,
                        "credit": unaffected_credit,
                        "account_id": self.unaffected_account.id,
                        "partner_id": partner.id,
                    },
                ),
            ],
        }
        move = self.env["account.move"].create(move_vals)
        move.post()

    def _get_report_lines(self, with_partners=False):
        company = self.env.ref("base.main_company")
        general_ledger = self.env["report_general_ledger"].create(
            {
                "date_from": self.fy_date_start,
                "date_to": self.fy_date_end,
                "only_posted_moves": True,
                "hide_account_at_0": False,
                "company_id": company.id,
                "fy_start_date": self.fy_date_start,
            }
        )
        general_ledger.compute_data_for_report(
            with_line_details=True, with_partners=with_partners
        )
        lines = {}
        report_account_model = self.env["report_general_ledger_account"]
        lines["receivable"] = report_account_model.search(
            [
                ("report_id", "=", general_ledger.id),
                ("account_id", "=", self.receivable_account.id),
            ]
        )
        lines["income"] = report_account_model.search(
            [
                ("report_id", "=", general_ledger.id),
                ("account_id", "=", self.income_account.id),
            ]
        )
        lines["unaffected"] = report_account_model.search(
            [
                ("report_id", "=", general_ledger.id),
                ("account_id", "=", self.unaffected_account.id),
            ]
        )
        if with_partners:
            report_partner_model = self.env["report_general_ledger_partner"]
            lines["partner_receivable"] = report_partner_model.search(
                [
                    ("report_account_id", "=", lines["receivable"].id),
                    ("partner_id", "=", self.env.ref("base.res_partner_12").id),
                ]
            )
        return lines

    def test_01_account_balance(self):
        # Generate the general ledger line
        lines = self._get_report_lines()
        self.assertEqual(len(lines["receivable"]), 0)
        self.assertEqual(len(lines["income"]), 0)

        # Add a move at the previous day of the first day of fiscal year
        # to check the initial balance
        self._add_move(
            date=self.previous_fy_date_end,
            receivable_debit=1000,
            receivable_credit=0,
            income_debit=0,
            income_credit=1000,
        )

        # Re Generate the general ledger line
        lines = self._get_report_lines()
        self.assertEqual(len(lines["receivable"]), 1)
        self.assertEqual(len(lines["income"]), 0)

        # Check the initial and final balance
        self.assertEqual(lines["receivable"].initial_debit, 1000)
        self.assertEqual(lines["receivable"].initial_credit, 0)
        self.assertEqual(lines["receivable"].initial_balance, 1000)
        self.assertEqual(lines["receivable"].final_debit, 1000)
        self.assertEqual(lines["receivable"].final_credit, 0)
        self.assertEqual(lines["receivable"].final_balance, 1000)

        # Add reversale move of the initial move the first day of fiscal year
        # to check the first day of fiscal year is not used
        # to compute the initial balance
        self._add_move(
            date=self.fy_date_start,
            receivable_debit=0,
            receivable_credit=1000,
            income_debit=1000,
            income_credit=0,
        )

        # Re Generate the general ledger line
        lines = self._get_report_lines()
        self.assertEqual(len(lines["receivable"]), 1)
        self.assertEqual(len(lines["income"]), 1)

        # Check the initial and final balance
        self.assertEqual(lines["receivable"].initial_debit, 1000)
        self.assertEqual(lines["receivable"].initial_credit, 0)
        self.assertEqual(lines["receivable"].initial_balance, 1000)
        self.assertEqual(lines["receivable"].final_debit, 1000)
        self.assertEqual(lines["receivable"].final_credit, 1000)
        self.assertEqual(lines["receivable"].final_balance, 0)

        self.assertEqual(lines["income"].initial_debit, 0)
        self.assertEqual(lines["income"].initial_credit, 0)
        self.assertEqual(lines["income"].initial_balance, 0)
        self.assertEqual(lines["income"].final_debit, 1000)
        self.assertEqual(lines["income"].final_credit, 0)
        self.assertEqual(lines["income"].final_balance, 1000)

        # Add another move at the end day of fiscal year
        # to check that it correctly used on report
        self._add_move(
            date=self.fy_date_end,
            receivable_debit=0,
            receivable_credit=1000,
            income_debit=1000,
            income_credit=0,
        )

        # Re Generate the general ledger line
        lines = self._get_report_lines()
        self.assertEqual(len(lines["receivable"]), 1)
        self.assertEqual(len(lines["income"]), 1)

        # Check the initial and final balance
        self.assertEqual(lines["receivable"].initial_debit, 1000)
        self.assertEqual(lines["receivable"].initial_credit, 0)
        self.assertEqual(lines["receivable"].initial_balance, 1000)
        self.assertEqual(lines["receivable"].final_debit, 1000)
        self.assertEqual(lines["receivable"].final_credit, 2000)
        self.assertEqual(lines["receivable"].final_balance, -1000)

        self.assertEqual(lines["income"].initial_debit, 0)
        self.assertEqual(lines["income"].initial_credit, 0)
        self.assertEqual(lines["income"].initial_balance, 0)
        self.assertEqual(lines["income"].final_debit, 2000)
        self.assertEqual(lines["income"].final_credit, 0)
        self.assertEqual(lines["income"].final_balance, 2000)

    def test_02_partner_balance(self):
        # Generate the general ledger line
        lines = self._get_report_lines(with_partners=True)
        self.assertEqual(len(lines["partner_receivable"]), 0)

        # Add a move at the previous day of the first day of fiscal year
        # to check the initial balance
        self._add_move(
            date=self.previous_fy_date_end,
            receivable_debit=1000,
            receivable_credit=0,
            income_debit=0,
            income_credit=1000,
        )

        # Re Generate the general ledger line
        lines = self._get_report_lines(with_partners=True)
        self.assertEqual(len(lines["partner_receivable"]), 1)

        # Check the initial and final balance
        self.assertEqual(lines["partner_receivable"].initial_debit, 1000)
        self.assertEqual(lines["partner_receivable"].initial_credit, 0)
        self.assertEqual(lines["partner_receivable"].initial_balance, 1000)
        self.assertEqual(lines["partner_receivable"].final_debit, 1000)
        self.assertEqual(lines["partner_receivable"].final_credit, 0)
        self.assertEqual(lines["partner_receivable"].final_balance, 1000)

        # Add reversale move of the initial move the first day of fiscal year
        # to check the first day of fiscal year is not used
        # to compute the initial balance
        self._add_move(
            date=self.fy_date_start,
            receivable_debit=0,
            receivable_credit=1000,
            income_debit=1000,
            income_credit=0,
        )

        # Re Generate the general ledger line
        lines = self._get_report_lines(with_partners=True)
        self.assertEqual(len(lines["partner_receivable"]), 1)

        # Check the initial and final balance
        self.assertEqual(lines["partner_receivable"].initial_debit, 1000)
        self.assertEqual(lines["partner_receivable"].initial_credit, 0)
        self.assertEqual(lines["partner_receivable"].initial_balance, 1000)
        self.assertEqual(lines["partner_receivable"].final_debit, 1000)
        self.assertEqual(lines["partner_receivable"].final_credit, 1000)
        self.assertEqual(lines["partner_receivable"].final_balance, 0)

        # Add another move at the end day of fiscal year
        # to check that it correctly used on report
        self._add_move(
            date=self.fy_date_end,
            receivable_debit=0,
            receivable_credit=1000,
            income_debit=1000,
            income_credit=0,
        )

        # Re Generate the general ledger line
        lines = self._get_report_lines(with_partners=True)
        self.assertEqual(len(lines["partner_receivable"]), 1)

        # Check the initial and final balance
        self.assertEqual(lines["partner_receivable"].initial_debit, 1000)
        self.assertEqual(lines["partner_receivable"].initial_credit, 0)
        self.assertEqual(lines["partner_receivable"].initial_balance, 1000)
        self.assertEqual(lines["partner_receivable"].final_debit, 1000)
        self.assertEqual(lines["partner_receivable"].final_credit, 2000)
        self.assertEqual(lines["partner_receivable"].final_balance, -1000)

    def test_03_unaffected_account_balance(self):
        # Generate the general ledger line
        lines = self._get_report_lines()
        self.assertEqual(len(lines["unaffected"]), 1)

        # Check the initial and final balance
        self.assertEqual(lines["unaffected"].initial_debit, 0)
        self.assertEqual(lines["unaffected"].initial_credit, 0)
        self.assertEqual(lines["unaffected"].initial_balance, 0)
        self.assertEqual(lines["unaffected"].final_debit, 0)
        self.assertEqual(lines["unaffected"].final_credit, 0)
        self.assertEqual(lines["unaffected"].final_balance, 0)

        # Add a move at the previous day of the first day of fiscal year
        # to check the initial balance
        self._add_move(
            date=self.previous_fy_date_end,
            receivable_debit=1000,
            receivable_credit=0,
            income_debit=0,
            income_credit=1000,
        )

        # Re Generate the general ledger line
        lines = self._get_report_lines()
        self.assertEqual(len(lines["unaffected"]), 1)

        # Check the initial and final balance
        self.assertEqual(lines["unaffected"].initial_debit, 0)
        self.assertEqual(lines["unaffected"].initial_credit, 1000)
        self.assertEqual(lines["unaffected"].initial_balance, -1000)
        self.assertEqual(lines["unaffected"].final_debit, 0)
        self.assertEqual(lines["unaffected"].final_credit, 1000)
        self.assertEqual(lines["unaffected"].final_balance, -1000)

        # Add reversale move of the initial move the first day of fiscal year
        # to check the first day of fiscal year is not used
        # to compute the initial balance
        self._add_move(
            date=self.fy_date_start,
            receivable_debit=0,
            receivable_credit=0,
            income_debit=0,
            income_credit=1000,
            unaffected_debit=1000,
            unaffected_credit=0,
        )

        # Re Generate the general ledger line
        lines = self._get_report_lines()
        self.assertEqual(len(lines["unaffected"]), 1)

        # Check the initial and final balance
        self.assertEqual(lines["unaffected"].initial_debit, 0)
        self.assertEqual(lines["unaffected"].initial_credit, 1000)
        self.assertEqual(lines["unaffected"].initial_balance, -1000)
        self.assertEqual(lines["unaffected"].final_debit, 1000)
        self.assertEqual(lines["unaffected"].final_credit, 1000)
        self.assertEqual(lines["unaffected"].final_balance, 0)

        # Add another move at the end day of fiscal year
        # to check that it correctly used on report
        self._add_move(
            date=self.fy_date_end,
            receivable_debit=3000,
            receivable_credit=0,
            income_debit=0,
            income_credit=0,
            unaffected_debit=0,
            unaffected_credit=3000,
        )

        # Re Generate the general ledger line
        lines = self._get_report_lines()
        self.assertEqual(len(lines["unaffected"]), 1)

        # Check the initial and final balance
        self.assertEqual(lines["unaffected"].initial_debit, 0)
        self.assertEqual(lines["unaffected"].initial_credit, 1000)
        self.assertEqual(lines["unaffected"].initial_balance, -1000)
        self.assertEqual(lines["unaffected"].final_debit, 1000)
        self.assertEqual(lines["unaffected"].final_credit, 4000)
        self.assertEqual(lines["unaffected"].final_balance, -3000)

    def test_04_unaffected_account_balance_2_years(self):
        # Generate the general ledger line
        lines = self._get_report_lines()
        self.assertEqual(len(lines["unaffected"]), 1)

        # Check the initial and final balance
        self.assertEqual(lines["unaffected"].initial_debit, 0)
        self.assertEqual(lines["unaffected"].initial_credit, 0)
        self.assertEqual(lines["unaffected"].initial_balance, 0)
        self.assertEqual(lines["unaffected"].final_debit, 0)
        self.assertEqual(lines["unaffected"].final_credit, 0)
        self.assertEqual(lines["unaffected"].final_balance, 0)

        # Add a move at any date 2 years before the balance
        # (to create an historic)
        self._add_move(
            date=self.before_previous_fy_year,
            receivable_debit=0,
            receivable_credit=1000,
            income_debit=1000,
            income_credit=0,
        )

        # Re Generate the general ledger line
        lines = self._get_report_lines()
        self.assertEqual(len(lines["unaffected"]), 1)

        # Check the initial and final balance
        self.assertEqual(lines["unaffected"].initial_debit, 1000)
        self.assertEqual(lines["unaffected"].initial_credit, 0)
        self.assertEqual(lines["unaffected"].initial_balance, 1000)
        self.assertEqual(lines["unaffected"].final_debit, 1000)
        self.assertEqual(lines["unaffected"].final_credit, 0)
        self.assertEqual(lines["unaffected"].final_balance, 1000)

        # Affect the company's result last year
        self._add_move(
            date=self.previous_fy_date_start,
            receivable_debit=1000,
            receivable_credit=0,
            income_debit=0,
            income_credit=0,
            unaffected_debit=0,
            unaffected_credit=1000,
        )

        # Add another move last year to test the initial balance this year
        self._add_move(
            date=self.previous_fy_date_start,
            receivable_debit=0,
            receivable_credit=500,
            income_debit=500,
            income_credit=0,
            unaffected_debit=0,
            unaffected_credit=0,
        )
        # Re Generate the general ledger line
        lines = self._get_report_lines()
        self.assertEqual(len(lines["unaffected"]), 1)

        # Check the initial and final balance
        self.assertEqual(lines["unaffected"].initial_debit, 500)
        self.assertEqual(lines["unaffected"].initial_credit, 0)
        self.assertEqual(lines["unaffected"].initial_balance, 500)
        self.assertEqual(lines["unaffected"].final_debit, 500)
        self.assertEqual(lines["unaffected"].final_credit, 0)
        self.assertEqual(lines["unaffected"].final_balance, 500)

    def test_partner_filter(self):
        partner_1 = self.env.ref("base.res_partner_1")
        partner_2 = self.env.ref("base.res_partner_2")
        partner_3 = self.env.ref("base.res_partner_3")
        partner_4 = self.env.ref("base.res_partner_4")
        partner_1.write({"is_company": False, "parent_id": partner_2.id})
        partner_3.write({"is_company": False})

        expected_list = [partner_2.id, partner_3.id, partner_4.id]
        context = {
            "active_ids": [partner_1.id, partner_2.id, partner_3.id, partner_4.id],
            "active_model": "res.partner",
        }

        wizard = self.env["general.ledger.report.wizard"].with_context(context)
        self.assertEqual(wizard._default_partners(), expected_list)

    def test_validate_date(self):
        company_id = self.env.ref("base.main_company")
        company_id.write(
            {"fiscalyear_last_day": 31, "fiscalyear_last_month": 12,}
        )
        user = self.env.ref("base.user_root").with_context(company_id=company_id.id)
        wizard = self.env["general.ledger.report.wizard"].with_context(user=user.id)
        self.assertEqual(wizard._init_date_from(), time.strftime("%Y") + "-01-01")

    def test_validate_date_range(self):
        data_type = self.env["date.range.type"].create(
            {"name": "Fiscal year", "company_id": False, "allow_overlap": False}
        )

        dr = self.env["date.range"].create(
            {
                "name": "FS2015",
                "date_start": "2018-01-01",
                "date_end": "2018-12-31",
                "type_id": data_type.id,
            }
        )

        wizard = self.env["general.ledger.report.wizard"].create(
            {"date_range_id": dr.id}
        )
        wizard.onchange_date_range_id()
        self.assertEqual(wizard.date_from, date(2018, 1, 1))
        self.assertEqual(wizard.date_to, date(2018, 12, 31))