May 13, 2020

Level 12

Check for validation errors

I have a test that checks the type of file being uploaded. It works but I also wanted to check the validation errors.

Im using PHP 7.4, phpunit 5.5.4 and Laravel 6.18.13.

/** @test */
    public function any_file_type_other_than_pdf_doc_and_docx_cant_be_uploaded()
    {
        Storage::fake('documents');
        $client = factory(Client::class)->create();
        $user = factory(User::class)->create([
            'admin' => true,
            'client_id' => null
        ]);
        $report = factory(Report::class)->create([
            'user_id' => $user->id,
            'client_id' => $client->id
        ]);
        $type = factory(DocumentType::class)->create();
        $this->actingAs($user);
        $file = UploadedFile::fake()->create('document.png', 999);
        $this->json('POST', 'documents/'.$report->id, [
            'file' => $file,
            'type' => $type->id,
        ]);

        // Assert the file was stored...
        Storage::disk('local')->assertMissing("public/documents/{$file->hashName()}");
    }

I have tried the following.

$this->json('POST', 'documents/'.$report->id, [
            'file' => $file,
            'type' => $type->id,
        ])->assertSessionHas('errors');

Missing key 'errors'

so tried

$response = $this->json('POST', 'documents/'.$report->id, [
            'file' => $file,
            'type' => $type->id,
        ]);

        $response->assertSessionHasErrors('file', null, 'The file must be a file of type: doc, docx, pdf.');

got Failed asserting that null matches expected 'The file must be a file of type: doc, docx, pdf.'. Expected :The file must be a file of type: doc, docx, pdf. Actual :null and have also tried numerous other ways with no luck.

Uploading the wrong type returns the user to the upload form and flashes Errors: The file must be a file of type: doc, docx, pdf.

Anyone know how to check for this in my test?

drewdan

6 years ago

Level 15

There seems to be some good suggestions here: https://stackoverflow.com/questions/34767309/better-way-for-testing-validation-errors

It looks like people reach for the response and assert it contains an error bag with the errors you are expecting

1 like

finchy70

6 years ago

Level 12

There is probably a more attractive way of doing this but I got it to work using

$this->assertSame($response['errors']['file'][0], 'The file must be a file of type: doc, docx, pdf.');

2 likes

drewdan

6 years ago

Level 15

If it works, it works. Though it does seem unusual that your assertSessionHasErrors did not work :/

finchy70

6 years ago

Level 12

Yes strange.

drewdan

6 years ago

Best Answer

Level 15

Ah wait, you are using json

What about

$response->assertJsonValidationErrors(array $data);

1 like

Reppair

4 years ago

Level 13

@drewdan Correct. An example makes it click that instant, here is one:

$this->deleteJson(route('api-user-delete'), ['reason' => ''])
            ->assertStatus(422)
            ->assertJsonValidationErrors(['reason' => 'required']);

Simply use the validation rule names as values for the $data array, and the keys are obviously the parameter that we are testing for.

drewdan

6 years ago

Level 15

@finchy70 If you request it using JSON, I am pretty sure you get a json response which has different keys to normal responses: https://laravel.com/docs/7.x/http-tests#assert-json-validation-errors

This documentation shows different assertions depending on if its json or a normal request

1 like

finchy70

6 years ago

Level 12

        $response->assertJsonValidationErrors('file');

Yes that works too. Thanks.

Please or to participate in this conversation.