-
Notifications
You must be signed in to change notification settings - Fork 508
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Azeem Shaikh <[email protected]>
- Loading branch information
1 parent
d490455
commit 6223b66
Showing
16 changed files
with
410 additions
and
104 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| // Copyright 2020 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 ( | ||
| "context" | ||
| "errors" | ||
| "testing" | ||
|
|
||
| "github.com/golang/mock/gomock" | ||
|
|
||
| "github.com/ossf/scorecard/v3/checker" | ||
| "github.com/ossf/scorecard/v3/clients" | ||
| mockrepo "github.com/ossf/scorecard/v3/clients/mockclients" | ||
| sce "github.com/ossf/scorecard/v3/errors" | ||
| scut "github.com/ossf/scorecard/v3/utests" | ||
| ) | ||
|
|
||
| var errTest = errors.New("test error") | ||
|
|
||
| func TestCIIBestPractices(t *testing.T) { | ||
| t.Parallel() | ||
| tests := []struct { | ||
| err error | ||
| name string | ||
| uri string | ||
| expected scut.TestReturn | ||
| badgeLevel clients.BadgeLevel | ||
| }{ | ||
| { | ||
| name: "CheckURIUsed", | ||
| uri: "github.com/owner/repo", | ||
| badgeLevel: clients.NotFound, | ||
| expected: scut.TestReturn{ | ||
| Score: checker.MinResultScore, | ||
| }, | ||
| }, | ||
| { | ||
| name: "CheckErrorHandling", | ||
| err: errTest, | ||
| expected: scut.TestReturn{ | ||
| Score: -1, | ||
| Error: sce.ErrScorecardInternal, | ||
| }, | ||
| }, | ||
| { | ||
| name: "NotFoundBadge", | ||
| badgeLevel: clients.NotFound, | ||
| expected: scut.TestReturn{ | ||
| Score: checker.MinResultScore, | ||
| }, | ||
| }, | ||
| { | ||
| name: "InProgressBadge", | ||
| badgeLevel: clients.InProgress, | ||
| expected: scut.TestReturn{ | ||
| Score: inProgressScore, | ||
| }, | ||
| }, | ||
| { | ||
| name: "PassingBadge", | ||
| badgeLevel: clients.Passing, | ||
| expected: scut.TestReturn{ | ||
| Score: passingScore, | ||
| }, | ||
| }, | ||
| { | ||
| name: "SilverBadge", | ||
| badgeLevel: clients.Silver, | ||
| expected: scut.TestReturn{ | ||
| Score: silverScore, | ||
| }, | ||
| }, | ||
| { | ||
| name: "GoldBadge", | ||
| badgeLevel: clients.Gold, | ||
| expected: scut.TestReturn{ | ||
| Score: checker.MaxResultScore, | ||
| }, | ||
| }, | ||
| { | ||
| name: "UnknownBadge", | ||
| badgeLevel: clients.Unknown, | ||
| expected: scut.TestReturn{ | ||
| Score: -1, | ||
| Error: sce.ErrScorecardInternal, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| 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.NewMockRepo(ctrl) | ||
| mockRepo.EXPECT().URI().Return(tt.uri).AnyTimes() | ||
|
|
||
| mockCIIClient := mockrepo.NewMockCIIBestPracticesClient(ctrl) | ||
| mockCIIClient.EXPECT().GetBadgeLevel(gomock.Any(), tt.uri).DoAndReturn( | ||
| func(context.Context, string) (clients.BadgeLevel, error) { | ||
| return tt.badgeLevel, tt.err | ||
| }).MinTimes(1) | ||
|
|
||
| req := checker.CheckRequest{ | ||
| Repo: mockRepo, | ||
| CIIClient: mockCIIClient, | ||
| } | ||
| res := CIIBestPractices(&req) | ||
| dl := scut.TestDetailLogger{} | ||
| if !scut.ValidateTestReturn(t, tt.name, &tt.expected, &res, &dl) { | ||
| t.Fail() | ||
| } | ||
| ctrl.Finish() | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| // 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 clients | ||
|
|
||
| import ( | ||
| "context" | ||
| ) | ||
|
|
||
| // BadgeLevel corresponds to CII-Best-Practices badge levels. | ||
| // https://bestpractices.coreinfrastructure.org/en | ||
| type BadgeLevel uint | ||
|
|
||
| const ( | ||
| // Unknown or non-parsable CII Best Practices badge. | ||
| Unknown BadgeLevel = iota | ||
| // NotFound represents when CII Best Practices returns an empty response for a project. | ||
| NotFound | ||
| // InProgress state of CII Best Practices badge. | ||
| InProgress | ||
| // Passing level for CII Best Practices badge. | ||
| Passing | ||
| // Silver level for CII Best Practices badge. | ||
| Silver | ||
| // Gold level for CII Best Practices badge. | ||
| Gold | ||
| ) | ||
|
|
||
| // CIIBestPracticesClient interface returns the BadgeLevel for a repo URL. | ||
| type CIIBestPracticesClient interface { | ||
| GetBadgeLevel(ctx context.Context, uri string) (BadgeLevel, error) | ||
| } | ||
|
|
||
| // DefaultCIIBestPracticesClient returns HTTPClientCIIBestPractices implementation of the interface. | ||
| func DefaultCIIBestPracticesClient() CIIBestPracticesClient { | ||
| return &HTTPClientCIIBestPractices{} | ||
| } |
Oops, something went wrong.