Настройка приложения#

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

Параметры настройки#

Название параметра	Назначение параметра	Рекомендуемые значения параметра	Допустимый формат значений параметра
Server URL	Базовый URL сервера Platform V Works::CodeScanner	`http(s)://example.com`	Строка, валидный URL
User Token	Токен пользователя для аутентификации	`Автоматическая генерация`	Произвольная строка символов
Project Key	Уникальный идентификатор проекта	`code-scanner-project`	Латинские буквы, цифры, тире и подчеркивания
Max History Size	Максимальное количество исторических записей анализа	`100`	Целое положительное число
Notification Frequency	Частота отправки уведомлений	`daily`	daily, weekly, never
Backup Interval	Периодичность резервного копирования	`24h`	Формат длительности (часы, дни, минуты)

Порядок настройки#

Чтобы выполнить настройки, описанные в разделе Параметры настройки, выполните следующие действия:

Перейдите в браузер и введите URL вашего сервера CodeScanner (параметр Server URL).
Авторизуйтесь с использованием выданного вам токена (User Token).
Зайдите в раздел проектов и создайте новый проект с уникальным именем (Project Key).
Переходите в настройки вашего проекта и устанавливайте максимальное количество сохраняемых записей анализа (Max History Size).
Задайте частоту отправки уведомлений о результатах анализа (Notification Frequency).
Убедитесь, что установлено регулярное резервное копирование системы с необходимой частотой (Backup Interval).
Для запуска анализа воспользуйтесь нужным методом (через Maven, Gradle или другой инструмент) с указанными вами параметрами.
Посмотрите результаты анализа в соответствующем разделе панели инструментов, ознакомьтесь с отчетами и зафиксированными нарушениями.

Настройки получения уведомлений#

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

Browse (Просмотр). Пользователь должен обладать правом просмотра проекта, чтобы иметь доступ к настройкам уведомлений для этого проекта.
Issue Administration (Администрирование замечаний). Для настройки уведомлений, связанных с управлением замечаниями, пользователь должен иметь привилегию управления замечаниями.

Для настройки оповещений выполните следующие действия:

Перейдите в личный профиль пользователя — в правом верхнем углу нажмите значок пользователя и в контекстном меню выберите Мой аккаунт.
Перейдите в раздел Оповещения.
Выберите необходимые события в разделе Общие уведомления. В случае, если требуется настроить отправку уведомлений о событиях конкретного сканирования, в разделе Уведомления каждого сканирования нажмите кнопку Добавить сканирование. В поиске введите название сканирования и в выпадающем списке выберите нужное. Далее отметьте нужные события.

Токены в Platform V Works::CodeScanner#

Типы токенов#

В CodeScanner существует несколько типов токенов:

пользовательские токены;
токены анализа проекта;
токены глобального анализа.

Пользовательские токены#

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

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

Токены анализа проекта#

Токены анализа проекта позволяют выполнять анализ по конкретному проекту.

Для создания данного типа токена, пользователь должен иметь глобальное разрешение Execute Analysis или разрешение Execute Analysis для связанного с токеном проекта. Если у владельца токена не будет разрешения на выполнение анализа для связанного проекта, то выполнение анализа с использованием данного токена будет также невозможно.

Токены глобального анализа#

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

Для создания данного типа токена пользователь должен иметь глобальное разрешение Execute Analysis.

Если с владельца токена будет снято глобальное разрешение Execute Analysis, токен, соответственно, будет недействителен для выполнения анализа.

Генерация токена#

Новые токены могут быть сгенерированы в разделе Пользователь -> Мой аккаунт -> Безопасность. Форма генерации новых токенов с указанием типа расположена в верхней части страницы.

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

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

Отзыв токена#

Существующий токен можно отозвать в разделе Пользователь -> Мой аккаунт -> Безопасность нажатием кнопки Отозвать рядом с токеном.

Токены с истекшим сроком действия#

После истечения срока действия токена его использование невозможно. Токен по-прежнему будет отображаться в разделе Пользователь -> Мой аккаунт -> Безопасность, где его можно отозвать, как и любой другой токен.

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

Использование токена#

Пользовательские токены используются для авторизации в Platform V Works::CodeScanner в следующих сценариях:

при запуске анализа кода токен передается в качестве значения переменной sonar.login (предоставление пароля не требуется);
при вызове веб-сервисов токен передается в запросе, например curl --header 'Authorization: Bearer MY_TOKEN' https://{code_scanner-ipAddress}/api/user_tokens/search.

Можно использовать альтернативный метод c использованием токена, однако потребуется указать вместо пароля пустое значение: curl -u THIS_IS_MY_TOKEN: https://{code_scanner-ipAddress}/api/user_tokens/search. Для установки пустого значения пароля в запросе после значения токена необходимо поставить двоеточие.