Как протестировать метод контроллера в Symfony5?

Question

[Алексей Дабалаев]

Всем привет.
Может сталкивался кто с такой проблемой (а может и не проблемой вовсе): работа экшна контроллера завершается таким образом:

echo file_get_contents($path);
exit();

т.е. функция echo отдаёт изображение.

Протестить сие пытаюсь таким образом:

$crawler = self::$client->request('GET', $uri);

В результате в консоль сыпется куча символов (собственно само изображение отданное экшном через echo).

Можно ли вообще такое протестировать? Если да - то как?

Comments

[Daria Motorina]

Алекс Вы хотите чтобы контент картинки не выводился в вывод пхпюнита в консоль, правильно? А какую логику хотите протестить? Просто я тоже с таким еще не сталкивалась, сейчас попробую вывод контента "замьютить"

Answer 1

[Daria Motorina]

Раньше с таким не сталкивалась, но есть момент в описании вопроса - просто сделать эхо контента и exit не выйдет, чтобы вывести файл нужно еще добавить заголовки контента, размер файла и способ вывода. Т.е. в таком виде как метод контроллера есть сейчас я не понимаю, как он может корректно работать)
Даже если без доработок, то для предотвращения вывода контента файла в консоль достаточно использовать ob_start() и ob_get_clean().

Доработала пример:
Контроллер:

<?php

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\BinaryFileResponse;
use Symfony\Component\Routing\Annotation\Route;

class TestController extends AbstractController
{
    /**
     * @Route("/get-image", name="get_image")
     */
    public function getImage()
    {
        $path = "/home/dariia/Code/sf5_http_kernel_course/public/uploads/article_image/lightspeed-5f687f2402b6f.png";

        $response = new BinaryFileResponse($path);

        return $response;
    }
}

Тест:

<?php

namespace App\Tests\Controller;

use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;

class TestControllerTest extends WebTestCase
{
    public function testRegister()
    {
        $client = static::createClient();
        ob_start();
        $client->request('GET', '/get-image');
        $client->getResponse()->sendContent();
        $this->assertResponseIsSuccessful();
        $this->assertResponseHeaderSame('Content-Type', 'image/png');
        ob_get_clean();
...

Дальше можно добавить ассерты на тему размера файла, имени и т.д., просто нужно иметь какую-то привязку к файлу, чтобы этими данными манипулировать, а я упростила пример)

Comments

[Алексей Дабалаев]

Здравствуйте )
Спасибо, что подключилиь к поиску решения!

Использовал предложенный вами код для тестирования.
Два варианта развития событий.

1. В контроллере метод отдаёт ответ с заголовками:

...
        $imgPath = __DIR__ . '/../../storage/temp/source.jpg';

        header('HTTP/1.1 200 OK');
        header('Content-type:image/jpg');

        echo file_get_contents($path);
        exit();
    }

В таком случае получаю 500-ю в ответ + стандартную страницу ошибки Symfony (вернее её разметку) с сообщение об ошибке. Вот собственно и ошибка:

Cannot modify header information - headers already sent by (output started at /var/www/.../.phpunit/phpunit-7.5-0/src/Util/Printer.php:113) (500 Internal Server Error)

/var/www/.../vendor/symfony/framework-bundle/Test/BrowserKitAssertionsTrait.php:132
/var/www/.../vendor/symfony/framework-bundle/Test/BrowserKitAssertionsTrait.php:33
/var/www/.../tests/Controller/ImagesControllerTest.php:30

Если без заголовков в методе отвечать - в консоль всё-равно продолжают сыпаться "запчасти" изображения:
qH��/����˅�t{�Sdž��V�����S<�-�,�W��BpѠ�

И метод теста:

public function testGetRemoteImage(): void
    {
        $uri = '/image/path/' . $this->params['remote']['image_name'] . '/remote';

        ob_start();

        $client = static::$client;
        $client->request('GET', $uri);
        $client->getResponse()->sendContent();

        $content = ob_get_contents();
        ob_clean();

        static::assertResponseIsSuccessful();
        static::assertResponseHeaderSame('Content-Type', 'image/jpg');
        static::assertIsString(gettype($content));
    }

Вместо функции echo() использовал BinaryFileResponse(). В разных вариациях передавал параметры в конструктор класса.
Тоже успехом не увенчалось.

Либо с настройками проекта траблы, либо руки у меня совсем кривые )))

[BoShurik]

Алексей Дабалаев, это же фреймворк, отправка хедеров и прочие операции инкапсулированы в объект класса Response, который уже используется в конце исполнения приложения: https://github.com/symfony/demo/blob/master/public...
В вашем случае из-за exit вы обрываете весь процесс на середине

[Daria Motorina]

Алексей Дабалаев, да, BinaryFileResponse заменяет весь тот процесс, что Вы описали вручную и exit не понадобится, лучше отрефакторьте контроллер)

[Алексей Дабалаев]

Да, вы правы. Принудительный выход обрывает работу фреймворка.
Спасибо, буду ковырять далььше ))

[Алексей Дабалаев]

В результате получилось следующее:

метод контроллера:

{
        ...
        $exploded = explode('.', $name);
        $extension = end($exploded);
        $extension = $extension === 'jpg' ? 'jpeg' : $extension;

        return new BinaryFileResponse($path, Response::HTTP_OK, ['Content-type:' => 'image/' . $extension]);
    }

тест:

{
        ....

        $client = static::$client;
        $client->request('GET', $uri);

        $response = $client->getResponse();
        self::assertEquals(Response::HTTP_OK, $response->getStatusCode());

        $headers = $response->headers->all();
        self::assertArrayHasKey(self::HEADERS_KEY, $headers);
        if (array_key_exists(self::HEADERS_KEY, $headers)) {
            self::assertEquals(self::EXPECTED_EXTENSION, $headers[self::HEADERS_KEY][0]);
        }
    }