Compare commits
23 Commits
Author | SHA1 | Date | |
---|---|---|---|
621020b0f0 | |||
6ad36cfaa3 | |||
20b0412091 | |||
3ca246d3e0 | |||
85d1b13ccd | |||
3bada28b8f | |||
8f2cef8d81 | |||
e62316c477 | |||
24ddb0c278 | |||
536f3390aa | |||
fadd8e73b6 | |||
12ccf658bf | |||
e30d1257e5 | |||
404b902d88 | |||
a560ff175a | |||
4be1ead6b5 | |||
700e4f822a | |||
c21ed59dfe | |||
c4a8326bfc | |||
371c80f668 | |||
40be3fb664 | |||
1e56403b35 | |||
650c26036a |
54
README.rst
54
README.rst
@ -7,7 +7,8 @@ Description
|
||||
===========
|
||||
|
||||
*Mia! Accounting* is an accounting module for Flask_ applications.
|
||||
It implements `double-entry bookkeeping`_, and generates the following
|
||||
It is designed both for mobile and desktop environments. It
|
||||
implements `double-entry bookkeeping`_. It generates the following
|
||||
accounting reports:
|
||||
|
||||
* Trial balance
|
||||
@ -18,6 +19,18 @@ In addition, *Mia! Accounting* tracks offsets for unpaid payables and
|
||||
receivables.
|
||||
|
||||
|
||||
Live Demonstration and Test Site
|
||||
================================
|
||||
|
||||
There is a `live demonstration`_ for *Mia! Accounting*. It runs the
|
||||
same code as the `test site`_ in the `source distribution`_. It is
|
||||
the simplest website that works with *Mia! Accounting*. It is also
|
||||
used in the automatic tests.
|
||||
|
||||
If you do not have a running Flask application or do not know how to
|
||||
start one, you may start with the test site.
|
||||
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
@ -27,27 +40,16 @@ Install *Mia! Accounting* with ``pip``:
|
||||
|
||||
pip install mia-accounting
|
||||
|
||||
You may also download the from the `PyPI project page`_ or the
|
||||
You may also download from the `PyPI project page`_ or the
|
||||
`release page`_ on the `Git repository`_.
|
||||
|
||||
|
||||
Test Site and Live Demonstration
|
||||
================================
|
||||
|
||||
You may find a working example in the `test site`_ in the
|
||||
`source distribution`_. It is the simplest website that works with
|
||||
*Mia! Accounting*. It is used in the automatic tests. It is the same
|
||||
code run for `live demonstration`_.
|
||||
|
||||
If you do not have a running Flask application or do not know how to
|
||||
start one, you may start with the test site.
|
||||
|
||||
|
||||
Prerequisites
|
||||
=============
|
||||
|
||||
You need a running Flask application with database user login.
|
||||
The primary key of the user data model must be integer.
|
||||
The primary key of the user data model must be integer. You also
|
||||
need at least one user.
|
||||
|
||||
The following front-end JavaScript libraries must be loaded. You may
|
||||
download it locally or use CDN_.
|
||||
@ -122,24 +124,13 @@ The following is an example configuration for *Mia! Accounting*.
|
||||
Database Initialization
|
||||
=======================
|
||||
|
||||
After the configuration, you need to run
|
||||
`flask_sqlalchemy.SQLAlchemy.create_all`_ to create the
|
||||
database tables that *Mia! Accounting* uses.
|
||||
|
||||
*Mia! Accounting* adds three console commands:
|
||||
|
||||
* ``accounting-init-base``
|
||||
* ``accounting-init-accounts``
|
||||
* ``accounting-init-currencies``
|
||||
|
||||
After database tables are created, run
|
||||
``accounting-init-base`` first, and then the other two commands.
|
||||
After the configuration, run the ``accounting-init-db`` console
|
||||
command to initialize the accounting database. You need to specify
|
||||
the username of a user as the data creator.
|
||||
|
||||
::
|
||||
|
||||
% flask --app myapp accounting-init-base
|
||||
% flask --app myapp accounting-init-accounts
|
||||
% flask --app myapp accounting-init-currencies
|
||||
% flask --app myapp accounting-init-db -u username
|
||||
|
||||
|
||||
Navigation Menu
|
||||
@ -201,9 +192,9 @@ Authors
|
||||
|
||||
.. _Flask: https://flask.palletsprojects.com
|
||||
.. _double-entry bookkeeping: https://en.wikipedia.org/wiki/Double-entry_bookkeeping
|
||||
.. _live demonstration: https://accounting.imacat.idv.tw
|
||||
.. _test site: https://github.com/imacat/mia-accounting/tree/main/tests/test_site
|
||||
.. _source distribution: https://pypi.org/project/mia-accounting/#files
|
||||
.. _live demonstration: https://accounting.imacat.idv.tw
|
||||
.. _PyPI project page: https://pypi.org/project/mia-accounting
|
||||
.. _release page: https://github.com/imacat/mia-accounting/releases
|
||||
.. _Git repository: https://github.com/imacat/mia-accounting
|
||||
@ -214,6 +205,5 @@ Authors
|
||||
.. _Tempus-Dominus: https://getdatepicker.com
|
||||
.. _UserUtilityInterface: https://mia-accounting.readthedocs.io/en/latest/accounting.utils.html#accounting.utils.user.UserUtilityInterface
|
||||
.. _init_app: https://mia-accounting.readthedocs.io/en/latest/accounting.html#accounting.init_app
|
||||
.. _flask_sqlalchemy.SQLAlchemy.create_all: https://flask-sqlalchemy.palletsprojects.com/en/3.0.x/api/#flask_sqlalchemy.SQLAlchemy.create_all
|
||||
.. _Bootstrap navigation bar: https://getbootstrap.com/docs/5.3/components/navbar/
|
||||
.. _documentation on Read the Docs: https://mia-accounting.readthedocs.io
|
||||
|
@ -19,6 +19,14 @@ Subpackages
|
||||
Submodules
|
||||
----------
|
||||
|
||||
accounting.commands module
|
||||
--------------------------
|
||||
|
||||
.. automodule:: accounting.commands
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
accounting.forms module
|
||||
-----------------------
|
||||
|
||||
|
@ -13,7 +13,7 @@ sys.path.insert(0, os.path.abspath('../../src/'))
|
||||
project = 'Mia! Accounting'
|
||||
copyright = '2023, imacat'
|
||||
author = 'imacat'
|
||||
release = '1.2.0'
|
||||
release = '1.3.2'
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||
|
@ -2,7 +2,8 @@ Introduction
|
||||
============
|
||||
|
||||
*Mia! Accounting* is an accounting module for Flask_ applications.
|
||||
It implements `double-entry bookkeeping`_, and generates the following
|
||||
It is designed both for mobile and desktop environments. It
|
||||
implements `double-entry bookkeeping`_. It generates the following
|
||||
accounting reports:
|
||||
|
||||
* Trial balance
|
||||
@ -13,6 +14,18 @@ In addition, *Mia! Accounting* tracks offsets for unpaid payables and
|
||||
receivables.
|
||||
|
||||
|
||||
Live Demonstration and Test Site
|
||||
--------------------------------
|
||||
|
||||
There is a `live demonstration`_ for *Mia! Accounting*. It runs the
|
||||
same code as the `test site`_ in the `source distribution`_. It is
|
||||
the simplest website that works with *Mia! Accounting*. It is also
|
||||
used in the automatic tests.
|
||||
|
||||
If you do not have a running Flask application or do not know how to
|
||||
start one, you may start with the test site.
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
@ -22,27 +35,16 @@ Install *Mia! Accounting* with ``pip``:
|
||||
|
||||
pip install mia-accounting
|
||||
|
||||
You may also download the from the `PyPI project page`_ or the
|
||||
You may also download from the `PyPI project page`_ or the
|
||||
`release page`_ on the `Git repository`_.
|
||||
|
||||
|
||||
Test Site and Live Demonstration
|
||||
--------------------------------
|
||||
|
||||
You may find a working example in the `test site`_ in the
|
||||
`source distribution`_. It is the simplest website that works with
|
||||
*Mia! Accounting*. It is used in the automatic tests. It is the same
|
||||
code run for `live demonstration`_.
|
||||
|
||||
If you do not have a running Flask application or do not know how to
|
||||
start one, you may start with the test site.
|
||||
|
||||
|
||||
Prerequisites
|
||||
-------------
|
||||
|
||||
You need a running Flask application with database user login.
|
||||
The primary key of the user data model must be integer.
|
||||
The primary key of the user data model must be integer. You also
|
||||
need at least one user.
|
||||
|
||||
The following front-end JavaScript libraries must be loaded. You may
|
||||
download it locally or use CDN_.
|
||||
@ -67,24 +69,13 @@ See an example in :ref:`example-userutils`.
|
||||
Database Initialization
|
||||
-----------------------
|
||||
|
||||
After the configuration, you need to run
|
||||
`flask_sqlalchemy.SQLAlchemy.create_all`_ to create the
|
||||
database tables that *Mia! Accounting* uses.
|
||||
|
||||
*Mia! Accounting* adds three console commands:
|
||||
|
||||
* ``accounting-init-base``
|
||||
* ``accounting-init-accounts``
|
||||
* ``accounting-init-currencies``
|
||||
|
||||
After database tables are created, run
|
||||
``accounting-init-base`` first, and then the other two commands.
|
||||
After the configuration, run the ``accounting-init-db`` console
|
||||
command to initialize the accounting database. You need to specify
|
||||
the username of a user as the data creator.
|
||||
|
||||
::
|
||||
|
||||
% flask --app myapp accounting-init-base
|
||||
% flask --app myapp accounting-init-accounts
|
||||
% flask --app myapp accounting-init-currencies
|
||||
% flask --app myapp accounting-init-db -u username
|
||||
|
||||
|
||||
Navigation Menu
|
||||
@ -120,9 +111,9 @@ Refer to the `documentation on Read the Docs`_.
|
||||
|
||||
.. _Flask: https://flask.palletsprojects.com
|
||||
.. _double-entry bookkeeping: https://en.wikipedia.org/wiki/Double-entry_bookkeeping
|
||||
.. _live demonstration: https://accounting.imacat.idv.tw
|
||||
.. _test site: https://github.com/imacat/mia-accounting/tree/main/tests/test_site
|
||||
.. _source distribution: https://pypi.org/project/mia-accounting/#files
|
||||
.. _live demonstration: https://accounting.imacat.idv.tw
|
||||
.. _PyPI project page: https://pypi.org/project/mia-accounting
|
||||
.. _release page: https://github.com/imacat/mia-accounting/releases
|
||||
.. _Git repository: https://github.com/imacat/mia-accounting
|
||||
@ -131,6 +122,5 @@ Refer to the `documentation on Read the Docs`_.
|
||||
.. _FontAwesome: https://fontawesome.com
|
||||
.. _Decimal.js: https://mikemcl.github.io/decimal.js
|
||||
.. _Tempus-Dominus: https://getdatepicker.com
|
||||
.. _flask_sqlalchemy.SQLAlchemy.create_all: https://flask-sqlalchemy.palletsprojects.com/en/3.0.x/api/#flask_sqlalchemy.SQLAlchemy.create_all
|
||||
.. _Bootstrap navigation bar: https://getbootstrap.com/docs/5.3/components/navbar/
|
||||
.. _documentation on Read the Docs: https://mia-accounting.readthedocs.io
|
||||
|
@ -17,7 +17,7 @@
|
||||
|
||||
[project]
|
||||
name = "mia-accounting"
|
||||
version = "1.2.0"
|
||||
version = "1.3.2"
|
||||
description = "A Flask accounting module."
|
||||
readme = "README.rst"
|
||||
requires-python = ">=3.11"
|
||||
|
@ -61,6 +61,9 @@ def init_app(app: Flask, user_utils: UserUtilityInterface,
|
||||
bp.add_app_template_global(default_currency_code,
|
||||
"accounting_default_currency_code")
|
||||
|
||||
from .commands import init_db_command
|
||||
app.cli.add_command(init_db_command)
|
||||
|
||||
from . import locale
|
||||
locale.init_app(app, bp)
|
||||
|
||||
|
@ -19,6 +19,8 @@
|
||||
"""
|
||||
from flask import Flask, Blueprint
|
||||
|
||||
from .commands import init_accounts_command
|
||||
|
||||
|
||||
def init_app(app: Flask, bp: Blueprint) -> None:
|
||||
"""Initialize the application.
|
||||
@ -32,6 +34,3 @@ def init_app(app: Flask, bp: Blueprint) -> None:
|
||||
|
||||
from .views import bp as account_bp
|
||||
bp.register_blueprint(account_bp, url_prefix="/accounts")
|
||||
|
||||
from .commands import init_accounts_command
|
||||
app.cli.add_command(init_accounts_command)
|
||||
|
@ -17,44 +17,21 @@
|
||||
"""The console commands for the account management.
|
||||
|
||||
"""
|
||||
import os
|
||||
import typing as t
|
||||
from secrets import randbelow
|
||||
|
||||
import click
|
||||
from flask.cli import with_appcontext
|
||||
|
||||
from accounting import db
|
||||
from accounting.models import BaseAccount, Account, AccountL10n
|
||||
from accounting.utils.user import has_user, get_user_pk
|
||||
from accounting.utils.user import get_user_pk
|
||||
import sqlalchemy as sa
|
||||
|
||||
AccountData = tuple[int, str, int, str, str, str, bool]
|
||||
"""The format of the account data, as a list of (ID, base account code, number,
|
||||
English, Traditional Chinese, Simplified Chinese, is-need-offset) tuples."""
|
||||
|
||||
|
||||
def __validate_username(ctx: click.core.Context, param: click.core.Option,
|
||||
value: str) -> str:
|
||||
"""Validates the username for the click console command.
|
||||
|
||||
:param ctx: The console command context.
|
||||
:param param: The console command option.
|
||||
:param value: The username.
|
||||
:raise click.BadParameter: When validation fails.
|
||||
:return: The username.
|
||||
"""
|
||||
value = value.strip()
|
||||
if value == "":
|
||||
raise click.BadParameter("Username empty.")
|
||||
if not has_user(value):
|
||||
raise click.BadParameter(f"User {value} does not exist.")
|
||||
return value
|
||||
|
||||
|
||||
@click.command("accounting-init-accounts")
|
||||
@click.option("-u", "--username", metavar="USERNAME", prompt=True,
|
||||
help="The username.", callback=__validate_username,
|
||||
default=lambda: os.getlogin())
|
||||
@with_appcontext
|
||||
def init_accounts_command(username: str) -> None:
|
||||
"""Initializes the accounts."""
|
||||
creator_pk: int = get_user_pk(username)
|
||||
@ -63,8 +40,6 @@ def init_accounts_command(username: str) -> None:
|
||||
.filter(db.func.length(BaseAccount.code) == 4)\
|
||||
.order_by(BaseAccount.code).all()
|
||||
if len(bases) == 0:
|
||||
click.echo("Please initialize the base accounts with "
|
||||
"\"flask accounting-init-base\" first.")
|
||||
raise click.Abort
|
||||
|
||||
existing: list[Account] = Account.query.all()
|
||||
@ -73,7 +48,6 @@ def init_accounts_command(username: str) -> None:
|
||||
bases_to_add: list[BaseAccount] = [x for x in bases
|
||||
if x.code not in existing_base_code]
|
||||
if len(bases_to_add) == 0:
|
||||
click.echo("No more account to import.")
|
||||
return
|
||||
|
||||
existing_id: set[int] = {x.id for x in existing}
|
||||
@ -89,14 +63,24 @@ def init_accounts_command(username: str) -> None:
|
||||
existing_id.add(new_id)
|
||||
return new_id
|
||||
|
||||
data: list[AccountData] = []
|
||||
data: list[dict[str, t.Any]] = []
|
||||
l10n_data: list[dict[str, t.Any]] = []
|
||||
for base in bases_to_add:
|
||||
l10n: dict[str, str] = {x.locale: x.title for x in base.l10n}
|
||||
is_need_offset: bool = __is_need_offset(base.code)
|
||||
data.append((get_new_id(), base.code, 1, base.title_l10n,
|
||||
l10n["zh_Hant"], l10n["zh_Hans"], is_need_offset))
|
||||
__add_accounting_accounts(data, creator_pk)
|
||||
click.echo(F"{len(data)} added. Accounting accounts initialized.")
|
||||
account_id: int = get_new_id()
|
||||
data.append({"id": account_id,
|
||||
"base_code": base.code,
|
||||
"no": 1,
|
||||
"title_l10n": base.title_l10n,
|
||||
"is_need_offset": __is_need_offset(base.code),
|
||||
"created_by_id": creator_pk,
|
||||
"updated_by_id": creator_pk})
|
||||
for locale in {"zh_Hant", "zh_Hans"}:
|
||||
l10n_data.append({"account_id": account_id,
|
||||
"locale": locale,
|
||||
"title": l10n[locale]})
|
||||
db.session.execute(sa.insert(Account), data)
|
||||
db.session.execute(sa.insert(AccountL10n), l10n_data)
|
||||
|
||||
|
||||
def __is_need_offset(base_code: str) -> bool:
|
||||
@ -121,29 +105,3 @@ def __is_need_offset(base_code: str) -> bool:
|
||||
return True
|
||||
# Only assets and liabilities need offset
|
||||
return False
|
||||
|
||||
|
||||
def __add_accounting_accounts(data: list[AccountData], creator_pk: int)\
|
||||
-> None:
|
||||
"""Adds the accounts.
|
||||
|
||||
:param data: A list of (base code, number, title) tuples.
|
||||
:param creator_pk: The primary key of the creator.
|
||||
:return: None.
|
||||
"""
|
||||
accounts: list[Account] = [Account(id=x[0],
|
||||
base_code=x[1],
|
||||
no=x[2],
|
||||
title_l10n=x[3],
|
||||
is_need_offset=x[6],
|
||||
created_by_id=creator_pk,
|
||||
updated_by_id=creator_pk)
|
||||
for x in data]
|
||||
l10n: list[AccountL10n] = [AccountL10n(account_id=x[0],
|
||||
locale=y[0],
|
||||
title=y[1])
|
||||
for x in data
|
||||
for y in (("zh_Hant", x[4]), ("zh_Hans", x[5]))]
|
||||
db.session.bulk_save_objects(accounts)
|
||||
db.session.bulk_save_objects(l10n)
|
||||
db.session.commit()
|
||||
|
@ -19,6 +19,8 @@
|
||||
"""
|
||||
from flask import Flask, Blueprint
|
||||
|
||||
from .commands import init_base_accounts_command
|
||||
|
||||
|
||||
def init_app(app: Flask, bp: Blueprint) -> None:
|
||||
"""Initialize the application.
|
||||
@ -32,6 +34,3 @@ def init_app(app: Flask, bp: Blueprint) -> None:
|
||||
|
||||
from .views import bp as base_account_bp
|
||||
bp.register_blueprint(base_account_bp, url_prefix="/base-accounts")
|
||||
|
||||
from .commands import init_base_accounts_command
|
||||
app.cli.add_command(init_base_accounts_command)
|
||||
|
@ -19,21 +19,17 @@
|
||||
"""
|
||||
import csv
|
||||
|
||||
import click
|
||||
from flask.cli import with_appcontext
|
||||
import sqlalchemy as sa
|
||||
|
||||
from accounting import data_dir
|
||||
from accounting import db
|
||||
from accounting.models import BaseAccount, BaseAccountL10n
|
||||
|
||||
|
||||
@click.command("accounting-init-base")
|
||||
@with_appcontext
|
||||
def init_base_accounts_command() -> None:
|
||||
"""Initializes the base accounts."""
|
||||
if BaseAccount.query.first() is not None:
|
||||
click.echo("Base accounts already exist.")
|
||||
raise click.Abort
|
||||
return
|
||||
|
||||
with open(data_dir / "base_accounts.csv") as fp:
|
||||
data: list[dict[str, str]] = [x for x in csv.DictReader(fp)]
|
||||
@ -45,7 +41,5 @@ def init_base_accounts_command() -> None:
|
||||
"locale": y,
|
||||
"title": x[f"l10n-{y}"]}
|
||||
for x in data for y in locales]
|
||||
db.session.bulk_insert_mappings(BaseAccount, account_data)
|
||||
db.session.bulk_insert_mappings(BaseAccountL10n, l10n_data)
|
||||
db.session.commit()
|
||||
click.echo("Base accounts initialized.")
|
||||
db.session.execute(sa.insert(BaseAccount), account_data)
|
||||
db.session.execute(sa.insert(BaseAccountL10n), l10n_data)
|
||||
|
62
src/accounting/commands.py
Normal file
62
src/accounting/commands.py
Normal file
@ -0,0 +1,62 @@
|
||||
# The Mia! Accounting Project.
|
||||
# Author: imacat@mail.imacat.idv.tw (imacat), 2023/4/10
|
||||
|
||||
# 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 console commands.
|
||||
|
||||
"""
|
||||
import os
|
||||
|
||||
import click
|
||||
from flask.cli import with_appcontext
|
||||
|
||||
from accounting import db
|
||||
from accounting.account import init_accounts_command
|
||||
from accounting.base_account import init_base_accounts_command
|
||||
from accounting.currency import init_currencies_command
|
||||
from accounting.utils.user import has_user
|
||||
|
||||
|
||||
def __validate_username(ctx: click.core.Context, param: click.core.Option,
|
||||
value: str) -> str:
|
||||
"""Validates the username for the click console command.
|
||||
|
||||
:param ctx: The console command context.
|
||||
:param param: The console command option.
|
||||
:param value: The username.
|
||||
:raise click.BadParameter: When validation fails.
|
||||
:return: The username.
|
||||
"""
|
||||
value = value.strip()
|
||||
if value == "":
|
||||
raise click.BadParameter("Username empty.")
|
||||
if not has_user(value):
|
||||
raise click.BadParameter(f"User {value} does not exist.")
|
||||
return value
|
||||
|
||||
|
||||
@click.command("accounting-init-db")
|
||||
@click.option("-u", "--username", metavar="USERNAME", prompt=True,
|
||||
help="The username.", callback=__validate_username,
|
||||
default=lambda: os.getlogin())
|
||||
@with_appcontext
|
||||
def init_db_command(username: str) -> None:
|
||||
"""Initializes the accounting database."""
|
||||
db.create_all()
|
||||
init_base_accounts_command()
|
||||
init_accounts_command(username)
|
||||
init_currencies_command(username)
|
||||
db.session.commit()
|
||||
click.echo("Accounting database initialized.")
|
@ -19,6 +19,8 @@
|
||||
"""
|
||||
from flask import Flask, Blueprint
|
||||
|
||||
from .commands import init_currencies_command
|
||||
|
||||
|
||||
def init_app(app: Flask, bp: Blueprint) -> None:
|
||||
"""Initialize the application.
|
||||
@ -33,6 +35,3 @@ def init_app(app: Flask, bp: Blueprint) -> None:
|
||||
from .views import bp as currency_bp, api_bp as currency_api_bp
|
||||
bp.register_blueprint(currency_bp, url_prefix="/currencies")
|
||||
bp.register_blueprint(currency_api_bp, url_prefix="/api/currencies")
|
||||
|
||||
from .commands import init_currencies_command
|
||||
app.cli.add_command(init_currencies_command)
|
||||
|
@ -18,42 +18,15 @@
|
||||
|
||||
"""
|
||||
import csv
|
||||
import os
|
||||
import typing as t
|
||||
|
||||
import click
|
||||
from flask.cli import with_appcontext
|
||||
import sqlalchemy as sa
|
||||
|
||||
from accounting import db, data_dir
|
||||
from accounting.models import Currency, CurrencyL10n
|
||||
from accounting.utils.user import has_user, get_user_pk
|
||||
|
||||
CurrencyData = tuple[str, str, str, str]
|
||||
from accounting.utils.user import get_user_pk
|
||||
|
||||
|
||||
def __validate_username(ctx: click.core.Context, param: click.core.Option,
|
||||
value: str) -> str:
|
||||
"""Validates the username for the click console command.
|
||||
|
||||
:param ctx: The console command context.
|
||||
:param param: The console command option.
|
||||
:param value: The username.
|
||||
:raise click.BadParameter: When validation fails.
|
||||
:return: The username.
|
||||
"""
|
||||
value = value.strip()
|
||||
if value == "":
|
||||
raise click.BadParameter("Username empty.")
|
||||
if not has_user(value):
|
||||
raise click.BadParameter(f"User {value} does not exist.")
|
||||
return value
|
||||
|
||||
|
||||
@click.command("accounting-init-currencies")
|
||||
@click.option("-u", "--username", metavar="USERNAME", prompt=True,
|
||||
help="The username.", callback=__validate_username,
|
||||
default=lambda: os.getlogin())
|
||||
@with_appcontext
|
||||
def init_currencies_command(username: str) -> None:
|
||||
"""Initializes the currencies."""
|
||||
existing_codes: set[str] = {x.code for x in Currency.query.all()}
|
||||
@ -63,7 +36,6 @@ def init_currencies_command(username: str) -> None:
|
||||
to_add: list[dict[str, str]] = [x for x in data
|
||||
if x["code"] not in existing_codes]
|
||||
if len(to_add) == 0:
|
||||
click.echo("No more currency to add.")
|
||||
return
|
||||
|
||||
creator_pk: int = get_user_pk(username)
|
||||
@ -77,8 +49,5 @@ def init_currencies_command(username: str) -> None:
|
||||
"locale": y,
|
||||
"name": x[f"l10n-{y}"]}
|
||||
for x in to_add for y in locales]
|
||||
db.session.bulk_insert_mappings(Currency, currency_data)
|
||||
db.session.bulk_insert_mappings(CurrencyL10n, l10n_data)
|
||||
db.session.commit()
|
||||
|
||||
click.echo(F"{len(to_add)} added. Currencies initialized.")
|
||||
db.session.execute(sa.insert(Currency), currency_data)
|
||||
db.session.execute(sa.insert(CurrencyL10n), l10n_data)
|
||||
|
@ -20,11 +20,10 @@
|
||||
from datetime import date
|
||||
|
||||
from flask import abort
|
||||
from sqlalchemy.orm import selectinload
|
||||
from werkzeug.routing import BaseConverter
|
||||
|
||||
from accounting import db
|
||||
from accounting.models import JournalEntry, JournalEntryLineItem
|
||||
from accounting.models import JournalEntry
|
||||
from accounting.utils.journal_entry_types import JournalEntryType
|
||||
|
||||
|
||||
|
@ -151,6 +151,17 @@ class LineItemCollector:
|
||||
== journal_entry_date.day))
|
||||
except ValueError:
|
||||
pass
|
||||
try:
|
||||
journal_entry_date = datetime.strptime(k, "%Y/%m/%d")
|
||||
conditions.append(sa.and_(
|
||||
sa.extract("year", JournalEntry.date)
|
||||
== journal_entry_date.year,
|
||||
sa.extract("month", JournalEntry.date)
|
||||
== journal_entry_date.month,
|
||||
sa.extract("day", JournalEntry.date)
|
||||
== journal_entry_date.day))
|
||||
except ValueError:
|
||||
pass
|
||||
return sa.select(JournalEntry.id).filter(sa.or_(*conditions))
|
||||
|
||||
|
||||
|
@ -51,12 +51,14 @@ First written: 2023/1/26
|
||||
{{ A_("Currencies") }}
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="dropdown-item {% if request.endpoint and request.endpoint.startswith("accounting.unmatched-offset.") %} active {% endif %}" href="{{ url_for("accounting.unmatched-offset.dashboard") }}">
|
||||
<i class="fa-solid fa-link-slash"></i>
|
||||
{{ A_("Unmatched Offsets") }}
|
||||
</a>
|
||||
</li>
|
||||
{% if accounting_can_edit() %}
|
||||
<li>
|
||||
<a class="dropdown-item {% if request.endpoint and request.endpoint.startswith("accounting.unmatched-offset.") %} active {% endif %}" href="{{ url_for("accounting.unmatched-offset.dashboard") }}">
|
||||
<i class="fa-solid fa-link-slash"></i>
|
||||
{{ A_("Unmatched Offsets") }}
|
||||
</a>
|
||||
</li>
|
||||
{% endif %}
|
||||
{% if accounting_can_admin() %}
|
||||
<li>
|
||||
<a class="dropdown-item {% if request.endpoint and request.endpoint.startswith("accounting.option.") %} active {% endif %}" href="{{ url_for("accounting.option.detail") }}">
|
||||
|
@ -129,5 +129,5 @@ def __update_file_rev_date(file: Path) -> None:
|
||||
main.add_command(babel_extract)
|
||||
main.add_command(babel_compile)
|
||||
|
||||
if __name__ == '__main__':
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
|
@ -129,5 +129,5 @@ def __update_file_rev_date(file: Path) -> None:
|
||||
main.add_command(babel_extract)
|
||||
main.add_command(babel_compile)
|
||||
|
||||
if __name__ == '__main__':
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
|
306
tests/make-sample.py
Executable file
306
tests/make-sample.py
Executable file
@ -0,0 +1,306 @@
|
||||
#! env python3
|
||||
# The Mia! Accounting Project.
|
||||
# Author: imacat@mail.imacat.idv.tw (imacat), 2023/4/9
|
||||
|
||||
# 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 sample data generation.
|
||||
|
||||
"""
|
||||
from datetime import date, timedelta
|
||||
|
||||
import click
|
||||
|
||||
from testlib import Accounts, create_test_app, JournalEntryLineItemData, \
|
||||
JournalEntryCurrencyData, JournalEntryData, \
|
||||
BaseTestData
|
||||
|
||||
|
||||
@click.command()
|
||||
@click.argument("file")
|
||||
def main(file) -> None:
|
||||
"""Creates the sample data and output to a file."""
|
||||
data: SampleData = SampleData(create_test_app(), "editor")
|
||||
with open(file, "wt") as fp:
|
||||
fp.write(data.json())
|
||||
|
||||
|
||||
class SampleData(BaseTestData):
|
||||
"""The sample data."""
|
||||
|
||||
def _init_data(self) -> None:
|
||||
self.__add_recurring()
|
||||
self.__add_offsets()
|
||||
self.__add_meals()
|
||||
|
||||
def __add_recurring(self) -> None:
|
||||
"""Adds the recurring data.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
self.__add_usd_recurring()
|
||||
self.__add_twd_recurring()
|
||||
|
||||
def __add_usd_recurring(self) -> None:
|
||||
"""Adds the recurring data in USD.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
today: date = date.today()
|
||||
days: int
|
||||
year: int
|
||||
month: int
|
||||
|
||||
# Recurring in USD
|
||||
j_date: date = date(today.year - 5, today.month, today.day)
|
||||
j_date = j_date + timedelta(days=(4 - j_date.weekday()))
|
||||
days = (today - j_date).days
|
||||
while True:
|
||||
if days < 0:
|
||||
break
|
||||
self.__add_journal_entry(
|
||||
days, "USD", "2600",
|
||||
Accounts.BANK, "Transfer", Accounts.SERVICE, "Payroll")
|
||||
|
||||
days = days - 1
|
||||
if days < 0:
|
||||
break
|
||||
self.__add_journal_entry(
|
||||
days, "USD", "1200",
|
||||
Accounts.CASH, None, Accounts.BANK, "Withdraw")
|
||||
days = days - 13
|
||||
|
||||
year = today.year - 5
|
||||
month = today.month
|
||||
while True:
|
||||
month = month + 1
|
||||
if month > 12:
|
||||
year = year + 1
|
||||
month = 1
|
||||
days = (today - date(year, month, 1)).days
|
||||
if days < 0:
|
||||
break
|
||||
self.__add_journal_entry(
|
||||
days, "USD", "1800",
|
||||
Accounts.RENT_EXPENSE, "Rent", Accounts.BANK, "Transfer")
|
||||
|
||||
def __add_twd_recurring(self) -> None:
|
||||
"""Adds the recurring data in TWD.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
today: date = date.today()
|
||||
|
||||
year: int = today.year - 5
|
||||
month: int = today.month
|
||||
while True:
|
||||
days: int = (today - date(year, month, 5)).days
|
||||
if days < 0:
|
||||
break
|
||||
self.__add_journal_entry(
|
||||
days, "TWD", "50000",
|
||||
Accounts.BANK, "薪資轉帳", Accounts.SERVICE, "薪水")
|
||||
|
||||
days = days - 1
|
||||
if days < 0:
|
||||
break
|
||||
self.__add_journal_entry(
|
||||
days, "TWD", "25000",
|
||||
Accounts.CASH, None, Accounts.BANK, "提款")
|
||||
|
||||
days = days - 4
|
||||
if days < 0:
|
||||
break
|
||||
self.__add_journal_entry(
|
||||
days, "TWD", "18000",
|
||||
Accounts.RENT_EXPENSE, "房租", Accounts.BANK, "轉帳")
|
||||
|
||||
month = month + 1
|
||||
if month > 12:
|
||||
year = year + 1
|
||||
month = 1
|
||||
|
||||
def __add_offsets(self) -> None:
|
||||
"""Adds the offset data.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
days: int
|
||||
year: int
|
||||
month: int
|
||||
description: str
|
||||
line_item_or: JournalEntryLineItemData
|
||||
line_item_of: JournalEntryLineItemData
|
||||
|
||||
# Full offset and unmatched in USD
|
||||
description = "Speaking—Institute"
|
||||
line_item_or = JournalEntryLineItemData(
|
||||
Accounts.RECEIVABLE, description, "120")
|
||||
self._add_journal_entry(JournalEntryData(
|
||||
40, [JournalEntryCurrencyData(
|
||||
"USD", [line_item_or], [JournalEntryLineItemData(
|
||||
Accounts.SERVICE, description, "120")])]))
|
||||
line_item_of = JournalEntryLineItemData(
|
||||
Accounts.RECEIVABLE, description, "120",
|
||||
original_line_item=line_item_or)
|
||||
self._add_journal_entry(JournalEntryData(
|
||||
5, [JournalEntryCurrencyData(
|
||||
"USD", [JournalEntryLineItemData(
|
||||
Accounts.BANK, description, "120")],
|
||||
[line_item_of])]))
|
||||
self.__add_journal_entry(
|
||||
30, "USD", "120",
|
||||
Accounts.BANK, description, Accounts.SERVICE, description)
|
||||
|
||||
# Partial offset in USD
|
||||
line_item_or = JournalEntryLineItemData(
|
||||
Accounts.PAYABLE, "Computer", "1600")
|
||||
self._add_journal_entry(JournalEntryData(
|
||||
60, [JournalEntryCurrencyData(
|
||||
"USD", [JournalEntryLineItemData(
|
||||
Accounts.MACHINERY, "Computer", "1600")],
|
||||
[line_item_or])]))
|
||||
line_item_of = JournalEntryLineItemData(
|
||||
Accounts.PAYABLE, "Computer", "800",
|
||||
original_line_item=line_item_or)
|
||||
self._add_journal_entry(JournalEntryData(
|
||||
35, [JournalEntryCurrencyData(
|
||||
"USD", [line_item_of], [JournalEntryLineItemData(
|
||||
Accounts.BANK, "Computer", "800")])]))
|
||||
line_item_of = JournalEntryLineItemData(
|
||||
Accounts.PAYABLE, "Computer", "400",
|
||||
original_line_item=line_item_or)
|
||||
self._add_journal_entry(JournalEntryData(
|
||||
10, [JournalEntryCurrencyData(
|
||||
"USD", [line_item_of], [JournalEntryLineItemData(
|
||||
Accounts.CASH, "Computer", "400")])]))
|
||||
|
||||
# Full offset and unmatched in TWD
|
||||
description = "演講費—母校"
|
||||
line_item_or = JournalEntryLineItemData(
|
||||
Accounts.RECEIVABLE, description, "3000")
|
||||
self._add_journal_entry(JournalEntryData(
|
||||
45, [JournalEntryCurrencyData(
|
||||
"TWD", [line_item_or], [JournalEntryLineItemData(
|
||||
Accounts.SERVICE, description, "3000")])]))
|
||||
line_item_of = JournalEntryLineItemData(
|
||||
Accounts.RECEIVABLE, description, "3000",
|
||||
original_line_item=line_item_or)
|
||||
self._add_journal_entry(JournalEntryData(
|
||||
6, [JournalEntryCurrencyData(
|
||||
"TWD", [JournalEntryLineItemData(
|
||||
Accounts.BANK, description, "3000")],
|
||||
[line_item_of])]))
|
||||
self.__add_journal_entry(
|
||||
25, "TWD", "3000",
|
||||
Accounts.BANK, description, Accounts.SERVICE, description)
|
||||
|
||||
# Partial offset in TWD
|
||||
line_item_or = JournalEntryLineItemData(
|
||||
Accounts.PAYABLE, "手機", "30000")
|
||||
self._add_journal_entry(JournalEntryData(
|
||||
55, [JournalEntryCurrencyData(
|
||||
"TWD", [JournalEntryLineItemData(
|
||||
Accounts.MACHINERY, "手機", "30000")],
|
||||
[line_item_or])]))
|
||||
line_item_of = JournalEntryLineItemData(
|
||||
Accounts.PAYABLE, "手機", "16000",
|
||||
original_line_item=line_item_or)
|
||||
self._add_journal_entry(JournalEntryData(
|
||||
27, [JournalEntryCurrencyData(
|
||||
"TWD", [line_item_of], [JournalEntryLineItemData(
|
||||
Accounts.BANK, "手機", "16000")])]))
|
||||
line_item_of = JournalEntryLineItemData(
|
||||
Accounts.PAYABLE, "手機", "6000",
|
||||
original_line_item=line_item_or)
|
||||
self._add_journal_entry(JournalEntryData(
|
||||
8, [JournalEntryCurrencyData(
|
||||
"TWD", [line_item_of], [JournalEntryLineItemData(
|
||||
Accounts.CASH, "手機", "6000")])]))
|
||||
|
||||
def __add_meals(self) -> None:
|
||||
"""Adds the meal data.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
days = 60
|
||||
while days >= 0:
|
||||
# Meals in USD
|
||||
if days % 4 == 2:
|
||||
self.__add_journal_entry(
|
||||
days, "USD", "2.9",
|
||||
Accounts.MEAL, "Lunch—Coffee", Accounts.CASH, None)
|
||||
else:
|
||||
self.__add_journal_entry(
|
||||
days, "USD", "3.9",
|
||||
Accounts.MEAL, "Lunch—Coffee", Accounts.CASH, None)
|
||||
|
||||
if days % 15 == 3:
|
||||
self.__add_journal_entry(
|
||||
days, "USD", "5.45",
|
||||
Accounts.MEAL, "Dinner—Pizza",
|
||||
Accounts.PAYABLE, "Dinner—Pizza")
|
||||
else:
|
||||
self.__add_journal_entry(
|
||||
days, "USD", "5.9",
|
||||
Accounts.MEAL, "Dinner—Pasta", Accounts.CASH, None)
|
||||
|
||||
# Meals in TWD
|
||||
if days % 5 == 3:
|
||||
self.__add_journal_entry(
|
||||
days, "TWD", "125",
|
||||
Accounts.MEAL, "午餐—鄰家咖啡", Accounts.CASH, None)
|
||||
else:
|
||||
self.__add_journal_entry(
|
||||
days, "TWD", "80",
|
||||
Accounts.MEAL, "午餐—便當", Accounts.CASH, None)
|
||||
|
||||
if days % 15 == 3:
|
||||
self.__add_journal_entry(
|
||||
days, "TWD", "320",
|
||||
Accounts.MEAL, "晚餐—牛排", Accounts.PAYABLE, "晚餐—牛排")
|
||||
else:
|
||||
self.__add_journal_entry(
|
||||
days, "TWD", "100",
|
||||
Accounts.MEAL, "晚餐—自助餐", Accounts.CASH, None)
|
||||
|
||||
days = days - 1
|
||||
|
||||
def __add_journal_entry(
|
||||
self, days: int, currency: str, amount: str,
|
||||
debit_account: str, debit_description: str | None,
|
||||
credit_account: str, credit_description: str | None) -> None:
|
||||
"""Adds a simple journal entry.
|
||||
|
||||
:param days: The number of days before today.
|
||||
:param currency: The currency code.
|
||||
:param amount: The amount.
|
||||
:param debit_account: The debit account code.
|
||||
:param debit_description: The debit description.
|
||||
:param credit_account: The credit account code.
|
||||
:param credit_description: The credit description.
|
||||
:return: None.
|
||||
"""
|
||||
self._add_journal_entry(JournalEntryData(
|
||||
days,
|
||||
[JournalEntryCurrencyData(
|
||||
currency,
|
||||
[JournalEntryLineItemData(
|
||||
debit_account, debit_description, amount)],
|
||||
[JournalEntryLineItemData(
|
||||
credit_account, credit_description, amount)])]))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
@ -21,10 +21,7 @@ import unittest
|
||||
from datetime import timedelta, date
|
||||
|
||||
import httpx
|
||||
import sqlalchemy as sa
|
||||
from click.testing import Result
|
||||
from flask import Flask
|
||||
from flask.testing import FlaskCliRunner
|
||||
|
||||
from test_site import db
|
||||
from testlib import NEXT_URI, create_test_app, get_client, set_locale, \
|
||||
@ -65,59 +62,6 @@ PREFIX: str = "/accounting/accounts"
|
||||
"""The URL prefix for the account management."""
|
||||
|
||||
|
||||
class AccountCommandTestCase(unittest.TestCase):
|
||||
"""The account console command test case."""
|
||||
|
||||
def setUp(self) -> None:
|
||||
"""Sets up the test.
|
||||
This is run once per test.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
self.app: Flask = create_test_app()
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
from accounting.models import BaseAccount, Account, AccountL10n
|
||||
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)
|
||||
AccountL10n.query.delete()
|
||||
Account.query.delete()
|
||||
db.session.commit()
|
||||
|
||||
def test_init(self) -> None:
|
||||
"""Tests the "accounting-init-account" console command.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
from accounting.models import BaseAccount, Account, AccountL10n
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
result: Result = runner.invoke(args=["accounting-init-accounts",
|
||||
"-u", "editor"])
|
||||
self.assertEqual(result.exit_code, 0)
|
||||
with self.app.app_context():
|
||||
bases: list[BaseAccount] = BaseAccount.query\
|
||||
.filter(sa.func.char_length(BaseAccount.code) == 4).all()
|
||||
accounts: list[Account] = Account.query.all()
|
||||
l10n: list[AccountL10n] = AccountL10n.query.all()
|
||||
self.assertEqual({x.code for x in bases},
|
||||
{x.base_code for x in accounts})
|
||||
self.assertEqual(len(accounts), len(bases))
|
||||
self.assertEqual(len(l10n), len(bases) * 2)
|
||||
base_dict: dict[str, BaseAccount] = {x.code: x for x in bases}
|
||||
for account in accounts:
|
||||
base: BaseAccount = base_dict[account.base_code]
|
||||
self.assertEqual(account.no, 1)
|
||||
self.assertEqual(account.title_l10n, base.title_l10n)
|
||||
self.assertEqual({x.locale: x.title for x in account.l10n},
|
||||
{x.locale: x.title for x in base.l10n})
|
||||
|
||||
|
||||
class AccountTestCase(unittest.TestCase):
|
||||
"""The account test case."""
|
||||
|
||||
@ -129,15 +73,8 @@ class AccountTestCase(unittest.TestCase):
|
||||
"""
|
||||
self.app: Flask = create_test_app()
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
from accounting.models import BaseAccount, Account, AccountL10n
|
||||
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)
|
||||
from accounting.models import Account, AccountL10n
|
||||
AccountL10n.query.delete()
|
||||
Account.query.delete()
|
||||
db.session.commit()
|
||||
@ -652,14 +589,6 @@ class AccountTestCase(unittest.TestCase):
|
||||
self.assertEqual(response.status_code, 302)
|
||||
self.assertEqual(response.headers["Location"], detail_uri)
|
||||
|
||||
response = self.client.post("/accounting/currencies/store",
|
||||
data={"csrf_token": self.csrf_token,
|
||||
"code": "USD",
|
||||
"name": "US Dollars"})
|
||||
self.assertEqual(response.status_code, 302)
|
||||
self.assertEqual(response.headers["Location"],
|
||||
"/accounting/currencies/USD")
|
||||
|
||||
add_journal_entry(self.client,
|
||||
form={"csrf_token": self.csrf_token,
|
||||
"next": NEXT_URI,
|
||||
|
@ -17,14 +17,10 @@
|
||||
"""The test for the base account management.
|
||||
|
||||
"""
|
||||
import csv
|
||||
import typing as t
|
||||
import unittest
|
||||
|
||||
import httpx
|
||||
from click.testing import Result
|
||||
from flask import Flask
|
||||
from flask.testing import FlaskCliRunner
|
||||
|
||||
from testlib import create_test_app, get_client
|
||||
|
||||
@ -34,59 +30,6 @@ DETAIL_URI: str = "/accounting/base-accounts/1111"
|
||||
"""The detail URI."""
|
||||
|
||||
|
||||
class BaseAccountCommandTestCase(unittest.TestCase):
|
||||
"""The base account console command test case."""
|
||||
|
||||
def setUp(self) -> None:
|
||||
"""Sets up the test.
|
||||
This is run once per test.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
from accounting.models import BaseAccount, BaseAccountL10n
|
||||
self.app: Flask = create_test_app()
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
result: Result = runner.invoke(args="init-db")
|
||||
self.assertEqual(result.exit_code, 0)
|
||||
BaseAccountL10n.query.delete()
|
||||
BaseAccount.query.delete()
|
||||
|
||||
def test_init(self) -> None:
|
||||
"""Tests the "accounting-init-base" console command.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
from accounting import data_dir
|
||||
from accounting.models import BaseAccount
|
||||
|
||||
with open(data_dir / "base_accounts.csv") as fp:
|
||||
data: dict[dict[str, t.Any]] \
|
||||
= {x["code"]: {"code": x["code"],
|
||||
"title": x["title"],
|
||||
"l10n": {y[5:]: x[y]
|
||||
for y in x if y.startswith("l10n-")}}
|
||||
for x in csv.DictReader(fp)}
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
result: Result = runner.invoke(args="accounting-init-base")
|
||||
self.assertEqual(result.exit_code, 0)
|
||||
with self.app.app_context():
|
||||
accounts: list[BaseAccount] = BaseAccount.query.all()
|
||||
|
||||
self.assertEqual(len(accounts), len(data))
|
||||
for account in accounts:
|
||||
self.assertIn(account.code, data)
|
||||
self.assertEqual(account.title_l10n, data[account.code]["title"])
|
||||
l10n: dict[str, str] = {x.locale: x.title for x in account.l10n}
|
||||
self.assertEqual(len(l10n), len(data[account.code]["l10n"]))
|
||||
for locale in l10n:
|
||||
self.assertIn(locale, data[account.code]["l10n"])
|
||||
self.assertEqual(l10n[locale],
|
||||
data[account.code]["l10n"][locale])
|
||||
|
||||
|
||||
class BaseAccountTestCase(unittest.TestCase):
|
||||
"""The base account test case."""
|
||||
|
||||
@ -96,17 +39,8 @@ class BaseAccountTestCase(unittest.TestCase):
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
from accounting.models import BaseAccount
|
||||
self.app: Flask = create_test_app()
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
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)
|
||||
|
||||
def test_nobody(self) -> None:
|
||||
"""Test the permission as nobody.
|
||||
|
||||
|
157
tests/test_commands.py
Normal file
157
tests/test_commands.py
Normal file
@ -0,0 +1,157 @@
|
||||
# The Mia! Accounting Project.
|
||||
# Author: imacat@mail.imacat.idv.tw (imacat), 2023/4/10
|
||||
|
||||
# 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 console commands.
|
||||
|
||||
"""
|
||||
import csv
|
||||
import typing as t
|
||||
import unittest
|
||||
|
||||
import sqlalchemy as sa
|
||||
from click.testing import Result
|
||||
from flask import Flask
|
||||
from flask.testing import FlaskCliRunner
|
||||
from sqlalchemy.sql.ddl import DropTable
|
||||
|
||||
from test_site import db
|
||||
from testlib import create_test_app
|
||||
|
||||
|
||||
class ConsoleCommandTestCase(unittest.TestCase):
|
||||
"""The console command test case."""
|
||||
|
||||
def setUp(self) -> None:
|
||||
"""Sets up the test.
|
||||
This is run once per test.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
self.app: Flask = create_test_app()
|
||||
|
||||
with self.app.app_context():
|
||||
# Drop every accounting table, to see if accounting-init recreates
|
||||
# them correctly.
|
||||
tables: list[sa.Table] \
|
||||
= [db.metadata.tables[x] for x in db.metadata.tables
|
||||
if x.startswith("accounting_")]
|
||||
for table in tables:
|
||||
db.session.execute(DropTable(table))
|
||||
db.session.commit()
|
||||
inspector: sa.Inspector = sa.inspect(db.session.connection())
|
||||
self.assertEqual(len({x for x in inspector.get_table_names()
|
||||
if x.startswith("accounting_")}),
|
||||
0)
|
||||
|
||||
def test_init(self) -> None:
|
||||
"""Tests the "accounting-init" console command.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
result: Result = runner.invoke(
|
||||
args=["accounting-init-db", "-u", "editor"])
|
||||
self.assertEqual(result.exit_code, 0,
|
||||
result.output + str(result.exception))
|
||||
self.__test_base_account_data()
|
||||
self.__test_account_data()
|
||||
self.__test_currency_data()
|
||||
|
||||
def __test_base_account_data(self) -> None:
|
||||
"""Tests the base account data.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
from accounting import data_dir
|
||||
from accounting.models import BaseAccount
|
||||
|
||||
with open(data_dir / "base_accounts.csv") as fp:
|
||||
data: dict[dict[str, t.Any]] \
|
||||
= {x["code"]: {"code": x["code"],
|
||||
"title": x["title"],
|
||||
"l10n": {y[5:]: x[y]
|
||||
for y in x if y.startswith("l10n-")}}
|
||||
for x in csv.DictReader(fp)}
|
||||
|
||||
with self.app.app_context():
|
||||
accounts: list[BaseAccount] = BaseAccount.query.all()
|
||||
|
||||
self.assertEqual(len(accounts), len(data))
|
||||
for account in accounts:
|
||||
self.assertIn(account.code, data)
|
||||
self.assertEqual(account.title_l10n, data[account.code]["title"])
|
||||
l10n: dict[str, str] = {x.locale: x.title for x in account.l10n}
|
||||
self.assertEqual(len(l10n), len(data[account.code]["l10n"]))
|
||||
for locale in l10n:
|
||||
self.assertIn(locale, data[account.code]["l10n"])
|
||||
self.assertEqual(l10n[locale],
|
||||
data[account.code]["l10n"][locale])
|
||||
|
||||
def __test_account_data(self) -> None:
|
||||
"""Tests the account data.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
from accounting.models import BaseAccount, Account, AccountL10n
|
||||
|
||||
with self.app.app_context():
|
||||
bases: list[BaseAccount] = BaseAccount.query\
|
||||
.filter(sa.func.char_length(BaseAccount.code) == 4).all()
|
||||
accounts: list[Account] = Account.query.all()
|
||||
l10n: list[AccountL10n] = AccountL10n.query.all()
|
||||
|
||||
self.assertEqual({x.code for x in bases},
|
||||
{x.base_code for x in accounts})
|
||||
self.assertEqual(len(accounts), len(bases))
|
||||
self.assertEqual(len(l10n), len(bases) * 2)
|
||||
base_dict: dict[str, BaseAccount] = {x.code: x for x in bases}
|
||||
for account in accounts:
|
||||
base: BaseAccount = base_dict[account.base_code]
|
||||
self.assertEqual(account.no, 1)
|
||||
self.assertEqual(account.title_l10n, base.title_l10n)
|
||||
self.assertEqual({x.locale: x.title for x in account.l10n},
|
||||
{x.locale: x.title for x in base.l10n})
|
||||
|
||||
def __test_currency_data(self) -> None:
|
||||
"""Tests the currency data.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
from accounting import data_dir
|
||||
from accounting.models import Currency
|
||||
|
||||
with open(data_dir / "currencies.csv") as fp:
|
||||
data: dict[dict[str, t.Any]] \
|
||||
= {x["code"]: {"code": x["code"],
|
||||
"name": x["name"],
|
||||
"l10n": {y[5:]: x[y]
|
||||
for y in x if y.startswith("l10n-")}}
|
||||
for x in csv.DictReader(fp)}
|
||||
|
||||
with self.app.app_context():
|
||||
currencies: list[Currency] = Currency.query.all()
|
||||
|
||||
self.assertEqual(len(currencies), len(data))
|
||||
for currency in currencies:
|
||||
self.assertIn(currency.code, data)
|
||||
self.assertEqual(currency.name_l10n, data[currency.code]["name"])
|
||||
l10n: dict[str, str] = {x.locale: x.name for x in currency.l10n}
|
||||
self.assertEqual(len(l10n), len(data[currency.code]["l10n"]))
|
||||
for locale in l10n:
|
||||
self.assertIn(locale, data[currency.code]["l10n"])
|
||||
self.assertEqual(l10n[locale],
|
||||
data[currency.code]["l10n"][locale])
|
@ -17,15 +17,11 @@
|
||||
"""The test for the currency management.
|
||||
|
||||
"""
|
||||
import csv
|
||||
import typing as t
|
||||
import unittest
|
||||
from datetime import timedelta, date
|
||||
|
||||
import httpx
|
||||
from click.testing import Result
|
||||
from flask import Flask
|
||||
from flask.testing import FlaskCliRunner
|
||||
|
||||
from test_site import db
|
||||
from testlib import NEXT_URI, create_test_app, get_client, set_locale, \
|
||||
@ -59,62 +55,6 @@ PREFIX: str = "/accounting/currencies"
|
||||
"""The URL prefix for the currency management."""
|
||||
|
||||
|
||||
class CurrencyCommandTestCase(unittest.TestCase):
|
||||
"""The account console command test case."""
|
||||
|
||||
def setUp(self) -> None:
|
||||
"""Sets up the test.
|
||||
This is run once per test.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
self.app: Flask = create_test_app()
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
from accounting.models import Currency, CurrencyL10n
|
||||
result: Result
|
||||
result = runner.invoke(args="init-db")
|
||||
self.assertEqual(result.exit_code, 0)
|
||||
CurrencyL10n.query.delete()
|
||||
Currency.query.delete()
|
||||
db.session.commit()
|
||||
|
||||
def test_init(self) -> None:
|
||||
"""Tests the "accounting-init-currencies" console command.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
from accounting import data_dir
|
||||
from accounting.models import Currency
|
||||
|
||||
with open(data_dir / "currencies.csv") as fp:
|
||||
data: dict[dict[str, t.Any]] \
|
||||
= {x["code"]: {"code": x["code"],
|
||||
"name": x["name"],
|
||||
"l10n": {y[5:]: x[y]
|
||||
for y in x if y.startswith("l10n-")}}
|
||||
for x in csv.DictReader(fp)}
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
result: Result = runner.invoke(
|
||||
args=["accounting-init-currencies", "-u", "editor"])
|
||||
self.assertEqual(result.exit_code, 0)
|
||||
currencies: list[Currency] = Currency.query.all()
|
||||
|
||||
self.assertEqual(len(currencies), len(data))
|
||||
for currency in currencies:
|
||||
self.assertIn(currency.code, data)
|
||||
self.assertEqual(currency.name_l10n, data[currency.code]["name"])
|
||||
l10n: dict[str, str] = {x.locale: x.name for x in currency.l10n}
|
||||
self.assertEqual(len(l10n), len(data[currency.code]["l10n"]))
|
||||
for locale in l10n:
|
||||
self.assertIn(locale, data[currency.code]["l10n"])
|
||||
self.assertEqual(l10n[locale],
|
||||
data[currency.code]["l10n"][locale])
|
||||
|
||||
|
||||
class CurrencyTestCase(unittest.TestCase):
|
||||
"""The currency test case."""
|
||||
|
||||
@ -126,12 +66,8 @@ class CurrencyTestCase(unittest.TestCase):
|
||||
"""
|
||||
self.app: Flask = create_test_app()
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
from accounting.models import Currency, CurrencyL10n
|
||||
result: Result
|
||||
result = runner.invoke(args="init-db")
|
||||
self.assertEqual(result.exit_code, 0)
|
||||
CurrencyL10n.query.delete()
|
||||
Currency.query.delete()
|
||||
db.session.commit()
|
||||
@ -588,21 +524,6 @@ class CurrencyTestCase(unittest.TestCase):
|
||||
list_uri: str = PREFIX
|
||||
response: httpx.Response
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
from accounting.models import BaseAccount
|
||||
if BaseAccount.query.first() is None:
|
||||
result = runner.invoke(args="accounting-init-base")
|
||||
self.assertEqual(result.exit_code, 0)
|
||||
|
||||
response = self.client.post("/accounting/accounts/store",
|
||||
data={"csrf_token": self.csrf_token,
|
||||
"base_code": "1111",
|
||||
"title": "Cash"})
|
||||
self.assertEqual(response.status_code, 302)
|
||||
self.assertEqual(response.headers["Location"],
|
||||
"/accounting/accounts/1111-001")
|
||||
|
||||
response = self.client.post(f"{PREFIX}/store",
|
||||
data={"csrf_token": self.csrf_token,
|
||||
"code": JPY.code,
|
||||
|
@ -20,9 +20,7 @@
|
||||
import unittest
|
||||
from datetime import date
|
||||
|
||||
from click.testing import Result
|
||||
from flask import Flask
|
||||
from flask.testing import FlaskCliRunner
|
||||
|
||||
from testlib import NEXT_URI, Accounts, create_test_app, get_client, \
|
||||
add_journal_entry
|
||||
@ -39,22 +37,8 @@ class DescriptionEditorTestCase(unittest.TestCase):
|
||||
"""
|
||||
self.app: Flask = create_test_app()
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
from accounting.models import BaseAccount, JournalEntry, \
|
||||
JournalEntryLineItem
|
||||
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)
|
||||
from accounting.models import JournalEntry, JournalEntryLineItem
|
||||
JournalEntry.query.delete()
|
||||
JournalEntryLineItem.query.delete()
|
||||
|
||||
|
@ -22,9 +22,7 @@ from datetime import date, timedelta
|
||||
from decimal import Decimal
|
||||
|
||||
import httpx
|
||||
from click.testing import Result
|
||||
from flask import Flask
|
||||
from flask.testing import FlaskCliRunner
|
||||
|
||||
from test_site import db
|
||||
from testlib import NEXT_URI, Accounts, create_test_app, get_client, \
|
||||
@ -51,22 +49,8 @@ class CashReceiptJournalEntryTestCase(unittest.TestCase):
|
||||
"""
|
||||
self.app: Flask = create_test_app()
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
from accounting.models import BaseAccount, JournalEntry, \
|
||||
JournalEntryLineItem
|
||||
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)
|
||||
from accounting.models import JournalEntry, JournalEntryLineItem
|
||||
JournalEntry.query.delete()
|
||||
JournalEntryLineItem.query.delete()
|
||||
|
||||
@ -670,22 +654,8 @@ class CashDisbursementJournalEntryTestCase(unittest.TestCase):
|
||||
"""
|
||||
self.app: Flask = create_test_app()
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
from accounting.models import BaseAccount, JournalEntry, \
|
||||
JournalEntryLineItem
|
||||
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)
|
||||
from accounting.models import JournalEntry, JournalEntryLineItem
|
||||
JournalEntry.query.delete()
|
||||
JournalEntryLineItem.query.delete()
|
||||
|
||||
@ -1265,22 +1235,9 @@ class TransferJournalEntryTestCase(unittest.TestCase):
|
||||
"""
|
||||
self.app: Flask = create_test_app()
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
from accounting.models import BaseAccount, JournalEntry, \
|
||||
from accounting.models import JournalEntry, \
|
||||
JournalEntryLineItem
|
||||
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)
|
||||
JournalEntry.query.delete()
|
||||
JournalEntryLineItem.query.delete()
|
||||
|
||||
@ -2139,22 +2096,8 @@ class JournalEntryReorderTestCase(unittest.TestCase):
|
||||
"""
|
||||
self.app: Flask = create_test_app()
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
from accounting.models import BaseAccount, JournalEntry, \
|
||||
JournalEntryLineItem
|
||||
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)
|
||||
from accounting.models import JournalEntry, JournalEntryLineItem
|
||||
JournalEntry.query.delete()
|
||||
JournalEntryLineItem.query.delete()
|
||||
|
||||
|
@ -23,9 +23,7 @@ import unittest
|
||||
from decimal import Decimal
|
||||
|
||||
import httpx
|
||||
from click.testing import Result
|
||||
from flask import Flask
|
||||
from flask.testing import FlaskCliRunner
|
||||
|
||||
from test_site import db
|
||||
from testlib import Accounts, create_test_app, get_client, \
|
||||
@ -47,28 +45,14 @@ class OffsetTestCase(unittest.TestCase):
|
||||
"""
|
||||
self.app: Flask = create_test_app()
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
from accounting.models import BaseAccount, JournalEntry, \
|
||||
JournalEntryLineItem
|
||||
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)
|
||||
from accounting.models import JournalEntry, JournalEntryLineItem
|
||||
JournalEntry.query.delete()
|
||||
JournalEntryLineItem.query.delete()
|
||||
|
||||
self.client, self.csrf_token = get_client(self.app, "editor")
|
||||
self.data: OffsetTestData = OffsetTestData(
|
||||
self.app, self.client, self.csrf_token)
|
||||
self.data: OffsetTestData = OffsetTestData(self.app, "editor")
|
||||
self.data.populate()
|
||||
|
||||
def test_add_receivable_offset(self) -> None:
|
||||
"""Tests to add the receivable offset.
|
||||
|
@ -21,9 +21,7 @@ import unittest
|
||||
from datetime import datetime, timedelta
|
||||
|
||||
import httpx
|
||||
from click.testing import Result
|
||||
from flask import Flask
|
||||
from flask.testing import FlaskCliRunner
|
||||
|
||||
from test_site import db
|
||||
from testlib import NEXT_URI, Accounts, create_test_app, get_client
|
||||
@ -49,21 +47,8 @@ class OptionTestCase(unittest.TestCase):
|
||||
"""
|
||||
self.app: Flask = create_test_app()
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
from accounting.models import BaseAccount, Option
|
||||
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)
|
||||
from accounting.models import Option
|
||||
Option.query.delete()
|
||||
|
||||
self.client, self.csrf_token = get_client(self.app, "admin")
|
||||
|
@ -21,9 +21,7 @@ import unittest
|
||||
from datetime import date
|
||||
|
||||
import httpx
|
||||
from click.testing import Result
|
||||
from flask import Flask
|
||||
from flask.testing import FlaskCliRunner
|
||||
|
||||
from testlib import create_test_app, get_client, Accounts, BaseTestData
|
||||
|
||||
@ -44,22 +42,8 @@ class ReportTestCase(unittest.TestCase):
|
||||
"""
|
||||
self.app: Flask = create_test_app()
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
from accounting.models import BaseAccount, JournalEntry, \
|
||||
JournalEntryLineItem
|
||||
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)
|
||||
from accounting.models import JournalEntry, JournalEntryLineItem
|
||||
JournalEntry.query.delete()
|
||||
JournalEntryLineItem.query.delete()
|
||||
|
||||
@ -71,7 +55,7 @@ class ReportTestCase(unittest.TestCase):
|
||||
:return: None.
|
||||
"""
|
||||
client, csrf_token = get_client(self.app, "nobody")
|
||||
ReportTestData(self.app, self.client, self.csrf_token)
|
||||
ReportTestData(self.app, "editor").populate()
|
||||
response: httpx.Response
|
||||
|
||||
response = client.get(PREFIX)
|
||||
@ -146,7 +130,7 @@ class ReportTestCase(unittest.TestCase):
|
||||
:return: None.
|
||||
"""
|
||||
client, csrf_token = get_client(self.app, "viewer")
|
||||
ReportTestData(self.app, self.client, self.csrf_token)
|
||||
ReportTestData(self.app, "editor").populate()
|
||||
response: httpx.Response
|
||||
|
||||
response = client.get(PREFIX)
|
||||
@ -231,7 +215,7 @@ class ReportTestCase(unittest.TestCase):
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
ReportTestData(self.app, self.client, self.csrf_token)
|
||||
ReportTestData(self.app, "editor").populate()
|
||||
response: httpx.Response
|
||||
|
||||
response = self.client.get(PREFIX)
|
||||
|
@ -21,9 +21,10 @@ import os
|
||||
import typing as t
|
||||
from secrets import token_urlsafe
|
||||
|
||||
import click
|
||||
from flask import Flask, Blueprint, render_template, redirect, Response
|
||||
from flask.cli import with_appcontext
|
||||
from click.testing import Result
|
||||
from flask import Flask, Blueprint, render_template, redirect, Response, \
|
||||
url_for
|
||||
from flask.testing import FlaskCliRunner
|
||||
from flask_babel_js import BabelJS
|
||||
from flask_sqlalchemy import SQLAlchemy
|
||||
from flask_wtf import CSRFProtect
|
||||
@ -63,7 +64,6 @@ def create_app(is_testing: bool = False) -> Flask:
|
||||
db.init_app(app)
|
||||
|
||||
app.register_blueprint(bp, url_prefix="/")
|
||||
app.cli.add_command(init_db_command)
|
||||
|
||||
from . import locale
|
||||
locale.init_app(app)
|
||||
@ -71,6 +71,9 @@ def create_app(is_testing: bool = False) -> Flask:
|
||||
from . import auth
|
||||
auth.init_app(app)
|
||||
|
||||
from . import reset
|
||||
reset.init_app(app)
|
||||
|
||||
class UserUtilities(accounting.UserUtilityInterface[auth.User]):
|
||||
|
||||
def can_view(self) -> bool:
|
||||
@ -87,7 +90,8 @@ def create_app(is_testing: bool = False) -> Flask:
|
||||
and auth.current_user().username == "admin"
|
||||
|
||||
def unauthorized(self) -> Response:
|
||||
return redirect("/login")
|
||||
from accounting.utils.next_uri import append_next
|
||||
return redirect(append_next(url_for("auth.login-form")))
|
||||
|
||||
@property
|
||||
def cls(self) -> t.Type[auth.User]:
|
||||
@ -110,20 +114,27 @@ def create_app(is_testing: bool = False) -> Flask:
|
||||
|
||||
accounting.init_app(app, user_utils=UserUtilities())
|
||||
|
||||
with app.app_context():
|
||||
init_db(app)
|
||||
|
||||
return app
|
||||
|
||||
|
||||
@click.command("init-db")
|
||||
@with_appcontext
|
||||
def init_db_command() -> None:
|
||||
"""Initializes the database."""
|
||||
def init_db(app: Flask) -> None:
|
||||
"""Initializes the database.
|
||||
|
||||
:param app: The Flask application.
|
||||
:return: None.
|
||||
"""
|
||||
db.create_all()
|
||||
from .auth import User
|
||||
for username in ["viewer", "editor", "admin", "nobody"]:
|
||||
if User.query.filter(User.username == username).first() is None:
|
||||
db.session.add(User(username=username))
|
||||
db.session.commit()
|
||||
click.echo("Database initialized successfully.")
|
||||
runner: FlaskCliRunner = app.test_cli_runner()
|
||||
result: Result = runner.invoke(args=["accounting-init-db", "-u", "editor"])
|
||||
assert result.exit_code == 0, result.output + str(result.exception)
|
||||
|
||||
|
||||
@bp.get("/", endpoint="home")
|
||||
|
@ -18,7 +18,7 @@
|
||||
|
||||
"""
|
||||
from flask import Blueprint, render_template, Flask, redirect, url_for, \
|
||||
session, request, g
|
||||
session, request, g, Response
|
||||
|
||||
from . import db
|
||||
|
||||
@ -44,11 +44,13 @@ class User(db.Model):
|
||||
|
||||
|
||||
@bp.get("login", endpoint="login-form")
|
||||
def show_login_form() -> str:
|
||||
def show_login_form() -> str | Response:
|
||||
"""Shows the login form.
|
||||
|
||||
:return: The login form.
|
||||
"""
|
||||
if "user" in session:
|
||||
return redirect(url_for("accounting-report.default"))
|
||||
return render_template("login.html")
|
||||
|
||||
|
||||
@ -58,11 +60,12 @@ def login() -> redirect:
|
||||
|
||||
:return: The redirection to the home page.
|
||||
"""
|
||||
from accounting.utils.next_uri import inherit_next, or_next
|
||||
if request.form.get("username") not in {"viewer", "editor", "admin",
|
||||
"nobody"}:
|
||||
return redirect(url_for("auth.login"))
|
||||
return redirect(inherit_next(url_for("auth.login")))
|
||||
session["user"] = request.form.get("username")
|
||||
return redirect(url_for("home.home"))
|
||||
return redirect(or_next(url_for("accounting-report.default")))
|
||||
|
||||
|
||||
@bp.post("logout", endpoint="logout")
|
||||
|
1
tests/test_site/data/sample.json
Normal file
1
tests/test_site/data/sample.json
Normal file
File diff suppressed because one or more lines are too long
153
tests/test_site/reset.py
Normal file
153
tests/test_site/reset.py
Normal file
@ -0,0 +1,153 @@
|
||||
# The Mia! Accounting Demonstration Website.
|
||||
# Author: imacat@mail.imacat.idv.tw (imacat), 2023/4/12
|
||||
|
||||
# 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 data reset for the Mia! Accounting demonstration website.
|
||||
|
||||
"""
|
||||
import json
|
||||
import typing as t
|
||||
from datetime import date, timedelta
|
||||
from decimal import Decimal
|
||||
from pathlib import Path
|
||||
|
||||
import sqlalchemy as sa
|
||||
from flask import Flask, Blueprint, url_for, flash, redirect, session, \
|
||||
render_template
|
||||
from flask_babel import lazy_gettext
|
||||
|
||||
from accounting.utils.cast import s
|
||||
from . import db
|
||||
from .auth import User, current_user
|
||||
|
||||
bp: Blueprint = Blueprint("reset", __name__, url_prefix="/")
|
||||
|
||||
|
||||
@bp.get("reset", endpoint="reset-page")
|
||||
def reset() -> str:
|
||||
"""Resets the sample data.
|
||||
|
||||
:return: Redirection to the accounting application.
|
||||
"""
|
||||
return render_template("reset.html")
|
||||
|
||||
|
||||
@bp.post("sample", endpoint="sample")
|
||||
def reset_sample() -> redirect:
|
||||
"""Resets the sample data.
|
||||
|
||||
:return: Redirection to the accounting application.
|
||||
"""
|
||||
__reset_database()
|
||||
__populate_sample_data()
|
||||
flash(s(lazy_gettext(
|
||||
"The sample data are emptied and reset successfully.")), "success")
|
||||
return redirect(url_for("accounting-report.default"))
|
||||
|
||||
|
||||
@bp.post("reset", endpoint="clean-up")
|
||||
def clean_up() -> redirect:
|
||||
"""Clean-up the database data.
|
||||
|
||||
:return: Redirection to the accounting application.
|
||||
"""
|
||||
__reset_database()
|
||||
db.session.commit()
|
||||
flash(s(lazy_gettext("The database is emptied successfully.")), "success")
|
||||
return redirect(url_for("accounting-report.default"))
|
||||
|
||||
|
||||
def __populate_sample_data() -> None:
|
||||
"""Populates the sample data.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
from accounting.models import Account, JournalEntry, JournalEntryLineItem
|
||||
file: Path = Path(__file__).parent / "data" / "sample.json"
|
||||
with open(file) as fp:
|
||||
json_data = json.load(fp)
|
||||
today: date = date.today()
|
||||
user: User | None = current_user()
|
||||
assert user is not None
|
||||
|
||||
def filter_journal_entry(data: list[t.Any]) -> dict[str, t.Any]:
|
||||
"""Filters the journal entry data from JSON.
|
||||
|
||||
:param data: The journal entry data.
|
||||
:return: The journal entry data from JSON.
|
||||
"""
|
||||
return {"id": data[0],
|
||||
"date": today - timedelta(days=data[1]),
|
||||
"no": data[2],
|
||||
"note": data[3],
|
||||
"created_by_id": user.id,
|
||||
"updated_by_id": user.id}
|
||||
|
||||
def filter_line_item(data: list[t.Any]) -> dict[str, t.Any]:
|
||||
"""Filters the journal entry line item data from JSON.
|
||||
|
||||
:param data: The journal entry line item data.
|
||||
:return: The journal entry line item data from JSON.
|
||||
"""
|
||||
return {"id": data[0],
|
||||
"journal_entry_id": data[1],
|
||||
"original_line_item_id": data[2],
|
||||
"is_debit": data[3],
|
||||
"no": data[4],
|
||||
"account_id": Account.find_by_code(data[5]).id,
|
||||
"currency_code": data[6],
|
||||
"description": data[7],
|
||||
"amount": Decimal(data[8])}
|
||||
|
||||
db.session.execute(sa.insert(JournalEntry),
|
||||
[filter_journal_entry(x) for x in json_data[0]])
|
||||
db.session.execute(sa.insert(JournalEntryLineItem),
|
||||
[filter_line_item(x) for x in json_data[1]])
|
||||
db.session.commit()
|
||||
|
||||
|
||||
def __reset_database() -> None:
|
||||
"""Resets the database.
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
from accounting.models import Currency, CurrencyL10n, BaseAccount, \
|
||||
BaseAccountL10n, Account, AccountL10n, JournalEntry, \
|
||||
JournalEntryLineItem
|
||||
from accounting.base_account import init_base_accounts_command
|
||||
from accounting.account import init_accounts_command
|
||||
from accounting.currency import init_currencies_command
|
||||
|
||||
JournalEntryLineItem.query.delete()
|
||||
JournalEntry.query.delete()
|
||||
CurrencyL10n.query.delete()
|
||||
Currency.query.delete()
|
||||
AccountL10n.query.delete()
|
||||
Account.query.delete()
|
||||
BaseAccountL10n.query.delete()
|
||||
BaseAccount.query.delete()
|
||||
init_base_accounts_command()
|
||||
init_accounts_command(session["user"])
|
||||
init_currencies_command(session["user"])
|
||||
|
||||
|
||||
def init_app(app: Flask) -> None:
|
||||
"""Initialize the localization.
|
||||
|
||||
:param app: The Flask application.
|
||||
:return: None.
|
||||
"""
|
||||
app.register_blueprint(bp)
|
||||
|
@ -72,6 +72,14 @@ First written: 2023/1/27
|
||||
</button>
|
||||
</form>
|
||||
</li>
|
||||
{% if current_user().username == "admin" %}
|
||||
<li>
|
||||
<a class="dropdown-item {% if request.endpoint and request.endpoint.startswith("reset.") %} active {% endif %}" href="{{ url_for("reset.reset-page") }}">
|
||||
<i class="fa-solid fa-rotate-right"></i>
|
||||
{{ _("Reset") }}
|
||||
</a>
|
||||
</li>
|
||||
{% endif %}
|
||||
</ul>
|
||||
</li>
|
||||
{% else %}
|
||||
|
@ -21,4 +21,12 @@ First written: 2023/1/27
|
||||
#}
|
||||
{% extends "base.html" %}
|
||||
|
||||
{% block header %}{% block title %}{{ _("Home") }}{% endblock %}{% endblock %}
|
||||
{% block header %}{% block title %}{{ _("Mia! Accounting Live Demonstration") }}{% endblock %}{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
|
||||
<p>{{ _("This is the live demonstration of the Mia! Accounting project. Please <a href=\"/login?next=%%2Faccounting\">log in</a> to continue.") }}</p>
|
||||
|
||||
<p>{{ _("You may also want to check the <a href=\"https://mia-accounting.readthedocs.io\">full documentation</a> and the <a href=\"https://github.com/imacat/mia-accounting\">Github repository</a>.") }}</p>
|
||||
|
||||
{% endblock %}
|
||||
|
@ -27,6 +27,9 @@ First written: 2023/1/27
|
||||
|
||||
<form action="{{ url_for("auth.login") }}" method="post">
|
||||
<input type="hidden" name="csrf_token" value="{{ csrf_token() }}">
|
||||
{% if request.args.next %}
|
||||
<input type="hidden" name="next" value="{{ request.args.next }}">
|
||||
{% endif %}
|
||||
<button class="btn btn-primary" type="submit" name="username" value="viewer">{{ _("Viewer") }}</button>
|
||||
<button class="btn btn-primary" type="submit" name="username" value="editor">{{ _("Editor") }}</button>
|
||||
<button class="btn btn-primary" type="submit" name="username" value="admin">{{ _("Administrator") }}</button>
|
||||
|
48
tests/test_site/templates/reset.html
Normal file
48
tests/test_site/templates/reset.html
Normal file
@ -0,0 +1,48 @@
|
||||
{#
|
||||
The Mia! Accounting Demonstration Website
|
||||
reset.html: The reset page.
|
||||
|
||||
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.
|
||||
|
||||
Author: imacat@mail.imacat.idv.tw (imacat)
|
||||
First written: 2023/4/12
|
||||
#}
|
||||
{% extends "base.html" %}
|
||||
|
||||
{% block header %}{% block title %}{{ _("Reset Database") }}{% endblock %}{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
|
||||
<p>{{ _("Warning: All the current accounting data will be deleted. This cannot be undone. Please backup your database first.") }}</p>
|
||||
|
||||
<p>{{ _("Database reset is provided by the live demonstration. This is not part of the Mia! Accounting project.") }}</p>
|
||||
|
||||
<form class="mb-2" action="{{ url_for("reset.clean-up") }}" method="post">
|
||||
<input type="hidden" name="csrf_token" value="{{ csrf_token() }}">
|
||||
{% if request.args.next %}
|
||||
<input type="hidden" name="next" value="{{ request.args.next }}">
|
||||
{% endif %}
|
||||
<button class="btn btn-primary" type="submit">{{ _("Empty the Database") }}</button>
|
||||
</form>
|
||||
|
||||
<form class="mb-2" action="{{ url_for("reset.sample") }}" method="post">
|
||||
<input type="hidden" name="csrf_token" value="{{ csrf_token() }}">
|
||||
{% if request.args.next %}
|
||||
<input type="hidden" name="next" value="{{ request.args.next }}">
|
||||
{% endif %}
|
||||
<button class="btn btn-primary" type="submit">{{ _("Empty and reset the Sample Data") }}</button>
|
||||
</form>
|
||||
|
||||
{% endblock %}
|
@ -9,8 +9,8 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: mia-accounting-test-site 1.0.0\n"
|
||||
"Report-Msgid-Bugs-To: imacat@mail.imacat.idv.tw\n"
|
||||
"POT-Creation-Date: 2023-04-06 02:34+0800\n"
|
||||
"PO-Revision-Date: 2023-04-06 02:34+0800\n"
|
||||
"POT-Creation-Date: 2023-04-12 17:59+0800\n"
|
||||
"PO-Revision-Date: 2023-04-12 18:00+0800\n"
|
||||
"Last-Translator: imacat <imacat@mail.imacat.idv.tw>\n"
|
||||
"Language: zh_Hant\n"
|
||||
"Language-Team: zh_Hant <imacat@mail.imacat.idv.tw>\n"
|
||||
@ -20,12 +20,19 @@ msgstr ""
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.12.1\n"
|
||||
|
||||
#: tests/test_site/reset.py:55
|
||||
msgid "The sample data are emptied and reset successfully."
|
||||
msgstr "範例資料已清空重設。"
|
||||
|
||||
#: tests/test_site/reset.py:68
|
||||
msgid "The database is emptied successfully."
|
||||
msgstr "資料庫已清空。"
|
||||
|
||||
#: tests/test_site/templates/base.html:23
|
||||
msgid "en"
|
||||
msgstr "zh-Hant"
|
||||
|
||||
#: tests/test_site/templates/base.html:46
|
||||
#: tests/test_site/templates/home.html:24
|
||||
msgid "Home"
|
||||
msgstr "首頁"
|
||||
|
||||
@ -33,28 +40,76 @@ msgstr "首頁"
|
||||
msgid "Log Out"
|
||||
msgstr "登出"
|
||||
|
||||
#: tests/test_site/templates/base.html:81
|
||||
#: tests/test_site/templates/base.html:79
|
||||
msgid "Reset"
|
||||
msgstr "重設"
|
||||
|
||||
#: tests/test_site/templates/base.html:89
|
||||
#: tests/test_site/templates/login.html:24
|
||||
msgid "Log In"
|
||||
msgstr "登入"
|
||||
|
||||
#: tests/test_site/templates/base.html:122
|
||||
#: tests/test_site/templates/base.html:130
|
||||
msgid "Error:"
|
||||
msgstr "錯誤:"
|
||||
|
||||
#: tests/test_site/templates/login.html:30
|
||||
#: tests/test_site/templates/home.html:24
|
||||
msgid "Mia! Accounting Live Demonstration"
|
||||
msgstr "Mia! Accounting 示範站"
|
||||
|
||||
#: tests/test_site/templates/home.html:28
|
||||
#, python-format
|
||||
msgid ""
|
||||
"This is the live demonstration of the Mia! Accounting project. Please <a"
|
||||
" href=\"/login?next=%%2Faccounting\">log in</a> to continue."
|
||||
msgstr "這是 Mia! Accounting 專案的示範站。請先<a href=\"/login?next=%%2Faccounting\">登入</a>。"
|
||||
|
||||
#: tests/test_site/templates/home.html:30
|
||||
msgid ""
|
||||
"You may also want to check the <a href=\"https://mia-"
|
||||
"accounting.readthedocs.io\">full documentation</a> and the <a "
|
||||
"href=\"https://github.com/imacat/mia-accounting\">Github repository</a>."
|
||||
msgstr ""
|
||||
"詳情請參閱<a href=\"https://mia-accounting.readthedocs.io\">完整說明文件</a>與<a "
|
||||
"href=\"https://github.com/imacat/mia-accounting\">Github 專案庫</a>。"
|
||||
|
||||
#: tests/test_site/templates/login.html:33
|
||||
msgid "Viewer"
|
||||
msgstr "讀報表者"
|
||||
|
||||
#: tests/test_site/templates/login.html:31
|
||||
#: tests/test_site/templates/login.html:34
|
||||
msgid "Editor"
|
||||
msgstr "記帳者"
|
||||
|
||||
#: tests/test_site/templates/login.html:32
|
||||
#: tests/test_site/templates/login.html:35
|
||||
msgid "Administrator"
|
||||
msgstr "管理者"
|
||||
|
||||
#: tests/test_site/templates/login.html:33
|
||||
#: tests/test_site/templates/login.html:36
|
||||
msgid "Nobody"
|
||||
msgstr "沒有權限者"
|
||||
|
||||
#: tests/test_site/templates/reset.html:24
|
||||
msgid "Reset Database"
|
||||
msgstr "資料庫重設"
|
||||
|
||||
#: tests/test_site/templates/reset.html:28
|
||||
msgid ""
|
||||
"Warning: All the current accounting data will be deleted. This cannot be"
|
||||
" undone. Please backup your database first."
|
||||
msgstr "警告:現有資料會全部刪除,無法復原。請先備份您的資料。"
|
||||
|
||||
#: tests/test_site/templates/reset.html:30
|
||||
msgid ""
|
||||
"Database reset is provided by the live demonstration. This is not part "
|
||||
"of the Mia! Accounting project."
|
||||
msgstr "資料庫重設是示範站的功能,不是 Mia! Accounting 的功能。"
|
||||
|
||||
#: tests/test_site/templates/reset.html:37
|
||||
msgid "Empty the Database"
|
||||
msgstr "清空資料庫"
|
||||
|
||||
#: tests/test_site/templates/reset.html:45
|
||||
msgid "Empty and reset the Sample Data"
|
||||
msgstr "清空並重設範例資料"
|
||||
|
||||
|
@ -20,9 +20,7 @@
|
||||
import unittest
|
||||
|
||||
import httpx
|
||||
from click.testing import Result
|
||||
from flask import Flask
|
||||
from flask.testing import FlaskCliRunner
|
||||
|
||||
from test_site import db
|
||||
from testlib import create_test_app, get_client, Accounts, \
|
||||
@ -43,22 +41,8 @@ class UnmatchedOffsetTestCase(unittest.TestCase):
|
||||
"""
|
||||
self.app: Flask = create_test_app()
|
||||
|
||||
runner: FlaskCliRunner = self.app.test_cli_runner()
|
||||
with self.app.app_context():
|
||||
from accounting.models import BaseAccount, JournalEntry, \
|
||||
JournalEntryLineItem
|
||||
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)
|
||||
from accounting.models import JournalEntry, JournalEntryLineItem
|
||||
JournalEntry.query.delete()
|
||||
JournalEntryLineItem.query.delete()
|
||||
|
||||
@ -70,7 +54,7 @@ class UnmatchedOffsetTestCase(unittest.TestCase):
|
||||
:return: None.
|
||||
"""
|
||||
client, csrf_token = get_client(self.app, "nobody")
|
||||
DifferentTestData(self.app, self.client, self.csrf_token)
|
||||
DifferentTestData(self.app, "nobody").populate()
|
||||
response: httpx.Response
|
||||
|
||||
response = client.get(PREFIX)
|
||||
@ -89,7 +73,7 @@ class UnmatchedOffsetTestCase(unittest.TestCase):
|
||||
:return: None.
|
||||
"""
|
||||
client, csrf_token = get_client(self.app, "viewer")
|
||||
DifferentTestData(self.app, self.client, self.csrf_token)
|
||||
DifferentTestData(self.app, "viewer").populate()
|
||||
response: httpx.Response
|
||||
|
||||
response = client.get(PREFIX)
|
||||
@ -107,7 +91,7 @@ class UnmatchedOffsetTestCase(unittest.TestCase):
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
DifferentTestData(self.app, self.client, self.csrf_token)
|
||||
DifferentTestData(self.app, "editor").populate()
|
||||
response: httpx.Response
|
||||
|
||||
response = self.client.get(PREFIX)
|
||||
@ -148,8 +132,8 @@ class UnmatchedOffsetTestCase(unittest.TestCase):
|
||||
"""
|
||||
from accounting.models import Account, JournalEntryLineItem
|
||||
from accounting.utils.offset_matcher import OffsetMatcher
|
||||
data: DifferentTestData \
|
||||
= DifferentTestData(self.app, self.client, self.csrf_token)
|
||||
data: DifferentTestData = DifferentTestData(self.app, "editor")
|
||||
data.populate()
|
||||
account: Account | None
|
||||
line_item: JournalEntryLineItem | None
|
||||
matcher: OffsetMatcher
|
||||
@ -264,8 +248,8 @@ class UnmatchedOffsetTestCase(unittest.TestCase):
|
||||
"""
|
||||
from accounting.models import Account, JournalEntryLineItem
|
||||
from accounting.utils.offset_matcher import OffsetMatcher
|
||||
data: SameTestData \
|
||||
= SameTestData(self.app, self.client, self.csrf_token)
|
||||
data: SameTestData = SameTestData(self.app, "editor")
|
||||
data.populate()
|
||||
account: Account | None
|
||||
line_item: JournalEntryLineItem | None
|
||||
matcher: OffsetMatcher
|
||||
@ -499,14 +483,12 @@ class DifferentTestData(BaseTestData):
|
||||
5, [JournalEntryCurrencyData(
|
||||
"USD", [self.l_p_of5d], [self.l_p_of5c])])
|
||||
|
||||
self._set_need_offset({Accounts.RECEIVABLE, Accounts.PAYABLE}, False)
|
||||
self._add_journal_entry(self.j_r_of1)
|
||||
self._add_journal_entry(self.j_r_of2)
|
||||
self._add_journal_entry(self.j_r_of3)
|
||||
self._add_journal_entry(self.j_p_of1)
|
||||
self._add_journal_entry(self.j_p_of2)
|
||||
self._add_journal_entry(self.j_p_of3)
|
||||
self._set_need_offset({Accounts.RECEIVABLE, Accounts.PAYABLE}, True)
|
||||
|
||||
|
||||
class SameTestData(BaseTestData):
|
||||
@ -541,8 +523,6 @@ class SameTestData(BaseTestData):
|
||||
self.l_p_or6d, self.l_p_or6c = self._add_simple_journal_entry(
|
||||
10, "USD", "Steak", "120", Accounts.MEAL, Accounts.PAYABLE)
|
||||
|
||||
self._set_need_offset({Accounts.RECEIVABLE, Accounts.PAYABLE}, False)
|
||||
|
||||
# Receivable offset items
|
||||
self.l_r_of1d, self.l_r_of1c = self._add_simple_journal_entry(
|
||||
65, "USD", "Noodles", "100", Accounts.CASH, Accounts.RECEIVABLE)
|
||||
@ -579,6 +559,5 @@ class SameTestData(BaseTestData):
|
||||
self.l_p_of6d, self.l_p_of6c = self._add_simple_journal_entry(
|
||||
15, "USD", "Steak", "120", Accounts.PAYABLE, Accounts.CASH)
|
||||
|
||||
self._set_need_offset({Accounts.RECEIVABLE, Accounts.PAYABLE}, True)
|
||||
self._add_journal_entry(j_r_of3)
|
||||
self._add_journal_entry(j_p_of3)
|
||||
|
196
tests/testlib.py
196
tests/testlib.py
@ -19,17 +19,21 @@
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import re
|
||||
import typing as t
|
||||
from abc import ABC, abstractmethod
|
||||
from datetime import date, timedelta
|
||||
from secrets import randbelow
|
||||
|
||||
from _decimal import Decimal
|
||||
from decimal import Decimal
|
||||
import sqlalchemy as sa
|
||||
|
||||
import httpx
|
||||
from flask import Flask, render_template_string
|
||||
|
||||
from test_site import create_app, db
|
||||
from test_site.auth import User
|
||||
|
||||
TEST_SERVER: str = "https://testserver"
|
||||
"""The test server URI."""
|
||||
@ -44,6 +48,7 @@ class Accounts:
|
||||
BANK: str = "1113-001"
|
||||
NOTES_RECEIVABLE: str = "1131-001"
|
||||
RECEIVABLE: str = "1141-001"
|
||||
MACHINERY: str = "1441-001"
|
||||
PREPAID: str = "1258-001"
|
||||
NOTES_PAYABLE: str = "2131-001"
|
||||
PAYABLE: str = "2141-001"
|
||||
@ -103,6 +108,7 @@ def get_client(app: Flask, username: str) -> tuple[httpx.Client, str]:
|
||||
csrf_token: str = get_csrf_token(client)
|
||||
response: httpx.Response = client.post("/login",
|
||||
data={"csrf_token": csrf_token,
|
||||
"next": "/",
|
||||
"username": username})
|
||||
assert response.status_code == 302
|
||||
assert response.headers["Location"] == "/"
|
||||
@ -162,7 +168,7 @@ def match_journal_entry_detail(location: str) -> int:
|
||||
class JournalEntryLineItemData:
|
||||
"""The journal entry line item data."""
|
||||
|
||||
def __init__(self, account: str, description: str, amount: str,
|
||||
def __init__(self, account: str, description: str | None, amount: str,
|
||||
original_line_item: JournalEntryLineItemData | None = None):
|
||||
"""Constructs the journal entry line item data.
|
||||
|
||||
@ -177,7 +183,7 @@ class JournalEntryLineItemData:
|
||||
self.original_line_item: JournalEntryLineItemData | None \
|
||||
= original_line_item
|
||||
self.account: str = account
|
||||
self.description: str = description
|
||||
self.description: str | None = description
|
||||
self.amount: Decimal = Decimal(amount)
|
||||
|
||||
def form(self, prefix: str, debit_credit: str, index: int,
|
||||
@ -293,17 +299,21 @@ class JournalEntryData:
|
||||
class BaseTestData(ABC):
|
||||
"""The base test data."""
|
||||
|
||||
def __init__(self, app: Flask, client: httpx.Client, csrf_token: str):
|
||||
def __init__(self, app: Flask, username: str):
|
||||
"""Constructs the test data.
|
||||
|
||||
:param app: The Flask application.
|
||||
:param client: The client.
|
||||
:param csrf_token: The CSRF token.
|
||||
:param username: The username.
|
||||
"""
|
||||
self.app: Flask = app
|
||||
self.client: httpx.Client = client
|
||||
self.csrf_token: str = csrf_token
|
||||
self._init_data()
|
||||
self.__app: Flask = app
|
||||
with self.__app.app_context():
|
||||
current_user: User | None = User.query\
|
||||
.filter(User.username == username).first()
|
||||
assert current_user is not None
|
||||
self.__current_user_id: int = current_user.id
|
||||
self.__journal_entries: list[dict[str, t.Any]] = []
|
||||
self.__line_items: list[dict[str, t.Any]] = []
|
||||
self._init_data()
|
||||
|
||||
@abstractmethod
|
||||
def _init_data(self) -> None:
|
||||
@ -312,6 +322,61 @@ class BaseTestData(ABC):
|
||||
:return: None
|
||||
"""
|
||||
|
||||
def populate(self) -> None:
|
||||
"""Populates the data into the database.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
from accounting.models import JournalEntry, JournalEntryLineItem
|
||||
with self.__app.app_context():
|
||||
db.session.execute(sa.insert(JournalEntry), self.__journal_entries)
|
||||
db.session.execute(sa.insert(JournalEntryLineItem),
|
||||
self.__line_items)
|
||||
db.session.commit()
|
||||
|
||||
def json(self) -> str:
|
||||
"""Returns the data as JSON.
|
||||
|
||||
:return: The JSON string.
|
||||
"""
|
||||
from accounting.models import Account
|
||||
today: date = date.today()
|
||||
|
||||
def filter_journal_entry(data: dict[str, t.Any]) -> list[t.Any]:
|
||||
"""Filters the journal entry data for JSON encoding.
|
||||
|
||||
:param data: The journal entry data.
|
||||
:return: The journal entry data for JSON encoding.
|
||||
"""
|
||||
data = data.copy()
|
||||
data["date"] = (today - data["date"]).days
|
||||
del data["created_by_id"]
|
||||
del data["updated_by_id"]
|
||||
return [data[x] for x in ["id", "date", "no", "note"]]
|
||||
|
||||
def filter_line_item(data: dict[str, t.Any]) -> list[t.Any]:
|
||||
"""Filters the journal entry line item data for JSON encoding.
|
||||
|
||||
:param data: The journal entry line item data.
|
||||
:return: The journal entry line item data for JSON encoding.
|
||||
"""
|
||||
data = data.copy()
|
||||
with self.__app.app_context():
|
||||
data["account_id"] \
|
||||
= db.session.get(Account, data["account_id"]).code
|
||||
data["amount"] = str(data["amount"])
|
||||
if "original_line_item_id" not in data:
|
||||
data["original_line_item_id"] = None
|
||||
return [data[x] for x in ["id", "journal_entry_id",
|
||||
"original_line_item_id", "is_debit",
|
||||
"no", "account_id", "currency_code",
|
||||
"description", "amount"]]
|
||||
|
||||
return json.dumps(
|
||||
[[filter_journal_entry(x) for x in self.__journal_entries],
|
||||
[filter_line_item(x) for x in self.__line_items]],
|
||||
ensure_ascii=False, separators=(",", ":"))
|
||||
|
||||
@staticmethod
|
||||
def _couple(description: str, amount: str, debit: str, credit: str) \
|
||||
-> tuple[JournalEntryLineItemData, JournalEntryLineItemData]:
|
||||
@ -332,26 +397,82 @@ class BaseTestData(ABC):
|
||||
:param journal_entry_data: The journal entry data.
|
||||
:return: None.
|
||||
"""
|
||||
from accounting.models import JournalEntry
|
||||
store_uri: str = "/accounting/journal-entries/store/transfer"
|
||||
from accounting.models import Account
|
||||
existing_j_id: set[int] = {x["id"] for x in self.__journal_entries}
|
||||
existing_l_id: set[int] = {x["id"] for x in self.__line_items}
|
||||
journal_entry_data.id = self.__new_id(existing_j_id)
|
||||
j_date: date = date.today() - timedelta(days=journal_entry_data.days)
|
||||
self.__journal_entries.append(
|
||||
{"id": journal_entry_data.id,
|
||||
"date": j_date,
|
||||
"no": self.__next_j_no(j_date),
|
||||
"note": journal_entry_data.note,
|
||||
"created_by_id": self.__current_user_id,
|
||||
"updated_by_id": self.__current_user_id})
|
||||
debit_no: int = 0
|
||||
credit_no: int = 0
|
||||
for currency in journal_entry_data.currencies:
|
||||
for line_item in currency.debit:
|
||||
account: Account | None \
|
||||
= Account.find_by_code(line_item.account)
|
||||
assert account is not None
|
||||
debit_no = debit_no + 1
|
||||
line_item.id = self.__new_id(existing_l_id)
|
||||
data: dict[str, t.Any] \
|
||||
= {"id": line_item.id,
|
||||
"journal_entry_id": journal_entry_data.id,
|
||||
"is_debit": True,
|
||||
"no": debit_no,
|
||||
"account_id": account.id,
|
||||
"currency_code": currency.code,
|
||||
"description": line_item.description,
|
||||
"amount": line_item.amount}
|
||||
if line_item.original_line_item is not None:
|
||||
data["original_line_item_id"] \
|
||||
= line_item.original_line_item.id
|
||||
self.__line_items.append(data)
|
||||
for line_item in currency.credit:
|
||||
account: Account | None \
|
||||
= Account.find_by_code(line_item.account)
|
||||
assert account is not None
|
||||
credit_no = credit_no + 1
|
||||
line_item.id = self.__new_id(existing_l_id)
|
||||
data: dict[str, t.Any] \
|
||||
= {"id": line_item.id,
|
||||
"journal_entry_id": journal_entry_data.id,
|
||||
"is_debit": False,
|
||||
"no": credit_no,
|
||||
"account_id": account.id,
|
||||
"currency_code": currency.code,
|
||||
"description": line_item.description,
|
||||
"amount": line_item.amount}
|
||||
if line_item.original_line_item is not None:
|
||||
data["original_line_item_id"] \
|
||||
= line_item.original_line_item.id
|
||||
self.__line_items.append(data)
|
||||
|
||||
response: httpx.Response = self.client.post(
|
||||
store_uri, data=journal_entry_data.new_form(self.csrf_token))
|
||||
assert response.status_code == 302
|
||||
journal_entry_id: int \
|
||||
= match_journal_entry_detail(response.headers["Location"])
|
||||
journal_entry_data.id = journal_entry_id
|
||||
with self.app.app_context():
|
||||
journal_entry: JournalEntry | None \
|
||||
= db.session.get(JournalEntry, journal_entry_id)
|
||||
assert journal_entry is not None
|
||||
for i in range(len(journal_entry.currencies)):
|
||||
for j in range(len(journal_entry.currencies[i].debit)):
|
||||
journal_entry_data.currencies[i].debit[j].id \
|
||||
= journal_entry.currencies[i].debit[j].id
|
||||
for j in range(len(journal_entry.currencies[i].credit)):
|
||||
journal_entry_data.currencies[i].credit[j].id \
|
||||
= journal_entry.currencies[i].credit[j].id
|
||||
@staticmethod
|
||||
def __new_id(existing_id: set[int]) -> int:
|
||||
"""Generates and returns a new random unique ID.
|
||||
|
||||
:param existing_id: The existing ID.
|
||||
:return: The newly-generated random unique ID.
|
||||
"""
|
||||
while True:
|
||||
obj_id: int = 100000000 + randbelow(900000000)
|
||||
if obj_id not in existing_id:
|
||||
existing_id.add(obj_id)
|
||||
return obj_id
|
||||
|
||||
def __next_j_no(self, j_date: date) -> int:
|
||||
"""Returns the next journal entry number in a day.
|
||||
|
||||
:param j_date: The journal entry date.
|
||||
:return: The next journal entry number.
|
||||
"""
|
||||
existing: set[int] = {x["no"] for x in self.__journal_entries
|
||||
if x["date"] == j_date}
|
||||
return 1 if len(existing) == 0 else max(existing) + 1
|
||||
|
||||
def _add_simple_journal_entry(
|
||||
self, days: int, currency: str, description: str, amount: str,
|
||||
@ -373,20 +494,3 @@ class BaseTestData(ABC):
|
||||
days, [JournalEntryCurrencyData(
|
||||
currency, [debit_item], [credit_item])]))
|
||||
return debit_item, credit_item
|
||||
|
||||
def _set_need_offset(self, account_codes: set[str],
|
||||
is_need_offset: bool) -> None:
|
||||
"""Sets whether the line items in some accounts need offset.
|
||||
|
||||
:param account_codes: The account codes.
|
||||
:param is_need_offset: True if the line items in the accounts need
|
||||
offset, or False otherwise.
|
||||
:return:
|
||||
"""
|
||||
from accounting.models import Account
|
||||
with self.app.app_context():
|
||||
for code in account_codes:
|
||||
account: Account | None = Account.find_by_code(code)
|
||||
assert account is not None
|
||||
account.is_need_offset = is_need_offset
|
||||
db.session.commit()
|
||||
|
Reference in New Issue
Block a user