Início / coding / Perguntas / 79311894
Accepted
Nishant
Asked: 2024-12-27 21:15:08 +0800 CST

Como simular métodos chamados dentro de um método de controlador ao testar métodos de controlador laravel

  • 772

A rota definida em web.phpé

Route::get('about-us', [PageController::class, 'renderAboutUsPage'])->name('pages.about-us');

No meu controlador, tenho métodos

class PageController extends Controller
{
    protected $pageService;

    /**
     * Class contructor
     */
    public function __construct(PageService $pageService)
    {
        $this->pageService = $pageService;
    }

    /**
     * Method to render about us page
     */
    public function renderAboutUsPage(){
        return $this->renderStaticPage('about-us');
    }

    /**
     * Method to render static page
     * @param slug
     */
    private function renderStaticPage($slug) {
        Log::info("Rendering ".$slug." static page.");
        $page = $this->pageService->getActivePageBySlug($slug);
        return view('pages.static-page', ['data'=>$page]);
    }
}

O que meu entendimento diz quando testo o método renderAboutUsPage()é que devo simular pageService->getActivePageBySlug($slug)no meu teste para que uma chamada real para esse método possa ser evitada. Isso ajudará a reduzir o tempo de execução do teste.

Tenho testes separados para meu serviço, nos quais estou testando getActivePageBySlug()de forma independente.

Meu caso de teste é

    /**
     * @test
     * @testdox Whether the about us page returns a successful response, renders the correct view, contains view object {data} and log correct messages in log file.
     * @group website
     * @group static-pages
     */
    public function test_whether_about_us_page_renders_successfully()
    {
        Log::shouldReceive('info')->once()->with("Rendering about-us static page.");
        Log::shouldReceive('info')->once()->with("Getting page by active status and provided slug.");
        $response = $this->get('about-us');
        $response->assertStatus(200);
        $response->assertViewIs('pages.static-page'); 
        $response->assertViewHas('data');
    }

Não sei como simular o método getActivePageBySlug($slug)no meu caso de teste para evitar chamadas reais.

A definição de getActivePageBySlug($slug)método é:

    /**
     * Method to get page by slug (Checks to page status is active)
     * @param string slug
     * @return Page page
     * @throws Throwable e 
     */
    public function getActivePageBySlug(string $slug)
    {
        Log::info("Getting page by active status and provided slug.");
        try
        {
            $page = Page::where('slug',$slug)->where('status', Status::active->value())->first();
            if(!$page) {
                throw new NotFoundHttpException("The page ". $slug ." not found.");
            } 
            return $page;
        }
        catch (Throwable $e)
        {
            Log::error("Error in getting page by slug.");
            throw $e;
        }
    }
laravel

1 respostas

  1. Best Answer

    Na realidade, você não quer evitar a chamada, senão não é realmente um teste de funcionalidade, mas um "teste unitário". E se você estiver testando um endpoint/url em seu projeto, deve ser um teste de funcionalidade, você deve fazer a chamada real, a menos que seja um serviço de terceiros onde você realmente queira evitar a chamada.

    Seu serviço está fazendo uma chamada de banco de dados, você deve chamá-lo, está tudo bem, principalmente se você não estiver fazendo nenhum trabalho pesado depois disso.

    Então, se você quiser fazer a chamada real, você deve ter o código assim (supondo que você tenha fábricas e tudo configurado corretamente):

    /**
 * @group website
 * @group static-pages
 */
public function test_about_us_page_should_render(): void
{
    Page::factory()->create([
        'slug' => $page = 'about-us',
        'status' => Status::active, // Be sure to cast 'status' => Status::class in your model
    ]);

    Log::shouldReceive('info')->once()->with("Rendering {$page} static page.");
    Log::shouldReceive('info')->once()->with("Getting page by active status and provided slug.");

    $this->get($page)
        ->assertOk()
        ->assertViewIs('pages.static-page')
        ->assertViewHas('data');
}

    Esse deve ser o teste mais simples de todos, você pode adicionar mais coisas lá. Veja que eu mudei o nome do teste (tentando seguir os padrões), e outras pequenas mudanças.

    Agora, digamos que você também espera que a página falhe (seu serviço gere um erro), então vamos testar isso também:

    /**
 * @group website
 * @group static-pages
 * @depends test_about_us_page_should_render
 * @dataProvider pageErrorDataProvider
 */
public function test_about_us_page_should_throw_an_error_when_model_not_found(callable $pageSeeder): void
{
    $pageSeeder();

    $page = 'about-us';

    Log::shouldReceive('error')->once()->with("Error in getting page by slug.");

    $this->get($page)
        ->assertServerError(); // This checks for status = 500

    // You should also assert that you got the exact error: "The page {$page} not found."
}

public function pageErrorDataProvider(): array
{
    return [
        'Page not active' => function () {
            return Page::factory()->create([
                'slug' => 'about-us',
                'status' => Status::disabled, // Or whatever the other state is
            ]);
        },
        'Different page' => function () {
            return Page::factory()->create([
                'slug' => 'about',
                'status' => Status::active,
            ]);
        },
        'Page does not exist' => function () {
            return null;
        },
    ];
}

    Agora, você pode ver que estamos, antes de tudo, dependendo do primeiro teste, se o caminho feliz funcionar, esse novo caso também pode ser executado. Também estamos aproveitando os provedores de dados , então testamos diferentes possibilidades com o mesmo caso, apenas inicialização de dados diferente.

    Não me lembro agora qual é a afirmação correta para verificar também o erro do endpoint, então também nos certificamos de verificar se o erro é o esperado, mas, por favor, leia a documentação oficial e mexa nela, e você o encontrará.

    Por fim, se você realmente deseja evitar fazer qualquer chamada, este deve ser seu teste:

    /**
 * @group website
 * @group static-pages
 */
public function test_about_us_page_should_render(): void
{
    $page = 'about-us';

    $this->mock(PageService::class, function (MockInterface $mock) {
        $mock->shouldReceive('getActivePageBySlug')
            ->andReturn(
                Page::factory()->make([
                    'slug' => $page = 'about-us',
                    'status' => Status::active,
                ])
            );
    });

    Log::shouldReceive('info')->once()->with("Rendering {$page} static page.");
    Log::shouldReceive('info')->once()->with("Getting page by active status and provided slug.");

    $this->get($page)
        ->assertOk()
        ->assertViewIs('pages.static-page')
        ->assertViewHas('data');
}

    Você quer zombar do serviço, então pode fazer qualquer coisa.

    Tenha em mente que usei a documentação do Laravel 11.x e não tenho ideia de qual conteúdo você Pagetem. Você também deve garantir que o conteúdo retornado é o esperado, não apenas que ele tem dataíndice na sua visualização, mas também quais dados são.

    • 1

relate perguntas