mabadir/laravel-cypress

Library to bootstrap Cypress testing in Laravel

dev-master 2021-04-06 01:45 UTC

Requires (Dev)

• orchestra/testbench: ^4.0
• phpunit/phpunit: ^9.0

MIT

• Mina Abadir

README

Easily Bootstrap your Laravel application with Cypress helpers to get you up and running with Cypress testing quickly.

Documentation

Install

You can install this package through composer. Make sure to request this package as Dev Dependency only, to avoid any potential security risks.

composer require mabadir/laravel-cypress --dev

Then you need to publish the config file through:

php artisan vendor:publish

Configuration

1. First ensure you have configured the URL that you will use for your Cypress Acceptance testing. Usually this URL is something like acceptance.example.test. In your .env file add an entry:

   CYPRESS_URL=acceptance.example.test

2. This package supports swapping the Database on the fly in order to keep your local database clean from acceptance testing data. The database needs to be using the local database connection. Add this entry to .env:

   CYPRESS_DB=acceptance

3. Add Cypress commands to cypress/support/commands.js by running the command:

   php artisan cypress:publish

Usage

This package by default offers the following routes:

You can extend or override the built in routes, by creating a new routes file in your app routes/acceptance.php. Adding any routes to this file will make them available to your acceptance domain name only. All routes are prefixed by /__testing__/

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

License

The MIT License (MIT). Please see License File for more information.