protocol: move away from Ginkgo (#4650)

This commit is contained in:
Marten Seemann
2024-09-12 12:39:03 +08:00
committed by GitHub
parent 3f3e12bd7c
commit 196c4bb16b
10 changed files with 365 additions and 415 deletions

View File

@@ -1,114 +1,136 @@
package protocol
import (
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
"testing"
"github.com/stretchr/testify/require"
)
var _ = Describe("Version", func() {
isReservedVersion := func(v Version) bool {
return v&0x0f0f0f0f == 0x0a0a0a0a
func TestValidVersion(t *testing.T) {
require.False(t, IsValidVersion(VersionUnknown))
require.False(t, IsValidVersion(versionDraft29))
require.True(t, IsValidVersion(Version1))
require.True(t, IsValidVersion(Version2))
require.False(t, IsValidVersion(1234))
}
func TestVersionStringRepresentation(t *testing.T) {
require.Equal(t, "unknown", VersionUnknown.String())
require.Equal(t, "draft-29", versionDraft29.String())
require.Equal(t, "v1", Version1.String())
require.Equal(t, "v2", Version2.String())
// check with unsupported version numbers from the wiki
require.Equal(t, "gQUIC 9", Version(0x51303039).String())
require.Equal(t, "gQUIC 13", Version(0x51303133).String())
require.Equal(t, "gQUIC 25", Version(0x51303235).String())
require.Equal(t, "gQUIC 48", Version(0x51303438).String())
require.Equal(t, "0x1234567", Version(0x01234567).String())
}
func TestRecognizesSupportedVersions(t *testing.T) {
require.False(t, IsSupportedVersion(SupportedVersions, 0))
require.False(t, IsSupportedVersion(SupportedVersions, maxGquicVersion))
require.True(t, IsSupportedVersion(SupportedVersions, SupportedVersions[0]))
require.True(t, IsSupportedVersion(SupportedVersions, SupportedVersions[len(SupportedVersions)-1]))
}
func TestVersionSelection(t *testing.T) {
tests := []struct {
name string
supportedVersions []Version
otherVersions []Version
expectedVersion Version
expectedOK bool
}{
{
name: "finds matching version",
supportedVersions: []Version{1, 2, 3},
otherVersions: []Version{6, 5, 4, 3},
expectedVersion: 3,
expectedOK: true,
},
{
name: "picks preferred version",
supportedVersions: []Version{2, 1, 3},
otherVersions: []Version{3, 6, 1, 8, 2, 10},
expectedVersion: 2,
expectedOK: true,
},
{
name: "no matching version",
supportedVersions: []Version{1},
otherVersions: []Version{2},
expectedOK: false,
},
{
name: "empty supported versions",
supportedVersions: []Version{},
otherVersions: []Version{1, 2},
expectedOK: false,
},
{
name: "empty other versions",
supportedVersions: []Version{102, 101},
otherVersions: []Version{},
expectedOK: false,
},
{
name: "both empty",
supportedVersions: []Version{},
otherVersions: []Version{},
expectedOK: false,
},
}
It("says if a version is valid", func() {
Expect(IsValidVersion(VersionUnknown)).To(BeFalse())
Expect(IsValidVersion(versionDraft29)).To(BeFalse())
Expect(IsValidVersion(Version1)).To(BeTrue())
Expect(IsValidVersion(Version2)).To(BeTrue())
Expect(IsValidVersion(1234)).To(BeFalse())
})
It("has the right string representation", func() {
Expect(VersionUnknown.String()).To(Equal("unknown"))
Expect(versionDraft29.String()).To(Equal("draft-29"))
Expect(Version1.String()).To(Equal("v1"))
Expect(Version2.String()).To(Equal("v2"))
// check with unsupported version numbers from the wiki
Expect(Version(0x51303039).String()).To(Equal("gQUIC 9"))
Expect(Version(0x51303133).String()).To(Equal("gQUIC 13"))
Expect(Version(0x51303235).String()).To(Equal("gQUIC 25"))
Expect(Version(0x51303438).String()).To(Equal("gQUIC 48"))
Expect(Version(0x01234567).String()).To(Equal("0x1234567"))
})
It("recognizes supported versions", func() {
Expect(IsSupportedVersion(SupportedVersions, 0)).To(BeFalse())
Expect(IsSupportedVersion(SupportedVersions, SupportedVersions[0])).To(BeTrue())
Expect(IsSupportedVersion(SupportedVersions, SupportedVersions[len(SupportedVersions)-1])).To(BeTrue())
})
Context("highest supported version", func() {
It("finds the supported version", func() {
supportedVersions := []Version{1, 2, 3}
other := []Version{6, 5, 4, 3}
ver, ok := ChooseSupportedVersion(supportedVersions, other)
Expect(ok).To(BeTrue())
Expect(ver).To(Equal(Version(3)))
})
It("picks the preferred version", func() {
supportedVersions := []Version{2, 1, 3}
other := []Version{3, 6, 1, 8, 2, 10}
ver, ok := ChooseSupportedVersion(supportedVersions, other)
Expect(ok).To(BeTrue())
Expect(ver).To(Equal(Version(2)))
})
It("says when no matching version was found", func() {
_, ok := ChooseSupportedVersion([]Version{1}, []Version{2})
Expect(ok).To(BeFalse())
})
It("handles empty inputs", func() {
_, ok := ChooseSupportedVersion([]Version{102, 101}, []Version{})
Expect(ok).To(BeFalse())
_, ok = ChooseSupportedVersion([]Version{}, []Version{1, 2})
Expect(ok).To(BeFalse())
_, ok = ChooseSupportedVersion([]Version{}, []Version{})
Expect(ok).To(BeFalse())
})
})
Context("reserved versions", func() {
It("adds a greased version if passed an empty slice", func() {
greased := GetGreasedVersions([]Version{})
Expect(greased).To(HaveLen(1))
Expect(isReservedVersion(greased[0])).To(BeTrue())
})
It("creates greased lists of version numbers", func() {
supported := []Version{10, 18, 29}
for _, v := range supported {
Expect(isReservedVersion(v)).To(BeFalse())
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
ver, ok := ChooseSupportedVersion(tt.supportedVersions, tt.otherVersions)
require.Equal(t, tt.expectedOK, ok)
if tt.expectedOK {
require.Equal(t, tt.expectedVersion, ver)
}
var greasedVersionFirst, greasedVersionLast, greasedVersionMiddle int
// check that
// 1. the greased version sometimes appears first
// 2. the greased version sometimes appears in the middle
// 3. the greased version sometimes appears last
// 4. the supported versions are kept in order
for i := 0; i < 100; i++ {
greased := GetGreasedVersions(supported)
Expect(greased).To(HaveLen(4))
var j int
for i, v := range greased {
if isReservedVersion(v) {
if i == 0 {
greasedVersionFirst++
}
if i == len(greased)-1 {
greasedVersionLast++
}
greasedVersionMiddle++
continue
}
Expect(supported[j]).To(Equal(v))
j++
})
}
}
func isReservedVersion(v Version) bool { return v&0x0f0f0f0f == 0x0a0a0a0a }
func TestAddGreasedVersionToEmptySlice(t *testing.T) {
greased := GetGreasedVersions([]Version{})
require.Len(t, greased, 1)
require.True(t, isReservedVersion(greased[0]))
}
func TestAddGreasedVersion(t *testing.T) {
supported := []Version{10, 18, 29}
for _, v := range supported {
require.False(t, isReservedVersion(v))
}
var greasedVersionFirst, greasedVersionLast, greasedVersionMiddle int
for i := 0; i < 100; i++ {
greased := GetGreasedVersions(supported)
require.Len(t, greased, 4)
var j int
for i, v := range greased {
if isReservedVersion(v) {
if i == 0 {
greasedVersionFirst++
}
if i == len(greased)-1 {
greasedVersionLast++
}
greasedVersionMiddle++
continue
}
Expect(greasedVersionFirst).ToNot(BeZero())
Expect(greasedVersionLast).ToNot(BeZero())
Expect(greasedVersionMiddle).ToNot(BeZero())
})
})
})
require.Equal(t, supported[j], v)
j++
}
}
require.NotZero(t, greasedVersionFirst)
require.NotZero(t, greasedVersionLast)
require.NotZero(t, greasedVersionMiddle)
}