91 lines
2.3 KiB
Go
91 lines
2.3 KiB
Go
// 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 groups the options for an InteractionEnv.
|
|
type InteractionOpts struct {
|
|
OnConfig func(*raft.Config)
|
|
}
|
|
|
|
// A Node is a member of a raft group tested via an InteractionEnv.
|
|
type Node struct {
|
|
*raft.RawNode
|
|
Storage
|
|
|
|
Config *raft.Config
|
|
History []pb.Snapshot
|
|
}
|
|
|
|
// InteractionEnv facilitates testing of complex interactions between the
|
|
// members of a raft group.
|
|
type InteractionEnv struct {
|
|
Options *InteractionOpts
|
|
Nodes []Node
|
|
Messages []pb.Message // in-flight messages
|
|
|
|
Output *RedirectLogger
|
|
}
|
|
|
|
// NewInteractionEnv initializes an InteractionEnv. opts may be nil.
|
|
func NewInteractionEnv(opts *InteractionOpts) *InteractionEnv {
|
|
if opts == nil {
|
|
opts = &InteractionOpts{}
|
|
}
|
|
return &InteractionEnv{
|
|
Options: opts,
|
|
Output: &RedirectLogger{
|
|
Builder: &strings.Builder{},
|
|
},
|
|
}
|
|
}
|
|
|
|
// Storage is the interface used by InteractionEnv. It is comprised of raft's
|
|
// Storage interface plus access to operations that maintain the log and drive
|
|
// the Ready handling loop.
|
|
type Storage interface {
|
|
raft.Storage
|
|
SetHardState(state pb.HardState) error
|
|
ApplySnapshot(pb.Snapshot) error
|
|
Compact(newFirstIndex uint64) error
|
|
Append([]pb.Entry) error
|
|
}
|
|
|
|
// defaultRaftConfig sets up a *raft.Config with reasonable testing defaults.
|
|
// In particular, no limits are set.
|
|
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)
|
|
}
|