raft: tidy up the unit tests some more

Use `t.Run` for each test case, and make some tests more idiomatic.

Signed-off-by: Tobias Grieger <tobias.b.grieger@gmail.com>
This commit is contained in:
Tobias Grieger 2022-11-13 22:34:09 +01:00
parent 1f4f70723f
commit de97f6aa3d
2 changed files with 53 additions and 44 deletions

View File

@ -38,22 +38,19 @@ func TestStorageTerm(t *testing.T) {
{6, ErrUnavailable, 0, false}, {6, ErrUnavailable, 0, false},
} }
for i, tt := range tests { for _, tt := range tests {
t.Run("", func(t *testing.T) {
s := &MemoryStorage{ents: ents} s := &MemoryStorage{ents: ents}
func() { if tt.wpanic {
defer func() { require.Panics(t, func() {
if r := recover(); r != nil { _, _ = s.Term(tt.i)
if !tt.wpanic { })
t.Errorf("%d: panic = %v, want %v", i, true, tt.wpanic)
} }
}
}()
term, err := s.Term(tt.i) term, err := s.Term(tt.i)
require.Equal(t, tt.werr, err, "#%d", i) require.Equal(t, tt.werr, err)
require.Equal(t, tt.wterm, term, "#%d", i) require.Equal(t, tt.wterm, term)
}() })
} }
} }
@ -82,10 +79,12 @@ func TestStorageEntries(t *testing.T) {
} }
for _, tt := range tests { for _, tt := range tests {
t.Run("", func(t *testing.T) {
s := &MemoryStorage{ents: ents} s := &MemoryStorage{ents: ents}
entries, err := s.Entries(tt.lo, tt.hi, tt.maxsize) entries, err := s.Entries(tt.lo, tt.hi, tt.maxsize)
require.Equal(t, tt.werr, err) require.Equal(t, tt.werr, err)
require.Equal(t, tt.wentries, entries) require.Equal(t, tt.wentries, entries)
})
} }
} }
@ -97,7 +96,7 @@ func TestStorageLastIndex(t *testing.T) {
require.NoError(t, err) require.NoError(t, err)
require.Equal(t, uint64(5), last) 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() last, err = s.LastIndex()
require.NoError(t, err) require.NoError(t, err)
require.Equal(t, uint64(6), last) require.Equal(t, uint64(6), last)
@ -111,7 +110,7 @@ func TestStorageFirstIndex(t *testing.T) {
require.NoError(t, err) require.NoError(t, err)
require.Equal(t, uint64(4), first) require.Equal(t, uint64(4), first)
s.Compact(4) require.NoError(t, s.Compact(4))
first, err = s.FirstIndex() first, err = s.FirstIndex()
require.NoError(t, err) require.NoError(t, err)
require.Equal(t, uint64(5), first) require.Equal(t, uint64(5), first)
@ -134,11 +133,13 @@ func TestStorageCompact(t *testing.T) {
} }
for _, tt := range tests { for _, tt := range tests {
t.Run("", func(t *testing.T) {
s := &MemoryStorage{ents: ents} s := &MemoryStorage{ents: ents}
require.Equal(t, tt.werr, s.Compact(tt.i)) require.Equal(t, tt.werr, s.Compact(tt.i))
require.Equal(t, tt.windex, s.ents[0].Index) require.Equal(t, tt.windex, s.ents[0].Index)
require.Equal(t, tt.wterm, s.ents[0].Term) require.Equal(t, tt.wterm, s.ents[0].Term)
require.Equal(t, tt.wlen, len(s.ents)) require.Equal(t, tt.wlen, len(s.ents))
})
} }
} }
@ -158,10 +159,12 @@ func TestStorageCreateSnapshot(t *testing.T) {
} }
for _, tt := range tests { for _, tt := range tests {
t.Run("", func(t *testing.T) {
s := &MemoryStorage{ents: ents} s := &MemoryStorage{ents: ents}
snap, err := s.CreateSnapshot(tt.i, cs, data) snap, err := s.CreateSnapshot(tt.i, cs, data)
require.Equal(t, tt.werr, err) require.Equal(t, tt.werr, err)
require.Equal(t, tt.wsnap, snap) require.Equal(t, tt.wsnap, snap)
})
} }
} }
@ -193,19 +196,19 @@ func TestStorageAppend(t *testing.T) {
nil, nil,
[]pb.Entry{{Index: 3, Term: 3}, {Index: 4, Term: 4}, {Index: 5, Term: 5}, {Index: 6, Term: 5}}, []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}}, []pb.Entry{{Index: 2, Term: 3}, {Index: 3, Term: 3}, {Index: 4, Term: 5}},
nil, nil,
[]pb.Entry{{Index: 3, Term: 3}, {Index: 4, Term: 5}}, []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}}, []pb.Entry{{Index: 4, Term: 5}},
nil, nil,
[]pb.Entry{{Index: 3, Term: 3}, {Index: 4, Term: 5}}, []pb.Entry{{Index: 3, Term: 3}, {Index: 4, Term: 5}},
}, },
// direct append // Direct append.
{ {
[]pb.Entry{{Index: 6, Term: 5}}, []pb.Entry{{Index: 6, Term: 5}},
nil, nil,
@ -214,9 +217,11 @@ func TestStorageAppend(t *testing.T) {
} }
for _, tt := range tests { for _, tt := range tests {
t.Run("", func(t *testing.T) {
s := &MemoryStorage{ents: ents} s := &MemoryStorage{ents: ents}
require.Equal(t, tt.werr, s.Append(tt.entries)) require.Equal(t, tt.werr, s.Append(tt.entries))
require.Equal(t, tt.wentries, s.ents) require.Equal(t, tt.wentries, s.ents)
})
} }
} }
@ -230,12 +235,11 @@ func TestStorageApplySnapshot(t *testing.T) {
s := NewMemoryStorage() s := NewMemoryStorage()
//Apply Snapshot successful
i := 0 i := 0
tt := tests[i] tt := tests[i]
require.NoError(t, s.ApplySnapshot(tt)) require.NoError(t, s.ApplySnapshot(tt))
//Apply Snapshot fails due to ErrSnapOutOfDate // ApplySnapshot fails due to ErrSnapOutOfDate.
i = 1 i = 1
tt = tests[i] tt = tests[i]
require.Equal(t, ErrSnapOutOfDate, s.ApplySnapshot(tt)) require.Equal(t, ErrSnapOutOfDate, s.ApplySnapshot(tt))

View File

@ -15,6 +15,7 @@
package raft package raft
import ( import (
"fmt"
"math" "math"
"strings" "strings"
"testing" "testing"
@ -34,7 +35,7 @@ func TestDescribeEntry(t *testing.T) {
Type: pb.EntryNormal, Type: pb.EntryNormal,
Data: []byte("hello\x00world"), Data: []byte("hello\x00world"),
} }
require.Equal(t, "1/2 EntryNormal \"hello\\x00world\"", DescribeEntry(entry, nil)) require.Equal(t, `1/2 EntryNormal "hello\x00world"`, DescribeEntry(entry, nil))
require.Equal(t, "1/2 EntryNormal HELLO\x00WORLD", DescribeEntry(entry, testFormatter)) require.Equal(t, "1/2 EntryNormal HELLO\x00WORLD", DescribeEntry(entry, testFormatter))
} }
@ -45,19 +46,21 @@ func TestLimitSize(t *testing.T) {
wentries []pb.Entry wentries []pb.Entry
}{ }{
{math.MaxUint64, []pb.Entry{{Index: 4, Term: 4}, {Index: 5, Term: 5}, {Index: 6, Term: 6}}}, {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}}}, {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}}}, {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()/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}}}, {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}}}, {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 _, tt := range tests { for _, tt := range tests {
t.Run("", func(t *testing.T) {
require.Equal(t, tt.wentries, limitSize(ents, tt.maxsize)) require.Equal(t, tt.wentries, limitSize(ents, tt.maxsize))
})
} }
} }
@ -88,6 +91,8 @@ func TestIsLocalMsg(t *testing.T) {
} }
for _, tt := range tests { for _, tt := range tests {
t.Run(fmt.Sprint(tt.msgt), func(t *testing.T) {
require.Equal(t, tt.isLocal, IsLocalMsg(tt.msgt)) require.Equal(t, tt.isLocal, IsLocalMsg(tt.msgt))
})
} }
} }