How to Test if a verification email was queued?

Besides I have added the following Queue Connection for testing purposes:

QUEUE_CONNECTION=sync
QUEUE_DRIVER=sync

@sirhxalot do you get any errors if you put $this->withoutExceptionHandling(); at the top of your test?

I know that the put action works from other tests where I check if a new user has been created. This is why i am sure that there is no validation error.

No. I only have the failed assertion and no errors so far:

The expected [Illuminate\Auth\Notifications\VerifyEmail] mailable was not queued.
Failed asserting that false is true.

@sirhxalot your class names doesn't match, you are expecting VerificationEMail, but you're asserting that VerifyEmail was queued.

Mail::assertQueued(VerifyEmail::class);

should be

Mail::assertQueued(VerificationEMail::class);

Besides now I am testing if the original verification email was sent. I have also tested if my custom Notification was sent:

Mail::assertQueued(VerificationEMail::class);

I have also tried out Queue::assertPushed and Notification::assertSentTo.

@sti3bas Thank you for the reply - i have done that same error.

@sirhxalot well, VerifyEmail is not a Mail, it's a Notification:

This should work:

/** @test */
    public function it_queues_a_verification_notification_email()
    {
        $user = factory(User::class)
            ->make()
            ->makeVisible(['password']);

        Notification::fake();

        Notification::assertNothingSent();

        $this->put(
            route('auth.register.store'),
            $user->toArray()
        );

        Notification::assertSentTo(User::first(), VerificationEMail::class);
    }

If you want to add assertions for the email sent through the notification, you can pass a callback as a third parameter:

Notification::assertSentTo(User::first(), VerificationEMail::class, function($notification) use ($user) {
   $mail = $notification->toMail($user);

   return $mail->subject === 'Test subject';
});

Thank you. I have done this aswell and also Queue.

Fact is my custom verification email is a notification that implement shoulqueue. Its not a mail but as I said i have tried out all possible mockings.

I have now tried out the following:

$this->expectsEvents('Illuminate\Auth\Events\Verified');

Even this assertion fails? How can I trigger the event correctly?

@sirhxalot what do you mean? Verified event is triggered after you verify your email. Registered event should be triggered after you register:

$this->expectsEvents(\Illuminate\Auth\Events\Registered::class);

@sti3bas - Thank you!

Event Verified

When I make the assertion $this->expectsEvents('Illuminate\Auth\Events\Verified');

I will receive the following console output:

1) Tests\Feature\SignUpTest::it_queues_a_verification_notification_email
These expected events were not fired: [Illuminate\Auth\Events\Verified]
Failed asserting that an array is empty.

Event Registred

The assertion you shared: $this->expectsEvents(\Illuminate\Auth\Events\Registered::class); turns into the same error:

1) Tests\Feature\SignUpTest::it_queues_a_verification_notification_email
These expected events were not fired: [Illuminate\Auth\Events\Registered]
Failed asserting that an array is empty.

Conclusion

This brings me to the conclusion that the events will not be triggered during testing. But why?

And just to eliminate any missunderstandings this is the current implementation of the test:

    public function it_queues_a_verification_notification_email()
    {
        $user = factory(User::class)
            ->make()
            ->makeVisible(['password']);

        Notification::fake();

        Notification::assertNothingSent();

        $this->withoutExceptionHandling();

        $this->put(
            route('auth.register.store'),
            $user->toArray()
        );

        $this->expectsEvents(\Illuminate\Auth\Events\Registered::class);

        // Notification::assertSentTo($user, VerificationEMail::class);
    }

@sirhxalot $this->expectsEvents(\Illuminate\Auth\Events\Registered::class); should be at the top, not at the bottom.

@sti3bas you are right!

When I put the expectsevents to the top it turns greeen.

But when I uncomment the Notification assertion sent to it still fails:

1) Tests\Feature\SignUpTest::it_queues_a_verification_notification_email
The expected [App\Notifications\User\VerificationEMail] notification was not sent.
Failed asserting that false is true.

Current implementation:

    public function it_queues_a_verification_notification_email()
    {
        $this->expectsEvents(\Illuminate\Auth\Events\Registered::class);

        $user = factory(User::class)
            ->make()
            ->makeVisible(['password']);

        Notification::fake();

        Notification::assertNothingSent();

        $this->withoutExceptionHandling();

        $this->put(
            route('auth.register.store'),
            $user->toArray()
        );

        Notification::assertSentTo($user, VerificationEMail::class);
    }

@sirhxalot change Notification::assertSentTo($user, VerificationEMail::class); to Notification::assertSentTo(User::first(), VerificationEMail::class); to fetch the user from the database.

Unfortunally same failure.

I have dump and died: User::first() and $user both give me a App\User eloquent class.

@sirhxalot do you really tried to add $this->withoutExceptionHandling(); at the top? Do you have password confirmation validation rule set in your SignupRequest?

This is my testing environment:

APP_NAME="A cool Name"
APP_ENV=testing
APP_KEY=base64:w9ZOK0PIt4/xmNb5T7WRBtzG4hAVPrbUphhSnx9OlEo=
APP_URL=http://localhost

STRIPE_KEY=not_for_public
STRIPE_SECRET=not_for_public

DB_CONNECTION=sqlite_testing
DB_DATABASE=":memory:"

BCRYPT_ROUNDS=4

CACHE_DRIVER=array
MAIL_DRIVER=array
SESSION_DRIVER=array
BROADCAST_DRIVER=null

QUEUE_CONNECTION=sync
QUEUE_DRIVER=sync

CYON_LOG="log-file-name"

Any errors with that?

Yes I did. And I am 99% sure that there is no error with the registration itself.

The following assertion works this is why I am confident that the registration itself works:

    public function its_stores_a_new_user()
    {
        $user = factory(User::class)
            ->make()
            ->makeVisible(['password'])
            ->toArray();

        $this->assertDatabaseMissing(
            'users', [
            'email' => $user['email']
            ]
        );

        $this->put(
            route('auth.register.store'),
            $user
        );

        $this->assertDatabaseHas(
            'users', [
            'email' => $user['email']
            ]
        );
    }

This turns into green.

@sti3bas Thank you for your help! I have found out what the problem was:

The assertion sent to used a user that doesn't exists. I had to fetch the genereated user and than do the assertion - so the assertion end up like this:

    public function it_queues_a_verification_notification_email()
    {
        $user = factory(User::class)
            ->make()
            ->makeVisible(['password']);

        Notification::fake();

        Notification::assertNothingSent();

        $this->put(
            route('auth.register.store'),
            $user->toArray()
        );

        $user = User::firstWhere('email', $user->email);

        Notification::assertSentTo($user, VerificationEMail::class);

        Notification::assertTimesSent(1, VerificationEMail::class);
    }

Using the $this->expectsEvents(\Illuminate\Auth\Events\Registered::class); was not a good idea since it fakes the events so after this line the event will never triggered.

Stupid mistake I am sorry for that.