mirror of
https://github.com/ossf/scorecard.git
synced 2024-09-20 05:27:12 +03:00
140 lines
3.6 KiB
Go
140 lines
3.6 KiB
Go
// Copyright 2020 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 checker
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"time"
|
|
|
|
opencensusstats "go.opencensus.io/stats"
|
|
"go.opencensus.io/tag"
|
|
|
|
sce "github.com/ossf/scorecard/v3/errors"
|
|
"github.com/ossf/scorecard/v3/stats"
|
|
)
|
|
|
|
const checkRetries = 3
|
|
|
|
// Runner runs a check with retries.
|
|
type Runner struct {
|
|
CheckRequest CheckRequest
|
|
CheckName string
|
|
Repo string
|
|
}
|
|
|
|
// CheckFn defined for convenience.
|
|
type CheckFn func(*CheckRequest) CheckResult
|
|
|
|
// CheckNameToFnMap defined here for convenience.
|
|
type CheckNameToFnMap map[string]CheckFn
|
|
|
|
// UPGRADEv2: messages2 will ultimately
|
|
// be renamed to messages.
|
|
type logger struct {
|
|
messages2 []CheckDetail
|
|
}
|
|
|
|
func (l *logger) Info(desc string, args ...interface{}) {
|
|
cd := CheckDetail{Type: DetailInfo, Msg: LogMessage{Text: fmt.Sprintf(desc, args...)}}
|
|
l.messages2 = append(l.messages2, cd)
|
|
}
|
|
|
|
func (l *logger) Warn(desc string, args ...interface{}) {
|
|
cd := CheckDetail{Type: DetailWarn, Msg: LogMessage{Text: fmt.Sprintf(desc, args...)}}
|
|
l.messages2 = append(l.messages2, cd)
|
|
}
|
|
|
|
func (l *logger) Debug(desc string, args ...interface{}) {
|
|
cd := CheckDetail{Type: DetailDebug, Msg: LogMessage{Text: fmt.Sprintf(desc, args...)}}
|
|
l.messages2 = append(l.messages2, cd)
|
|
}
|
|
|
|
// UPGRADEv3: to rename.
|
|
func (l *logger) Info3(msg *LogMessage) {
|
|
cd := CheckDetail{
|
|
Type: DetailInfo,
|
|
Msg: *msg,
|
|
}
|
|
cd.Msg.Version = 3
|
|
l.messages2 = append(l.messages2, cd)
|
|
}
|
|
|
|
func (l *logger) Warn3(msg *LogMessage) {
|
|
cd := CheckDetail{
|
|
Type: DetailWarn,
|
|
Msg: *msg,
|
|
}
|
|
cd.Msg.Version = 3
|
|
l.messages2 = append(l.messages2, cd)
|
|
}
|
|
|
|
func (l *logger) Debug3(msg *LogMessage) {
|
|
cd := CheckDetail{
|
|
Type: DetailDebug,
|
|
Msg: *msg,
|
|
}
|
|
cd.Msg.Version = 3
|
|
l.messages2 = append(l.messages2, cd)
|
|
}
|
|
|
|
func logStats(ctx context.Context, startTime time.Time, result *CheckResult) error {
|
|
runTimeInSecs := time.Now().Unix() - startTime.Unix()
|
|
opencensusstats.Record(ctx, stats.CheckRuntimeInSec.M(runTimeInSecs))
|
|
|
|
if result.Error != nil {
|
|
ctx, err := tag.New(ctx, tag.Upsert(stats.ErrorName, sce.GetName(result.Error2)))
|
|
if err != nil {
|
|
return sce.WithMessage(sce.ErrScorecardInternal, fmt.Sprintf("tag.New: %v", err))
|
|
}
|
|
opencensusstats.Record(ctx, stats.CheckErrors.M(1))
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Run runs a given check.
|
|
func (r *Runner) Run(ctx context.Context, f CheckFn) CheckResult {
|
|
ctx, err := tag.New(ctx, tag.Upsert(stats.CheckName, r.CheckName))
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
startTime := time.Now()
|
|
|
|
var res CheckResult
|
|
var l logger
|
|
for retriesRemaining := checkRetries; retriesRemaining > 0; retriesRemaining-- {
|
|
checkRequest := r.CheckRequest
|
|
checkRequest.Ctx = ctx
|
|
l = logger{}
|
|
checkRequest.Dlogger = &l
|
|
res = f(&checkRequest)
|
|
if res.Error2 != nil && errors.Is(res.Error2, sce.ErrRepoUnreachable) {
|
|
checkRequest.Dlogger.Warn("%v", res.Error2)
|
|
continue
|
|
}
|
|
break
|
|
}
|
|
|
|
res.Details2 = l.messages2
|
|
for _, d := range l.messages2 {
|
|
res.Details = append(res.Details, d.Msg.Text)
|
|
}
|
|
if err := logStats(ctx, startTime, &res); err != nil {
|
|
panic(err)
|
|
}
|
|
return res
|
|
}
|