more test

Author: vladopajic

pkg/testcoverage/check_test.go

@@ -265,16 +265,109 @@ func TestCheck(t *testing.T) {
 		assert.Error(t, err)
 		assert.Contains(t, err.Error(), "failed to load base coverage breakdown")
 	})
+}
 
-	t.Run("valid profile - diff pass", func(t *testing.T) {
-		t.Parallel()
-		// add test
-	})
+func TestCheckDiff(t *testing.T) {
+	t.Parallel()
 
-	t.Run("valid profile - diff fail", func(t *testing.T) {
-		t.Parallel()
-		// add test
-	})
+	if testing.Short() {
+		return
+	}
+
+	brakedownFile := t.TempDir() + "/breakdown.testcoverage"
+	brakedownCurrentFile := t.TempDir() + "/breakdown-current.testcoverage"
+	brakedownFileEdited := "breakdown-edit.testcoverage"
+
+	// run check to generate brakedown file
+	cfg := Config{
+		Profile:           profileOK,
+		BreakdownFileName: brakedownFile,
+		SourceDir:         sourceDir,
+	}
+	buf := &bytes.Buffer{}
+	pass, err := Check(buf, cfg)
+	assert.True(t, pass)
+	assert.NoError(t, err)
+
+	// should pass since brakedown is the same
+	cfg = Config{
+		Profile:   profileOK,
+		SourceDir: sourceDir,
+		Diff: Diff{
+			BaseBreakdownFileName: brakedownFile,
+			Threshold:             ptr(0.0),
+		},
+	}
+	buf = &bytes.Buffer{}
+	pass, err = Check(buf, cfg)
+	assert.True(t, pass)
+	assert.NoError(t, err)
+	assertDiffNoChange(t, buf.String())
+	assertDiffPercentage(t, buf.String(), 0.0)
+	assertDiffThreshold(t, buf.String(), *cfg.Diff.Threshold, true)
+
+	// should pass since diff is negative
+	cfg = Config{
+		Profile:   profileOK,
+		SourceDir: sourceDir,
+		Diff: Diff{
+			BaseBreakdownFileName: brakedownFile,
+			Threshold:             ptr(-0.001),
+		},
+	}
+	buf = &bytes.Buffer{}
+	pass, err = Check(buf, cfg)
+	assert.True(t, pass)
+	assert.NoError(t, err)
+	assertDiffNoChange(t, buf.String())
+	assertDiffPercentage(t, buf.String(), 0.0)
+	assertDiffThreshold(t, buf.String(), *cfg.Diff.Threshold, true)
+
+	// should NOT pass since brakedown is the same, and diff is positive
+	cfg = Config{
+		Profile:   profileOK,
+		SourceDir: sourceDir,
+		Diff: Diff{
+			BaseBreakdownFileName: brakedownFile,
+			Threshold:             ptr(0.1),
+		},
+	}
+	buf = &bytes.Buffer{}
+	pass, err = Check(buf, cfg)
+	assert.False(t, pass)
+	assert.NoError(t, err)
+	assertDiffNoChange(t, buf.String())
+	assertDiffPercentage(t, buf.String(), 0.0)
+	assertDiffThreshold(t, buf.String(), *cfg.Diff.Threshold, false)
+
+	// change brakedown file to have positive difference
+	base := readStats(t, brakedownFile)
+	base[0].Covered = 0
+	base[1].Covered = 0
+
+	tmpFile, err := os.CreateTemp(t.TempDir(), brakedownFileEdited)
+	assert.NoError(t, err)
+	_, err = tmpFile.Write(coverage.StatsSerialize(base))
+	assert.NoError(t, err)
+
+	// check should now pass since difference has increased
+	cfg = Config{
+		Profile:           profileOK,
+		SourceDir:         sourceDir,
+		BreakdownFileName: brakedownCurrentFile,
+		Diff: Diff{
+			BaseBreakdownFileName: tmpFile.Name(),
+			Threshold:             ptr(1.0),
+		},
+	}
+	buf = &bytes.Buffer{}
+	pass, err = Check(buf, cfg)
+	assert.True(t, pass)
+	assert.NoError(t, err)
+
+	diff := TotalPercentageDiff(readStats(t, brakedownCurrentFile), base)
+	assertDiffPercentage(t, buf.String(), diff)
+	assertDiffThreshold(t, buf.String(), *cfg.Diff.Threshold, true)
 }
 
 //nolint:paralleltest // must not be parallel because it uses env

pkg/testcoverage/export_test.go

@@ -17,6 +17,7 @@ var (
 	LoadBaseCoverageBreakdown = loadBaseCoverageBreakdown
 	CompressUncoveredLines    = compressUncoveredLines
 	ReportUncoveredLines      = reportUncoveredLines
+	StatusStr                 = statusStr
 )
 
 type (

pkg/testcoverage/helpers_test.go

@@ -208,6 +208,21 @@ func assertDiffChange(t *testing.T, content string, lines int) {
 	assert.Contains(t, content, str)
 }
 
+func assertDiffThreshold(t *testing.T, content string, thr float64, isSatisfied bool) {
+	t.Helper()
+
+	//nolint:lll //relax
+	str := fmt.Sprintf("Coverage difference threshold (%.2f%%) satisfied:\t %s", thr, StatusStr(isSatisfied))
+	assert.Contains(t, content, str)
+}
+
+func assertDiffPercentage(t *testing.T, content string, p float64) {
+	t.Helper()
+
+	str := fmt.Sprintf("Coverage difference: %.2f%%", p)
+	assert.Contains(t, content, str)
+}
+
 func assertGithubActionErrorsCount(t *testing.T, content string, count int) {
 	t.Helper()
 
@@ -264,3 +279,15 @@ func assertGithubOutputValues(t *testing.T, file string) {
 	assertNonEmptyValue(t, content, GaOutputBadgeText)
 	assertNonEmptyValue(t, content, GaOutputReport)
 }
+
+func readStats(t *testing.T, file string) []coverage.Stats {
+	t.Helper()
+
+	contentBytes, err := os.ReadFile(file)
+	assert.NoError(t, err)
+	assert.NotEmpty(t, contentBytes)
+	stats, err := coverage.StatsDeserialize(contentBytes)
+	assert.NoError(t, err)
+
+	return stats
+}