Введение в тестирование с Arquillian

12 февраля 2020 г. · 6 мин. чтения

1. Обзор

Arquillian — это среда тестирования интеграции, не зависящая от контейнера, для Jakarta EE. Использование Arquillian сводит к минимуму нагрузку на управление контейнерами, развертыванием, инициализацией фреймворка и т. д.

Мы можем сосредоточиться на написании реальных тестов, а не на начальной загрузке тестовой среды.

2. Основные концепции

2.1. Архивы развертывания

Существует простой способ тестирования нашего приложения при работе внутри контейнера.

Во- первых, класс ShrinkWrap предоставляет API для создания развертываемых файлов *.jar, *.war и *.ear .

Затем Arquillian позволяет нам настроить тестовое развертывание с помощью аннотации @Deployment для метода, который возвращает объект ShrinkWrap .

2.2. Контейнеры

Arquillian различает три различных типа контейнеров:

Удаленный — протестировано с использованием удаленного протокола, такого как JMX.
Управляемые — удаленные контейнеры, но их жизненным циклом управляет Arquillian.
Embedded — локальные контейнеры, в которых выполняются тесты по локальным протоколам.

Также мы можем классифицировать контейнеры по их возможностям:

Приложения Jakarta EE, развернутые на сервере приложений, таком как Glassfish или JBoss
Контейнеры сервлетов, развернутые на Tomcat или Jetty
Автономные контейнеры
OSGI-контейнеры

Он проверяет путь к классам среды выполнения и автоматически выбирает доступный контейнер.

2.3. Тестовое обогащение

Arquillian обогащает тесты, предоставляя, например, внедрение зависимостей, чтобы мы могли легко писать наши тесты.

Мы можем вводить зависимости с помощью @Inject , вводить ресурсы с помощью @Resource , сеансовые компоненты EJB с помощью @EJB и т. д.

2.4. Несколько тестовых прогонщиков

Мы можем создать несколько развертываний, используя аннотацию:

@Deployment(name="myname" order = 1)

Где имя — это имя файла развертывания, а параметр порядка — порядок выполнения развертывания, поэтому теперь мы можем запускать тесты на нескольких развертываниях одновременно, используя аннотацию:

@Test @OperateOnDeployment("myname")

Предварительный тест выполняется в контейнере развертывания myname в порядке, указанном в аннотации @Deployment .

2.5. Арквиллианские расширения

Arquillian предлагает несколько расширений на тот случай, если наши потребности в тестировании не покрываются основной средой выполнения. У нас есть постоянство, транзакции, клиент/сервер, расширения REST и т. д.

Мы можем включить эти расширения, добавив соответствующие зависимости в файлы конфигурации Maven или Gradle.

Обычно используемые расширения: Drone, Graphene и Selenium.

3. Зависимости и настройка Maven

Давайте добавим следующую зависимость в наш файл pom.xml :

<dependency>
    <groupId>org.jboss.arquillian</groupId>
    <artifactId>arquillian-bom</artifactId>
    <version>1.1.13.Final</version>
    <scope>import</scope>
    <type>pom</type>
</dependency>
<dependency>
    <groupId>org.glassfish.main.extras</groupId>
    <artifactId>glassfish-embedded-all</artifactId>
    <version>4.1.2</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.jboss.arquillian.container</groupId>
    <artifactId>arquillian-glassfish-embedded-3.1</artifactId>
    <version>1.0.0.Final</version>
    <scope>test</scope>
</dependency>

Последнюю версию зависимостей можно найти здесь: arquillian-bom , org.glassfish.main.extras , org.jboss.arquillian.container .

4. Простой тест

4.1. Создать компонент

Начнем с простого компонента. Мы не включаем сюда какую-либо расширенную логику, чтобы иметь возможность сосредоточиться на тестах:

public class Component {
    public void sendMessage(PrintStream to, String msg) {
        to.println(message(msg));
    }

    public String message(String msg) {
        return "Message, " + msg;
    }
}

Используя Arquillian, мы хотим проверить, правильно ли ведет себя этот класс при вызове в качестве компонента CDI.

4.2. Напишем наш первый аркиллианский тест

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

@RunWith(Arquillian.class)

Если мы собираемся запускать наши тесты внутри контейнера, нам нужно использовать аннотацию @Deployment .

Arquillian не использует весь путь к классам для изоляции тестового архива. Вместо этого он использует класс ShrinkWrap , который представляет собой Java API для создания архивов. Когда мы создаем архив для тестирования, мы указываем, какие файлы включать в путь к классам для использования теста. Во время развертывания ShrinkWrap изолирует только те классы, которые необходимы для теста.

С помощью метода addclass() мы можем указать все необходимые классы, а также добавить пустой ресурс манифеста.

JavaArchive.class создает макет веб-архива с именем test.war, этот файл развертывается в контейнере, а затем используется Arquillian для выполнения тестов : ``

@Deployment
public static JavaArchive createDeployment() {
    return ShrinkWrap.create(JavaArchive.class)
      .addClass(Component.class)
      .addAsManifestResource(EmptyAsset.INSTANCE, "beans.xml");
}

Затем внедряем наш компонент в тест:

@Inject
private Component component;

Наконец, мы выполняем наш тест:

assertEquals("Message, MESSAGE",component.message(("MESSAGE")));
 
component.sendMessage(System.out, "MESSAGE");

5. Тестирование корпоративных Java-бинов

5.1. Корпоративный Java-бин

С помощью Arquillian мы можем протестировать внедрение зависимостей Enterprise Java Bean, для этого мы создадим класс, который имеет метод для преобразования любого слова в нижний регистр:

public class ConvertToLowerCase {
    public String convert(String word){
        return word.toLowerCase();
    }
}

Используя этот класс, мы создаем класс без состояния для вызова созданного ранее метода:

@Stateless
public class CapsConvertor {
    public ConvertToLowerCase getLowerCase(){
        return new ConvertToLowerCase();
    }
}

Класс CapsConvertor внедряется в сервисный компонент:

@Stateless
public class CapsService {
 
    @Inject
    private CapsConvertor capsConvertor;
    
    public String getConvertedCaps(final String word){
        return capsConvertor.getLowerCase().convert(word);
    }
}

5.2. Протестируйте корпоративный Java-бин

Теперь мы можем использовать Arquillian для тестирования нашего корпоративного Java Bean, внедряя CapsService :

@Inject
private CapsService capsService;
    
@Test
public void givenWord_WhenUppercase_ThenLowercase(){
    assertTrue("capitalize".equals(capsService.getConvertedCaps("CAPITALIZE")));
    assertEquals("capitalize", capsService.getConvertedCaps("CAPITALIZE"));
}

Используя ShrinkWrap, мы обеспечиваем правильное подключение всех классов:

@Deployment
public static JavaArchive createDeployment() {
    return ShrinkWrap.create(JavaArchive.class)
      .addClasses(CapsService.class, CapsConvertor.class, ConvertToLowerCase.class)
      .addAsManifestResource(EmptyAsset.INSTANCE, "beans.xml");
}

6. Тестирование JPA

6.1. Упорство

Мы также можем использовать Arquillian для проверки сохраняемости. Во-первых, мы собираемся создать нашу сущность:

@Entity
public class Car {
 
    @Id
    @GeneratedValue
    private Long id;
 
    @NotNull
    private String name;

    // getters and setters
}

У нас есть таблица с названиями автомобилей.

Затем мы собираемся создать наш EJB для выполнения основных операций с нашими данными:

@Stateless
public class CarEJB {
 
    @PersistenceContext(unitName = "defaultPersistenceUnit")
    private EntityManager em;
 
    public Car saveCar(Car car) {
        em.persist(car);
        return car;
    }
 
    public List<Car> findAllCars() {
    Query query 
      = em.createQuery("SELECT b FROM Car b ORDER BY b.name ASC");
    List<Car> entries = query.getResultList();
    
    return entries == null ? new ArrayList<>() : entries;    
 
    public void deleteCar(Car car) {
        car = em.merge(car);
        em.remove(car);
    }
}

С помощью saveCar мы можем сохранить названия автомобилей в базе данных, мы можем сохранить все автомобили с помощью findAllCars, а также мы можем удалить автомобиль из базы данных с помощью deleteCar .

6.2. Проверьте настойчивость с Arquillian

Теперь мы можем выполнить некоторые базовые тесты с помощью Arquillian.

Во-первых, мы добавляем наши классы в наш ShrinkWrap:

.addClasses(Car.class, CarEJB.class)
.addAsResource("META-INF/persistence.xml")

Затем мы создаем наш тест:

@Test
public void testCars() {
    assertTrue(carEJB.findAllCars().isEmpty());
    Car c1 = new Car();
    c1.setName("Impala");
    Car c2 = new Car();
    c2.setName("Lincoln");
    carEJB.saveCar(c1);
    carEJB.saveCar(c2);
 
    assertEquals(2, carEJB.findAllCars().size());
 
    carEJB.deleteCar(c1);
 
    assertEquals(1, carEJB.findAllCars().size());
}

В этом тесте мы сначала создаем четыре экземпляра автомобиля и проверяем, что количество строк в базе данных такое же, как мы создали.

8. Заключение

В этом уроке мы:

представил основные концепции Arquillian
ввел компонент в тест Аркиллиана
протестировал EJB
проверенная настойчивость
выполнил тест Arquillian с использованием Maven

Вы можете найти код из статьи на Github .

1. Обзор​

2. Основные концепции​

2.1. Архивы развертывания​

2.2. Контейнеры​

2.3. Тестовое обогащение​

2.4. Несколько тестовых прогонщиков​

2.5. Арквиллианские расширения​

3. Зависимости и настройка Maven​

4. Простой тест​

4.1. Создать компонент​

4.2. Напишем наш первый аркиллианский тест​

5. Тестирование корпоративных Java-бинов​

5.1. Корпоративный Java-бин​

5.2. Протестируйте корпоративный Java-бин​

6. Тестирование JPA​

6.1. Упорство​

6.2. Проверьте настойчивость с Arquillian​

8. Заключение​