Tutorial anterior: Developing Discourse Plugins - Part 5 - Add an admin interface
Você sabia que o Discourse possui dois grandes conjuntos de testes (test suites) 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 de testes qunit que inclui o ember-testing.
Assumindo que você tenha um ambiente de desenvolvimento configurado, se você visitar a URL http://localhost:3000/tests, começará a executar o conjunto de testes de JavaScript no seu navegador. Um aspecto divertido é que você pode ver o aplicativo sendo testado em uma janela 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 (checkout). 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.
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:
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 fortemente 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 fazer uma assert (afirmação). No nosso teste, queremos fazer algumas afirmações para verificar se o tentáculo está oculto inicialmente e só é exibido após clicar no botão.
Queremos definir um conjunto de ações a serem tomadas antes de uma afirmação ser 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 aquela URL em nosso aplicativo. Aquele era o endereço que exibia o tentáculo.
Após 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 do elemento #show-tentacle no template handlebars. Verifique a versão mais recente para acompanhar!
Uma vez que esses testes passem, é 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.
Após simularmos um clique no botão, podemos verificar se o tentáculo aparece fazendo a afirmação:
assert.ok(exists(".tentacle"), "the tentacle wants to rule the world!");
Nada mal, não é? Você pode tentar o teste você mesmo visitando http://localhost:3000/tests?qunit_single_plugin=purple-tentacle&qunit_skip_core=1 na sua máquina de desenvolvimento. Você deve ver o tentáculo roxo aparecer muito rapidamente 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 ajudar você a identificar problemas no seu 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 por quê, o Ember tem alguns helpers úteis: pauseTest() e resumeTest().
Para usá-los, adicione await pauseTest() dentro do seu código de teste onde você gostaria que o teste pausasse. 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
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 de javascript. Temos vários exemplos lá dos quais você pode aprender.
Bons testes!
Mais na série
Parte 1: Plugin Basics
Parte 2: Plugin Outlets
Parte 3: Site Settings
Parte 4: git setup
Parte 5: Admin interfaces
Parte 6: Este tópico
Parte 7: Publish your plugin
Este documento é controlado por versão - sugira alterações no github.
it is an Admin page
)