Assertion Tests & Implementation

[Juhlinus]

Assertions in the Inertia Laravel Adapter

I'm pretty sure that most of us that are testing are making use of the neat macros that was made for PingCRM, so I thought I'd make a PR merging those assertions into the adapter.

Motivations

I don't really want my TestCase.php to be bloated with a ton of macros, so I decided to make these assertions and override the default Laravel TestResponse with these. (You will of course be able to use all assertions that comes with Laravel as well.)

Usage

Simply extend the Inertia TestCase instead of the default Laravel one.

Before

<?php

namespace Tests;

use Illuminate\Support\Arr;
use PHPUnit\Framework\Assert;
use Illuminate\Foundation\Testing\TestResponse;
use Illuminate\Foundation\Testing\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    use CreatesApplication;

    protected function setUp(): void
    {
        parent::setUp();

        TestResponse::macro('props', function ($key = null) {
            $props = json_decode(json_encode($this->original->getData()['page']['props']), JSON_OBJECT_AS_ARRAY);
            if ($key) {
                return Arr::get($props, $key);
            }
            return $props;
        });

        TestResponse::macro('assertHasProp', function ($key) {
            Assert::assertTrue(Arr::has($this->props(), $key));
            return $this;
        });

        TestResponse::macro('assertPropValue', function ($key, $value) {
            $this->assertHasProp($key);
            if (is_callable($value)) {
                $value($this->props($key));
            } else {
                Assert::assertEquals($this->props($key), $value);
            }
            return $this;
        });

        TestResponse::macro('assertPropCount', function ($key, $count) {
            $this->assertHasProp($key);
            Assert::assertCount($count, $this->props($key));
            return $this;
        });
    }
}

After

<?php

namespace Tests;

use Tests\CreatesApplication;
use Inertia\Testing\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    use CreatesApplication;
}

See? Much cleaner than before!

Docs

If this get merged I'll sit down and write some documentation for this as well. 😄

[reinink]

Thanks for this @Juhlinus, but I actually have some updated testing helpers. I'm going to leave this PR open and will post those helpers when I have a minute.

[Juhlinus]

Thanks for this @Juhlinus, but I actually have some updated testing helpers. I'm going to leave this PR open and will post those helpers when I have a minute.

Great! Looking forward to it!

[herpaderpaldent]

i am curious about these new helpers too @reinink

[Juhlinus]

i am curious about these new helpers too @reinink

@herpaderpaldent Jonathan has a day-job and can't push out new changes everyday, unfortunately.

He will post an update in this thread when the new helpers are available. :)

[m1guelpf]

This would probably make better sense as a trait instead of a class?

[robsontenorio]

it would be nice!

I do prefer strategy proposed by @Juhlinus insted of traits, because we get autocompletion advantage. It will require one single change on your app codebase base (TestCase.php)

[nasyrov]

IMHO better to create a proper mixin class and boot in the service provider or when needed

TestResponse::mixin(new TestMixins);

[robsontenorio]

Macros would be a option. But auto completion would be a plus!

[johanvanhelden]

But what if the user already has his own BaseTestCase that he uses with certain customizations.
This way it is going to be extend-ception.

Maybe a trait or macro would be a better option.

[mojtabaahn]

Hi there. any updates on this ?

[Juhlinus]

@mojtabaahn Not yet!

If you want to use it, then just add it to your project. 😄

[jartaud]

While I wait for the PR to be merged, I'm doing something like that:

TestResponse::macro('assertComponentIs', function ($component) {
     Assert::assertEquals(
         $component,
         $this->original->getData()['page']['component']
     );
     return $this;
});

Thanks for the idea @Juhlinus

[claudiodekker]

Thanks @Juhlinus! We just merged #220, meaning this PR is no longer necessary, so I'll be closing this one now 👍

[Juhlinus]

Thanks @Juhlinus! We just merged #220, meaning this PR is no longer necessary, so I'll be closing this one now 👍

Nice job buddy!