Интеграция Orbs Wallarm FAST в проект CircleCI

Данная инструкция описывает способ интеграции FAST в рабочий процесс CircleCI через Orbs (плагин) Wallarm FAST. Настройка интеграции выполняется в конфигурационном файле ~/.circleci/config.yml. Более подробная информация об использовании CircleCI Orbs описана в официальной документации CircleCI.

Требования

Если вы используете другую версию CircleCI или вам необходимо добавить этап записи запросов в рабочий процесс, ознакомьтесь с примером интеграции через FAST-ноду.

Шаг 1: Установка токена FAST-ноды

Передайте токен FAST-ноды в переменной окружения WALLARM_API_TOKEN в настройках проекта CircleCI. Способ настройки переменных окружения описан в документации CircleCI.

Определение переменной окружения для проекта CircleCI

Шаг 2: Подключение Orbs Wallarm FAST

Для подключения Orbs выполните следующие настройки в файле ~/.circleci/config.yml:

  1. Убедитесь, что в файле указана версия CircleCI 2.1:

     version: 2.1
    
  2. Инициализируйте плагин Wallarm FAST в блоке orbs:

     orbs:
         fast: wallarm/fast@1.1.0
    

Шаг 3: Настройка этапа тестирования безопасности приложения

Для настройки этапа тестирования безопасности, необходимо добавить отдельный шаг fast/run_security_tests в рабочий процесс CircleCI и определить следующие параметры для запуска тестирования:

Параметр Описание Обязательность
test_record_id Идентификатор набора базовых запросов, соответствует TEST_RECORD_ID.
По умолчанию: последний набор базовых запросов, записанный используемой FAST-нодой.
Да
app_host Адрес, по которому доступно тестируемое приложение (IP или имя домена).
По умолчанию: внутренний IP.
Нет
app_port Порт, на котором доступно тестируемое приложение.
По умолчанию: 80.
Нет
policy_id Идентификатор политики тестирования.
По умолчанию: [null]Default Test Policy.
Нет
stop_on_first_fail Флаг для прекращения тестирования при возникновении первой ошибки. Нет
test_run_name Имя запускаемого теста безопасности.
По умолчанию, имя будет сгенерировано автоматически на базе даты запуска.
Нет
test_run_desc Описание запускаемого теста безопасности. Нет
test_run_rps Ограничение на количество запросов, отправляемых приложению в секунду.
Возможные значения: от 0 до 1000.
По умолчанию: null (RPS не ограничено).
Нет
wallarm_api_host Адрес используемого API-сервера Валарм.
Возможные значения:
us1.api.wallarm.com — для американского облака;
api.wallarm.com — для европейского облака;
api.wallarm.ru — для российского облака.
По умолчанию: us1.api.wallarm.com.
Нет
wallarm_fast_port Порт, на котором должна быть запущена FAST-нода.
По умолчанию: 8080.
Нет
wallarm_version Версия плагина Wallarm FAST.
Список версией доступен по ссылке.
По умолчанию: latest.
Нет

Пример ~/.circleci/config.yml
version: 2.1
jobs:
  build:
    machine:
      image: 'ubuntu-1604:201903-01'
    steps:
      - checkout
      - run:
          command: >
            docker run -d --name app-test -p 3000:3000
            wallarm/fast-example-rails
          name: Run application
      - fast/run_security_tests:
          app_port: '3000'
          test_record_id: '9058'
orbs:
  fast: 'wallarm/fast@dev:1.1.0'

Больше примеров интеграции FAST в CircleCI доступно в нашем GitHub и CircleCI.

Если у вас возникли вопросы по интеграции FAST в ваш рабочий процесс CircleCI, обратитесь в службу поддержки Валарм.

results matching ""

    No results matching ""