splash / validator
Splash Modules & Connectors Validation Component
Requires
- php: ^7.4|^8.0
- phpunit/phpunit: ^8.0|^9.0
- splash/phpcore: ^3.0.x-dev
- webmozart/assert: ^1.0
Requires (Dev)
- ext-apcu: *
- badpixxel/php-sdk: ^2.0|^3.0
Suggests
None
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-09-11 10:35:08 UTC
README
Splash Validator
Conformance test suite of Splash Sync connectors.
The Validator drives a connector through the whole Splash contract — description, fields definition, listing, create, read, update, delete, primary keys, scopes — with generated fake data, both by calling the connector directly and through the SOAP protocol, and compares what the connector returns with what was written. It is the acceptance gate of every connector.
Install & run
Installed with the Toolkit (composer require --dev splash/toolkit), referenced from the
connector phpunit.xml.dist:
<testsuite name="Validator">
<directory>vendor/splash/validator/phpunit</directory>
</testsuite>
make test # in the Toolkit containers
php vendor/bin/phpunit --testsuite Validator --filter O06 # one test class
SPLASH_SEQUENCE="Acme - Sandbox" SPLASH_TYPES=Product php vendor/bin/phpunit --testsuite Validator
Documentation
- Overview — install, run, tests order, sequences / types / fields
- Configuration — constants, generator settings, per-field flags
- Test suite — data flow, generators & comparison rules, every test, reading a failure
- Extending — additional test classes, scope validators, writing strategies
AI coding agents: see llms.txt, and the splash-connector skill (splash/skills).
License
MIT - See LICENSE
