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 utiliza una suite de pruebas basada en rspec. Para la aplicación en el navegador, contamos con una suite de qunit que incluye ember-testing.
Suponiendo que ya tienes configurado un entorno de desarrollo, 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 en 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 las pruebas según el complemento en el que estés trabajando. Puedes hacerlo en la interfaz haciendo clic en el menú desplegable Plugin y seleccionando tu complemento:
Añadir una prueba de aceptación en tu complemento
En primer lugar, asegúrate de tener la última versión de Discourse descargada. La posibilidad de ejecutar pruebas de aceptación desde complementos es una funcionalidad relativamente nueva; si no descargas 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.
Añadir una prueba de aceptación es tan fácil como añadir 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 resultar un poco confusa si nunca has escrito una prueba de aceptación antes. Te recomiendo encarecidamente que leas la documentación de Ember sobre las pruebas de aceptación, ya que contienen mucha información útil.
En cada prueba que escribamos, 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 que se realizarán antes de hacer una afirmación. Para ello, utilizamos la palabra clave await. Al usar esa palabra clave, esperamos a que termine la ejecución de cada ayuda asíncrona.
Nuestra primera acción importante es: await visit("/admin/plugins/purple-tentacle");. Esto le indica a nuestra prueba que navegue a esa URL en nuestra aplicación. Esa era la URL que muestra el tentáculo.
Después de visitar la página donde aparece el botón del tentáculo púrpura, queremos comprobar si el botón existe en la página y si la imagen del tentáculo aún no existe.
Esto se logra 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 #show-tentacle en la plantilla handlebars. ¡Descarga la última versión para seguir el ejemplo!
Una vez que esas pruebas pasen, es hora de probar la interacción.
El siguiente comando es await click('#show-tentacle');, que le indica a nuestro framework 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 comprobar si el tentáculo aparece afirmando lo siguiente:
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?target=purple-tentacle en tu máquina de desarrollo. Deberías ver aparecer el tentáculo púrpura muy rápido y todas las pruebas pasarán.
Si quieres ejecutar las pruebas qunit del complemento desde la línea de comandos, puedes ejecutar
bin/qunit --target purple-tentacle
(añade --standalone si tu servidor de desarrollo no está en ejecución)
(donde purple-tentacle es el nombre de la carpeta de tu complemento)
Depurar tus pruebas
Mientras escribes tus complementos, tus pruebas pueden ayudarte a identificar problemas en ellos. Cuando estés desarrollando tus pruebas o si realizas cambios en el código de tu complemento, las pruebas pueden fallar. Para ayudar a entender por qué, Ember tiene algunas ayudas útiles: pauseTest() y resumeTest().
Para hacer uso de ellas, añade await pauseTest() dentro del código de tu prueba en el punto donde quieras que se detenga. Ahora, cuando ejecutes tu prueba en el navegador, la prueba se detendrá automáticamente en el punto donde añadiste pauseTest(). Esto te dará la oportunidad de inspeccionar la página o ver cualquier error para ayudarte a depurar problemas.
Qué hacer a continuación
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 diversas funcionalidades explorando las pruebas en nuestro directorio de pruebas de JavaScript. Tenemos bastantes ejemplos allí de los que aprender.
¡Feliz prueba!
Más en la serie
Parte 1: Fundamentos de los complementos
Parte 2: Enchufes 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: Publicar tu complemento
Este documento está controlado por versiones - sugiere cambios en github.


