mirror of
https://github.com/ossf/scorecard.git
synced 2024-09-19 21:18:09 +03:00
137 lines
3.6 KiB
Go
137 lines
3.6 KiB
Go
// Copyright 2020 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 checker
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"time"
|
|
|
|
opencensusstats "go.opencensus.io/stats"
|
|
"go.opencensus.io/tag"
|
|
|
|
sce "github.com/ossf/scorecard/v5/errors"
|
|
"github.com/ossf/scorecard/v5/stats"
|
|
)
|
|
|
|
const checkRetries = 3
|
|
|
|
// Runner runs a check with retries.
|
|
type Runner struct {
|
|
CheckName string
|
|
Repo string
|
|
CheckRequest CheckRequest
|
|
}
|
|
|
|
// NewRunner creates a new instance of `Runner`.
|
|
func NewRunner(checkName, repo string, checkReq *CheckRequest) *Runner {
|
|
return &Runner{
|
|
CheckName: checkName,
|
|
Repo: repo,
|
|
CheckRequest: *checkReq,
|
|
}
|
|
}
|
|
|
|
// SetCheckName sets the check name.
|
|
func (r *Runner) SetCheckName(check string) {
|
|
r.CheckName = check
|
|
}
|
|
|
|
// SetRepo sets the repository.
|
|
func (r *Runner) SetRepo(repo string) {
|
|
r.Repo = repo
|
|
}
|
|
|
|
// SetCheckRequest sets the check request.
|
|
func (r *Runner) SetCheckRequest(checkReq *CheckRequest) {
|
|
r.CheckRequest = *checkReq
|
|
}
|
|
|
|
// CheckFn defined for convenience.
|
|
type CheckFn func(*CheckRequest) CheckResult
|
|
|
|
// Check defines a Scorecard check fn and its supported request types.
|
|
type Check struct {
|
|
Fn CheckFn
|
|
SupportedRequestTypes []RequestType
|
|
}
|
|
|
|
// CheckNameToFnMap defined here for convenience.
|
|
type CheckNameToFnMap map[string]Check
|
|
|
|
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.Error)))
|
|
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, c Check) CheckResult {
|
|
// Sanity check.
|
|
unsupported := ListUnsupported(r.CheckRequest.RequiredTypes, c.SupportedRequestTypes)
|
|
if len(unsupported) != 0 {
|
|
return CreateRuntimeErrorResult(r.CheckName,
|
|
sce.WithMessage(sce.ErrUnsupportedCheck,
|
|
fmt.Sprintf("requiredType: %s not supported by check %s", fmt.Sprint(unsupported), r.CheckName)))
|
|
}
|
|
|
|
l := NewLogger()
|
|
ctx, err := tag.New(ctx, tag.Upsert(stats.CheckName, r.CheckName))
|
|
if err != nil {
|
|
l.Warn(&LogMessage{Text: fmt.Sprintf("tag.New: %v", err)})
|
|
}
|
|
|
|
ctx, err = tag.New(ctx, tag.Upsert(stats.RepoHost, r.CheckRequest.Repo.Host()))
|
|
if err != nil {
|
|
l.Warn(&LogMessage{Text: fmt.Sprintf("tag.New: %v", err)})
|
|
}
|
|
|
|
startTime := time.Now()
|
|
|
|
var res CheckResult
|
|
l = NewLogger()
|
|
for retriesRemaining := checkRetries; retriesRemaining > 0; retriesRemaining-- {
|
|
checkRequest := r.CheckRequest
|
|
checkRequest.Ctx = ctx
|
|
checkRequest.Dlogger = l
|
|
res = c.Fn(&checkRequest)
|
|
if res.Error != nil && errors.Is(res.Error, sce.ErrRepoUnreachable) {
|
|
checkRequest.Dlogger.Warn(&LogMessage{
|
|
Text: fmt.Sprintf("%v", res.Error),
|
|
})
|
|
continue
|
|
}
|
|
break
|
|
}
|
|
|
|
// Set details.
|
|
// TODO(#1393): Remove.
|
|
res.Details = l.Flush()
|
|
|
|
if err := logStats(ctx, startTime, &res); err != nil {
|
|
panic(err)
|
|
}
|
|
return res
|
|
}
|