Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/astrotomic/phpunit-assertions
This package provides a set of common PHPUnit custom assertions.
https://github.com/astrotomic/phpunit-assertions
assertions phpunit phpunit-assertions testing
Last synced: 1 day ago
JSON representation
This package provides a set of common PHPUnit custom assertions.
- Host: GitHub
- URL: https://github.com/astrotomic/phpunit-assertions
- Owner: Astrotomic
- License: mit
- Created: 2021-01-13T09:06:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-18T16:14:17.000Z (8 months ago)
- Last Synced: 2024-04-14T10:15:57.436Z (5 months ago)
- Topics: assertions, phpunit, phpunit-assertions, testing
- Language: PHP
- Homepage:
- Size: 90.8 KB
- Stars: 18
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHPUnit Assertions
[](https://packagist.org/packages/astrotomic/phpunit-assertions)
[](https://github.com/Astrotomic/phpunit-assertions/blob/master/LICENSE)
[](https://forest.astrotomic.info)
[](https://larabelles.com)
[](https://github.com/Astrotomic/phpunit-assertions/actions?query=workflow%3Apest)
[](https://packagist.org/packages/astrotomic/phpunit-assertions)
[](https://forest.astrotomic.info)
[](https://forest.astrotomic.info)
This package provides a set of common [PHPUnit](https://phpunit.de/) custom assertions.
Some require optional packages - check the `composer.json[suggest]` section for more details.
## Installation
```bash
composer require --dev astrotomic/phpunit-assertions
```
## Usage
Even if all assertions are in `trait`s I highly recommend you to don't `use` these traits in your test classes.
Instead you can access all assertions as static methods on the traits.
```php
\Astrotomic\PhpunitAssertions\StringLengthAssertions::assertSame(10, 'Astrotomic');
```
This will prevent any method name conflicts with core, your custom or other trait assertions.
## Assertions
### Array
```php
\Astrotomic\PhpunitAssertions\ArrayAssertions::assertIndexed(['foo', 'bar']);
\Astrotomic\PhpunitAssertions\ArrayAssertions::assertAssociative(['foo' => 'bar']);
\Astrotomic\PhpunitAssertions\ArrayAssertions::assertEquals(['foo', 'bar'], ['bar', 'foo']);
\Astrotomic\PhpunitAssertions\ArrayAssertions::assertSubset(['foo' => 'bar'], ['baz' => 'foo', 'foo' => 'bar']);
\Astrotomic\PhpunitAssertions\ArrayAssertions::assertContainsAll(['foo', 'bar'], ['baz', 'foo', 'lorem', 'ipsum', 'bar']);
```
### Country
`composer require --dev league/iso3166:^3.0`
```php
\Astrotomic\PhpunitAssertions\CountryAssertions::assertName('Germany');
\Astrotomic\PhpunitAssertions\CountryAssertions::assertAlpha2('DE');
\Astrotomic\PhpunitAssertions\CountryAssertions::assertAlpha3('DEU');
\Astrotomic\PhpunitAssertions\CountryAssertions::assertNumeric('276');
```
### Email
`composer require --dev egulias/email-validator:^3.0`
```php
\Astrotomic\PhpunitAssertions\EmailAssertions::assertValidLoose('[email protected]');
\Astrotomic\PhpunitAssertions\EmailAssertions::assertValidStrict('[email protected]');
\Astrotomic\PhpunitAssertions\EmailAssertions::assertDomain('astrotomic.info', '[email protected]');
\Astrotomic\PhpunitAssertions\EmailAssertions::assertLocalPart('gummibeer', '[email protected]');
\Astrotomic\PhpunitAssertions\EmailAssertions::assertPlusMailbox('gummibeer', '[email protected]');
\Astrotomic\PhpunitAssertions\EmailAssertions::assertPlusAlias('news', '[email protected]');
```
### Geographic
```php
\Astrotomic\PhpunitAssertions\GeographicAssertions::assertLatitude(53.551085);
\Astrotomic\PhpunitAssertions\GeographicAssertions::assertLongitude(9.993682);
\Astrotomic\PhpunitAssertions\GeographicAssertions::assertCoordinates([
'lat' => 53.551085,
'lng' => 9.993682,
]);
```
### HashID
`composer require --dev hashids/hashids:^4.0`
```php
\Astrotomic\PhpunitAssertions\HashidAssertions::assertHashIds('3kTMd', 2, 'this is my salt');
\Astrotomic\PhpunitAssertions\HashidAssertions::assertHashId('yr8', 'this is my salt');
```
### Language
`composer require --dev astrotomic/iso639:^1.0`
```php
\Astrotomic\PhpunitAssertions\LanguageAssertions::assertName('German');
\Astrotomic\PhpunitAssertions\LanguageAssertions::assertAlpha2('de');
```
### Nullable Type
```php
\Astrotomic\PhpunitAssertions\NullableTypeAssertions::assertIsNullableString('Astrotomic');
\Astrotomic\PhpunitAssertions\NullableTypeAssertions::assertIsNullableInt(42);
\Astrotomic\PhpunitAssertions\NullableTypeAssertions::assertIsNullableFloat(42.5);
\Astrotomic\PhpunitAssertions\NullableTypeAssertions::assertIsNullableArray(['Astrotomic' => 'Gummibeer']);
\Astrotomic\PhpunitAssertions\NullableTypeAssertions::assertIsNullableBool(true);
```
### Phone Number
`composer require --dev giggsey/libphonenumber-for-php:^8.12`
```php
\Astrotomic\PhpunitAssertions\PhoneNumberAssertions::assertE164('+498001110550');
\Astrotomic\PhpunitAssertions\PhoneNumberAssertions::assertValid('+49 800 - 111 0 550');
\Astrotomic\PhpunitAssertions\PhoneNumberAssertions::assertValidForRegion('+49 800 - 111 0 550', 'DE');
```
### String
```php
\Astrotomic\PhpunitAssertions\StringLengthAssertions::assertSame(10, 'Astrotomic');
\Astrotomic\PhpunitAssertions\StringLengthAssertions::assertNotSame(8, 'Astrotomic');
\Astrotomic\PhpunitAssertions\StringLengthAssertions::assertLessThan(11, 'Astrotomic');
\Astrotomic\PhpunitAssertions\StringLengthAssertions::assertLessThanOrEqual(10, 'Astrotomic');
\Astrotomic\PhpunitAssertions\StringLengthAssertions::assertGreaterThan(9, 'Astrotomic');
\Astrotomic\PhpunitAssertions\StringLengthAssertions::assertGreaterThanOrEqual(10, 'Astrotomic');
```
### URL
```php
\Astrotomic\PhpunitAssertions\UrlAssertions::assertValidLoose('https://astrotomic.info');
\Astrotomic\PhpunitAssertions\UrlAssertions::assertScheme('https', 'https://astrotomic.info');
\Astrotomic\PhpunitAssertions\UrlAssertions::assertHost('astrotomic.info', 'https://astrotomic.info');
\Astrotomic\PhpunitAssertions\UrlAssertions::assertPath('/contributor/gummibeer/', 'https://astrotomic.info/contributor/gummibeer/');
\Astrotomic\PhpunitAssertions\UrlAssertions::assertQuery(['_' => '123', 'q' => 'search'], 'https://astrotomic.info?q=search&_=123');
\Astrotomic\PhpunitAssertions\UrlAssertions::assertComponent('gummibeer', 'https://[email protected]', PHP_URL_USER);
```
### Path
```php
\Astrotomic\PhpunitAssertions\PathAssertions::assertDirname('/foo/bar', '/foo/bar/image.jpg');
\Astrotomic\PhpunitAssertions\PathAssertions::assertBasename('image.jpg', '/foo/bar/image.jpg');
\Astrotomic\PhpunitAssertions\PathAssertions::assertFilename('image', '/foo/bar/image.jpg');
\Astrotomic\PhpunitAssertions\PathAssertions::assertExtension('jpg', '/foo/bar/image.jpg');
```
### UUID
`composer require --dev ramsey/uuid:^4.0`
```php
\Astrotomic\PhpunitAssertions\UuidAssertions::assertUuid('52d08e38-ad24-4960-af02-22e0f7e0db8d');
```
## Laravel Assertions
### Collection
```php
\Astrotomic\PhpunitAssertions\Laravel\CollectionAssertions::assertContains($collection, 'Astrotomic');
```
### HashID
`composer require --dev vinkla/hashids:^9.0`
```php
\Astrotomic\PhpunitAssertions\Laravel\HashidAssertions::assertHashIds('3kTMd', 2);
\Astrotomic\PhpunitAssertions\Laravel\HashidAssertions::assertHashId('yr8');
```
### Model
```php
\Astrotomic\PhpunitAssertions\Laravel\ModelAssertions::assertExists($model);
\Astrotomic\PhpunitAssertions\Laravel\ModelAssertions::assertSame($model, \App\Models\User::first());
\Astrotomic\PhpunitAssertions\Laravel\ModelAssertions::assertRelated($post, 'comments', $comment);
\Astrotomic\PhpunitAssertions\Laravel\ModelAssertions::assertRelated(
$post,
'comments',
\App\Models\Comment::class,
\Illuminate\Database\Eloquent\Relations\HasMany::class
);
```
### Blade
`composer require --dev gajus/dindent:^2.0`
```php
\Astrotomic\PhpunitAssertions\Laravel\BladeAssertions::assertRenderEquals(
"
Price: 99.99 €
",
'Price: {{ number_format($price, 2) }} €
',
['price' => 99.99]
);
```