pkg/metrics/config_test.go

/*
Copyright 2018 The Knative Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package metrics

import (
	"reflect"
	"testing"

	. "github.com/knative/pkg/logging/testing"
	corev1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

const (
	servingDomain = "serving.knative.dev"
	badDomain     = "test.domain"
	testComponent = "testComponent"
	testProj      = "test-project"
	anotherProj   = "another-project"
)

var (
	errorTests = []struct {
		name        string
		cm          map[string]string
		domain      string
		component   string
		expectedErr string
	}{{
		name:        "backendKeyMissing",
		cm:          map[string]string{"": ""},
		domain:      servingDomain,
		component:   testComponent,
		expectedErr: "metrics.backend-destination key is missing",
	}, {
		name:        "stackdriverProjectIDMissing",
		cm:          map[string]string{"metrics.backend-destination": "stackdriver"},
		domain:      servingDomain,
		component:   testComponent,
		expectedErr: "For backend stackdriver, metrics.stackdriver-project-id field must exist and cannot be empty",
	}, {
		name: "stackdriverProjectIDEmpty",
		cm: map[string]string{
			"metrics.backend-destination":    "stackdriver",
			"metrics.stackdriver-project-id": "",
		},
		domain:      servingDomain,
		component:   testComponent,
		expectedErr: "For backend stackdriver, metrics.stackdriver-project-id field must exist and cannot be empty",
	}, {
		name: "unsupportedBackend",
		cm: map[string]string{
			"metrics.backend-destination":    "unsupported",
			"metrics.stackdriver-project-id": testProj,
		},
		domain:      servingDomain,
		component:   testComponent,
		expectedErr: "Unsupported metrics backend value \"unsupported\"",
	}, {
		name: "emptyDomain",
		cm: map[string]string{
			"metrics.backend-destination": "prometheus",
		},
		domain:      "",
		component:   testComponent,
		expectedErr: "Metrics domain cannot be empty",
	}, {
		name: "invalidComponent",
		cm: map[string]string{
			"metrics.backend-destination": "prometheus",
		},
		domain:      servingDomain,
		component:   "",
		expectedErr: "Metrics component name cannot be empty",
	}}
	successTests = []struct {
		name           string
		cm             map[string]string
		domain         string
		component      string
		expectedConfig metricsConfig
	}{{
		name:      "validPrometheus",
		cm:        map[string]string{"metrics.backend-destination": "prometheus"},
		domain:    servingDomain,
		component: testComponent,
		expectedConfig: metricsConfig{
			domain:             servingDomain,
			component:          testComponent,
			backendDestination: Prometheus},
	}, {
		name: "validStackdriver",
		cm: map[string]string{"metrics.backend-destination": "stackdriver",
			"metrics.stackdriver-project-id": anotherProj},
		domain:    servingDomain,
		component: testComponent,
		expectedConfig: metricsConfig{
			domain:               servingDomain,
			component:            testComponent,
			backendDestination:   Stackdriver,
			stackdriverProjectID: anotherProj},
	}, {
		name: "validCapitalStackdriver",
		cm: map[string]string{"metrics.backend-destination": "Stackdriver",
			"metrics.stackdriver-project-id": testProj},
		domain:    servingDomain,
		component: testComponent,
		expectedConfig: metricsConfig{
			domain:               servingDomain,
			component:            testComponent,
			backendDestination:   Stackdriver,
			stackdriverProjectID: testProj},
	}}
)

func TestGetMetricsConfig(t *testing.T) {
	for _, test := range errorTests {
		_, err := getMetricsConfig(test.cm, test.domain, test.component, TestLogger(t))
		if err.Error() != test.expectedErr {
			t.Errorf("In test %v, wanted err: %v, got: %v", test.name, test.expectedErr, err)
		}
	}

	for _, test := range successTests {
		mc, err := getMetricsConfig(test.cm, test.domain, test.component, TestLogger(t))
		if err != nil {
			t.Errorf("In test %v, wanted valid config %v, got error %v", test.name, test.expectedConfig, err)
		}
		if !reflect.DeepEqual(*mc, test.expectedConfig) {
			t.Errorf("In test %v, wanted config %v, got config %v", test.name, test.expectedConfig, *mc)
		}
	}
}

func TestIsMetricsConfigChanged(t *testing.T) {
	setCurMetricsExporterAndConfig(nil, nil)
	for _, test := range successTests {
		mc, err := getMetricsConfig(test.cm, test.domain, test.component, TestLogger(t))
		if err != nil {
			t.Errorf("In test %v, wanted valid config %v, got error %v", test.name, test.expectedConfig, err)
		}
		changed := isMetricsConfigChanged(mc)
		if !changed {
			t.Errorf("In test %v, isMetricsConfigChanged should be true", test.name)
		}
		setCurMetricsExporterAndConfig(nil, mc)
	}

	setCurMetricsExporterAndConfig(nil, &metricsConfig{
		domain:             servingDomain,
		component:          testComponent,
		backendDestination: Prometheus})
	newConfig := &metricsConfig{
		domain:               servingDomain,
		component:            testComponent,
		backendDestination:   Prometheus,
		stackdriverProjectID: testProj,
	}
	changed := isMetricsConfigChanged(newConfig)
	if changed {
		t.Error("isMetricsConfigChanged should be false if stackdriver project ID changes for prometheus backend")
	}
}

func TestUpdateExporterFromConfigMap(t *testing.T) {
	setCurMetricsExporterAndConfig(nil, nil)
	cm := &corev1.ConfigMap{
		ObjectMeta: metav1.ObjectMeta{
			Name: "config-observability",
		},
		Data: map[string]string{},
	}
	oldConfig := getCurMetricsConfig()
	for _, test := range successTests {
		cm.Data = test.cm
		u := UpdateExporterFromConfigMap(test.domain, test.component, TestLogger(t))
		u(cm)
		mConfig := getCurMetricsConfig()
		if mConfig == oldConfig {
			t.Errorf("In test %v, expected metrics config change", test.name)
		}
		if !reflect.DeepEqual(*mConfig, test.expectedConfig) {
			t.Errorf("In test %v, expected config: %v; got config %v", test.name, test.expectedConfig, mConfig)
		}
		oldConfig = mConfig
	}

	for _, test := range errorTests {
		cm.Data = test.cm
		u := UpdateExporterFromConfigMap(test.domain, test.component, TestLogger(t))
		u(cm)
		mConfig := getCurMetricsConfig()
		if mConfig != oldConfig {
			t.Errorf("In test %v, mConfig should not change", test.name)
		}
	}
}