forked from etcd-io/etcd
-
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.
[wip] raft/rafttest: introduce datadriven testing
It has often been tedious to test the interactions between multi-member Raft groups, especially when many steps were required to reach a certain scenario. Often, this boilerplate was as boring as it is hard to write and hard to maintain, making it attractive to resort to shortcuts whenever possible, which in turn tended to undercut how meaningful and maintainable the tests ended up being - that is, if the tests were even written, which sometimes they weren't. This change introduces a datadriven framework specifically for testing deterministically the interaction between multiple members of a raft group with the goal of reducing the friction for writing these tests to near zero. In the near term, this will be used to add thorough testing for joint consensus (which is already available today, but wildly undertested), but just converting an existing test into this framework has shown that the concise representation and built-in inspection of log messages highlights unexpected behavior much more readily than the previous unit tests did (the test in question is `snapshot_succeed_via_app_resp`; the reader is invited to compare the old and new version of it). The main building block is `InteractionEnv`, which holds on to the state of the whole system and exposes various relevant methods for manipulating it, including but not limited to adding nodes, delivering and dropping messages, and proposing configuration changes. All of this is extensible so that in the future I hope to use it to explore the phenomena discussed in etcd-io#7625 (comment) which requires injecting appropriate "crash points" in the Ready handling loop. Discussions of the "what if X happened in state Y" can quickly be made concrete by "scripting up an interaction test". Additionally, this framework is intentionally not kept internal to the raft package.. Though this is in its infancy, a goal is that it should be possible for a suite of interaction tests to allow applications to validate that their Storage implementation behaves accordingly, simply by running a raft-provided interaction suite against their Storage.
- Loading branch information
Showing
23 changed files
with
1,376 additions
and
126 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| package raft_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/cockroachdb/datadriven" | ||
| "go.etcd.io/etcd/raft/rafttest" | ||
| ) | ||
|
|
||
| func TestInteraction(t *testing.T) { | ||
| datadriven.Walk(t, "testdata", func(t *testing.T, path string) { | ||
| env := rafttest.NewInteractionEnv(nil) | ||
| datadriven.RunTest(t, path, func(d *datadriven.TestData) string { | ||
| return env.Handle(t, *d) | ||
| }) | ||
| }) | ||
| } |
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,97 @@ | ||
| // Copyright 2019 The etcd Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package rafttest | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "math" | ||
| "strings" | ||
|
|
||
| "go.etcd.io/etcd/raft" | ||
| pb "go.etcd.io/etcd/raft/raftpb" | ||
| ) | ||
|
|
||
| // InteractionOpts blob | ||
| type InteractionOpts struct { | ||
| OnConfig func(*raft.Config) | ||
| } | ||
|
|
||
| type State struct { | ||
| AppliedIndex uint64 | ||
| pb.ConfState | ||
| Content string | ||
| } | ||
|
|
||
| type Storage interface { | ||
| raft.Storage | ||
| SetHardState(state pb.HardState) error | ||
| ApplySnapshot(pb.Snapshot) error | ||
| Compact(newFirstIndex uint64) error | ||
| Append([]pb.Entry) error | ||
| } | ||
|
|
||
| type InteractionEnv struct { | ||
| Options *InteractionOpts | ||
| Nodes []*raft.RawNode | ||
| Storages []Storage | ||
| Configs []*raft.Config | ||
| Messages []pb.Message | ||
|
|
||
| Histories [][]pb.Snapshot | ||
|
|
||
| Logger *RedirectLogger | ||
| } | ||
|
|
||
| func NewInteractionEnv(opts *InteractionOpts) *InteractionEnv { | ||
| if opts == nil { | ||
| opts = &InteractionOpts{} | ||
| } | ||
| return &InteractionEnv{ | ||
| Options: opts, | ||
| Logger: &RedirectLogger{ | ||
| Buf: &strings.Builder{}, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func defaultRaftConfig(id uint64, applied uint64, s raft.Storage) *raft.Config { | ||
| return &raft.Config{ | ||
| ID: id, | ||
| Applied: applied, | ||
| ElectionTick: 3, | ||
| HeartbeatTick: 1, | ||
| Storage: s, | ||
| MaxSizePerMsg: math.MaxUint64, | ||
| MaxInflightMsgs: math.MaxInt32, | ||
| } | ||
| } | ||
|
|
||
| func defaultEntryFormatter(b []byte) string { | ||
| return fmt.Sprintf("%q", b) | ||
| } | ||
|
|
||
| type Store struct { | ||
| Storage | ||
| SnapshotOverride func() (pb.Snapshot, error) | ||
| } | ||
|
|
||
| func (s Store) Snapshot() (pb.Snapshot, error) { | ||
| if s.SnapshotOverride != nil { | ||
| return s.SnapshotOverride() | ||
| } | ||
| return s.Storage.Snapshot() | ||
| } | ||
|
|
||
| var _ raft.Storage = Store{} |
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,91 @@ | ||
| // Copyright 2019 The etcd Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package rafttest | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strconv" | ||
| "testing" | ||
|
|
||
| "github.com/cockroachdb/datadriven" | ||
| ) | ||
|
|
||
| func (env *InteractionEnv) Handle(t *testing.T, d datadriven.TestData) string { | ||
| env.Logger.Buf.Reset() | ||
| buf := env.Logger.Buf | ||
| var err error | ||
| switch d.Cmd { | ||
| case "add-nodes": | ||
| err = env.handleAddNodes(t, d) | ||
| case "campaign": | ||
| err = env.handleCampaign(t, d) | ||
| case "compact": | ||
| err = env.handleCompact(t, d) | ||
| case "deliver-msgs": | ||
| err = env.handleDeliverMsgs(t, d) | ||
| case "process-ready": | ||
| err = env.handleProcessReady(t, d) | ||
| case "log-level": | ||
| err = env.handleLogLevel(t, d) | ||
| case "raft-log": | ||
| err = env.handleRaftLog(t, d) | ||
| case "stabilize": | ||
| err = env.handleStabilize(t, d) | ||
| case "status": | ||
| err = env.handleStatus(t, d) | ||
| case "tick-heartbeat": | ||
| err = env.handleTickHeartbeat(t, d) | ||
| case "propose-conf-change": | ||
| err = env.handleProposeConfChange(t, d) | ||
| default: | ||
| err = fmt.Errorf("unknown command") | ||
| } | ||
| if err != nil { | ||
| buf.WriteString(err.Error()) | ||
| } | ||
| // NB: the highest log level suppresses all output, including that of the | ||
| // handlers. This comes in useful during setup which can be chatty. | ||
| if buf.Len() == 0 || env.Logger.Lvl == len(lvlNames)-1 { | ||
| return "ok\n" | ||
| } | ||
| s := buf.String() | ||
| if len(s) > 0 && s[len(s)-1] != '\n' { | ||
| s += "\n" | ||
| } | ||
| return s | ||
| } | ||
|
|
||
| func mustFirstAsInt(t *testing.T, d datadriven.TestData) int { | ||
| n, err := strconv.Atoi(d.CmdArgs[0].Key) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| return n | ||
| } | ||
|
|
||
| func ints(t *testing.T, d datadriven.TestData) []int { | ||
| var ints []int | ||
| for i := 0; i < len(d.CmdArgs); i++ { | ||
| if len(d.CmdArgs[i].Vals) != 0 { | ||
| continue | ||
| } | ||
| n, err := strconv.Atoi(d.CmdArgs[i].Key) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| ints = append(ints, n) | ||
| } | ||
| return ints | ||
| } |
Oops, something went wrong.