config_test.go

//
// Copyright (c) 2018-2019 Intel Corporation
//
// SPDX-License-Identifier: Apache-2.0
//

package main

import (
	"io/ioutil"
	"os"
	"reflect"
	"testing"
	"time"

	"github.com/sirupsen/logrus"
	"github.com/stretchr/testify/assert"
)

func TestNewConfig(t *testing.T) {
	assert := assert.New(t)

	testLogLevel := logrus.DebugLevel

	expectedConfig := agentConfig{
		logLevel: testLogLevel,
	}

	config := newConfig(testLogLevel)

	assert.True(reflect.DeepEqual(config, expectedConfig),
		"Config structures should be identical: got %+v, expecting %+v",
		config, expectedConfig)
}

func TestParseCmdlineOptionEmptyOption(t *testing.T) {
	assert := assert.New(t)

	a := &agentConfig{}

	err := a.parseCmdlineOption("")
	assert.NoError(err, "%v", err)
}

func TestParseCmdlineOptionWrongOptionValue(t *testing.T) {
	assert := assert.New(t)

	a := &agentConfig{}

	wrongOption := logLevelFlag + "=debgu"

	err := a.parseCmdlineOption(wrongOption)
	assert.Errorf(err, "Parsing should fail because wrong option %q", wrongOption)
}

func TestParseCmdlineOptionWrongOptionParam(t *testing.T) {
	assert := assert.New(t)

	a := &agentConfig{}

	wrongOption := "agent.lgo=debug"

	err := a.parseCmdlineOption(wrongOption)
	assert.Errorf(err, "Parsing should fail because wrong option %q", wrongOption)
}

func TestParseCmdlineOptionCorrectOptions(t *testing.T) {
	assert := assert.New(t)

	a := &agentConfig{}

	logFlagList := []string{"debug", "info", "warn", "error", "fatal", "panic"}

	for _, logFlag := range logFlagList {
		debug = false
		option := logLevelFlag + "=" + logFlag

		err := a.parseCmdlineOption(option)
		assert.NoError(err, "%v", err)

		if logFlag == "debug" {
			assert.True(debug)
		}
	}
}

func TestParseCmdlineOptionIncorrectOptions(t *testing.T) {
	assert := assert.New(t)

	a := &agentConfig{}

	logFlagList := []string{"debg", "ifo", "wan", "eror", "ftal", "pnic"}

	for _, logFlag := range logFlagList {
		option := logLevelFlag + "=" + logFlag

		err := a.parseCmdlineOption(option)
		assert.Errorf(err, "Should fail because of incorrect option %q", logFlag)
	}
}

func TestParseCmdlineOptionDevMode(t *testing.T) {
	assert := assert.New(t)

	a := &agentConfig{}

	type testData struct {
		option               string
		expectDevModeEnabled bool
	}

	data := []testData{
		{"agent.Devmode", false},
		{"agent.DevMode", false},
		{"devmode", false},
		{"DevMode", false},
		{"agent.devmodel", false},
		{"agent.devmode.", false},
		{"agent.devmode-", false},
		{"agent.devmode:", false},

		{"agent.devmode", true},
	}

	for i, d := range data {
		debug = false
		crashOnError = false

		err := a.parseCmdlineOption(d.option)
		assert.NoError(err)

		if !d.expectDevModeEnabled {
			continue
		}

		assert.True(debug, "test %d (%+v)", i, d)
		assert.True(crashOnError, "test %d (%+v)", i, d)
	}
}

func TestGetConfigEmptyFileName(t *testing.T) {
	assert := assert.New(t)

	a := &agentConfig{}

	err := a.getConfig("")
	assert.Error(err, "Should fail because command line path is empty")
}

func TestGetConfigFilePathNotExist(t *testing.T) {
	assert := assert.New(t)

	a := &agentConfig{}

	tmpFile, err := ioutil.TempFile("", "test")
	assert.NoError(err, "%v", err)

	fileName := tmpFile.Name()
	tmpFile.Close()
	err = os.Remove(fileName)
	assert.NoError(err, "%v", err)

	err = a.getConfig(fileName)
	assert.Error(err, "Should fail because command line path does not exist")
}

func TestGetConfig(t *testing.T) {
	assert := assert.New(t)

	a := &agentConfig{}

	tmpFile, err := ioutil.TempFile("", "test")
	assert.NoError(err, "%v", err)
	fileName := tmpFile.Name()

	tmpFile.Write([]byte(logLevelFlag + "=info"))
	tmpFile.Close()

	defer os.Remove(fileName)

	err = a.getConfig(fileName)
	assert.NoError(err, "%v", err)

	assert.True(a.logLevel == logrus.InfoLevel,
		"Log levels should be identical: got %+v, expecting %+v",
		a.logLevel, logrus.InfoLevel)
}

func TestParseCmdlineOptionTracing(t *testing.T) {
	assert := assert.New(t)

	type testData struct {
		option              string
		expectTraceEnabled  bool
		expectCollatedTrace bool
	}

	data := []testData{
		{"", false, false},
		{"moo", false, false},
		{"." + traceModeFlag, false, false},
		{traceModeFlag + ".", false, false},
		{"x" + traceModeFlag, false, false},
		{traceModeFlag + "x", false, false},
		{"x" + traceModeFlag + "x", false, false},
		{"=" + traceModeFlag, false, false},
		{traceModeFlag + "=", false, false},

		{traceModeFlag, true, false},
		{traceModeFlag + "=" + traceTypeIsolated, true, false},
		{traceModeFlag + "=" + traceTypeCollated, true, true},

		{traceModeFlag + "=" + traceTypeIsolated + "x", false, false},
		{traceModeFlag + "=" + traceTypeCollated + "x", false, false},
	}

	for i, d := range data {
		// force reset
		tracing = false
		collatedTrace = false
		debug = false

		a := &agentConfig{}

		tmpFile, err := ioutil.TempFile("", "")
		assert.NoError(err)

		fileName := tmpFile.Name()
		defer os.Remove(fileName)

		tmpFile.Write([]byte(d.option))
		tmpFile.Close()

		assert.False(tracing)
		assert.False(collatedTrace)
		assert.False(debug)

		err = a.getConfig(fileName)
		assert.NoError(err)

		if d.expectTraceEnabled {
			assert.Truef(tracing, "test %d (%+v)", i, d)
		} else {
			assert.Falsef(tracing, "test %d (%+v)", i, d)
		}

		if d.expectCollatedTrace {
			assert.Truef(collatedTrace, "test %d (%+v)", i, d)
		} else {
			assert.Falsef(collatedTrace, "test %d (%+v)", i, d)
		}

		if d.expectTraceEnabled || d.expectCollatedTrace {
			assert.True(debug, "test %d (%+v)", i, d)
		}
	}
}

func TestEnableTracing(t *testing.T) {
	assert := assert.New(t)

	type testData struct {
		traceMode           string
		traceType           string
		expectCollatedTrace bool
	}

	data := []testData{
		{traceModeStatic, traceTypeIsolated, false},
		{traceModeStatic, traceTypeCollated, true},

		{traceModeDynamic, traceTypeIsolated, false},
		{traceModeDynamic, traceTypeCollated, true},
	}

	for i, d := range data {
		// force reset
		tracing = false
		collatedTrace = false
		debug = false

		enableTracing(d.traceMode, d.traceType)

		assert.True(debug, "test %d (%+v)", i, d)
		assert.True(tracing, "test %d (%+v)", i, d)

		if d.expectCollatedTrace {
			assert.True(collatedTrace, "test %d (%+v)", i, d)
		} else {
			assert.False(collatedTrace, "test %d (%+v)", i, d)
		}
	}
}

func TestParseCmdlineOptionWrongOptionVsock(t *testing.T) {
	t.Skip()
	assert := assert.New(t)

	a := &agentConfig{}

	wrongOption := "use_vsockkk=true"

	err := a.parseCmdlineOption(wrongOption)
	assert.Errorf(err, "Parsing should fail because wrong option %q", wrongOption)
}

func TestParseCmdlineOptionsVsock(t *testing.T) {
	assert := assert.New(t)

	a := &agentConfig{}

	type testData struct {
		val            string
		shouldErr      bool
		expectedCommCh commType
	}

	data := []testData{
		{"true", false, vsockCh},
		{"false", false, serialCh},
		{"blah", true, unknownCh},
	}

	for _, d := range data {
		commCh = unknownCh
		option := useVsockFlag + "=" + d.val

		err := a.parseCmdlineOption(option)
		if d.shouldErr {
			assert.Error(err)
		} else {
			assert.NoError(err)
		}
		assert.Equal(commCh, d.expectedCommCh)
	}
}

func TestParseCmdlineOptionDebugConsole(t *testing.T) {
	assert := assert.New(t)

	a := &agentConfig{}

	type testData struct {
		option                    string
		expectDebugConsoleEnabled bool
	}

	data := []testData{
		{"", false},
		{"debug_console", false},
		{"debug_console=true", false},
		{"debug_console=1", false},

		{"agent.debug_console", true},
	}

	for i, d := range data {
		debugConsole = false

		err := a.parseCmdlineOption(d.option)
		assert.NoError(err)

		if !d.expectDebugConsoleEnabled {
			continue
		}

		assert.True(debugConsole, "test %d (%+v)", i, d)
	}
}

func TestParseCmdlineOptionDebugConsoleVPort(t *testing.T) {
	assert := assert.New(t)

	a := &agentConfig{}

	type testData struct {
		option                    string
		expectDebugConsoleEnabled bool
		expectedError             bool
		expectedVPort             uint32
	}

	data := []testData{
		{"", false, false, 0},
		{"debug_console_vport", false, false, 0},
		{"debug_console_vport=xxx", false, false, 0},
		{"debug_console_vport=1026", false, false, 0},
		{debugConsoleVPortFlag + "=", false, true, 0},
		{debugConsoleVPortFlag + "=xxxx", false, true, 0},
		{debugConsoleVPortFlag, false, false, 0},
		{debugConsoleVPortFlag + "=1026", false, false, 1026},
	}

	for i, d := range data {
		debugConsole = false
		debugConsoleVSockPort = 0

		err := a.parseCmdlineOption(d.option)
		if d.expectedError {
			assert.Error(err)
		} else {
			assert.NoError(err)
		}

		if d.expectDebugConsoleEnabled {
			assert.True(debugConsole, "test %d (%+v)", i, d)
		}

		assert.Equal(debugConsoleVSockPort, d.expectedVPort)
	}
}

func TestParseCmdlineOptionHotplugTimeout(t *testing.T) {
	assert := assert.New(t)

	a := &agentConfig{}

	type testData struct {
		option                 string
		shouldErr              bool
		expectedHotplugTimeout time.Duration
	}

	data := []testData{
		{"", false, 3 * time.Second},
		{"hotpug_timout", false, 3 * time.Second},
		{"hotplug_timeout", false, 3 * time.Second},
		{"hotplug_timeout=1h", false, 3 * time.Second},
		{"agnt.hotplug_timeout=1h", false, 3 * time.Second},
		{"agent.hotplug_timeout=3h", false, 3 * time.Hour},
		{"agent.hotplug_timeout=1s", false, 1 * time.Second},
		{"agent.hotplug_timeout=0s", false, 3 * time.Second},
		{"agent.hotplug_timeout=0", false, 3 * time.Second},
		{"agent.hotplug_timeout=100ms", false, 100 * time.Millisecond},
		{"agent.hotplug_timeout=-1", true, 3 * time.Second},
		{"agent.hotplug_timeout=foobar", true, 3 * time.Second},
		{"agent.hotplug_timeout=5.0", true, 3 * time.Second},
	}

	for i, d := range data {
		// reset the hotplug timeout
		hotplugTimeout = 3 * time.Second

		err := a.parseCmdlineOption(d.option)
		if d.shouldErr {
			assert.Error(err)
		} else {
			assert.NoError(err)
		}

		assert.Equal(d.expectedHotplugTimeout, hotplugTimeout, "test %d (%+v)", i, d)
	}
}