feat: Add testing documentation for webforJ applications #382
Conversation
hyyan
requested review from
MatthewHawkins,
nmlynx and
mschned
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
docs/testing/selenium.md
Outdated
| - `webforJ` app is correctly set up and running on your local server. | ||
| - You have installed: | ||
| - Selenium Java bindings. | ||
| - A compatible WebDriver for your browser (e.g., `ChromeDriver` or `GeckoDriver`). |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
docs/testing/selenium.md
Outdated
| - `webforJ` app is correctly set up and running on your local server. | ||
| - You have installed: | ||
| - Selenium Java bindings. | ||
| - A compatible WebDriver for your browser (e.g., `ChromeDriver` or `GeckoDriver`). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Google.Latin] Use 'for example' instead of 'e.g.'.
docs/testing/overview.md
Outdated
| </Head> | ||
|
|
||
|
|
||
| # Testing in webforJ |
There was a problem hiding this comment.
[Google.Headings] 'Testing in webforJ' should use sentence-style capitalization.
docs/testing/overview.md
Outdated
|
|
||
| # Testing in webforJ | ||
|
|
||
| Testing in `webforJ` applications combines traditional Java unit testing with end-to-end (E2E) testing to ensure robust functionality and user experience. |
There was a problem hiding this comment.
[Google.WordList] Use 'capability' or 'feature' instead of 'functionality'.
docs/testing/overview.md
Outdated
| ## End-to-End testing | ||
|
|
||
| Since `webforJ` generates dynamic, single-page web applications, end-to-end testing is essential for validating user interactions and UI behavior. Tools like Selenium and Playwright allow you to: | ||
| - Automate browser interactions (e.g., button clicks, form submissions). |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
docs/testing/overview.md
Outdated
| ## End-to-End testing | ||
|
|
||
| Since `webforJ` generates dynamic, single-page web applications, end-to-end testing is essential for validating user interactions and UI behavior. Tools like Selenium and Playwright allow you to: | ||
| - Automate browser interactions (e.g., button clicks, form submissions). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Google.Latin] Use 'for example' instead of 'e.g.'.
docs/testing/overview.md
Outdated
|
|
||
| Since `webforJ` generates dynamic, single-page web applications, end-to-end testing is essential for validating user interactions and UI behavior. Tools like Selenium and Playwright allow you to: | ||
| - Automate browser interactions (e.g., button clicks, form submissions). | ||
| - Verify the rendering and functionality of dynamic components. |
There was a problem hiding this comment.
[Google.WordList] Use 'capability' or 'feature' instead of 'functionality'.
|
|
||
| The `PropertyDescriptorTester` in webforJ is a tool designed to simplify testing for **third-party web components** integrated into your app. It ensures that properties defined with [`PropertyDescriptor`](https://javadoc.io/doc/com.webforj/webforj-foundation/latest/com/webforj/component/element/PropertyDescriptor.html) are correctly linked to their getter and setter methods, and that default behaviors are consistent. | ||
|
|
||
| This is particularly useful when integrating third-party components that expose properties as part of their API, allowing you to validate their functionality without needing to write repetitive test logic. |
There was a problem hiding this comment.
[Google.WordList] Use 'capability' or 'feature' instead of 'functionality'.
| - Skips fields annotated with `@PropertyExclude`. | ||
|
|
||
| 2. **Resolve Methods**: | ||
| - Determines getter and setter methods based on standard conventions (`get<PropertyName>`/`set<PropertyName>`). |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
docs/testing/playwright.md
Outdated
| - The `webforJ` app is correctly set up and running on your local server. | ||
| - You have installed: | ||
| - Playwright Java bindings. | ||
| - A compatible browser (Playwright can automatically install browsers during setup). |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
docs/testing/overview.md
Outdated
|
|
||
| # Testing in webforJ | ||
|
|
||
| Testing in webforJ applications combines traditional Java unit testing with end-to-end (E2E) testing to ensure robust functionality and user experience. |
There was a problem hiding this comment.
[Google.WordList] Use 'capability' or 'feature' instead of 'functionality'.
| - The webforJ app is correctly set up and running on your local server. | ||
| - You have installed: | ||
| - Playwright Java bindings. | ||
| - A compatible browser (Playwright can automatically install browsers during setup). |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
| `}</style> | ||
| </Head> | ||
|
|
||
| # webforJ Testing |
There was a problem hiding this comment.
[Google.Headings] 'webforJ Testing' should use sentence-style capitalization.
| title: PropertyDescriptorTester | ||
| --- | ||
|
|
||
| The `PropertyDescriptorTester` in webforJ simplifies testing for **third-party web components** integrated into your app. It validates that properties defined with [`PropertyDescriptor`](https://javadoc.io/doc/com.webforj/webforj-foundation/latest/com/webforj/component/element/PropertyDescriptor.html) are correctly linked to their getter and setter methods and ensures that default behaviors are handled consistently. This tool is especially useful for verifying the functionality of properties exposed by third-party components without requiring repetitive test logic. |
There was a problem hiding this comment.
[Google.WordList] Use 'capability' or 'feature' instead of 'functionality'.
No description provided.