mirror of
https://github.com/ossf/scorecard.git
synced 2024-09-11 08:55:27 +03:00
* keep runs and rules for exempted checks, only skip the results. Signed-off-by: Spencer Schrock <sschrock@google.com> * update test Signed-off-by: Spencer Schrock <sschrock@google.com> --------- Signed-off-by: Spencer Schrock <sschrock@google.com>
990 lines
24 KiB
Go
990 lines
24 KiB
Go
// Copyright 2021 OpenSSF Scorecard Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package pkg
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"os"
|
|
"reflect"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/google/go-cmp/cmp"
|
|
|
|
"github.com/ossf/scorecard/v5/checker"
|
|
"github.com/ossf/scorecard/v5/config"
|
|
"github.com/ossf/scorecard/v5/finding"
|
|
"github.com/ossf/scorecard/v5/log"
|
|
"github.com/ossf/scorecard/v5/options"
|
|
spol "github.com/ossf/scorecard/v5/policy"
|
|
)
|
|
|
|
func sarifMockDocRead() *mockDoc {
|
|
d := map[string]mockCheck{
|
|
"Check-Name": {
|
|
name: "Check-Name",
|
|
risk: "High",
|
|
short: "short description",
|
|
description: "long description\n other line",
|
|
url: "https://github.com/ossf/scorecard/blob/main/docs/checks.md#check-name",
|
|
tags: []string{"tag1", "tag2"},
|
|
repos: []string{"GitHub", "local"},
|
|
remediation: []string{"not-used1", "not-used2"},
|
|
},
|
|
"Check-Name2": {
|
|
name: "Check-Name2",
|
|
risk: "Medium",
|
|
short: "short description 2",
|
|
description: "long description\n other line 2",
|
|
url: "https://github.com/ossf/scorecard/blob/main/docs/checks.md#check-name2",
|
|
tags: []string{" tag1 ", " tag2 ", "tag3"},
|
|
repos: []string{"GitHub", "local"},
|
|
remediation: []string{"not-used1", "not-used2"},
|
|
},
|
|
"Check-Name3": {
|
|
name: "Check-Name3",
|
|
risk: "Low",
|
|
short: "short description 3",
|
|
description: "long description\n other line 3",
|
|
url: "https://github.com/ossf/scorecard/blob/main/docs/checks.md#check-name3",
|
|
tags: []string{" tag1", " tag2", "tag3", "tag 4 "},
|
|
repos: []string{"GitHub", "local"},
|
|
remediation: []string{"not-used1", "not-used2"},
|
|
},
|
|
"Check-Name4": {
|
|
name: "Check-Name4",
|
|
risk: "Low",
|
|
short: "short description 4",
|
|
description: "long description\n other line 4",
|
|
url: "https://github.com/ossf/scorecard/blob/main/docs/checks.md#check-name4",
|
|
tags: []string{" tag1", " tag2", "tag3", "tag 4 "},
|
|
repos: []string{"GitHub"},
|
|
remediation: []string{"not-used1", "not-used2"},
|
|
},
|
|
"Check-Name5": {
|
|
name: "Check-Name5",
|
|
risk: "Low",
|
|
short: "short description 5",
|
|
description: "long description\n other line 5",
|
|
url: "https://github.com/ossf/scorecard/blob/main/docs/checks.md#check-name5",
|
|
tags: []string{" tag1", " tag2", "tag3", "tag 4 "},
|
|
repos: []string{"local"},
|
|
remediation: []string{"not-used1", "not-used2"},
|
|
},
|
|
"Check-Name6": {
|
|
name: "Check-Name6",
|
|
risk: "Low",
|
|
short: "short description 6",
|
|
description: "long description\n other line 6",
|
|
url: "https://github.com/ossf/scorecard/blob/main/docs/checks.md#check-name6",
|
|
tags: []string{" tag1", " tag2", "tag3", "tag 4 "},
|
|
repos: []string{"Git-local"},
|
|
remediation: []string{"not-used1", "not-used2"},
|
|
},
|
|
}
|
|
|
|
m := mockDoc{checks: d}
|
|
return &m
|
|
}
|
|
|
|
func TestSARIFOutput(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
repoCommit := "68bc59901773ab4c051dfcea0cc4201a1567ab32"
|
|
scorecardCommit := "ccbc59901773ab4c051dfcea0cc4201a1567abdd"
|
|
scorecardVersion := "1.2.3"
|
|
repoName := "repo not used"
|
|
date, e := time.Parse(time.RFC822Z, "17 Aug 21 18:57 +0000")
|
|
if e != nil {
|
|
panic(fmt.Errorf("time.Parse: %w", e))
|
|
}
|
|
|
|
checkDocs := sarifMockDocRead()
|
|
|
|
//nolint:govet
|
|
tests := []struct {
|
|
name string
|
|
expected string
|
|
showDetails bool
|
|
showAnotations bool
|
|
logLevel log.Level
|
|
result ScorecardResult
|
|
policy spol.ScorecardPolicy
|
|
}{
|
|
{
|
|
name: "check with detail remediation",
|
|
showDetails: true,
|
|
expected: "./testdata/check-remediation.sarif",
|
|
logLevel: log.DebugLevel,
|
|
policy: spol.ScorecardPolicy{
|
|
Version: 1,
|
|
Policies: map[string]*spol.CheckPolicy{
|
|
"Check-Name": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
"Check-Name2": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_DISABLED,
|
|
},
|
|
},
|
|
},
|
|
result: ScorecardResult{
|
|
Repo: RepoInfo{
|
|
Name: repoName,
|
|
CommitSHA: repoCommit,
|
|
},
|
|
Scorecard: ScorecardInfo{
|
|
Version: scorecardVersion,
|
|
CommitSHA: scorecardCommit,
|
|
},
|
|
Date: date,
|
|
Checks: []checker.CheckResult{
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "src/file1.cpp",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 5,
|
|
Snippet: "if (bad) {BUG();}",
|
|
Remediation: &finding.Remediation{
|
|
Markdown: "this is the custom markdown help",
|
|
Text: "this is the custom text help",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
Score: 5,
|
|
Reason: "half score reason",
|
|
Name: "Check-Name",
|
|
},
|
|
},
|
|
Metadata: []string{},
|
|
},
|
|
},
|
|
{
|
|
name: "check-1",
|
|
showDetails: true,
|
|
expected: "./testdata/check1.sarif",
|
|
logLevel: log.DebugLevel,
|
|
policy: spol.ScorecardPolicy{
|
|
Version: 1,
|
|
Policies: map[string]*spol.CheckPolicy{
|
|
"Check-Name": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
"Check-Name2": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_DISABLED,
|
|
},
|
|
},
|
|
},
|
|
result: ScorecardResult{
|
|
Repo: RepoInfo{
|
|
Name: repoName,
|
|
CommitSHA: repoCommit,
|
|
},
|
|
Scorecard: ScorecardInfo{
|
|
Version: scorecardVersion,
|
|
CommitSHA: scorecardCommit,
|
|
},
|
|
Date: date,
|
|
Checks: []checker.CheckResult{
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "src/file1.cpp",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 5,
|
|
Snippet: "if (bad) {BUG();}",
|
|
},
|
|
},
|
|
},
|
|
Score: 5,
|
|
Reason: "half score reason",
|
|
Name: "Check-Name",
|
|
},
|
|
},
|
|
Metadata: []string{},
|
|
},
|
|
},
|
|
{
|
|
name: "annotated check defined but no results",
|
|
showDetails: true,
|
|
showAnotations: true,
|
|
expected: "./testdata/check1_annotations.sarif",
|
|
logLevel: log.DebugLevel,
|
|
policy: spol.ScorecardPolicy{
|
|
Version: 1,
|
|
Policies: map[string]*spol.CheckPolicy{
|
|
"Check-Name": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
},
|
|
},
|
|
result: ScorecardResult{
|
|
Repo: RepoInfo{
|
|
Name: repoName,
|
|
CommitSHA: repoCommit,
|
|
},
|
|
Scorecard: ScorecardInfo{
|
|
Version: scorecardVersion,
|
|
CommitSHA: scorecardCommit,
|
|
},
|
|
Date: date,
|
|
Checks: []checker.CheckResult{
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "src/file1.cpp",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 5,
|
|
Snippet: "if (bad) {BUG();}",
|
|
},
|
|
},
|
|
},
|
|
Score: 5,
|
|
Reason: "half score reason",
|
|
Name: "Check-Name",
|
|
},
|
|
},
|
|
Config: config.Config{
|
|
Annotations: []config.Annotation{
|
|
{
|
|
Checks: []string{"Check-Name"},
|
|
Reasons: []config.ReasonGroup{
|
|
{Reason: "test-data"},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
Metadata: []string{},
|
|
},
|
|
},
|
|
{
|
|
name: "check-2",
|
|
showDetails: true,
|
|
expected: "./testdata/check2.sarif",
|
|
logLevel: log.DebugLevel,
|
|
policy: spol.ScorecardPolicy{
|
|
Version: 1,
|
|
Policies: map[string]*spol.CheckPolicy{
|
|
"Check-Name": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
"Check-Name2": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_DISABLED,
|
|
},
|
|
},
|
|
},
|
|
result: ScorecardResult{
|
|
Repo: RepoInfo{
|
|
Name: repoName,
|
|
CommitSHA: repoCommit,
|
|
},
|
|
Scorecard: ScorecardInfo{
|
|
Version: scorecardVersion,
|
|
CommitSHA: scorecardCommit,
|
|
},
|
|
Date: date,
|
|
Checks: []checker.CheckResult{
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "bin/binary.elf",
|
|
Type: finding.FileTypeBinary,
|
|
Offset: 0,
|
|
},
|
|
},
|
|
},
|
|
Score: checker.MinResultScore,
|
|
Reason: "min score reason",
|
|
Name: "Check-Name",
|
|
},
|
|
},
|
|
Metadata: []string{},
|
|
},
|
|
},
|
|
{
|
|
name: "check-3",
|
|
showDetails: true,
|
|
expected: "./testdata/check3.sarif",
|
|
logLevel: log.InfoLevel,
|
|
policy: spol.ScorecardPolicy{
|
|
Version: 1,
|
|
Policies: map[string]*spol.CheckPolicy{
|
|
"Check-Name": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
"Check-Name2": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
"Check-Name3": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
},
|
|
},
|
|
result: ScorecardResult{
|
|
Repo: RepoInfo{
|
|
Name: repoName,
|
|
CommitSHA: repoCommit,
|
|
},
|
|
Scorecard: ScorecardInfo{
|
|
Version: scorecardVersion,
|
|
CommitSHA: scorecardCommit,
|
|
},
|
|
Date: date,
|
|
Checks: []checker.CheckResult{
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "bin/binary.elf",
|
|
Type: finding.FileTypeBinary,
|
|
Offset: 0,
|
|
},
|
|
},
|
|
},
|
|
Score: checker.MinResultScore,
|
|
Reason: "min result reason",
|
|
Name: "Check-Name",
|
|
},
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "src/doc.txt",
|
|
Type: finding.FileTypeText,
|
|
Offset: 3,
|
|
Snippet: "some text",
|
|
},
|
|
},
|
|
},
|
|
Score: checker.MinResultScore,
|
|
Reason: "min result reason",
|
|
Name: "Check-Name2",
|
|
},
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailInfo,
|
|
Msg: checker.LogMessage{
|
|
Text: "info message",
|
|
Path: "some/path.js",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 3,
|
|
Snippet: "if (bad) {BUG();}",
|
|
},
|
|
},
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "some/path.py",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 3,
|
|
Snippet: "if (bad) {BUG2();}",
|
|
},
|
|
},
|
|
{
|
|
Type: checker.DetailDebug,
|
|
Msg: checker.LogMessage{
|
|
Text: "debug message",
|
|
Path: "some/path.go",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 3,
|
|
Snippet: "if (bad) {BUG5();}",
|
|
},
|
|
},
|
|
},
|
|
Score: checker.InconclusiveResultScore,
|
|
Reason: "inconclusive reason",
|
|
Name: "Check-Name3",
|
|
},
|
|
},
|
|
Metadata: []string{},
|
|
},
|
|
},
|
|
{
|
|
name: "check-4",
|
|
showDetails: true,
|
|
expected: "./testdata/check4.sarif",
|
|
logLevel: log.DebugLevel,
|
|
policy: spol.ScorecardPolicy{
|
|
Version: 1,
|
|
Policies: map[string]*spol.CheckPolicy{
|
|
"Check-Name": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
"Check-Name2": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
"Check-Name3": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
},
|
|
},
|
|
result: ScorecardResult{
|
|
Repo: RepoInfo{
|
|
Name: repoName,
|
|
CommitSHA: repoCommit,
|
|
},
|
|
Scorecard: ScorecardInfo{
|
|
Version: scorecardVersion,
|
|
CommitSHA: scorecardCommit,
|
|
},
|
|
Date: date,
|
|
Checks: []checker.CheckResult{
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "bin/binary.elf",
|
|
Type: finding.FileTypeBinary,
|
|
Offset: 0,
|
|
},
|
|
},
|
|
},
|
|
Score: checker.MinResultScore,
|
|
Reason: "min result reason",
|
|
Name: "Check-Name",
|
|
},
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "src/doc.txt",
|
|
Type: finding.FileTypeText,
|
|
Offset: 3,
|
|
Snippet: "some text",
|
|
},
|
|
},
|
|
},
|
|
Score: checker.MinResultScore,
|
|
Reason: "min result reason",
|
|
Name: "Check-Name2",
|
|
},
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailInfo,
|
|
Msg: checker.LogMessage{
|
|
Text: "info message",
|
|
Path: "some/path.js",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 3,
|
|
Snippet: "if (bad) {BUG();}",
|
|
},
|
|
},
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "some/path.py",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 3,
|
|
Snippet: "if (bad) {BUG2();}",
|
|
},
|
|
},
|
|
{
|
|
Type: checker.DetailDebug,
|
|
Msg: checker.LogMessage{
|
|
Text: "debug message",
|
|
Path: "some/path.go",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 3,
|
|
Snippet: "if (bad) {BUG5();}",
|
|
},
|
|
},
|
|
},
|
|
Score: checker.InconclusiveResultScore,
|
|
Reason: "inconclusive reason",
|
|
Name: "Check-Name3",
|
|
},
|
|
},
|
|
Metadata: []string{},
|
|
},
|
|
},
|
|
{
|
|
name: "check-5",
|
|
showDetails: true,
|
|
expected: "./testdata/check5.sarif",
|
|
logLevel: log.WarnLevel,
|
|
policy: spol.ScorecardPolicy{
|
|
Version: 1,
|
|
Policies: map[string]*spol.CheckPolicy{
|
|
"Check-Name": {
|
|
Score: 5,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
},
|
|
},
|
|
result: ScorecardResult{
|
|
Repo: RepoInfo{
|
|
Name: repoName,
|
|
CommitSHA: repoCommit,
|
|
},
|
|
Scorecard: ScorecardInfo{
|
|
Version: scorecardVersion,
|
|
CommitSHA: scorecardCommit,
|
|
},
|
|
Date: date,
|
|
Checks: []checker.CheckResult{
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "src/file1.cpp",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 5,
|
|
Snippet: "if (bad) {BUG();}",
|
|
},
|
|
},
|
|
},
|
|
Score: 6,
|
|
Reason: "six score reason",
|
|
Name: "Check-Name",
|
|
},
|
|
},
|
|
Metadata: []string{},
|
|
},
|
|
},
|
|
{
|
|
name: "check-6",
|
|
showDetails: true,
|
|
// https://github.com/github/codeql-action/issues/754
|
|
// Disabled related locations.
|
|
expected: "./testdata/check6.sarif",
|
|
logLevel: log.WarnLevel,
|
|
policy: spol.ScorecardPolicy{
|
|
Version: 1,
|
|
Policies: map[string]*spol.CheckPolicy{
|
|
"Check-Name": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
},
|
|
},
|
|
result: ScorecardResult{
|
|
Repo: RepoInfo{
|
|
Name: repoName,
|
|
CommitSHA: repoCommit,
|
|
},
|
|
Scorecard: ScorecardInfo{
|
|
Version: scorecardVersion,
|
|
CommitSHA: scorecardCommit,
|
|
},
|
|
Date: date,
|
|
Checks: []checker.CheckResult{
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "https://domain.com/something",
|
|
Type: finding.FileTypeURL,
|
|
},
|
|
},
|
|
},
|
|
Score: 6,
|
|
Reason: "six score reason",
|
|
Name: "Check-Name",
|
|
},
|
|
},
|
|
Metadata: []string{},
|
|
},
|
|
},
|
|
{
|
|
name: "check-7",
|
|
showDetails: true,
|
|
expected: "./testdata/check7.sarif",
|
|
logLevel: log.DebugLevel,
|
|
policy: spol.ScorecardPolicy{
|
|
Version: 1,
|
|
Policies: map[string]*spol.CheckPolicy{
|
|
"Check-Name": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
"Check-Name2": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_DISABLED,
|
|
},
|
|
"Check-Name3": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_DISABLED,
|
|
},
|
|
},
|
|
},
|
|
result: ScorecardResult{
|
|
Repo: RepoInfo{
|
|
Name: repoName,
|
|
CommitSHA: repoCommit,
|
|
},
|
|
Scorecard: ScorecardInfo{
|
|
Version: scorecardVersion,
|
|
CommitSHA: scorecardCommit,
|
|
},
|
|
Date: date,
|
|
Checks: []checker.CheckResult{
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "bin/binary.elf",
|
|
Type: finding.FileTypeBinary,
|
|
Offset: 0,
|
|
},
|
|
},
|
|
},
|
|
Score: checker.MinResultScore,
|
|
Reason: "min result reason",
|
|
Name: "Check-Name",
|
|
},
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "src/doc.txt",
|
|
Type: finding.FileTypeText,
|
|
Offset: 3,
|
|
Snippet: "some text",
|
|
},
|
|
},
|
|
},
|
|
Score: checker.MinResultScore,
|
|
Reason: "min result reason",
|
|
Name: "Check-Name2",
|
|
},
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailInfo,
|
|
Msg: checker.LogMessage{
|
|
Text: "info message",
|
|
Path: "some/path.js",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 3,
|
|
Snippet: "if (bad) {BUG();}",
|
|
},
|
|
},
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "some/path.py",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 3,
|
|
Snippet: "if (bad) {BUG2();}",
|
|
},
|
|
},
|
|
{
|
|
Type: checker.DetailDebug,
|
|
Msg: checker.LogMessage{
|
|
Text: "debug message",
|
|
Path: "some/path.go",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 3,
|
|
Snippet: "if (bad) {BUG5();}",
|
|
},
|
|
},
|
|
},
|
|
Score: checker.InconclusiveResultScore,
|
|
Reason: "inconclusive reason",
|
|
Name: "Check-Name3",
|
|
},
|
|
},
|
|
Metadata: []string{},
|
|
},
|
|
},
|
|
{
|
|
name: "check-8",
|
|
showDetails: true,
|
|
expected: "./testdata/check8.sarif",
|
|
logLevel: log.DebugLevel,
|
|
policy: spol.ScorecardPolicy{
|
|
Version: 1,
|
|
Policies: map[string]*spol.CheckPolicy{
|
|
"Check-Name4": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
"Check-Name": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
"Check-Name5": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
"Check-Name6": {
|
|
Score: checker.MaxResultScore,
|
|
Mode: spol.CheckPolicy_ENFORCED,
|
|
},
|
|
},
|
|
},
|
|
result: ScorecardResult{
|
|
Repo: RepoInfo{
|
|
Name: repoName,
|
|
CommitSHA: repoCommit,
|
|
},
|
|
Scorecard: ScorecardInfo{
|
|
Version: scorecardVersion,
|
|
CommitSHA: scorecardCommit,
|
|
},
|
|
Date: date,
|
|
Checks: []checker.CheckResult{
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "src/file1.cpp",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 5,
|
|
Snippet: "if (bad) {BUG();}",
|
|
},
|
|
},
|
|
},
|
|
Score: 5,
|
|
Reason: "half score reason",
|
|
Name: "Check-Name4",
|
|
},
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "src/file1.cpp",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 5,
|
|
Snippet: "if (bad) {BUG();}",
|
|
},
|
|
},
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "src/file2.cpp",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 5,
|
|
Snippet: "if (bad2) {BUG();}",
|
|
},
|
|
},
|
|
},
|
|
Score: 5,
|
|
Reason: "half score reason",
|
|
Name: "Check-Name",
|
|
},
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "src/file1.cpp",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 5,
|
|
Snippet: "if (bad) {BUG();}",
|
|
},
|
|
},
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "src/file2.cpp",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 5,
|
|
Snippet: "if (bad2) {BUG2();}",
|
|
},
|
|
},
|
|
},
|
|
Score: 8,
|
|
Reason: "half score reason",
|
|
Name: "Check-Name5",
|
|
},
|
|
{
|
|
Details: []checker.CheckDetail{
|
|
{
|
|
Type: checker.DetailWarn,
|
|
Msg: checker.LogMessage{
|
|
Text: "warn message",
|
|
Path: "src/file1.cpp",
|
|
Type: finding.FileTypeSource,
|
|
Offset: 5,
|
|
Snippet: "if (bad) {BUG();}",
|
|
},
|
|
},
|
|
},
|
|
Score: 9,
|
|
Reason: "half score reason",
|
|
Name: "Check-Name6",
|
|
},
|
|
},
|
|
Metadata: []string{},
|
|
},
|
|
},
|
|
}
|
|
for i := range tests {
|
|
tt := &tests[i] // Re-initializing variable so it is not changed while executing the closure below
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
var content []byte
|
|
var err error
|
|
content, err = os.ReadFile(tt.expected)
|
|
if err != nil {
|
|
t.Fatalf("%s: cannot read file: %v", tt.name, err)
|
|
}
|
|
|
|
var expected bytes.Buffer
|
|
n, err := expected.Write(content)
|
|
if err != nil {
|
|
t.Fatalf("%s: cannot write buffer: %v", tt.name, err)
|
|
}
|
|
if n != len(content) {
|
|
t.Fatalf("%s: write %d bytes but expected %d", tt.name, n, len(content))
|
|
}
|
|
|
|
var result bytes.Buffer
|
|
err = tt.result.AsSARIF(tt.showDetails, tt.logLevel, &result,
|
|
checkDocs, &tt.policy, &options.Options{})
|
|
if err != nil {
|
|
t.Fatalf("%s: AsSARIF: %v", tt.name, err)
|
|
}
|
|
|
|
r := bytes.Compare(expected.Bytes(), result.Bytes())
|
|
if r != 0 {
|
|
t.Fatalf("%s: invalid result: %d, %s", tt.name, r, cmp.Diff(expected.Bytes(), result.Bytes()))
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func Test_createSARIFRuns(t *testing.T) {
|
|
t.Parallel()
|
|
type args struct {
|
|
runs map[string]*run
|
|
}
|
|
tests := []struct {
|
|
name string
|
|
args args
|
|
want []run
|
|
}{
|
|
{
|
|
name: "empty runs",
|
|
args: args{
|
|
runs: map[string]*run{},
|
|
},
|
|
want: []run{},
|
|
},
|
|
{
|
|
name: "nil runs are skipped",
|
|
args: args{
|
|
runs: map[string]*run{
|
|
"run1": nil,
|
|
"run2": {
|
|
Tool: tool{
|
|
Driver: driver{
|
|
Name: "name",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: []run{
|
|
{
|
|
Tool: tool{
|
|
Driver: driver{
|
|
Name: "name",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "one run",
|
|
args: args{
|
|
runs: map[string]*run{
|
|
"run1": {
|
|
Tool: tool{
|
|
Driver: driver{
|
|
Name: "name",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
want: []run{
|
|
{
|
|
Tool: tool{
|
|
Driver: driver{
|
|
Name: "name",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
tt := tt
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
if got := createSARIFRuns(tt.args.runs); !reflect.DeepEqual(got, tt.want) {
|
|
t.Errorf("createSARIFRuns() = %v, want %v", got, tt.want)
|
|
}
|
|
})
|
|
}
|
|
}
|