Интеграция с Jenkins

Интеграция WebdriverIO с Jenkins позволяет автоматизировать процесс тестирования веб-приложений, повышая эффективность CI/CD (Continuous Integration/Continuous Deployment) процессов. Для этого необходимо настроить окружение таким образом, чтобы при каждом изменении в репозитории автоматически запускались тесты, что позволит оперативно обнаруживать ошибки и ускорит процесс разработки.

Подготовка окружения

Для начала требуется установить несколько зависимостей. Важно, чтобы на сервере Jenkins был установлен Node.js, так как WebdriverIO работает на базе JavaScript. Кроме того, для работы с WebdriverIO необходимы дополнительные пакеты и плагины, такие как:

  • WebdriverIO
  • Selenium или другой драйвер (например, ChromeDriver)
  • Jenkins-plugins для Node.js

После установки Node.js можно установить WebdriverIO и необходимые плагины. Для этого в терминале выполняется команда:

npm init -y
npm install webdriverio --save-dev
npm install @wdio/cli --save-dev

Для взаимодействия с Selenium или другими браузерными драйверами нужно будет установить соответствующие пакеты. Например:

npm install selenium-standalone --save-dev

Для автоматического запуска тестов в Jenkins необходимо также настроить сам сервер и создать соответствующие Jenkins-Job’ы.

Установка плагинов Jenkins

Для интеграции с WebdriverIO необходимо установить следующие плагины:

  1. NodeJS Plugin — для работы с Node.js на Jenkins.
  2. Pipeline Plugin — для создания сложных пайплайнов для тестов.
  3. JUnit Plugin — для генерации отчетов в формате JUnit, который можно будет использовать для анализа результатов тестирования.

После установки плагинов, необходимо настроить их через интерфейс Jenkins. В разделе «Управление Jenkins» выбирается «Настройка системы», и в разделе «NodeJS» необходимо указать путь к установленной версии Node.js.

Настройка WebdriverIO для Jenkins

После установки всех необходимых зависимостей и плагинов следует настроить WebdriverIO. Основная конфигурация WebdriverIO осуществляется через файл wdio.conf.js, в котором задаются все параметры запуска тестов: браузеры, тестовые фреймворки, репортеры, соединения с Selenium Grid и т.д.

Пример базовой конфигурации для запуска с Selenium:

exports.config = {
    runner: 'local',
    specs: ['./tests/**/*.js'],
    capabilities: [{
        maxInstances: 5,
        browserName: 'chrome',
        acceptInsecureCerts: true,
    }],
    logLevel: 'info',
    waitforTimeout: 10000,
    framework: 'mocha',
    reporters: ['spec', 'junit'],
    services: ['selenium-standalone'],
    mochaOpts: {
        ui: 'bdd',
        timeout: 60000,
    },
};

Конфигурация указывает путь к тестам, параметры браузера (например, Chrome), а также настройки фреймворка и репортеров. Важно помнить, что WebdriverIO поддерживает работу с несколькими браузерами одновременно, что позволяет параллельно запускать тесты в разных окружениях.

Настройка Jenkins Job

После того как WebdriverIO настроен, необходимо настроить Jenkins для запуска тестов автоматически. Для этого создается Jenkins Job, который будет запускать WebdriverIO каждый раз, когда будет происходить изменение в репозитории.

  1. Создается новый Jenkins Job с типом «Pipeline».
  2. В конфигурации этого Job’а необходимо указать шаги, которые будут запускать тесты. Пример конфигурации для файла Jenkinsfile:
pipeline {
    agent any

    environment {
        PATH = "${tool 'nodejs-14'}:${env.PATH}"
    }

    stages {
        stage('Install Dependencies') {
            steps {
                script {
                    sh 'npm install'
                }
            }
        }

        stage('Run Tests') {
            steps {
                script {
                    sh 'npx wdio wdio.conf.js'
                }
            }
        }

        stage('Publish Results') {
            steps {
                junit '**/test-results/**/*.xml'
            }
        }
    }
}

Этот Jenkinsfile содержит три этапа: установку зависимостей, запуск тестов и публикацию результатов. В этапе «Run Tests» происходит запуск команды для WebdriverIO. В этапе «Publish Results» выводятся результаты тестов в формате JUnit.

Важно убедиться, что на сервере Jenkins установлен правильный путь к Node.js, и он правильно настроен через плагин NodeJS, чтобы команда npm install и npx wdio выполнялись корректно.

Автоматизация тестов с использованием GitHub Webhooks

Для полной автоматизации процесса можно настроить вебхуки в GitHub (или в другом репозитории). Это позволит Jenkins автоматически запускать тесты при каждом коммите или Pull Request.

Для этого в настройках репозитория на GitHub необходимо активировать вебхук, указывая URL Jenkins, который будет слушать события. В Jenkins настраивается соответствующий плагин, чтобы он мог принимать эти запросы и запускать тесты. Важное требование — правильная настройка прав доступа и токенов безопасности для связи между GitHub и Jenkins.

Использование Docker для изоляции окружений

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

Для запуска WebdriverIO в Docker нужно создать Dockerfile, который будет содержать установку всех необходимых пакетов:

FROM node:14

WORKDIR /app
COPY package.json ./
RUN npm install

COPY . .
CMD ["npx", "wdio", "wdio.conf.js"]

Затем, в Jenkins можно настроить пайплайн с использованием Docker контейнера, что позволит запускать тесты в абсолютно идентичных окружениях, независимо от машины, на которой работает Jenkins.

Обработка результатов тестов

После выполнения тестов результаты можно обработать с помощью различных репортеров, например, JUnit Reporter или Allure Reporter, которые позволят генерировать красивые и подробные отчеты о тестировании.

В WebdriverIO конфигурации можно добавить репортер для JUnit:

reporters: [
    'spec',
    ['junit', {
        outputDir: './test-results',
        outputFileFormat: function (options) {
            return `results-${options.capabilities}.xml`;
        }
    }]
],

Репортер JUnit будет генерировать XML-файлы с результатами тестов, которые Jenkins может использовать для отображения информации о прошедших или не прошедших тестах.

Уведомления о статусе тестов

Важным аспектом является уведомление команды о статусе тестов. Для этого можно настроить уведомления в Jenkins, чтобы при успешном или неудачном прохождении тестов команда получала соответствующее оповещение. Используя плагины для Slack или электронной почты, можно легко настроить отправку уведомлений о статусе.

Пример настройки уведомлений для Slack в Jenkins:

post {
    success {
        slackSend channel: '#test-results', color: 'good', message: "Тесты прошли успешно!"
    }
    failure {
        slackSend channel: '#test-results', color: 'danger', message: "Тесты не прошли!"
    }
}

Такой подход позволяет оперативно реагировать на ошибки и быстро их исправлять.

Резюме

Интеграция WebdriverIO с Jenkins — это мощный инструмент для автоматизации тестирования веб-приложений в рамках CI/CD процессов. Правильная настройка окружения, Jenkins Job и обработка результатов тестов значительно ускоряют процесс разработки и повышают качество продукта.

Оглавление