🌱 Unit tests for Fuzzing

Unit tests checks for fuzzing.

https://github.com/ossf/scorecard/issues/986
Signed-off-by: naveen <172697+naveensrinivasan@users.noreply.github.com>

checks/fuzzing_test.go

@@ -0,0 +1,308 @@
+// 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 (
+	"errors"
+	"testing"
+
+	"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"
+	sce "github.com/ossf/scorecard/v4/errors"
+	scut "github.com/ossf/scorecard/v4/utests"
+)
+
+// Test_checkOSSFuzz is a test function for checkOSSFuzz.
+func Test_checkOSSFuzz(t *testing.T) {
+	t.Parallel()
+	//nolint
+	tests := []struct {
+		name        string
+		want        bool
+		response    clients.SearchResponse
+		wantErr     bool
+		wantFuzzErr bool
+		expected    scut.TestReturn
+	}{
+		{
+			name:     "Test_checkOSSFuzz failure",
+			want:     false,
+			response: clients.SearchResponse{},
+			wantErr:  false,
+			expected: scut.TestReturn{
+				NumberOfWarn:  0,
+				NumberOfDebug: 0,
+				NumberOfInfo:  0,
+				Score:         0,
+			},
+		},
+		{
+			name: "Test_checkOSSFuzz success",
+			want: true,
+			response: clients.SearchResponse{
+				Hits: 1,
+			},
+			wantErr: false,
+			expected: scut.TestReturn{
+				NumberOfWarn:  0,
+				NumberOfDebug: 0,
+				NumberOfInfo:  0,
+				Score:         0,
+			},
+		},
+		{
+			name:    "error",
+			want:    false,
+			wantErr: true,
+			expected: scut.TestReturn{
+				NumberOfWarn:  0,
+				NumberOfDebug: 0,
+				NumberOfInfo:  0,
+				Score:         0,
+			},
+		},
+		{
+			name:        "Test_checkOSSFuzz fuzz error",
+			want:        false,
+			wantFuzzErr: true,
+			expected: scut.TestReturn{
+				Error:         nil,
+				NumberOfWarn:  0,
+				NumberOfDebug: 0,
+				NumberOfInfo:  0,
+				Score:         0,
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		tt := tt
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			ctrl := gomock.NewController(t)
+
+			mockFuzz := mockrepo.NewMockRepoClient(ctrl)
+			mockFuzz.EXPECT().URI().Return("github.com/ossf/scorecard").AnyTimes()
+			mockFuzz.EXPECT().Search(gomock.Any()).
+				DoAndReturn(func(q clients.SearchRequest) (clients.SearchResponse, error) {
+					if tt.wantErr {
+						//nolint
+						return clients.SearchResponse{}, errors.New("error")
+					}
+					return tt.response, nil
+				}).AnyTimes()
+
+			dl := scut.TestDetailLogger{}
+
+			req := checker.CheckRequest{
+				RepoClient:  mockFuzz,
+				OssFuzzRepo: mockFuzz,
+				Dlogger:     &dl,
+			}
+			if tt.wantFuzzErr {
+				req.OssFuzzRepo = nil
+			}
+
+			got, err := checkOSSFuzz(&req)
+
+			if (err != nil) != tt.wantErr {
+				t.Errorf("checkOSSFuzz() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if got != tt.want {
+				t.Errorf("checkOSSFuzz() = %v, want %v for %v", got, tt.want, tt.name)
+			}
+			if !scut.ValidateTestReturn(t, tt.name, &tt.expected, &checker.CheckResult{}, &dl) {
+				t.Fatalf(tt.name)
+			}
+		})
+	}
+}
+
+// Test_checkCFLite is a test function for checkCFLite.
+func Test_checkCFLite(t *testing.T) {
+	t.Parallel()
+	//nolint
+	tests := []struct {
+		name        string
+		want        bool
+		wantErr     bool
+		fileName    []string
+		fileContent string
+		expected    scut.TestReturn
+	}{
+		{
+			name:        "Test_checkCFLite success",
+			want:        false,
+			wantErr:     false,
+			fileName:    []string{"docker-compose.yml"},
+			fileContent: `# .clusterfuzzlite/Dockerfile`,
+			expected: scut.TestReturn{
+				NumberOfWarn:  0,
+				NumberOfDebug: 0,
+				NumberOfInfo:  0,
+				Score:         0,
+			},
+		},
+		{
+			name:     "Test_checkCFLite failure",
+			want:     false,
+			wantErr:  true,
+			fileName: []string{"docker-compose.yml"},
+			expected: scut.TestReturn{
+				NumberOfWarn:  0,
+				NumberOfDebug: 0,
+				NumberOfInfo:  0,
+				Score:         0,
+			},
+		},
+	}
+	for _, tt := range tests {
+		tt := tt
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+			ctrl := gomock.NewController(t)
+			defer ctrl.Finish()
+			mockFuzz := mockrepo.NewMockRepoClient(ctrl)
+			mockFuzz.EXPECT().ListFiles(gomock.Any()).Return(tt.fileName, nil).AnyTimes()
+			mockFuzz.EXPECT().GetFileContent(gomock.Any()).DoAndReturn(func(f string) (string, error) {
+				if tt.wantErr {
+					//nolint
+					return "", errors.New("error")
+				}
+				return tt.fileContent, nil
+			}).AnyTimes()
+			dl := scut.TestDetailLogger{}
+			req := checker.CheckRequest{
+				RepoClient: mockFuzz,
+				Dlogger:    &dl,
+			}
+			got, err := checkCFLite(&req)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("checkCFLite() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if got != tt.want {
+				t.Errorf("checkCFLite() = %v, want %v for test %v", got, tt.want, tt.name)
+			}
+			if !scut.ValidateTestReturn(t, tt.name, &tt.expected, &checker.CheckResult{}, &dl) {
+				t.Fatalf(tt.name)
+			}
+		})
+	}
+}
+
+// TestFuzzing is a test function for Fuzzing.
+func TestFuzzing(t *testing.T) {
+	t.Parallel()
+	//nolint
+	tests := []struct {
+		name        string
+		want        checker.CheckResult
+		response    clients.SearchResponse
+		wantErr     bool
+		wantFuzzErr bool
+		fileName    []string
+		fileContent string
+		expected    scut.TestReturn
+	}{
+		{
+			name:     "empty response",
+			response: clients.SearchResponse{},
+			wantErr:  false,
+		},
+		{
+			name: "hits 1",
+			response: clients.SearchResponse{
+				Hits: 1,
+			},
+			wantErr: false,
+			want:    checker.CheckResult{Score: 10},
+			expected: scut.TestReturn{
+				NumberOfWarn:  0,
+				NumberOfDebug: 0,
+				NumberOfInfo:  0,
+				Score:         10,
+			},
+		},
+		{
+			name:    "nil response",
+			wantErr: true,
+			want:    checker.CheckResult{Score: -1},
+			expected: scut.TestReturn{
+				Error:         sce.ErrScorecardInternal,
+				NumberOfWarn:  0,
+				NumberOfDebug: 0,
+				NumberOfInfo:  0,
+				Score:         -1,
+			},
+		},
+		{
+			name:        " error",
+			wantFuzzErr: true,
+			want:        checker.CheckResult{},
+		},
+	}
+	for _, tt := range tests {
+		tt := tt
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+			ctrl := gomock.NewController(t)
+
+			mockFuzz := mockrepo.NewMockRepoClient(ctrl)
+			mockFuzz.EXPECT().URI().Return("github.com/ossf/scorecard").AnyTimes()
+			mockFuzz.EXPECT().Search(gomock.Any()).
+				DoAndReturn(func(q clients.SearchRequest) (clients.SearchResponse, error) {
+					if tt.wantErr {
+						//nolint
+						return clients.SearchResponse{}, errors.New("error")
+					}
+					return tt.response, nil
+				}).AnyTimes()
+
+			mockFuzz.EXPECT().ListFiles(gomock.Any()).Return(tt.fileName, nil).AnyTimes()
+			mockFuzz.EXPECT().GetFileContent(gomock.Any()).DoAndReturn(func(f string) (string, error) {
+				if tt.wantErr {
+					//nolint
+					return "", errors.New("error")
+				}
+				return tt.fileContent, nil
+			}).AnyTimes()
+			dl := scut.TestDetailLogger{}
+			req := checker.CheckRequest{
+				RepoClient:  mockFuzz,
+				OssFuzzRepo: mockFuzz,
+				Dlogger:     &dl,
+			}
+			if tt.wantFuzzErr {
+				req.OssFuzzRepo = nil
+			}
+
+			result := Fuzzing(&req)
+			if (result.Error2 != nil) != tt.wantErr {
+				t.Errorf("Fuzzing() error = %v, wantErr %v", result.Error2, tt.wantErr)
+				return
+			}
+
+			if !scut.ValidateTestReturn(t, tt.name, &tt.expected, &result, &dl) {
+				t.Fatalf(tt.name, tt.expected)
+			}
+		})
+	}
+}