SARIF - это статический формат обмена результатами анализа, этот проект стремится предоставить простой интерфейс для создания отчетов в формате SARIF.
Этот пример взят непосредственно со страниц Microsoft Sarif
{
"version" : " 2.1.0 " ,
"$schema" : " https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/schemas/sarif-schema-2.1.0.json " ,
"runs" : [
{
"tool" : {
"driver" : {
"name" : " ESLint " ,
"informationUri" : " https://eslint.org " ,
"rules" : [
{
"id" : " no-unused-vars " ,
"shortDescription" : {
"text" : " disallow unused variables "
},
"helpUri" : " https://eslint.org/docs/rules/no-unused-vars " ,
"properties" : {
"category" : " Variables "
}
}
]
}
},
"artifacts" : [
{
"location" : {
"uri" : " file:///C:/dev/sarif/sarif-tutorials/samples/Introduction/simple-example.js "
}
}
],
"results" : [
{
"level" : " error " ,
"message" : {
"text" : " 'x' is assigned a value but never used. "
},
"locations" : [
{
"physicalLocation" : {
"artifactLocation" : {
"uri" : " file:///C:/dev/sarif/sarif-tutorials/samples/Introduction/simple-example.js " ,
"index" : 0
},
"region" : {
"startLine" : 1 ,
"startColumn" : 5
}
}
}
],
"ruleId" : " no-unused-vars " ,
"ruleIndex" : 0
}
]
}
]
}Одним из проектов, в которые я люблю вносить свой вклад, является TFSEC - это статический инструмент анализа для Terraform, который производит выход во многих форматах. Генерация отчетов SARIF не хватает функциональности, и он оправдывал, что он был перенесен на собственный проект.
Для получения дополнительной информации о SARIF вы можете посетить Oasis Open Site.
Добавьте импорт, чтобы go get github.com/owenrumney/go-sarif/sarif
Есть несколько способов загрузить в содержание отчета SARIF.
sarif.Open берет путь к файлу и загружает сариф из этого места. Возвращает отчет и любую соответствующую ошибку
sarif.FromBytes берет кусок байта и возвращает отчет и любую соответствующую ошибку.
sarif.FromString берет строку содержимого сари и возвращает отчет и любую соответствующую ошибку.
Создание нового отчета SARIF выполняется путем передачи версии, единственное, что поддерживается на данный момент 2.1.0
Для получения подробного примера проверьте пример примера папки/main.go