2023-08-04 07:52:15 +03:00
|
|
|
// 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.
|
|
|
|
|
2023-11-15 22:44:28 +03:00
|
|
|
//nolint:stylecheck
|
2023-08-04 07:52:15 +03:00
|
|
|
package securityPolicyPresent
|
|
|
|
|
|
|
|
import (
|
|
|
|
"testing"
|
|
|
|
|
|
|
|
"github.com/google/go-cmp/cmp"
|
|
|
|
"github.com/google/go-cmp/cmp/cmpopts"
|
|
|
|
|
2024-04-13 00:51:50 +03:00
|
|
|
"github.com/ossf/scorecard/v5/checker"
|
|
|
|
"github.com/ossf/scorecard/v5/finding"
|
|
|
|
"github.com/ossf/scorecard/v5/probes/internal/utils/test"
|
|
|
|
"github.com/ossf/scorecard/v5/probes/internal/utils/uerror"
|
2023-08-04 07:52:15 +03:00
|
|
|
)
|
|
|
|
|
|
|
|
func Test_Run(t *testing.T) {
|
|
|
|
t.Parallel()
|
2023-11-15 22:44:28 +03:00
|
|
|
//nolint:govet
|
2023-08-04 07:52:15 +03:00
|
|
|
tests := []struct {
|
|
|
|
name string
|
|
|
|
raw *checker.RawResults
|
|
|
|
outcomes []finding.Outcome
|
|
|
|
err error
|
|
|
|
}{
|
|
|
|
{
|
|
|
|
name: "file present on repo",
|
|
|
|
raw: &checker.RawResults{
|
|
|
|
SecurityPolicyResults: checker.SecurityPolicyData{
|
|
|
|
PolicyFiles: []checker.SecurityPolicyFile{
|
|
|
|
{
|
|
|
|
File: checker.File{
|
|
|
|
Path: "SECURITY.md",
|
|
|
|
Type: finding.FileTypeText,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
outcomes: []finding.Outcome{
|
2024-04-09 01:36:11 +03:00
|
|
|
finding.OutcomeTrue,
|
2023-08-04 07:52:15 +03:00
|
|
|
},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "file present on org",
|
|
|
|
raw: &checker.RawResults{
|
|
|
|
SecurityPolicyResults: checker.SecurityPolicyData{
|
|
|
|
PolicyFiles: []checker.SecurityPolicyFile{
|
|
|
|
{
|
|
|
|
File: checker.File{
|
|
|
|
Path: "SECURITY.md",
|
|
|
|
Type: finding.FileTypeURL,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
outcomes: []finding.Outcome{
|
2024-04-09 01:36:11 +03:00
|
|
|
finding.OutcomeTrue,
|
2023-08-04 07:52:15 +03:00
|
|
|
},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "files present on org and repo",
|
|
|
|
raw: &checker.RawResults{
|
|
|
|
SecurityPolicyResults: checker.SecurityPolicyData{
|
|
|
|
PolicyFiles: []checker.SecurityPolicyFile{
|
|
|
|
{
|
|
|
|
File: checker.File{
|
|
|
|
Path: "SECURITY.md",
|
|
|
|
Type: finding.FileTypeURL,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
File: checker.File{
|
|
|
|
Path: "SECURITY.md",
|
|
|
|
Type: finding.FileTypeText,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
outcomes: []finding.Outcome{
|
2024-04-09 01:36:11 +03:00
|
|
|
finding.OutcomeTrue,
|
|
|
|
finding.OutcomeTrue,
|
2023-08-04 07:52:15 +03:00
|
|
|
},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "file not present",
|
|
|
|
raw: &checker.RawResults{},
|
|
|
|
outcomes: []finding.Outcome{
|
2024-04-09 01:36:11 +03:00
|
|
|
finding.OutcomeFalse,
|
2023-08-04 07:52:15 +03:00
|
|
|
},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "nil raw",
|
2023-08-21 23:16:41 +03:00
|
|
|
err: uerror.ErrNil,
|
2023-08-04 07:52:15 +03:00
|
|
|
},
|
|
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
|
|
tt := tt // Re-initializing variable so it is not changed while executing the closure below
|
|
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
|
|
t.Parallel()
|
|
|
|
|
|
|
|
findings, s, err := Run(tt.raw)
|
|
|
|
if !cmp.Equal(tt.err, err, cmpopts.EquateErrors()) {
|
|
|
|
t.Errorf("mismatch (-want +got):\n%s", cmp.Diff(tt.err, err, cmpopts.EquateErrors()))
|
|
|
|
}
|
|
|
|
if err != nil {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
if diff := cmp.Diff(Probe, s); diff != "" {
|
|
|
|
t.Errorf("mismatch (-want +got):\n%s", diff)
|
|
|
|
}
|
2024-01-10 21:00:04 +03:00
|
|
|
test.AssertOutcomes(t, findings, tt.outcomes)
|
2023-08-04 07:52:15 +03:00
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|