mirror of
https://github.com/ossf/scorecard.git
synced 2024-08-15 19:30:40 +03:00
28337f13b1
* validate check names against full list Signed-off-by: Raghav Kaul <raghavkaul+github@google.com> * tests: close file Signed-off-by: Raghav Kaul <raghavkaul+github@google.com> * update Signed-off-by: Raghav Kaul <raghavkaul+github@google.com> * make private Signed-off-by: Raghav Kaul <raghavkaul+github@google.com> * Restructure imports Signed-off-by: Raghav Kaul <raghavkaul+github@google.com> * update Signed-off-by: Raghav Kaul <raghavkaul+github@google.com> --------- Signed-off-by: Raghav Kaul <raghavkaul+github@google.com>
84 lines
2.5 KiB
Go
84 lines
2.5 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 blocksDeleteOnBranches
|
|
|
|
import (
|
|
"embed"
|
|
"fmt"
|
|
|
|
"github.com/ossf/scorecard/v5/checker"
|
|
"github.com/ossf/scorecard/v5/finding"
|
|
"github.com/ossf/scorecard/v5/internal/checknames"
|
|
"github.com/ossf/scorecard/v5/internal/probes"
|
|
"github.com/ossf/scorecard/v5/probes/internal/utils/uerror"
|
|
)
|
|
|
|
func init() {
|
|
probes.MustRegister(Probe, Run, []checknames.CheckName{checknames.BranchProtection})
|
|
}
|
|
|
|
//go:embed *.yml
|
|
var fs embed.FS
|
|
|
|
const (
|
|
Probe = "blocksDeleteOnBranches"
|
|
BranchNameKey = "branchName"
|
|
)
|
|
|
|
func Run(raw *checker.RawResults) ([]finding.Finding, string, error) {
|
|
if raw == nil {
|
|
return nil, "", fmt.Errorf("%w: raw", uerror.ErrNil)
|
|
}
|
|
|
|
r := raw.BranchProtectionResults
|
|
var findings []finding.Finding
|
|
|
|
if len(r.Branches) == 0 {
|
|
f, err := finding.NewWith(fs, Probe, "no branches found", nil, finding.OutcomeNotApplicable)
|
|
if err != nil {
|
|
return nil, Probe, fmt.Errorf("create finding: %w", err)
|
|
}
|
|
findings = append(findings, *f)
|
|
return findings, Probe, nil
|
|
}
|
|
|
|
for i := range r.Branches {
|
|
branch := &r.Branches[i]
|
|
|
|
var text string
|
|
var outcome finding.Outcome
|
|
switch {
|
|
case branch.BranchProtectionRule.AllowDeletions == nil:
|
|
text = "could not determine whether branch is protected against deletion"
|
|
outcome = finding.OutcomeNotAvailable
|
|
case *branch.BranchProtectionRule.AllowDeletions:
|
|
text = fmt.Sprintf("'allow deletion' enabled on branch '%s'", *branch.Name)
|
|
outcome = finding.OutcomeFalse
|
|
case !*branch.BranchProtectionRule.AllowDeletions:
|
|
text = fmt.Sprintf("'allow deletion' disabled on branch '%s'", *branch.Name)
|
|
outcome = finding.OutcomeTrue
|
|
default:
|
|
}
|
|
f, err := finding.NewWith(fs, Probe, text, nil, outcome)
|
|
if err != nil {
|
|
return nil, Probe, fmt.Errorf("create finding: %w", err)
|
|
}
|
|
f = f.WithValue(BranchNameKey, *branch.Name)
|
|
findings = append(findings, *f)
|
|
}
|
|
return findings, Probe, nil
|
|
}
|