Создание экземпляров класса для насмешек в функциональном тесте - PullRequest
0 голосов
/ 05 марта 2019

В настоящее время я работаю над своим первым проектом Laravel - конечной точкой службы, которая возвращает ресурс на основе записи, сохраненной в S3. Службе не требуется БД, но моя идея состояла в том, чтобы я мог сохранить контроллер в скине, переместив логику в «модель». Затем я мог получить доступ к ресурсу, имитируя некоторые стандартные вызовы активных записей.

Функционально реализация работает, как и ожидалось, но у меня возникают проблемы с насмешками.

Я использую библиотеку для создания подписанных URL-адресов CloudFront, но доступ к ней осуществляется как статический метод. Когда я впервые начал писать свой функциональный тест, я обнаружил, что не смог заглушить статический метод. Я попробовал псевдоним класса с Mockery , но безуспешно - я все еще использовал статический метод. Итак, я попытался обернуть статический метод в небольшом классе, предполагая, что насмешка над классом будет проще. К сожалению, я испытываю ту же проблему. То, что я пытаюсь высмеять, так это то, что меня бьют, как будто я не издеваюсь.

В этом посте о переполнении стека приведен пример использования псевдонимов классов, но я не могу заставить его работать. В чем разница между перегрузкой и псевдонимом в Mockery?

Что я делаю не так? Я бы предпочел заставить насмешливое наложение псевдонимов работать, но насмешка над экземплярами была бы хорошей. Пожалуйста, укажите мне в правильном направлении. Заранее благодарю за помощь.

Контроллер

// app/Http/Controllers/API/V1/RecordingController.php
class RecordingController extends Controller {
    public function show($id){
        return json_encode(Recording::findOrFail($id));
    }
}

Модель

// app/Models/Recording.php
namespace App\Models;

use Mockery;
use Carbon\Carbon;
use CloudFrontUrlSigner;
use Storage;
use Illuminate\Support\Arr;

class Recording
{
    public $id;
    public $url;

    private function __construct($array)
    {
        $this->id = $array['id'];
        $this->url = $this->signedURL($array['filename']);
    }

    // imitates the behavior of the findOrFail function
    public static function findOrFail($id): Recording
    {
        $filename = self::filenameFromId($id);
        if (!Storage::disk('s3')->exists($filename)) {
            abort(404, "Recording not found with id $id");
        }

        $array = [
            'id' => $id,
            'filename' => $filename,
        ];

        return new self($array);
    }

    // imitate the behavior of the find function
    public static function find($id): ?Recording
    {
        $filename = self::filenameFromId($id);
        if (!Storage::disk('s3')->exists($filename)){
            return null;
        }

        $array = [
            'id' => $id,
            'filename' => $filename,
        ];

        return new self($array);
    }

    protected function signedURL($key) : string
    {
        $url = Storage::url($key);
        $signedUrl = new cloudFrontSignedURL($url);
        return $signedUrl->getUrl($url);
    }
}

/**
 * wrapper for static method for testing purposes
 */
class cloudFrontSignedURL {
    protected $url;
    public function __construct($url) {
        $this->url = CloudFrontUrlSigner::sign($url);
    }
    public function getUrl($url) {
        return $this->url;
    }
}

Test

// tests/Feature/RecordingsTest.php
namespace Tests\Feature;

use Mockery;
use Faker;
use Tests\TestCase;
use Illuminate\Http\File;
use Illuminate\Support\Facades\Storage;
use Illuminate\Foundation\Testing\WithFaker;

/* The following is what my test looked like when I wrapped CloudFrontUrlSigner 
 * in a class and attempted to mock the class
 */
class RecordingsTest extends TestCase
{
    /** @test */
    public function if_a_recording_exists_with_provided_id_it_will_return_a_URL()
    {
        $recordingMock = \Mockery::mock(Recording::class);
        $faker = Faker\Factory::create();
        $id = $faker->numberBetween($min = 1000, $max = 9999);

        $filename = "$id.mp3";
        $path = '/api/v1/recordings/';
        $returnValue = 'abc.1234.com';

        $urlMock
            ->shouldReceive('getURL')
            ->once()
            ->andReturn($returnValue);

        $this->app->instance(Recording::class, $urlMock);

        Storage::fake('s3');
        Storage::disk('s3')->put($filename, 'this is an mp3');
        Storage::disk('s3')->exists($filename);

        $response = $this->call('GET', "$path$id");
        $response->assertStatus(200);
    }
}

// The following is what my test looked like when I was trying to alias CloudFrontUrlSigner
{
    /** @test */
    public function if_a_recording_exists_with_provided_id_it_will_return_a_URL1()
    {
        $urlMock = \Mockery::mock('alias:Dreamonkey\cloudFrontSignedURL');
        $faker = Faker\Factory::create();
        $id = $faker->numberBetween($min = 1000, $max = 9999);

        $filename = "$id.mp3";
        $path = '/api/v1/recordings/';
        $returnValue = 'abc.1234.com';

        $urlMock
            ->shouldReceive('sign')
            ->once()
            ->andReturn($returnValue);

        $this->app->instance('Dreamonkey\cloudFrontSignedURL', $urlMock);

        Storage::fake('s3');
        Storage::disk('s3')->put($filename, 'this is an mp3');
        Storage::disk('s3')->exists($filename);

        $response = $this->call('GET', "$path$id");
        $response->assertStatus(200);
    }
}

PHPUnit

$ phpunit tests/Feature/RecordingsTest.php --verbose

...

There was 1 failure:

1) Tests\Feature\RecordingsTest::if_a_recording_exists_with_provided_id_it_will_return_a_URL
Expected status code 200 but received 500.
Failed asserting that false is true.

/Users/stevereilly/Projects/media-service/vendor/laravel/framework/src/Illuminate/Foundation/Testing/TestResponse.php:133
/Users/stevereilly/Projects/media-service/tests/Feature/RecordingsTest.php:85
/Users/stevereilly/.composer/vendor/phpunit/phpunit/src/TextUI/Command.php:206
/Users/stevereilly/.composer/vendor/phpunit/phpunit/src/TextUI/Command.php:162

1 Ответ

0 голосов
/ 06 марта 2019

Вы получаете 500, что означает, что с кодом что-то не так.Просто просматривая его, я замечаю, что вы пропускаете метод filenameFromId в классе Recordings, и тест создает макет с именем $recordingMock, но вы пытаетесь использовать $urlMock.Попытайтесь сначала исправить эти проблемы.
Затем вы издеваетесь над классом, но никогда не заменяете его в своем приложении (очевидно, вы делали это в старом тесте).
Как правило, вы хотите выполнить следующие шаги при издевательстве:
1. Макет класса
2. Скажите Laravel заменять класс на ваш макет всякий раз, когда кто-то его запрашивает
3. Сделайте некоторые утверждения против макета

...