tasks/common/rpc/context_test.go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package rpc

import (
	"context"
	"testing"
	"time"

	"github.com/stretchr/testify/require"
	"github.com/stretchr/testify/suite"
	"google.golang.org/grpc/metadata"
)

type (
	contextSuite struct {
		*require.Assertions
		suite.Suite
	}
)

func TestContextSuite(t *testing.T) {
	suite.Run(t, &contextSuite{})
}

func (s *contextSuite) SetupTest() {
	s.Assertions = require.New(s.T())
}

func (s *contextSuite) TestCopyContextValues_ValueCopied() {
	key := struct{}{}
	value := "value"

	metadataKey := "header-key"
	metadataValue := "header-value"

	ctx := context.Background()
	ctx = context.WithValue(ctx, key, value)
	ctx = metadata.NewIncomingContext(ctx, metadata.Pairs(metadataKey, metadataValue))

	newDeadline := time.Now().Add(time.Hour)
	newContext, _ := context.WithDeadline(context.Background(), newDeadline)

	newContext = CopyContextValues(newContext, ctx)

	s.Equal(value, newContext.Value(key))
	md, ok := metadata.FromIncomingContext(newContext)
	s.True(ok)
	s.Equal(metadataValue, md[metadataKey][0])
}

func (s *contextSuite) TestCopyContextValue_DeadlineSeparated() {
	deadline := time.Now().Add(time.Minute)
	ctx, cancel := context.WithDeadline(context.Background(), deadline)

	newDeadline := time.Now().Add(time.Hour)
	newContext, newCancel := context.WithDeadline(context.Background(), newDeadline)
	defer newCancel()

	newContext = CopyContextValues(newContext, ctx)

	cancel()
	s.NotNil(ctx.Err())
	s.Nil(newContext.Err())
}

func (s *contextSuite) TestCopyContextValue_ValueNotOverWritten() {
	key := struct{}{}
	value := "value"
	ctx := context.WithValue(context.Background(), key, value)

	newValue := "newValue"
	newContext := context.WithValue(context.Background(), key, newValue)

	newContext = CopyContextValues(newContext, ctx)

	s.Equal(newValue, newContext.Value(key))
}