quic-go/stream_frame_queue_test.go

package quic

import (
	"github.com/lucas-clemente/quic-go/frames"
	"github.com/lucas-clemente/quic-go/protocol"
	. "github.com/onsi/ginkgo"
	. "github.com/onsi/gomega"
)

var _ = Describe("streamFrameQueue", func() {
	var prioFrame1, prioFrame2 *frames.StreamFrame
	var frame1, frame2 *frames.StreamFrame
	var queue *streamFrameQueue

	BeforeEach(func() {
		queue = &streamFrameQueue{}
		prioFrame1 = &frames.StreamFrame{
			StreamID: 5,
			Data:     []byte{0x13, 0x37},
		}
		prioFrame2 = &frames.StreamFrame{
			StreamID: 6,
			Data:     []byte{0xDE, 0xCA, 0xFB, 0xAD},
		}
		frame1 = &frames.StreamFrame{
			StreamID: 10,
			Data:     []byte{0xCA, 0xFE, 0x13},
		}
		frame2 = &frames.StreamFrame{
			StreamID: 11,
			Data:     []byte{0xDE, 0xAD, 0xBE, 0xEF, 0x37},
		}
	})

	Context("Queue Length", func() {
		It("returns the correct length for an empty queue", func() {
			Expect(queue.Len()).To(BeZero())
		})

		It("returns the correct length for a queue", func() {
			queue.Push(prioFrame1, true)
			Expect(queue.Len()).To(Equal(1))
			queue.Push(frame1, false)
			queue.Push(frame2, false)
			Expect(queue.Len()).To(Equal(3))
		})

		It("returns the correct length when popping", func() {
			queue.Push(prioFrame1, true)
			queue.Push(prioFrame2, true)
			queue.Push(frame1, false)
			queue.Push(frame2, false)
			Expect(queue.Len()).To(Equal(4))
			queue.Pop()
			Expect(queue.Len()).To(Equal(3))
			queue.Pop()
			queue.Pop()
			queue.Pop()
			Expect(queue.Len()).To(Equal(0))
		})

		It("does not change the length when using Front()", func() {
			queue.Push(prioFrame1, true)
			queue.Push(frame1, false)
			Expect(queue.Len()).To(Equal(2))
			queue.Front()
			Expect(queue.Len()).To(Equal(2))
		})
	})

	Context("Queue Byte Length", func() {
		It("returns the correct length for an empty queue", func() {
			Expect(queue.ByteLen()).To(BeZero())
		})

		It("returns the correct byte length for a queue", func() {
			queue.Push(prioFrame1, true)
			Expect(queue.ByteLen()).To(Equal(protocol.ByteCount(2)))
			queue.Push(frame1, false)
			queue.Push(frame2, false)
			Expect(queue.ByteLen()).To(Equal(protocol.ByteCount(2 + 3 + 5)))
		})

		It("returns the correct byte length when popping", func() {
			queue.Push(prioFrame1, true)
			queue.Push(prioFrame2, true)
			queue.Push(frame1, false)
			queue.Push(frame2, false)
			Expect(queue.ByteLen()).To(Equal(protocol.ByteCount(2 + 4 + 3 + 5)))
			queue.Pop()
			Expect(queue.ByteLen()).To(Equal(protocol.ByteCount(4 + 3 + 5)))
			queue.Pop()
			queue.Pop()
			queue.Pop()
			Expect(queue.ByteLen()).To(Equal(protocol.ByteCount(0)))
		})

		It("does not change the byte length when using Front()", func() {
			queue.Push(prioFrame1, true)
			queue.Push(frame1, false)
			Expect(queue.ByteLen()).To(Equal(protocol.ByteCount(2 + 3)))
			queue.Front()
			Expect(queue.ByteLen()).To(Equal(protocol.ByteCount(2 + 3)))
		})
	})

	Context("Popping", func() {
		It("returns nil when popping an empty queue", func() {
			Expect(queue.Pop()).To(BeNil())
		})

		It("deletes elements once they are popped", func() {
			queue.Push(frame1, false)
			Expect(queue.Pop()).To(Equal(frame1))
			Expect(queue.Pop()).To(BeNil())
		})

		It("returns normal frames if no prio frames are available", func() {
			queue.Push(frame1, false)
			queue.Push(frame2, false)
			Expect(queue.Pop()).To(Equal(frame1))
			Expect(queue.Pop()).To(Equal(frame2))
		})

		It("returns prio frames first", func() {
			queue.Push(prioFrame1, true)
			queue.Push(frame1, false)
			queue.Push(frame2, false)
			queue.Push(prioFrame2, true)
			Expect(queue.Pop()).To(Equal(prioFrame1))
			Expect(queue.Pop()).To(Equal(prioFrame2))
			Expect(queue.Pop()).To(Equal(frame1))
		})
	})

	Context("Front", func() {
		It("returns nil for an empty queue", func() {
			Expect(queue.Front()).To(BeNil())
		})

		It("returns normal frames if no prio frames are available", func() {
			queue.Push(frame1, false)
			queue.Push(frame2, false)
			Expect(queue.Front()).To(Equal(frame1))
			Expect(queue.Front()).To(Equal(frame1))
		})

		It("returns prio frames first", func() {
			queue.Push(prioFrame1, true)
			queue.Push(frame1, false)
			queue.Push(frame2, false)
			queue.Push(prioFrame2, true)
			Expect(queue.Front()).To(Equal(prioFrame1))
		})
	})
})