mirror of
https://github.com/ossf/scorecard.git
synced 2024-09-19 04:57:14 +03:00
110e352273
* Add make targets and E2E test target for GitLab only Signed-off-by: Raghav Kaul <raghavkaul@google.com> * Add GitLab support to RepoClient Signed-off-by: Raghav Kaul <raghavkaul@google.com> * Build * Make target for e2e-gitlab-token * Only run Gitlab tests in CI that don't require a token Signed-off-by: Raghav Kaul <raghavkaul@google.com> * Add tests Signed-off-by: Raghav Kaul <raghavkaul@google.com> * Remove spurious printf Signed-off-by: Raghav Kaul <raghavkaul@google.com> * 🐛 Check OSS Fuzz build file for Fuzzing check (#2719) * Check OSS-Fuzz using project list Signed-off-by: Spencer Schrock <sschrock@google.com> * Use clients.RepoClient interface to perform the new OSS Fuzz check Signed-off-by: Spencer Schrock <sschrock@google.com> * wip: add eager client for better repeated lookup of projects Signed-off-by: Spencer Schrock <sschrock@google.com> * Split lazy and eager behavior into different implementations. Signed-off-by: Spencer Schrock <sschrock@google.com> * Add tests and benchmarks Signed-off-by: Spencer Schrock <sschrock@google.com> * Switch to always parsing JSON to determine if a project is present. The other approach of looking for a substring match would lead to false positives. Signed-off-by: Spencer Schrock <sschrock@google.com> * Add eager constructor to surface status file errors sooner. Signed-off-by: Spencer Schrock <sschrock@google.com> * Switch existing users to new OSS Fuzz client Signed-off-by: Spencer Schrock <sschrock@google.com> * Mark old method as deprecated in the godoc Signed-off-by: Spencer Schrock <sschrock@google.com> * remove unused comment. Signed-off-by: Spencer Schrock <sschrock@google.com> * Use new OSS Fuzz client in e2e test. Signed-off-by: Spencer Schrock <sschrock@google.com> * fix typo. Signed-off-by: Spencer Schrock <sschrock@google.com> * Fix potential path bug with test server. Signed-off-by: Spencer Schrock <sschrock@google.com> * Force include the two JSON files which were being ignored by .gitignore Signed-off-by: Spencer Schrock <sschrock@google.com> * trim the status json file Signed-off-by: Spencer Schrock <sschrock@google.com> --------- Signed-off-by: Spencer Schrock <sschrock@google.com> --------- Signed-off-by: Raghav Kaul <raghavkaul@google.com> Signed-off-by: Spencer Schrock <sschrock@google.com> Co-authored-by: Spencer Schrock <sschrock@google.com>
205 lines
7.0 KiB
Go
205 lines
7.0 KiB
Go
// Copyright 2021 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 e2e
|
|
|
|
import (
|
|
"os"
|
|
"strings"
|
|
|
|
. "github.com/onsi/ginkgo/v2"
|
|
. "github.com/onsi/gomega"
|
|
"gopkg.in/yaml.v2"
|
|
|
|
"github.com/ossf/scorecard/v4/attestor/command"
|
|
"github.com/ossf/scorecard/v4/attestor/policy"
|
|
)
|
|
|
|
var _ = Describe("E2E TEST PAT: scorecard-attestor policy", func() {
|
|
Context("E2E TEST:Validating scorecard attestation policy", func() {
|
|
It("Should attest to repos based on policy", func() {
|
|
tt := []struct {
|
|
name string
|
|
repoURL string
|
|
commit string
|
|
policy policy.AttestationPolicy
|
|
expected policy.PolicyResult
|
|
}{
|
|
{
|
|
name: "test good repo",
|
|
repoURL: "https://github.com/ossf-tests/scorecard-binauthz-test-good",
|
|
policy: policy.AttestationPolicy{
|
|
PreventBinaryArtifacts: true,
|
|
PreventKnownVulnerabilities: true,
|
|
PreventUnpinnedDependencies: true,
|
|
},
|
|
expected: policy.Pass,
|
|
},
|
|
{
|
|
name: "test bad repo with vulnerabilities prevented but no known vulnerabilities",
|
|
repoURL: "https://github.com/ossf-tests/scorecard-binauthz-test-bad",
|
|
policy: policy.AttestationPolicy{
|
|
PreventKnownVulnerabilities: true,
|
|
},
|
|
expected: policy.Pass,
|
|
},
|
|
{
|
|
name: "test bad repo with ignored binary artifact",
|
|
repoURL: "https://github.com/ossf-tests/scorecard-binauthz-test-bad",
|
|
policy: policy.AttestationPolicy{
|
|
PreventBinaryArtifacts: true,
|
|
AllowedBinaryArtifacts: []string{"test-binary-artifact-*"},
|
|
PreventKnownVulnerabilities: true,
|
|
},
|
|
expected: policy.Pass,
|
|
},
|
|
{
|
|
name: "test bad repo with ignored binary artifact",
|
|
repoURL: "https://github.com/ossf-tests/scorecard-binauthz-test-bad",
|
|
policy: policy.AttestationPolicy{
|
|
PreventBinaryArtifacts: true,
|
|
PreventKnownVulnerabilities: true,
|
|
},
|
|
expected: policy.Fail,
|
|
},
|
|
{
|
|
name: "test bad repo with ignored dep by path",
|
|
repoURL: "https://github.com/ossf-tests/scorecard-binauthz-test-bad",
|
|
policy: policy.AttestationPolicy{
|
|
PreventUnpinnedDependencies: true,
|
|
AllowedUnpinnedDependencies: []policy.Dependency{{Filepath: "Dockerfile"}},
|
|
},
|
|
expected: policy.Pass,
|
|
},
|
|
{
|
|
name: "test bad repo without ignored dep",
|
|
repoURL: "https://github.com/ossf-tests/scorecard-binauthz-test-bad",
|
|
policy: policy.AttestationPolicy{
|
|
PreventUnpinnedDependencies: true,
|
|
},
|
|
expected: policy.Fail,
|
|
},
|
|
{
|
|
name: "test bad repo with ignored dep by name",
|
|
repoURL: "https://github.com/ossf-tests/scorecard-binauthz-test-bad",
|
|
policy: policy.AttestationPolicy{
|
|
PreventUnpinnedDependencies: true,
|
|
AllowedUnpinnedDependencies: []policy.Dependency{{PackageName: "static-debian11"}, {PackageName: "golang"}},
|
|
},
|
|
expected: policy.Pass,
|
|
},
|
|
{
|
|
name: "test bad repo with everything ignored",
|
|
repoURL: "https://github.com/ossf-tests/scorecard-binauthz-test-bad",
|
|
policy: policy.AttestationPolicy{
|
|
PreventBinaryArtifacts: true,
|
|
AllowedBinaryArtifacts: []string{"test-binary-artifact-*"},
|
|
PreventKnownVulnerabilities: true,
|
|
PreventUnpinnedDependencies: true,
|
|
AllowedUnpinnedDependencies: []policy.Dependency{{Filepath: "Dockerfile"}},
|
|
},
|
|
expected: policy.Pass,
|
|
},
|
|
{
|
|
name: "test repo with simple code review requirements",
|
|
repoURL: "https://github.com/ossf/scorecard",
|
|
commit: "fa0592fab28aa92560f04e1ae8649dfff566ae2b",
|
|
policy: policy.AttestationPolicy{
|
|
EnsureCodeReviewed: true,
|
|
CodeReviewRequirements: policy.CodeReviewRequirements{
|
|
MinReviewers: 1,
|
|
},
|
|
},
|
|
expected: policy.Pass,
|
|
},
|
|
{
|
|
name: "test code reviews required but repo doesn't have code reviews",
|
|
repoURL: "https://github.com/ossf-tests/scorecard-binauthz-test-bad",
|
|
policy: policy.AttestationPolicy{
|
|
PreventBinaryArtifacts: true,
|
|
PreventKnownVulnerabilities: true,
|
|
PreventUnpinnedDependencies: true,
|
|
EnsureCodeReviewed: true,
|
|
},
|
|
expected: policy.Fail,
|
|
},
|
|
{
|
|
name: "test code reviews required with min reviewers",
|
|
repoURL: "https://github.com/ossf/scorecard",
|
|
commit: "fa0592fab28aa92560f04e1ae8649dfff566ae2b",
|
|
policy: policy.AttestationPolicy{
|
|
PreventBinaryArtifacts: true,
|
|
PreventKnownVulnerabilities: false,
|
|
PreventUnpinnedDependencies: true,
|
|
EnsureCodeReviewed: true,
|
|
CodeReviewRequirements: policy.CodeReviewRequirements{
|
|
MinReviewers: 1,
|
|
},
|
|
},
|
|
expected: policy.Pass,
|
|
},
|
|
{
|
|
name: "test code reviews required with min reviewers and required reviewers",
|
|
repoURL: "https://github.com/ossf/scorecard",
|
|
commit: "fa0592fab28aa92560f04e1ae8649dfff566ae2b",
|
|
policy: policy.AttestationPolicy{
|
|
PreventBinaryArtifacts: true,
|
|
PreventKnownVulnerabilities: false,
|
|
PreventUnpinnedDependencies: true,
|
|
EnsureCodeReviewed: true,
|
|
CodeReviewRequirements: policy.CodeReviewRequirements{
|
|
MinReviewers: 1,
|
|
RequiredApprovers: []string{"spencerschrock", "laurentsimon", "naveensrinivasan", "azeemshaikh38"},
|
|
},
|
|
},
|
|
expected: policy.Pass,
|
|
},
|
|
{
|
|
name: "test code reviews required with too many min reviewers but matching required reviewers",
|
|
repoURL: "https://github.com/ossf/scorecard",
|
|
commit: "fa0592fab28aa92560f04e1ae8649dfff566ae2b",
|
|
policy: policy.AttestationPolicy{
|
|
PreventBinaryArtifacts: true,
|
|
PreventKnownVulnerabilities: false,
|
|
PreventUnpinnedDependencies: true,
|
|
EnsureCodeReviewed: true,
|
|
CodeReviewRequirements: policy.CodeReviewRequirements{
|
|
MinReviewers: 2,
|
|
RequiredApprovers: []string{"spencerschrock", "laurentsimon", "naveensrinivasan", "azeemshaikh38"},
|
|
},
|
|
},
|
|
expected: policy.Fail,
|
|
},
|
|
}
|
|
|
|
for _, tc := range tt {
|
|
f, err := os.CreateTemp("/tmp", strings.ReplaceAll(tc.name, " ", "-"))
|
|
Expect(err).Should(BeNil())
|
|
defer os.Remove(f.Name())
|
|
|
|
buf, err := yaml.Marshal(tc.policy)
|
|
Expect(err).Should(BeNil())
|
|
|
|
nbytes, err := f.Write(buf)
|
|
Expect(err).Should(BeNil())
|
|
Expect(nbytes).Should(BeNumerically(">", 0))
|
|
|
|
result, err := command.RunCheckWithParams(tc.repoURL, tc.commit, f.Name())
|
|
Expect(err).Should(BeNil())
|
|
Expect(result).Should(BeEquivalentTo(tc.expected))
|
|
}
|
|
})
|
|
})
|
|
})
|