Add storecategories tests (test automation)

All Submissions:

[ ] My code follow the WordPress' coding standards
[ ] My code satisfies feature requirements
[ ] My code is tested
[ ] My code passes the PHPCS tests
[ ] My code has proper inline documentation
[ ] I've included related pull request(s) (optional)
[ ] I've included developer documentation (optional)
[ ] I've added proper labels to this pull request

Changes proposed in this Pull Request:

Add store categories test
Fix couple of flaky tests
Add test environment info to reporter

Related Pull Request(s)

Full PR Link

Closes

Closes #

How to test the changes in this Pull Request:

Steps or issue link

Changelog entry

Title

Detailed Description of the pull request. What was previous behaviour and what will be changed in this PR.

Before Changes

Describe the issue before changes with screenshots(s).

After Changes

Describe the issue after changes with screenshot(s).

Feature Video (optional)

Link of detailed video if this PR is for a feature.

PR Self Review Checklist:

Code is not following code style guidelines
Bad naming: make sure you would understand your code if you read it a few months from now.
KISS: Keep it simple, Sweetie (not stupid!).
DRY: Don't Repeat Yourself.
Code that is not readable: too many nested 'if's are a bad sign.
Performance issues
Complicated constructions that need refactoring or comments: code should almost always be self-explanatory.
Grammar errors.

FOR PR REVIEWER ONLY:

As a reviewer, your feedback should be focused on the idea, not the person. Seek to understand, be respectful, and focus on constructive dialog.

As a contributor, your responsibility is to learn from suggestions and iterate your pull request should it be needed based on feedback. Seek to collaborate and produce the best possible contribution to the greater whole.

[ ] Correct — Does the change do what it’s supposed to? ie: code 100% fulfilling the requirements?
[ ] Secure — Would a nefarious party find some way to exploit this change? ie: everything is sanitized/escaped appropriately for any SQL or XSS injection possibilities?
[ ] Readable — Will your future self be able to understand this change months down the road?
[ ] Elegant — Does the change fit aesthetically within the overall style and architecture?

Summary by CodeRabbit

New Features
- Introduced permissions for admins to assign single and multiple store categories to vendors.
- Added a new method to assign store categories to vendors.
- Implemented new test cases for assigning store categories to vendors.
Bug Fixes
- Corrected the API endpoint for payment gateways to ensure proper functionality.
- Enhanced the filtering logic in the Withdraws page to reload data before applying filters.
Improvements
- Improved visibility checks in the BasePage class for better reliability.
- Updated the ProductsPage class to ensure application state is fully loaded before proceeding.
Tests
- Expanded testing coverage for order cancellation and store category assignments.
- Added dynamic environment variables for vendor IDs in test scenarios.
Documentation
- Enhanced comments and clarity in various methods for better understanding.

Walkthrough

The changes encompass modifications across various files related to store category management, UI interactions, and testing frameworks. Enhancements include new permissions for assigning store categories to vendors, improvements in visibility checks for UI elements, adjustments to URL endpoints for order management, and the introduction of methods for product addons. Additionally, updates to TypeScript configurations and utility functions were made to improve the overall functionality and maintainability of the codebase.

Changes

Files	Change Summary
`tests/pw/feature-map/feature-map.yml`	Added permissions for admin to assign store categories to vendors (single and multiple).
`tests/pw/pages/basePage.ts`	Enhanced `isVisible` method with polling mechanism; clarified parameter naming; updated comment.
`tests/pw/pages/customerPage.ts`	Updated URLs in `addBillingAddress` and `addShippingAddress` methods to use `editAddress`.
`tests/pw/pages/myOrdersPage.ts`	Changed URLs for order cancellation and reordering methods; commented out a checkout step.
`tests/pw/pages/paymentsPage.ts`	Corrected method call URL from `paymentGayways` to `paymentGateways`.
`tests/pw/pages/productsPage.ts`	Replaced `clickAndWaitForResponse` with `clickAndWaitForResponseAndLoadState` in method calls.
`tests/pw/pages/selectors.ts`	Added new selectors for store category management; modified existing selectors for specificity.
`tests/pw/pages/shortcodePage.ts`	Modified `closeBlockEditorModal` method; removed timeout parameter from visibility check.
`tests/pw/pages/storeCategoriesPage.ts`	Added `assignStoreCategoryToVendor` method for category assignment to vendors.
`tests/pw/pages/withdrawsPage.ts`	Added `this.reload()` call before filtering by payment methods.
`tests/pw/tests/e2e/_localSite.setup.ts`	Introduced a test case for checking out the develop branch of the Dokan Pro plugin.
`tests/pw/tests/e2e/myOrders.spec.ts`	Updated test cases for order cancellation to use different customer instances.
`tests/pw/tests/e2e/storeCategories.spec.ts`	Added test cases for assigning single and multiple store categories to vendors.
`tests/pw/tsconfig.json`	Updated TypeScript `target` and `module` to support ESNext features.
`tests/pw/utils/apiUtils.ts`	Changed `fs` import to dynamic; added methods for product addons; updated `getSystemStatus`.
`tests/pw/utils/dbData.ts`	Changed `store_category_type` from `'multiple'` to `'single'`.
`tests/pw/utils/gitTestSummary.ts`	Modified `addList` function to include OS information in the summary.
`tests/pw/utils/pwMatchers.ts`	Removed comment regarding adding more custom matchers.
`tests/pw/utils/testData.ts`	Added new properties and function for AJAX operations; changed `WP_DEBUG_DISPLAY` to `true`.

Sequence Diagram(s)

sequenceDiagram
    participant Admin
    participant StoreCategoriesPage
    participant Vendor
    participant UI

    Admin->>StoreCategoriesPage: Assign store category to vendor
    StoreCategoriesPage->>Vendor: Navigate to vendor's details
    StoreCategoriesPage->>UI: Select categories
    UI-->>StoreCategoriesPage: Categories selected
    StoreCategoriesPage->>Vendor: Confirm category assignment
    Vendor-->>Admin: Categories assigned

🐰 Hopping through the code with glee,
New features sprout like leaves on a tree.
Categories for vendors, now easy to share,
With tests and updates, we show we care!
Let’s celebrate changes, both big and small,
In our coding garden, there’s room for us all! 🌱✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

getdokan / dokan