Download the PHP package lastdragon-ru/lara-asp-testing without Composer

(Laravel) Testing Helpers 🐝

This package provides various useful asserts for PHPUnit and better solution for HTTP tests - testing HTTP response has never been so easy! And this not only about TestResponse but any PSR response 😎

[include:artisan]: <lara-asp-documentator:requirements "{$directory}">

Requirements

Installation

[!NOTE]

The package intended to use in dev.

Usage

[!IMPORTANT]

By default, package overrides scalar comparator to make it strict! So assertEquals(true, 1) is false.

In the general case, you just need to update tests/TestCase.php to include most important things, but you also can include only desired features, please see related traits and extensions below.

Comparators

[!TIP]

Should be registered before test, check/use built-in traits.

DatabaseQueryComparator

Compares two Query.

We are performing following normalization before comparison to be more precise:

• Renumber laravel_reserved_* (it will always start from 0 and will not contain gaps)
• Format the query by doctrine/sql-formatter package

EloquentModelComparator

Compares two Eloquent Models.

The problem is models after creating from the factory and selecting from the database may have different types for the same properties. For example, factory()->create() will set key as int, but select will set it to string and (strict) comparison will fail. This comparator normalizes properties types before comparison.

ScalarStrictComparator

Makes comparison of scalars strict.

Extensions

PHPUnit TestCase

WithTempDirectory

Allows to create a temporary directory. The directory will be removed automatically after script shutdown.

WithTempFile

Allows to create a temporary file. The file will be removed automatically after script shutdown.

WithTestData

Allows to get instance of TestData (a small helper to load data associated with test)

Laravel TestCase

WithTranslations

Allows replacing translation strings for Laravel.

Override

Similar to \Illuminate\Foundation\Testing\Concerns\InteractsWithContainer but will mark test as failed if override was not used while test (that helps to find unused code).

Eloquent Model Factory

FixRecentlyCreated

After creating the model will have wasRecentlyCreated = true, in most cases this is unwanted behavior, this trait fixes it.

WithoutModelEvents

Disable models events during make/create.

Mixins

\Illuminate\Testing\TestResponse

Assertions

assertDatabaseQueryEquals

Asserts that SQL Query equals SQL Query.

Read more.

assertDirectoryEquals

Asserts that Directory equals Directory.

Read more.

assertJsonMatchesSchema

Asserts that JSON matches schema. Validation based on the Opis JSON Schema package.

Read more.

assertPsrResponse

Asserts that PSR Response satisfies given constraint (we have a lot of built-in responses, but, of course, you can create a custom).

Read more.

assertQueryLogEquals

Asserts that QueryLog equals QueryLog.

Read more.

assertScheduled

Asserts that Schedule contains task.

Read more.

assertScoutQueryEquals

Asserts that Scout Query equals Scout Query.

Read more.

assertXmlMatchesSchema

Asserts that XML matches schema XSD or Relax NG. Validation based on the standard methods of DOMDocument class.

Read more.

Laravel Response Testing

What is wrong with the Laravel approach? Well, there are two big problems.

Where is the error?

You never know why your test failed and need to debug it to find the reason. Real-life example:

Expected status code 200 but received 500.

Hmmm, 500, probably this is php error? Why? Where? 😰

Compare with:

Reusing the test code is problematic

In most real applications you have multiple roles (eg guest, user, admin), guards, and policies. Very difficult to test all of them and usually you need create many testRouteIsNotAvailableForGuest(), testRouteIsAvailableForAdminOnly(), etc with a lot of boilerplate code. Also, often you cannot reuse that (boilerplate) code and must write it again and again. That is really annoying.

Resolving this problem is very simple. First, we need to create classes for the required Responses (actually package already provides few most used responses 🙄). Let's start with a simple JSON response:

Next, lets add JSON Validation Error:

Finally, the test:

The same test with default assertions may look something like this:

Feel the difference 😉

PSR Response Testing

Internally package uses PSR-7 so you can test any Psr\Http\Message\ResponseInterface 🤩

Data Providers on steroids

There is another cool feature that allows us to test a lot of use cases without code duplication - the CompositeDataProvider. It's merging multiple provides into one in the following way:

So we can organize our tests like this:

Enjoy 😸

Mocking properties (Mockery) 🧪

[!IMPORTANT]

Working prototype for How to mock protected properties? (#1142). Please note that implementation relies on Reflection and internal Mockery methods/properties. Also, PHP supports Property Hooks since v8.4 so it highly recommended using them instead of regular properties (when Mockery will support it of course).

Limitations/Notes:

• Readonly properties should be uninitialized.
• Private properties aren't supported.
• Property value must be an object.
• Property must be used while test.
• Property can be mocked only once.
• Objects without methods will be marked as unused.

Custom Test Requirements

Unfortunately, PHPUnit doesn't allow to add/extend existing requirements and probably will not:

I do not think that additional attributes for test requirements should be added. After all, the existing ones are only convenient syntax sugar. Simply check your custom requirements in a before-test method and call markTestSkipped() when they are not met. © @sebastianbergmann

The extension listen several events and checks all attributes of test class/method which are implements Requirement. If the requirements don't meet, the test will be marked as skipped. Please note that at least one "before" hook will be executed anyway (PHPUnit emits events after hook execution).

You need to register extension first:

And then

Upgrading

Please follow Upgrade Guide.

Contributing

This package is the part of Awesome Set of Packages for Laravel. Please use the main repository to report issues, send pull requests, or ask questions.

"\LastDragon_ru\LaraASP\Testing\Database\QueryLog\Query"

"\LastDragon_ru\LaraASP\Testing\Utils\TestData"