Exponenta Banner
exponenta event banner

Настройка метрик полиспейса

Примечание

Для упрощения совместной работы используйте Polyspace ® Code Prover™ Access™. В дополнение к более интуитивно понятной веб-панели управления, с помощью Polyspace Access можно:

  • Просмотр и обоснование результатов непосредственно из веб-браузера.

  • Интеграция инструмента отслеживания дефектов, такого как Jira, с веб-интерфейсом и создание билетов для отслеживания результатов Polyspace.

  • Обмен результатами анализа с помощью веб-ссылок.

Дополнительные сведения см. в документации по доступу к программе проверки кода Polyspace.

Polyspace Metrics - это веб-панель управления, которая генерирует метрики качества кода на основе результатов проверки. С помощью этой панели мониторинга можно выполнять следующие действия:

  • Предоставьте руководству общий обзор качества кода.

  • Сравните качество кода с предварительно определенными стандартами.

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

  • Отслеживание улучшений или регрессии качества кода с течением времени.

В этом разделе показано, как настроить сервер показателей Polyspace для хранения результатов Polyspace.

Требования к метрикам пространства

Параметры Polyspace можно использовать для:

  • Сохранить результаты Polyspace.

  • Оценка и мониторинг показателей качества программного обеспечения на основе этих результатов.

Требуется компьютер, который выступает в качестве сервера и содержит интерфейс Polyspace Metrics. Результаты с нескольких клиентских рабочих станций можно загрузить в интерфейс Polyspace Metrics.

В этой таблице перечислены требования к метрикам Polyspace.

МестоположениеЗадачаТребования
Клиентские настольные ПК

Клиентские настольные компьютеры:

  • Запустите Polyspace и загрузите результаты на сервер.

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

Необходимо установить Finder™ ошибки Polyspace и/или средство проверки кода Polyspace.

Сервер

Сервер:

  • Запускает службу показателей Polyspace.

  • Хосты загружают результаты с сервера, вычисляют и отображают метрики качества. Можно загрузить адрес сервера и просмотреть метрики.

Необходимо установить средство поиска ошибок Polyspace и/или средство проверки кода Polyspace.

Однако для запуска службы показателей Polyspace активация не требуется.

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

Настройка и запуск сервера метрик Polyspace

В этом разделе показано, как запустить хост-сервер для метрик Polyspace. После выполнения этого шага необходимо также настроить параметры клиентской стороны таким образом, чтобы пользовательский интерфейс на рабочих столах Polyspace мог взаимодействовать с сервером Metrics.

  1. В интерфейсе пользователя Polyspace выберите Сервис > Параметры сервера показателей.

    Либо выполните следующую команду:

    polyspaceroot\polyspace\bin\polyspace-server-settings.exe

    Здесь, polyspaceroot является папкой установки Polyspace, например, C:\Program Files\Polyspace\R2021a.

  2. В разделе Параметры параметров полиспейса (Polyspace Metrics Settings) укажите следующую информацию:

    • Имя пользователя, используемое для запуска службы - имя пользователя.

    • Пароль - пароль (только для Windows ®).

    • Порт связи - номер порта связи Polyspace (по умолчанию 12427). Этот номер должен совпадать с номером порта связи, указанным в настройках интерфейса Polyspace. См. раздел Настройка клиентской стороны.

    • Папка, в которой будут храниться данные анализа - репозиторий результатов для сервера Polyspace Metrics.

    Если необходимо запустить Polyspace Metrics как службу, выберите Установить как службу. Если выбран этот вариант, то при каждом перезапуске компьютера автоматически запускается служба Polyspace Metrics. Нет необходимости явно запускать службу Metrics. Однако при использовании этого параметра запуск сервера может потребовать дополнительных привилегий, например, корневых привилегий в Linux ®.

  3. Чтобы запустить сервер показателей Polyspace, щелкните Пуск сервера.

Программа сохраняет информацию, указанную в окне Настройки сервера метрик (Metrics Server Settings), в следующем файле:

  • В системе Windows \%APPDATA%\Polyspace_RLDatas\polyspace.conf\polyspace.conf.

  • В системе Linux /etc/Polyspace/polyspace.conf

Этот файл можно редактировать непосредственно для определенных целей. Например, Polyspace Metrics использует Tomcat 8.0.22 для запуска пользовательского интерфейса Metrics. Чтобы указать собственную версию Tomcat, добавьте в этот файл следующую строку: 

tomcat_install_dir = tomcat_path
Здесь, tomcat_path путь к установке Tomcat (в Windows - значение переменной среды) CATALINA_HOME).

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

  • Окна: perl polyspaceroot\toolbox\polyspace\psdistcomp\bin\setup-polyspace-cluster.pl

  • Linux: ./polyspaceroot/toolbox/polyspace/psdistcomp/bin/setup-polyspace-cluster

Здесь, polyspaceroot является папкой установки Polyspace, например, C:\Program Files\Polyspace\R2021a. Для получения дополнительных сведений об использовании команд используйте -h вариант.

Настройка клиентской стороны

После настройки сервера метрик Polyspace необходимо задать параметры на стороне клиента, чтобы интерфейс Polyspace мог взаимодействовать с сервером Metrics.

  1. Выберите «Сервис» > «Установки».

  2. Перейдите на вкладку Конфигурация сервера.

  3. Выберите Использовать метрики пространства (Use Polyspace Metrics).

    Укажите следующую информацию:

    1. Если необходимо, чтобы Polyspace обнаруживал сервер в сети, использующий порт 12427 (номер порта по умолчанию), нажмите кнопку Автоматически обнаруживать сервер показателей Polyspace.

    2. Если для сервера Metrics используется другой номер порта или требуется указать имя сервера, нажмите кнопку Использовать следующий сервер и порт. Введите имя сервера или IP-адрес и номер порта связи.

      Необходимо указать один и тот же номер порта связи для всех клиентов, использующих службу Polyspace Metrics.

  4. В разделе настройки веб-интерфейса Polyspace Metrics выполните следующие действия.

    1. Укажите порт, используемый для загрузки результатов, по умолчанию - 12428. При изменении этого номера порта необходимо также изменить его на стороне сервера.

    2. Укажите протокол для использования HTTP или HTTPS. Если для веб-протокола выбран HTTPS, существуют дополнительные шаги по настройке веб-сервера Metrics для HTTPS.

    3. Укажите номер порта веб-сервера для выбранного протокола. Номера портов по умолчанию:

      • HTTP - 8080

      • HTTPS - 8443

      При изменении номера порта по умолчанию необходимо настроить тот же номер порта для сервера Polyspace Metrics. См. раздел Настройка и запуск сервера метрик Polyspace.

  5. В разделе Параметры загрузки и выгрузки:

    • Параметры загрузки - после просмотра результатов из репозитория Metrics можно загрузить комментарии и обоснования обратно в репозиторий с помощью команды Metrics > Upload to Metrics.

      Если вы хотите, чтобы Polyspace автоматически загружал ваши обоснования в Polyspace Metrics при сохранении, выберите Загрузить обоснования автоматически в хранилище Polyspace Metrics....

    • Параметры загрузки - при щелчке элемента для просмотра в Полиспейс (Polyspace Metrics) Полиспейс загружает результаты и открывает их в среде Полиспейс (Polyspace). Выберите место для загрузки результатов измерений Polyspace:

      • В папку проекта или, если проект не существует, папку по умолчанию.

      • Каждый раз спрашивайте, где скачать результаты.

Для просмотра параметров Polyspace в адресной строке веб-браузера введите:

protocol://ServerName:WSPN

  • protocol является http или https.

  • ServerName - это имя или IP-адрес сервера Polyspace Metrics.

  • WSPN номер порта веб-сервера, по умолчанию 8080 или 8443.

Настройка веб-сервера для HTTPS

По умолчанию передача данных между настольными продуктами Polyspace и веб-интерфейсом Polyspace Metrics не шифруется. Можно включить HTTPS для веб-протокола, который шифрует передачу данных. Чтобы настроить HTTPS, необходимо изменить конфигурацию сервера и настроить хранилище ключей для сертификата HTTPS.

Перед запуском следующей процедуры необходимо выполнить команды Настроить и запустить сервер параметров Polyspace и Настроить клиентскую сторону.

Чтобы настроить HTTPS-доступ к метрикам Polyspace:

  1. Откройте диалоговое окно Настройки сервера метрик, как указано в разделе Настройка и запуск сервера метрик Polyspace.

  2. Щелкните Остановить сервер. Программное обеспечение останавливает службы Polyspace Metrics. Теперь можно вносить изменения, необходимые для HTTPS.

  3. Открыть файл metricsRootFolder\tomcat\conf\server.xml в текстовом редакторе. Здесь, metricsRootFolder - это имя, указанное для папки, в которой будут храниться данные анализа. Найдите следующий текст:

    <!-
  <Connector port="8443" SSLEnabled="true" scheme="https" 
  secure="true" clientAuth="false" sslProtocol="TLS" 
  keystoreFile="<datadir>/.keystore" keystorePass="polyspace"/>
->

    Если текст отсутствует в вашем server.xml файл:

    1. Удалить весь ..\conf\ папка.

    2. В диалоговом окне Параметры сервера Metrics перезапустите службы, щелкнув Пуск сервера.

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

    conf папка регенерируется, включая server.xml файл. Файл теперь содержит текст, необходимый для настройки веб-сервера HTTPS.

  4. Следуйте комментированным инструкциям в server.xml для создания хранилища ключей для сертификата HTTPS.

  5. В диалоговом окне Параметры сервера Metrics (Metrics Server Settings), чтобы перезапустить службу Polyspace Metrics с изменениями, нажмите кнопку Запустить сервер (Start Server).

Для просмотра параметров Polyspace в адресной строке веб-браузера введите:

https://ServerName:WSPN

  • ServerName - это имя или IP-адрес сервера Polyspace Metrics.

  • WSPN - номер порта веб-сервера.

Изменение номера порта веб-сервера для сервера метрик

При изменении или указании нестандартного значения для номера порта веб-сервера клиента Polyspace Code Prover необходимо вручную настроить такое же значение для сервера Polyspace Metrics.

  1. Выберите «Метрики» > «Параметры сервера метрик».

  2. В диалоговом окне «Параметры сервера метрик» выберите «Остановить сервер», чтобы остановить демон сервера «Polyspace Metrics».

  3. В metricsRootFolder\tomcat\conf\server.xml, отредактируйте port атрибут Connector элемент для протокола веб-сервера. Здесь, metricsRootFolder - это имя, указанное для папки, в которой будут храниться данные анализа при настройке параметров Polyspace.

    • Для HTTP: 

      <Connector port="8080"/>

    • Для HTTPS: 

        <Connector port="8443" SSLEnabled="true" scheme="https" 
  secure="true" clientAuth="false" sslProtocol="TLS" 
  keystoreFile="<datadir>/.keystore" keystorePass="polyspace"/>

  4. В том же файле отредактируйте port атрибут Server элемент для протокола веб-сервера.

    <Server port="8005" shutdown="SHUTDOWN">

  5. В диалоговом окне Настройки сервера Metrics выберите Пуск сервера, чтобы перезапустить сервер с новыми номерами портов.

  6. На панели инструментов «Полиспейс» выберите «Сервис» > «Установки».

  7. На вкладке Конфигурация сервера измените номер порта веб-сервера в соответствии с новым значением port атрибут в Connector элемент.

Связанные темы

Документация по программе проверки кода Polyspace

Поддержка