telegraf/plugins/inputs/huebridge/huebridge_test.go

package huebridge

import (
	"fmt"
	"path/filepath"
	"testing"
	"time"

	"github.com/stretchr/testify/require"
	"github.com/tdrn-org/go-hue/mock"

	"github.com/influxdata/telegraf"
	"github.com/influxdata/telegraf/config"
	"github.com/influxdata/telegraf/plugins/common/tls"
	"github.com/influxdata/telegraf/plugins/parsers/influx"
	"github.com/influxdata/telegraf/testutil"
)

func TestConfig(t *testing.T) {
	// Verify plugin can be loaded from config
	conf := config.NewConfig()
	require.NoError(t, conf.LoadConfig("testdata/conf/huebridge.conf"))
	require.Len(t, conf.Inputs, 1)
	h, ok := conf.Inputs[0].Input.(*HueBridge)
	require.True(t, ok)

	// Verify successful Init
	require.NoError(t, h.Init())

	// Verify everything is setup according to config file
	require.Len(t, h.BridgeUrls, 4)
	require.Equal(t, "client", h.RemoteClientID)
	require.Equal(t, "secret", h.RemoteClientSecret)
	require.Equal(t, "url", h.RemoteCallbackURL)
	require.Equal(t, "dir", h.RemoteTokenDir)
	require.Len(t, h.RoomAssignments, 2)
	require.Equal(t, config.Duration(60*time.Second), h.Timeout)
	require.Equal(t, "secret", h.TLSKeyPwd)
	require.True(t, h.InsecureSkipVerify)
}

func TestInitSuccess(t *testing.T) {
	// Create plugin instance with all types of URL schemes
	h := &HueBridge{
		BridgeUrls: []string{
			"address://12345678:secret@localhost/",
			"cloud://12345678:secret@localhost/discovery/",
			"mdns://12345678:secret@/",
			"remote://12345678:secret@localhost/",
		},
		remoteClientConfig: remoteClientConfig{
			RemoteClientID:     mock.MockClientId,
			RemoteClientSecret: mock.MockClientSecret,
			RemoteTokenDir:     ".",
		},
		ClientConfig: tls.ClientConfig{
			InsecureSkipVerify: true,
		},
		Timeout: config.Duration(10 * time.Second),
		Log:     &testutil.Logger{Name: "huebridge"},
	}

	// Verify successful Init
	require.NoError(t, h.Init())

	// Verify successful configuration of all bridge URLs
	require.Len(t, h.bridges, len(h.BridgeUrls))
}

func TestInitIgnoreInvalidUrls(t *testing.T) {
	tests := []struct {
		addr     string
		expected string
	}{
		{
			addr:     "invalid://12345678:secret@invalid-scheme.net/",
			expected: "unrecognized scheme",
		},
		{
			addr:     "address://12345678@missing-password.net/",
			expected: "missing password in URL",
		},
		{
			addr:     "cloud://12345678@missing-password.net/",
			expected: "missing password in URL",
		},
		{
			addr:     "mdns://12345678@missing-password.net/",
			expected: "missing password in URL",
		},
		{
			addr:     "remote://12345678@missing-password.net/",
			expected: "missing remote application credentials and/or token director not configured",
		},
		{
			addr:     "remote://12345678:secret@missing-remote-config.net/",
			expected: "missing remote application credentials and/or token director not configured",
		},
	}

	for _, tt := range tests {
		t.Run(tt.addr, func(t *testing.T) {
			// The following URLs are all invalid must all be ignored during Init
			plugin := &HueBridge{
				BridgeUrls: []string{tt.addr},
				Timeout:    config.Duration(10 * time.Second),
				Log:        &testutil.Logger{Name: "huebridge"},
			}

			// Verify successful Init
			require.ErrorContains(t, plugin.Init(), tt.expected)

			// Verify no bridge have been configured
			require.Empty(t, plugin.bridges)
		})
	}
}

func TestGatherLocal(t *testing.T) {
	// Load the expected metrics
	parser := &influx.Parser{}
	require.NoError(t, parser.Init())
	fn := filepath.Join("testdata", "metrics", "huebridge.txt")
	expected, err := testutil.ParseMetricsFromFile(fn, parser)
	require.NoError(t, err)
	for i := range expected {
		expected[i].SetType(telegraf.Gauge)
	}

	// Start mock server and make plugin targing it
	bridgeMock := mock.Start()
	require.NotNil(t, bridgeMock)
	defer bridgeMock.Shutdown()

	// Setup the plugin
	h := &HueBridge{
		BridgeUrls: []string{
			fmt.Sprintf("address://%s:%s@%s/", mock.MockBridgeId, mock.MockBridgeUsername, bridgeMock.Server().Host),
		},
		RoomAssignments: map[string]string{"Name#7": "Name#15"},
		Timeout:         config.Duration(10 * time.Second),
		Log:             &testutil.Logger{Name: "huebridge"},
	}
	require.NoError(t, h.Init())

	// Verify successfull collection
	var acc testutil.Accumulator
	require.NoError(t, acc.GatherError(h.Gather))
	testutil.RequireMetricsEqual(t, expected, acc.GetTelegrafMetrics(), testutil.IgnoreTime(), testutil.SortMetrics())
}