Skip to content

feat: test framework with test factory#72

Merged
harshtandiya merged 9 commits intodevelopfrom
feat/test-framework
Apr 10, 2026
Merged

feat: test framework with test factory#72
harshtandiya merged 9 commits intodevelopfrom
feat/test-framework

Conversation

@harshtandiya
Copy link
Copy Markdown
Collaborator

@harshtandiya harshtandiya commented Apr 9, 2026

Summary

Integrates frappe_factory_bot into the Forms Pro test suite, replacing ad-hoc test data helpers with a proper factory layer.

New: forms_pro/tests/factories/

  • UserFactory — generates User docs with randomised email/name via Faker; exposes a with_forms_pro_role trait that includes the role in the initial doc dict so on_update fires once with the role already set
  • FPTeamFactory — generates FP Team docs with a random team name; owner is determined by the active Frappe user at creation time (matching the real app flow)
  • Both factories implement __del_override__ as a safety-net cleanup guard

Refactored: test_roles.py

  • Replaced the inline Faker + frappe.get_doc boilerplate with a single UserFactory.create() call

Refactored: test_invitations.py

  • Dropped _create_user() and _create_team() helper methods and the Faker import
  • Tracking lists changed from list[str] (email/name strings) to list[Document] — teardown now deletes by doc.name
  • UserFactory.build().email is used where only a random email address is needed without inserting a DB record
  • Helper signatures updated to accept Document args throughout, eliminating .name lookups scattered across the test body

hooks.py

  • Added frappe_factory_bot to required_apps so bench/CI pulls it in before running tests

Testing

  • pre-commit run --all-files
  • bench --site forms.localhost run-tests --app forms_pro — all 33 tests pass (2 pre-existing skips)

Checklist

  • PR title follows the conventional format used by this repo
  • Documentation updated if behavior or setup changed
  • Screenshots attached for UI changes when useful

Summary by CodeRabbit

  • Chores

    • Added test factories (UserFactory, FPTeamFactory, UserInvitationFactory) and package re-exports to standardize test data.
    • Updated CI to install a test helper app before running tests.
  • Tests

    • Refactored tests to use the new factories, simplifying setup/teardown and adjusting invitation and role-related test coverage.
  • Documentation

    • Added "Running Tests Locally" instructions for test setup and execution.

harshtandiya and others added 3 commits April 10, 2026 00:38
Introduces a factories package under forms_pro/tests/factories/ with:
- UserFactory: generates random User docs; with_forms_pro_role trait
  includes the role in the initial doc dict so on_update fires once
  with the role already set
- FPTeamFactory: generates FP Team docs with a random team name default

Both factories implement __del_override__ as a safety-net cleanup guard.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replaces manual frappe.get_doc + Faker boilerplate with UserFactory.create().
Role assignment is kept as a post-insert step since the test specifically
exercises the on_update hook that fires when a role is added after creation.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replaces _create_user() and _create_team() helpers and the Faker/string
tracking lists with UserFactory and FPTeamFactory. Key changes:
- _user(*traits) and _team(owner) thin wrappers call the factories and
  track Document objects instead of email/name strings
- Helper signatures updated to accept Document args throughout
- UserFactory.build().email used where only a random email is needed
  (no DB insert required)
- All 11 tests pass unchanged in behaviour

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 9, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 00ec1cf5-a358-4421-a34e-8e9df9df51c8

📥 Commits

Reviewing files that changed from the base of the PR and between b6f964f and d55b89e.

📒 Files selected for processing (1)
  • forms_pro/forms_pro/doctype/fp_team/test_fp_team.py

📝 Walkthrough

Walkthrough

Adds test factories (FPTeamFactory, UserFactory, UserInvitationFactory), re-exports factories via forms_pro/tests/factories/__init__.py, updates tests to use Document-backed factories, adds CI step to install frappe_factory_bot, and documents local test setup in README; removes a commented line from hooks.

Changes

Cohort / File(s) Summary
Factories package
forms_pro/tests/factories/__init__.py
New package initializer re-exporting FPTeamFactory and UserFactory and defining __all__.
Factory implementations
forms_pro/tests/factories/fp_team_factory.py, forms_pro/tests/factories/user_factory.py, forms_pro/tests/factories/user_invitation_factory.py
Added FPTeamFactory (doctype "FP Team"), UserFactory (doctype "User", generates unique email/name, with_forms_pro_role trait), and UserInvitationFactory (doctype "User Invitation", generates invitation payloads and to_forms_pro_app mapping). All use Faker for generated fields.
Tests updated
forms_pro/tests/test_invitations.py, forms_pro/tests/test_roles.py, forms_pro/forms_pro/doctype/fp_team/test_fp_team.py
Refactored tests to use factories and Document objects; helpers updated to accept Documents; assertions use Document.name/email; added/adjusted tests around invitation acceptance and after_insert role validation.
CI workflow
.github/workflows/ci.yml
Added workflow step to fetch/install frappe_factory_bot (bench get-app --branch main) before installing and testing forms_pro.
Documentation
README.md
Added "Running Tests Locally" section documenting installing frappe_factory_bot and bench commands to run tests.
Hooks cleanup
forms_pro/hooks.py
Removed a commented-out required_apps = [] line (no functional change).

Sequence Diagram(s)

(omitted)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Poem

🐰 I hop through fixtures, sewing names with care,
I plant small teams and users here and there.
Invitations flutter, roles checked with delight,
CI fetches my tools to run tests through the night.
I twitch my whiskers — all clean, not a hare out of place.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 48.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: introducing a test factory framework to improve test data management.
Description check ✅ Passed The description covers all required template sections: a detailed summary of changes, completed testing checklist with passing test results, and mostly completed project checklist.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/test-framework

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Introduces a new required_apps list in hooks.py to include the frappe_factory_bot repository, enabling its integration into the application. This change enhances the app's capabilities by allowing the use of factory methods for testing and development.
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (3)
forms_pro/tests/factories/user_factory.py (1)

29-35: Consider logging exceptions in cleanup instead of silently swallowing them.

The bare except Exception: pass makes it difficult to diagnose cleanup failures during test runs. While cleanup should be resilient, silently swallowing exceptions can mask underlying issues (e.g., permission problems, database connection issues) and leave orphaned test data.

♻️ Proposed fix to add logging
+import logging
+
+_logger = logging.getLogger(__name__)
+
 `@staticmethod`
 def __del_override__(_self: Any) -> None:
     try:
         if frappe.db.exists("User", _self.name):
             frappe.delete_doc("User", _self.name, force=True, ignore_permissions=True)
-    except Exception:
-        pass
+    except Exception as e:
+        _logger.debug("Failed to delete test user %s: %s", _self.name, e)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@forms_pro/tests/factories/user_factory.py` around lines 29 - 35, The
__del_override__ cleanup currently swallows all exceptions; update it to catch
Exception as e and log the error before continuing (e.g., call
frappe.log_error(e, "user_factory.__del_override__ cleanup failed") or use
frappe.logger().error with a clear message and the exception), keeping the
existing deletion logic and still suppressing the exception to avoid breaking
tests; reference the __del_override__ staticmethod and the
frappe.delete_doc/frappe.db.exists calls when applying the change.
forms_pro/tests/factories/fp_team_factory.py (1)

17-23: Same suggestion: log cleanup exceptions for debuggability.

Consistent with the UserFactory feedback, consider logging cleanup failures rather than silently passing.

♻️ Proposed fix
+import logging
+
+_logger = logging.getLogger(__name__)
+
 `@staticmethod`
 def __del_override__(_self: Any) -> None:
     try:
         if frappe.db.exists("FP Team", _self.name):
             frappe.delete_doc("FP Team", _self.name, force=True, ignore_permissions=True)
-    except Exception:
-        pass
+    except Exception as e:
+        _logger.debug("Failed to delete test team %s: %s", _self.name, e)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@forms_pro/tests/factories/fp_team_factory.py` around lines 17 - 23, The
__del_override__ cleanup currently swallows all exceptions, which hides
failures; update the handler in the __del_override__ method so that instead of a
bare except: pass it catches Exception as e and logs the error (including
exception details and context like the FP Team name) using the project's logging
mechanism (e.g., frappe.log_error or the module logger) when
frappe.db.exists("FP Team", _self.name) and frappe.delete_doc("FP Team",
_self.name, ...) fails, so failures during delete are recorded for debugging.
forms_pro/tests/test_roles.py (1)

12-31: Consider adding explicit tearDown cleanup for test isolation.

Unlike TestTeamInvitations which tracks created users in _created_users and explicitly deletes them in tearDown, this test relies solely on the factory's __del_override__ for cleanup. Python's __del__ timing is non-deterministic, which could cause test pollution if users persist across test runs.

♻️ Proposed fix to add explicit cleanup
 class TestRoles(IntegrationTestCase):
     def setUp(self):
         super().setUp()
+        self._created_users = []
+
+    def tearDown(self):
+        frappe.set_user("Administrator")
+        for user in self._created_users:
+            if frappe.db.exists("User", user.name):
+                frappe.delete_doc("User", user.name, force=True, ignore_permissions=True)
+        frappe.db.commit()
+        super().tearDown()

     def test_roles(self):
         user = UserFactory.create()
+        self._created_users.append(user)
         roles = frappe.get_roles(user.name)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@forms_pro/tests/test_roles.py` around lines 12 - 31, Add explicit teardown
cleanup for TestRoles by tracking created users and deleting them in a tearDown
method: when creating a user via UserFactory.create() in test_roles (or in
setUp), append the user's name to a test-level list (e.g., self._created_users)
and implement tearDown to iterate over that list and remove each user (using the
same deletion mechanism used elsewhere, e.g., delete_doc or user.delete()) to
ensure deterministic cleanup; update setUp to initialize self._created_users if
needed and ensure tearDown calls super().tearDown() at the end.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@forms_pro/tests/factories/fp_team_factory.py`:
- Around line 17-23: The __del_override__ cleanup currently swallows all
exceptions, which hides failures; update the handler in the __del_override__
method so that instead of a bare except: pass it catches Exception as e and logs
the error (including exception details and context like the FP Team name) using
the project's logging mechanism (e.g., frappe.log_error or the module logger)
when frappe.db.exists("FP Team", _self.name) and frappe.delete_doc("FP Team",
_self.name, ...) fails, so failures during delete are recorded for debugging.

In `@forms_pro/tests/factories/user_factory.py`:
- Around line 29-35: The __del_override__ cleanup currently swallows all
exceptions; update it to catch Exception as e and log the error before
continuing (e.g., call frappe.log_error(e, "user_factory.__del_override__
cleanup failed") or use frappe.logger().error with a clear message and the
exception), keeping the existing deletion logic and still suppressing the
exception to avoid breaking tests; reference the __del_override__ staticmethod
and the frappe.delete_doc/frappe.db.exists calls when applying the change.

In `@forms_pro/tests/test_roles.py`:
- Around line 12-31: Add explicit teardown cleanup for TestRoles by tracking
created users and deleting them in a tearDown method: when creating a user via
UserFactory.create() in test_roles (or in setUp), append the user's name to a
test-level list (e.g., self._created_users) and implement tearDown to iterate
over that list and remove each user (using the same deletion mechanism used
elsewhere, e.g., delete_doc or user.delete()) to ensure deterministic cleanup;
update setUp to initialize self._created_users if needed and ensure tearDown
calls super().tearDown() at the end.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e4e21514-85f7-484c-950f-102c37e30e33

📥 Commits

Reviewing files that changed from the base of the PR and between 46b31b0 and 2a82f42.

📒 Files selected for processing (5)
  • forms_pro/tests/factories/__init__.py
  • forms_pro/tests/factories/fp_team_factory.py
  • forms_pro/tests/factories/user_factory.py
  • forms_pro/tests/test_invitations.py
  • forms_pro/tests/test_roles.py

bench get-app with a local path skips required_apps resolution, so
frappe_factory_bot was never fetched. bench install-app then failed
with ModuleNotFoundError when Frappe tried to satisfy the required_apps
entry. Explicitly get the app before installing forms_pro.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@forms_pro/hooks.py`:
- Line 15: The required_apps list currently contains a Git URL which Frappe
doesn't accept; update the required_apps variable to use the app slug or
org/repo form instead of the full Git URL. Locate the required_apps declaration
and replace "https://github.com/harshtandiya/frappe_factory_bot.git:main" with
the package name or repo slug (for example "frappe_factory_bot" or
"harshtandiya/frappe_factory_bot") so dependency validation during
install/migrate succeeds.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 235e519f-a172-474f-8f3f-bfe64104a558

📥 Commits

Reviewing files that changed from the base of the PR and between 2a82f42 and a9af6c4.

📒 Files selected for processing (1)
  • forms_pro/hooks.py

Comment thread forms_pro/hooks.py Outdated
# ------------------

# required_apps = []
required_apps = ["https://github.com/harshtandiya/frappe_factory_bot.git:main"]
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🌐 Web query:

In Frappe Framework v15 hooks.py, does required_appsaccept Git URLs or only app names? Please provide the official docs example forrequired_apps.

💡 Result:

required_apps is not a Git URL field. In v15 it’s meant to list dependent app identifiers (the app name like erpnext, and in some contexts an org/repo slug like frappe/erpnext), rather than full https://... Git URLs. This is consistent with how Frappe describes required apps being referenced as erpnext or frappe/erpnext (org + app). [2]

Official docs example (hooks.py):

required_apps = ["erpnext"]

[1]

Sources: Frappe Framework Hooks docs (Required Apps section) [1], Frappe Cloud “Required app not found” (explains frappe/erpnext org/app form vs just erpnext) [2].


Use app name in required_apps, not a Git URL.

Line 15 sets required_apps with a repository URL, but Frappe expects installed app names (e.g., ["erpnext"] or org/repo slugs like ["frappe/erpnext"]). Using a Git URL here breaks dependency validation during install/migrate. Use the app slug instead.

Proposed fix
-required_apps = ["https://github.com/harshtandiya/frappe_factory_bot.git:main"]
+required_apps = ["frappe_factory_bot"]
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
required_apps = ["https://github.com/harshtandiya/frappe_factory_bot.git:main"]
required_apps = ["frappe_factory_bot"]
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@forms_pro/hooks.py` at line 15, The required_apps list currently contains a
Git URL which Frappe doesn't accept; update the required_apps variable to use
the app slug or org/repo form instead of the full Git URL. Locate the
required_apps declaration and replace
"https://github.com/harshtandiya/frappe_factory_bot.git:main" with the package
name or repo slug (for example "frappe_factory_bot" or
"harshtandiya/frappe_factory_bot") so dependency validation during
install/migrate succeeds.

@NagariaHussain
Copy link
Copy Markdown
Collaborator

I don't think this should be a dependency.

…ps for frappe_factory_bot

Added a new section to the README detailing how to run tests locally using frappe_factory_bot. Included installation instructions and commands for running all tests as well as specific test modules.
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/workflows/ci.yml:
- Line 93: The workflow currently checks out a mutable personal fork branch via
the bench command ("bench get-app frappe_factory_bot ... --branch main"); change
this to pin to an immutable, trusted ref by replacing the repository URL with
the upstream/trusted repository and using a specific tag or commit hash instead
of "main" (e.g., use --branch vX.Y.Z or --branch <commit-sha>) so builds are
reproducible and supply-chain safe; update the bench invocation that references
frappe_factory_bot accordingly and ensure the chosen tag/sha exists in the
trusted upstream before committing.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 21553432-514f-447a-b5be-efc4ac71651e

📥 Commits

Reviewing files that changed from the base of the PR and between a9af6c4 and 5b2194b.

📒 Files selected for processing (3)
  • .github/workflows/ci.yml
  • README.md
  • forms_pro/hooks.py
💤 Files with no reviewable changes (1)
  • forms_pro/hooks.py
✅ Files skipped from review due to trivial changes (1)
  • README.md

Comment thread .github/workflows/ci.yml
- 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
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify CI workflow does not use mutable branch refs for get-app.
rg -n --iglob '*.yml' --iglob '*.yaml' 'bench get-app .*--branch (main|master)\b' .github/workflows

# Verify source is not a personal fork namespace.
rg -n --iglob '*.yml' --iglob '*.yaml' 'bench get-app .*https://github.com/[a-zA-Z0-9_-]+/frappe_factory_bot\.git' .github/workflows

Repository: BuildWithHussain/forms_pro

Length of output: 349


Pin frappe_factory_bot to an immutable ref from a trusted source.

Line 93 uses a mutable main branch from a personal fork, which makes builds non-reproducible and weakens supply-chain safety. Pin to a version tag and use a trusted upstream repository.

Suggested change
-          bench get-app frappe_factory_bot https://github.com/harshtandiya/frappe_factory_bot.git --branch main
+          bench get-app frappe_factory_bot https://github.com/<trusted-org>/frappe_factory_bot.git --branch <pinned-tag>
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/workflows/ci.yml at line 93, The workflow currently checks out a
mutable personal fork branch via the bench command ("bench get-app
frappe_factory_bot ... --branch main"); change this to pin to an immutable,
trusted ref by replacing the repository URL with the upstream/trusted repository
and using a specific tag or commit hash instead of "main" (e.g., use --branch
vX.Y.Z or --branch <commit-sha>) so builds are reproducible and supply-chain
safe; update the bench invocation that references frappe_factory_bot accordingly
and ensure the chosen tag/sha exists in the trusted upstream before committing.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
forms_pro/tests/factories/user_invitation_factory.py (1)

24-29: Make to_forms_pro_app safer when a team override is provided.

Right now, Line 27 defaults to "/forms", which skips after_insert team-link processing unless every caller overrides redirect_to_path. Consider auto-building a team-aware redirect when team exists in overrides, and keep "/forms" as fallback.

💡 Proposed refactor
 `@property`
 def to_forms_pro_app(self) -> dict[str, Any]:
+    team = self.overrides.get("team")
+    team_id = getattr(team, "name", team) if team else None
+    redirect = self.overrides.get("redirect_to_path")
+    if not redirect and team_id:
+        redirect = f"/api/v2/method/forms_pro.api.team.add_member_to_team_via_invitation?team_id={team_id}"
+
     return {
         "app_name": "forms_pro",
-        "redirect_to_path": "/forms",
+        "redirect_to_path": redirect or "/forms",
         "roles": [{"role": FORMS_PRO_ROLE}],
     }
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@forms_pro/tests/factories/user_invitation_factory.py` around lines 24 - 29,
to_forms_pro_app currently always returns redirect_to_path "/forms", which
bypasses after_insert team-link processing when callers pass a team override;
update to_forms_pro_app to detect a provided team (e.g., check self.overrides or
the method's inputs for a "team" dict or object), and if present build a
team-aware redirect like "/teams/{team_slug}/forms" (or use team.id/slug as
appropriate), otherwise fall back to "/forms"; keep roles and app_name unchanged
and ensure FORMS_PRO_ROLE remains used.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@forms_pro/tests/factories/user_invitation_factory.py`:
- Around line 24-29: to_forms_pro_app currently always returns redirect_to_path
"/forms", which bypasses after_insert team-link processing when callers pass a
team override; update to_forms_pro_app to detect a provided team (e.g., check
self.overrides or the method's inputs for a "team" dict or object), and if
present build a team-aware redirect like "/teams/{team_slug}/forms" (or use
team.id/slug as appropriate), otherwise fall back to "/forms"; keep roles and
app_name unchanged and ensure FORMS_PRO_ROLE remains used.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: efaa726b-eb8f-414c-ade5-3ff4427a3f04

📥 Commits

Reviewing files that changed from the base of the PR and between 5b2194b and b6f964f.

📒 Files selected for processing (4)
  • forms_pro/tests/factories/fp_team_factory.py
  • forms_pro/tests/factories/user_factory.py
  • forms_pro/tests/factories/user_invitation_factory.py
  • forms_pro/tests/test_invitations.py
✅ Files skipped from review due to trivial changes (1)
  • forms_pro/tests/factories/fp_team_factory.py
🚧 Files skipped from review as they are similar to previous changes (2)
  • forms_pro/tests/factories/user_factory.py
  • forms_pro/tests/test_invitations.py

@harshtandiya harshtandiya added this pull request to the merge queue Apr 10, 2026
Merged via the queue into develop with commit db798f0 Apr 10, 2026
6 checks passed
@harshtandiya harshtandiya deleted the feat/test-framework branch April 10, 2026 17:19
harshtandiya added a commit that referenced this pull request Apr 19, 2026
* feat(tests): add UserFactory and FPTeamFactory via frappe_factory_bot

Introduces a factories package under forms_pro/tests/factories/ with:
- UserFactory: generates random User docs; with_forms_pro_role trait
  includes the role in the initial doc dict so on_update fires once
  with the role already set
- FPTeamFactory: generates FP Team docs with a random team name default

Both factories implement __del_override__ as a safety-net cleanup guard.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* refactor(tests): use UserFactory in test_roles

Replaces manual frappe.get_doc + Faker boilerplate with UserFactory.create().
Role assignment is kept as a post-insert step since the test specifically
exercises the on_update hook that fires when a role is added after creation.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* refactor(tests): use factories in TestTeamInvitations

Replaces _create_user() and _create_team() helpers and the Faker/string
tracking lists with UserFactory and FPTeamFactory. Key changes:
- _user(*traits) and _team(owner) thin wrappers call the factories and
  track Document objects instead of email/name strings
- Helper signatures updated to accept Document args throughout
- UserFactory.build().email used where only a random email is needed
  (no DB insert required)
- All 11 tests pass unchanged in behaviour

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix(hooks): add required_apps for frappe_factory_bot

Introduces a new required_apps list in hooks.py to include the frappe_factory_bot repository, enabling its integration into the application. This change enhances the app's capabilities by allowing the use of factory methods for testing and development.

* ci: fetch frappe_factory_bot before installing forms_pro

bench get-app with a local path skips required_apps resolution, so
frappe_factory_bot was never fetched. bench install-app then failed
with ModuleNotFoundError when Frappe tried to satisfy the required_apps
entry. Explicitly get the app before installing forms_pro.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs: update README with local test instructions and installation steps for frappe_factory_bot

Added a new section to the README detailing how to run tests locally using frappe_factory_bot. Included installation instructions and commands for running all tests as well as specific test modules.

* chore: remove del_override

* refactor: tests

* chore: refactor test_fp_team

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
harshtandiya added a commit that referenced this pull request Apr 19, 2026
* fix: route handling for /form

* feat: child table support v1 (#42)

* chore: bump frappe-ui to `0.1.262`

* feat: add 'Table' option to fieldtype selection

- Updated form_field.json and form_field.py to include 'Table' in the list of selectable field types for enhanced functionality.
- Adjusted the modified timestamp in form_field.json to reflect recent changes.

* feat: implement Table field component and enhance field options handling

- Added a new Table component for rendering tabular data input.
- Updated RenderField and FieldRenderer components to support dynamic options for Select and Link fields.
- Introduced useFieldOptions composable for improved option management.
- Enhanced form_fields utility to include Table as a selectable field type.
- Updated auto-imports and TypeScript definitions to accommodate new functionality.

* feat: enhance Table component fieldtype mapping

- Integrated utility function to map fieldtype for Table component, ensuring proper handling of field types.
- Defaulted unmapped fieldtypes to "Data" for improved consistency in table rendering.

* fix: update TableField component to use the correct Table component

- Replaced ListView with Table in the TableField definition to ensure proper rendering of tabular data.
- Adjusted imports in form_fields utility to reflect the change in component usage.

* refactor: remove onMounted hook from useFieldOptions

- Eliminated the onMounted lifecycle hook from the useFieldOptions composable to streamline the loading process of options.
- Adjusted imports to reflect the removal of the unused onMounted function.

* fix: child table fields fetch

* refactor: update TextEditor component bindings

- Changed `:model-value` to `:content` for TextEditor components across multiple files to ensure consistency in prop usage.
- Added an empty declaration block in auto-imports.d.ts for improved TypeScript support.

* feat: team management pages (#46)

* chore: bump lucide-icons

* feat: restructure home dashboard and sidebar

- Introduced a new home dashboard layout with a dedicated Dashboard.vue component.
- Migrated existing dashboard functionality from the previous Dashboard.vue to the new home structure.
- Added sidebar items management through a new sidebarItems.ts file for better organization.
- Updated TeamSwitcher component to conditionally render based on the current team.
- Removed unused code and components to streamline the application.

* refactor: enhance layout structure in BaseLayout and Dashboard components

- Wrapped the slot in BaseLayout with a div for improved layout consistency.
- Removed unnecessary padding class from the Dashboard component for a cleaner design.
- Ensured consistent formatting in watch options for better readability.

* fix: manageform page layout

* feat: team invitations via User Invitations

* feat: implement team member removal and permission toggling

- Added functionality to remove members from a team and toggle their edit permissions.
- Introduced `remove_member_from_team` and `toggle_can_edit_team` API endpoints.
- Created `RemoveMemberDialog` component for user confirmation before removal.
- Updated `TeamMemberList` to include removal actions and permission toggling.
- Enhanced `FPTeam` model to manage team member permissions effectively.

* feat: add team details update functionality

- Implemented a new API endpoint `save` to update team fields, allowing modifications to `team_name` and `logo`.
- Created `ManageTeamHeader` component for editing team name and logo upload functionality.
- Integrated the new save functionality into the team store for seamless updates.
- Updated `ManageTeam` page to include the new header component for enhanced team management.

* refactor: clean up imports in team store

- Removed unused `call` import from the team store file to streamline dependencies.

* chore: better code

- Added checks to prevent duplicate team member invitations and ensure team owners cannot have their permissions toggled.
- Updated `FPTeam` model to prevent removal of the team owner from the team.
- Modified `RemoveMemberDialog` and `TeamMemberList` components to improve member removal functionality and user experience.

* fix: tests

* chore: better code

* fix: team avatar uploader  (#47)

* feat: Image uploader component with crop

* feat: integrate ImageUploader for team logo management

- Replaced the existing logo upload button with an ImageUploader component for enhanced functionality.
- Added error handling and upload progress display within the ImageUploader.
- Updated the button label dynamically based on the upload state and existing logo presence.

* feat: enhance TeamSwitcher with search functionality

- Added a search input to the TeamSwitcher component, allowing users to filter teams by name.
- Updated the team options computation to include search query handling.
- Integrated a new search icon and improved layout for better user experience.
- Refactored dropdown item templates to accommodate the search input and maintain consistent styling.

* refactor: update CreateTeamDialog to use ImageUploader for logo uploads

- Replaced FileUploader with ImageUploader component for improved logo management.
- Updated type handling for uploaded files to align with new component.
- Enhanced error handling and upload progress display in the logo upload section.
- Adjusted button label to reflect upload status dynamically.

* refactor: update BaseLayout styling and icon usage

- Modified the layout classes for improved design consistency and responsiveness.
- Changed the logout button icon from a string to a component reference for better integration with the icon library.

* feat: add Breadcrumbs component to Dashboard

- Integrated Breadcrumbs component into the Dashboard for improved navigation.
- Defined breadcrumb items to enhance user context within the application.

* feat: submission list pages (#59)

* feat: add submissions page and update sidebar navigation

- Introduced a new "Manage Form Submissions" page for viewing form submissions.
- Updated the router to include a route for submissions.
- Refactored sidebar items to include navigation to the new submissions page.
- Enhanced the overview page with breadcrumb navigation for better user context.

* feat: submissions page v1

* feat: add Drawer component for UI enhancement

- Introduced a new Drawer component to provide a sliding panel interface.
- Implemented customizable properties for size, position, title, and actions.
- Added keyboard accessibility with Escape key support for closing the drawer.
- Included transition effects for smooth opening and closing animations.

* feat: extend Drawer component with additional size options

- Added "xl" size option to the Drawer component for enhanced customization.
- Updated size classes for both horizontal and vertical orientations to include new "xl" dimensions.

* feat: add submission details view and field value component

- Introduced SubmissionDetails component to display detailed information about a specific submission.
- Created SubmissionFieldValue component to render individual field values with appropriate formatting based on field type.
- Enhanced SubmissionList component to include a drawer for viewing submission details upon row click.
- Updated API integration to fetch submission data securely based on user permissions.

* feat: enhance SubmissionFieldValue component with dynamic class handling

- Added computed property to determine class names based on field type, improving layout for Switch and Checkbox types.
- Updated template structure to utilize dynamic classes for better styling and responsiveness.

* fix: validate doctype against linked_doctype in get_submission_response

A client could pass an arbitrary doctype to access submissions from a
different form. Now we fetch both linked_team_id and linked_doctype from
the Form doc and reject requests where the supplied doctype doesn't match.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix: throw when form not found in get_all_submissions

If form_id is invalid, frappe.db.get_value returns None and calling
has_permission(doc=None) has undefined behaviour. Explicitly throw
DoesNotExistError before the permission check.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix: show dash placeholder for null textarea value in SubmissionFieldValue

Textarea was rendering blank when value is null/undefined, inconsistent
with the default case which uses value ?? "–".

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix: remove unused isLoading ref in SubmissionList

isLoading was declared and set but never bound in the template, so the
loading state had no effect and was also never cleared on fetch error.
Removed it entirely.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix: show loading state in drawer when formData not yet available

If a row is clicked before formData loads, the drawer was empty. Now
shows a Loading... placeholder until linked_doctype is available.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix: add aria-labelledby to Drawer dialog element

Adds id="drawer-title" to the title heading and wires aria-labelledby
on the dialog div so assistive tech can announce the drawer title.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix: form sharing methods (#58)

* fix: form sharing methods

- Introduced `add_form_access` and `set_form_permission` functions to manage user permissions on forms.
- Updated the frontend to utilize the new API endpoints for adding access and setting permissions.
- Enhanced permission validation to ensure only authorized users can share forms.

* fix: validate permission_to allowlist and add docstrings to sharing API

- Validate `permission_to` against an explicit allowlist in `set_form_permission`
  to prevent unexpected kwargs from being forwarded to `add_docshare`
- Use `int(bool(value))` for safe coercion of the permission value
- Expand docstrings on `add_form_access` and `set_form_permission` with
  full Args/Raises sections and inline comments

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

* chore: hygine (#60)

* chore: update gitignore and pre-commit config for current project structure

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* chore: replace license.txt with LICENSE

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* chore: add community health files and GitHub templates

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs: update README with contributing and security references

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* chore: update Python version references to 3.14 across all configs

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix: set ruff target-version to py313 (py314 not yet supported)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

* refactor: move vulnerable dependency check to a separate workflow

The vulnerable dependency check has been extracted from the linter workflow into its own dedicated workflow file. This change improves organization and allows for more focused execution of dependency checks during pull requests and manual triggers.

* chore: update dependabot configuration to use npm instead of yarn

* chore(deps): bump actions/cache from 4 to 5 (#61)

Bumps [actions/cache](https://github.com/actions/cache) from 4 to 5.
- [Release notes](https://github.com/actions/cache/releases)
- [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md)
- [Commits](actions/cache@v4...v5)

---
updated-dependencies:
- dependency-name: actions/cache
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump actions/setup-node from 3 to 6 (#62)

Bumps [actions/setup-node](https://github.com/actions/setup-node) from 3 to 6.
- [Release notes](https://github.com/actions/setup-node/releases)
- [Commits](actions/setup-node@v3...v6)

---
updated-dependencies:
- dependency-name: actions/setup-node
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump actions/setup-python from 4 to 6 (#63)

Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4 to 6.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](actions/setup-python@v4...v6)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump pre-commit/action from 3.0.0 to 3.0.1 (#65)

Bumps [pre-commit/action](https://github.com/pre-commit/action) from 3.0.0 to 3.0.1.
- [Release notes](https://github.com/pre-commit/action/releases)
- [Commits](pre-commit/action@v3.0.0...v3.0.1)

---
updated-dependencies:
- dependency-name: pre-commit/action
  dependency-version: 3.0.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump actions/checkout from 3 to 6 (#66)

Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 6.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v3...v6)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps-dev): bump jsdom from 25.0.1 to 29.0.2 in /frontend (#67)

Bumps [jsdom](https://github.com/jsdom/jsdom) from 25.0.1 to 29.0.2.
- [Release notes](https://github.com/jsdom/jsdom/releases)
- [Commits](jsdom/jsdom@v25.0.1...v29.0.2)

---
updated-dependencies:
- dependency-name: jsdom
  dependency-version: 29.0.2
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump vue from 3.5.21 to 3.5.32 in /frontend (#68)

Bumps [vue](https://github.com/vuejs/core) from 3.5.21 to 3.5.32.
- [Release notes](https://github.com/vuejs/core/releases)
- [Changelog](https://github.com/vuejs/core/blob/main/CHANGELOG.md)
- [Commits](vuejs/core@v3.5.21...v3.5.32)

---
updated-dependencies:
- dependency-name: vue
  dependency-version: 3.5.32
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump zod from 4.1.12 to 4.3.6 in /frontend (#69)

Bumps [zod](https://github.com/colinhacks/zod) from 4.1.12 to 4.3.6.
- [Release notes](https://github.com/colinhacks/zod/releases)
- [Commits](colinhacks/zod@v4.1.12...v4.3.6)

---
updated-dependencies:
- dependency-name: zod
  dependency-version: 4.3.6
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump socket.io-client from 4.8.1 to 4.8.3 in /frontend (#70)

Bumps [socket.io-client](https://github.com/socketio/socket.io) from 4.8.1 to 4.8.3.
- [Release notes](https://github.com/socketio/socket.io/releases)
- [Changelog](https://github.com/socketio/socket.io/blob/main/CHANGELOG.md)
- [Commits](https://github.com/socketio/socket.io/compare/socket.io-client@4.8.1...socket.io-client@4.8.3)

---
updated-dependencies:
- dependency-name: socket.io-client
  dependency-version: 4.8.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps-dev): bump postcss from 8.5.6 to 8.5.8 in /frontend (#71)

Bumps [postcss](https://github.com/postcss/postcss) from 8.5.6 to 8.5.8.
- [Release notes](https://github.com/postcss/postcss/releases)
- [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
- [Commits](postcss/postcss@8.5.6...8.5.8)

---
updated-dependencies:
- dependency-name: postcss
  dependency-version: 8.5.8
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): update frappe-ui to 0.1.272

* chore(deps): update vite to version 5.4.21 and adjust auto-imports and Vite config

* refactor(tests): streamline email handling in TestTeamInvitations

Removed the use of patching for the sendmail function and replaced it with a flag to mute emails during tests. This change simplifies the setup and teardown process while ensuring that email notifications are suppressed during test execution. Additionally, cleaned up the tearDown method to delete the Email Queue after tests.

* refactor(tests): enhance email handling in TestTeamInvitations

Reintroduced patching for the sendmail function in the TestTeamInvitations class to ensure email notifications are suppressed during tests. Updated the setUp and tearDown methods to manage the patching process effectively, ensuring compatibility with different Frappe versions. Removed the deletion of the Email Queue in tearDown as it is no longer necessary.

* feat: test framework with test factory (#72)

* feat(tests): add UserFactory and FPTeamFactory via frappe_factory_bot

Introduces a factories package under forms_pro/tests/factories/ with:
- UserFactory: generates random User docs; with_forms_pro_role trait
  includes the role in the initial doc dict so on_update fires once
  with the role already set
- FPTeamFactory: generates FP Team docs with a random team name default

Both factories implement __del_override__ as a safety-net cleanup guard.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* refactor(tests): use UserFactory in test_roles

Replaces manual frappe.get_doc + Faker boilerplate with UserFactory.create().
Role assignment is kept as a post-insert step since the test specifically
exercises the on_update hook that fires when a role is added after creation.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* refactor(tests): use factories in TestTeamInvitations

Replaces _create_user() and _create_team() helpers and the Faker/string
tracking lists with UserFactory and FPTeamFactory. Key changes:
- _user(*traits) and _team(owner) thin wrappers call the factories and
  track Document objects instead of email/name strings
- Helper signatures updated to accept Document args throughout
- UserFactory.build().email used where only a random email is needed
  (no DB insert required)
- All 11 tests pass unchanged in behaviour

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix(hooks): add required_apps for frappe_factory_bot

Introduces a new required_apps list in hooks.py to include the frappe_factory_bot repository, enabling its integration into the application. This change enhances the app's capabilities by allowing the use of factory methods for testing and development.

* ci: fetch frappe_factory_bot before installing forms_pro

bench get-app with a local path skips required_apps resolution, so
frappe_factory_bot was never fetched. bench install-app then failed
with ModuleNotFoundError when Frappe tried to satisfy the required_apps
entry. Explicitly get the app before installing forms_pro.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs: update README with local test instructions and installation steps for frappe_factory_bot

Added a new section to the README detailing how to run tests locally using frappe_factory_bot. Included installation instructions and commands for running all tests as well as specific test modules.

* chore: remove del_override

* refactor: tests

* chore: refactor test_fp_team

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

* chore(deps): update devDependencies for Vite and Vitest (#73)

Updated the versions of @vitejs/plugin-vue, @vitest/coverage-v8, vite, and vitest in package.json to their latest compatible releases. Removed deprecated dependencies from yarn.lock and updated @bcoe/v8-coverage to version 1.0.2.

* feat(e2e): Playwright E2E test suite (#57) (#79)

* feat(e2e): Phase 1 — Playwright foundation

Install @playwright/test, add test:e2e scripts, create playwright.config.ts
with Chromium project, global-setup for Frappe session auth, and a smoke
spec that asserts an authenticated user can reach the forms dashboard.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* feat(e2e): Phase 2 — data-testid attributes, POMs, and test data fixture

Add data-testid to 7 Vue components (form-card, btn-new-form, field-type-*,
btn-save-form, btn-publish, btn-submit-form, submission-success,
btn-send-invite, input-invite-email). Restructure InviteMemberDialog to use
#actions slot so the send button is directly targetable. Create Page Object
Models (dashboard, form-builder, submission, team) and a Playwright fixture
with API helpers for form create/publish/teardown.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* feat(e2e): Phase 2+3 — semantic selectors and form-creation spec (5 tests)

Remove all data-testid attributes from Vue components (reverted to original).
Rewrite POMs with semantic selectors: getByRole/getByLabel/getByText, scoped
to pre-existing data-form-builder-component attributes. Add form-creation.spec.ts
covering dashboard listing, builder load, field canvas, publish, and unpublish.
Tests avoid triggering Frappe validation by never saving a field with an empty
label; publish/unpublish uses setValue({is_published}) which is always valid.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* feat(e2e): Phase 3+4 — remaining specs, flake fixes, and CI workflow

Specs:
- form-submission.spec.ts — guest context submission + success message
- submission-view.spec.ts — empty state and post-submission row visibility
- team-invite.spec.ts — invite dialog open/fill/send flow

Fixture:
- submitForm fixture for creating a guest submission via API

Reliability fixes:
- smoke.spec.ts: reload on Frappe 500 under parallel startup load
- TeamPage.goto(): waitForLoadState("networkidle") so Vue API calls
  complete before assertions run
- TeamPage.openInviteDialog(): wait for email input to be visible (not
  just the dialog shell) before returning
- playwright.config.ts: retries=1 everywhere; github reporter added

CI:
- .github/workflows/ui-tests.yml: full Playwright E2E workflow running
  against a real Frappe bench on every PR and push to develop

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* ci(ui-tests): log bench serve output on startup timeout

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* ci(ui-tests): fix server startup — switch to bench start, add hostname, fix action versions

- Replace bench serve (silent crash) with bench start + Procfile (disable watch/schedule)
- Add forms.test to /etc/hosts and set host_name config; rename site test_site → forms.test
- Swap npx wait-on for a curl loop (no install overhead, same pattern as buzz CI)
- Fix non-existent action versions: checkout@v6→@v4, setup-python@v6→@v5, setup-node@v6→@v4
- Add timeout-minutes: 60, fix concurrency group for push events, add workflow_dispatch
- Add Playwright browser cache step and bench logs dump on failure

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* ci(ui-tests): setup E2E test data — give Admin Forms Pro role and default team

`before_tests()` already added the role to Administrator, but the
`on_update` hook that creates the default team checks `has_value_changed`
on a freshly-fetched doc (which is always False), so no team was ever
created. `_ensure_admin_has_default_team()` closes that gap explicitly.

A new "Setup E2E test data" CI step calls `bench execute
forms_pro.install.before_tests` before the server starts, so the
test user has a team available when fixtures call `get_user_teams`.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix(form-generator): replace clear_cache() with targeted doctype cache clear

frappe.clear_cache() flushes Redis entirely, including session and CSRF
token data. In the E2E test suite this causes all POST API calls after
the first form creation to fail with CSRFTokenError, because the token
captured during global-setup is invalidated server-side.

Replace with frappe.clear_document_cache("DocType", name) which only
evicts the specific newly-created DocType from the document cache —
sufficient for the new schema to be reloaded on next access, and does
not touch sessions or CSRF tokens.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* ci(ui-tests): set ignore_csrf=1 for test site

Frappe's DocType.on_update() calls frappe.clear_cache() internally
whenever a DocType is saved. This flushes session/CSRF data from Redis,
invalidating the CSRF token captured in Playwright's storageState.json.
All POST API calls after the first form creation then fail with
CSRFTokenError.

ignore_csrf=1 is the standard Frappe configuration for CI/test sites
and skips CSRF validation entirely, which is correct here.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* ci(ui-tests): mute emails so invite test does not need an email account

Sets mute_emails=1 in site config so Frappe returns a dummy outgoing
account instead of throwing OutgoingEmailError when no real account is
configured, allowing the team-invite E2E test to succeed.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* ci(ui-tests): run E2E tests as the shared Forms Pro test user

- Switch global-setup login from Administrator to FORMS_PRO_TEST_USER
  (test_forms_pro_user@example.com / testforms123) so E2E tests run
  under a least-privileged Forms Pro User, matching real-user conditions
- Fix create_test_user() to strip the System User role Frappe auto-assigns
  on insert, leaving only the Forms Pro User role
- Set a known password via update_password() so Playwright can log in
- Add frontend/e2e/tsconfig.json with @types/node so process.env
  references in global-setup.ts type-check correctly
- Install @types/node dev dependency

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

* chore: update .gitignore to include Playwright report and skills-lock.json

* feat(multiselect): add Multiselect field with registry-driven builder extras (#85)

* feat(form-field): add Multiselect fieldtype to doctype and backend mapping

* fix(submission): serialize list values to JSON string before DocType insert

* feat(multiselect): wire up Multiselect field across the frontend

* docs: add add-field skill and register it in CLAUDE.md

* chore: move skills to .claude/skills, gitignore .agents, document npx skills workflow

* docs: add userinterface-wiki skill reference to CLAUDE.md

* feat(fieldTypes): add optional builderExtras component slot to FieldTypeDefinition

* refactor(fields): move Multiselect into multiselect/ subfolder, add MultiselectBuilderExtras

* feat(fieldTypes): update Multiselect import path and register MultiselectBuilderExtras

* refactor(builder): replace hardcoded Multiselect extras with registry-driven builderExtras

* feat(multiselect): enhance option addition with error handling and unique validation

* feat(multiselect): change layout to description-first (label → desc → checkboxes)

* refactor(builder): wrap template in single root div so builderExtras stacks below field

* test(e2e): add Playwright spec for Multiselect field builder and submission flow

* test(e2e): wait for canvas render and set label before adding options

* test(e2e): fix strict mode violation on No options defined locator

* test(e2e): wait for Add Option button to confirm field rendered on canvas

* test(e2e): ensure Add Option button is visible before adding options

* fix(e2e): ensure form is saved before publishing to enable Publish button

* fix(e2e): set form title and wait on Save button state

Multiselect spec clicked Save while form title was blank — Frappe
rejected the save with MandatoryError, Save button never hid, and the
publish helper timed out. Fill a title before save so the request
succeeds, and in the helper wait for the Save button to disappear (same
render cycle as Publish appearing) instead of polling for Publish.

* fix(ci): resolve all CI failures on backport branch

- Node 18 → 20 in ci.yml and typecheck.yml (@vitejs/plugin-vue@6 requires ≥20.19)
- nosemgrep comment on allow_guest=True in get_doctype_fields (intentional for public form rendering)
- Migrate form_fields.ts to re-export FIELD_TYPE_DEFINITIONS, fixing Multiselect missing from sidebar
- Add Multiselect to FormFieldTypes enum; fix TS2367 comparison in SubmissionFieldValue.vue

* fix(tests): use FrappeTestCase for version-15 compatibility

IntegrationTestCase was introduced in Frappe v16; version-15 exposes
FrappeTestCase from frappe.tests.utils.

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants