Tutorial anterior: Developing Discourse Plugins - Part 5 - Add an admin interface
Você sabia que o Discourse tem duas grandes suítes de teste para sua base de código? No lado do servidor, nosso código Ruby tem uma suíte de testes que usa rspec. Para a aplicação do navegador, temos uma suíte qunit que inclui ember-testing.
Assumindo que você tenha um ambiente de desenvolvimento configurado, se você visitar o URL http://localhost:4200/tests, começará a executar a suíte de testes JavaScript no seu navegador. Um aspecto divertido é que você pode vê-la testando a aplicação em uma janela miniatura no canto inferior direito:
A aplicação Discourse é construída com muitos testes que começarão a ser executados quando você visitar o 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 extraída. Ser capaz de executar testes de Aceitação a partir de plugins é um recurso relativamente novo e, se você não extrair 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!");
});
});
Eu 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 altamente recomendo que você leia a documentação do Ember sobre testes de aceitação, pois eles têm muitas informações ótimas.
Em cada teste que escrevemos, precisamos assert (afirmar) algo. Em nosso teste, queremos fazer algumas afirmações para verificar se o tentáculo está oculto inicialmente e só é mostrado após clicar no botão.
Queremos definir um conjunto de ações a serem tomadas antes que uma afirmação seja feita. Para fazer isso, usamos a palavra-chave await. Ao usar essa palavra-chave, esperamos que a execução de cada helper assíncrono termine primeiro.
Nossa primeira ação de importância é: await visit("/admin/plugins/purple-tentacle");. Isso diz ao nosso teste para navegar para aquele URL em nossa aplicação. Aquele URL era o que exibia o tentáculo.
Depois de visitar a página onde o botão do tentáculo roxo aparece, queremos verificar se conseguimos ver que o botão na página existe e que 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 handlebars. Verifique a versão mais recente para acompanhar!
Assim que esses testes passarem, é 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, certo? Você pode tentar o teste você mesmo visitando http://localhost:4200/tests?qunit_single_plugin=purple-tentacle&qunit_skip_core=1 em sua máquina de desenvolvimento. Você deverá ver muito rapidamente o tentáculo roxo aparecer e todos os testes passarão.
Se você quiser executar os testes qunit do plugin na linha de comando usando PhantomJS, você pode executar
rake plugin:qunit['purple-tentacle']
(onde purple-tentacle é o nome da pasta do seu plugin)
Depurando seus testes
À medida que você escreve seus plugins, seus testes podem ajudá-lo a identificar problemas no seu plugin. Quando você estiver desenvolvendo seus testes ou se fizer alterações no código do seu plugin, os testes podem falhar. Para ajudar a entender o porquê, o Ember tem alguns helpers legais: pauseTest() e resumeTest().
Para usá-los, adicione await pauseTest() dentro do código do seu teste onde você gostaria que o teste pausasse. Agora, quando você executa 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 ver quaisquer erros para ajudar a depurar problemas.
Para onde ir a partir daqui
Eu odeio soar como um disco arranhado, 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á dos quais você pode aprender.
Bons testes!
Mais na série
Parte 1: Noções Básicas de Plugin
Parte 2: Plugin Outlets
Parte 3: Configurações do Site
Parte 4: Configuração do git
Parte 5: Interfaces de Administrador
Parte 6: Este tópico
Parte 7: Publique seu plugin
Este documento é controlado por versão - sugira alterações no github.
it is an Admin page
)