feat: test framework with test factory

.github/workflows/ci.yml

@@ -90,6 +90,7 @@ jobs:
       - name: Install
         working-directory: /home/runner/frappe-bench
         run: |
+          bench get-app frappe_factory_bot https://github.com/harshtandiya/frappe_factory_bot.git --branch main
           bench get-app forms_pro $GITHUB_WORKSPACE
           bench setup requirements --dev
           bench new-site --db-root-password root --admin-password admin test_site

README.md

@@ -139,6 +139,28 @@ The project includes automated testing via GitHub Actions:
 - **CI**: Installs the app and runs unit tests on pull requests and pushes to `develop`
 - **Linters**: Runs [Frappe Semgrep Rules](https://github.com/frappe/semgrep-rules) and [pip-audit](https://pypi.org/project/pip-audit/) on every pull request
 
+### Running Tests Locally
+
+The test suite uses [frappe_factory_bot](https://github.com/harshtandiya/frappe_factory_bot) for test data factories. You must install it on your bench before running tests.
+
+**1. Install frappe_factory_bot:**
+
+```bash
+cd $PATH_TO_YOUR_BENCH
+bench get-app https://github.com/harshtandiya/frappe_factory_bot.git --branch main
+bench --site <your-site> install-app frappe_factory_bot
+```
+
+**2. Run the tests:**
+
+```bash
+# Run all Forms Pro tests
+bench --site <your-site> run-tests --app forms_pro
+
+# Run a specific test module
+bench --site <your-site> run-tests --module forms_pro.tests.test_roles
+```
+
 ## 📄 License
 
 This project is licensed under the **AGPL-3.0** License - see the [LICENSE](LICENSE) file for details.

forms_pro/forms_pro/doctype/fp_team/test_fp_team.py

@@ -5,7 +5,7 @@
 from frappe.defaults import get_user_default
 from frappe.tests import IntegrationTestCase
 
-from forms_pro.tests import FORMS_PRO_TEST_USER
+from forms_pro.tests.factories import FPTeamFactory, UserFactory
 
 # On IntegrationTestCase, the doctype test records and all
 # link-field test record dependencies are recursively loaded
@@ -22,7 +22,7 @@ class IntegrationTestFPTeam(IntegrationTestCase):
 
     def setUp(self):
         super().setUp()
-        self.test_user = FORMS_PRO_TEST_USER
+        frappe.set_user("Administrator")
 
     def tearDown(self):
         frappe.set_user("Administrator")
@@ -33,45 +33,44 @@ def test_add_owner_to_team(self):
         Test that after a user creates a team, that owner user is added to the team and the team is shared with the owner user
         """
 
-        frappe.set_user(self.test_user)
+        owner = UserFactory.create("with_forms_pro_role")
+        frappe.set_user(owner.name)
 
-        team = frappe.new_doc("FP Team")
-        team.team_name = "Test Team"
-        team.insert()
+        team = FPTeamFactory.create()
         team.reload()
 
         frappe.set_user("Administrator")
 
-        # Check that the user is added to the team
-        self.assertTrue(team.is_team_member(self.test_user))
+        # Check that the owner is added to the team
+        self.assertTrue(team.is_team_member(owner.name))
 
-        # Check that the user is added to the team
+        # Check that the FP Team Member row exists
         self.assertIsNotNone(
             frappe.db.exists(
                 "FP Team Member",
                 {
                     "parent": team.name,
                     "parentfield": "users",
                     "parenttype": "FP Team",
-                    "user": self.test_user,
+                    "user": owner.name,
                 },
             )
         )
 
-        # Check that the user is added to the team's docshare
+        # Check that the team is shared with the owner
         self.assertTrue(
             frappe.db.exists(
                 "DocShare",
                 {
                     "share_doctype": "FP Team",
                     "share_name": team.name,
-                    "user": self.test_user,
+                    "user": owner.name,
                     "read": 1,
                     "write": 1,
                     "share": 1,
                 },
             )
         )
 
-        # Check that the user's current team is set to the team
-        self.assertEqual(get_user_default("current_team", self.test_user), team.name)
+        # Check that the owner's current team is set to this team
+        self.assertEqual(get_user_default("current_team", owner.name), team.name)

forms_pro/hooks.py

@@ -9,11 +9,6 @@
 fixtures = [
     {"dt": "Role", "filters": {"role_name": "Forms Pro User"}},
 ]
-# Apps
-# ------------------
-
-# required_apps = []
-
 # Each item in the list will be shown as an app in the apps page
 add_to_apps_screen = [
     {

forms_pro/tests/factories/__init__.py

@@ -0,0 +1,4 @@
+from forms_pro.tests.factories.fp_team_factory import FPTeamFactory
+from forms_pro.tests.factories.user_factory import UserFactory
+
+__all__ = ["FPTeamFactory", "UserFactory"]

forms_pro/tests/factories/fp_team_factory.py

@@ -0,0 +1,14 @@
+from typing import Any
+
+from faker import Faker
+from frappe_factory_bot.frappe_factory_bot.base_factory import BaseFactory
+
+_fake = Faker()
+
+
+class FPTeamFactory(BaseFactory):
+    doctype = "FP Team"
+
+    @property
+    def default_attributes(self) -> dict[str, Any]:
+        return {"team_name": f"{_fake.word().capitalize()} Team"}

forms_pro/tests/factories/user_factory.py

@@ -0,0 +1,26 @@
+from typing import Any
+
+from faker import Faker
+from frappe_factory_bot.frappe_factory_bot.base_factory import BaseFactory
+
+from forms_pro.roles import FORMS_PRO_ROLE
+
+_fake = Faker()
+
+
+class UserFactory(BaseFactory):
+    doctype = "User"
+
+    @property
+    def default_attributes(self) -> dict[str, Any]:
+        return {
+            "email": _fake.unique.email(),
+            "first_name": _fake.first_name(),
+            "last_name": _fake.last_name(),
+        }
+
+    @property
+    def with_forms_pro_role(self) -> dict[str, Any]:
+        # Frappe accepts child table rows as dicts in the initial doc dict.
+        # on_update fires with the role already set, so the default team is created.
+        return {"roles": [{"role": FORMS_PRO_ROLE}]}

forms_pro/tests/factories/user_invitation_factory.py

@@ -0,0 +1,29 @@
+from typing import Any
+
+from faker import Faker
+from frappe_factory_bot.frappe_factory_bot.base_factory import BaseFactory
+
+from forms_pro.roles import FORMS_PRO_ROLE
+
+_fake = Faker()
+
+
+class UserInvitationFactory(BaseFactory):
+    doctype = "User Invitation"
+
+    @property
+    def default_attributes(self) -> dict[str, Any]:
+        return {
+            "email": self.overrides.get("email", _fake.unique.email()),
+            "redirect_to_path": self.overrides.get("redirect_to_path", "/forms"),
+            "invited_by": self.overrides.get("invited_by") or "Administrator",
+            "status": self.overrides.get("status") or "Pending",
+        }
+
+    @property
+    def to_forms_pro_app(self) -> dict[str, Any]:
+        return {
+            "app_name": "forms_pro",
+            "redirect_to_path": "/forms",
+            "roles": [{"role": FORMS_PRO_ROLE}],
+        }