Add coupon and refund ratio parameters to order generator

[layoutd]

Summary

This PR adds two new parameters to the order generator for more realistic test data generation, plus a new parameter for the coupon generator:

1. --coupon-ratio: Apply coupons to a percentage of generated orders
2. --refund-ratio: Refund a percentage of completed orders
3. --discount_type: Specify discount type when generating coupons

Changes

Order Generator

--coupon-ratio Parameter

• Accepts a decimal value between 0.0 and 1.0
• Determines the percentage of orders that should have coupons applied
• If no coupons exist, automatically creates 6 coupons (3 fixed cart $5-$50, 3 percentage 5%-25%)
• Backwards compatible with existing --coupons flag (same as using --coupons-ratio=1.0)

Examples:

# Apply coupons to 50% of orders
wp wc generate orders 100 --coupon-ratio=0.5

# Apply coupons to all orders
wp wc generate orders 100 --coupon-ratio=1.0

--refund-ratio Parameter

• Accepts a decimal value between 0.0 and 1.0
• Determines the percentage of completed orders that should be refunded
• Only applies to orders with completed status
• Refunds are split roughly evenly between full and partial refunds
• Additionally, ~ 25% of partial refunds will receive a second partial refund
• Two partial refunds will never reach full refund value
• Creates realistic refund line items with proper amounts and tax calculations
• Refund dates are realistic: first refunds within 2 months of completion, second refunds within 1 month of first
• Refund reasons include item counts: "Partial refund - X products, Y items" or "Full refund"

Examples:

# Refund 30% of completed orders
wp wc generate orders 100 --status=completed --refund-ratio=0.3

# Refund all completed orders
wp wc generate orders 100 --status=completed --refund-ratio=1.0

# Generate orders with both coupons and refunds
wp wc generate orders 100 --status=completed --coupon-ratio=0.5 --refund-ratio=0.3

Coupon Generator

--discount_type Parameter

• Accepts fixed_cart or percent
• Allows creating coupons of a specific discount type
• Maintains backwards compatibility: if not specified, uses WooCommerce default (fixed_cart)
• Enables the Order generator to create a mix of coupon types when auto-creating coupons

Examples:

# Create 20 percentage coupons with 5-25% discount
wp wc generate coupons 20 --discount_type=percent --min=5 --max=25

# Create 10 fixed cart coupons with $10-$100 discount
wp wc generate coupons 10 --discount_type=fixed_cart --min=10 --max=100

Technical Details

Refund Implementation

• Uses WooCommerce's wc_create_refund() function
• Properly calculates line item refund amounts and taxes
• Preserves tax rate IDs in refund tax arrays
• Explicitly calculates refund amounts from line items
• Full refunds include all line items and fees
• Partial refunds can be:
  • Complete items (subset of order items)
  • Partial quantities (e.g., 2 of 5 items)
• Full refunds update order status to refunded
• Tracks already-refunded quantities to prevent over-refunding
• Division-by-zero guards protect against edge cases

Coupon Implementation

• Leverages existing Coupon::generate() method with new discount_type parameter
• Auto-creation ensures realistic mix of fixed and percentage coupons
• Uses Coupon::get_random() to retrieve existing coupons
• Backwards compatible with existing code

Testing

Start with 0 orders and 0 coupons!!

Coupon Ratio Tests

• Verify 6 coupons are created (3 fixed, 3 percent) when none exist

  # First delete all coupons, then:
  wp wc generate orders 20 --coupon-ratio=0.5
  # Check: 6 coupons should exist (3 fixed_cart $5-$50, 3 percent 5-25%)

• CONTINUE: test coupon-ratio applies coupons to correct percentage of orders

  # Then check: approximately 10 of the above orders should have coupons applied (open all in new tab and look for discounts on first line item)

• BULK DELETE all orders with WP Admin interface /wp-admin/admin.php?page=wc-orders

• Test coupon-ratio=1.0 applies coupons to all orders

  wp wc generate orders 10 --coupon-ratio=1.0
  # Check: all 10 orders should have coupons applied (open all in new tab and look for discounts on first line item)
  # NOTE that the orders don't appear in the count in the Coupons table if they're failed, etc.

• BULK DELETE all orders with WP Admin interface /wp-admin/admin.php?page=wc-orders

• Test backwards compatibility with --coupons flag

  wp wc generate orders 10 --coupons
  # Check: all orders should have coupons (existing behavior)

Refund Ratio Tests

• BULK DELETE all orders with WP Admin interface /wp-admin/admin.php?page=wc-orders

• Test refund-ratio=0.5 refunds approximately 50% of orders

  wp wc generate orders 20 --status=completed --refund-ratio=0.5
  # Check: about 10 orders should have refunds (strikeout prices in orders table)

• BULK DELETE all orders with WP Admin interface /wp-admin/admin.php?page=wc-orders

• Test refund-ratio=1.0 refunds all completed orders

  wp wc generate orders 20 --status=completed --refund-ratio=1.0  --date-start=2023-01-01 --date-end=2023-01-31
  # Check: all 20 orders should have refunds (strikeout prices in orders table)

• CONTINUE: Verify refund amounts match line item totals (not 0.00)

  # Check in WP Admin: refund totals should match refunded items totals (look at some individual orders confirm line item red numbers add up to refund line item)

• CONTINUE Verify refund dates are realistic

  # Check: all refunds should basically be in Q1 2023 (~2 months for first, ~1 additional month if there's a second refund) Confirm line item refund date is in Q1 2023 and not today

• CONTINUE Verify partial refund reasons show correct product/item counts

  # Check: partial refunds should have reasons like "Partial refund - 2 products, 3 items" (look at individual order line items and refund item)

• BULK DELETE all orders with WP Admin interface /wp-admin/admin.php?page=wc-orders

• Verify ~25% of partial refunds receive a second refund

  wp wc generate orders 100 --status=completed --refund-ratio=1.0 --date-start=2021-01-01 --date-end=2021-01-31
  # Check: approximately 12-13 orders should have 2+ refunds (25% of ~50% partial = ~12.5%) - open all partial refunds (completed with strikethrough price in orders table) and see if any have two refudns 
  # OR use
  # SELECT SUM(cnt) FROM (SELECT count(*) as cnt, parent_order_id FROM wp_wc_orders WHERE parent_order_id!=0 AND wp_wc_orders.date_created_gmt < "2023-01-01" GROUP BY parent_order_id HAVING cnt >= 2 ORDER BY cnt DESC, parent_order_id desc) as tbl;

• BULK DELETE all orders with WP Admin interface /wp-admin/admin.php?page=wc-orders

• Test refund-ratio only affects completed orders

  wp wc generate orders 10 --status=processing --refund-ratio=1.0
  # Check: no orders should have refunds (only completed status can be refunded)

Discount Type Tests

• BULK DELETE all coupons with WP Admin interface /wp-admin/edit.php?post_type=shop_coupon

• Test creating percentage coupons with discount_type parameter

  wp wc generate coupons 5 --discount_type=percent --min=5 --max=25
  # Check: all 5 coupons should be percentage type with 5-25% discount

• BULK DELETE all coupons with WP Admin interface /wp-admin/edit.php?post_type=shop_coupon

• Test creating fixed_cart coupons with discount_type parameter

  wp wc generate coupons 5 --discount_type=fixed_cart --min=10 --max=50
  # Check: all 5 coupons should be fixed_cart type with $10-$50 discount

• BULK DELETE all coupons with WP Admin interface /wp-admin/edit.php?post_type=shop_coupon

• Verify default behavior without discount_type (should be fixed_cart)

  wp wc generate coupons 5
  # Check: coupons should default to fixed_cart type

Integration Tests

• BULK DELETE all orders with WP Admin interface /wp-admin/admin.php?page=wc-orders
• Test combined coupon-ratio and refund-ratio

  wp wc generate orders 20 --status=completed --coupon-ratio=0.5 --refund-ratio=0.3
  # Check: ~10 orders with coupons, ~6 orders with refunds

[Copilot]

Pull Request Overview

This PR enhances the order generator with two new parameters for creating more realistic test data: --coupon-ratio and --refund-ratio. These allow users to specify the percentage of orders that should have coupons applied and the percentage of completed orders that should be refunded, respectively.

Key Changes:

• Added --coupon-ratio parameter to control coupon application percentage with automatic coupon creation when none exist
• Added --refund-ratio parameter to generate full or partial refunds on completed orders
• Implemented automatic creation of 6 coupons (3 fixed, 3 percentage) when the store has no existing coupons

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
includes/Generator/Order.php	Implements coupon ratio logic, refund creation functionality, and helper methods for managing coupons and refunds
includes/CLI.php	Adds command-line parameter definitions for --coupon-ratio and --refund-ratio

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[chihsuan]

Nice wprk, @layoutd!

Test refund-ratio=0.5 refunds approximately 50% of orders

wp wc generate orders 20 --status=completed --refund-ratio=0.5
# Check: about 10 orders should have refunds (strikeout prices in orders table)

I noticed that only one refund is listed in the orders table, but several orders have a total amount of 0. Is this expected?

[layoutd]

I noticed that only one refund is listed in the orders table, but several orders have a total amount of 0. Is this expected?

This may be due to a lack of products in the store - afaics, they aren't automatically generated so you have to run wp wc generate products 20 first