mirror of
https://github.com/ossf/scorecard.git
synced 2024-09-11 00:45:36 +03:00
281 lines
5.7 KiB
Go
281 lines
5.7 KiB
Go
// Copyright 2022 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 checks
|
|
|
|
import (
|
|
"errors"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/golang/mock/gomock"
|
|
|
|
"github.com/ossf/scorecard/v4/checker"
|
|
"github.com/ossf/scorecard/v4/clients"
|
|
mockrepo "github.com/ossf/scorecard/v4/clients/mockclients"
|
|
scut "github.com/ossf/scorecard/v4/utests"
|
|
)
|
|
|
|
// TestCodeReview tests the code review checker.
|
|
func TestCodereview(t *testing.T) {
|
|
t.Parallel()
|
|
//fieldalignment lint issue. Ignoring it as it is not important for this test.
|
|
//nolint
|
|
tests := []struct {
|
|
err error
|
|
name string
|
|
commiterr error
|
|
commits []clients.Commit
|
|
expected checker.CheckResult
|
|
}{
|
|
{
|
|
name: "no commits",
|
|
expected: checker.CheckResult{
|
|
Score: -1,
|
|
},
|
|
},
|
|
{
|
|
name: "no commits with error",
|
|
commiterr: errors.New("error"),
|
|
expected: checker.CheckResult{
|
|
Score: -1,
|
|
},
|
|
},
|
|
{
|
|
name: "no PR's with error",
|
|
err: errors.New("error"),
|
|
expected: checker.CheckResult{
|
|
Score: -1,
|
|
},
|
|
},
|
|
{
|
|
name: "no PR's with error as well as commits",
|
|
err: errors.New("error"),
|
|
commiterr: errors.New("error"),
|
|
expected: checker.CheckResult{
|
|
Score: -1,
|
|
},
|
|
},
|
|
{
|
|
name: "Valid GitHub PR",
|
|
commits: []clients.Commit{
|
|
{
|
|
SHA: "sha",
|
|
Committer: clients.User{
|
|
Login: "user",
|
|
},
|
|
AssociatedMergeRequest: clients.PullRequest{
|
|
Number: 1,
|
|
MergedAt: time.Now(),
|
|
Reviews: []clients.Review{
|
|
{
|
|
State: "APPROVED",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
expected: checker.CheckResult{
|
|
Score: 10,
|
|
},
|
|
},
|
|
{
|
|
name: "Valid Prow PR as not a bot",
|
|
commits: []clients.Commit{
|
|
{
|
|
SHA: "sha",
|
|
Committer: clients.User{
|
|
Login: "user",
|
|
},
|
|
AssociatedMergeRequest: clients.PullRequest{
|
|
Number: 1,
|
|
MergedAt: time.Now(),
|
|
Labels: []clients.Label{
|
|
{
|
|
Name: "lgtm",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
expected: checker.CheckResult{
|
|
Score: 10,
|
|
},
|
|
},
|
|
{
|
|
name: "Valid Prow PR and commits as bot",
|
|
commits: []clients.Commit{
|
|
{
|
|
SHA: "sha",
|
|
Committer: clients.User{
|
|
Login: "bot",
|
|
},
|
|
AssociatedMergeRequest: clients.PullRequest{
|
|
Number: 1,
|
|
MergedAt: time.Now(),
|
|
Labels: []clients.Label{
|
|
{
|
|
Name: "lgtm",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
expected: checker.CheckResult{
|
|
Score: 10,
|
|
},
|
|
},
|
|
{
|
|
name: "Valid PR's and commits with merged by someone else",
|
|
commits: []clients.Commit{
|
|
{
|
|
SHA: "sha",
|
|
Committer: clients.User{
|
|
Login: "bob",
|
|
},
|
|
AssociatedMergeRequest: clients.PullRequest{
|
|
Number: 1,
|
|
Labels: []clients.Label{
|
|
{
|
|
Name: "lgtm",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
expected: checker.CheckResult{
|
|
Score: 0,
|
|
},
|
|
},
|
|
{
|
|
name: "2 PRs 2 review on GitHub",
|
|
commits: []clients.Commit{
|
|
{
|
|
SHA: "sha",
|
|
Committer: clients.User{
|
|
Login: "bob",
|
|
},
|
|
AssociatedMergeRequest: clients.PullRequest{
|
|
Number: 1,
|
|
MergedAt: time.Now(),
|
|
Reviews: []clients.Review{
|
|
{
|
|
State: "APPROVED",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
SHA: "sha2",
|
|
Committer: clients.User{
|
|
Login: "bob",
|
|
},
|
|
},
|
|
},
|
|
expected: checker.CheckResult{
|
|
Score: 5,
|
|
},
|
|
},
|
|
{
|
|
name: "Valid Phabricator commit",
|
|
commits: []clients.Commit{
|
|
{
|
|
SHA: "sha",
|
|
Committer: clients.User{
|
|
Login: "bob",
|
|
},
|
|
Message: "Title\nReviewed By: alice\nDifferential Revision: PHAB234",
|
|
},
|
|
},
|
|
expected: checker.CheckResult{
|
|
Score: 10,
|
|
},
|
|
},
|
|
{
|
|
name: "Phabricator like, missing differential",
|
|
commits: []clients.Commit{
|
|
{
|
|
SHA: "sha",
|
|
Committer: clients.User{
|
|
Login: "bob",
|
|
},
|
|
Message: "Title\nReviewed By: alice",
|
|
},
|
|
},
|
|
expected: checker.CheckResult{
|
|
Score: 0,
|
|
},
|
|
},
|
|
{
|
|
name: "Phabricator like, missing reviewed by",
|
|
commits: []clients.Commit{
|
|
{
|
|
SHA: "sha",
|
|
Committer: clients.User{
|
|
Login: "bob",
|
|
},
|
|
Message: "Title\nDifferential Revision: PHAB234",
|
|
},
|
|
},
|
|
expected: checker.CheckResult{
|
|
Score: 0,
|
|
},
|
|
},
|
|
{
|
|
name: "Valid piper commit",
|
|
commits: []clients.Commit{
|
|
{
|
|
SHA: "sha",
|
|
Committer: clients.User{
|
|
Login: "",
|
|
},
|
|
Message: "Title\nPiperOrigin-RevId: 444529962",
|
|
},
|
|
},
|
|
expected: checker.CheckResult{
|
|
Score: 10,
|
|
},
|
|
},
|
|
}
|
|
|
|
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()
|
|
ctrl := gomock.NewController(t)
|
|
mockRepo := mockrepo.NewMockRepoClient(ctrl)
|
|
mockRepo.EXPECT().ListCommits().Return(tt.commits, tt.err).AnyTimes()
|
|
|
|
req := checker.CheckRequest{
|
|
RepoClient: mockRepo,
|
|
}
|
|
req.Dlogger = &scut.TestDetailLogger{}
|
|
res := CodeReview(&req)
|
|
|
|
if tt.err != nil {
|
|
if res.Error == nil {
|
|
t.Errorf("Expected error %v, got nil", tt.err)
|
|
}
|
|
// return as we don't need to check the rest of the fields.
|
|
return
|
|
}
|
|
|
|
if res.Score != tt.expected.Score {
|
|
t.Errorf("Expected score %d, got %d for %v", tt.expected.Score, res.Score, tt.name)
|
|
}
|
|
ctrl.Finish()
|
|
})
|
|
}
|
|
}
|