Skip to content

Commit

Permalink
Merge pull request #14717 from falser101/fix/testify
Browse files Browse the repository at this point in the history
  • Loading branch information
tbg authored Nov 13, 2022
2 parents 0e4bf4a + de97f6a commit 4c82446
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 124 deletions.
156 changes: 56 additions & 100 deletions raft/storage_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ package raft

import (
"math"
"reflect"
"testing"

"github.com/stretchr/testify/require"
pb "go.etcd.io/etcd/raft/v3/raftpb"
)

Expand All @@ -38,26 +38,19 @@ func TestStorageTerm(t *testing.T) {
{6, ErrUnavailable, 0, false},
}

for i, tt := range tests {
s := &MemoryStorage{ents: ents}
for _, tt := range tests {
t.Run("", func(t *testing.T) {
s := &MemoryStorage{ents: ents}

func() {
defer func() {
if r := recover(); r != nil {
if !tt.wpanic {
t.Errorf("%d: panic = %v, want %v", i, true, tt.wpanic)
}
}
}()

term, err := s.Term(tt.i)
if err != tt.werr {
t.Errorf("#%d: err = %v, want %v", i, err, tt.werr)
if tt.wpanic {
require.Panics(t, func() {
_, _ = s.Term(tt.i)
})
}
if term != tt.wterm {
t.Errorf("#%d: term = %d, want %d", i, term, tt.wterm)
}
}()
term, err := s.Term(tt.i)
require.Equal(t, tt.werr, err)
require.Equal(t, tt.wterm, term)
})
}
}

Expand Down Expand Up @@ -85,15 +78,13 @@ func TestStorageEntries(t *testing.T) {
{4, 7, uint64(ents[1].Size() + ents[2].Size() + ents[3].Size()), nil, []pb.Entry{{Index: 4, Term: 4}, {Index: 5, Term: 5}, {Index: 6, Term: 6}}},
}

for i, tt := range tests {
s := &MemoryStorage{ents: ents}
entries, err := s.Entries(tt.lo, tt.hi, tt.maxsize)
if err != tt.werr {
t.Errorf("#%d: err = %v, want %v", i, err, tt.werr)
}
if !reflect.DeepEqual(entries, tt.wentries) {
t.Errorf("#%d: entries = %v, want %v", i, entries, tt.wentries)
}
for _, tt := range tests {
t.Run("", func(t *testing.T) {
s := &MemoryStorage{ents: ents}
entries, err := s.Entries(tt.lo, tt.hi, tt.maxsize)
require.Equal(t, tt.werr, err)
require.Equal(t, tt.wentries, entries)
})
}
}

Expand All @@ -102,43 +93,27 @@ func TestStorageLastIndex(t *testing.T) {
s := &MemoryStorage{ents: ents}

last, err := s.LastIndex()
if err != nil {
t.Errorf("err = %v, want nil", err)
}
if last != 5 {
t.Errorf("last = %d, want %d", last, 5)
}
require.NoError(t, err)
require.Equal(t, uint64(5), last)

s.Append([]pb.Entry{{Index: 6, Term: 5}})
require.NoError(t, s.Append([]pb.Entry{{Index: 6, Term: 5}}))
last, err = s.LastIndex()
if err != nil {
t.Errorf("err = %v, want nil", err)
}
if last != 6 {
t.Errorf("last = %d, want %d", last, 6)
}
require.NoError(t, err)
require.Equal(t, uint64(6), last)
}

func TestStorageFirstIndex(t *testing.T) {
ents := []pb.Entry{{Index: 3, Term: 3}, {Index: 4, Term: 4}, {Index: 5, Term: 5}}
s := &MemoryStorage{ents: ents}

first, err := s.FirstIndex()
if err != nil {
t.Errorf("err = %v, want nil", err)
}
if first != 4 {
t.Errorf("first = %d, want %d", first, 4)
}
require.NoError(t, err)
require.Equal(t, uint64(4), first)

s.Compact(4)
require.NoError(t, s.Compact(4))
first, err = s.FirstIndex()
if err != nil {
t.Errorf("err = %v, want nil", err)
}
if first != 5 {
t.Errorf("first = %d, want %d", first, 5)
}
require.NoError(t, err)
require.Equal(t, uint64(5), first)
}

func TestStorageCompact(t *testing.T) {
Expand All @@ -157,21 +132,14 @@ func TestStorageCompact(t *testing.T) {
{5, nil, 5, 5, 1},
}

for i, tt := range tests {
s := &MemoryStorage{ents: ents}
err := s.Compact(tt.i)
if err != tt.werr {
t.Errorf("#%d: err = %v, want %v", i, err, tt.werr)
}
if s.ents[0].Index != tt.windex {
t.Errorf("#%d: index = %d, want %d", i, s.ents[0].Index, tt.windex)
}
if s.ents[0].Term != tt.wterm {
t.Errorf("#%d: term = %d, want %d", i, s.ents[0].Term, tt.wterm)
}
if len(s.ents) != tt.wlen {
t.Errorf("#%d: len = %d, want %d", i, len(s.ents), tt.wlen)
}
for _, tt := range tests {
t.Run("", func(t *testing.T) {
s := &MemoryStorage{ents: ents}
require.Equal(t, tt.werr, s.Compact(tt.i))
require.Equal(t, tt.windex, s.ents[0].Index)
require.Equal(t, tt.wterm, s.ents[0].Term)
require.Equal(t, tt.wlen, len(s.ents))
})
}
}

Expand All @@ -190,15 +158,13 @@ func TestStorageCreateSnapshot(t *testing.T) {
{5, nil, pb.Snapshot{Data: data, Metadata: pb.SnapshotMetadata{Index: 5, Term: 5, ConfState: *cs}}},
}

for i, tt := range tests {
s := &MemoryStorage{ents: ents}
snap, err := s.CreateSnapshot(tt.i, cs, data)
if err != tt.werr {
t.Errorf("#%d: err = %v, want %v", i, err, tt.werr)
}
if !reflect.DeepEqual(snap, tt.wsnap) {
t.Errorf("#%d: snap = %+v, want %+v", i, snap, tt.wsnap)
}
for _, tt := range tests {
t.Run("", func(t *testing.T) {
s := &MemoryStorage{ents: ents}
snap, err := s.CreateSnapshot(tt.i, cs, data)
require.Equal(t, tt.werr, err)
require.Equal(t, tt.wsnap, snap)
})
}
}

Expand Down Expand Up @@ -230,35 +196,32 @@ func TestStorageAppend(t *testing.T) {
nil,
[]pb.Entry{{Index: 3, Term: 3}, {Index: 4, Term: 4}, {Index: 5, Term: 5}, {Index: 6, Term: 5}},
},
// truncate incoming entries, truncate the existing entries and append
// Truncate incoming entries, truncate the existing entries and append.
{
[]pb.Entry{{Index: 2, Term: 3}, {Index: 3, Term: 3}, {Index: 4, Term: 5}},
nil,
[]pb.Entry{{Index: 3, Term: 3}, {Index: 4, Term: 5}},
},
// truncate the existing entries and append
// Truncate the existing entries and append.
{
[]pb.Entry{{Index: 4, Term: 5}},
nil,
[]pb.Entry{{Index: 3, Term: 3}, {Index: 4, Term: 5}},
},
// direct append
// Direct append.
{
[]pb.Entry{{Index: 6, Term: 5}},
nil,
[]pb.Entry{{Index: 3, Term: 3}, {Index: 4, Term: 4}, {Index: 5, Term: 5}, {Index: 6, Term: 5}},
},
}

for i, tt := range tests {
s := &MemoryStorage{ents: ents}
err := s.Append(tt.entries)
if err != tt.werr {
t.Errorf("#%d: err = %v, want %v", i, err, tt.werr)
}
if !reflect.DeepEqual(s.ents, tt.wentries) {
t.Errorf("#%d: entries = %v, want %v", i, s.ents, tt.wentries)
}
for _, tt := range tests {
t.Run("", func(t *testing.T) {
s := &MemoryStorage{ents: ents}
require.Equal(t, tt.werr, s.Append(tt.entries))
require.Equal(t, tt.wentries, s.ents)
})
}
}

Expand All @@ -272,19 +235,12 @@ func TestStorageApplySnapshot(t *testing.T) {

s := NewMemoryStorage()

//Apply Snapshot successful
i := 0
tt := tests[i]
err := s.ApplySnapshot(tt)
if err != nil {
t.Errorf("#%d: err = %v, want %v", i, err, nil)
}
require.NoError(t, s.ApplySnapshot(tt))

//Apply Snapshot fails due to ErrSnapOutOfDate
// ApplySnapshot fails due to ErrSnapOutOfDate.
i = 1
tt = tests[i]
err = s.ApplySnapshot(tt)
if err != ErrSnapOutOfDate {
t.Errorf("#%d: err = %v, want %v", i, err, ErrSnapOutOfDate)
}
require.Equal(t, ErrSnapOutOfDate, s.ApplySnapshot(tt))
}
40 changes: 16 additions & 24 deletions raft/util_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@
package raft

import (
"fmt"
"math"
"reflect"
"strings"
"testing"

"github.com/stretchr/testify/require"
pb "go.etcd.io/etcd/raft/v3/raftpb"
)

Expand All @@ -34,16 +35,8 @@ func TestDescribeEntry(t *testing.T) {
Type: pb.EntryNormal,
Data: []byte("hello\x00world"),
}

defaultFormatted := DescribeEntry(entry, nil)
if defaultFormatted != "1/2 EntryNormal \"hello\\x00world\"" {
t.Errorf("unexpected default output: %s", defaultFormatted)
}

customFormatted := DescribeEntry(entry, testFormatter)
if customFormatted != "1/2 EntryNormal HELLO\x00WORLD" {
t.Errorf("unexpected custom output: %s", customFormatted)
}
require.Equal(t, `1/2 EntryNormal "hello\x00world"`, DescribeEntry(entry, nil))
require.Equal(t, "1/2 EntryNormal HELLO\x00WORLD", DescribeEntry(entry, testFormatter))
}

func TestLimitSize(t *testing.T) {
Expand All @@ -53,21 +46,21 @@ func TestLimitSize(t *testing.T) {
wentries []pb.Entry
}{
{math.MaxUint64, []pb.Entry{{Index: 4, Term: 4}, {Index: 5, Term: 5}, {Index: 6, Term: 6}}},
// even if maxsize is zero, the first entry should be returned
// Even if maxsize is zero, the first entry should be returned.
{0, []pb.Entry{{Index: 4, Term: 4}}},
// limit to 2
// Limit to 2.
{uint64(ents[0].Size() + ents[1].Size()), []pb.Entry{{Index: 4, Term: 4}, {Index: 5, Term: 5}}},
// limit to 2
// Limit to 2.
{uint64(ents[0].Size() + ents[1].Size() + ents[2].Size()/2), []pb.Entry{{Index: 4, Term: 4}, {Index: 5, Term: 5}}},
{uint64(ents[0].Size() + ents[1].Size() + ents[2].Size() - 1), []pb.Entry{{Index: 4, Term: 4}, {Index: 5, Term: 5}}},
// all
// All.
{uint64(ents[0].Size() + ents[1].Size() + ents[2].Size()), []pb.Entry{{Index: 4, Term: 4}, {Index: 5, Term: 5}, {Index: 6, Term: 6}}},
}

for i, tt := range tests {
if !reflect.DeepEqual(limitSize(ents, tt.maxsize), tt.wentries) {
t.Errorf("#%d: entries = %v, want %v", i, limitSize(ents, tt.maxsize), tt.wentries)
}
for _, tt := range tests {
t.Run("", func(t *testing.T) {
require.Equal(t, tt.wentries, limitSize(ents, tt.maxsize))
})
}
}

Expand Down Expand Up @@ -97,10 +90,9 @@ func TestIsLocalMsg(t *testing.T) {
{pb.MsgPreVoteResp, false},
}

for i, tt := range tests {
got := IsLocalMsg(tt.msgt)
if got != tt.isLocal {
t.Errorf("#%d: got %v, want %v", i, got, tt.isLocal)
}
for _, tt := range tests {
t.Run(fmt.Sprint(tt.msgt), func(t *testing.T) {
require.Equal(t, tt.isLocal, IsLocalMsg(tt.msgt))
})
}
}

0 comments on commit 4c82446

Please sign in to comment.