Запуск тестов с GitHub Actions

Представьте, что вы внесли изменение в код и сразу узнали, не нарушило ли оно что-нибудь ещё. В этом сила автоматизированного тестирования в вашем конвейере CI!

Непрерывная интеграция (CI) заключается в частом объединении изменений кода в центральном репозитории. Автоматизированные тесты служат защитой этого процесса.

Они рано обнаруживают ошибки, быстро предоставляют обратную связь и повышают уверенность в каждом изменении кода.

Когда речь заходит об автоматизированных тестах, обычно выделяют два основных типа: модульные и интеграционные тесты.

• Модульные тесты: сосредоточены на небольших изолированных частях кода, например одной функции или методе. Они выполняются быстро и точно указывают на проблему.
• Интеграционные тесты: проверяют, правильно ли взаимодействуют друг с другом разные части системы, например код и база данных или API.

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

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

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

Это гарантирует единообразную проверку каждого изменения без ручных действий.

Для демонстрации мы воспользуемся простым проектом Java, управляемым с помощью Maven — популярного инструмента автоматизации сборки.

Maven помогает управлять зависимостями проекта, а также предоставляет команды для компиляции кода и запуска тестов.

В нашем проекте будут простой класс Java и соответствующий тест JUnit (концептуально).

Вот простой класс Java и базовый тест для проверки его работы. Для простоты мы имитируем модульный тест без полной настройки JUnit.

Метод main выполняет роль исполнителя тестов и проверяет, работает ли метод add ожидаемым образом.

Попробуйте запустить его, чтобы увидеть результат!

Теперь посмотрим, как будет выглядеть файл рабочего процесса GitHub Actions (.github/workflows/test.yml) для запуска наших тестов.

Этот файл YAML определяет шаги, которые GitHub Actions выполнит для настройки среды и запуска команд тестирования.

В настоящем проекте мы воспользуемся командой Maven test для запуска всех фактических тестов JUnit.

name: Java CI with Maven

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up JDK 17
        uses: actions/setup-java@v4
        with:
          java-version: '17'
          distribution: 'temurin'
          cache: maven
      - name: Run Maven Tests
        run: mvn test

Разберём основные шаги нашего рабочего процесса для тестирования:

• on: push / pull_request: запускает рабочий процесс при отправке кода или создании запросов на включение изменений в ветку main.
• runs-on: ubuntu-latest: указывает операционную систему виртуальной машины (исполнителя), на которой будет выполняться рабочий процесс.
• actions/checkout@v4: готовое действие, которое извлекает код репозитория на машину исполнителя.
• actions/setup-java@v4: ещё одно действие для настройки Java Development Kit (JDK) на машине исполнителя.
• run: mvn test: это ключевой шаг! Он выполняет команду Maven для компиляции кода и запуска всех определённых тестов.

Важное преимущество тестирования в CI — мгновенная обратная связь. Если какой-либо тест завершается с ошибкой, задание рабочего процесса GitHub Actions также завершается с ошибкой.

Это ясно показывает, что недавнее изменение кода привнесло ошибку или вызвало регрессию.

Затем можно изучить журналы рабочего процесса, чтобы точно определить, какой тест завершился с ошибкой и почему. Это поможет быстро устранить проблему.

Интеграция автоматизированных тестов в конвейер CI — один из основополагающих принципов современной разработки программного обеспечения.

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

Этот процесс повышает уверенность в кодовой базе и позволяет вашей команде быстрее и надёжнее внедрять новые решения.

Рассмотрим рабочий процесс GitHub Actions, предназначенный для запуска тестов. Каково основное назначение шага run: mvn test в проекте Java?

В этом уроке мы рассмотрели интеграцию автоматизированных тестов в конвейер CI на GitHub Actions.

Мы изучили:

• важность автоматизированного тестирования для качества кода;
• различия между модульными и интеграционными тестами;
• структуру рабочего процесса GitHub Actions для запуска тестов Java с помощью Maven;
• такие шаги рабочего процесса, как checkout и setup-java;
• важную роль mvn test при выполнении тестов;
• способ, которым GitHub Actions сообщает о сбоях тестов.

Автоматизированное тестирование крайне важно для раннего обнаружения ошибок и поддержания надёжной кодовой базы!