private/testmonkit: move monkit test helper
Some tests do not use testplanet and hence testmonkit should be reusable. Change-Id: If6b7194a199d9ffba5eb1a91f38d3a792f883336
This commit is contained in:
Egon Elbre
parent
5b4a9070b0
commit
4020e9e2ce
134
private/testmonkit/run.go
Normal file
134
private/testmonkit/run.go
Normal file
@ -0,0 +1,134 @@
|
||||
// Copyright (C) 2021 Storj Labs, Inc.
|
||||
// See LICENSE for copying information
|
||||
|
||||
// Package testmonkit allows attaching monkit monitoring for testing.
|
||||
//
|
||||
// It allows to set an environment variable to get a trace per test.
|
||||
//
|
||||
// STORJ_TEST_MONKIT=svg
|
||||
// STORJ_TEST_MONKIT=json
|
||||
//
|
||||
// By default, it saves the output the same folder as the test. However, if you wish
|
||||
// to specify a separate folder, you can specify an absolute directory:
|
||||
//
|
||||
// STORJ_TEST_MONKIT=json,svg,dir=/home/user/debug/trace
|
||||
//
|
||||
// Note, due to how go tests work, it's not possible to specify a relative directory.
|
||||
package testmonkit
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/spacemonkeygo/monkit/v3"
|
||||
"github.com/spacemonkeygo/monkit/v3/collect"
|
||||
"github.com/spacemonkeygo/monkit/v3/present"
|
||||
)
|
||||
|
||||
var mon = monkit.Package()
|
||||
|
||||
// Config defines configuration for monkit test output.
|
||||
type Config struct {
|
||||
Disabled bool
|
||||
Dir string
|
||||
Outputs []string
|
||||
}
|
||||
|
||||
// Run attaches monkit tracing to the ctx where configuration is taken from STORJ_TEST_MONKIT.
|
||||
func Run(ctx context.Context, tb testing.TB, fn func(ctx context.Context)) {
|
||||
RunWith(ctx, tb, EnvConfig(tb), fn)
|
||||
}
|
||||
|
||||
// RunWith attaches monkit to the ctx with custom configuration.
|
||||
func RunWith(parentCtx context.Context, tb testing.TB, cfg Config, fn func(ctx context.Context)) {
|
||||
if cfg.Disabled {
|
||||
fn(parentCtx)
|
||||
return
|
||||
}
|
||||
|
||||
done := mon.Task()(&parentCtx)
|
||||
spans := collect.CollectSpans(parentCtx, fn)
|
||||
done(nil)
|
||||
|
||||
baseName := sanitizeFileName(tb.Name())
|
||||
|
||||
for _, outputType := range cfg.Outputs {
|
||||
var data bytes.Buffer
|
||||
|
||||
var err error
|
||||
switch outputType {
|
||||
case "svg":
|
||||
err = present.SpansToSVG(&data, spans)
|
||||
case "json":
|
||||
err = present.SpansToJSON(&data, spans)
|
||||
}
|
||||
if err != nil {
|
||||
tb.Error(err)
|
||||
}
|
||||
|
||||
path := filepath.Join(cfg.Dir, baseName+".test."+outputType)
|
||||
err = os.WriteFile(path, data.Bytes(), 0644)
|
||||
if err != nil {
|
||||
tb.Errorf("failed to write %q: %v", path, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
var supportedOutputs = map[string]bool{
|
||||
"svg": true,
|
||||
"json": true,
|
||||
}
|
||||
|
||||
// EnvConfig loads test monkit configuration from STORJ_TEST_MONKIT environment variable.
|
||||
func EnvConfig(tb testing.TB) Config {
|
||||
value := os.Getenv("STORJ_TEST_MONKIT")
|
||||
if value == "" {
|
||||
return Config{Disabled: true}
|
||||
}
|
||||
|
||||
cfg := Config{}
|
||||
|
||||
for _, tag := range strings.Split(value, ",") {
|
||||
tokens := strings.SplitN(tag, "=", 2)
|
||||
if len(tokens) <= 1 {
|
||||
tag = strings.TrimSpace(tag)
|
||||
if !supportedOutputs[tag] {
|
||||
tb.Errorf("testmonkit: unknown output type %q", tag)
|
||||
continue
|
||||
}
|
||||
cfg.Outputs = append(cfg.Outputs, tag)
|
||||
continue
|
||||
}
|
||||
|
||||
key, value := strings.TrimSpace(tokens[0]), strings.TrimSpace(tokens[1])
|
||||
switch key {
|
||||
case "dir":
|
||||
cfg.Dir = value
|
||||
case "type":
|
||||
cfg.Outputs = append(cfg.Outputs, strings.TrimSpace(tag))
|
||||
default:
|
||||
tb.Errorf("testmonkit: unhandled key=%q value=%q", key, value)
|
||||
}
|
||||
}
|
||||
|
||||
return cfg
|
||||
}
|
||||
|
||||
func sanitizeFileName(s string) string {
|
||||
var b strings.Builder
|
||||
for _, x := range s {
|
||||
switch {
|
||||
case 'a' <= x && x <= 'z':
|
||||
b.WriteRune(x)
|
||||
case 'A' <= x && x <= 'Z':
|
||||
b.WriteRune(x)
|
||||
case '0' <= x && x <= '9':
|
||||
b.WriteRune(x)
|
||||
}
|
||||
}
|
||||
return b.String()
|
||||
}
|
||||
19
private/testmonkit/run_test.go
Normal file
19
private/testmonkit/run_test.go
Normal file
@ -0,0 +1,19 @@
|
||||
// Copyright (C) 2021 Storj Labs, Inc.
|
||||
// See LICENSE for copying information
|
||||
|
||||
package testmonkit_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"storj.io/storj/private/testmonkit"
|
||||
)
|
||||
|
||||
func TestBasic(t *testing.T) {
|
||||
// Set STORJ_TEST_MONKIT=svg,json for this to see the output.
|
||||
testmonkit.Run(context.Background(), t, func(ctx context.Context) {
|
||||
time.Sleep(100 * time.Millisecond)
|
||||
})
|
||||
}
|
||||
@ -4,20 +4,13 @@
|
||||
package testplanet
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"runtime/pprof"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/spacemonkeygo/monkit/v3/collect"
|
||||
"github.com/spacemonkeygo/monkit/v3/present"
|
||||
"go.uber.org/zap"
|
||||
|
||||
"storj.io/common/testcontext"
|
||||
"storj.io/private/dbutil/pgtest"
|
||||
"storj.io/storj/private/testmonkit"
|
||||
"storj.io/storj/satellite/satellitedb/satellitedbtest"
|
||||
"storj.io/uplink"
|
||||
)
|
||||
@ -49,7 +42,7 @@ func Run(t *testing.T, config Config, test func(t *testing.T, ctx *testcontext.C
|
||||
|
||||
log := newLogger(t)
|
||||
|
||||
startPlanetAndTest := func(parent context.Context) {
|
||||
testmonkit.Run(context.Background(), t, func(parent context.Context) {
|
||||
ctx := testcontext.NewWithContext(parent, t)
|
||||
defer ctx.Cleanup()
|
||||
|
||||
@ -66,87 +59,11 @@ func Run(t *testing.T, config Config, test func(t *testing.T, ctx *testcontext.C
|
||||
|
||||
test(t, ctx, planet)
|
||||
})
|
||||
}
|
||||
|
||||
monkitConfig := os.Getenv("STORJ_TEST_MONKIT")
|
||||
if monkitConfig == "" {
|
||||
startPlanetAndTest(context.Background())
|
||||
} else {
|
||||
flags := parseMonkitFlags(monkitConfig)
|
||||
outDir := flags["dir"]
|
||||
if outDir != "" {
|
||||
if !filepath.IsAbs(outDir) {
|
||||
t.Fatalf("testplanet-monkit: dir must be an absolute path, but was %q", outDir)
|
||||
}
|
||||
}
|
||||
outType := flags["type"]
|
||||
|
||||
rootctx := context.Background()
|
||||
|
||||
done := mon.Task()(&rootctx)
|
||||
spans := collect.CollectSpans(rootctx, startPlanetAndTest)
|
||||
done(nil)
|
||||
|
||||
outPath := filepath.Join(outDir, sanitizeFileName(planetConfig.Name))
|
||||
var data bytes.Buffer
|
||||
|
||||
switch outType {
|
||||
default: // also svg
|
||||
if outType != "svg" {
|
||||
t.Logf("testplanet-monkit: unknown output type %q defaulting to svg", outType)
|
||||
}
|
||||
outPath += ".test.svg"
|
||||
err := present.SpansToSVG(&data, spans)
|
||||
if err != nil {
|
||||
t.Error(err)
|
||||
}
|
||||
|
||||
case "json":
|
||||
outPath += ".test.json"
|
||||
err := present.SpansToJSON(&data, spans)
|
||||
if err != nil {
|
||||
t.Error(err)
|
||||
}
|
||||
}
|
||||
|
||||
err := os.WriteFile(outPath, data.Bytes(), 0644)
|
||||
if err != nil {
|
||||
log.Error("failed to write svg", zap.String("path", outPath), zap.Error(err))
|
||||
}
|
||||
}
|
||||
})
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func parseMonkitFlags(s string) map[string]string {
|
||||
r := make(map[string]string)
|
||||
for _, tag := range strings.Split(s, ",") {
|
||||
tokens := strings.SplitN(tag, "=", 2)
|
||||
if len(tokens) <= 1 {
|
||||
r["type"] = strings.TrimSpace(tag)
|
||||
continue
|
||||
}
|
||||
key, value := strings.TrimSpace(tokens[0]), strings.TrimSpace(tokens[1])
|
||||
r[key] = value
|
||||
}
|
||||
return r
|
||||
}
|
||||
|
||||
func sanitizeFileName(s string) string {
|
||||
var b strings.Builder
|
||||
for _, x := range s {
|
||||
switch {
|
||||
case 'a' <= x && x <= 'z':
|
||||
b.WriteRune(x)
|
||||
case 'A' <= x && x <= 'Z':
|
||||
b.WriteRune(x)
|
||||
case '0' <= x && x <= '9':
|
||||
b.WriteRune(x)
|
||||
}
|
||||
}
|
||||
return b.String()
|
||||
}
|
||||
|
||||
func provisionUplinks(ctx context.Context, t *testing.T, planet *Planet) {
|
||||
for _, planetUplink := range planet.Uplinks {
|
||||
for _, satellite := range planet.Satellites {
|
||||
|
||||
Loading…
Reference in New Issue
Block a user