Weave Code
Smoke Tests Playground Laravel Package
controleonline/smoke-tests-playground
Symfony bundle for exposing browser smoke test indexes and artifacts as JSON APIs in ControleOnline projects.
Frequently asked questions about Smoke Tests Playground
- How do I install and run smoke tests in a Laravel project?
- Install via Composer with `composer require controleonline/smoke-tests-playground`, then manually bootstrap the test runner. Since it lacks Laravel-specific integrations, you’ll need to configure HTTP requests (e.g., Guzzle) and define test cases in an array format. No Artisan commands or ServiceProvider are included, so setup is minimal but requires custom code.
- Does this package support Laravel’s testing helpers like `actingAs()` or `followRedirects()`?
- No, this package doesn’t integrate with Laravel’s testing helpers. You’ll need to handle authentication and redirects manually using HTTP clients like Guzzle or Symfony’s BrowserKit. For auth checks, mock responses or use Laravel’s native `Http::actingAs()` outside the smoke test runner.
- What Laravel versions does this package support?
- The package likely works with Laravel 8+ due to PHP 8.0+ requirements, but it’s not officially Laravel-first. Test compatibility by checking the `composer.json` dependencies and PHP version constraints. For older Laravel versions, you may need to adjust HTTP client configurations manually.
- Can I use this for CI/CD pipelines like GitHub Actions?
- Yes, it’s ideal for CI/CD pipelines due to its lightweight nature. Add a script to your workflow to run the smoke tests before deployment, treating failures as critical blocks. Use containerized environments (Docker) to ensure consistent test execution across pipelines.
- How do I define test cases for endpoints or API routes?
- Test cases are defined as an array where keys are URLs and values are expected responses (e.g., HTTP status codes). For example, `['/health' => 200]` checks if the endpoint returns a success. You’ll need to pass this array to the runner’s `run()` method, often with a custom HTTP client.
- Is this package maintained, or should I look for alternatives?
- The package appears abandoned (no recent commits, 0 stars), so evaluate alternatives like Laravel Dusk (for browser tests) or Pest (for feature/unit tests). If you proceed, fork the repo to ensure future updates or supplement it with custom scripts for critical functionality.
- Can I run these tests in parallel or asynchronously?
- No, this package doesn’t support parallel or async testing. For parallel execution, consider Laravel’s built-in `php artisan test --parallel` or Pest’s parallel flag. If async is needed, combine this with queue workers or external tools like PHP-PM.
- How do I handle database interactions or API dependencies in smoke tests?
- Since smoke tests focus on high-level validation, avoid real databases/APIs. Use mock responses (e.g., Guzzle middleware) or Laravel’s `Http::fake()` to simulate dependencies. For staging-like tests, deploy to a separate environment or use Docker to isolate test data.
- Will this work with Laravel’s test environment or do I need a separate setup?
- The package doesn’t leverage Laravel’s test environment, so you’ll need a separate setup (e.g., a dedicated test server or Docker container). Configure your HTTP client to target the test environment or a staging-like URL to avoid production data leaks.
- Are there any known performance bottlenecks or flaky test risks?
- Flaky tests are a risk if shared state (e.g., sessions, caches) isn’t reset between runs. Use containerized environments to ensure clean test execution. For performance, avoid heavy payloads—smoke tests should be fast (under 1 minute) to fit CI/CD pipelines. Monitor test duration in your pipeline logs.
Weaver
How can I help you explore Laravel packages today?