mirror of
https://github.com/refraction-networking/uquic.git
synced 2025-04-04 12:47:36 +03:00
Mock FlowControlManager using gomock
This commit is contained in:
Lucas Clemente
parent
94843e1919
commit
eeb2d8d821
9 changed files with 325 additions and 228 deletions
203
stream_test.go
203
stream_test.go
|
|
@ -5,114 +5,17 @@ import (
|
|||
"io"
|
||||
"time"
|
||||
|
||||
"github.com/lucas-clemente/quic-go/congestion"
|
||||
"github.com/lucas-clemente/quic-go/flowcontrol"
|
||||
"github.com/lucas-clemente/quic-go/frames"
|
||||
"github.com/lucas-clemente/quic-go/internal/mocks"
|
||||
"github.com/lucas-clemente/quic-go/protocol"
|
||||
"github.com/lucas-clemente/quic-go/utils"
|
||||
|
||||
. "github.com/onsi/ginkgo"
|
||||
. "github.com/onsi/gomega"
|
||||
)
|
||||
|
||||
type mockFlowControlHandler struct {
|
||||
streamsContributing []protocol.StreamID
|
||||
|
||||
sendWindowSizes map[protocol.StreamID]protocol.ByteCount
|
||||
remainingConnectionWindowSize protocol.ByteCount
|
||||
bytesReadForStream protocol.StreamID
|
||||
bytesRead protocol.ByteCount
|
||||
bytesSent protocol.ByteCount
|
||||
|
||||
receiveWindow protocol.ByteCount
|
||||
highestReceivedForStream protocol.StreamID
|
||||
highestReceived protocol.ByteCount
|
||||
flowControlViolation error
|
||||
|
||||
triggerStreamWindowUpdate bool
|
||||
triggerConnectionWindowUpdate bool
|
||||
}
|
||||
|
||||
var _ flowcontrol.FlowControlManager = &mockFlowControlHandler{}
|
||||
|
||||
func newMockFlowControlHandler() *mockFlowControlHandler {
|
||||
return &mockFlowControlHandler{
|
||||
sendWindowSizes: make(map[protocol.StreamID]protocol.ByteCount),
|
||||
}
|
||||
}
|
||||
|
||||
func (m *mockFlowControlHandler) NewStream(streamID protocol.StreamID, contributesToConnectionFlow bool) {
|
||||
panic("not implemented")
|
||||
}
|
||||
|
||||
func (m *mockFlowControlHandler) RemoveStream(streamID protocol.StreamID) {
|
||||
delete(m.sendWindowSizes, streamID)
|
||||
}
|
||||
|
||||
func (m *mockFlowControlHandler) GetWindowUpdates() (res []flowcontrol.WindowUpdate) {
|
||||
if m.triggerStreamWindowUpdate {
|
||||
res = append(res, flowcontrol.WindowUpdate{StreamID: 42, Offset: 0x1337})
|
||||
}
|
||||
if m.triggerConnectionWindowUpdate {
|
||||
res = append(res, flowcontrol.WindowUpdate{StreamID: 0, Offset: 0x1337})
|
||||
}
|
||||
return res
|
||||
}
|
||||
|
||||
func (m *mockFlowControlHandler) GetReceiveWindow(protocol.StreamID) (protocol.ByteCount, error) {
|
||||
return m.receiveWindow, nil
|
||||
}
|
||||
|
||||
func (m *mockFlowControlHandler) AddBytesRead(streamID protocol.StreamID, n protocol.ByteCount) error {
|
||||
m.bytesReadForStream = streamID
|
||||
m.bytesRead = n
|
||||
return nil
|
||||
}
|
||||
|
||||
func (m *mockFlowControlHandler) ResetStream(streamID protocol.StreamID, byteOffset protocol.ByteCount) error {
|
||||
m.bytesRead = byteOffset
|
||||
return m.UpdateHighestReceived(streamID, byteOffset)
|
||||
}
|
||||
|
||||
func (m *mockFlowControlHandler) UpdateHighestReceived(streamID protocol.StreamID, byteOffset protocol.ByteCount) error {
|
||||
if m.flowControlViolation != nil {
|
||||
return m.flowControlViolation
|
||||
}
|
||||
m.highestReceivedForStream = streamID
|
||||
m.highestReceived = byteOffset
|
||||
return nil
|
||||
}
|
||||
|
||||
func (m *mockFlowControlHandler) AddBytesSent(streamID protocol.StreamID, n protocol.ByteCount) error {
|
||||
m.bytesSent += n
|
||||
m.sendWindowSizes[streamID] -= n
|
||||
for _, s := range m.streamsContributing {
|
||||
if s == streamID {
|
||||
m.remainingConnectionWindowSize -= n
|
||||
return nil
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (m *mockFlowControlHandler) SendWindowSize(streamID protocol.StreamID) (protocol.ByteCount, error) {
|
||||
res := m.sendWindowSizes[streamID]
|
||||
for _, s := range m.streamsContributing {
|
||||
if s == streamID {
|
||||
return utils.MinByteCount(res, m.remainingConnectionWindowSize), nil
|
||||
}
|
||||
}
|
||||
return res, nil
|
||||
}
|
||||
|
||||
func (m *mockFlowControlHandler) RemainingConnectionWindowSize() protocol.ByteCount {
|
||||
return m.remainingConnectionWindowSize
|
||||
}
|
||||
|
||||
func (m *mockFlowControlHandler) UpdateWindow(streamID protocol.StreamID, offset protocol.ByteCount) (bool, error) {
|
||||
panic("not implemented")
|
||||
}
|
||||
|
||||
var _ = Describe("Stream", func() {
|
||||
const streamID protocol.StreamID = 1337
|
||||
|
||||
var (
|
||||
str *stream
|
||||
onDataCalled bool
|
||||
|
|
@ -120,6 +23,8 @@ var _ = Describe("Stream", func() {
|
|||
resetCalled bool
|
||||
resetCalledForStream protocol.StreamID
|
||||
resetCalledAtOffset protocol.ByteCount
|
||||
|
||||
mockFcm *mocks.MockFlowControlManager
|
||||
)
|
||||
|
||||
onData := func() {
|
||||
|
|
@ -135,11 +40,8 @@ var _ = Describe("Stream", func() {
|
|||
BeforeEach(func() {
|
||||
onDataCalled = false
|
||||
resetCalled = false
|
||||
var streamID protocol.StreamID = 1337
|
||||
cpm := &mockConnectionParametersManager{}
|
||||
flowControlManager := flowcontrol.NewFlowControlManager(cpm, &congestion.RTTStats{})
|
||||
flowControlManager.NewStream(streamID, true)
|
||||
str = newStream(streamID, onData, onReset, flowControlManager)
|
||||
mockFcm = mocks.NewMockFlowControlManager(mockCtrl)
|
||||
str = newStream(streamID, onData, onReset, mockFcm)
|
||||
})
|
||||
|
||||
It("gets stream id", func() {
|
||||
|
|
@ -148,6 +50,8 @@ var _ = Describe("Stream", func() {
|
|||
|
||||
Context("reading", func() {
|
||||
It("reads a single StreamFrame", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(4))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(4))
|
||||
frame := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
Data: []byte{0xDE, 0xAD, 0xBE, 0xEF},
|
||||
|
|
@ -162,6 +66,9 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("reads a single StreamFrame in multiple goes", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(4))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(2))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(2))
|
||||
frame := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
Data: []byte{0xDE, 0xAD, 0xBE, 0xEF},
|
||||
|
|
@ -180,6 +87,9 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("reads all data available", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(2))
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(4))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(2)).Times(2)
|
||||
frame1 := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
Data: []byte{0xDE, 0xAD},
|
||||
|
|
@ -200,6 +110,9 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("assembles multiple StreamFrames", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(2))
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(4))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(2)).Times(2)
|
||||
frame1 := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
Data: []byte{0xDE, 0xAD},
|
||||
|
|
@ -220,6 +133,8 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("waits until data is available", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(2))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(2))
|
||||
go func() {
|
||||
frame := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
|
|
@ -236,6 +151,9 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("handles StreamFrames in wrong order", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(2))
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(4))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(2)).Times(2)
|
||||
frame1 := frames.StreamFrame{
|
||||
Offset: 2,
|
||||
Data: []byte{0xBE, 0xEF},
|
||||
|
|
@ -256,6 +174,10 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("ignores duplicate StreamFrames", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(2))
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(2))
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(4))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(2)).Times(2)
|
||||
frame1 := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
Data: []byte{0xDE, 0xAD},
|
||||
|
|
@ -282,6 +204,10 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("doesn't rejects a StreamFrames with an overlapping data range", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(4))
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(6))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(2))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(4))
|
||||
frame1 := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
Data: []byte("foob"),
|
||||
|
|
@ -293,6 +219,7 @@ var _ = Describe("Stream", func() {
|
|||
err := str.AddStreamFrame(&frame1)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
err = str.AddStreamFrame(&frame2)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
b := make([]byte, 6)
|
||||
n, err := str.Read(b)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
|
|
@ -301,6 +228,8 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("calls onData", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(4))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(4))
|
||||
frame := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
Data: []byte{0xDE, 0xAD, 0xBE, 0xEF},
|
||||
|
|
@ -315,6 +244,8 @@ var _ = Describe("Stream", func() {
|
|||
Context("closing", func() {
|
||||
Context("with FIN bit", func() {
|
||||
It("returns EOFs", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(4))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(4))
|
||||
frame := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
Data: []byte{0xDE, 0xAD, 0xBE, 0xEF},
|
||||
|
|
@ -332,6 +263,9 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("handles out-of-order frames", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(2))
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(4))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(2)).Times(2)
|
||||
frame1 := frames.StreamFrame{
|
||||
Offset: 2,
|
||||
Data: []byte{0xBE, 0xEF},
|
||||
|
|
@ -356,6 +290,8 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("returns EOFs with partial read", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(2))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(2))
|
||||
frame := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
Data: []byte{0xDE, 0xAD},
|
||||
|
|
@ -371,6 +307,8 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("handles immediate FINs", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(0))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(0))
|
||||
frame := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
Data: []byte{},
|
||||
|
|
@ -387,6 +325,8 @@ var _ = Describe("Stream", func() {
|
|||
|
||||
Context("when CloseRemote is called", func() {
|
||||
It("closes", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(0))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(0))
|
||||
str.CloseRemote(0)
|
||||
b := make([]byte, 8)
|
||||
n, err := str.Read(b)
|
||||
|
|
@ -430,6 +370,7 @@ var _ = Describe("Stream", func() {
|
|||
|
||||
Context("reset by the peer", func() {
|
||||
It("continues reading after receiving a remote error", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(4))
|
||||
frame := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
Data: []byte{0xDE, 0xAD, 0xBE, 0xEF},
|
||||
|
|
@ -443,6 +384,7 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("reads a delayed StreamFrame that arrives after receiving a remote error", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(4))
|
||||
str.RegisterRemoteError(testErr)
|
||||
frame := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
|
|
@ -457,6 +399,7 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("returns the error if reading past the offset of the frame received", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(4))
|
||||
frame := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
Data: []byte{0xDE, 0xAD, 0xBE, 0xEF},
|
||||
|
|
@ -471,6 +414,7 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("returns an EOF when reading past the offset, if the stream received a finbit", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(4))
|
||||
frame := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
Data: []byte{0xDE, 0xAD, 0xBE, 0xEF},
|
||||
|
|
@ -486,6 +430,7 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("continues reading in small chunks after receiving a remote error", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(4))
|
||||
frame := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
Data: []byte{0xDE, 0xAD, 0xBE, 0xEF},
|
||||
|
|
@ -505,19 +450,18 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("doesn't inform the flow controller about bytes read after receiving the remote error", func() {
|
||||
str.flowControlManager = newMockFlowControlHandler()
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(4))
|
||||
// No AddBytesRead()
|
||||
frame := frames.StreamFrame{
|
||||
Offset: 0,
|
||||
StreamID: 5,
|
||||
Data: []byte{0xDE, 0xAD, 0xBE, 0xEF},
|
||||
}
|
||||
str.AddStreamFrame(&frame)
|
||||
str.flowControlManager.ResetStream(5, 4)
|
||||
str.RegisterRemoteError(testErr)
|
||||
b := make([]byte, 3)
|
||||
_, err := str.Read(b)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(str.flowControlManager.(*mockFlowControlHandler).bytesRead).To(BeEquivalentTo(4))
|
||||
})
|
||||
|
||||
It("stops writing after receiving a remote error", func() {
|
||||
|
|
@ -617,6 +561,7 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("doesn't allow further reads", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(6))
|
||||
str.AddStreamFrame(&frames.StreamFrame{
|
||||
Data: []byte("foobar"),
|
||||
})
|
||||
|
|
@ -801,32 +746,15 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
})
|
||||
|
||||
Context("flow control, for receiving", func() {
|
||||
BeforeEach(func() {
|
||||
str.flowControlManager = &mockFlowControlHandler{}
|
||||
})
|
||||
|
||||
It("updates the highestReceived value in the flow controller", func() {
|
||||
frame := frames.StreamFrame{
|
||||
Offset: 2,
|
||||
Data: []byte("foobar"),
|
||||
}
|
||||
err := str.AddStreamFrame(&frame)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(str.flowControlManager.(*mockFlowControlHandler).highestReceivedForStream).To(Equal(str.streamID))
|
||||
Expect(str.flowControlManager.(*mockFlowControlHandler).highestReceived).To(Equal(protocol.ByteCount(2 + 6)))
|
||||
})
|
||||
|
||||
It("errors when a StreamFrames causes a flow control violation", func() {
|
||||
testErr := errors.New("flow control violation")
|
||||
str.flowControlManager.(*mockFlowControlHandler).flowControlViolation = testErr
|
||||
frame := frames.StreamFrame{
|
||||
Offset: 2,
|
||||
Data: []byte("foobar"),
|
||||
}
|
||||
err := str.AddStreamFrame(&frame)
|
||||
Expect(err).To(MatchError(testErr))
|
||||
})
|
||||
It("errors when a StreamFrames causes a flow control violation", func() {
|
||||
testErr := errors.New("flow control violation")
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(8)).Return(testErr)
|
||||
frame := frames.StreamFrame{
|
||||
Offset: 2,
|
||||
Data: []byte("foobar"),
|
||||
}
|
||||
err := str.AddStreamFrame(&frame)
|
||||
Expect(err).To(MatchError(testErr))
|
||||
})
|
||||
|
||||
Context("closing", func() {
|
||||
|
|
@ -852,6 +780,8 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("is not finished if it is only closed for reading", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(0))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(0))
|
||||
finishReading()
|
||||
Expect(str.finished()).To(BeFalse())
|
||||
})
|
||||
|
|
@ -878,11 +808,12 @@ var _ = Describe("Stream", func() {
|
|||
})
|
||||
|
||||
It("is finished after finishing reading and being locally reset", func() {
|
||||
mockFcm.EXPECT().UpdateHighestReceived(streamID, protocol.ByteCount(0))
|
||||
mockFcm.EXPECT().AddBytesRead(streamID, protocol.ByteCount(0))
|
||||
finishReading()
|
||||
Expect(str.finished()).To(BeFalse())
|
||||
str.Reset(testErr)
|
||||
Expect(str.finished()).To(BeTrue())
|
||||
})
|
||||
})
|
||||
|
||||
})
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue