Merge pull request #323 from k1LoW/coverage.exclude

Support coverage.exclude: for excluding files from coverage reports
k1LoW · Feb 8, 2024 · 108950a · 108950a
2 parents fcd4191 + 4a2ef03
commit 108950a
Show file tree

Hide file tree

Showing 12 changed files with 284 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -327,6 +327,17 @@ coverage:
     - tests/coverage.xml
 ```
 
+### `coverage.exclude:`
+
+Exclude files from the coverage report.
+
+``` yaml
+coverage:
+  exclude:
+    - 'cmd/*.go'
+    - 'proto/**/*.pb.go'
+```
+
 ### `coverage.acceptable:`
 
 acceptable coverage condition.

diff --git a/cmd/badge.go b/cmd/badge.go
@@ -29,9 +29,9 @@ import (
 	"strings"
 	"time"
 
+	"github.com/k1LoW/octocov/badge"
 	"github.com/k1LoW/octocov/config"
 	"github.com/k1LoW/octocov/internal"
-	"github.com/k1LoW/octocov/badge"
 	"github.com/k1LoW/octocov/report"
 	"github.com/spf13/cobra"
 )
@@ -85,7 +85,7 @@ var badgeCmd = &cobra.Command{
 			if err := c.CoverageConfigReady(); err != nil {
 				return err
 			}
-			if err := r.MeasureCoverage(c.Coverage.Paths); err != nil {
+			if err := r.MeasureCoverage(c.Coverage.Paths, c.Coverage.Exclude); err != nil {
 				return err
 			}
 			cp := r.CoveragePercent()

diff --git a/cmd/dump.go b/cmd/dump.go
@@ -59,7 +59,7 @@ var dumpCmd = &cobra.Command{
 		if err := c.CoverageConfigReady(); err != nil {
 			cmd.PrintErrf("Skip measuring code coverage: %v\n", err)
 		} else {
-			if err := r.MeasureCoverage(c.Coverage.Paths); err != nil {
+			if err := r.MeasureCoverage(c.Coverage.Paths, c.Coverage.Exclude); err != nil {
 				cmd.PrintErrf("Skip measuring code coverage: %v\n", err)
 			}
 		}

diff --git a/cmd/lsFiles.go b/cmd/lsFiles.go
@@ -61,7 +61,7 @@ var lsFilesCmd = &cobra.Command{
 		if err != nil {
 			return err
 		}
-		if err := r.MeasureCoverage(c.Coverage.Paths); err != nil {
+		if err := r.MeasureCoverage(c.Coverage.Paths, c.Coverage.Exclude); err != nil {
 			return err
 		}
 		t := 0

diff --git a/cmd/root.go b/cmd/root.go
@@ -169,7 +169,7 @@ var rootCmd = &cobra.Command{
 		if err := c.CoverageConfigReady(); err != nil {
 			cmd.PrintErrf("Skip measuring code coverage: %v\n", err)
 		} else {
-			if err := r.MeasureCoverage(c.Coverage.Paths); err != nil {
+			if err := r.MeasureCoverage(c.Coverage.Paths, c.Coverage.Exclude); err != nil {
 				cmd.PrintErrf("Skip measuring code coverage: %v\n", err)
 			}
 		}
@@ -358,7 +358,7 @@ var rootCmd = &cobra.Command{
 				if err != nil {
 					return err
 				}
-				if err := rt.MeasureCoverage([]string{c.Diff.Path}); err == nil {
+				if err := rt.MeasureCoverage([]string{c.Diff.Path}, c.Coverage.Exclude); err == nil {
 					if rPrev == nil || rPrev.Timestamp.UnixNano() < rt.Timestamp.UnixNano() {
 						rPrev = rt
 					}
@@ -508,7 +508,7 @@ func printMetrics(cmd *cobra.Command) error {
 	}
 
 	if err := c.CoverageConfigReady(); err == nil {
-		if err := r.MeasureCoverage(c.Coverage.Paths); err != nil {
+		if err := r.MeasureCoverage(c.Coverage.Paths, c.Coverage.Exclude); err != nil {
 			cmd.PrintErrf("Skip measuring code coverage: %v\n", err)
 		}
 	}

diff --git a/cmd/view.go b/cmd/view.go
@@ -57,7 +57,7 @@ var viewCmd = &cobra.Command{
 		if err != nil {
 			return err
 		}
-		if err := r.MeasureCoverage(c.Coverage.Paths); err != nil {
+		if err := r.MeasureCoverage(c.Coverage.Paths, c.Coverage.Exclude); err != nil {
 			return err
 		}
 		for _, f := range args {

diff --git a/config/config.go b/config/config.go
@@ -60,6 +60,7 @@ type Config struct {
 type Coverage struct {
 	Path       string        `yaml:"path,omitempty"`
 	Paths      []string      `yaml:"paths,omitempty"`
+	Exclude    []string      `yaml:"exclude,omitempty"`
 	Badge      CoverageBadge `yaml:"badge,omitempty"`
 	Acceptable string        `yaml:"acceptable,omitempty"`
 	If         string        `yaml:"if,omitempty"`

diff --git a/coverage/exclude.go b/coverage/exclude.go
@@ -0,0 +1,43 @@
+package coverage
+
+import (
+	"strings"
+
+	"github.com/bmatcuk/doublestar/v4"
+)
+
+func (c *Coverage) Exclude(exclude []string) error {
+	if len(exclude) == 0 {
+		return c.reCalc()
+	}
+
+	// Exclude files
+	var files FileCoverages
+	for i, f := range c.Files {
+		excluded := false
+		for _, e := range exclude {
+			not := false
+			if strings.HasPrefix(e, "!") {
+				e = strings.TrimPrefix(e, "!")
+				not = true
+			}
+			match, err := doublestar.Match(e, f.File)
+			if err != nil {
+				return err
+			}
+			if match {
+				if not {
+					excluded = false
+				} else {
+					excluded = true
+				}
+			}
+		}
+		if !excluded {
+			files = append(files, c.Files[i])
+		}
+	}
+	c.Files = files
+
+	return c.reCalc()
+}
diff --git a/coverage/exclude_test.go b/coverage/exclude_test.go
@@ -0,0 +1,210 @@
+package coverage
+
+import (
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+	"github.com/google/go-cmp/cmp/cmpopts"
+)
+
+func TestExclude(t *testing.T) {
+	tests := []struct {
+		c       *Coverage
+		exclude []string
+		want    *Coverage
+	}{
+		{
+			&Coverage{
+				Type: TypeLOC,
+				Files: FileCoverages{
+					&FileCoverage{
+						File: "file_a.go",
+						Blocks: BlockCoverages{
+							newBlockCoverage(TypeLOC, 1, -1, 1, -1, -1, 1),
+							newBlockCoverage(TypeLOC, 2, -1, 2, -1, -1, 0),
+							newBlockCoverage(TypeLOC, 3, -1, 3, -1, -1, 1),
+						},
+					},
+					&FileCoverage{
+						File: "file_b.go",
+						Blocks: BlockCoverages{
+							newBlockCoverage(TypeLOC, 1, -1, 1, -1, -1, 0),
+							newBlockCoverage(TypeLOC, 2, -1, 2, -1, -1, 1),
+							newBlockCoverage(TypeLOC, 3, -1, 3, -1, -1, 1),
+						},
+					},
+				},
+			},
+			[]string{},
+			&Coverage{
+				Type:    TypeLOC,
+				Total:   6,
+				Covered: 4,
+				Files: FileCoverages{
+					&FileCoverage{
+						File:    "file_a.go",
+						Total:   3,
+						Covered: 2,
+						Blocks: BlockCoverages{
+							newBlockCoverage(TypeLOC, 1, -1, 1, -1, -1, 1),
+							newBlockCoverage(TypeLOC, 2, -1, 2, -1, -1, 0),
+							newBlockCoverage(TypeLOC, 3, -1, 3, -1, -1, 1),
+						},
+					},
+					&FileCoverage{
+						File:    "file_b.go",
+						Total:   3,
+						Covered: 2,
+						Blocks: BlockCoverages{
+							newBlockCoverage(TypeLOC, 1, -1, 1, -1, -1, 0),
+							newBlockCoverage(TypeLOC, 2, -1, 2, -1, -1, 1),
+							newBlockCoverage(TypeLOC, 3, -1, 3, -1, -1, 1),
+						},
+					},
+				},
+			},
+		},
+		{
+			&Coverage{
+				Type: TypeLOC,
+				Files: FileCoverages{
+					&FileCoverage{
+						File: "file_a.go",
+						Blocks: BlockCoverages{
+							newBlockCoverage(TypeLOC, 1, -1, 1, -1, -1, 1),
+							newBlockCoverage(TypeLOC, 2, -1, 2, -1, -1, 0),
+							newBlockCoverage(TypeLOC, 3, -1, 3, -1, -1, 1),
+						},
+					},
+					&FileCoverage{
+						File: "file_b.go",
+						Blocks: BlockCoverages{
+							newBlockCoverage(TypeLOC, 1, -1, 1, -1, -1, 0),
+							newBlockCoverage(TypeLOC, 2, -1, 2, -1, -1, 1),
+							newBlockCoverage(TypeLOC, 3, -1, 3, -1, -1, 1),
+						},
+					},
+				},
+			},
+			[]string{
+				"file_a.go",
+			},
+			&Coverage{
+				Type:    TypeLOC,
+				Total:   3,
+				Covered: 2,
+				Files: FileCoverages{
+					&FileCoverage{
+						File:    "file_b.go",
+						Total:   3,
+						Covered: 2,
+						Blocks: BlockCoverages{
+							newBlockCoverage(TypeLOC, 1, -1, 1, -1, -1, 0),
+							newBlockCoverage(TypeLOC, 2, -1, 2, -1, -1, 1),
+							newBlockCoverage(TypeLOC, 3, -1, 3, -1, -1, 1),
+						},
+					},
+				},
+			},
+		},
+		{
+			&Coverage{
+				Type: TypeLOC,
+				Files: FileCoverages{
+					&FileCoverage{
+						File: "file_a.go",
+						Blocks: BlockCoverages{
+							newBlockCoverage(TypeLOC, 1, -1, 1, -1, -1, 1),
+							newBlockCoverage(TypeLOC, 2, -1, 2, -1, -1, 0),
+							newBlockCoverage(TypeLOC, 3, -1, 3, -1, -1, 1),
+						},
+					},
+					&FileCoverage{
+						File: "file_b.go",
+						Blocks: BlockCoverages{
+							newBlockCoverage(TypeLOC, 1, -1, 1, -1, -1, 0),
+							newBlockCoverage(TypeLOC, 2, -1, 2, -1, -1, 1),
+							newBlockCoverage(TypeLOC, 3, -1, 3, -1, -1, 1),
+						},
+					},
+				},
+			},
+			[]string{
+				"file_*.go",
+			},
+			&Coverage{
+				Type:    TypeLOC,
+				Total:   0,
+				Covered: 0,
+				Files:   nil,
+			},
+		},
+		{
+			&Coverage{
+				Type: TypeLOC,
+				Files: FileCoverages{
+					&FileCoverage{
+						File: "file_a.go",
+						Blocks: BlockCoverages{
+							newBlockCoverage(TypeLOC, 1, -1, 1, -1, -1, 1),
+							newBlockCoverage(TypeLOC, 2, -1, 2, -1, -1, 0),
+							newBlockCoverage(TypeLOC, 3, -1, 3, -1, -1, 1),
+						},
+					},
+					&FileCoverage{
+						File: "file_b.go",
+						Blocks: BlockCoverages{
+							newBlockCoverage(TypeLOC, 1, -1, 1, -1, -1, 0),
+							newBlockCoverage(TypeLOC, 2, -1, 2, -1, -1, 1),
+							newBlockCoverage(TypeLOC, 3, -1, 3, -1, -1, 1),
+						},
+					},
+				},
+			},
+			[]string{
+				"file_*.go",
+				"!**/*.go",
+			},
+			&Coverage{
+				Type:    TypeLOC,
+				Total:   6,
+				Covered: 4,
+				Files: FileCoverages{
+					&FileCoverage{
+						File:    "file_a.go",
+						Total:   3,
+						Covered: 2,
+						Blocks: BlockCoverages{
+							newBlockCoverage(TypeLOC, 1, -1, 1, -1, -1, 1),
+							newBlockCoverage(TypeLOC, 2, -1, 2, -1, -1, 0),
+							newBlockCoverage(TypeLOC, 3, -1, 3, -1, -1, 1),
+						},
+					},
+					&FileCoverage{
+						File:    "file_b.go",
+						Total:   3,
+						Covered: 2,
+						Blocks: BlockCoverages{
+							newBlockCoverage(TypeLOC, 1, -1, 1, -1, -1, 0),
+							newBlockCoverage(TypeLOC, 2, -1, 2, -1, -1, 1),
+							newBlockCoverage(TypeLOC, 3, -1, 3, -1, -1, 1),
+						},
+					},
+				},
+			},
+		},
+	}
+	for _, tt := range tests {
+		if err := tt.c.Exclude(tt.exclude); err != nil {
+			t.Fatal(err)
+		}
+		got := tt.c
+
+		opts := []cmp.Option{
+			cmpopts.IgnoreUnexported(FileCoverage{}),
+		}
+		if diff := cmp.Diff(tt.want, got, opts...); diff != "" {
+			t.Error(diff)
+		}
+	}
+}
diff --git a/coverage/merge.go b/coverage/merge.go
@@ -19,7 +19,10 @@ func (c *Coverage) Merge(c2 *Coverage) error {
 			c.Files = append(c.Files, fc2)
 		}
 	}
-	// Recalculate
+	return c.reCalc()
+}
+
+func (c *Coverage) reCalc() error {
 	total := 0
 	covered := 0
 	for _, f := range c.Files {

diff --git a/report/report.go b/report/report.go
@@ -297,7 +297,7 @@ func (r *Report) Load(path string) error {
 	return nil
 }
 
-func (r *Report) MeasureCoverage(paths []string) error {
+func (r *Report) MeasureCoverage(paths, exclude []string) error {
 	if len(paths) == 0 {
 		return fmt.Errorf("coverage report not found: %s", paths)
 	}
@@ -333,6 +333,11 @@ func (r *Report) MeasureCoverage(paths []string) error {
 		return cerr
 	}
 
+	if err := r.Coverage.Exclude(exclude); err != nil {
+		cerr = multierror.Append(cerr, err)
+		return cerr
+	}
+
 	return nil
 }
 

diff --git a/report/report_test.go b/report/report_test.go
@@ -109,7 +109,7 @@ func TestMeasureCoverage(t *testing.T) {
 	}
 	for _, tt := range tests {
 		r := &Report{}
-		if err := r.MeasureCoverage(tt.paths); err != nil {
+		if err := r.MeasureCoverage(tt.paths, nil); err != nil {
 			if !tt.wantErr {
 				t.Error(err)
 			}