etcd/main_test.go
Piotr Tabor c32180d772 tests/e2e,etcdctl,etcdmain: Fix go test --tags cov -v ./tests/e2e
This CL fixes:
  COVERDIR=./coverage PASSES="build_cov" && go test --tags cov -v ./tests/e2e
and is part of the effort to make:
  COVERDIR=coverage PASSES="build_cov cov" ./test
fully pass.

The args passed to ./bin/etcd_test and ./bin/etcdctl_test binaries were
mismatched. The protocol of passing the arguments using
environment variables has been replaces with proper passing of flags.

How the measurement of coverage by e2e tests works:
  1. COVERDIR=./coverage PASSES="build_cov" are generating
./bin/etcd_test and ./bin/etcdctl_test binaries.

  2. These binaries are tests (as coverage can be computed only for
tests) [see ./main_test.go ./etcdctl/main_test.go], but this tests are
running the main logic of the server and uppon termination (or SIGTERM
signal) are writting proper .coverprofile files in the $COVERDIR folder.
The binaries used to take arguments using env variables, but its not
needed any longer. The binaries can consume any command line arguments
that either test (so --test.fooo) or the original binary can consume.

 3.  The tests/e2e (when compiled with the --tags cov) are starting the
_test binaries instead of the original binaries, such that the coverage
is being collected.
2020-09-09 12:56:15 +02:00

69 lines
1.7 KiB
Go

// Copyright 2017 The etcd Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package main
import (
"log"
"os"
"os/signal"
"strings"
"syscall"
"testing"
"go.etcd.io/etcd/v3/etcdmain"
)
func SplitTestArgs(args []string) (testArgs, appArgs []string) {
for i, arg := range os.Args {
switch {
case strings.HasPrefix(arg, "-test."):
testArgs = append(testArgs, arg)
case i == 0:
appArgs = append(appArgs, arg)
testArgs = append(testArgs, arg)
default:
appArgs = append(appArgs, arg)
}
}
return
}
func TestEmpty(t *testing.T) {}
/**
* The purpose of this "test" is to run etcd server with code-coverage
* collection turned on. The technique is documented here:
*
* https://www.cyphar.com/blog/post/20170412-golang-integration-coverage
*/
func TestMain(m *testing.M) {
// don't launch etcd server when invoked via go test
if strings.HasSuffix(os.Args[0], ".test") {
log.Printf("skip launching etcd server when invoked via go test")
return
}
testArgs, appArgs := SplitTestArgs(os.Args)
notifier := make(chan os.Signal, 1)
signal.Notify(notifier, syscall.SIGINT, syscall.SIGTERM)
go etcdmain.Main(appArgs)
<-notifier
// This will generate coverage files:
os.Args = testArgs
m.Run()
}