10 показателей, на которые нужно обратить внимание при работе с правилами проверки кода

[Предварительный просмотр прямой трансляции] Облачная виртуальная машина за 99 юаней × Собственная облачная архитектура за 9 юаней √

Эта статья опубликована в облачном сообществе Huawei « На каких индикаторах обычно фокусируются правила проверки кода?» ", автор:gent_zhou.

На панели операций измерения службы проверки кода, в дополнение к упомянутому ранее модулю работы с сигналами тревоги (по индикаторам вы можете обратиться к этой статье «На каких индикаторах обычно фокусируются операции по проверке кода? »), есть один модуль, который будет определенно существует. правило действие. . Этот модуль посвящен анализу, обработке и составлению отчетов о правилах проверки кода. Для менеджеров групповых проектов он может отслеживать и управлять общим состоянием правил. Подробную информацию можно найти в моей предыдущей статье «Почему для статической проверки кода нужны правила». операции? 》.

Сегодня поговорим подробнее, на какие показатели в модуле работы правил дашборда обычно обращают внимание пользователи? Его можно грубо разделить на данные в измерении самого правила: имя правила, версия правила, содержание правила, связанные языки, связанные инструменты и категории, категории сигналов тревоги, область применения; и данные в измерении ассоциации правила: информация о Лицо, ответственное за обслуживание правила, правила. Соответствующая эталонная ситуация, набор правил, связанный с правилом.

Размерность самого правила

Название правила

Имя правила позволяет пользователям примерно понять значение и функцию правила, что упрощает идентификацию правила и управление им. Являясь одним из основных индикаторов работы правил, он может помочь пользователям быстро понять и определить, какие правила существуют в компаниях, отраслях и подразделениях и какие правила предпочитают использовать разные отделы.

В качестве примера возьмем сервис проверки кода Huawei Cloud CodeArts Check. Дизайн названий правил основан на ясности и простоте:
изображение.png

Версия правила

По мере развития правил неизбежно будет существовать множество версий, включая различные основные версии (которые могут повторяться в течение года или полугода) и второстепенные версии (нерегулярные небольшие улучшения оптимизации). Версия обычно является альтернативой номеру версии, и номер версии обычно также содержит время и дату (представляющие время ее создания/время изменения/время подключения и т. д.), чтобы отразить обновление правил.

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

Содержание правила

Если имя правила может помочь пользователям примерно понять смысл правила, то содержание правила должно позволить пользователям четко понять, что это за правило, предыстория правила, где правило может быть использовано, правильные и неправильные примеры его применения. правило, и ссылка на правило.Какие нормы и тд.

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

На примере службы проверки кода Huawei Cloud CodeArts Check обзор разделен на описания, правильные примеры, примеры ошибок и предложения по исправлению. См. подробное описание содержания правила:
изображение.png

Родственные языки

Разработчики правил будут проектировать и разрабатывать адаптированные правила для соответствующих языков программирования и их языковых характеристик. В частности, для некоторых основных языков, таких как Java, C, C++, Python и т. д., должны быть охвачены правила зрелой и полной службы проверки кода.

На панели управления классификация правил по языку может улучшить читабельность и удобство сопровождения правил, позволяя пользователям отфильтровывать правила, соответствующие характеристикам проекта и языковым привычкам разработчиков на основе языка, а также выбирать инструменты движка, соответствующие правил., проводить более целенаправленное обнаружение и сканирование бизнес-проектов.

Связанные инструменты и категории

Если правила хотят работать в службе проверки кода, помимо самих правил им также необходимы вспомогательные инструменты ядра для их выполнения. Какие механизмы используются для выполнения правил? Например, распространенным сценарием является то, что набор правил сам по себе распознается отделами и экспертами, но в ходе фактического процесса применения обнаруживается, что производимые эффекты сильно различаются; одна из возможностей заключается в том, что механизмы, поддерживающие эти правила, различны.В результате некоторые движки очень эффективны и эффект правил реализуется на месте, то эффект проверки и сканирования проявится; но если сам согласующий движок имеет среднюю эффективность и производительность, эффект сканирования может быть значительно уменьшено.

В качестве примера возьмем сервис проверки кода Huawei Cloud CodeArts Check.Разные правила будут соответствовать разным инструментам движка, которые будут отображаться в метке интерфейса сведений о правилах:
изображение.png

изображение.png

Категория тревоги

Точно так же, как я сказал в разделе «Почему статическая проверка кода должна соответствовать правилам?» «Как упоминалось в статье, правила аналогичны положениям закона, значит, нарушенное правило относится к гражданским, дорожным или уголовным категориям? В это время необходимо отобразить категорию тревоги.

Вообще говоря, категории тревог можно разделить на три основные категории для отображения: категория безопасности, категория качества и категория стиля (конечно, категории качества и категории стиля также могут отображаться вместе). Если отдел качества компании считает, что классификация трех категорий слишком грубая, он может продолжить ее подразделение.

В качестве примера возьмем классификацию сервиса проверки кода Huawei Cloud CodeArts Check («Пакет функций повышения безопасности», упомянутый в столбце классификации, представляет собой расширенную ветвь категории безопасности и обеспечивает более глубокое сканирование некоторых сценариев проблем безопасности):
изображение.png

Область применения

Когда дело доходит до сферы применения, мы должны сначала кратко рассказать, как использовать инструмент проверки кода. Помимо обычных облачных сервисов, сканирования уровня контроля доступа, обеспечиваемого хранилищем кода, и сканирования уровня версии, обеспечиваемого/запускаемого вручную конвейером, решающее значение также имеет сканирование подключаемых модулей IDE, необходимое разработчикам для разработки кода в локальной IDE. Давайте временно назовем эти три метода использования уровнем версии, уровнем контроля доступа и уровнем плагина IDE.Тогда можно сказать, что эти три метода являются сферой применения сервиса.

Для правил также действует сфера применения. Применимый объем правил делится на основе характеристик самих правил, необходимости компиляции, требует ли сканирование вспомогательного механизма большого количества вычислительных ресурсов, требуется ли анализ пятен и т. д. Некоторые правила, занимающие меньше вычислительных ресурсов и не требующие компиляции, можно выбрать в качестве области проверки плагина IDE. В модуле работы правил панели управления классификация правил по сфере применения позволяет пользователям понять, какие правила можно выбрать для применения в разных областях.

Параметры ассоциации правил

Информация об ответственном за техническое обслуживание, связанная с правилами

Правила будут постоянно обновляться и оптимизироваться по мере развития бизнеса и повышения осведомленности об уязвимостях в отрасли. Поэтому требуется специальный отдел обслуживания и ответственное за обслуживание лицо, которое будет нести ответственность за онлайн и оффлайн, модификацию, выпуск и управление правилами. .

Вообще говоря, существует две причины для отображения информации об ответственном за техническое обслуживание, связанной с правилами, на панели управления:

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

Ссылки, связанные с правилами

Как только правило будет разработано, если оно разумно и эффективно, оно будет принято и использовано различными продуктовыми линейками, отделами и проектами внутри компании. , эффективность и влияние правила.

Вообще говоря, существует три причины для отображения информации о цитировании, связанной с правилами, на панели управления:

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

Набор правил, связанный с правилом

Когда пользователи службы проверки кода используют правила, они не выбирают правила для сканирования напрямую, а выбирают некоторые правила и объединяют их в набор на основе своих бизнес-характеристик, спецификаций кода, стандартов безопасности или требований к качеству, которые необходимо выполнить. последовал. . Этот набор обычно называется набором правил, который может помочь пользователям управлять добавлениями, удалениями и запросами.

Правила отображения на панели управления используются этими наборами правил, что может помочь пользователям понять:

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

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

в заключение

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

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