Tutorial anterior: Developing Discourse Plugins - Part 5 - Add an admin interface
Você sabia que o Discourse possui dois grandes conjuntos de testes para sua base de código? No lado do servidor, nosso código Ruby tem um conjunto de testes que usa rspec. Para o aplicativo do navegador, temos um conjunto qunit que inclui ember-testing.
Supondo que você tenha configurado um ambiente de desenvolvimento, se visitar a URL http://localhost:3000/tests, você iniciará a execução do conjunto de testes JavaScript no seu navegador. Um aspecto divertido é que você pode vê-lo testando o aplicativo em uma janela em miniatura no canto inferior direito:
O aplicativo Discourse é construído 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 em que 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 verificada. A capacidade de executar testes de aceitação a partir de plugins é um recurso relativamente novo e, se você não verificar a versão mais recente, seus testes não aparecerão.
Para este 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:
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 forma clara, mas pode ser um pouco confuso se você nunca escreveu um teste de aceitação antes. Eu altamente recomendo que você leia a documentação do Ember sobre testes de aceitação, pois eles têm muitas informações excelentes.
Em cada teste que escrevemos, precisamos assert algo. No nosso teste, queremos fazer algumas afirmações para verificar se o tentáculo está oculto inicialmente e depois mostrado apenas após clicar no botão.
Queremos definir um conjunto de ações a serem tomadas antes de uma afirmação ser feita. Para isso, usamos a palavra-chave await. Ao usar essa palavra-chave, aguardamos que a execução de cada assistente assíncrono termine primeiro.
Nossa primeira ação importante é: await visit("/admin/plugins/purple-tentacle");. Isso diz ao nosso teste para navegar para essa URL no nosso aplicativo. Essa URL é a que exibe o tentáculo.
Depois de visitar a página onde o botão do tentáculo roxo aparece, queremos verificar se podemos ver o botão na página e se a imagem do tentáculo ainda não existe.
Isso é feito pelas seguintes afirmaçõ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 do Handlebars. Confira a versão mais recente para acompanhar!
Uma vez que esses testes passam, é hora de testar a interação.
O próximo comando é await click('#show-tentacle');, que diz ao nosso framework de teste 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 afirmando:
assert.ok(exists(".tentacle"), "the tentacle wants to rule the world!");
Não é tão ruim, não é? Você pode tentar o teste você mesmo visitando http://localhost:3000/tests?qunit_single_plugin=purple-tentacle&qunit_skip_core=1 em sua máquina de desenvolvimento. Você verá muito rapidamente o tentáculo roxo aparecer e todos os testes passarão.
Se quiser executar os testes qunit do plugin na linha de comando usando o PhantomJS, você pode executar:
rake plugin:qunit['purple-tentacle']
(onde purple-tentacle é o nome da pasta do seu plugin)
Depurando seus testes
Enquanto você escreve seus plugins, seus testes podem ajudá-lo a identificar problemas no seu plugin. Quando você está desenvolvendo seus testes ou se fizer alterações no código do seu plugin, os testes podem falhar. Para ajudar a entender o motivo, o Ember possui alguns assistentes úteis: pauseTest() e resumeTest().
Para usá-los, adicione await pauseTest() dentro do seu código de teste onde você deseja que o teste pause. Agora, quando você executar seu teste no navegador, o teste pausará automaticamente no ponto em que você adicionou pauseTest(). Isso lhe dará a chance de inspecionar a página ou visualizar quaisquer erros para ajudar a depurar problemas.
Para onde ir a partir 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 em nosso diretório de testes JavaScript. Temos vários exemplos lá que você pode aprender.
Boa sorte nos testes!
Mais na série
Parte 1: Fundamentos do Plugin
Parte 2: Saídas 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 está sob controle de versão — sugira alterações no GitHub.
it is an Admin page
)