scorecard/checks/maintained_test.go

// 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"
	"time"

	"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"
	scut "github.com/ossf/scorecard/v3/utests"
)

// nolint: gocognit
// ignoring the linter for cyclomatic complexity because it is a test func
// TestMaintained tests the maintained check.
func TestMaintained(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
		isarchived bool
		archiveerr error
		commits    []clients.Commit
		commiterr  error
		issues     []clients.Issue
		issueerr   error
		expected   checker.CheckResult
	}{
		{
			name:       "archived",
			isarchived: true,
			expected: checker.CheckResult{
				Score: 0,
			},
		},
		{
			name:       "archived",
			isarchived: true,
			archiveerr: errors.New("error"),
			expected: checker.CheckResult{
				Score: -1,
			},
		},
		{
			name:       "commit lookup error",
			isarchived: false,
			commits:    []clients.Commit{},
			commiterr:  errors.New("error"),
			issues:     []clients.Issue{},
			expected: checker.CheckResult{
				Score: -1,
			},
		},
		{
			name:       "issue lookup error",
			isarchived: false,
			issueerr:   errors.New("error"),
			issues:     []clients.Issue{},
			expected: checker.CheckResult{
				Score: -1,
			},
		},

		{
			name:       "repo with no commits or issues",
			isarchived: false,
			commits:    []clients.Commit{},
			issues:     []clients.Issue{},
			expected: checker.CheckResult{
				Score: 0,
			},
		},
		{
			name:       "repo with valid commits",
			isarchived: false,
			commits: []clients.Commit{
				{
					CommittedDate: time.Now().AddDate(0, 0, -1),
				},
				{
					CommittedDate: time.Now().AddDate(0, 0, -10),
				},
				{
					CommittedDate: time.Now().AddDate(0, 0, -11),
				},
				{
					CommittedDate: time.Now().AddDate(0, 0, -12),
				},
			},
			issues: []clients.Issue{},
			expected: checker.CheckResult{
				Score: 3,
			},
		},
	}

	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().IsArchived().DoAndReturn(func() (bool, error) {
				if tt.archiveerr != nil {
					return false, tt.archiveerr
				}
				return tt.isarchived, nil
			})

			if !tt.isarchived {
				mockRepo.EXPECT().ListCommits().DoAndReturn(
					func() ([]clients.Commit, error) {
						if tt.commiterr != nil {
							return nil, tt.commiterr
						}
						return tt.commits, tt.err
					},
				).MinTimes(1)
				if tt.commiterr == nil {
					mockRepo.EXPECT().ListIssues().DoAndReturn(
						func() ([]clients.Issue, error) {
							if tt.issueerr != nil {
								return nil, tt.issueerr
							}
							return tt.issues, tt.err
						},
					).MinTimes(1)
				}
			}

			req := checker.CheckRequest{
				RepoClient: mockRepo,
			}
			req.Dlogger = &scut.TestDetailLogger{}
			res := IsMaintained(&req)

			if tt.err != nil {
				if res.Error2 == 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)
			}
			if res.Pass != tt.expected.Pass {
				t.Errorf("Expected pass %t, got %t for %v", tt.expected.Pass, res.Pass, tt.name)
			}
			ctrl.Finish()
		})
	}
}