-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
roachtest: add run-operation command to run singular operation
This change adds a new roachtest command, run-operation, that runs a singular operation defined in OperationSpec (see #119796), in a simplified harness, with existing clusters only. The existing cluster is not touched (eg. stopped or wiped), unless the operation explicitly does an action like that. An implementation of operation.Operation is also bundled in this change to make these operations runnable. Epic: none Release note: None
- Loading branch information
Showing
10 changed files
with
363 additions
and
6 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| // Copyright 2024 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 main | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/cockroachdb/cockroach/pkg/cmd/roachtest/operation" | ||
| "github.com/cockroachdb/cockroach/pkg/cmd/roachtest/registry" | ||
| "github.com/cockroachdb/cockroach/pkg/roachprod/logger" | ||
| "github.com/cockroachdb/cockroach/pkg/util/syncutil" | ||
| "github.com/cockroachdb/errors" | ||
| ) | ||
|
|
||
| var errOperationFatal = errors.New("o.Fatal() was called") | ||
|
|
||
| type operationImpl struct { | ||
| spec *registry.OperationSpec | ||
| cockroach string // path to main cockroach binary on the cluster. | ||
|
|
||
| // l is the logger that the operation will use for its output. | ||
| l *logger.Logger | ||
|
|
||
| mu struct { | ||
| syncutil.RWMutex | ||
| done bool | ||
|
|
||
| // cancel, if set, is called from the o.Fatal() family of functions when the | ||
| // op is being marked as failed (i.e. when the failures slice is being | ||
| // appended to). This is used to cancel the context passed to o.spec.Run(), | ||
| // so async goroutines can be notified. | ||
| cancel func() | ||
|
|
||
| // failures added via addFailures, in order. An operation may have multiple | ||
| // calls to o.Fail()/Error(), with each call adding to this slice once. | ||
| failures []error | ||
|
|
||
| status string | ||
| } | ||
| } | ||
|
|
||
| func (o *operationImpl) ClusterCockroach() string { | ||
| return o.cockroach | ||
| } | ||
|
|
||
| func (o *operationImpl) Name() string { | ||
| return o.spec.Name | ||
| } | ||
|
|
||
| // L returns the operation's logger. | ||
| func (o *operationImpl) L() *logger.Logger { | ||
| return o.l | ||
| } | ||
|
|
||
| // Status sets the main status message for the operation. This is logged to | ||
| // o.L() and is the main way to log status of an operation. | ||
| func (o *operationImpl) Status(args ...interface{}) { | ||
| o.mu.Lock() | ||
| defer o.mu.Unlock() | ||
|
|
||
| o.mu.status = fmt.Sprint(args...) | ||
| if !o.L().Closed() { | ||
| o.L().PrintfCtxDepth(context.TODO(), 3, "operation status: %s", o.mu.status) | ||
| } | ||
| } | ||
|
|
||
| // Fatal marks the operation as failed, prints the args to o.L(), and calls the | ||
| // cancel method if specified. Also shuts down the process. Can be called | ||
| // multiple times. | ||
| func (o *operationImpl) Fatal(args ...interface{}) { | ||
| o.addFailureAndCancel(1, "", args...) | ||
| panic(errOperationFatal) | ||
| } | ||
|
|
||
| // Fatalf is like Fatal, but takes a format string. | ||
| func (o *operationImpl) Fatalf(format string, args ...interface{}) { | ||
| o.addFailureAndCancel(1, format, args...) | ||
| panic(errOperationFatal) | ||
| } | ||
|
|
||
| // FailNow implements the Operation interface. | ||
| func (o *operationImpl) FailNow() { | ||
| o.addFailureAndCancel(1, "FailNow called") | ||
| panic(errOperationFatal) | ||
| } | ||
|
|
||
| // Error implements the Operation interface | ||
| func (o *operationImpl) Error(args ...interface{}) { | ||
| o.addFailureAndCancel(1, "", args...) | ||
| } | ||
|
|
||
| // Errorf implements the Operation interface. | ||
| func (o *operationImpl) Errorf(format string, args ...interface{}) { | ||
| o.addFailureAndCancel(1, format, args...) | ||
| } | ||
|
|
||
| func (o *operationImpl) addFailureAndCancel(depth int, format string, args ...interface{}) { | ||
| o.addFailure(depth+1, format, args...) | ||
| o.mu.cancel() | ||
| } | ||
|
|
||
| // addFailure depth indicates how many stack frames to skip when reporting the | ||
| // site of the failure in logs. `0` will report the caller of addFailure, `1` the | ||
| // caller of the caller of addFailure, etc. | ||
| func (o *operationImpl) addFailure(depth int, format string, args ...interface{}) { | ||
| if format == "" { | ||
| format = strings.Repeat(" %v", len(args))[1:] | ||
| } | ||
| reportFailure := errors.NewWithDepthf(depth+1, format, args...) | ||
|
|
||
| o.mu.Lock() | ||
| defer o.mu.Unlock() | ||
| o.mu.failures = append(o.mu.failures, reportFailure) | ||
|
|
||
| msg := reportFailure.Error() | ||
|
|
||
| failureNum := len(o.mu.failures) | ||
| o.L().Printf("operation failure #%d: %s", failureNum, msg) | ||
| } | ||
|
|
||
| func (o *operationImpl) Failed() bool { | ||
| o.mu.RLock() | ||
| defer o.mu.RUnlock() | ||
|
|
||
| return len(o.mu.failures) > 0 | ||
| } | ||
|
|
||
| var _ operation.Operation = &operationImpl{} |
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,9 @@ | ||
| load("@io_bazel_rules_go//go:def.bzl", "go_library") | ||
|
|
||
| go_library( | ||
| name = "operations", | ||
| srcs = ["register.go"], | ||
| importpath = "github.com/cockroachdb/cockroach/pkg/cmd/roachtest/operations", | ||
| visibility = ["//visibility:public"], | ||
| deps = ["//pkg/cmd/roachtest/registry"], | ||
| ) |
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,17 @@ | ||
| // Copyright 2024 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 operations | ||
|
|
||
| import "github.com/cockroachdb/cockroach/pkg/cmd/roachtest/registry" | ||
|
|
||
| // RegisterOperations registers all operations to the Registry. This powers `roachtest run-operations`. | ||
| func RegisterOperations(r registry.Registry) { | ||
| } |
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 |
|---|---|---|
|
|
@@ -23,6 +23,7 @@ type cmdID int | |
| const ( | ||
| listCmdID cmdID = iota | ||
| runCmdID | ||
| runOpsCmdID | ||
| numCmdIDs | ||
| ) | ||
|
|
||
|
|
||
Oops, something went wrong.