2023-12-05 21:59:42 +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.
|
|
|
|
|
|
|
|
//nolint:stylecheck
|
|
|
|
package webhooksUseSecrets
|
|
|
|
|
|
|
|
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/clients"
|
|
|
|
"github.com/ossf/scorecard/v5/finding"
|
|
|
|
"github.com/ossf/scorecard/v5/probes/internal/utils/test"
|
2023-12-05 21:59:42 +03:00
|
|
|
)
|
|
|
|
|
|
|
|
func Test_Run(t *testing.T) {
|
|
|
|
t.Parallel()
|
|
|
|
//nolint:govet
|
|
|
|
tests := []struct {
|
|
|
|
name string
|
|
|
|
raw *checker.RawResults
|
|
|
|
outcomes []finding.Outcome
|
|
|
|
err error
|
|
|
|
}{
|
|
|
|
{
|
|
|
|
name: "No Webhooks",
|
|
|
|
raw: &checker.RawResults{
|
|
|
|
WebhookResults: checker.WebhooksData{
|
|
|
|
Webhooks: []clients.Webhook{},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
outcomes: []finding.Outcome{
|
|
|
|
finding.OutcomeNotApplicable,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "Webhooks present with auth secret",
|
|
|
|
raw: &checker.RawResults{
|
|
|
|
WebhookResults: checker.WebhooksData{
|
|
|
|
Webhooks: []clients.Webhook{
|
|
|
|
{
|
|
|
|
Path: "https://github.com/owner/repo/settings/hooks/1234",
|
|
|
|
ID: 1,
|
|
|
|
UsesAuthSecret: true,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
outcomes: []finding.Outcome{
|
2024-04-09 01:36:11 +03:00
|
|
|
finding.OutcomeTrue,
|
2023-12-05 21:59:42 +03:00
|
|
|
},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "Webhooks present without auth secret",
|
|
|
|
raw: &checker.RawResults{
|
|
|
|
WebhookResults: checker.WebhooksData{
|
|
|
|
Webhooks: []clients.Webhook{
|
|
|
|
{
|
|
|
|
Path: "https://github.com/owner/repo/settings/hooks/1234",
|
|
|
|
ID: 1,
|
|
|
|
UsesAuthSecret: false,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
outcomes: []finding.Outcome{
|
2024-04-09 01:36:11 +03:00
|
|
|
finding.OutcomeFalse,
|
2023-12-05 21:59:42 +03:00
|
|
|
},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "Multiple webhooks present, one without auth secret",
|
|
|
|
raw: &checker.RawResults{
|
|
|
|
WebhookResults: checker.WebhooksData{
|
|
|
|
Webhooks: []clients.Webhook{
|
|
|
|
{
|
|
|
|
Path: "https://github.com/owner/repo/settings/hooks/1234",
|
|
|
|
ID: 1,
|
|
|
|
UsesAuthSecret: false,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Path: "https://github.com/owner/repo/settings/hooks/12345",
|
|
|
|
ID: 2,
|
|
|
|
UsesAuthSecret: true,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Path: "https://github.com/owner/repo/settings/hooks/12346",
|
|
|
|
ID: 3,
|
|
|
|
UsesAuthSecret: true,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
outcomes: []finding.Outcome{
|
2024-04-09 01:36:11 +03:00
|
|
|
finding.OutcomeFalse, finding.OutcomeTrue, finding.OutcomeTrue,
|
2023-12-05 21:59:42 +03:00
|
|
|
},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: "Multiple webhooks present, two without auth secret",
|
|
|
|
raw: &checker.RawResults{
|
|
|
|
WebhookResults: checker.WebhooksData{
|
|
|
|
Webhooks: []clients.Webhook{
|
|
|
|
{
|
|
|
|
Path: "https://github.com/owner/repo/settings/hooks/1234",
|
|
|
|
ID: 1,
|
|
|
|
UsesAuthSecret: false,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Path: "https://github.com/owner/repo/settings/hooks/12345",
|
|
|
|
ID: 2,
|
|
|
|
UsesAuthSecret: true,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Path: "https://github.com/owner/repo/settings/hooks/12346",
|
|
|
|
ID: 3,
|
|
|
|
UsesAuthSecret: true,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Path: "https://github.com/owner/repo/settings/hooks/12346",
|
|
|
|
ID: 4,
|
|
|
|
UsesAuthSecret: false,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
outcomes: []finding.Outcome{
|
2024-04-09 01:36:11 +03:00
|
|
|
finding.OutcomeFalse, finding.OutcomeTrue,
|
|
|
|
finding.OutcomeTrue, finding.OutcomeFalse,
|
2023-12-05 21:59:42 +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-12-05 21:59:42 +03:00
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|