span_context_test.go

// Copyright (c) 2017 Uber Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package jaeger

import (
	"math"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func TestContextFromString(t *testing.T) {
	var err error
	_, err = ContextFromString("")
	assert.Error(t, err)
	_, err = ContextFromString("abcd")
	assert.Error(t, err)
	_, err = ContextFromString("x:1:1:1")
	assert.Error(t, err)
	_, err = ContextFromString("1:x:1:1")
	assert.Error(t, err)
	_, err = ContextFromString("1:1:x:1")
	assert.Error(t, err)
	_, err = ContextFromString("1:1:1:x")
	assert.Error(t, err)
	_, err = ContextFromString("1:1:1:x")
	assert.Error(t, err)
	_, err = ContextFromString("01234567890123456789012345678901234:1:1:1")
	assert.Error(t, err)
	_, err = ContextFromString("01234567890123456789012345678901:1:1:1")
	assert.NoError(t, err)
	_, err = ContextFromString("01234_67890123456789012345678901:1:1:1")
	assert.Error(t, err)
	_, err = ContextFromString("0123456789012345678901_345678901:1:1:1")
	assert.Error(t, err)
	_, err = ContextFromString("1:0123456789012345:1:1")
	assert.NoError(t, err)
	_, err = ContextFromString("1:01234567890123456:1:1")
	assert.Error(t, err)
	ctx, err := ContextFromString("10000000000000001:1:1:1")
	assert.NoError(t, err)
	assert.EqualValues(t, TraceID{High: 1, Low: 1}, ctx.traceID)
	ctx, err = ContextFromString("1:1:1:1")
	assert.NoError(t, err)
	assert.EqualValues(t, TraceID{Low: 1}, ctx.traceID)
	assert.EqualValues(t, 1, ctx.spanID)
	assert.EqualValues(t, 1, ctx.parentID)
	assert.True(t, ctx.IsSampled())
	ctx = NewSpanContext(TraceID{Low: 1}, 1, 1, true, nil)
	assert.EqualValues(t, TraceID{Low: 1}, ctx.traceID)
	assert.EqualValues(t, 1, ctx.spanID)
	assert.EqualValues(t, 1, ctx.parentID)
	assert.True(t, ctx.IsSampled())
	assert.Equal(t, "00000000000000ff", SpanID(255).String())
	assert.Equal(t, "00000000000000ff", TraceID{Low: 255}.String())
	assert.Equal(t, "00000000000000ff00000000000000ff", TraceID{High: 255, Low: 255}.String())
	ctx = NewSpanContext(TraceID{High: 255, Low: 255}, SpanID(1), SpanID(1), false, nil)
	assert.Equal(t, "00000000000000ff00000000000000ff:0000000000000001:0000000000000001:0", ctx.String())
}

func TestSpanContext_WithBaggageItem(t *testing.T) {
	var ctx SpanContext
	ctx = ctx.WithBaggageItem("some-KEY", "Some-Value")
	assert.Equal(t, map[string]string{"some-KEY": "Some-Value"}, ctx.baggage)
	ctx = ctx.WithBaggageItem("some-KEY", "Some-Other-Value")
	assert.Equal(t, map[string]string{"some-KEY": "Some-Other-Value"}, ctx.baggage)
}

func TestSpanContext_WithBaggageItem_Delete(t *testing.T) {
	var ctx SpanContext
	ctx = ctx.WithBaggageItem("some-KEY", "")
	assert.Nil(t, ctx.baggage)
	ctx = ctx.WithBaggageItem("some-KEY", "Some-Value")
	assert.Equal(t, map[string]string{"some-KEY": "Some-Value"}, ctx.baggage)
	ctx = ctx.WithBaggageItem("another-KEY", "")
	assert.Equal(t, map[string]string{"some-KEY": "Some-Value"}, ctx.baggage)
	ctx2 := ctx.WithBaggageItem("some-KEY", "")
	assert.Equal(t, map[string]string{"some-KEY": "Some-Value"}, ctx.baggage, "parent unchanged")
	assert.Equal(t, map[string]string{}, ctx2.baggage)
}

func TestSpanContext_Flags(t *testing.T) {

	var tests = map[string]struct {
		in           string
		sampledFlag  bool
		debugFlag    bool
		firehoseFlag bool
	}{
		"None": {
			in:           "1:1:1:0",
			sampledFlag:  false,
			debugFlag:    false,
			firehoseFlag: false,
		},
		"Sampled Only": {
			in:           "1:1:1:1",
			sampledFlag:  true,
			debugFlag:    false,
			firehoseFlag: false,
		},

		"Debug Only": {
			in:           "1:1:1:2",
			sampledFlag:  false,
			debugFlag:    true,
			firehoseFlag: false,
		},

		"IsFirehose Only": {
			in:           "1:1:1:8",
			sampledFlag:  false,
			debugFlag:    false,
			firehoseFlag: true,
		},

		"Sampled And Debug": {
			in:           "1:1:1:3",
			sampledFlag:  true,
			debugFlag:    true,
			firehoseFlag: false,
		},

		"Sampled And Firehose": {
			in:           "1:1:1:9",
			sampledFlag:  true,
			debugFlag:    false,
			firehoseFlag: true,
		},

		"Debug And Firehose": {
			in:           "1:1:1:10",
			sampledFlag:  false,
			debugFlag:    true,
			firehoseFlag: true,
		},

		"Sampled And Debug And Firehose": {
			in:           "1:1:1:11",
			sampledFlag:  true,
			debugFlag:    true,
			firehoseFlag: true,
		},
	}

	for name, tc := range tests {
		t.Run(name, func(t *testing.T) {
			ctx, err := ContextFromString(tc.in)
			require.NoError(t, err)
			assert.Equal(t, tc.sampledFlag, ctx.IsSampled())
			assert.Equal(t, tc.debugFlag, ctx.IsDebug())
			assert.Equal(t, tc.firehoseFlag, ctx.IsFirehose())
		})
	}
}

func TestSpanContext_CopyFrom(t *testing.T) {
	ctx, err := ContextFromString("1:1:1:1")
	require.NoError(t, err)
	ctx2 := SpanContext{}
	ctx2.CopyFrom(&ctx)
	assert.Equal(t, ctx, ctx2)
	// with baggage
	ctx = ctx.WithBaggageItem("x", "y")
	ctx2 = SpanContext{}
	ctx2.CopyFrom(&ctx)
	assert.Equal(t, ctx, ctx2)
	assert.Equal(t, "y", ctx2.baggage["x"])
}

func TestTraceIDString(t *testing.T) {
	var tests = map[string]struct {
		in       TraceID
		expected string
	}{
		"Empty TraceID": {
			in:       TraceID{},
			expected: "0000000000000000",
		},
		"TraceID low only": {
			in:       TraceID{Low: math.MaxUint64/16 - 405},
			expected: "0ffffffffffffe6a",
		},
		"TraceID low and high": {
			in:       TraceID{High: math.MaxUint64 / 16, Low: math.MaxUint64/16 - 405},
			expected: "0fffffffffffffff0ffffffffffffe6a",
		},
	}
	for name, tc := range tests {
		t.Run(name, func(t *testing.T) {
			assert.Equal(t, tc.expected, tc.in.String())
			parsed, err := TraceIDFromString(tc.in.String())
			assert.NoError(t, err)
			assert.Equal(t, tc.in, parsed)
		})
	}
}

func TestSpanIDString(t *testing.T) {
	var tests = map[string]struct {
		in       SpanID
		expected string
	}{
		"SpanID zero": {
			in:       0,
			expected: "0000000000000000",
		},
		"SpanID non zero": {
			in:       math.MaxUint64/16 - 405,
			expected: "0ffffffffffffe6a",
		},
	}
	for name, tc := range tests {
		t.Run(name, func(t *testing.T) {
			assert.Equal(t, tc.expected, tc.in.String())
			parsed, err := SpanIDFromString(tc.in.String())
			assert.NoError(t, err)
			assert.Equal(t, tc.in, parsed)
		})
	}
}