forked from cockroachdb/cockroach
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
107548: roachtest/mixedversion: monitor nodes in every test r=herkolategan,srosenberg a=renatolabs This PR includes a few changes related to the roachprod/roachtest monitor itself, and integrates it with the `mixedversion` package. Specifically, the changes are as follows (each bullet point corresponds to a commit): * emit structured events from the roachprod monitor; this removes the need to perform string parsing on callers. * change `mixedversion` framework to monitor nodes by default. An unexpected node death immediately fails the test. * move public functions on the `*mixedversion.Helper` struct to its own file, for ease of browsing. * update the README with instructions on background tasks; most importantly, mixedversion tests can't use `cluster.NewMonitor` like other roachtests. Epic: CRDB-19321 Release notes: None Co-authored-by: Renato Costa <[email protected]>
- Loading branch information
Showing
12 changed files
with
465 additions
and
210 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| // Copyright 2023 The Cockroach Authors. | ||
| // | ||
| // Use of this software is governed by the Business Source License | ||
| // included in the file licenses/BSL.txt. | ||
| // | ||
| // As of the Change Date specified in that file, in accordance with | ||
| // the Business Source License, use of this software will be governed | ||
| // by the Apache License, Version 2.0, included in the file | ||
| // licenses/APL.txt. | ||
|
|
||
| package mixedversion | ||
|
|
||
| import ( | ||
| "context" | ||
| gosql "database/sql" | ||
| "fmt" | ||
| "math/rand" | ||
| "path" | ||
| "strings" | ||
| "sync/atomic" | ||
|
|
||
| "github.com/cockroachdb/cockroach/pkg/cmd/roachtest/option" | ||
| "github.com/cockroachdb/cockroach/pkg/roachprod/logger" | ||
| ) | ||
|
|
||
| func (h *Helper) RandomNode(prng *rand.Rand, nodes option.NodeListOption) int { | ||
| return nodes[prng.Intn(len(nodes))] | ||
| } | ||
|
|
||
| // RandomDB returns a (nodeID, connection) tuple for a randomly picked | ||
| // cockroach node according to the parameters passed. | ||
| func (h *Helper) RandomDB(prng *rand.Rand, nodes option.NodeListOption) (int, *gosql.DB) { | ||
| node := h.RandomNode(prng, nodes) | ||
| return node, h.Connect(node) | ||
| } | ||
|
|
||
| // QueryRow performs `db.QueryRowContext` on a randomly picked | ||
| // database node. The query and the node picked are logged in the logs | ||
| // of the step that calls this function. | ||
| func (h *Helper) QueryRow(rng *rand.Rand, query string, args ...interface{}) *gosql.Row { | ||
| node, db := h.RandomDB(rng, h.runner.crdbNodes) | ||
| h.stepLogger.Printf("running SQL statement:\n%s\nArgs: %v\nNode: %d", query, args, node) | ||
| return db.QueryRowContext(h.ctx, query, args...) | ||
| } | ||
|
|
||
| // Exec performs `db.ExecContext` on a randomly picked database node. | ||
| // The query and the node picked are logged in the logs of the step | ||
| // that calls this function. | ||
| func (h *Helper) Exec(rng *rand.Rand, query string, args ...interface{}) error { | ||
| node, db := h.RandomDB(rng, h.runner.crdbNodes) | ||
| h.stepLogger.Printf("running SQL statement:\n%s\nArgs: %v\nNode: %d", query, args, node) | ||
| _, err := db.ExecContext(h.ctx, query, args...) | ||
| return err | ||
| } | ||
|
|
||
| func (h *Helper) Connect(node int) *gosql.DB { | ||
| return h.runner.conn(node) | ||
| } | ||
|
|
||
| // SetContext should be called by steps that need access to the test | ||
| // context, as that is only visible to them. | ||
| func (h *Helper) SetContext(c *Context) { | ||
| h.testContext = c | ||
| } | ||
|
|
||
| // Context returns the test context associated with a certain step. It | ||
| // is made available for user-functions (see runHookStep). | ||
| func (h *Helper) Context() *Context { | ||
| return h.testContext | ||
| } | ||
|
|
||
| // Background allows test authors to create functions that run in the | ||
| // background in mixed-version hooks. | ||
| func (h *Helper) Background( | ||
| name string, fn func(context.Context, *logger.Logger) error, | ||
| ) context.CancelFunc { | ||
| return h.runner.background.Start(name, func(ctx context.Context) error { | ||
| bgLogger, err := h.loggerFor(name) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to create logger for background function %q: %w", name, err) | ||
| } | ||
|
|
||
| err = panicAsError(bgLogger, func() error { return fn(ctx, bgLogger) }) | ||
| if err != nil { | ||
| if isContextCanceled(ctx) { | ||
| return err | ||
| } | ||
|
|
||
| desc := fmt.Sprintf("error in background function %s: %s", name, err) | ||
| return h.runner.testFailure(desc, bgLogger) | ||
| } | ||
|
|
||
| return nil | ||
| }) | ||
| } | ||
|
|
||
| // BackgroundCommand has the same semantics of `Background()`; the | ||
| // command passed will run and the test will fail if the command is | ||
| // not successful. | ||
| func (h *Helper) BackgroundCommand(cmd string, nodes option.NodeListOption) context.CancelFunc { | ||
| desc := fmt.Sprintf("run command: %q", cmd) | ||
| return h.Background(desc, func(ctx context.Context, l *logger.Logger) error { | ||
| l.Printf("running command `%s` on nodes %v in the background", cmd, nodes) | ||
| return h.runner.cluster.RunE(ctx, nodes, cmd) | ||
| }) | ||
| } | ||
|
|
||
| // ExpectDeath alerts the testing infrastructure that a node is | ||
| // expected to die. Regular restarts as part of the mixedversion | ||
| // testing are already taken into account. This function should only | ||
| // be used by tests that perform their own node restarts or chaos | ||
| // events. | ||
| func (h *Helper) ExpectDeath() { | ||
| h.ExpectDeaths(1) | ||
| } | ||
|
|
||
| // ExpectDeaths is the general version of `ExpectDeath()`. | ||
| func (h *Helper) ExpectDeaths(n int) { | ||
| h.runner.monitor.ExpectDeaths(n) | ||
| } | ||
|
|
||
| // loggerFor creates a logger instance to be used by background | ||
| // functions (created by calling `Background` on the helper | ||
| // instance). It is similar to the logger instances created for | ||
| // mixed-version steps, but with the `background_` prefix. | ||
| func (h *Helper) loggerFor(name string) (*logger.Logger, error) { | ||
| atomic.AddInt64(&h.bgCount, 1) | ||
|
|
||
| fileName := invalidChars.ReplaceAllString(strings.ToLower(name), "") | ||
| fileName = fmt.Sprintf("background_%s_%d", fileName, h.bgCount) | ||
| fileName = path.Join(logPrefix, fileName) | ||
|
|
||
| return prefixedLogger(h.runner.logger, fileName) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.