go.temporal.io/server@v1.23.0/common/headers/headers_test.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package headers
    26  
    27  import (
    28  	"context"
    29  	"testing"
    30  
    31  	"github.com/stretchr/testify/require"
    32  	"github.com/stretchr/testify/suite"
    33  	"google.golang.org/grpc/metadata"
    34  )
    35  
    36  type (
    37  	HeadersSuite struct {
    38  		*require.Assertions
    39  		suite.Suite
    40  	}
    41  )
    42  
    43  func TestHeadersSuite(t *testing.T) {
    44  	suite.Run(t, &HeadersSuite{})
    45  }
    46  
    47  func (s *HeadersSuite) SetupTest() {
    48  	s.Assertions = require.New(s.T())
    49  }
    50  
    51  func (s *HeadersSuite) TestPropagate_CreateNewOutgoingContext() {
    52  	ctx := context.Background()
    53  	ctx = metadata.NewIncomingContext(ctx, metadata.New(map[string]string{
    54  		ClientVersionHeaderName:           "22.08.78",
    55  		SupportedServerVersionsHeaderName: ">21.04.16",
    56  		ClientNameHeaderName:              "28.08.14",
    57  		SupportedFeaturesHeaderName:       "my-feature",
    58  	}))
    59  
    60  	ctx = Propagate(ctx)
    61  
    62  	md, ok := metadata.FromOutgoingContext(ctx)
    63  	s.True(ok)
    64  
    65  	s.Equal("22.08.78", md.Get(ClientVersionHeaderName)[0])
    66  	s.Equal(">21.04.16", md.Get(SupportedServerVersionsHeaderName)[0])
    67  	s.Equal("28.08.14", md.Get(ClientNameHeaderName)[0])
    68  	s.Equal("my-feature", md.Get(SupportedFeaturesHeaderName)[0])
    69  }
    70  
    71  func (s *HeadersSuite) TestPropagate_CreateNewOutgoingContext_SomeMissing() {
    72  	ctx := context.Background()
    73  	ctx = metadata.NewIncomingContext(ctx, metadata.New(map[string]string{
    74  		ClientVersionHeaderName: "22.08.78",
    75  		ClientNameHeaderName:    "28.08.14",
    76  	}))
    77  
    78  	ctx = Propagate(ctx)
    79  
    80  	md, ok := metadata.FromOutgoingContext(ctx)
    81  	s.True(ok)
    82  
    83  	s.Equal("22.08.78", md.Get(ClientVersionHeaderName)[0])
    84  	s.Equal(0, len(md.Get(SupportedServerVersionsHeaderName)))
    85  	s.Equal("28.08.14", md.Get(ClientNameHeaderName)[0])
    86  	s.Equal(0, len(md.Get(SupportedFeaturesHeaderName)))
    87  }
    88  
    89  func (s *HeadersSuite) TestPropagate_UpdateExistingEmptyOutgoingContext() {
    90  	ctx := context.Background()
    91  	ctx = metadata.NewIncomingContext(ctx, metadata.New(map[string]string{
    92  		ClientVersionHeaderName:           "22.08.78",
    93  		SupportedServerVersionsHeaderName: "<21.04.16",
    94  		ClientNameHeaderName:              "28.08.14",
    95  		SupportedFeaturesHeaderName:       "my-feature",
    96  	}))
    97  
    98  	ctx = metadata.NewOutgoingContext(ctx, metadata.MD{})
    99  
   100  	ctx = Propagate(ctx)
   101  
   102  	md, ok := metadata.FromOutgoingContext(ctx)
   103  	s.True(ok)
   104  
   105  	s.Equal("22.08.78", md.Get(ClientVersionHeaderName)[0])
   106  	s.Equal("<21.04.16", md.Get(SupportedServerVersionsHeaderName)[0])
   107  	s.Equal("28.08.14", md.Get(ClientNameHeaderName)[0])
   108  	s.Equal("my-feature", md.Get(SupportedFeaturesHeaderName)[0])
   109  }
   110  
   111  func (s *HeadersSuite) TestPropagate_UpdateExistingNonEmptyOutgoingContext() {
   112  	ctx := context.Background()
   113  	ctx = metadata.NewIncomingContext(ctx, metadata.New(map[string]string{
   114  		ClientVersionHeaderName:           "07.08.78",   // Must be ignored
   115  		SupportedServerVersionsHeaderName: "<07.04.16",  // Must be ignored
   116  		SupportedFeaturesHeaderName:       "my-feature", // Passed through
   117  	}))
   118  
   119  	ctx = metadata.NewOutgoingContext(ctx, metadata.New(map[string]string{
   120  		ClientVersionHeaderName:           "22.08.78",
   121  		SupportedServerVersionsHeaderName: "<21.04.16",
   122  		ClientNameHeaderName:              "28.08.14",
   123  	}))
   124  
   125  	ctx = Propagate(ctx)
   126  
   127  	md, ok := metadata.FromOutgoingContext(ctx)
   128  	s.True(ok)
   129  
   130  	s.Equal("22.08.78", md.Get(ClientVersionHeaderName)[0])
   131  	s.Equal("<21.04.16", md.Get(SupportedServerVersionsHeaderName)[0])
   132  	s.Equal("28.08.14", md.Get(ClientNameHeaderName)[0])
   133  	s.Equal("my-feature", md.Get(SupportedFeaturesHeaderName)[0])
   134  }
   135  
   136  func (s *HeadersSuite) TestPropagate_EmptyIncomingContext() {
   137  	ctx := context.Background()
   138  
   139  	ctx = metadata.NewOutgoingContext(ctx, metadata.New(map[string]string{
   140  		ClientVersionHeaderName:           "22.08.78",
   141  		SupportedServerVersionsHeaderName: "<21.04.16",
   142  		ClientNameHeaderName:              "28.08.14",
   143  	}))
   144  
   145  	ctx = Propagate(ctx)
   146  
   147  	md, ok := metadata.FromOutgoingContext(ctx)
   148  	s.True(ok)
   149  
   150  	s.Equal("22.08.78", md.Get(ClientVersionHeaderName)[0])
   151  	s.Equal("<21.04.16", md.Get(SupportedServerVersionsHeaderName)[0])
   152  	s.Equal("28.08.14", md.Get(ClientNameHeaderName)[0])
   153  }