-
Notifications
You must be signed in to change notification settings - Fork 515
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into search-bar
- Loading branch information
Showing
312 changed files
with
12,495 additions
and
12,505 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| files: | ||
| - source: /public/locale/{{lang}}.json | ||
| translation: /public/locale/%two_letters_code%/%original_file_name% | ||
| - source: public/locale//{{lang}}.json | ||
| translation: /public/locale/%two_letters_code%.json | ||
| bundles: | ||
| - 2 | ||
|
|
||
| - 2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Best Practices | ||
|
|
||
| ## Test Independence | ||
|
|
||
| - Each test should be independent and isolated | ||
| - Clean up test data after tests | ||
| - Don't rely on the state from other tests | ||
|
|
||
| ## API Testing | ||
|
|
||
| - Use cy.intercept() for API verification | ||
| - Use waitUntil() for API completion | ||
| - Avoid cy.wait() except for API responses | ||
|
|
||
| ## Element Interaction | ||
|
|
||
| - Always verify element state before interaction | ||
| - Use data-cy attributes for selectors | ||
| - Verify button text before clicking | ||
| - Always verify loading states before and after interactions | ||
|
|
||
| ## Code Organization | ||
|
|
||
| - Keep tests focused and concise | ||
| - Follow AAA pattern (Arrange, Act, Assert) | ||
| - Use meaningful test descriptions | ||
|
|
||
| ## Common Pitfalls to Avoid | ||
|
|
||
| - Redundant visibility checks with verifyAndClickElement | ||
| - Hardcoded values in page objects | ||
| - Unnecessary waits | ||
| - Test interdependencies | ||
| - Skipping API verifications | ||
| - Using arbitrary timeouts instead of proper waits | ||
|
|
||
| ## Performance Considerations | ||
|
|
||
| - Minimize unnecessary API calls | ||
| - Use efficient selectors | ||
| - Batch similar operations | ||
|
|
||
| ## Testing Checklist | ||
|
|
||
| Before submitting your test, verify: | ||
|
|
||
| - [ ] All API calls are intercepted and verified | ||
| - [ ] Loading states are handled properly | ||
| - [ ] Success/error states are verified | ||
| - [ ] No arbitrary timeouts used | ||
| - [ ] Search operations include debounce handling | ||
| - [ ] Form submissions verify both request and response |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,114 +1,25 @@ | ||
| # Cypress Guidelines | ||
| # Cypress Testing Documentation | ||
|
|
||
| ## File Structure | ||
| ## Overview | ||
| This documentation covers the testing standards and patterns for our Cypress test suite. | ||
|
|
||
| ``` | ||
| cypress/ | ||
| ├── docs/ | ||
| │ └── cypress.md | ||
| ├── e2e/ # Test files grouped by modules | ||
| │ ├── patient/ # Patient module tests | ||
| │ │ ├── search.cy.ts | ||
| │ │ ├── create.cy.ts | ||
| │ │ └── edit.cy.ts | ||
| │ ├── facility/ # Facility module tests | ||
| │ │ ├── list.cy.ts | ||
| │ │ └── details.cy.ts | ||
| │ └── user/ # User module tests | ||
| │ ├── login.cy.ts | ||
| │ └── profile.cy.ts | ||
| ├── fixtures/ # Test data files by module | ||
| │ ├── patient/ | ||
| │ │ └── patient-data.json | ||
| │ └── facility/ | ||
| │ └── facility-data.json | ||
| ├── pageObject/ # Page Objects by module | ||
| │ ├── patient/ | ||
| │ │ ├── SearchPage.ts | ||
| │ │ └── CreatePage.ts | ||
| │ ├── facility/ | ||
| │ │ ├── ListPage.ts | ||
| │ │ └── DetailsPage.ts | ||
| │ └── utils/ # Common helpers and global functions | ||
| │ ├── CommonActions.ts # Shared actions across pages | ||
| │ ├── CommonAssertions.ts # Shared assertions | ||
| │ └── GlobalHelpers.ts # Platform-wide utility functions | ||
| ├── support/ # Core support files | ||
| │ ├── commands.ts # Custom Cypress commands | ||
| │ ├── e2e.ts # e2e test configuration | ||
| │ └── index.ts # Main support file | ||
| └── tsconfig.json | ||
| ``` | ||
|
|
||
| ## Support Files | ||
|
|
||
| - `commands.ts`: Custom Cypress commands and their TypeScript definitions | ||
| - `e2e.ts`: e2e specific configurations and imports | ||
| - `index.ts`: Main support file that loads commands and configurations | ||
|
|
||
| ## Page Objects Utils | ||
|
|
||
| The `pageObjects/utils` folder contains: | ||
|
|
||
| - Common helper functions used across different page objects | ||
| - Global utility functions for platform-wide operations | ||
| - Shared assertions and verifications | ||
| - Reusable action patterns | ||
|
|
||
| ## Module-based Organization | ||
|
|
||
| Each module (patient, facility, user, etc.) should have its own: | ||
|
|
||
| - Test files in `e2e/<module-name>/` | ||
| - Page Objects in `pageObjects/<module-name>/` | ||
| - Fixtures in `fixtures/<module-name>/` | ||
|
|
||
| This organization helps: | ||
|
|
||
| - Keep related tests and page objects together | ||
| - Maintain clear separation between module-specific and common utilities | ||
| - Enable better code reuse through common utilities | ||
| - Keep core support files focused and minimal | ||
| ## Quick Links | ||
| - [File Structure and Organization](./file-structure.md) | ||
| - [Testing Patterns](./patterns.md) | ||
| - [Best Practices](./best-practices.md) | ||
|
|
||
| ## Core Principles | ||
|
|
||
| - Create, use and modify Reusable Commands and Functions for Cypress as needed | ||
| - Provide Id for the elements using data-cy attributes | ||
| - When interacting with a button, verify the button is enabled and visible before interacting with it | ||
| - when interacting with a button, verify the text of the button is correct | ||
| - Use Page Object Model for Cypress | ||
| - Use built-in assertions for Cypress | ||
| - Use beforeEach, afterEach and all relevant hooks for Cypress on every test file | ||
|
|
||
| ## File Naming Conventions | ||
|
|
||
| - Test files: `feature-name.cy.ts` | ||
| - Page Objects: `FeatureNamePage.ts` | ||
| - Custom Commands: `feature-name.ts` | ||
| - Fixtures: `feature-name-data.json` | ||
|
|
||
| ## Storage Management | ||
|
|
||
| - Use cy.saveLocalStorage() and cy.restoreLocalStorage() for Cypress | ||
| - If we are using same element id to verify presence, interact and assert, make a reusable structure for it | ||
|
|
||
| ## API Testing | ||
|
|
||
| - Use cy.intercept() for Cypress to verify API calls | ||
| - Use waitUntil() for Cypress to wait for API calls to complete | ||
| - Never use cy.wait() for Cypress except for API responses | ||
|
|
||
| ## Best Practices | ||
|
|
||
| - Keep tests independent and isolated | ||
| - Use meaningful test descriptions | ||
| - Follow AAA pattern (Arrange, Act, Assert) | ||
| - Use fixtures for test data | ||
| - Implement custom commands for repetitive actions | ||
|
|
||
| ### Code Editing Guidelines | ||
|
|
||
| - When suggesting code edits, provide only the relevant file and changes | ||
| - Don't create separate folders for each edit | ||
| - Keep the existing file structure intact | ||
| - Provide clear comments for what's being changed | ||
| - Create and use reusable commands and functions | ||
| - Use data-cy attributes for element identification | ||
| - Follow Page Object Model pattern | ||
| - Write independent and isolated tests | ||
| - Use TypeScript for better type safety | ||
|
|
||
| ## Getting Started | ||
| 1. Familiarize yourself with the file structure | ||
| 2. Review the testing patterns | ||
| 3. Follow the best practices | ||
| 4. Use the provided examples as templates | ||
|
|
||
| ## Support | ||
| For questions or clarifications, refer to the specific documentation sections or reach out to the team. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # File Structure and Organization | ||
|
|
||
| ## Directory Structure | ||
|
|
||
| ``` | ||
| cypress/ | ||
| ├── docs/ | ||
| │ ├── README.md | ||
| │ ├── file-structure.md | ||
| │ ├── patterns.md | ||
| │ └── best-practices.md | ||
| ├── e2e/ # Test files grouped by modules | ||
| │ ├── patient/ | ||
| │ ├── facility/ | ||
| │ └── user/ | ||
| ├── fixtures/ | ||
| ├── pageObject/ # Page Objects grouped by modules | ||
| │ ├── patient/ | ||
| │ ├── facility/ | ||
| │ └── user/ | ||
| ├── utils/ # Utility functions and helpers | ||
| │ ├── facilityData.ts # Facility-related utility functions | ||
| │ └── commonUtils.ts # Shared utility functions | ||
| └── support/ | ||
| ``` | ||
|
|
||
| ## Module Organization | ||
|
|
||
| Each module (patient, facility, user, etc.) should have: | ||
|
|
||
| - Test files in `e2e/<module-name>/` | ||
| - Page Object in `pageObject/<module-name>/` | ||
| - Fixtures in `fixtures/<module-name>/` | ||
|
|
||
| ## File Naming Conventions | ||
|
|
||
| - Test files: `feature-name.cy.ts` | ||
| - Page Object: `FeatureNamePage.ts` | ||
| - Custom Commands: `feature-name.ts` | ||
| - Fixtures: `feature-name-data.json` | ||
|
|
||
| ## Support Files | ||
|
|
||
| - `commands.ts`: Custom Cypress commands | ||
| - `e2e.ts`: e2e configurations | ||
| - `index.ts`: Main support file | ||
|
|
||
| ## Storage Management | ||
|
|
||
| - Use cy.saveLocalStorage() and cy.restoreLocalStorage() | ||
| - Manage test data cleanup |
Oops, something went wrong.