-report-template)Укажите шаблон для генерации отчета анализа
Укажите шаблон для генерации отчета анализа.
.rpt файлы для шаблонов отчетов доступны в polyspaceroot\ toolbox\polyspace\psrptgen\templates\polyspacerootC:\Program Files\Polyspace\R2019a.
Пользовательский интерфейс (только для настольных продуктов): В строении проекта опция находится на узле Reporting. У вас есть отдельные опции для анализа Bug Finder и Code Prover. Смотрите Зависимости для других опций, которые вы также должны включить.
Командная строка и файл опций: Используйте опцию -report-template. См. «Информация о командной строке».
В зависимости от используемого шаблона отчет содержит информацию об определенных типах результатов из панели Results List. Шаблон также определяет, какая информация представлена в отчете и как организована информация. См. описание шаблона ниже.
По умолчанию: BugFinderSummary
BugFinderВ отчете перечислены:
Polyspace Bug Finder Summary: Количество результатов в проекте. Результаты суммируются по файлам. Файлы, которые частично анализируются из-за ошибок компиляции, перечислены в отдельной таблице.
Code Metrics: Сводные данные различных метрик сложности кода. Для получения дополнительной информации см. Раздел «Метрики кода».
Coding Rules: Нарушения правил кодирования в исходном коде. Для каждого нарушения правил в отчете перечислены:
Номер и описание правила.
Функция, содержащая нарушение правил.
Просмотрите информацию, такую как Severity, Status и комментарии.
Defects: Дефекты, обнаруженные в исходном коде. Для каждого дефекта в отчете перечислены:
Функция, содержащая дефект.
Сведения о дефекте на панели Result Details.
Просмотрите информацию, такую как Severity, Status и комментарии.
Configuration Settings: Список опций анализа, которые Polyspace использует для анализа. Если вы конфигурировали свой проект для многозадачности, в этом разделе также перечислены Concurrency Modeling Summary. Если ваш проект имеет исходные файлы с ошибками компиляции, эти файлы также перечислены.
Если вы проверяете правила кодирования, в дополнительном Coding Rules Configuration разделе указываются правила наряду с информацией о том, были ли они активированы или отключены.
BugFinderSummaryВ отчете перечислены:
Polyspace Bug Finder Summary: Количество результатов в проекте. Результаты суммируются по файлам. Файлы, которые частично анализируются из-за ошибок компиляции, перечислены в отдельной таблице.
Code Metrics: Сводные данные различных метрик сложности кода. Для получения дополнительной информации см. Раздел «Метрики кода».
Coding Rules Summary: Правила кодирования наряду с количеством нарушений.
Defect Summary: Дефекты, которые Polyspace Bug Finder™ ищет. Для каждого дефекта в отчете перечислены:
Группа дефектов.
Имя дефекта.
Количество образцов дефекта, найденных в исходном коде.
Configuration Settings: Список опций анализа, которые Polyspace использует для анализа. Если вы конфигурировали свой проект для многозадачности, в этом разделе также перечислены Concurrency Modeling Summary. Для получения дополнительной информации смотрите Опции анализа в Polyspace Bug Finder. Если ваш проект имеет исходные файлы с ошибками компиляции, эти файлы также перечислены.
Если вы проверяете правила кодирования, в дополнительном Coding Rules Configuration разделе указываются правила наряду с информацией о том, были ли они активированы или отключены.
CodeMetricsВ отчете перечислены следующие элементы:
Code Metrics Summary: Различные величины, связанные с исходным кодом. Для получения дополнительной информации см. Раздел «Метрики кода».
Code Metrics Details: Различные величины, связанные с исходным кодом с информацией в разбивке по файлам и функциям.
Configuration Settings: Список опций анализа, которые Polyspace использует для анализа. Если вы конфигурировали свой проект для многозадачности, в этом разделе также перечислены Concurrency Modeling Summary. Если ваш проект имеет исходные файлы с ошибками компиляции, эти файлы также перечислены.
Если вы проверяете правила кодирования, в дополнительном Coding Rules Configuration разделе указываются правила наряду с информацией о том, были ли они активированы или отключены.
CodingStandardsОтчет содержит отдельные главы для каждого стандарта кодирования, активируемого в анализе (для образца, MISRA C®: 2012, CERT® C, пользовательские правила и так далее). Каждая глава содержит следующую информацию:
Summary - Violations by File: График, показывающий каждый файл с количеством нарушений правил.
Summary - Violations by Rule: График, показывающий каждое правило с количеством нарушений. Если правило не включено или не нарушено, оно не отображается в графике.
Summary for all Files: Таблица, показывающая каждый файл с количеством нарушений правил.
Summary for Enabled Guidelines или Summary for Enabled Rules: Таблица, показывающая каждое руководство или правило с количеством нарушений.
Violations: Таблицы с перечислением каждого нарушения правил наряду с такими сведениями, как идентификатор, имя функции, серьезность, состояние и так далее. Для каждого файла создается одна таблица.
В приложении перечислены опции, используемые в анализе Polyspace.
SecurityCWEОтчет содержит ту же информацию, что и BugFinder отчет. Однако в Defects главе в дополнительном столбце перечислены правила CWE™, сопоставленные с каждым дефектом. В Configuration Settings приложении также содержится Security Standard to Polyspace Result Map.
MetricsДоступно только для результатов, загруженных из интерфейса Polyspace Metrics.
Отчет содержит информацию, полезную для инженеров по качеству и доступную на интерфейсе Polyspace Metrics, включая:
Информация о том, удовлетворяет ли проект целям качества
Время, затраченное на каждую фазу анализа
Метрики о целом проекте. Для каждой метрики в отчете перечисляется порог качества и удовлетворяет ли метрика этому порогу.
Нарушения правил кодирования в проекте. Для каждого правила в отчете указывается количество обоснованных нарушений и удовлетворяет ли обоснование целям качества.
Определите, а также возможные ошибки времени выполнения в проекте. Для каждого типа ошибки времени выполнения в отчете указывается количество обоснованных ошибок и удовлетворяет ли обоснование целям качества.
Приложения содержат дополнительные сведения о настройках строения Polyspace, метриках кода, нарушениях правил кодирования и ошибках времени выполнения.
По умолчанию: Developer
CodeMetricsОтчет содержит сводные данные метрик кода, за которой следуют полные метрики для приложения.
CodingStandardsОтчет содержит отдельные главы для каждого стандарта кодирования, включенного в анализе (для образца, MISRA C: 2012, пользовательских правил и так далее). Каждая глава содержит следующую информацию:
Summary - Violations by File: График, показывающий каждый файл с количеством нарушений правил.
Summary - Violations by Rule: График, показывающий каждое правило с количеством нарушений. Если правило не включено или не нарушено, оно не отображается в графике.
Summary for all Files: Таблица, показывающая каждый файл с количеством нарушений правил.
Summary for Enabled Guidelines или Summary for Enabled Rules: Таблица, показывающая каждое руководство или правило с количеством нарушений.
Violations: Таблицы с перечислением каждого нарушения правил наряду с такими сведениями, как идентификатор, имя функции, серьезность, состояние и так далее. Для каждого файла создается одна таблица.
В приложении перечислены опции, используемые в анализе Polyspace.
DeveloperВ отчете перечислены полезные для разработчиков сведения, в том числе:
Сводные данные результатов
Нарушения правил кодирования
Список проверенных ошибок времени выполнения или красных проверок
Список недоказанных ошибок времени выполнения или оранжевых проверок
Список недоступных процедур или серых проверок
Использование глобальной переменной в коде. См. «Глобальные переменные» (Polyspace Code Prover).
Отчет также содержит настройки строения Polyspace и изменяемые допущения, используемые в анализе. Если ваш проект имеет исходные файлы с ошибками компиляции, эти файлы также перечислены.
DeveloperReviewОтчет содержит ту же информацию, что и Developer отчет. Однако просматриваемые результаты сортируются по степени серьезности и статусу, а не просматриваемые результаты сортируются по местоположению файла.
Developer_withGreenChecksОтчет содержит ту же информацию, что и Developer отчет. В сложение код списков отчета оказался безошибочным или зеленым.
QualityВ отчете приводится информация, полезная для инженеров по качеству, включая:
Сводные данные результатов
Статистика по коду
Графики, показывающие распределения проверок по файлам
Отчет также содержит настройки строения Polyspace и изменяемые допущения, используемые в анализе. Если ваш проект имеет исходные файлы с ошибками компиляции, эти файлы также перечислены.
VariableAccessВ отчете отображается доступ к глобальной переменной в исходном коде. Сначала в отчете отображается количество глобальных переменных каждого типа. Для получения информации о типах смотрите Глобальные переменные (Polyspace Code Prover). Для каждой глобальной переменной в отчете отображается следующая информация:
Имя переменной.
Запись для каждой переменной обозначается |.
Тип переменной.
Количество операций чтения и записи переменной.
Детали операций чтения и записи. Для каждой операции чтения или записи в таблице отображается следующая информация:
Файл и функция, содержащие операцию в форме file_name. function_name
Запись для каждой операции чтения или записи обозначается ||. Операции записи обозначаются < и считывайте операции по >.
Линия и столбца операции.
Этот отчет содержит информацию, доступную на панели Variable Access в пользовательском интерфейсе Polyspace.
CallHierarchyВ отчете отображается иерархия вызовов в исходном коде. Для каждого вызова функции в исходном коде в отчете отображается следующая информация:
Уровень иерархии вызовов, где вызывается функция.
Каждый уровень обозначается |. Если вызов функции появляется в таблице следующим |||-> вызов функции происходит на третьем уровне иерархии. Начиная с file_name. function_namemain или точки входа, существует три вызова функций, ведущих к текущему вызову.
Файл, содержащий вызов функции.
В сложение также отображаются линии и столбец.
Файл, содержащий определение функции.
В сложение также отображаются линии и столбец, с которых начинается определение функции.
В сложение в отчете также отображаются незакрытые функции.
Этот отчет содержит информацию, доступную на панели Call Hierarchy в пользовательском интерфейсе Polyspace.
SoftwareQualityObjectivesОтчет содержит информацию, полезную для инженеров по качеству и доступную на интерфейсе Polyspace Metrics, включая:
Информация о том, удовлетворяет ли проект целям качества
Время, затраченное на каждой фазе верификации
Метрики о целом проекте. Для каждой метрики в отчете перечисляется порог качества и удовлетворяет ли метрика этому порогу.
Нарушения правил кодирования в проекте. Для каждого правила в отчете указывается количество обоснованных нарушений и удовлетворяет ли обоснование целям качества.
Определите, а также возможные ошибки времени выполнения в проекте. Для каждого типа ошибки времени выполнения в отчете указывается количество обоснованных ошибок и удовлетворяет ли обоснование целям качества.
Приложения содержат дополнительные сведения о настройках строения Polyspace, метриках кода, нарушениях правил кодирования и ошибках времени выполнения.
Этот шаблон доступен только при создании отчета из результатов, загруженных в веб-интерфейс Polyspace Access, или из результатов, загруженных в веб-интерфейс Polyspace Metrics (а затем загруженных в пользовательский интерфейс Polyspace). В каждом случае необходимо явно задать цели в веб-интерфейсе, а затем сгенерировать отчеты.
SoftwareQualityObjectives_SummaryОтчет содержит ту же информацию, что и SoftwareQualityObjectives отчет. Однако он не имеет вспомогательных приложений с подробностями о метриках кода, нарушениях правил кодирования и ошибках времени выполнения.
Этот шаблон доступен только при создании отчета из результатов, загруженных в веб-интерфейс Polyspace Access, или из результатов, загруженных в веб-интерфейс Polyspace Metrics (а затем загруженных в пользовательский интерфейс Polyspace). В каждом случае необходимо явно задать целевой уровень качества в веб-интерфейсе, а затем сгенерировать отчеты.
В пользовательском интерфейсе десктопных продуктов Polyspace эта опция включена только при выборе Generate report опция.
Эта опция позволяет вам задать генерацию отчетов перед началом анализа.
Чтобы сгенерировать отчет после завершения анализа, в пользовательском интерфейсе десктопных решений Polyspace выберите Reporting > Run Report. Кроме того, в командной строке используйте polyspace-report-generator команда.
После анализа можно также экспортировать результат как текстовый файл для дальнейшей индивидуальной настройки. Используйте опцию -generate-results-list-file с polyspace-report-generator команда.
В Bug Finder отчет не содержит линию или номер столбца для результата. Используйте отчет для архивирования, сбора статистики и проверки того, были ли результаты рассмотрены и рассмотрены (в целях сертификации или иным образом). Чтобы просмотреть результат в исходном коде, используйте пользовательский интерфейс Polyspace или вашу IDE, если вы используете плагин Polyspace.
Если вы используете SoftwareQualityObjectives_Summary и SoftwareQualityObjectives шаблоны для генерации отчетов, статус pass/fail зависит от того, задаете ли вы уровень целей качества в Polyspace Metrics или Polyspace Access:
В Polyspace Access статус pass/fail определяется на основе всех результатов. Например, если вы используете уровень, SQO-4 котором устанавливает порог 60% при проверках переполнения оранжевого цвета, ваш проект имеет статус FAIL, если процент проверок переполнения зеленого и обоснованного оранжевого цвета составляет менее 60% от всех проверок переполнения зеленого и оранжевого цвета.
В метриках Polyspace статус pass/fail определяется на основе файлового базисный. Общее состояние FAIL, если один из файлов имеет статус FAIL. Например, если вы используете уровень, SQO-4 котором устанавливает порог 60% при проверках переполнения оранжевого цвета, ваш проект имеет статус FAIL, если процент проверок переполнения зеленого и обоснованного оранжевого цвета в любом файле составляет менее 60% проверок переполнения зеленого и оранжевого цвета в этом файле.
В первой главе докладов содержатся сводные данные соответствующих результатов. Вы можете ввести статус Pass/Fail в этой главе для вашего проекта на основе сводных данных. Если вы используете шаблон SoftwareQualityObjectives или SoftwareQualityObjectives_Summaryстатус автоматически присваивается на основе ваших целей и результатов верификации. Для получения дополнительной информации о реализации целей с помощью Polyspace Metrics, смотрите Сравнение метрики с целями качества программного обеспечения.
Параметр: -report-template |
Значение: Полный путь к |
Пример (Bug Finder):
Polyspace Bug Finder -sources file_name |
Пример (Code Prover):
Polyspace Code Prover -sources file_name |
Пример (Bug Finder Server):
polyspace-bug-finder-server -sources file_name |
Пример (Код Prover Server):
Полипространство -code-prover-server -sources file_name |