Test Harness

Overview

Flux includes a comprehensive end-to-end test harness that validates sync and deployment operations against live Shopify APIs. The test harness runs real operations against real stores, ensuring that every supported object type works correctly in production conditions.

What it validates

The test harness validates that Flux correctly handles:

• Creating, updating, and deleting every supported object type through the sync and deployment pipeline
• Dependency ordering across object types (e.g., definitions before entries)
• Circular reference detection and multi-pass resolution
• Handle collisions and canonical mapping conflicts
• Cross-environment consistency (source state matches deployed target state)

How it works

The test harness is built on a layered architecture:

• Primitives — atomic operations (individual Shopify API calls for each object type: create, read, update, delete)
• Flows — compose primitives into higher-level workflows (e.g., a release flow chains create, freeze, and deploy into one reusable operation)
• Scenarios — the unit of testing, each defining a sequence of operations, expected outcomes, and verification steps

Scenarios cover the full surface area of Flux's capabilities across all supported object types.

Running tests

Scenarios can be filtered by:

• Collection name — run all scenarios in a category
• Tags — run scenarios matching specific tags
• Scenario ID — run a specific scenario by its identifier

Reporting

Test results include pass/fail status for each scenario, detailed execution logs with the full operation sequence, and formatted reports for review.

Next steps

• Read about the architecture underpinning the test harness
• Learn about deployments and how changes are applied