Exponenta Banner

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

Примечание

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

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

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

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

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

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

  • Предоставьте вашему управлению общий обзор своего качества кода.

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

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

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

Эта тема показывает, как настроить Метрический сервер Polyspace, чтобы сохранить результаты Polyspace.

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

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

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

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

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

Эта таблица приводит требования для Метрик Polyspace.

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

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

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

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

СерверСервер:

  • Метрический сервис Polyspace запусков.

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

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

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

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

Сконфигурируйте и запустите метрический сервер Polyspace

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

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

    В качестве альтернативы запустите следующую команду:

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

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

  2. Под Polyspace Metrics Settings укажите эту информацию:

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

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

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

    • Folder where analysis data will be stored — Репозиторий результатов для Метрического сервера Polyspace.

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

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

Программное обеспечение хранит информацию, которую вы указываете через окно Metrics Server Settings в следующем файле:

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

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

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

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

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

  • Windows: 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\R2020a. Для большего количества справки в использовании команд используйте -h опция.

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

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

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

  2. Кликните по вкладке Server Configuration.

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

    Укажите эту информацию:

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

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

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

  4. Под разделом Polyspace Metrics web interface configuration:

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

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

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

      • HTTP — 8080

      • HTTPS — 8443

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

  5. Под разделом Upload and download settings:

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

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

    • Загрузите настройки — В Метриках Polyspace, когда вы кликаете по элементу, чтобы просмотреть, Polyspace загружает ваши результаты и открывает их в среде Polyspace. Выберите, где загрузить ваши Метрические результаты Polyspace, также:

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

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

К представлению Polyspace Metrics, в строке поиска вашего веб-браузера, введите:

protocol://ServerName:WSPN

  • protocol http или https.

  • ServerName имя или IP-адрес вашего Метрического сервера Polyspace.

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

Сконфигурируйте веб-сервер для HTTPS

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

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

Сконфигурировать доступ к HTTPS к Метрикам Polyspace:

  1. Откройтесь диалоговое окно Metrics Server Settings, как утверждено в Конфигурируют и Запускают Метрический Сервер Polyspace.

  2. Нажмите Stop Server. Программное обеспечение останавливает Метрические сервисы Polyspace. Теперь можно делать изменения требуемыми для 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.

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

  4. Следуйте прокомментированным инструкциям в server.xml создать keystore для сертификата HTTPS.

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

К представлению Polyspace Metrics, в строке поиска вашего веб-браузера, введите:

https://ServerName:WSPN

  • ServerName имя или IP-адрес Метрического сервера Polyspace.

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

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

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

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

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

  3. В metricsRootFolder\tomcat\conf\server.xml, отредактируйте port атрибут Connector элемент для вашего протокола веб-сервера. Здесь, metricsRootFolder имя, которое вы задали для Folder where analysis data will be stored при подготовке Метрик 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 Server Settings выберите Start Server, чтобы перезапустить сервер с новыми номерами портов.

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

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

Похожие темы

Документация Polyspace Code Prover
Поддержка