2022-08-12 10:00:26 -07:00
# Using the Test Suite
This document is targeted at developers looking to make modifications to
this application's code base and want to run the existing test suite.
## Setup
Follow the instructions for installing the application locally,
making sure to have also run the [database migrations ](link to db migrations ).
## Unit Tests
The application will use values in the `.env.testing` file located
in the root directory to override the
default settings and/or other values that exist in your `.env` files.
Make sure to modify the section in `.env.testing` that has the
database settings. In the example below, it is connecting to the
[MariaDB ](link-to-maria-db ) server that is used if you install the
application using [Docker ](https://docker.com ).
```dotenv
# --------------------------------------------
# REQUIRED: DATABASE SETTINGS
# --------------------------------------------
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_DATABASE=snipeit
DB_USERNAME=root
DB_PASSWORD=changeme1234
```
To run the entire unit test suite, use the following command from your terminal:
`php artisan test --env=testing`
To run individual test files, you can pass the path to the test that
you want to run.
`php artisan test --env=testing tests/Unit/AccessoryTest.php`
## Browser Tests
2023-01-11 13:51:01 -08:00
Browser tests are run via [Laravel Dusk ](https://laravel.com/docs/8.x/dusk ) and require Google Chrome to be installed.
Before attempting to run Dusk tests copy the example environment file for Dusk and update the values to match your environment:
`cp .env.dusk.example .env.dusk.local`
> `local` refers to the value of `APP_ENV` in your `.env` so if you have it set to `dev` then the file should be named `.env.dusk.dev`.
2022-08-12 10:00:26 -07:00
2023-01-11 18:05:07 -08:00
**Important**: Dusk tests cannot be run using an in-memory SQLite database. Additionally, the Dusk test suite uses the `DatabaseMigrations` trait which will leave the database in a fresh state after running. Therefore, it is recommended that you create a test database and point `DB_DATABASE` in `.env.dusk.local` to it.
2022-08-26 10:55:12 -07:00
### Test Setup
2023-01-11 13:51:01 -08:00
Your application needs to be configured and up and running in order for the browser
2022-08-26 10:55:12 -07:00
tests to actually run. When running the tests locally, you can start the application
using the following command:
`php artisan serve`
2023-01-11 13:51:01 -08:00
Now you are ready to run the test suite. Use the following command from another terminal tab or window:
2022-08-12 10:00:26 -07:00
`php artisan dusk`
2023-01-11 13:51:01 -08:00
To run individual test files, you can pass the path to the test that you want to run:
2022-08-12 10:00:26 -07:00
2022-08-26 10:55:12 -07:00
`php artisan dusk tests/Browser/LoginTest.php`
2023-01-11 13:54:28 -08:00
If you get an error when attempting to run Dusk tests that says `Couldn't connect to server` run:
`php artisan dusk:chrome-driver --detect`
This command will install the specific ChromeDriver Dusk needs for your operating system and Chrome version.