Add vendor coupon tests

[shashwatahalder01]

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:

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 a new test suite for vendor coupon calculations, enhancing the testing coverage for coupon functionalities.
  • Added multiple tests for various coupon scenarios, including single and multiple coupons, both sequential and non-sequential.

• Bug Fixes

  • Updated existing tests for marketplace coupons for improved clarity by renaming variables.

[coderabbitai]

Walkthrough

The pull request introduces a new test suite specifically for vendor coupon calculations within the marketplace API's test framework. It includes multiple tests for different scenarios involving single and multiple coupons, both sequential and non-sequential. Additionally, existing tests have been updated for clarity by renaming variables, while the overall structure and logic of the test suite remain unchanged.

Changes

File Path	Change Summary
tests/pw/tests/api/calculation.spec.ts	- Added new test suite for vendor coupon calculations. - Included tests for single and multiple coupons (sequential and non-sequential). - Updated variable names for clarity (e.g., code1 to couponCode).

Possibly related PRs

• fix: Improve vendor coupon validation for various discount item types and empty cart scenarios #2351: This PR improves vendor coupon validation, which is directly related to the coupon calculations being tested in the main PR.
• Add product form tests #2383: This PR adds product form tests, which may relate to the coupon tests if they involve product pricing and discounts.
• Add: add product form tests (gallery, description) #2385: This PR introduces tests for product form functionalities, including descriptions and gallery options, which could intersect with coupon-related product tests.
• Add: product form tests (other options, catalog) #2391: This PR adds tests for product form options, which may include scenarios relevant to coupon applications in product pricing.
• Add: add product tests (product addon, rma) #2396: This PR introduces tests for product addons and RMA, which could relate to coupon functionalities if they affect product pricing or discounts.
• Add Geolocation tests #2445: This PR adds geolocation tests, which may not be directly related but could involve scenarios where coupons are applied based on location.
• Add new tests to featuremap #2453: This PR introduces new tests to the feature map, which may include functionalities related to coupons and discounts in product management.

Suggested labels

QA approved

Suggested reviewers

• mrabbani

🐰 In the land of code where coupons play,
New tests are hopping in a joyful array.
With vendors and discounts, they frolic and cheer,
Ensuring calculations are perfectly clear.
So let’s celebrate this testing delight,
For every coupon shines ever so bright! 🌟

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

tests/pw/tests/api/calculation.spec.ts (1)

455-507: Consider adding edge cases to strengthen test coverage.

While the current test cases cover the basic scenarios well, consider adding tests for edge cases such as:

• Coupons with minimum spend requirements
• Coupons with usage limits
• Expired coupons
• Invalid coupon combinations

Example test structure:

test('vendor coupon: minimum spend requirement not met', { tag: ['@lite'] }, async () => {
    const [, , couponCode] = await apiUtils.createCoupon([], { 
        ...payloads.createCoupon(), 
        discount_type: 'percent',
        minimum_amount: '100.00'
    }, payloads.vendorAuth);

    // place order with amount less than minimum spend
    const order = await apiUtils.createOrder(
        { ...payloads.createProduct(), regular_price: '50.00' },
        { ...payloads.createOrder, coupon_lines: [{ code: couponCode }] },
        payloads.vendorAuth
    );
    await assertOrderCalculation(order);
});

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b44d4b3 and f253830.

📒 Files selected for processing (1)

• tests/pw/tests/api/calculation.spec.ts (2 hunks)

🔇 Additional comments (2)

tests/pw/tests/api/calculation.spec.ts (2)

389-392: LGTM! Improved variable naming for better clarity.

The renaming of variables from generic names (e.g., code1) to more descriptive names (e.g., couponCode) enhances code readability and maintainability.

Also applies to: 427-430, 435-440

---

443-453: LGTM! Well-structured test setup for vendor coupon calculations.

The test suite initialization properly configures all necessary settings including tax rates, vendor commission, and discount calculation modes.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

tests/pw/tests/api/calculation.spec.ts (1)

443-507: Consider adding tests for edge cases and error scenarios.

While the current test coverage is good, consider adding tests for:

Edge cases:

• Zero value coupons
• Maximum discount limits
• Coupon usage limits

Error scenarios:

• Invalid coupon codes
• Expired coupons
• Usage limit exceeded

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f253830 and a334455.

📒 Files selected for processing (1)

• tests/pw/tests/api/calculation.spec.ts (2 hunks)

🔇 Additional comments (3)

tests/pw/tests/api/calculation.spec.ts (3)

389-392: LGTM! Improved variable naming.

The renaming of code1 to couponCode enhances code readability and makes the code more self-documenting.

Also applies to: 427-430, 435-440

---

443-507: LGTM! Well-structured vendor coupon test suite.

The new test suite provides comprehensive coverage for vendor coupon scenarios:

• Proper test environment setup
• Coverage for single and multiple coupons
• Handling of sequential and non-sequential discounts
• Testing of different coupon types (percent and fixed_cart)

---

443-507: Verify test implementation consistency across the codebase.

Let's ensure the test patterns are consistent across all coupon-related tests.

✅ Verification successful

Test implementation patterns are consistent across coupon-related tests

Based on the verification results:

1. The marketplace and vendor coupon calculation tests in calculation.spec.ts follow identical patterns:
   • Same test case structure for single/multiple/sequential coupons
   • Consistent use of assertOrderCalculation helper
   • Similar order creation and coupon application flow
2. The e2e tests in coupons.spec.ts have their own consistent patterns for UI testing
3. The API tests in coupons.spec.ts follow REST API testing conventions

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for consistent test patterns in coupon-related tests

# Search for all coupon-related test files
echo "Searching for coupon-related test files..."
fd -e ts -e js "coupon.*spec"

# Check test patterns in coupon-related tests
echo "Checking test patterns..."
rg -A 5 "test\('.*coupon.*'" 

# Check assertion patterns
echo "Checking assertion patterns..."
rg "assert.*Calculation"

Length of output: 20989