Phpunit Extras Laravel Package

Product Decisions This Supports

• Faster Time-to-Market for Tarantool Features: Reduces test development time for PHP applications interacting with Tarantool by providing specialized annotations, expectations, and mocking utilities. This directly supports sprints focused on database-driven features (e.g., caching layers, real-time data processing).
• Risk Mitigation for Database Integrations: Enables comprehensive testing of Tarantool-specific edge cases (e.g., Lua/SQL execution, version compatibility) to prevent production incidents tied to database interactions. Critical for teams adopting Tarantool as a primary or secondary data store.
• Build vs. Buy Decision: Justifies using this package over custom test utilities by offering maintained, Tarantool-optimized assertions (e.g., request mocking, prepared statement validation) that align with the Tarantool PHP client ecosystem. Avoids technical debt from reinventing wheel for niche use cases.
• Key Use Cases:
  • API Backends: Validate Tarantool-backed endpoints (e.g., EVALUATE requests, space operations) with minimal boilerplate.
  • Data Pipeline Testing: Simulate Tarantool responses for ETL jobs or migration scripts to catch SQL/Lua errors early.
  • Performance Testing: Mock Tarantool latency or failures to stress-test resilience without impacting production instances.
  • Multi-Version Support: Test compatibility across Tarantool versions (e.g., 1.x vs. 2.x) using @requires Tarantool ^2.3.2 annotations.
  • Security Audits: Verify Lua/SQL injection safeguards by testing malformed requests via mock clients.

When to Consider This Package

• Adopt if:
  • Your PHP application directly interacts with Tarantool (e.g., via the official client) for core functionality (data storage, caching, or real-time sync).
  • You need to test Tarantool-specific logic (e.g., Lua scripts, SQL queries, prepared statements) without spinning up a real instance for every test.
  • Your team values developer productivity over minimal test setup, as annotations (e.g., @lua, @sql) reduce repetitive code for common scenarios.
  • You require conditional test execution (e.g., skip tests if Tarantool version is unsupported or a Lua condition fails).
  • Your CI/CD pipeline can tolerate dev dependencies (this package is require-dev only).
• Look elsewhere if:
  • You’re not using Tarantool—this package is tightly coupled to its ecosystem (e.g., no support for Redis, PostgreSQL, or other databases).
  • Your tests are trivial (e.g., basic HTTP assertions) and don’t involve Tarantool-specific interactions.
  • You prefer zero-configuration testing and are unwilling to extend TestCase or configure PHPUnit extensions.
  • Your project uses PHP < 7.2 (minimum supported version) or Tarantool < 1.10 (implicit dependency).
  • You need enterprise-grade support—this package has low adoption (2 stars, 0 dependents) and last release was in 2022.
  • Your team lacks familiarity with PHPUnit extensions or Tarantool’s Lua/SQL syntax.

How to Pitch It (Stakeholders)

For Executives: "This package lets our PHP team test Tarantool integrations faster and more reliably. By using specialized annotations (e.g., @lua, @sql) and mock clients, we can validate database logic—like caching layers or real-time queries—without spinning up expensive Tarantool instances for every test. This reduces bugs in production and accelerates feature delivery for data-heavy use cases, like our [X feature] roadmap. The MIT license and low maintenance overhead make it a safe bet."

For Engineering/DevOps: *"This gives us Tarantool-specific superpowers in PHPUnit:

• Mock Tarantool responses to test error handling or edge cases without a real server.
• Annotations like @lua and @sql to set up test data or preconditions in one line (e.g., @sql INSERT INTO users VALUES (1, 'admin')).
• Version-aware tests with @requires Tarantool ^2.3.2 to catch compatibility issues early. It’s a drop-in for teams already using the Tarantool PHP client. Tradeoff: slight PHPUnit config overhead, but massive payoff for complex database interactions."*

For QA/Testing Teams: *"This package cuts test development time for Tarantool by:

1. Automating setup/teardown (e.g., @sql DROP TABLE IF EXISTS...) so you don’t repeat SQL/Lua in every test.
2. Validating request patterns (e.g., expectSelectRequestToBeCalledOnce()) to ensure your PHP code interacts with Tarantool as expected.
3. Isolating tests with mock clients to avoid flaky tests from network issues or shared Tarantool instances. Perfect for validating APIs, migrations, or performance scenarios where Tarantool is critical."*