platformtest: dedicated pool per test, Makefile target, maintainer notice

fixes #216
fixes #211

platformtest/harness/harness.go

@@ -4,9 +4,11 @@ import (
 	"context"
 	"flag"
 	"fmt"
+	"path/filepath"
 	"time"
 
 	"github.com/fatih/color"
+	"github.com/pkg/errors"
 	"github.com/zrepl/zrepl/config"
 	"github.com/zrepl/zrepl/daemon/logging"
 	"github.com/zrepl/zrepl/logger"
@@ -16,11 +18,14 @@ import (
 
 func main() {
 
-	root := flag.String("root", "", "empty root filesystem under which we conduct the platform test")
-	flag.Parse()
-	if *root == "" {
-		panic(*root)
+	var args struct {
+		createArgs platformtest.ZpoolCreateArgs
 	}
+	flag.StringVar(&args.createArgs.PoolName, "poolname", "", "")
+	flag.StringVar(&args.createArgs.ImagePath, "imagepath", "", "")
+	flag.Int64Var(&args.createArgs.ImageSize, "imagesize", 100*(1<<20), "")
+	flag.StringVar(&args.createArgs.Mountpoint, "mountpoint", "none", "")
+	flag.Parse()
 
 	outlets := logger.NewOutlets()
 	outlet, level, err := logging.ParseOutlet(config.LoggingOutletEnum{Ret: &config.StdoutLoggingOutlet{
@@ -35,17 +40,40 @@ func main() {
 	outlets.Add(outlet, level)
 	logger := logger.NewLogger(outlets, 1*time.Second)
 
-	ctx := &platformtest.Context{
-		Context:     platformtest.WithLogger(context.Background(), logger),
-		RootDataset: *root,
+	if err := args.createArgs.Validate(); err != nil {
+		logger.Error(err.Error())
+		panic(err)
 	}
+	ctx := platformtest.WithLogger(context.Background(), logger)
+	ex := platformtest.NewEx(logger)
 
 	bold := color.New(color.Bold)
 	for _, c := range tests.Cases {
-		bold.Printf("BEGIN TEST CASE %s\n", c)
-		c(ctx)
-		bold.Printf("DONE  TEST CASE %s\n", c)
-		fmt.Println()
+		// ATTENTION future parallelism must pass c by value into closure!
+		err := func() error {
+			bold.Printf("BEGIN TEST CASE %s\n", c)
+			pool, err := platformtest.CreateOrReplaceZpool(ctx, ex, args.createArgs)
+			if err != nil {
+				return errors.Wrap(err, "create test pool")
+			}
+			defer func() {
+				if err := pool.Destroy(ctx, ex); err != nil {
+					fmt.Printf("error destroying test pool: %s", err)
+				}
+			}()
+			ctx := &platformtest.Context{
+				Context:     ctx,
+				RootDataset: filepath.Join(pool.Name(), "rootds"),
+			}
+			c(ctx)
+			bold.Printf("DONE  TEST CASE %s\n", c)
+			fmt.Println()
+			return nil
+		}()
+		if err != nil {
+			bold.Printf("TEST CASE FAILED WITH ERROR:\n")
+			fmt.Println(err)
+		}
 	}
 
 }

platformtest/harness/harness_test.go

@@ -9,14 +9,14 @@ import (
 // Idea taken from
 // https://github.com/openSUSE/umoci/blob/v0.2.1/cmd/umoci/main_test.go
 //
-// How to generate coverage:
-// go test -c -covermode=atomic -cover -coverpkg github.com/zrepl/zrepl/...
-// sudo ../logmockzfs/logzfsenv /tmp/zrepl_platform_test.log /usr/bin/zfs \
-//     ./harness.test -test.coverprofile=/tmp/harness.out \
-//     -test.v __DEVEL--i-heard-you-like-tests \
-//     -root rpool/zreplplayground
-//  go tool cover -html=/tmp/harness.out -o /tmp/harness.html
-//
+/* How to generate coverage:
+   go test -c -covermode=atomic -cover -coverpkg github.com/zrepl/zrepl/...
+   sudo ../logmockzfs/logzfsenv /tmp/zrepl_platform_test.log /usr/bin/zfs \
+       ./harness.test -test.coverprofile=/tmp/harness.out \
+       -test.v __DEVEL--i-heard-you-like-tests \
+       -imagepath /tmp/testpool.img -poolname zreplplatformtest
+    go tool cover -html=/tmp/harness.out -o /tmp/harness.html
+*/
 // Merge with existing coverage reports using gocovmerge:
 //  https://github.com/wadey/gocovmerge