mirror of
https://github.com/ossf/scorecard.git
synced 2024-09-17 11:57:12 +03:00
68 lines
2.0 KiB
Go
68 lines
2.0 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"
|
|
|
|
"github.com/ossf/scorecard/v5/clients"
|
|
"github.com/ossf/scorecard/v5/internal/packageclient"
|
|
)
|
|
|
|
// CheckRequest struct encapsulates all data to be passed into a CheckFn.
|
|
type CheckRequest struct {
|
|
Ctx context.Context
|
|
RepoClient clients.RepoClient
|
|
CIIClient clients.CIIBestPracticesClient
|
|
OssFuzzRepo clients.RepoClient
|
|
Dlogger DetailLogger
|
|
Repo clients.Repo
|
|
VulnerabilitiesClient clients.VulnerabilitiesClient
|
|
ProjectClient packageclient.ProjectPackageClient
|
|
// UPGRADEv6: return raw results instead of scores.
|
|
RawResults *RawResults
|
|
RequiredTypes []RequestType
|
|
}
|
|
|
|
// RequestType identifies special requirements/attributes that need to be supported by checks.
|
|
type RequestType int
|
|
|
|
const (
|
|
// FileBased request types require checks to run solely on file-content.
|
|
FileBased RequestType = iota
|
|
// CommitBased request types require checks to run on non-HEAD commit content.
|
|
CommitBased
|
|
)
|
|
|
|
// ListUnsupported returns []RequestType not in `supported` and are `required`.
|
|
func ListUnsupported(required, supported []RequestType) []RequestType {
|
|
var ret []RequestType
|
|
for _, t := range required {
|
|
if !contains(supported, t) {
|
|
ret = append(ret, t)
|
|
}
|
|
}
|
|
return ret
|
|
}
|
|
|
|
func contains(in []RequestType, exists RequestType) bool {
|
|
for _, r := range in {
|
|
if r == exists {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|