Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 Fix signed release error for empty gitlab repo #3753

Merged
merged 3 commits into from
Dec 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions checks/evaluation/signed_releases.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
package evaluation

import (
"errors"
"fmt"
"math"

Expand All @@ -25,6 +26,8 @@
"github.com/ossf/scorecard/v4/probes/releasesHaveProvenance"
)

var errNoReleaseFound = errors.New("no release found")

// SignedReleases applies the score policy for the Signed-Releases check.
func SignedReleases(name string,
findings []finding.Finding, dl checker.DetailLogger,
Expand All @@ -47,11 +50,16 @@
f := &findings[i]

// Debug release name
spencerschrock marked this conversation as resolved.
Show resolved Hide resolved
releaseName, err := getReleaseName(f)
if err != nil {
e := sce.WithMessage(sce.ErrScorecardInternal, "could not get release name")
return checker.CreateRuntimeErrorResult(name, e)
if f.Outcome == finding.OutcomeNotApplicable {
// Generic summary.
return checker.CreateInconclusiveResult(name, "no releases found")
}
releaseName := getReleaseName(f)
if releaseName == "" {
// Generic summary.
return checker.CreateRuntimeErrorResult(name, errNoReleaseFound)
}

Check warning on line 61 in checks/evaluation/signed_releases.go

View check run for this annotation

Codecov / codecov/patch

checks/evaluation/signed_releases.go#L59-L61

Added lines #L59 - L61 were not covered by tests

if !contains(loggedReleases, releaseName) {
dl.Debug(&checker.LogMessage{
Text: fmt.Sprintf("GitHub release found: %s", releaseName),
Expand All @@ -60,13 +68,6 @@
}

// Check if outcome is NotApplicable
if f.Outcome == finding.OutcomeNotApplicable {
dl.Warn(&checker.LogMessage{
Text: "no GitHub releases found",
})
// Generic summary.
return checker.CreateInconclusiveResult(name, "no releases found")
}
}

totalPositive := 0
Expand All @@ -77,11 +78,10 @@
for i := range findings {
f := &findings[i]

releaseName, err := getReleaseName(f)
if err != nil {
return checker.CreateRuntimeErrorResult(name, err)
releaseName := getReleaseName(f)
if releaseName == "" {
return checker.CreateRuntimeErrorResult(name, errNoReleaseFound)

Check warning on line 83 in checks/evaluation/signed_releases.go

View check run for this annotation

Codecov / codecov/patch

checks/evaluation/signed_releases.go#L83

Added line #L83 was not covered by tests
}

if !contains(uniqueReleaseTags, releaseName) {
uniqueReleaseTags = append(uniqueReleaseTags, releaseName)
}
Expand Down Expand Up @@ -126,7 +126,7 @@
return checker.CreateResultWithScore(name, reason, score)
}

func getReleaseName(f *finding.Finding) (string, error) {
func getReleaseName(f *finding.Finding) string {
m := f.Values
for k, v := range m {
var value int
Expand All @@ -137,10 +137,10 @@
value = int(releasesHaveProvenance.ValueTypeRelease)
}
if v == value {
return k, nil
return k
}
}
return "", sce.WithMessage(sce.ErrScorecardInternal, "could not get release tag")
return ""
}

func contains(releases []string, release string) bool {
Expand Down
62 changes: 56 additions & 6 deletions checks/evaluation/signed_releases_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,6 @@ const (
asset1 = 1
asset2 = 2
asset3 = 3
asset4 = 4
asset5 = 5
asset6 = 6
asset7 = 7
asset8 = 8
asset9 = 9
)

func signedProbe(release, asset int, outcome finding.Outcome) finding.Finding {
Expand Down Expand Up @@ -282,3 +276,59 @@ func TestSignedReleases(t *testing.T) {
})
}
}

func Test_getReleaseName(t *testing.T) {
t.Parallel()
type args struct {
f *finding.Finding
}
tests := []struct {
name string
args args
want string
}{
{
name: "no release",
args: args{
f: &finding.Finding{
Values: map[string]int{},
},
},
want: "",
},
{
name: "release",
args: args{
f: &finding.Finding{
Values: map[string]int{
"v1": int(releasesAreSigned.ValueTypeRelease),
},
Probe: releasesAreSigned.Probe,
},
},
want: "v1",
},
{
name: "release and asset",
args: args{
f: &finding.Finding{
Values: map[string]int{
"v1": int(releasesAreSigned.ValueTypeRelease),
"artifact-1": int(releasesAreSigned.ValueTypeReleaseAsset),
},
Probe: releasesAreSigned.Probe,
},
},
want: "v1",
},
}
for _, tt := range tests {
tt := tt
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
if got := getReleaseName(tt.args.f); got != tt.want {
t.Errorf("getReleaseName() = %v, want %v", got, tt.want)
}
})
}
}
Loading