Skip to content

testserver: add option to run demo mode #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 30, 2025
Merged

testserver: add option to run demo mode #186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion testserver/binaries.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,8 @@ func downloadBinaryFromTar(response *http.Response, output *os.File, filePath st
}

}
return nil
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unreachable code.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: I would rather there be return fmt.Errorf("could not find cockroach binary in archive") or something similar in case due to some bug it turns out to no longer be true that this is unreachable. I also don't fully understand when missing the final return statement is a compile error or not, I'd rather that not change under our feet due to a Go upgrade or similar.

// Unreachable, but left present for safety in case later changes make this branch reachable again.
return fmt.Errorf("could not find cockroach binary in archive")
}

// downloadBinaryFromZip writes the binary compressed in a zip from a http response
Expand Down
157 changes: 98 additions & 59 deletions testserver/testserver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,7 @@ type testServerArgs struct {
envVars []string // to be passed to cmd.Env
localityFlags []string
cockroachLogsDir string
demoMode bool // run in "demo" mode
}

// CockroachBinaryPathOpt is a TestServer option that can be passed to
Expand Down Expand Up @@ -430,6 +431,12 @@ func CockroachLogsDirOpt(dir string) TestServerOpt {
}
}

func DemoModeOpt() TestServerOpt {
return func(args *testServerArgs) {
args.demoMode = true
}
}

const (
logsDirName = "logs"
certsDirName = "certs"
Expand Down Expand Up @@ -559,12 +566,7 @@ func NewTestServer(opts ...TestServerOpt) (TestServer, error) {
return nil, fmt.Errorf("%s failed to parse version: %w", testserverMessagePrefix, err)
}

startCmd := "start-single-node"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved into the new else below

if !v.AtLeast(version.MustParse("v19.2.0-alpha")) || serverArgs.numNodes > 1 {
startCmd = "start"
}

nodes := make([]nodeInfo, serverArgs.numNodes)
var nodes []nodeInfo
if len(serverArgs.httpPorts) == 0 {
serverArgs.httpPorts = make([]int, serverArgs.numNodes)
}
Expand All @@ -573,60 +575,102 @@ func NewTestServer(opts ...TestServerOpt) (TestServer, error) {
serverArgs.externalIODir = "disabled"
}

for i := 0; i < serverArgs.numNodes; i++ {
storeArg := fmt.Sprintf("--store=type=mem,size=%.2f", serverArgs.storeMemSize)
logsBaseDir := filepath.Join(serverArgs.cockroachLogsDir, strconv.Itoa(i))
nodeBaseDir, err := mkDir(strconv.Itoa(i))
if serverArgs.demoMode {
startCmd := "demo"
nodes = make([]nodeInfo, 1)
logsBaseDir := filepath.Join(serverArgs.cockroachLogsDir, "0")
nodeBaseDir, err := mkDir("0")
if err != nil {
return nil, err
}
if serverArgs.storeOnDisk {
storeArg = fmt.Sprintf("--store=path=%s", nodeBaseDir)
}

// TODO(janexing): Make sure the log is written to logDir instead of shown in console.
// Should be done once issue #109 is solved:
// https://github.com/cockroachdb/cockroach-go/issues/109
nodes[i].stdout = filepath.Join(logsBaseDir, "cockroach.stdout")
nodes[i].stderr = filepath.Join(logsBaseDir, "cockroach.stderr")
nodes[i].listeningURLFile = filepath.Join(nodeBaseDir, "listen-url")
nodes[i].state = stateNew
if serverArgs.numNodes > 1 {
nodes[i].startCmdArgs = []string{
serverArgs.cockroachBinary,
startCmd,
"--logtostderr",
secureOpt,
storeArg,
fmt.Sprintf(
"--listen-addr=%s:%d",
serverArgs.listenAddrHost,
serverArgs.listenAddrPorts[i],
),
fmt.Sprintf(
"--http-addr=%s:%d",
serverArgs.listenAddrHost,
serverArgs.httpPorts[i],
),
"--listening-url-file=" + nodes[i].listeningURLFile,
"--external-io-dir=" + serverArgs.externalIODir,
nodes[0].stdout = filepath.Join(logsBaseDir, "cockroach.stdout")
nodes[0].stderr = filepath.Join(logsBaseDir, "cockroach.stderr")
nodes[0].listeningURLFile = filepath.Join(nodeBaseDir, "listen-url")
nodes[0].state = stateNew

// Note the flags in demo mode are slightly different than single-node mode.
// There's no external-io-dir flag, --port becomes --sql-port, and --nodes exists.
nodes[0].startCmdArgs = []string{
serverArgs.cockroachBinary,
startCmd,
"--logtostderr",
secureOpt,
"--sql-port=" + strconv.Itoa(serverArgs.listenAddrPorts[0]),
"--http-port=" + strconv.Itoa(serverArgs.httpPorts[0]),
"--cache=" + strconv.FormatFloat(serverArgs.cacheSize, 'f', 4, 64),
"--listening-url-file=" + nodes[0].listeningURLFile,
"--nodes=" + strconv.Itoa(serverArgs.numNodes),
}

if len(serverArgs.localityFlags) > 0 {
nodes[0].startCmdArgs = append(nodes[0].startCmdArgs, fmt.Sprintf("--demo-locality=%s", strings.Join(serverArgs.localityFlags, ":")))
}
} else {
startCmd := "start-single-node"
if !v.AtLeast(version.MustParse("v19.2.0-alpha")) || serverArgs.numNodes > 1 {
startCmd = "start"
}
nodes = make([]nodeInfo, serverArgs.numNodes)
for i := 0; i < serverArgs.numNodes; i++ {
storeArg := fmt.Sprintf("--store=type=mem,size=%.2f", serverArgs.storeMemSize)
logsBaseDir := filepath.Join(serverArgs.cockroachLogsDir, strconv.Itoa(i))
nodeBaseDir, err := mkDir(strconv.Itoa(i))
if err != nil {
return nil, err
}
} else {
nodes[0].startCmdArgs = []string{
serverArgs.cockroachBinary,
startCmd,
"--logtostderr",
secureOpt,
fmt.Sprintf("--host=%s", serverArgs.listenAddrHost),
"--port=" + strconv.Itoa(serverArgs.listenAddrPorts[0]),
"--http-port=" + strconv.Itoa(serverArgs.httpPorts[0]),
storeArg,
"--cache=" + strconv.FormatFloat(serverArgs.cacheSize, 'f', 4, 64),
"--listening-url-file=" + nodes[i].listeningURLFile,
"--external-io-dir=" + serverArgs.externalIODir,
if serverArgs.storeOnDisk {
storeArg = fmt.Sprintf("--store=path=%s", nodeBaseDir)
}

// TODO(janexing): Make sure the log is written to logDir instead of shown in console.
// Should be done once issue #109 is solved:
// https://github.com/cockroachdb/cockroach-go/issues/109
nodes[i].stdout = filepath.Join(logsBaseDir, "cockroach.stdout")
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: there's some mild duplication here (this whole nodes[i] thing seems to be copy-pasted?) You could refactor into a helper function but the duplication doesn't look so severe that it seems absolutely necessary.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Demo mode and regular mode have different flags, so I think a helper here might be more risky than, well, helpful. I'll add a comment in the code.

nodes[i].stderr = filepath.Join(logsBaseDir, "cockroach.stderr")
nodes[i].listeningURLFile = filepath.Join(nodeBaseDir, "listen-url")
nodes[i].state = stateNew
if serverArgs.numNodes > 1 {
nodes[i].startCmdArgs = []string{
serverArgs.cockroachBinary,
startCmd,
"--logtostderr",
secureOpt,
storeArg,
fmt.Sprintf(
"--listen-addr=%s:%d",
serverArgs.listenAddrHost,
serverArgs.listenAddrPorts[i],
),
fmt.Sprintf(
"--http-addr=%s:%d",
serverArgs.listenAddrHost,
serverArgs.httpPorts[i],
),
"--listening-url-file=" + nodes[i].listeningURLFile,
"--external-io-dir=" + serverArgs.externalIODir,
}
} else {
nodes[0].startCmdArgs = []string{
serverArgs.cockroachBinary,
startCmd,
"--logtostderr",
secureOpt,
fmt.Sprintf("--host=%s", serverArgs.listenAddrHost),
"--port=" + strconv.Itoa(serverArgs.listenAddrPorts[0]),
"--http-port=" + strconv.Itoa(serverArgs.httpPorts[0]),
storeArg,
"--cache=" + strconv.FormatFloat(serverArgs.cacheSize, 'f', 4, 64),
"--listening-url-file=" + nodes[i].listeningURLFile,
"--external-io-dir=" + serverArgs.externalIODir,
}
}
if len(serverArgs.localityFlags) > 0 {
nodes[i].startCmdArgs = append(nodes[i].startCmdArgs, fmt.Sprintf("--locality=%s", serverArgs.localityFlags[i]))
}
}
if 0 < len(serverArgs.localityFlags) {
nodes[i].startCmdArgs = append(nodes[i].startCmdArgs, fmt.Sprintf("--locality=%s", serverArgs.localityFlags[i]))
}
}

Expand All @@ -638,11 +682,6 @@ func NewTestServer(opts ...TestServerOpt) (TestServer, error) {
secureOpt,
}

states := make([]int, serverArgs.numNodes)
for i := 0; i < serverArgs.numNodes; i++ {
states[i] = stateNew
}

ts := &testServerImpl{
serverArgs: *serverArgs,
version: v,
Expand Down Expand Up @@ -844,13 +883,13 @@ func (ts *testServerImpl) Start() error {
ts.serverState = stateRunning
ts.mu.Unlock()

for i := 0; i < ts.serverArgs.numNodes; i++ {
for i := 0; i < len(ts.nodes); i++ {
if err := ts.StartNode(i); err != nil {
return err
}
}

if ts.serverArgs.numNodes > 1 {
if ts.serverArgs.numNodes > 1 && !ts.serverArgs.demoMode {
err := ts.CockroachInit()
if err != nil {
return err
Expand Down
16 changes: 16 additions & 0 deletions testserver/testserver_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,22 @@ func TestRunServer(t *testing.T) {
)
},
},
{
name: "Demo mode",
instantiation: func(t *testing.T) (*sql.DB, func()) {
return testserver.NewDBForTest(t,
testserver.DemoModeOpt(),
)
},
},
{
name: "Demo mode 3-node",
instantiation: func(t *testing.T) (*sql.DB, func()) {
return testserver.NewDBForTest(t, testserver.ThreeNodeOpt(),
testserver.DemoModeOpt(),
)
},
},
} {
t.Run(tc.name, func(t *testing.T) {
db, stop := tc.instantiation(t)
Expand Down
10 changes: 10 additions & 0 deletions testserver/testservernode.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ func (ts *testServerImpl) StopNode(nodeNum int) error {
return nil
}

type blockForeverReader struct{}

func (blockForeverReader) Read(p []byte) (int, error) {
select {} // block forever
}

func (ts *testServerImpl) StartNode(i int) error {
ts.mu.RLock()
if ts.nodes[i].state == stateRunning {
Expand Down Expand Up @@ -122,6 +128,10 @@ func (ts *testServerImpl) StartNode(i int) error {
}
currCmd.Stderr = ts.nodes[i].stderrBuf

if ts.serverArgs.demoMode {
currCmd.Stdin = blockForeverReader{}
}

for k, v := range defaultEnv() {
currCmd.Env = append(currCmd.Env, k+"="+v)
}
Expand Down