Add support for codecov

Author: aledbf

.github/workflows/ci-build.yaml

@@ -68,6 +68,8 @@ jobs:
         run: mkdir -p ~/go/src/github.com/gitpod-io
       - name: Checkout code
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 10
       - name: Create symlink in GOPATH
         run: ln -s $(pwd) ~/go/src/github.com/gitpod-io/leeway
       - name: Setup Golang
@@ -100,6 +102,8 @@ jobs:
         run: mkdir -p ~/go/src/github.com/gitpod-io
       - name: Checkout code
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 10
       - name: Create symlink in GOPATH
         run: ln -s $(pwd) ~/go/src/github.com/gitpod-io/leeway
       - name: Setup Golang
@@ -126,7 +130,7 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v2
         with:
-          fetch-depth: 0
+          fetch-depth: 10
       - name: Create test-results directory
         run: |
           mkdir -p test-results

README.md

@@ -139,7 +139,7 @@ config:
   # [DEPRECATED: use buildCommand instead] A list of flags passed to `go build`. Useful for passing `ldflags`.
   buildFlags: []
   # Command that's executed to lint the code
-  lintCommand: ["golangci-lint", "run]
+  lintCommand: ["golangci-lint", "run"]
 ```
 
 ### Yarn packages
@@ -213,7 +213,7 @@ This however can lead to subtle failure modes where a package built in one envir
 
 To prevent such issues, leeway computes an _environment manifest_ which contains the versions of the tools used, as well as some platform information.
 The entries in that manifest depend on the package types used by that workspace, e.g. if only `Go` packages exist in the workspace, only `go version`, [GOOS and GOARCH](https://golang.org/pkg/runtime/#pkg-constants) will be part of the manifest.
-You can inspect a workspace's environment manifest using `leeway describe environment-manifest`. 
+You can inspect a workspace's environment manifest using `leeway describe environment-manifest`.
 
 You can add your own entries to a workspace's environment manifest in the `WORKSPACE.yaml` like so:
 ```YAML

cmd/build.go

@@ -169,6 +169,7 @@ func addBuildFlags(cmd *cobra.Command) {
 	cmd.Flags().Bool("werft", false, "Produce werft CI compatible output")
 	cmd.Flags().Bool("dont-test", false, "Disable all package-level tests (defaults to false)")
 	cmd.Flags().UintP("max-concurrent-tasks", "j", uint(runtime.NumCPU()), "Limit the number of max concurrent build tasks - set to 0 to disable the limit")
+	cmd.Flags().String("coverage-output-path", "", "Output path where test coverage file will be copied after running tests")
 }
 
 func getBuildOpts(cmd *cobra.Command) ([]leeway.BuildOption, *leeway.FilesystemCache) {
@@ -263,6 +264,11 @@ func getBuildOpts(cmd *cobra.Command) ([]leeway.BuildOption, *leeway.FilesystemC
 		log.Fatal(err)
 	}
 
+	coverageOutputPath, _ := cmd.Flags().GetString("coverage-output-path")
+	if coverageOutputPath != "" {
+		_ = os.MkdirAll(coverageOutputPath, 0644)
+	}
+
 	return []leeway.BuildOption{
 		leeway.WithLocalCache(localCache),
 		leeway.WithRemoteCache(remoteCache),
@@ -272,6 +278,7 @@ func getBuildOpts(cmd *cobra.Command) ([]leeway.BuildOption, *leeway.FilesystemC
 		leeway.WithReporter(reporter),
 		leeway.WithDontTest(dontTest),
 		leeway.WithMaxConcurrentTasks(int64(maxConcurrentTasks)),
+		leeway.WithCoverageOutputPath(coverageOutputPath),
 	}, localCache
 }
 

pkg/leeway/build.go

@@ -9,6 +9,7 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"regexp"
 	"strings"
 	"sync"
 
@@ -204,6 +205,7 @@ type buildOptions struct {
 	BuildPlan              io.Writer
 	DontTest               bool
 	MaxConcurrentTasks     int64
+	CoverageOutputPath     string
 
 	context *buildContext
 }
@@ -279,6 +281,14 @@ func WithMaxConcurrentTasks(n int64) BuildOption {
 	}
 }
 
+// WithCoverageOutputPath configures coverage output directory
+func WithCoverageOutputPath(output string) BuildOption {
+	return func(opts *buildOptions) error {
+		opts.CoverageOutputPath = output
+		return nil
+	}
+}
+
 func withBuildContext(ctx *buildContext) BuildOption {
 	return func(opts *buildOptions) error {
 		opts.context = ctx
@@ -894,7 +904,7 @@ func (p *Package) buildGo(buildctx *buildContext, wd, result string) (err error)
 	if cfg.Generate {
 		commands = append(commands, []string{goCommand, "generate", "-v", "./..."})
 	}
-	commands = append(commands, []string{goCommand, "get", "-v", "./..."})
+
 	if !cfg.DontCheckGoFmt {
 		commands = append(commands, []string{"sh", "-c", `if [ ! $(go fmt ./... | wc -l) -eq 0 ]; then echo; echo; echo please gofmt your code; echo; echo; exit 1; fi`})
 	}
@@ -906,10 +916,17 @@ func (p *Package) buildGo(buildctx *buildContext, wd, result string) (err error)
 		}
 	}
 	if !cfg.DontTest && !buildctx.DontTest {
+		testArgs := []string{goCommand, "test", "-v"}
+		if buildctx.buildOptions.CoverageOutputPath != "" {
+			testArgs = append(testArgs, fmt.Sprintf("-coverprofile=%v", codecovComponentName(p.FullName())))
+		}
+
+		testArgs = append(testArgs, "./...")
+
 		commands = append(commands, [][]string{
 			// we build the test binaries in addition to running the tests regularly, so that downstream packages can run the tests in different environments
 			{"sh", "-c", "mkdir _tests; for i in $(" + goCommand + " list ./...); do " + goCommand + " test -c $i; [ -e $(basename $i).test ] && mv $(basename $i).test _tests; true; done"},
-			{goCommand, "test", "-v", "./..."},
+			testArgs,
 		}...)
 	}
 
@@ -929,6 +946,12 @@ func (p *Package) buildGo(buildctx *buildContext, wd, result string) (err error)
 		{"tar", "cfz", result, "."},
 	}...)
 
+	if !cfg.DontTest && !buildctx.DontTest {
+		commands = append(commands, [][]string{
+			{"sh", "-c", fmt.Sprintf(`[ -f "%v" ] && cp -f %v %v`, codecovComponentName(p.FullName()), codecovComponentName(p.FullName()), buildctx.buildOptions.CoverageOutputPath)},
+		}...)
+	}
+
 	return executeCommandsForPackage(buildctx, p, wd, commands)
 }
 
@@ -1156,3 +1179,9 @@ func (s *reporterStream) Write(buf []byte) (n int, err error) {
 	s.R.PackageBuildLog(s.P, s.IsErr, buf)
 	return len(buf), nil
 }
+
+func codecovComponentName(name string) string {
+	reg, _ := regexp.Compile("[^a-zA-Z0-9]+")
+	component := reg.ReplaceAllString(name, "-")
+	return strings.ToLower(component + "-coverage.out")
+}

pkg/leeway/build_test.go

@@ -0,0 +1,25 @@
+package leeway
+
+import (
+	"testing"
+)
+
+func TestCodecovComponentName(t *testing.T) {
+	tests := []struct {
+		Test     string
+		Package  string
+		Expected string
+	}{
+		{"valid package format", "components/ee/ws-scheduler", "components-ee-ws-scheduler-coverage.out"},
+		{"lower case", "COMPONENTS/gitpod-cli:app", "components-gitpod-cli-app-coverage.out"},
+		{"special character", "components/~ü:app", "components-app-coverage.out"},
+		{"with numbers", "components/1icens0r:app", "components-1icens0r-app-coverage.out"},
+	}
+
+	for _, test := range tests {
+		name := codecovComponentName(test.Package)
+		if name != test.Expected {
+			t.Errorf("%s: expected: %v, actual: %v", test.Test, test.Expected, name)
+		}
+	}
+}