illuminated/testing-tools

Laravel-specific Testing Helpers and Assertions.

10.0.0 2024-03-06 15:32 UTC

Requires

• php: ^8.1
• illuminate/database: ^10.0
• illuminate/support: ^10.0
• mockery/mockery: ^1.5.1

Requires (Dev)

• orchestra/testbench: ^8.0
• phpunit/phpunit: ^10.5

MIT

• Dmitry Ivanov

• helpers
• testing
• tools
• laravel
• assertions
• assertion-methods
• assertion-functions

README

Laravel Testing Tools

Laravel-specific Testing Helpers and Assertions.

Laravel	Testing Tools
11.x	Support ☕
10.x	10.x
9.x	9.x
8.x	8.x
7.x	7.x
6.x	6.x
5.8.*	5.8.*
5.7.*	5.7.*
5.6.*	5.6.*
5.5.*	5.5.*
5.4.*	5.4.*
5.3.*	5.3.*
5.2.*	5.2.*
5.1.*	5.1.*

Usage

1. Install the package via Composer:

   composer require --dev illuminated/testing-tools

2. Use Illuminated\Testing\TestingTools trait:

   use Illuminated\Testing\TestingTools;
   
   abstract class TestCase extends Illuminate\Foundation\Testing\TestCase
   {
       use TestingTools;
   
       // ...
   }

3. Use any of the provided helpers and assertions in your tests:

   class ExampleTest extends TestCase
   {
       /** @test */
       public function it_has_lots_of_useful_assertions()
       {
           $this->assertDatabaseHasMany('posts', [
               ['title' => 'Awesome!'],
               ['title' => 'Check multiple rows'],
               ['title' => 'In one simple assertion 🤟'],
           ]);
       }
   }

Available helpers

Feel free to contribute.

• ApplicationHelpers
  • emulateLocal
  • emulateProduction
  • emulateEnvironment

Available assertions

Feel free to contribute.

• CollectionAsserts
  • assertCollectionsEqual
  • assertCollectionsNotEqual
• DatabaseAsserts
  • assertDatabaseHasTable
  • assertDatabaseMissingTable
  • assertDatabaseHasMany
  • assertDatabaseMissingMany
• FilesystemAsserts
  • assertDirectoryEmpty
  • assertDirectoryNotEmpty
  • assertFilesCount
  • assertNotFilesCount
• LogFileAsserts
  • seeLogFile
  • dontSeeLogFile
  • seeInLogFile
  • dontSeeInLogFile
• ScheduleAsserts
  • seeScheduleCount
  • dontSeeScheduleCount
  • seeInSchedule
  • dontSeeInSchedule

Helpers

ApplicationHelpers

emulateLocal()

Emulate that application is running on the local environment:

$this->emulateLocal();

emulateProduction()

Emulate that application is running on the production environment:

$this->emulateProduction();

emulateEnvironment()

Emulate that application is running on the given environment:

$this->emulateEnvironment('demo');

Assertions

CollectionAsserts

assertCollectionsEqual()

Assert that the given collections are equal based on the specified key:

$this->assertCollectionsEqual($collection1, $collection2, 'id');

assertCollectionsNotEqual()

Assert that the given collections are not equal based on the specified key:

$this->assertCollectionsNotEqual($collection1, $collection2, 'id');

DatabaseAsserts

assertDatabaseHasTable()

Assert that the database has the given table:

$this->assertDatabaseHasTable('users');

assertDatabaseMissingTable()

Assert that the database doesn't have the given table:

$this->assertDatabaseMissingTable('unicorns');

assertDatabaseHasMany()

Assert that the database has all the given rows:

$this->assertDatabaseHasMany('posts', [
    ['title' => 'First Post'],
    ['title' => 'Second Post'],
    ['title' => 'Third Post'],
]);

assertDatabaseMissingMany()

Assert that the database doesn't have all the given rows:

$this->assertDatabaseMissingMany('posts', [
    ['title' => 'Fourth Post'],
    ['title' => 'Fifth Post'],
]);

FilesystemAsserts

assertDirectoryEmpty()

Assert that the given directory is empty:

$this->assertDirectoryEmpty('./my/dir/');

assertDirectoryNotEmpty()

Assert that the given directory is not empty:

$this->assertDirectoryNotEmpty('./my/dir/');

assertFilesCount()

Assert that directory has the given number of files:

$this->assertFilesCount('./my/dir/', 3);

assertNotFilesCount()

Assert that directory doesn't have the given number of files:

$this->assertNotFilesCount('./my/dir/', 5);

LogFileAsserts

seeLogFile()

Assert that the given log file exists.

The path is relative to the storage/logs folder:

$this->seeLogFile('example.log');

dontSeeLogFile()

Assert that the given log file doesn't exist.

The path is relative to the storage/logs folder:

$this->dontSeeLogFile('foobarbaz.log');

seeInLogFile()

Assert that the log file contains the given message.

The path is relative to the storage/logs folder:

$this->seeInLogFile('example.log', 'Sample log message!');

Also, you can specify an array of messages:

$this->seeInLogFile('example.log', [
    'Sample log message 1!',
    'Sample log message 2!',
    'Sample log message 3!',
]);

You can use these placeholders in messages:

• %datetime% - any datetime string.

$this->seeInLogFile('example.log', '[%datetime%]: Sample log message!');

dontSeeInLogFile()

Assert that the log file doesn't contain the given message.

The path is relative to the storage/logs folder:

$this->dontSeeInLogFile('example.log', 'Non-existing log message!');

Also, you can specify an array of messages:

$this->dontSeeInLogFile('example.log', [
    'Non-existing log message 1!',
    'Non-existing log message 2!',
    'Non-existing log message 3!',
]);

ScheduleAsserts

seeScheduleCount()

Assert that schedule count equals to the given value:

$this->seeScheduleCount(3);

dontSeeScheduleCount()

Assert that schedule count doesn't equal to the given value:

$this->dontSeeScheduleCount(5);

seeInSchedule()

Assert that the given command is scheduled:

$this->seeInSchedule('foo', 'everyFiveMinutes');
$this->seeInSchedule('bar', 'hourly');
$this->seeInSchedule('baz', 'twiceDaily');

Also, you can use cron expressions:

$this->seeInSchedule('foo', '*/5 * * * * *');
$this->seeInSchedule('bar', '0 * * * * *');
$this->seeInSchedule('baz', '0 1,13 * * * *');

dontSeeInSchedule()

Assert that the given command is not scheduled:

$this->dontSeeInSchedule('foobarbaz');

Sponsors

License

Laravel Testing Tools is open-sourced software licensed under the MIT license.