PT AI

Для того, чтобы запускать сканирования Positive Technologies Application Inspector (PT AI) из Шерлока необходимо настроить взаимосвязь между репозиторием в Шерлоке и проектом в PT AI.
После этого функционал запуска сканирования будет доступен на странице с таблицей ИБ-дефектов.

к сведению

Соотношение репозиториев настраивается для конкретных веток. Запустить сканирование ветки, для которой отсутствует настройка не получится.
Таким образом, для запуска сканирования main и develop веток из Шерлока необходимо подключить несколько проектов из PT AI (для версия < 5.0).
Если используется версия PT AI > 5.0, то Шерлок позволяет синхронизировать ветки между своими репозиториями и проектами в PT AI.

Подготовительная работа

Перед тем, как настраивать взаимосвязь между репозиторием Шерлока и проектом PT AI необходимо убедиться, что настроена системная интеграция между Шерлоком и PT AI.

Подключение проекта PT AI

Допускается использовать как существующие проекты PT AI для анализа, так и создавать новые проекты в сканере непосредственно из Шерлока.

Создание проекта в PT AI из Шерлока

1. Для создания проекта в PT AI из Шерлока необходимо, находясь в репозитории, нажать на Меню действий () и выбрать Сканирование в SCM.

2. Найти необходимую интеграцию с PT AI в разделе Можно подключить и нажать кнопку Подключить.

3. Выбрать вариант Новый проект в сканере.

   

4. Заполнить необходимые параметры в открывшемся окне:

   • Название проекта: название проекта, который будет создан в PT AI;

   • Ветка: ветка проекта, которую необходимо проанализировать;

   • Запустить сканирование после создания проекта: выбрать этот вариант, если это требуется.

     к сведению

     При создании проекта из Шерлока по умолчанию:

     • Подключены все методы «Белого ящика»;
     • Анализ «Чёрного ящика» не используется;
     • Языки программирования определяются автоматически.

5. Нажать кнопку Подключить. В случае успеха Шерлок оповестит о том, что подключение настроено и можно продолжать работу.

Использование существующего проекта PT AI

1. Для использования существующего проекта в PT AI из Шерлока необходимо, находясь в репозитории, нажать на Меню действий () и выбрать Сканирование в SCM.

2. Найти необходимую интеграцию с PT AI в разделе Можно подключить и нажать кнопку Подключить.

3. Выбрать вариант Существующий.

   

4. Заполнить необходимые параметры в открывшемся окне:

   • ProjectID или ссылка на проект в PT AI: ссылка на проект или уникальный идентификатор проекта в PT AI

5. Нажать кнопку Подключить. В случае успеха Шерлок оповестит о том, что подключение настроено и можно продолжать работу.

Изменение подключения

1. Для изменения подключения необходимо нажать на Меню действий (), расположенное рядом с подключением, которое необходимо изменить, и выбрать Изменить ().

   
   к сведению

   При изменении подключения можно указать альтернативную ссылку на проект или уникальный идентификатор проекта в PT AI.

2. Нажать кнопку Сохранить после внесения необходимых изменений. В случае успеха Шерлок оповестит о том, что подключение изменено и можно продолжать работу.

Отключение подключения

1. Для отключения подключения необходимо нажать на Меню действий (), расположенное рядом с подключением, которое необходимо отключить, и выбрать Отключить ().

   

2. В открывшейся форме нажать кнопку Отключить. В случае успеха Шерлок оповестит о том, что подключение отключено и можно продолжать работу.

   внимание

   Сканирование в SCM с использованием PT AI для конкретной ветки, что была использована при настройке подключения, будет невозможно в случае отключения подключения.

Синхронизация веток

к сведению

Функционал доступен только при использовании PT AI версии 5.0 и выше.

Шерлок позволяет синхронизировать ветки между собственным проектом и проектом в PT AI в ручном режиме. Для этого необходимо нажать на Меню действий (), расположенное рядом с настроенным подключением, и выбрать Синхронизировать ().

Запуск сканирования

Для запуска сканирования PT AI необходимо, находясь в таблице ИБ-дефектов репозитория, нажать кнопку Сканировать () и выбрать PT Application Inspector (SAST) из предложенных вариантов.

Отмена сканирования

1. Для отмены сканирования PT AI необходимо, находясь в таблице ИБ-дефектов репозитория, нажать кнопку Сканировать (), найти запущенное сканирование PT AI (SAST) и нажать на иконку отмены ().

   

2. Указать причину отмены сканирования в открывшемся окне.

3. Нажать кнопку Да, остановить. В случае успеха Шерлок оповестит о том, что сканирование остановлено и можно продолжать работу.