Написание тестов приемки для Ember-кода в Discourse

Автоматизированные тесты — это отличный способ защитить ваш код от будущих регрессий. Многие знают, как это делать в кодовой базе Rails с помощью rspec, но для некоторых тестирование на стороне JavaScript может быть somewhat загадочным.

К счастью, сегодня добавить базовые тесты в ваш код на Ember довольно просто!

Для тестов компонентов см. Тесты компонентов.

Приёмочные тесты

Приёмочные тесты часто проще писать, и они могут быть мощнее тестов компонентов, так как проверяют ваше приложение так же, как это сделал бы пользователь в браузере. Я часто начинаю с приёмочных тестов, а затем, если создаю сложный компонент, добавляю тесты и для него.

Вот как мы можем написать приёмочный тест, который посетит маршрут /admin/snack и подтвердит, что закуска была отрендерена:

test/javascripts/acceptance/snack-test.js

import { acceptance } from "helpers/qunit-helpers";
acceptance("Snack");

test("Visit Page", function (assert) {
  visit("/admin/snack");
  andThen(() => {
    assert.ok(exists(".fancy-snack-title"), "the snack title is present");
  });
});

Метод test() в данном случае почти читается как английский язык! Первая команда говорит перейти по URL /admin/snack. После этого следует метод andThen(). Этот метод необходим для того, чтобы убедиться, что все фоновые задачи завершены, прежде чем тесты продолжатся. Поскольку код JavaScript и Ember является асинхронным, нам нужно убедиться, что Ember закончил все необходимые действия, прежде чем будут выполнены наши утверждения. Наконец, тест проверяет, присутствует ли элемент .fancy-snack-title.

Однако, если вы запустите этот тест, посетив URL /qunit?module=Acceptance%3A%20Snack, вы обнаружите, что тест завершится ошибкой из-за ошибки AJAX.

Если вы помните, наш код включает как часть на Rails, так и часть на JavaScript, которая выполняла AJAX-запрос для получения данных. Приёмочный тест запустил часть JavaScript, но не знал, что делать, чтобы получить данные от Rails.

Чтобы это исправить, нам нужно добавить фиктивный ответ, используя отличную библиотеку pretender. Откройте файл test/javascripts/helpers/create-pretender.js и найдите строку:

this.get("/admin/plugins", () => response({ plugins: [] }));

Сразу под ней добавьте строку, которая вернёт фиктивный объект закуски для работы нашего приёмочного теста:

this.get("/admin/snack.json", () => {
  return response({ name: "snack name", description: "snack description" });
});

Приведённый выше код можно прочитать как «для любого запроса к /admin/snack.json отвечать следующим response».

Если вы обновите URL /qunit?module=Acceptance%3A%20Snack, ваш приёмочный тест получит данные через pretender, и тесты должны пройти.

Что делать дальше

Вы можете попробовать разработать небольшую функциональность и добавить тесты, чтобы убедиться, что она работает. Вы даже можете попробовать использовать TDD, создав тесты до написания какого-либо кода на фронтенде. В зависимости от того, над чем вы работаете, и ваших личных предпочтений, вам может оказаться, что это более приятный способ действовать. Удачи и хорошего кодинга :slight_smile:


Этот документ имеет контроль версий — предлагайте изменения на GitHub.

15 лайков

My prior experience in writing qunit tests was based on the other howto

i.e. “acceptance” was simply

acceptance("Purple Tentacle", { loggedIn: true });

I have seen in other plugins where the test code contained “fake” JSON to test against. I wasn’t sure if that would be as good as testing against “real” data, so I wanted to avoid doing it that way.

The six tests passed, but I got a couple of rather angry looking “unhandled request” errors.

After finding an example of some “setup” code, I tried it and it solved the errors.

It works, but I’m not really sure why, nor why it’s needed for some but not for the majority of plugins I’ve seen that have qunit tests.

3 лайка

For a long time we weren’t great with testing plugins, so not many people followed our example and added tests.

You are right to add a response using pretender to handle AJAX calls.

4 лайка

Просто заметка: путь /qunit устарел. Теперь это /tests. Мне потребовалось некоторое время, чтобы разобраться :slight_smile:

1 лайк