mirror of
https://github.com/ossf/scorecard.git
synced 2024-09-11 08:55:27 +03:00
* merge probe and finding packages No one interacts with the probes directly, and having them in the same package helps with follow up commits Signed-off-by: Spencer Schrock <sschrock@google.com> * add extra field to indicate the outcome a probe should show remediation for Signed-off-by: Spencer Schrock <sschrock@google.com> * start all probes with remediate on 'False' Signed-off-by: Spencer Schrock <sschrock@google.com> * make OutcomeTrue bad for hasOSVVulnerabilities Signed-off-by: Spencer Schrock <sschrock@google.com> * nest outcome trigger under remediation in yaml Signed-off-by: Spencer Schrock <sschrock@google.com> * invert outcomes for dangerous workflow probes Signed-off-by: Spencer Schrock <sschrock@google.com> * rename notArchived probe to archived with the swap, the true outcome is now the bad outcome. Signed-off-by: Spencer Schrock <sschrock@google.com> * rename notCreatedRecently probe to createRecently with the rename, the true outcome is now bad Signed-off-by: Spencer Schrock <sschrock@google.com> * switch binary artifact probes so detecting binaries is a true outcome Signed-off-by: Spencer Schrock <sschrock@google.com> * appease the linter Signed-off-by: Spencer Schrock <sschrock@google.com> * dont export probe type we can always make it public again later Signed-off-by: Spencer Schrock <sschrock@google.com> --------- Signed-off-by: Spencer Schrock <sschrock@google.com>
118 lines
2.9 KiB
Go
118 lines
2.9 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.
|
|
|
|
package finding
|
|
|
|
import (
|
|
"os"
|
|
"testing"
|
|
|
|
"github.com/google/go-cmp/cmp"
|
|
"github.com/google/go-cmp/cmp/cmpopts"
|
|
)
|
|
|
|
func Test_probeFromBytes(t *testing.T) {
|
|
t.Parallel()
|
|
//nolint:govet
|
|
tests := []struct {
|
|
name string
|
|
id string
|
|
path string
|
|
err error
|
|
probe *probe
|
|
}{
|
|
{
|
|
name: "all fields set",
|
|
id: "all-fields",
|
|
path: "testdata/all-fields.yml",
|
|
probe: &probe{
|
|
ID: "all-fields",
|
|
Short: "short description",
|
|
Implementation: "impl1 impl2\n",
|
|
Motivation: "mot1 mot2\n",
|
|
Remediation: &Remediation{
|
|
Text: "step1\nstep2 https://www.google.com/something",
|
|
Markdown: "step1\nstep2 [google.com](https://www.google.com/something)",
|
|
Effort: RemediationEffortLow,
|
|
},
|
|
RemediateOnOutcome: OutcomeFalse,
|
|
},
|
|
},
|
|
{
|
|
name: "mismatch probe ID",
|
|
id: "mismatch-id",
|
|
path: "testdata/all-fields.yml",
|
|
probe: &probe{
|
|
ID: "all-fields",
|
|
Short: "short description",
|
|
Implementation: "impl1 impl2\n",
|
|
Motivation: "mot1 mot2\n",
|
|
Remediation: &Remediation{
|
|
Text: "step1\nstep2 https://www.google.com/something",
|
|
Markdown: "step1\nstep2 [google.com](https://www.google.com/something)",
|
|
Effort: RemediationEffortLow,
|
|
},
|
|
},
|
|
err: errInvalid,
|
|
},
|
|
{
|
|
name: "missing id",
|
|
id: "missing-id",
|
|
path: "testdata/missing-id.yml",
|
|
err: errInvalid,
|
|
},
|
|
{
|
|
name: "invalid effort",
|
|
id: "invalid-effort",
|
|
path: "testdata/invalid-effort.yml",
|
|
err: errInvalid,
|
|
},
|
|
{
|
|
name: "invalid language",
|
|
id: "invalid-language",
|
|
path: "testdata/invalid-language.yml",
|
|
err: errInvalid,
|
|
},
|
|
{
|
|
name: "invalid client",
|
|
id: "invalid-client",
|
|
path: "testdata/invalid-client.yml",
|
|
err: errInvalid,
|
|
},
|
|
}
|
|
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()
|
|
|
|
content, err := os.ReadFile(tt.path)
|
|
if err != nil {
|
|
t.Fatalf(err.Error())
|
|
}
|
|
|
|
r, err := probeFromBytes(content, tt.id)
|
|
if err != nil || tt.err != nil {
|
|
if !errCmp(err, tt.err) {
|
|
t.Fatalf("unexpected error: %v", cmp.Diff(err, tt.err, cmpopts.EquateErrors()))
|
|
}
|
|
return
|
|
}
|
|
|
|
if diff := cmp.Diff(*tt.probe, *r); diff != "" {
|
|
t.Errorf("mismatch (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
}
|
|
}
|