fix tests like in ossf#3409

Signed-off-by: AdamKorcz <[email protected]>
AdamKorcz · Sep 28, 2023 · b44d2d0 · b44d2d0
1 parent b6aa192
commit b44d2d0
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 49 deletions.
diff --git a/checks/contributors.go b/checks/contributors.go
@@ -53,5 +53,5 @@ func Contributors(c *checker.CheckRequest) checker.CheckResult {
 	}
 
 	// Return the score evaluation.
-	return evaluation.Contributors(CheckContributors, findings)
+	return evaluation.Contributors(CheckContributors, findings, c.Dlogger)
 }
diff --git a/checks/evaluation/contributors.go b/checks/evaluation/contributors.go
@@ -29,6 +29,7 @@ const (
 
 func Contributors(name string,
 	findings []finding.Finding,
+	dl checker.DetailLogger,
 ) checker.CheckResult {
 	expectedProbes := []string{
 		contributorsFromOrgOrCompany.Probe,
@@ -46,6 +47,7 @@ func Contributors(name string,
 		// are added for other contributors metrics. Right now, it the
 		// scoring is designed for a single probe that returns true
 		// or false.
+		// checker.LogFindings(nonNegativeFindings(findings), dl) TODO: Uncomment this line
 		return checker.CreateMaxScoreResult(name, reason)
 	}
 

diff --git a/checks/evaluation/contributors_test.go b/checks/evaluation/contributors_test.go
@@ -16,79 +16,64 @@ package evaluation
 import (
 	"testing"
 
-	"github.com/google/go-cmp/cmp"
-	"github.com/google/go-cmp/cmp/cmpopts"
-
 	"github.com/ossf/scorecard/v4/checker"
 	"github.com/ossf/scorecard/v4/finding"
+	scut "github.com/ossf/scorecard/v4/utests"
 )
 
 func TestContributors(t *testing.T) {
 	t.Parallel()
-	type args struct { //nolint
+	tests := []struct {
 		name     string
 		findings []finding.Finding
-	}
-	tests := []struct {
-		name string
-		args args
-		want checker.CheckResult
+		result   scut.TestReturn
 	}{
 		{
 			name: "Only has two positive outcomes",
-			args: args{
-				name: "Contributors",
-				findings: []finding.Finding{
-					{
-						Probe:   "contributorsFromOrgOrCompany",
-						Outcome: finding.OutcomePositive,
-					},
-					{
-						Probe:   "contributorsFromOrgOrCompany",
-						Outcome: finding.OutcomePositive,
-					},
+			findings: []finding.Finding{
+				{
+					Probe:   "contributorsFromOrgOrCompany",
+					Outcome: finding.OutcomePositive,
+				},
+				{
+					Probe:   "contributorsFromOrgOrCompany",
+					Outcome: finding.OutcomePositive,
 				},
 			},
-			want: checker.CheckResult{
-				Score:   0,
-				Version: 2,
-				Name:    "contributorsFromOrgOrCompany",
-				Reason:  "project has 2 contributing companies or organizations",
+			result: scut.TestReturn{
+				Score:        checker.MinResultScore,
+				NumberOfInfo: 0,
 			},
 		}, {
 			name: "Has two positive outcomes",
-			args: args{
-				name: "Contributors",
-				findings: []finding.Finding{
-					{
-						Probe:   "contributorsFromOrgOrCompany",
-						Outcome: finding.OutcomePositive,
-					},
-					{
-						Probe:   "contributorsFromOrgOrCompany",
-						Outcome: finding.OutcomePositive,
-					},
-					{
-						Probe:   "contributorsFromOrgOrCompany",
-						Outcome: finding.OutcomePositive,
-					},
+			findings: []finding.Finding{
+				{
+					Probe:   "contributorsFromOrgOrCompany",
+					Outcome: finding.OutcomePositive,
+				},
+				{
+					Probe:   "contributorsFromOrgOrCompany",
+					Outcome: finding.OutcomePositive,
+				},
+				{
+					Probe:   "contributorsFromOrgOrCompany",
+					Outcome: finding.OutcomePositive,
 				},
 			},
-			want: checker.CheckResult{
-				Score:   10,
-				Version: 2,
-				Name:    "contributorsFromOrgOrCompany",
-				Reason:  "project has 3 contributing companies or organizations",
+			result: scut.TestReturn{
+				Score:        checker.MaxResultScore,
+				NumberOfInfo: 0,
 			},
 		},
 	}
 	for _, tt := range tests {
 		tt := tt
 		t.Run(tt.name, func(t *testing.T) {
 			t.Parallel()
-			result := Contributors("contributorsFromOrgOrCompany", tt.args.findings)
-			if !cmp.Equal(result, tt.want, cmpopts.IgnoreFields(checker.CheckResult{}, "Error")) { //nolint:govet
-				t.Errorf("expected %v, got %v", tt.want, cmp.Diff(tt.want, result, cmpopts.IgnoreFields(checker.CheckResult{}, "Error"))) //nolint:lll
+			dl := scut.TestDetailLogger{}
+			got := Contributors(tt.name, tt.findings, &dl)
+			if !scut.ValidateTestReturn(t, tt.name, &tt.result, &got, &dl) {
+				t.Fatalf(tt.name)
 			}
 		})
 	}