Testing with Pest is an absolute pleasure, but sometimes you just need that little bit extra. In my case, that extra was a set of expectations and functions to interact with the filesystem and make assertions on it. Below I made a list with all the helpers currently available. Enjoy!
Important
This package will only work for Pest V1 and not for Pest V2.
- Expectations
- Higher-order expectations
- Functions
Test whether a file has certain contents:
file_put_contents(__DIR__ . '/tmp/fileA.php', 'I\'m a test file!');
file_put_contents(__DIR__ . '/tmp/fileB.php', 'I\'m a second test file!');
expect(__DIR__ . '/tmp/fileA.php')->toHaveContents('I\'m a test file!');
expect(__DIR__ . '/tmp/fileB.php')->not->toHaveContents('I\'m a test file!');Test whether a file exists:
expect(__DIR__ . '/tmp/fileA.php')->toExist();Test whether a file has a certain namespace (PHP-only):
expect(__DIR__ . '/tmp/fileA.php')->toHaveNamespace('App\Models');Make assertions on the contents of a file:
file_put_contents(__DIR__ . '/tmp/fileA.php', 'I\'m a test file!');
expect(__DIR__ . '/tmp/fileA.php')
->contents->toBe('I\'m a test file!')
->toContain('test file')
->not->toContain('Hello world');Completely remove a file or directory:
use function RalphJSmit\PestPluginFilesystem\rm;
rm(__DIR__ . '/tmp'); // Make sure that this file or directory doesn't exist
file_put_contents(__DIR__ . '/tmp/fileA.php', 'I\'m a test file!');
file_put_contents(__DIR__ . '/tmp/fileB.php', 'I\'m a second test file!');
// Other codeThis function recursively deletes a folder, including its contents. Internally this is used by the rm() function:
use function RalphJSmit\PestPluginFilesystem\rmdir_recursive;
rmdir_recursive(__DIR__ . '/tmp'); // Recursively remove this directoryGets the file contents of a certain file. Its simply a shorter wrapper for file_get_contents():
use function RalphJSmit\PestPluginFilesystem\contents;
expect(
contents(__DIR__ . '/tmp/fileA.php')
)->toBe(
contents(__DIR__ . '/tmp/fileB.php')
);Note that this helper will be added to another package soon and thus be removed here.
Expect a failed assertion. Helpful for testing your own custom Pest assertions:
use function RalphJSmit\PestPluginFilesystem\expectFailedAssertion;
expectFailedAssertion();
expect(true)->toBe(false);
// This test will pass// Somewhere
expect()->extend('toBeHello', function () {
return $this->toBe('Hello there');
});
// In your test
use function RalphJSmit\PestPluginFilesystem\expectFailedAssertion;
expect('Hello there')->toBeHello(); // This will pass
expectFailedAssertion();
expect('Bye')->toBeHello(); // This will pass
expectFailedAssertion();
expect('Hello there')->toBeHello(); // This will fail🐞 If you spot a bug, please submit a detailed issue and I'll try to fix it as soon as possible.
🔐 If you discover a vulnerability, please review our security policy.
🙌 If you want to contribute, please submit a pull request. All PRs will be fully credited. If you're unsure whether I'd accept your idea, feel free to contact me!
🙋♂️ Ralph J. Smit