Thucydides StepListener отслеживание выполнения тестов

Интерфейс net.thucydides.core.steps.StepListener представляет собой класс, прослушивающий ход выполнения теста и получающий данные или результаты в определенных точках его выполнения. StepListener получает информацию от Thucydides на уровне выполнения самих тестовых методов и их шагов (stepStarted, stepIgnored, stepFailed и т.д.). Thucydides использует этот интерфейс для собственных нужд, но также предоставляет нам возможность создать и зарегистрировать свой собственный listener. Для этого нужно реализовать в классе интерфейс net.thucydides.core.steps.StepListener и зарегистрировать его в Thucydides:

import net.thucydides.core.model.Story;
import net.thucydides.core.model.TestOutcome;
import net.thucydides.core.steps.ExecutedStepDescription;
import net.thucydides.core.steps.StepFailure;
import net.thucydides.core.steps.StepListener;
 
public class MyProjectStepListener implements StepListener {
 
    public void skippedStepStarted(ExecutedStepDescription arg0) {
         
    }
 
    public void stepFailed(StepFailure arg0) {
         
    }
 
    public void stepFinished() {
         
    }
 
    public void stepIgnored() {
         
    }
 
    .
    .
    .
}

Регистрацию MyProjectStepListener можно осуществить двумя способами:

1. Использовать метод registerListener(final StepListener listener) класса net.thucydides.core.steps.StepEventBus. Класс StepEventBus является своеобразным средством передачи соответствующих уведомлений о ходе выполнения теста всем зарегистрированным слушателям. StepEventBus использует внутри себя разделение на потоки, поэтому работа с ним осуществляется через статический метод getEventBus(), который возвращает экземпляр StepEventBus для текущего потока:

   MyProjectStepListener myProjectStepListener = 
                                               new MyProjectStepListener();
   StepEventBus.getEventBus().registerListener(myProjectStepListener);

   Отменить регистрации можно с помощью метода dropListener:

   StepEventBus.getEventBus().dropListener(myProjectStepListener);

   Основное преимущество этого способа заключается в том, что выполнять регистрацию или ее отмену можно в любой момент выполнения теста.

2. Установить класс MyProjectStepListener как сервис-провайдер (service provider) для интерфейса net.thucydides.core.steps.StepListener, тогда класс StepEventBus автоматически обнаружит слушателя и добавит его в список зарегистрированных. Пользовательские слушатели загружаются и регистрируется один раз во время запуска теста. Для того, чтобы установить Ваш класс в качестве сервис-провайдера, нужно расположить конфигурационный файл в директории

   META-INF/services

   Директория в свою очередь должна быть расположена в одной из src папок проекта (например, в src/main/java). Конфигурационный файл представляет собой обычный текстовый файл, имя которого является полным именем типа службы, в нашем случае это net.thucydides.core.steps.StepListener (следите за тем, чтобы у файла не было расширения .txt).
   
   Файл должен содержать список имен классов-провайдеров, реализующих методы интерфейса, каждый с новой строки. Для нашего примера в нем будет единственная строка с именем класса MyProjectStepListener:

   example.support.MyProjectStepListener
   

Помимо регистрации слушателей класс StepEventBus предоставляет несколько других полезных методов, например, aStepInTheCurrentTestHasFailed. Используя этот метод можно предотвратить выполнение нежелательных действий после того, как один из шагов закончился неудачно. Необходимость в этом может возникнуть, потому что Thucydides даже после падения одного из шагов, продолжает запускать последующие шаги на выполнение, блокируя обращение только к драйверу. В итоге получается, что сопутствующие действия, вроде записи в файл или изменения ресурсов, продолжают выполняются даже после того, как тест по сути провалился. Проверяя результат метода aStepInTheCurrentTestHasFailed можно запретить, например, выполнение дальнейших запросов к БД, которые после провала теста не представляют никакой ценности:

private static boolean isTestFailed() {
        return StepEventBus.getEventBus().aStepInTheCurrentTestHasFailed();
}