spawnia/phpunit-assert-directory

PHPUnit extension with assert methods for directories

v2.2.0 2024-04-26 09:46 UTC

Requires

• php: ^7.3 || ^8
• phpunit/phpunit: ^8 || ^9 || ^10 || ^11
• thecodingmachine/safe: ^1.3.3 || ^2

Requires (Dev)

• ergebnis/composer-normalize: ^2.5
• mll-lab/php-cs-fixer-config: ^4 || ^5
• phpstan/extension-installer: ^1
• phpstan/phpstan: ^1
• phpstan/phpstan-deprecation-rules: ^1
• phpstan/phpstan-strict-rules: ^1
• thecodingmachine/phpstan-safe-rule: ^1

MIT

• Benedikt Franke

README

PHPUnit extension with assert methods for directories

Installation

Install through composer.

composer require --dev spawnia/phpunit-assert-directory

Usage

Use the trait AssertDirectory in your test method.

namespace Foo\Tests;

use PHPUnit\Framework\TestCase;
+use Spawnia\PHPUnitAssertFiles\AssertDirectory;

final class FooTest extends TestCase
{
+   use AssertDirectory;
}

You can then proceed the use the additional assertions just like you would use PHPUnit's built-in methods, such as assertSame.

assertDirectoryEquals

/**
 * Assert that two directories contain the same files with the same contents.
 *
 * @param  string  $expected Path to the expected directory
 * @param  string  $actual Path to the actual directory
 * @param  string  $message Optional error message in case of failure
 *
 * @throws ExpectationFailedException
 */
public static function assertDirectoryEquals(string $expected, string $actual, string $message = ''): void

assertDirectoryContains

/**
 * Assert a directory contains at least the same files as another directory.
 *
 * @param  string  $expected Path to the expected directory
 * @param  string  $actual Path to the actual directory
 * @param  string  $message Optional error message in case of failure
 * @return void
 *
 * @throws ExpectationFailedException
 */
public static function assertDirectoryContains(string $expected, string $actual, string $message = ''): void

Changelog

See CHANGELOG.md.

Contributing

See CONTRIBUTING.md.

License

This package is licensed using the MIT License.