Added the sample data generation and database reset on the test site for live demonstration.

tests/test_site/__init__.py

@@ -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:

tests/test_site/reset.py

@@ -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)
+

tests/test_site/templates/base.html

@@ -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 %}

tests/test_site/templates/reset.html

@@ -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 %}