scorecard/probes/hasRecentCommits/impl.go
Spencer Schrock 0b9dfb656f
⚠️ Replace v4 module references with v5 (#4027)
Signed-off-by: Spencer Schrock <sschrock@google.com>
2024-04-12 14:51:50 -07:00

83 lines
2.2 KiB
Go

// Copyright 2023 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.
//nolint:stylecheck
package hasRecentCommits
import (
"embed"
"fmt"
"strconv"
"time"
"github.com/ossf/scorecard/v5/checker"
"github.com/ossf/scorecard/v5/finding"
"github.com/ossf/scorecard/v5/internal/probes"
"github.com/ossf/scorecard/v5/probes/internal/utils/uerror"
)
func init() {
probes.MustRegister(Probe, Run, []probes.CheckName{probes.Maintained})
}
//go:embed *.yml
var fs embed.FS
const (
Probe = "hasRecentCommits"
NumCommitsKey = "commitsWithinThreshold"
LookbackDayKey = "lookBackDays"
lookBackDays = 90
)
func Run(raw *checker.RawResults) ([]finding.Finding, string, error) {
if raw == nil {
return nil, "", fmt.Errorf("%w: raw", uerror.ErrNil)
}
var findings []finding.Finding
r := raw.MaintainedResults
threshold := time.Now().AddDate(0 /*years*/, 0 /*months*/, -1*lookBackDays /*days*/)
commitsWithinThreshold := 0
for i := range r.DefaultBranchCommits {
commit := r.DefaultBranchCommits[i]
if commit.CommittedDate.After(threshold) {
commitsWithinThreshold++
}
}
var text string
var outcome finding.Outcome
if commitsWithinThreshold > 0 {
text = "Found a contribution within the threshold."
outcome = finding.OutcomeTrue
} else {
text = "Did not find contribution within the threshold."
outcome = finding.OutcomeFalse
}
f, err := finding.NewWith(fs, Probe, text, nil, outcome)
if err != nil {
return nil, Probe, fmt.Errorf("create finding: %w", err)
}
f = f.WithValues(map[string]string{
NumCommitsKey: strconv.Itoa(commitsWithinThreshold),
LookbackDayKey: strconv.Itoa(lookBackDays),
})
findings = append(findings, *f)
return findings, Probe, nil
}