channel_test.go

// Copyright (c) 2015 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 tchannel

import (
	"io/ioutil"
	"math"
	"os"
	"runtime"
	"strings"
	"testing"
	"time"

	"github.com/opentracing/opentracing-go"
	"github.com/opentracing/opentracing-go/mocktracer"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

func toMap(fields LogFields) map[string]interface{} {
	m := make(map[string]interface{})
	for _, f := range fields {
		m[f.Key] = f.Value
	}
	return m
}

func TestNewChannel(t *testing.T) {
	ch, err := NewChannel("svc", &ChannelOptions{
		ProcessName: "pname",
	})
	require.NoError(t, err, "NewChannel failed")

	assert.Equal(t, LocalPeerInfo{
		ServiceName: "svc",
		PeerInfo: PeerInfo{
			ProcessName: "pname",
			HostPort:    ephemeralHostPort,
			IsEphemeral: true,
			Version: PeerVersion{
				Language:        "go",
				LanguageVersion: strings.TrimPrefix(runtime.Version(), "go"),
				TChannelVersion: VersionInfo,
			},
		},
	}, ch.PeerInfo(), "Wrong local peer info")
}

func TestLoggers(t *testing.T) {
	ch, err := NewChannel("svc", &ChannelOptions{
		Logger: NewLogger(ioutil.Discard),
	})
	require.NoError(t, err, "NewChannel failed")
	defer ch.Close()

	peerInfo := ch.PeerInfo()
	fields := toMap(ch.Logger().Fields())
	assert.Equal(t, peerInfo.ServiceName, fields["serviceName"])

	sc := ch.GetSubChannel("subch")
	fields = toMap(sc.Logger().Fields())
	assert.Equal(t, peerInfo.ServiceName, fields["serviceName"])
	assert.Equal(t, "subch", fields["subchannel"])
}

func TestStats(t *testing.T) {
	ch, err := NewChannel("svc", &ChannelOptions{
		Logger: NewLogger(ioutil.Discard),
	})
	require.NoError(t, err, "NewChannel failed")
	defer ch.Close()

	hostname, err := os.Hostname()
	require.NoError(t, err, "Hostname failed")

	peerInfo := ch.PeerInfo()
	tags := ch.StatsTags()
	assert.NotNil(t, ch.StatsReporter(), "StatsReporter missing")
	assert.Equal(t, peerInfo.ProcessName, tags["app"], "app tag")
	assert.Equal(t, peerInfo.ServiceName, tags["service"], "service tag")
	assert.Equal(t, hostname, tags["host"], "hostname tag")

	sc := ch.GetSubChannel("subch")
	subTags := sc.StatsTags()
	assert.NotNil(t, sc.StatsReporter(), "StatsReporter missing")
	for k, v := range tags {
		assert.Equal(t, v, subTags[k], "subchannel missing tag %v", k)
	}
	assert.Equal(t, "subch", subTags["subchannel"], "subchannel tag missing")
}

func TestRelayMaxTTL(t *testing.T) {
	tests := []struct {
		max      time.Duration
		expected time.Duration
	}{
		{time.Second, time.Second},
		{-time.Second, _defaultRelayMaxTimeout},
		{0, _defaultRelayMaxTimeout},
		{time.Microsecond, _defaultRelayMaxTimeout},
		{math.MaxUint32 * time.Millisecond, math.MaxUint32 * time.Millisecond},
		{(math.MaxUint32 + 1) * time.Millisecond, _defaultRelayMaxTimeout},
	}

	for _, tt := range tests {
		ch, err := NewChannel("svc", &ChannelOptions{
			RelayMaxTimeout: tt.max,
		})
		assert.NoError(t, err, "Unexpected error when creating channel.")
		assert.Equal(t, ch.relayMaxTimeout, tt.expected, "Unexpected max timeout on channel.")
	}
}

func TestIsolatedSubChannelsDontSharePeers(t *testing.T) {
	ch, err := NewChannel("svc", &ChannelOptions{
		Logger: NewLogger(ioutil.Discard),
	})
	require.NoError(t, err, "NewChannel failed")
	defer ch.Close()

	sub := ch.GetSubChannel("svc-ringpop")
	if ch.peers != sub.peers {
		t.Log("Channel and subchannel don't share the same peer list.")
		t.Fail()
	}

	isolatedSub := ch.GetSubChannel("svc-shy-ringpop", Isolated)
	if ch.peers == isolatedSub.peers {
		t.Log("Channel and isolated subchannel share the same peer list.")
		t.Fail()
	}

	// Nobody knows about the peer.
	assert.Nil(t, ch.peers.peersByHostPort["127.0.0.1:3000"])
	assert.Nil(t, sub.peers.peersByHostPort["127.0.0.1:3000"])
	assert.Nil(t, isolatedSub.peers.peersByHostPort["127.0.0.1:3000"])

	// Uses of the parent channel should be reflected in the subchannel, but
	// not the isolated subchannel.
	ch.Peers().Add("127.0.0.1:3000")
	assert.NotNil(t, ch.peers.peersByHostPort["127.0.0.1:3000"])
	assert.NotNil(t, sub.peers.peersByHostPort["127.0.0.1:3000"])
	assert.Nil(t, isolatedSub.peers.peersByHostPort["127.0.0.1:3000"])
}

func TestChannelTracerMethod(t *testing.T) {
	mockTracer := mocktracer.New()
	ch, err := NewChannel("svc", &ChannelOptions{
		Tracer: mockTracer,
	})
	require.NoError(t, err)
	defer ch.Close()
	assert.Equal(t, mockTracer, ch.Tracer(), "expecting tracer passed at initialization")

	ch, err = NewChannel("svc", &ChannelOptions{})
	require.NoError(t, err)
	defer ch.Close()
	assert.EqualValues(t, opentracing.GlobalTracer(), ch.Tracer(), "expecting default tracer")

	// because ch.Tracer() function is doing dynamic lookup, we can change global tracer
	origTracer := opentracing.GlobalTracer()
	defer opentracing.InitGlobalTracer(origTracer)

	opentracing.InitGlobalTracer(mockTracer)
	assert.Equal(t, mockTracer, ch.Tracer(), "expecting tracer set as global tracer")
}

func TestToServiceMethodSet(t *testing.T) {
	tests := []struct {
		desc    string
		sms     []string
		want    map[string]struct{}
		wantErr string
	}{
		{
			desc: "single service, single method",
			sms:  []string{"service::Method"},
			want: map[string]struct{}{
				"service::Method": struct{}{},
			},
		},
		{
			desc: "single service, multiple methods",
			sms:  []string{"service::Method1", "service::Method2", "service::Method3"},
			want: map[string]struct{}{
				"service::Method1": struct{}{},
				"service::Method2": struct{}{},
				"service::Method3": struct{}{},
			},
		},
		{
			desc:    "invalid input",
			sms:     []string{"notDelimitedByDoubleColons"},
			wantErr: `each "SkipHandlerMethods" value should be of service::Method format but got "notDelimitedByDoubleColons"`,
		},
	}

	for _, tt := range tests {
		t.Run(tt.desc, func(t *testing.T) {
			r, err := toServiceMethodSet(tt.sms)
			if tt.wantErr != "" {
				assert.EqualError(t, err, tt.wantErr)
				return
			}
			assert.Equal(t, tt.want, r)
		})
	}
}