Make/itest: enable coverage output for tests and itests

Author: aakselrod

.github/workflows/docker-test.yml

@@ -16,3 +16,20 @@ jobs:
 
       - name: Run tests in docker container
         run:  make docker-test-all
+
+      - name: Upload unit test coverage
+        uses: shogo82148/actions-goveralls@v1
+        with:
+          path-to-profile: cover.out
+          parallel: true
+
+      - name: Upload integration test coverage
+        uses: shogo82148/actions-goveralls@v1
+        with:
+          path-to-profile: icover.out
+          parallel: true
+
+      - name: Generate coverage badge
+        uses: shogo82148/actions-goveralls@v1
+        with:
+          parallel-finished: true

Makefile

@@ -1,9 +1,11 @@
-.PHONY: docker docker-itest docker-test docker-test-all docker-check docker-shell itest test test-all
+.PHONY: cover docker docker-itest docker-test docker-test-all docker-check docker-shell itest test test-all
 
-IMG_NAME      := lndsigner-builder
+IMG_NAME    := lndsigner-builder
 
 CPLATFORM   := $(shell uname -m)
 
+GOCOVERDIR  := /tmp/lndsigner-icover-$(shell date +%s)
+
 ifeq ($(CPLATFORM), x86_64)
 	GOPLATFORM := amd64
 endif
@@ -55,11 +57,18 @@ docker-shell: docker
 		--mount type=bind,source=$(CURDIR),target=/app $(IMG_NAME):latest \
 		bash -l 
 
-itest:
-	go install -race -buildvcs=false ./cmd/... && go test -v -count=1 -race -tags=itest -cover ./itest
+cover:
+	mkdir $(GOCOVERDIR) && mkdir $(GOCOVERDIR)/lndsignerd && \
+		mkdir $(GOCOVERDIR)/plugin && mkdir $(GOCOVERDIR)/combined
+
+itest: cover
+	go install -race -cover -buildvcs=false ./cmd/... && \
+		GOCOVERDIR=$(GOCOVERDIR) go test -v -count=1 -race -tags=itest ./itest && \
+		go tool covdata merge -pcombine -i=$(GOCOVERDIR)/lndsignerd,$(GOCOVERDIR)/plugin -o=$(GOCOVERDIR)/combined && \
+		go tool covdata textfmt -i=$(GOCOVERDIR)/combined -o icover.out && \
+		rm -rf $(GOCOVERDIR)
 
 test:
-	go test -v -count=1 -race -cover ./...
+	go test -v -count=1 -race -coverprofile cover.out ./...
 
-test-all:
-	go install -race -buildvcs=false ./cmd/... && go test -v -count=1 -race -tags=itest -cover ./...
+test-all: test itest

README.md

@@ -1,3 +1,5 @@
+[![Coverage Status](https://coveralls.io/repos/github/NYDIG-OSS/lndsigner/badge.svg?branch=main)](https://coveralls.io/github/NYDIG-OSS/lndsigner?branch=main)
+
 # lndsigner
 `lndsigner` is a [remote signer](https://github.com/lightningnetwork/lnd/blob/master/docs/remote-signing.md) for [lnd](https://github.com/lightningnetwork/lnd). Currently, it can do the following:
 - [x] store seeds for multiple nodes in [Hashicorp Vault](https://github.com/hashicorp/vault/)

itest/itest_context_test.go

@@ -35,6 +35,7 @@ type testContext struct {
 	vaultPort   string
 	vaultCmd    *exec.Cmd
 	vaultClient *api.Logical
+	vaultSys    *api.Sys
 
 	bitcoinDir     string
 	bitcoinRPC     string
@@ -137,6 +138,11 @@ func newTestContext(t *testing.T) *testContext {
 		"-dev-root-token-id=root", "-dev-plugin-dir="+pluginDir,
 		"-dev-listen-address=127.0.0.1:"+tctx.vaultPort)
 
+	tctx.vaultCmd.Env = append(tctx.vaultCmd.Env,
+		"PATH="+os.Getenv("PATH"),
+		"GOCOVERDIR="+path.Join(os.Getenv("GOCOVERDIR"), "plugin"),
+	)
+
 	go waitProc(tctx.vaultCmd)
 
 	vaultClientConf := api.DefaultConfig()
@@ -148,9 +154,9 @@ func newTestContext(t *testing.T) *testContext {
 	vaultClient.SetToken("root")
 
 	tctx.vaultClient = vaultClient.Logical()
+	tctx.vaultSys = vaultClient.Sys()
 
-	vaultSys := vaultClient.Sys()
-	err = vaultSys.Mount("lndsigner", &api.MountInput{
+	err = tctx.vaultSys.Mount("lndsigner", &api.MountInput{
 		Type: "vault-plugin-lndsigner",
 	})
 	require.NoError(t, err)
@@ -213,6 +219,7 @@ func (tctx *testContext) Close() {
 		lnd.Close()
 	}
 
+	_ = tctx.vaultSys.Unmount("lndsigner")
 	_ = tctx.bitcoinCli("stop")
 	_ = tctx.vaultCmd.Process.Signal(os.Interrupt)
 

itest/itest_lndharness_test.go

@@ -14,8 +14,6 @@ import (
 	"encoding/json"
 	"encoding/pem"
 	"fmt"
-	"github.com/nydig-oss/lndsigner"
-	"github.com/nydig-oss/lndsigner/itest"
 	"io/fs"
 	"math/big"
 	"net"
@@ -25,6 +23,9 @@ import (
 	"testing"
 	"time"
 
+	"github.com/nydig-oss/lndsigner"
+	"github.com/nydig-oss/lndsigner/itest"
+
 	"github.com/stretchr/testify/require"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
@@ -95,8 +96,13 @@ func (l *lndHarness) Start() {
 	l.lndSignerCmd.Env = append(l.lndSignerCmd.Env,
 		"VAULT_ADDR=http://127.0.0.1:"+l.tctx.vaultPort,
 		"VAULT_TOKEN=root",
+		"GOCOVERDIR="+path.Join(os.Getenv("GOCOVERDIR"), "lndsignerd"),
 	)
 
+	l.lndSignerCmd.Cancel = func() error {
+		return l.lndSignerCmd.Process.Signal(os.Interrupt)
+	}
+
 	go waitProc(l.lndSignerCmd)
 
 	// Start lnd.
@@ -265,7 +271,9 @@ func waitFile(t *testing.T, file, waitStr string) {
 // exit error, the program's entire stderr and stdout are logged.
 func waitProc(cmd *exec.Cmd) {
 	output, err := cmd.CombinedOutput()
-	if err != nil && err.Error() != "signal: killed" {
+	if err != nil && err.Error() != "signal: killed" &&
+		err != context.Canceled {
+
 		config := zap.NewDevelopmentConfig()
 		config.EncoderConfig.EncodeLevel = zapcore.CapitalColorLevelEncoder
 		config.EncoderConfig.EncodeCaller = nil