Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
✨ Use crane to add hash suggestion to unpinned Docker images (#2037)
* Use crane to add hash suggestion to unpinned Docker images * Add nil check before dereferencing name for image digest * Reformat changes to comply with linter * Add basic remediation for dockerfile pinning * Deduplicate remediation code * Remove reference to linux/amd64, as crane digest should be universal * add remediation info to scorecard output. switch to using strings.Builder for more maintainable logic
- Loading branch information
1 parent
a905d66
commit 096cbd0
Showing
4 changed files
with
190 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| // Copyright 2022 Security 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 ( | ||
| "testing" | ||
|
|
||
| "github.com/ossf/scorecard/v4/checker" | ||
| "github.com/ossf/scorecard/v4/log" | ||
| ) | ||
|
|
||
| func TestDetailString(t *testing.T) { | ||
| t.Parallel() | ||
| tests := []struct { | ||
| name string | ||
| detail checker.CheckDetail | ||
| log log.Level | ||
| want string | ||
| }{ | ||
| { | ||
| name: "ignoreDebug", | ||
| detail: checker.CheckDetail{ | ||
| Msg: checker.LogMessage{ | ||
| Text: "should not appear", | ||
| }, | ||
| Type: checker.DetailDebug, | ||
| }, | ||
| log: log.DefaultLevel, | ||
| want: "", | ||
| }, | ||
| { | ||
| name: "includeDebug", | ||
| detail: checker.CheckDetail{ | ||
| Msg: checker.LogMessage{ | ||
| Text: "should appear", | ||
| }, | ||
| Type: checker.DetailDebug, | ||
| }, | ||
| log: log.DebugLevel, | ||
| want: "Debug: should appear", | ||
| }, | ||
| { | ||
| name: "onlyType", | ||
| detail: checker.CheckDetail{ | ||
| Msg: checker.LogMessage{ | ||
| Text: "some meaningful text", | ||
| }, | ||
| Type: checker.DetailWarn, | ||
| }, | ||
| log: log.DefaultLevel, | ||
| want: "Warn: some meaningful text", | ||
| }, | ||
| { | ||
| name: "displayPath", | ||
| detail: checker.CheckDetail{ | ||
| Msg: checker.LogMessage{ | ||
| Text: "some meaningful text", | ||
| Path: "Dockerfile", | ||
| }, | ||
| Type: checker.DetailWarn, | ||
| }, | ||
| log: log.DefaultLevel, | ||
| want: "Warn: some meaningful text: Dockerfile", | ||
| }, | ||
| { | ||
| name: "displayStartOffset", | ||
| detail: checker.CheckDetail{ | ||
| Msg: checker.LogMessage{ | ||
| Text: "some meaningful text", | ||
| Path: "Dockerfile", | ||
| Offset: 1, | ||
| }, | ||
| Type: checker.DetailWarn, | ||
| }, | ||
| log: log.DefaultLevel, | ||
| want: "Warn: some meaningful text: Dockerfile:1", | ||
| }, | ||
| { | ||
| name: "displayEndOffset", | ||
| detail: checker.CheckDetail{ | ||
| Msg: checker.LogMessage{ | ||
| Text: "some meaningful text", | ||
| Path: "Dockerfile", | ||
| Offset: 1, | ||
| EndOffset: 7, | ||
| }, | ||
| Type: checker.DetailWarn, | ||
| }, | ||
| log: log.DefaultLevel, | ||
| want: "Warn: some meaningful text: Dockerfile:1-7", | ||
| }, | ||
| { | ||
| name: "ignoreInvalidEndOffset", | ||
| detail: checker.CheckDetail{ | ||
| Msg: checker.LogMessage{ | ||
| Text: "some meaningful text", | ||
| Path: "Dockerfile", | ||
| Offset: 3, | ||
| EndOffset: 2, | ||
| }, | ||
| Type: checker.DetailWarn, | ||
| }, | ||
| log: log.DefaultLevel, | ||
| want: "Warn: some meaningful text: Dockerfile:3", | ||
| }, | ||
| { | ||
| name: "includeRemediation", | ||
| detail: checker.CheckDetail{ | ||
| Msg: checker.LogMessage{ | ||
| Text: "some meaningful text", | ||
| Path: "Dockerfile", | ||
| Remediation: &checker.Remediation{ | ||
| HelpText: "fix x by doing y", | ||
| }, | ||
| }, | ||
| Type: checker.DetailWarn, | ||
| }, | ||
| log: log.DefaultLevel, | ||
| want: "Warn: some meaningful text: Dockerfile: fix x by doing y", | ||
| }, | ||
| } | ||
| for _, tt := range tests { | ||
| tt := tt | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| t.Parallel() | ||
| got := DetailToString(&tt.detail, tt.log) | ||
| if got != tt.want { | ||
| t.Errorf("got %v, want %v", got, tt.want) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters