Exponenta Banner

Настройте метрики Polyspace

Примечание

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

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

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

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

Для получения дополнительной информации см. документацию Polyspace Bug Finder Access.

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

  • Предоставьте вашему руководству высокоуровневый обзор качества вашего кода.

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

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

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

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

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

Можно использовать Polyspace Metrics для:

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

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

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

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

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

Клиентские рабочие столы:

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

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

Необходимо установить Polyspace Bug Finder и/или Polyspace Code Prover™.

Сервер

Сервер:

  • Запускает сервис Polyspace Metrics.

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

Необходимо установить Polyspace Bug Finder и/или Polyspace Code Prover.

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

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

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

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

  1. В пользовательском интерфейсе Polyspace выберите Tools > Metrics Server Settings.

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

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

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

  2. В разделе Polyspace Metrics Settings укажите следующую информацию:

    • User name used to start the service - Ваше имя пользователя.

    • Password - Ваш пароль (Windows® только).

    • Communication port - номер порта связи Polyspace (по умолчанию 12427). Этот номер должен совпадать с номером коммуникационного порта, заданным в настройках Polyspace Interface. См. «Настройка клиентской стороны».

    • Folder where analysis data will be stored - репозиторий результатов для сервера Polyspace Metrics.

    Если вы хотите запустить Polyspace Metrics как сервис, выберите Install as service. Если вы выбираете эту опцию, служба Polyspace Metrics запускается автоматически каждый раз, когда вы перезагружаете компьютер. Вы не должны явно запускать службу Metrics. Однако, когда вы используете эту опцию, запуск сервера может потребовать дополнительных привилегий, например, root-привилегий в Linux®.

  3. Чтобы запустить сервер Polyspace Metrics, нажмите Start Server.

Информация, заданная в окне 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 опция.

Сконфигурируйте клиентскую сторону

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

  1. Выберите Tools > Preferences.

  2. Перейдите на вкладку Server Configuration.

  3. Выберите Use Polyspace Metrics.

    Укажите следующие сведения:

    1. Если вы хотите, чтобы Polyspace обнаружил сервер в сети, который использует порт 12427 (номер порта по умолчанию), нажмите Automatically detect the Polyspace Metrics Server.

    2. Если для сервера Metrics используется другой номер порта или необходимо указать имя сервера, нажмите кнопку Use the following server and port. Введите имя сервера или IP-адрес и номер коммуникационного порта.

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

  4. В разделе Polyspace Metrics web interface configuration:

    1. Задайте Port used to download results, по умолчанию это 12428. Если вы измените этот номер порта, необходимо также изменить его на стороне сервера.

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

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

      • HTTP - 8080

      • HTTPS - 8443

      Если вы измените номер порта по умолчанию, необходимо сконфигурировать тот же номер порта для сервера Polyspace Metrics. См. «Настройка и запуск сервера Metrics Polyspace».

  5. В разделе Upload and download settings:

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

      Если вы хотите, чтобы Polyspace автоматически загрузил ваши обоснования в Polyspace Metrics при сохранении, выберите Upload justifications automatically in the Polyspace Metrics repository....

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

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

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

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

protocol://ServerName:WSPN

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

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

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

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

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

Прежде чем вы начнете следующую процедуру, необходимо завершить настройку и запуск Polyspace Metrics Server и Configure Client Side.

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

  1. Откройте диалоговое окно Metrics Server Settings, как указано в Configure и Start Polyspace Metrics Server.

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

  3. Откройте файл metricsRootFolder\ tomcat\conf\server.xml в текстовом редакторе. Здесь, metricsRootFolder - имя, заданное для Folder where analysis data will be stored. Проверьте следующий текст:

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

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

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

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

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

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

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

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

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

https://ServerName: WSPN

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

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

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

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

  1. Выберите Metrics > Metrics Server Settings.

  2. В диалоговом окне Metrics Server Settings выберите Stop Server, чтобы остановить демон сервера Polyspace Metrics.

  3. В metricsRootFolder\ tomcat\conf\server.xml, отредактируйте port атрибут Connector элемент для протокола веб-сервера. Здесь, metricsRootFolder - имя, заданное для Folder where analysis data will be stored при настройке Polyspace Metrics.

    • Для 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 Server Settings выберите Start Server, чтобы перезапустить сервер с новыми номерами портов.

  6. На панели инструментов Polyspace выберите Tools > Preferences.

  7. На вкладке Server Configuration измените Web server port number так, чтобы оно совпадало с вашим новым значением для port атрибут в Connector элемент.

Похожие темы

Документация Polyspace Bug Finder

Поддержка