telegraf/plugins/inputs/win_wmi/win_wmi_test.go

//go:build windows

package win_wmi

import (
	"fmt"
	"os"
	"regexp"
	"testing"
	"time"

	"github.com/stretchr/testify/require"

	"github.com/influxdata/telegraf"
	"github.com/influxdata/telegraf/metric"
	"github.com/influxdata/telegraf/testutil"
)

var sysDrive = os.Getenv("SystemDrive") + `\` // C:\

func TestBuildWqlStatements(t *testing.T) {
	plugin := &Wmi{
		Queries: []query{
			{
				Namespace:  "ROOT\\cimv2",
				ClassName:  "Win32_Volume",
				Properties: []string{"Name", "FreeSpace", "Purpose"},
				//nolint:gocritic // sprintfQuotedString - "%s" used by purpose, string escaping is done by special function
				Filter:               fmt.Sprintf(`NOT Name LIKE "\\\\?\\%%" AND Name LIKE "%s"`, regexp.QuoteMeta(sysDrive)),
				TagPropertiesInclude: []string{"Name"},
			},
		},
		Log: testutil.Logger{},
	}
	require.NoError(t, plugin.Init())
	require.NotEmpty(t, plugin.Queries)

	//nolint:gocritic // sprintfQuotedString - "%s" used by purpose, string escaping is done by special function
	expected := fmt.Sprintf(
		`SELECT Name, FreeSpace, Purpose FROM Win32_Volume WHERE NOT Name LIKE "\\\\?\\%%" AND Name LIKE "%s"`,
		regexp.QuoteMeta(sysDrive),
	)
	require.Equal(t, expected, plugin.Queries[0].query)
}

func TestInit(t *testing.T) {
	plugin := &Wmi{}
	require.NoError(t, plugin.Init())
}

func TestQueryIntegration(t *testing.T) {
	if testing.Short() {
		t.Skip("Skipping integration test in short mode")
	}

	plugin := &Wmi{
		Queries: []query{
			{
				Namespace:  "ROOT\\cimv2",
				ClassName:  "Win32_Volume",
				Properties: []string{"Name", "FreeSpace", "Purpose"},
				//nolint:gocritic // sprintfQuotedString - "%s" used by purpose, string escaping is done by special function
				Filter:               fmt.Sprintf(`NOT Name LIKE "\\\\?\\%%" AND Name LIKE "%s"`, regexp.QuoteMeta(sysDrive)),
				TagPropertiesInclude: []string{"Name"},
			},
		},
		Log: testutil.Logger{},
	}
	require.NoError(t, plugin.Init())

	var acc testutil.Accumulator
	require.NoError(t, plugin.Gather(&acc))
	require.Empty(t, acc.Errors)
	// Only one metric was returned (because we filtered for SystemDrive)
	require.Len(t, acc.Metrics, 1)
	// Name property collected and is the SystemDrive
	require.Equal(t, sysDrive, acc.Metrics[0].Tags["Name"])
	// FreeSpace property was collected as a field
	require.NotEmpty(t, acc.Metrics[0].Fields["FreeSpace"])
}

func TestMethodIntegration(t *testing.T) {
	if testing.Short() {
		t.Skip("Skipping integration test in short mode")
	}

	plugin := &Wmi{
		Methods: []method{
			{
				Namespace: "ROOT\\default",
				ClassName: "StdRegProv",
				Method:    "GetStringValue",
				Arguments: map[string]interface{}{
					"hDefKey":     `2147483650`,
					"sSubKeyName": `software\microsoft\windows nt\currentversion`,
					"sValueName":  `ProductName`,
				},
				TagPropertiesInclude: []string{"ReturnValue"},
			},
		},
		Log: testutil.Logger{},
	}
	require.NoError(t, plugin.Init())

	expected := []telegraf.Metric{
		metric.New(
			"StdRegProv",
			map[string]string{"ReturnValue": "0"},
			map[string]interface{}{"sValue": "Windows ..."},
			time.Unix(0, 0),
		),
	}

	var acc testutil.Accumulator
	require.NoError(t, plugin.Gather(&acc))
	require.Empty(t, acc.Errors)
	actual := acc.GetTelegrafMetrics()
	testutil.RequireMetricsStructureEqual(t, expected, actual, testutil.IgnoreTime())
}