Tutorial anterior: Developing Discourse Plugins - Part 5 - Add an admin interface
¿Sabías que Discourse tiene dos grandes suites de pruebas para su base de código? En el lado del servidor, nuestro código Ruby tiene una suite de pruebas que utiliza rspec. Para la aplicación del navegador, tenemos una suite qunit que incluye ember-testing.
Asumiendo que tienes un entorno de desarrollo configurado, si visitas la URL http://localhost:3000/tests comenzarás a ejecutar la suite de pruebas de JavaScript en tu navegador. Un aspecto divertido es que puedes ver cómo prueba la aplicación en una ventana miniatura en la esquina inferior derecha:
La aplicación Discourse está construida con muchas pruebas que comenzarán a ejecutarse cuando visites la URL /tests. Por lo tanto, puede ser útil filtrar tus pruebas por el complemento en el que estás trabajando. Puedes hacerlo en la interfaz haciendo clic en el menú desplegable Plugin y seleccionando tu complemento:
Agregar una prueba de aceptación en tu complemento
Primero, asegúrate de tener la última versión de Discourse clonada. La capacidad de ejecutar pruebas de aceptación desde complementos es una característica relativamente nueva, y si no clonas la última versión, tus pruebas no aparecerán.
Para este artículo, voy a escribir una prueba de aceptación para el complemento purple-tentacle que creamos en la parte 5 de esta serie.
Agregar una prueba de aceptación es tan fácil como agregar un archivo a tu complemento. Crea lo siguiente:
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!");
});
});
Intenté escribir la prueba de una manera clara, pero podría ser un poco confusa si nunca has escrito una prueba de aceptación antes. Muy recomiendo que leas la documentación de Ember sobre pruebas de aceptación, ya que tienen mucha información excelente.
En cada prueba que escribimos, necesitamos assert (afirmar) algo. En nuestra prueba, queremos hacer algunas afirmaciones para verificar si el tentáculo está oculto inicialmente y luego se muestra solo después de hacer clic en el botón.
Queremos definir un conjunto de acciones a realizar antes de que se haga una afirmación. Para hacerlo, usamos la palabra clave await. Al usar esa palabra clave, esperamos a que termine la ejecución de cada auxiliar asíncrono primero.
Nuestra primera acción de importancia es: await visit("/admin/plugins/purple-tentacle");. Esto le indica a nuestra prueba que navegue a esa URL en nuestra aplicación. Esa URL era la que mostraba el tentáculo.
Después de visitar la página donde aparece el botón del tentáculo púrpura, queremos verificar si podemos ver que el botón existe en la página y que la imagen del tentáculo aún no existe.
Eso se hace mediante las siguientes afirmaciones:
assert.ok(exists("#show-tentacle"), "it shows the purple tentacle button");
assert.ok(!exists(".tentacle"), "the tentacle is not shown yet");
P.D. la versión anterior del complemento purple-tentacle no tenía el id de elemento #show-tentacle en la plantilla de handlebars. ¡Consulta la última versión para seguir el tutorial!
Una vez que esas pruebas pasen, es momento de probar la interacción.
El siguiente comando es await click('#show-tentacle'); que le indica a nuestro marco de pruebas que queremos hacer clic en el botón y mostrar el tentáculo.
Después de simular un clic en el botón, podemos verificar si aparece el tentáculo afirmando:
assert.ok(exists(".tentacle"), "the tentacle wants to rule the world!");
¿No está tan mal, verdad? Puedes probar la prueba tú mismo visitando http://localhost:3000/tests?qunit_single_plugin=purple-tentacle&qunit_skip_core=1 en tu máquina de desarrollo. Deberías ver muy rápidamente aparecer el tentáculo púrpura y todas las pruebas pasarán.
Si deseas ejecutar las pruebas qunit del complemento en la línea de comandos usando PhantomJS, puedes ejecutar
rake plugin:qunit['purple-tentacle']
(donde purple-tentacle es el nombre de la carpeta de tu complemento)
Depurando tus pruebas
A medida que escribes tus complementos, tus pruebas pueden ayudarte a identificar problemas en tu complemento. Cuando estás desarrollando tus pruebas o si haces cambios en el código de tu complemento, las pruebas pueden fallar. Para ayudar a entender por qué, Ember tiene algunos auxiliares útiles: pauseTest() y resumeTest().
Para aprovecharlos, agrega await pauseTest() dentro de tu código de prueba donde quieras que la prueba se pause. Ahora, cuando ejecutes tu prueba en el navegador, la prueba se pausará automáticamente en el punto donde agregaste pauseTest(). Esto te dará la oportunidad de inspeccionar la página o ver cualquier error para ayudar a depurar problemas.
Hacia dónde ir desde aquí
Odio sonar como un disco rayado, pero la documentación de Ember sobre pruebas es excelente. También podrías querer ver cómo Discourse prueba varias funcionalidades navegando por las pruebas en nuestro directorio de pruebas de JavaScript. Tenemos bastantes ejemplos ahí de los cuales puedes aprender.
¡Felices pruebas!
Más en la serie
Parte 1: Conceptos básicos de complementos
Parte 2: Enclaves de complementos
Parte 3: Configuraciones del sitio
Parte 4: Configuración de git
Parte 5: Interfaces de administración
Parte 6: Este tema
Parte 7: Publica tu complemento
Este documento está controlado por versiones - sugiere cambios en github.
it is an Admin page
)