storj/pkg/telemetry/client_test.go

// Copyright (C) 2019 Storj Labs, Inc.
// See LICENSE for copying information.
package telemetry

import (
	"context"
	"os"
	"testing"
	"time"

	"github.com/spacemonkeygo/monkit/v3"
	"github.com/stretchr/testify/assert"
	"github.com/zeebo/admission/v2/admmonkit"
	"go.uber.org/zap/zaptest"
)

func TestNewClient_IntervalIsZero(t *testing.T) {
	s, err := Listen("127.0.0.1:0")
	assert.NoError(t, err)
	defer func() { assert.NoError(t, s.Close()) }()

	client, err := NewClient(zaptest.NewLogger(t), s.Addr(), ClientOpts{
		Application: "testapp",
		Instance:    "testinst",
		Interval:    0,
	})

	assert.NotNil(t, client)
	assert.NoError(t, err)
	assert.Equal(t, client.interval, DefaultInterval)
}

func TestNewClient_ApplicationAndArgsAreEmpty(t *testing.T) {
	s, err := Listen("127.0.0.1:0")
	assert.NoError(t, err)
	oldArgs := os.Args

	defer func() {
		assert.NoError(t, s.Close())
		os.Args = oldArgs
	}()

	os.Args = nil

	client, err := NewClient(zaptest.NewLogger(t), s.Addr(), ClientOpts{
		Application: "",
		Instance:    "testinst",
		Interval:    0,
	})

	assert.NotNil(t, client)
	assert.NoError(t, err)
	assert.Equal(t, DefaultApplication, client.opts.Application)
}

func TestNewClient_ApplicationIsEmpty(t *testing.T) {
	s, err := Listen("127.0.0.1:0")
	assert.NoError(t, err)
	defer func() { assert.NoError(t, s.Close()) }()

	client, err := NewClient(zaptest.NewLogger(t), s.Addr(), ClientOpts{
		Application: "",
		Instance:    "testinst",
		Interval:    0,
	})

	assert.NotNil(t, client)
	assert.NoError(t, err)
	assert.Equal(t, client.opts.Application, os.Args[0])
}

func TestNewClient_InstanceIsEmpty(t *testing.T) {
	s, err := Listen("127.0.0.1:0")
	assert.NoError(t, err)
	defer func() { assert.NoError(t, s.Close()) }()

	client, err := NewClient(zaptest.NewLogger(t), s.Addr(), ClientOpts{
		Application: "qwe",
		Instance:    "",
		Interval:    0,
	})

	assert.NotNil(t, client)
	assert.NoError(t, err)

	assert.Equal(t, client.opts.InstanceId, []byte(DefaultInstanceID()))
	assert.Equal(t, client.opts.Application, "qwe")
	assert.Equal(t, client.interval, DefaultInterval)
}

func TestNewClient_RegistryIsNil(t *testing.T) {
	s, err := Listen("127.0.0.1:0")
	assert.NoError(t, err)
	defer func() { assert.NoError(t, s.Close()) }()

	client, err := NewClient(zaptest.NewLogger(t), s.Addr(), ClientOpts{
		Application: "qwe",
		Instance:    "",
		Interval:    0,
	})

	assert.NotNil(t, client)
	assert.NoError(t, err)
	assert.Equal(t, client.opts.InstanceId, []byte(DefaultInstanceID()))
	assert.Equal(t, client.opts.Application, "qwe")
	assert.Equal(t, client.interval, DefaultInterval)
	assert.Equal(t, client.opts.Registry, monkit.Default)
}

func TestNewClient_PacketSizeIsZero(t *testing.T) {
	s, err := Listen("127.0.0.1:0")
	assert.NoError(t, err)
	defer func() { assert.NoError(t, s.Close()) }()

	client, err := NewClient(zaptest.NewLogger(t), s.Addr(), ClientOpts{
		Application: "qwe",
		Instance:    "",
		Interval:    0,
		PacketSize:  0,
	})

	assert.NotNil(t, client)

	assert.Equal(t, client.opts.InstanceId, []byte(DefaultInstanceID()))
	assert.NoError(t, err)
	assert.Equal(t, client.opts.Application, "qwe")
	assert.Equal(t, client.interval, DefaultInterval)
	assert.Equal(t, client.opts.Registry, monkit.Default)
	assert.Equal(t, client.opts.PacketSize, DefaultPacketSize)
}

func TestRun_ReportNoCalled(t *testing.T) {
	client, err := NewClient(zaptest.NewLogger(t), "127.0.0.1:0", ClientOpts{
		Application: "qwe",
		Instance:    "",
		Interval:    time.Millisecond,
		PacketSize:  0,
	})
	assert.NoError(t, err)

	client.send = func(context.Context, admmonkit.Options) error {
		t.Fatal("shouldn't be called")
		return nil
	}

	ctx, cancel := context.WithCancel(context.Background())
	cancel()

	client.Run(ctx)
}