From 4076ab587e65b7258fc53a9d923729a17b00aa5e Mon Sep 17 00:00:00 2001
From: Marten Seemann <martenseemann@gmail.com>
Date: Wed, 22 Nov 2017 15:57:22 -0800
Subject: [PATCH] add a string representation for the Long Header packet types

---
 internal/protocol/protocol.go      | 22 +++++++++++++++++++++-
 internal/protocol/protocol_test.go | 19 +++++++++++++++++++
 internal/wire/ietf_header.go       |  2 +-
 internal/wire/ietf_header_test.go  |  4 ++--
 4 files changed, 43 insertions(+), 4 deletions(-)
 create mode 100644 internal/protocol/protocol_test.go

diff --git a/internal/protocol/protocol.go b/internal/protocol/protocol.go
index dadbf32d..23330707 100644
--- a/internal/protocol/protocol.go
+++ b/internal/protocol/protocol.go
@@ -1,6 +1,9 @@
 package protocol
 
-import "math"
+import (
+	"fmt"
+	"math"
+)
 
 // A PacketNumber in QUIC
 type PacketNumber uint64
@@ -37,6 +40,23 @@ const (
 	PacketType0RTT PacketType = 5
 )
 
+func (t PacketType) String() string {
+	switch t {
+	case PacketTypeVersionNegotiation:
+		return "Version Negotiation"
+	case PacketTypeInitial:
+		return "Initial"
+	case PacketTypeRetry:
+		return "Retry"
+	case PacketTypeHandshake:
+		return "Handshake"
+	case PacketType0RTT:
+		return "0-RTT Protected"
+	default:
+		return fmt.Sprintf("unknown packet type: %d", t)
+	}
+}
+
 // A ConnectionID in QUIC
 type ConnectionID uint64
 
diff --git a/internal/protocol/protocol_test.go b/internal/protocol/protocol_test.go
new file mode 100644
index 00000000..27576184
--- /dev/null
+++ b/internal/protocol/protocol_test.go
@@ -0,0 +1,19 @@
+package protocol
+
+import (
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("Protocol", func() {
+	Context("Long Header Packet Types", func() {
+		It("has the correct string representation", func() {
+			Expect(PacketTypeVersionNegotiation.String()).To(Equal("Version Negotiation"))
+			Expect(PacketTypeInitial.String()).To(Equal("Initial"))
+			Expect(PacketTypeRetry.String()).To(Equal("Retry"))
+			Expect(PacketTypeHandshake.String()).To(Equal("Handshake"))
+			Expect(PacketType0RTT.String()).To(Equal("0-RTT Protected"))
+			Expect(PacketType(10).String()).To(Equal("unknown packet type: 10"))
+		})
+	})
+})
diff --git a/internal/wire/ietf_header.go b/internal/wire/ietf_header.go
index 3db67cc0..4595a4bb 100644
--- a/internal/wire/ietf_header.go
+++ b/internal/wire/ietf_header.go
@@ -159,7 +159,7 @@ func (h *Header) getHeaderLength() (protocol.ByteCount, error) {
 
 func (h *Header) logHeader() {
 	if h.IsLongHeader {
-		utils.Debugf("   Long Header{Type: %#x, ConnectionID: %#x, PacketNumber: %#x, Version: %s}", h.Type, h.ConnectionID, h.PacketNumber, h.Version)
+		utils.Debugf("   Long Header{Type: %s, ConnectionID: %#x, PacketNumber: %#x, Version: %s}", h.Type, h.ConnectionID, h.PacketNumber, h.Version)
 	} else {
 		connID := "(omitted)"
 		if !h.OmitConnectionID {
diff --git a/internal/wire/ietf_header_test.go b/internal/wire/ietf_header_test.go
index 65daf128..06443729 100644
--- a/internal/wire/ietf_header_test.go
+++ b/internal/wire/ietf_header_test.go
@@ -389,12 +389,12 @@ var _ = Describe("IETF draft Header", func() {
 		It("logs Long Headers", func() {
 			(&Header{
 				IsLongHeader: true,
-				Type:         0x5,
+				Type:         protocol.PacketTypeHandshake,
 				PacketNumber: 0x1337,
 				ConnectionID: 0xdeadbeef,
 				Version:      253,
 			}).logHeader()
-			Expect(string(buf.Bytes())).To(ContainSubstring("Long Header{Type: 0x5, ConnectionID: 0xdeadbeef, PacketNumber: 0x1337, Version: 253}"))
+			Expect(string(buf.Bytes())).To(ContainSubstring("Long Header{Type: Handshake, ConnectionID: 0xdeadbeef, PacketNumber: 0x1337, Version: 253}"))
 		})
 
 		It("logs Short Headers containing a connection ID", func() {