Tutorial anterior: Developing Discourse Plugins - Part 5 - Add an admin interface
Você sabia que o Discourse possui duas grandes suítes de testes para sua base de código? No lado do servidor, nosso código Ruby tem uma suíte de testes que usa o rspec. Para a aplicação do navegador, temos uma suíte de qunit que inclui o ember-testing.
Presumindo que você tenha um ambiente de desenvolvimento configurado, se você visitar a URL http://localhost:3000/tests, começará a executar a suíte de testes JavaScript no seu navegador. Um aspecto divertido é que você pode ver os testes sendo executados na aplicação em uma janela em miniatura no canto inferior direito:
A aplicação Discourse é construída com muitos testes que começarão a ser executados quando você visitar a URL /tests. Portanto, pode ser útil filtrar seus testes pelo plugin no qual você está trabalhando. Você pode fazer isso na interface clicando no menu suspenso Plugin e selecionando seu plugin:
Adicionando um Teste de Aceitação no seu Plugin
Primeiro, certifique-se de ter a versão mais recente do Discourse baixada (checkout). A capacidade de executar testes de aceitação a partir de plugins é um recurso relativamente novo, e se você não usar a versão mais recente, seus testes não aparecerão.
Neste artigo, vou escrever um teste de aceitação para o plugin purple-tentacle, que criamos na parte 5 desta série.
Adicionar um teste de aceitação é tão fácil quanto adicionar um arquivo ao seu plugin. Crie o seguinte arquivo:
test/javascripts/acceptance/purple-tentacle-test.js
import { acceptance, exists } from "discourse/tests/helpers/qunit-helpers";
import { click, visit } from "@ember/test-helpers";
import { test } from "qunit";
acceptance("Purple Tentacle", function (needs) {
needs.settings({ purple_tentacle_enabled: true });
needs.user();
test("Purple tentacle button works", async function (assert) {
await visit("/admin/plugins/purple-tentacle");
assert.ok(exists("#show-tentacle"), "it shows the purple tentacle button");
assert.ok(!exists(".tentacle"), "the tentacle is not shown yet");
await click("#show-tentacle");
assert.ok(exists(".tentacle"), "the tentacle wants to rule the world!");
});
});
Tentei escrever o teste de uma forma clara, mas pode ser um pouco confuso se você nunca escreveu um teste de aceitação antes. Eu recomendo fortemente que você leia a documentação do Ember sobre testes de aceitação, pois ela contém muitas informações excelentes.
Em cada teste que escrevemos, precisamos fazer uma assert (asserção). No nosso teste, queremos fazer algumas asserções para verificar se o tentáculo está oculto inicialmente e depois é exibido somente após clicar no botão.
Queremos definir um conjunto de ações a serem tomadas antes de uma asserção ser feita. Para isso, usamos a palavra-chave await. Ao usar essa palavra-chave, aguardamos a conclusão da execução de cada auxiliar assíncrono primeiro.
Nossa primeira ação importante é: await visit("/admin/plugins/purple-tentacle");. Isso diz ao nosso teste para navegar até essa URL em nossa aplicação. Essa era a URL que exibia o tentáculo.
Depois de visitar a página onde o botão do tentáculo roxo aparece, queremos verificar se podemos ver que o botão existe na página e que a imagem do tentáculo ainda não existe.
Isso é feito pelas seguintes asserções:
assert.ok(exists("#show-tentacle"), "it shows the purple tentacle button");
assert.ok(!exists(".tentacle"), "the tentacle is not shown yet");
P.S. A versão anterior do plugin purple-tentacle não tinha o ID de elemento #show-tentacle no template handlebars. Confira a versão mais recente para acompanhar!
Uma vez que esses testes sejam aprovados, é hora de testar a interação.
O próximo comando é await click('#show-tentacle');, que diz à nossa estrutura de testes que queremos clicar no botão e mostrar o tentáculo.
Depois de simular um clique no botão, podemos verificar se o tentáculo aparece fazendo a asserção:
assert.ok(exists(".tentacle"), "the tentacle wants to rule the world!");
Não é tão ruim, certo? Você pode tentar o teste você mesmo visitando http://localhost:3000/tests?target=purple-tentacle na sua máquina de desenvolvimento. Você deve ver o tentáculo roxo aparecer muito rapidamente e todos os testes serão aprovados.
Se você quiser executar os testes qunit do plugin na linha de comando, você pode executar
bin/qunit --target purple-tentacle
(adicione --standalone se o seu servidor de desenvolvimento não estiver sendo executado)
(onde purple-tentacle é o nome da pasta do seu plugin)
Depurando seus testes
À medida que você escreve seus plugins, seus testes podem ajudar a identificar problemas no plugin. Quando você está desenvolvendo seus testes ou se faz alterações no código do seu plugin, os testes podem falhar. Para ajudar a entender o motivo, o Ember possui alguns auxiliares úteis: pauseTest() e resumeTest().
Para usá-los, adicione await pauseTest() dentro do código do seu teste, onde você gostaria que o teste fosse pausado. Agora, quando você executar seu teste no navegador, o teste será automaticamente pausado no ponto onde você adicionou pauseTest(). Isso dará a você a chance de inspecionar a página ou ver quaisquer erros para ajudar a depurar problemas.
Para onde ir daqui
Eu odeio soar como um disco riscado, mas a documentação do Ember sobre testes é excelente. Você também pode querer ver como o Discourse testa várias funcionalidades navegando pelos testes no nosso diretório de testes javascript. Temos muitos exemplos lá dos quais você pode aprender.
Felizes testes!
Mais na série
Parte 1: Fundamentos de Plugins
Parte 2: Outlets de Plugin
Parte 3: Configurações do Site
Parte 4: Configuração do git
Parte 5: Interfaces de Administração
Parte 6: Este tópico
Parte 7: Publique seu plugin
Este documento possui controle de versão - sugira alterações no github.


