1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
|
package qlog
import (
"bytes"
"net"
"testing"
"time"
"github.com/quic-go/quic-go/internal/protocol"
"github.com/quic-go/quic-go/logging"
"github.com/stretchr/testify/require"
)
func newTracer() (*logging.Tracer, *bytes.Buffer) {
buf := &bytes.Buffer{}
tracer := NewTracer(nopWriteCloser(buf))
return tracer, buf
}
func TestTraceMetadata(t *testing.T) {
tracer, buf := newTracer()
tracer.Close()
var m map[string]interface{}
err := unmarshal(buf.Bytes(), &m)
require.NoError(t, err)
require.Equal(t, "0.3", m["qlog_version"])
require.Contains(t, m, "title")
require.Contains(t, m, "trace")
trace := m["trace"].(map[string]interface{})
require.Contains(t, trace, "common_fields")
commonFields := trace["common_fields"].(map[string]interface{})
require.NotContains(t, commonFields, "ODCID")
require.NotContains(t, commonFields, "group_id")
require.Contains(t, commonFields, "reference_time")
referenceTime := time.Unix(0, int64(commonFields["reference_time"].(float64)*1e6))
require.WithinDuration(t, time.Now(), referenceTime, scaleDuration(10*time.Millisecond))
require.Equal(t, "relative", commonFields["time_format"])
require.Contains(t, trace, "vantage_point")
vantagePoint := trace["vantage_point"].(map[string]interface{})
require.Equal(t, "transport", vantagePoint["type"])
}
func TestTracerSentLongHeaderPacket(t *testing.T) {
tracer, buf := newTracer()
tracer.SentPacket(
nil,
&logging.Header{
Type: protocol.PacketTypeHandshake,
DestConnectionID: protocol.ParseConnectionID([]byte{1, 2, 3, 4, 5, 6, 7, 8}),
SrcConnectionID: protocol.ParseConnectionID([]byte{4, 3, 2, 1}),
Length: 1337,
Version: protocol.Version1,
},
1234,
[]logging.Frame{
&logging.MaxStreamDataFrame{StreamID: 42, MaximumStreamData: 987},
&logging.StreamFrame{StreamID: 123, Offset: 1234, Length: 6, Fin: true},
},
)
tracer.Close()
entry := exportAndParseSingle(t, buf)
require.WithinDuration(t, time.Now(), entry.Time, scaleDuration(10*time.Millisecond))
require.Equal(t, "transport:packet_sent", entry.Name)
ev := entry.Event
require.Contains(t, ev, "raw")
raw := ev["raw"].(map[string]interface{})
require.Equal(t, float64(1234), raw["length"])
require.Contains(t, ev, "header")
hdr := ev["header"].(map[string]interface{})
require.Equal(t, "handshake", hdr["packet_type"])
require.Equal(t, "04030201", hdr["scid"])
require.Contains(t, ev, "frames")
frames := ev["frames"].([]interface{})
require.Len(t, frames, 2)
require.Equal(t, "max_stream_data", frames[0].(map[string]interface{})["frame_type"])
require.Equal(t, "stream", frames[1].(map[string]interface{})["frame_type"])
}
func TestSendingVersionNegotiationPacket(t *testing.T) {
tracer, buf := newTracer()
tracer.SentVersionNegotiationPacket(
nil,
protocol.ArbitraryLenConnectionID{1, 2, 3, 4, 5, 6, 7, 8},
protocol.ArbitraryLenConnectionID{4, 3, 2, 1},
[]protocol.Version{0xdeadbeef, 0xdecafbad},
)
tracer.Close()
entry := exportAndParseSingle(t, buf)
require.WithinDuration(t, time.Now(), entry.Time, scaleDuration(10*time.Millisecond))
require.Equal(t, "transport:packet_sent", entry.Name)
ev := entry.Event
require.Contains(t, ev, "header")
require.NotContains(t, ev, "frames")
require.Contains(t, ev, "supported_versions")
require.Equal(t, []interface{}{"deadbeef", "decafbad"}, ev["supported_versions"].([]interface{}))
header := ev["header"]
require.Equal(t, "version_negotiation", header.(map[string]interface{})["packet_type"])
require.NotContains(t, header, "packet_number")
require.NotContains(t, header, "version")
require.Equal(t, "0102030405060708", header.(map[string]interface{})["dcid"])
require.Equal(t, "04030201", header.(map[string]interface{})["scid"])
}
func TestDroppedPackets(t *testing.T) {
tracer, buf := newTracer()
addr := net.UDPAddr{IP: net.IPv4(1, 2, 3, 4), Port: 1234}
tracer.DroppedPacket(&addr, logging.PacketTypeInitial, 1337, logging.PacketDropPayloadDecryptError)
tracer.Close()
entry := exportAndParseSingle(t, buf)
require.WithinDuration(t, time.Now(), entry.Time, scaleDuration(10*time.Millisecond))
require.Equal(t, "transport:packet_dropped", entry.Name)
ev := entry.Event
require.Contains(t, ev, "raw")
require.Equal(t, float64(1337), ev["raw"].(map[string]interface{})["length"])
require.Contains(t, ev, "header")
hdr := ev["header"].(map[string]interface{})
require.Len(t, hdr, 1)
require.Equal(t, "initial", hdr["packet_type"])
require.Equal(t, "payload_decrypt_error", ev["trigger"])
}
func TestGenericTracerEvent(t *testing.T) {
tracer, buf := newTracer()
tracer.Debug("foo", "bar")
tracer.Close()
entry := exportAndParseSingle(t, buf)
require.WithinDuration(t, time.Now(), entry.Time, scaleDuration(10*time.Millisecond))
require.Equal(t, "transport:foo", entry.Name)
ev := entry.Event
require.Len(t, ev, 1)
require.Equal(t, "bar", ev["details"])
}
|