reports are added to output only if thresholds are specified (#111)

Author: vladopajic

pkg/testcoverage/check_test.go

@@ -54,7 +54,7 @@ func TestCheck(t *testing.T) {
 		pass := Check(buf, cfg)
 		assert.True(t, pass)
 		assertGithubActionErrorsCount(t, buf.String(), 0)
-		assertHumanReport(t, buf.String(), 3, 0)
+		assertHumanReport(t, buf.String(), 1, 0)
 	})
 
 	t.Run("valid profile with exclude - pass", func(t *testing.T) {
@@ -71,7 +71,7 @@ func TestCheck(t *testing.T) {
 		pass := Check(buf, cfg)
 		assert.True(t, pass)
 		assertGithubActionErrorsCount(t, buf.String(), 0)
-		assertHumanReport(t, buf.String(), 3, 0)
+		assertHumanReport(t, buf.String(), 1, 0)
 	})
 
 	t.Run("valid profile - fail", func(t *testing.T) {
@@ -82,7 +82,7 @@ func TestCheck(t *testing.T) {
 		pass := Check(buf, cfg)
 		assert.False(t, pass)
 		assertGithubActionErrorsCount(t, buf.String(), 0)
-		assertHumanReport(t, buf.String(), 2, 1)
+		assertHumanReport(t, buf.String(), 0, 1)
 		assert.GreaterOrEqual(t, strings.Count(buf.String(), prefix), 0)
 	})
 
@@ -95,7 +95,7 @@ func TestCheck(t *testing.T) {
 		pass := Check(buf, cfg)
 		assert.True(t, pass)
 		assertGithubActionErrorsCount(t, buf.String(), 0)
-		assertHumanReport(t, buf.String(), 3, 0)
+		assertHumanReport(t, buf.String(), 1, 0)
 		assert.Equal(t, 0, strings.Count(buf.String(), prefix))
 	})
 
@@ -111,7 +111,7 @@ func TestCheck(t *testing.T) {
 		pass := Check(buf, cfg)
 		assert.True(t, pass)
 		assertGithubActionErrorsCount(t, buf.String(), 0)
-		assertHumanReport(t, buf.String(), 3, 0)
+		assertHumanReport(t, buf.String(), 1, 0)
 		assert.GreaterOrEqual(t, strings.Count(buf.String(), prefix), 0)
 	})
 
@@ -127,7 +127,7 @@ func TestCheck(t *testing.T) {
 		pass := Check(buf, cfg)
 		assert.False(t, pass)
 		assertGithubActionErrorsCount(t, buf.String(), 0)
-		assertHumanReport(t, buf.String(), 1, 2)
+		assertHumanReport(t, buf.String(), 0, 1)
 		assert.GreaterOrEqual(t, strings.Count(buf.String(), prefix), 0)
 	})
 
@@ -172,7 +172,7 @@ func TestCheckNoParallel(t *testing.T) {
 		pass := Check(buf, cfg)
 		assert.True(t, pass)
 		assertGithubActionErrorsCount(t, buf.String(), 0)
-		assertHumanReport(t, buf.String(), 3, 0)
+		assertHumanReport(t, buf.String(), 1, 0)
 		assertGithubOutputValues(t, testFile)
 	})
 
@@ -185,7 +185,7 @@ func TestCheckNoParallel(t *testing.T) {
 		pass := Check(buf, cfg)
 		assert.False(t, pass)
 		assertGithubActionErrorsCount(t, buf.String(), 1)
-		assertHumanReport(t, buf.String(), 2, 1)
+		assertHumanReport(t, buf.String(), 0, 1)
 		assertGithubOutputValues(t, testFile)
 	})
 }

pkg/testcoverage/report.go

@@ -31,21 +31,27 @@ func ReportForHuman(w io.Writer, result AnalyzeResult) {
 
 	thr := result.Threshold
 
-	// File threshold report
-	fmt.Fprintf(tabber, "File coverage threshold (%d%%) satisfied:\t", thr.File)
-	fmt.Fprint(tabber, statusStr(len(result.FilesBelowThreshold) == 0))
-	reportIssuesForHuman(tabber, result.FilesBelowThreshold)
+	if thr.File > 0 { // File threshold report
+		fmt.Fprintf(tabber, "File coverage threshold (%d%%) satisfied:\t", thr.File)
+		fmt.Fprint(tabber, statusStr(len(result.FilesBelowThreshold) == 0))
+		reportIssuesForHuman(tabber, result.FilesBelowThreshold)
+		fmt.Fprint(tabber, "\n")
+	}
 
-	// Package threshold report
-	fmt.Fprintf(tabber, "\nPackage coverage threshold (%d%%) satisfied:\t", thr.Package)
-	fmt.Fprint(tabber, statusStr(len(result.PackagesBelowThreshold) == 0))
-	reportIssuesForHuman(tabber, result.PackagesBelowThreshold)
+	if thr.Package > 0 { // Package threshold report
+		fmt.Fprintf(tabber, "Package coverage threshold (%d%%) satisfied:\t", thr.Package)
+		fmt.Fprint(tabber, statusStr(len(result.PackagesBelowThreshold) == 0))
+		reportIssuesForHuman(tabber, result.PackagesBelowThreshold)
+		fmt.Fprint(tabber, "\n")
+	}
 
-	// Total threshold report
-	fmt.Fprintf(tabber, "\nTotal coverage threshold (%d%%) satisfied:\t", thr.Total)
-	fmt.Fprint(tabber, statusStr(result.MeetsTotalCoverage))
+	if thr.Total > 0 { // Total threshold report
+		fmt.Fprintf(tabber, "Total coverage threshold (%d%%) satisfied:\t", thr.Total)
+		fmt.Fprint(tabber, statusStr(result.MeetsTotalCoverage))
+		fmt.Fprint(tabber, "\n")
+	}
 
-	fmt.Fprintf(tabber, "\nTotal test coverage: %d%%\n", result.TotalCoverage)
+	fmt.Fprintf(tabber, "Total test coverage: %d%%\n", result.TotalCoverage)
 }
 
 func reportIssuesForHuman(w io.Writer, coverageStats []coverage.Stats) {

pkg/testcoverage/report_test.go

@@ -16,20 +16,21 @@ func Test_ReportForHuman(t *testing.T) {
 	t.Parallel()
 
 	prefix := "organization.org"
+	thr := Threshold{100, 100, 100}
 
 	t.Run("all - pass", func(t *testing.T) {
 		t.Parallel()
 
 		buf := &bytes.Buffer{}
-		ReportForHuman(buf, AnalyzeResult{MeetsTotalCoverage: true})
+		ReportForHuman(buf, AnalyzeResult{Threshold: thr, MeetsTotalCoverage: true})
 		assertHumanReport(t, buf.String(), 3, 0)
 	})
 
 	t.Run("total coverage - fail", func(t *testing.T) {
 		t.Parallel()
 
 		buf := &bytes.Buffer{}
-		ReportForHuman(buf, AnalyzeResult{MeetsTotalCoverage: false})
+		ReportForHuman(buf, AnalyzeResult{Threshold: thr, MeetsTotalCoverage: false})
 		assertHumanReport(t, buf.String(), 2, 1)
 	})
 
@@ -42,7 +43,7 @@ func Test_ReportForHuman(t *testing.T) {
 		statsNoError := randStats(prefix, 10, 100)
 		result := Analyze(cfg, mergeStats(statsWithError, statsNoError))
 		ReportForHuman(buf, result)
-		assertHumanReport(t, buf.String(), 2, 1)
+		assertHumanReport(t, buf.String(), 0, 1)
 		assertContainStats(t, buf.String(), statsWithError)
 		assertNotContainStats(t, buf.String(), statsNoError)
 	})
@@ -56,7 +57,7 @@ func Test_ReportForHuman(t *testing.T) {
 		statsNoError := randStats(prefix, 10, 100)
 		result := Analyze(cfg, mergeStats(statsWithError, statsNoError))
 		ReportForHuman(buf, result)
-		assertHumanReport(t, buf.String(), 2, 1)
+		assertHumanReport(t, buf.String(), 0, 1)
 		assertContainStats(t, buf.String(), MakePackageStats(statsWithError))
 		assertNotContainStats(t, buf.String(), MakePackageStats(statsNoError))
 		assertNotContainStats(t, buf.String(), statsWithError)