Skip to content

test.md

Latest commit

 

History

History
590 lines (452 loc) · 19.3 KB

test.md

File metadata and controls

590 lines (452 loc) · 19.3 KB
Raw

Missing Tests for OrderTracking Smart Contract

This document outlines all the tests that have not been written for the OrderTracking smart contract. The current test file (OrderTracking.test.ts) is being updated to provide comprehensive coverage for the current implementation.

Contract Overview

The current OrderTracking.sol contract includes:

  • Payment escrow system with platform fees
  • Order lifecycle management (Pending → Confirmed → Processing → Shipped → Delivered)
  • Dispute resolution system
  • Automatic payment release on delivery
  • Automatic refund on cancellation
  • Admin functions for fee and configuration management
  • Multi-currency support (native ETH)
  • Network identifier and metadata hash support

1. Constructor Tests ✅ COMPLETED

Completed Tests:

  • Should deploy with correct platform fee and minimum order value

    • ✅ Test that constructor sets platformFeeBps correctly
    • ✅ Test that constructor sets minOrderValue correctly
    • ✅ Test that constructor sets owner to deployer address
    • ✅ Test that totalOrders starts at 0

  • Should handle edge cases in constructor

    • ✅ Test with platform fee of 0 (0%)
    • ✅ Test with platform fee of 1000 (10% - maximum)
    • ✅ Test with minimum order value of 0
    • ✅ Test with minimum order value of 1 wei

2. Order Creation Tests (createOrder) ✅ COMPLETED

Completed Tests:

  • Should create order with payment and deduct platform fee

    • ✅ Test that payment is held in escrow
    • ✅ Test that platform fee is transferred to owner
    • ✅ Test that seller amount is calculated correctly (price - fee)
    • ✅ Test that contract balance increases by order price
    • ✅ Test that owner receives platform fee

  • Should create order with all parameters

    • ✅ Test with product name, description, quantity
    • ✅ Test with currency address (address(0) for native ETH)
    • ✅ Test with estimated delivery timestamp
    • ✅ Test with network identifier
    • ✅ Test with metadata hash (IPFS hash)
    • ✅ Test that order number is generated correctly (ORD-{id})

  • Should validate order creation requirements

    • ✅ Test that order value must be >= minOrderValue
    • ✅ Test that quantity must be > 0
    • ✅ Test that product name cannot be empty
    • ✅ Test that network identifier cannot be empty
    • ✅ Test that seller cannot be zero address
    • ✅ Test that seller cannot be the same as buyer

  • Should emit OrderCreated event with correct parameters

    • ✅ Test event emission with all order details
    • ✅ Test indexed parameters (orderId, buyer, seller)
    • ✅ Test non-indexed parameters (orderNumber, price, currency)

  • Should track orders correctly

    • ✅ Test that order is added to buyerOrders mapping
    • ✅ Test that order is added to sellerOrders mapping
    • ✅ Test that totalOrders increments correctly
    • ✅ Test that order ID is assigned sequentially

  • Should set order timestamps correctly

    • ✅ Test that createdAt is set to block.timestamp
    • ✅ Test that updatedAt is set to block.timestamp
    • ✅ Test that transactionHash is generated correctly

  • Should handle edge cases

    • ✅ Test with very large order value
    • ✅ Test with maximum platform fee (10%)
    • ✅ Test with empty product description
    • ✅ Test with empty metadata hash
    • ✅ Test with estimated delivery of 0

3. Order Confirmation Tests (confirmOrder) ✅ COMPLETED

Completed Tests:

  • Should confirm order (seller only)

    • ✅ Test that seller can confirm pending order
    • ✅ Test that status changes from Pending to Confirmed
    • ✅ Test that updatedAt timestamp is updated
    • ✅ Test that OrderStatusUpdated event is emitted

  • Should enforce authorization

    • ✅ Test that buyer cannot confirm order
    • ✅ Test that non-participant cannot confirm order
    • ✅ Test that only seller can confirm

  • Should enforce status requirements

    • ✅ Test that order must be in Pending status
    • ✅ Test that confirmed order cannot be confirmed again
    • ✅ Test that order must exist

  • Should emit correct events

    • ✅ Test OrderStatusUpdated event with oldStatus = Pending, newStatus = Confirmed

4. Order Status Update Tests (updateOrderStatus)

Missing Tests:

  • Should update order status with valid transitions

    • Test Pending → Confirmed
    • Test Pending → Cancelled
    • Test Pending → Disputed
    • Test Confirmed → Processing
    • Test Confirmed → Cancelled
    • Test Confirmed → Disputed
    • Test Processing → Shipped
    • Test Processing → Disputed
    • Test Shipped → Delivered
    • Test Shipped → Disputed
    • Test Disputed → Confirmed
    • Test Disputed → Cancelled
    • Test Disputed → Delivered

  • Should reject invalid status transitions

    • Test that Delivered cannot transition to any other status
    • Test that Cancelled cannot transition to any other status
    • Test that invalid transitions are rejected

  • Should enforce authorization

    • Test that only buyer or seller can update status
    • Test that non-participant cannot update status

  • Should handle payment release on delivery

    • Test that marking order as Delivered releases payment to seller
    • Test that only buyer can mark as Delivered
    • Test that seller receives full order price (after fee deduction)
    • Test that contract balance decreases by order price
    • Test that payment release fails if insufficient contract balance

  • Should handle refund on cancellation

    • Test that cancelling order refunds payment to buyer
    • Test that buyer receives full order price
    • Test that contract balance decreases by order price
    • Test that refund fails if insufficient contract balance

  • Should update timestamps

    • Test that updatedAt is updated on status change

  • Should emit events

    • Test OrderStatusUpdated event emission with correct parameters

5. Mark as Processing Tests (markAsProcessing)

Missing Tests:

  • Should mark order as processing (seller only)

    • Test that seller can mark confirmed order as processing
    • Test that status changes from Confirmed to Processing
    • Test that updatedAt timestamp is updated

  • Should enforce authorization

    • Test that only seller can mark as processing
    • Test that buyer cannot mark as processing
    • Test that non-participant cannot mark as processing

  • Should enforce status requirements

    • Test that order must be in Confirmed status
    • Test that order must exist

  • Should emit events

    • Test OrderStatusUpdated event emission

6. Mark as Shipped Tests (markAsShipped)

Missing Tests:

  • Should mark order as shipped (seller only)

    • Test that seller can mark processing order as shipped
    • Test that status changes from Processing to Shipped
    • Test that updatedAt timestamp is updated

  • Should enforce authorization

    • Test that only seller can mark as shipped
    • Test that buyer cannot mark as shipped
    • Test that non-participant cannot mark as shipped

  • Should enforce status requirements

    • Test that order must be in Processing status
    • Test that order must exist

  • Should emit events

    • Test OrderStatusUpdated event emission

7. Add Tracking Number Tests (addTrackingNumber)

Missing Tests:

  • Should add tracking number (seller only)

    • Test that seller can add tracking number
    • Test that tracking number is stored correctly
    • Test that updatedAt timestamp is updated

  • Should enforce authorization

    • Test that only seller can add tracking number
    • Test that buyer cannot add tracking number
    • Test that non-participant cannot add tracking number

  • Should enforce status requirements

    • Test that tracking can only be added when status is Processing
    • Test that tracking can only be added when status is Shipped
    • Test that tracking cannot be added in other statuses

  • Should emit events

    • Test TrackingNumberAdded event emission with correct orderId and trackingNumber

  • Should handle edge cases

    • Test with empty tracking number (should this be allowed?)
    • Test with very long tracking number

8. Dispute Order Tests (disputeOrder)

Missing Tests:

  • Should dispute order

    • Test that buyer can dispute order
    • Test that seller can dispute order
    • Test that status changes to Disputed
    • Test that reason is stored/emitted
    • Test that updatedAt timestamp is updated

  • Should enforce authorization

    • Test that only buyer or seller can dispute
    • Test that non-participant cannot dispute

  • Should enforce status requirements

    • Test that Delivered orders cannot be disputed
    • Test that Cancelled orders cannot be disputed
    • Test that already Disputed orders cannot be disputed again
    • Test that order can be disputed from Pending, Confirmed, Processing, or Shipped

  • Should emit events

    • Test OrderDisputed event emission with orderId, disputer, and reason
    • Test OrderStatusUpdated event emission

  • Should handle edge cases

    • Test with empty reason string
    • Test with very long reason string

9. Cancel Order Tests (cancelOrder)

Missing Tests:

  • Should cancel order

    • Test that buyer can cancel order
    • Test that seller can cancel order
    • Test that status changes to Cancelled
    • Test that reason is emitted
    • Test that updatedAt timestamp is updated

  • Should refund payment on cancellation

    • Test that buyer receives full refund
    • Test that contract balance decreases by order price
    • Test that refund happens automatically

  • Should enforce authorization

    • Test that only buyer or seller can cancel
    • Test that non-participant cannot cancel

  • Should enforce status requirements

    • Test that order can only be cancelled from Pending status
    • Test that order can only be cancelled from Confirmed status
    • Test that Processing orders cannot be cancelled
    • Test that Shipped orders cannot be cancelled
    • Test that Delivered orders cannot be cancelled
    • Test that already Cancelled orders cannot be cancelled again

  • Should emit events

    • Test OrderCancelled event emission with orderId, cancelledBy, and reason
    • Test OrderStatusUpdated event emission

  • Should handle edge cases

    • Test with empty reason string
    • Test refund when contract has insufficient balance (should revert)

10. View Functions Tests

getOrder Tests:

  • Should return order details
    • Test that all order fields are returned correctly
    • Test that non-existent order reverts

getBuyerOrders Tests:

  • Should return all orders for a buyer
    • Test that buyer's orders are returned correctly
    • Test that orders are returned in correct order
    • Test that empty array is returned for buyer with no orders
    • Test that multiple buyers' orders don't interfere

getSellerOrders Tests:

  • Should return all orders for a seller
    • Test that seller's orders are returned correctly
    • Test that orders are returned in correct order
    • Test that empty array is returned for seller with no orders
    • Test that multiple sellers' orders don't interfere

getOrders Tests (Batch):

  • Should return multiple orders by IDs
    • Test that multiple orders are returned correctly
    • Test that non-existent order IDs return empty Order struct (id = 0)
    • Test with empty array
    • Test with large array of order IDs
    • Test that order data matches individual getOrder calls

totalOrders Tests:

  • Should return total number of orders
    • Test that totalOrders increments with each order
    • Test that totalOrders matches actual order count

11. Admin Functions Tests

setPlatformFee Tests:

  • Should update platform fee (owner only)

    • Test that owner can update platform fee
    • Test that new fee is set correctly
    • Test that PlatformFeeUpdated event is emitted with old and new fee

  • Should enforce authorization

    • Test that non-owner cannot update platform fee
    • Test that only owner can update

  • Should enforce limits

    • Test that fee cannot exceed 1000 (10%)
    • Test that fee can be set to 0
    • Test that fee can be set to maximum (1000)

  • Should affect new orders only

    • Test that existing orders use old fee
    • Test that new orders use new fee

setMinOrderValue Tests:

  • Should update minimum order value (owner only)

    • Test that owner can update minimum order value
    • Test that new value is set correctly
    • Test that MinOrderValueUpdated event is emitted

  • Should enforce authorization

    • Test that non-owner cannot update minimum order value

  • Should affect new orders

    • Test that orders below new minimum are rejected
    • Test that orders at or above new minimum are accepted

transferOwnership Tests:

  • Should transfer ownership (owner only)

    • Test that owner can transfer ownership
    • Test that new owner is set correctly
    • Test that old owner loses access

  • Should enforce authorization

    • Test that non-owner cannot transfer ownership

  • Should validate new owner

    • Test that new owner cannot be zero address
    • Test that new owner can perform admin functions

12. Payment and Escrow Tests

Payment Escrow Tests:

  • Should hold payment in escrow
    • Test that payment is held in contract
    • Test that contract balance increases on order creation
    • Test that platform fee is deducted and sent to owner
    • Test that remaining amount stays in contract

Payment Release Tests:

  • Should release payment on delivery
    • Test that seller receives payment when order is marked as Delivered
    • Test that payment amount is correct (full order price)
    • Test that contract balance decreases
    • Test that only buyer can trigger delivery

Refund Tests:

  • Should refund payment on cancellation
    • Test that buyer receives refund when order is cancelled
    • Test that refund amount is correct (full order price)
    • Test that contract balance decreases
    • Test that platform fee is not refunded (already sent to owner)

Edge Cases:

  • Should handle insufficient balance scenarios
    • Test that payment release fails if contract has insufficient balance
    • Test that refund fails if contract has insufficient balance
    • Test error messages for insufficient balance

13. Status Transition Validation Tests

Missing Tests:

  • Should validate all status transitions
    • Test _isValidStatusTransition internal function logic
    • Test that terminal states (Delivered, Cancelled) cannot transition
    • Test that Disputed can transition to multiple states
    • Test all valid transition paths
    • Test all invalid transition paths

14. Modifier Tests

onlyOwner Modifier:

  • Should restrict to owner only
    • Test that owner can call admin functions
    • Test that non-owner cannot call admin functions

orderExists Modifier:

  • Should check order existence
    • Test that functions revert for non-existent orders
    • Test that functions work for existing orders

onlyOrderParty Modifier:

  • Should restrict to buyer or seller
    • Test that buyer can call restricted functions
    • Test that seller can call restricted functions
    • Test that non-participant cannot call restricted functions

validOrderStatus Modifier:

  • Should validate order status
    • Test that functions work when order is in required status
    • Test that functions revert when order is in wrong status

15. Event Tests

Missing Event Tests:

  • OrderCreated event

    • Test all event parameters
    • Test indexed vs non-indexed parameters

  • OrderStatusUpdated event

    • Test oldStatus and newStatus values
    • Test updatedBy address

  • TrackingNumberAdded event

    • Test orderId and trackingNumber

  • OrderDisputed event

    • Test orderId, disputer, and reason

  • OrderCancelled event

    • Test orderId, cancelledBy, and reason

  • PlatformFeeUpdated event

    • Test oldFee and newFee values

  • MinOrderValueUpdated event

    • Test oldValue and newValue

16. Edge Cases and Error Handling

Missing Tests:

  • Should handle zero values correctly

    • Test with zero quantity (should revert)
    • Test with zero price (should revert if below minOrderValue)
    • Test with zero estimated delivery (should be allowed)

  • Should handle maximum values

    • Test with very large order values
    • Test with maximum uint256 values

  • Should handle string parameters

    • Test with empty strings where not allowed
    • Test with very long strings
    • Test with special characters

  • Should handle reentrancy

    • Test that contract is safe from reentrancy attacks
    • Test payment release reentrancy
    • Test refund reentrancy

  • Should handle gas optimization

    • Test that batch operations are efficient
    • Test that view functions are gas-efficient

17. Integration Tests

Missing Tests:

  • Complete order lifecycle

    • Test full flow: Create → Confirm → Processing → Shipped → Delivered
    • Test payment flow through entire lifecycle
    • Test that all events are emitted correctly

  • Cancellation flow

    • Test: Create → Cancel
    • Test: Create → Confirm → Cancel
    • Test that refund happens correctly

  • Dispute flow

    • Test: Create → Confirm → Dispute
    • Test: Create → Processing → Dispute
    • Test: Create → Shipped → Dispute
    • Test dispute resolution paths

  • Multiple orders

    • Test creating multiple orders from same buyer
    • Test creating multiple orders for same seller
    • Test that orders don't interfere with each other

18. Frontend Integration Points

Based on frontend code analysis, these contract functions are used but not fully tested:

  • confirmOrder - Used in useConfirmOrder hook
  • markAsProcessing - Used in status updates
  • markAsShipped - Used in status updates
  • disputeOrder - Used in useDisputeOrder hook
  • updateOrderStatus - Used in useUpdateOrderStatus hook
  • getBuyerOrders - Used to fetch buyer's orders
  • getSellerOrders - Used to fetch seller's orders
  • totalOrders - Used in useTotalOrders hook

Summary

Total Missing Test Categories: 18

Estimated Missing Test Cases: 150+

The current test file covers basic functionality but is missing:

  1. Payment escrow and fee handling
  2. Admin functions
  3. Status transition validation
  4. Payment release and refund mechanisms
  5. Dispute resolution
  6. Comprehensive edge cases
  7. Event testing
  8. Modifier testing
  9. Integration tests
  10. Frontend integration point tests

Recommendations

  1. Priority 1 (Critical):

    • Payment escrow and release tests
    • Refund mechanism tests
    • Admin function authorization tests
    • Status transition validation tests

  2. Priority 2 (Important):

    • All order lifecycle functions (confirmOrder, markAsProcessing, markAsShipped)
    • Dispute resolution tests
    • View function tests
    • Event emission tests

  3. Priority 3 (Nice to have):

    • Edge cases
    • Gas optimization tests
    • Integration tests
    • Reentrancy tests

Note: The current test file appears to test an older version of the contract. Consider updating it to match the current contract implementation in contracts/contracts/OrderTracking.sol.