prometheus/retrieval/discovery/kubernetes/discovery_test.go

// Copyright 2015 The Prometheus 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 kubernetes

import (
	"flag"
	"math/rand"
	"os"
	"testing"

	_ "github.com/prometheus/common/log"
	"github.com/prometheus/common/model"
)

func TestMain(m *testing.M) {
	flag.Parse()
	os.Exit(m.Run())
}

var portsA = []ContainerPort{
	{
		Name:          "http",
		ContainerPort: 80,
		Protocol:      "TCP",
	},
}

var portsB = []ContainerPort{
	{
		Name:          "https",
		ContainerPort: 443,
		Protocol:      "TCP",
	},
}

var portsNoTcp = []ContainerPort{
	{
		Name:          "dns",
		ContainerPort: 53,
		Protocol:      "UDP",
	},
}

var portsMultiA = []ContainerPort{
	{
		Name:          "http",
		ContainerPort: 80,
		Protocol:      "TCP",
	},
	{
		Name:          "ssh",
		ContainerPort: 22,
		Protocol:      "TCP",
	},
}

var portsMultiB = []ContainerPort{
	{
		Name:          "http",
		ContainerPort: 80,
		Protocol:      "TCP",
	},
	{
		Name:          "https",
		ContainerPort: 443,
		Protocol:      "TCP",
	},
}

func container(name string, ports []ContainerPort) Container {
	p := make([]ContainerPort, len(ports))
	copy(p, ports)

	// Shuffle order of ports to ensure code enforces determinism
	for i := range p {
		j := rand.Intn(i + 1)
		p[i], p[j] = p[j], p[i]
	}

	return Container{
		Name:  name,
		Ports: p,
	}
}

func pod(name string, containers []Container) *Pod {
	c := make([]Container, len(containers))
	copy(c, containers)

	// Shuffle order of containers to ensure code enforces determinism
	for i := range c {
		j := rand.Intn(i + 1)
		c[i], c[j] = c[j], c[i]
	}

	return &Pod{
		ObjectMeta: ObjectMeta{
			Name: name,
		},
		PodStatus: PodStatus{
			PodIP: "1.1.1.1",
			Phase: "Running",
			Conditions: []PodCondition{
				{
					Type:   "Ready",
					Status: "True",
				},
			},
			HostIP: "2.2.2.2",
		},
		PodSpec: PodSpec{
			Containers: c,
			NodeName:   "test-node",
		},
	}
}

func TestUpdatePodTargets(t *testing.T) {
	var result []model.LabelSet

	// Multiple iterations help ensure that we'll see different permutations via the various randomizations that occur
	for i := 0; i < 100; i++ {
		// Return no targets for a pod that isn't "Running"
		result = updatePodTargets(&Pod{PodStatus: PodStatus{PodIP: "1.1.1.1"}}, true)
		if len(result) > 0 {
			t.Fatalf("expected 0 targets, received %d", len(result))
		}

		// Return no targets for a pod with no IP
		result = updatePodTargets(&Pod{PodStatus: PodStatus{Phase: "Running"}}, true)
		if len(result) > 0 {
			t.Fatalf("expected 0 targets, received %d", len(result))
		}

		// A pod with no containers (?!) should not produce any targets
		result = updatePodTargets(pod("empty", []Container{}), true)
		if len(result) > 0 {
			t.Fatalf("expected 0 targets, received %d", len(result))
		}

		// Return no targets for a pod that has no HostIP
		result = updatePodTargets(&Pod{PodStatus: PodStatus{PodIP: "1.1.1.1", Phase: "Running"}}, true)
		if len(result) > 0 {
			t.Fatalf("expected 0 targets, received %d", len(result))
		}

		// A pod with all valid containers should return one target per container with allContainers=true
		result = updatePodTargets(pod("easy", []Container{container("a", portsA), container("b", portsB)}), true)
		if len(result) != 2 {
			t.Fatalf("expected 2 targets, received %d", len(result))
		}
		if result[0][podReadyLabel] != "true" {
			t.Fatalf("expected result[0] podReadyLabel 'true', received '%s'", result[0][podReadyLabel])
		}
		if _, ok := result[0][podContainerPortMapPrefix+"http"]; !ok {
			t.Fatalf("expected result[0][podContainerPortMapPrefix + 'http'] to be '80', but was missing")
		}
		if result[0][podContainerPortMapPrefix+"http"] != "80" {
			t.Fatalf("expected result[0][podContainerPortMapPrefix + 'http'] to be '80', but was %s", result[0][podContainerPortMapPrefix+"http"])
		}
		if _, ok := result[1][podContainerPortMapPrefix+"https"]; !ok {
			t.Fatalf("expected result[1][podContainerPortMapPrefix + 'https'] to be '443', but was missing")
		}
		if result[1][podContainerPortMapPrefix+"https"] != "443" {
			t.Fatalf("expected result[1][podContainerPortMapPrefix + 'https'] to be '443', but was %s", result[1][podContainerPortMapPrefix+"https"])
		}
		if result[0][podNodeNameLabel] != "test-node" {
			t.Fatalf("expected result[0] podNodeNameLabel 'test-node', received '%s'", result[0][podNodeNameLabel])
		}
		if result[0][podHostIPLabel] != "2.2.2.2" {
			t.Fatalf("expected result[0] podHostIPLabel '2.2.2.2', received '%s'", result[0][podHostIPLabel])
		}

		// A pod with all valid containers should return one target with allContainers=false, and it should be the alphabetically first container
		result = updatePodTargets(pod("easy", []Container{container("a", portsA), container("b", portsB)}), false)
		if len(result) != 1 {
			t.Fatalf("expected 1 targets, received %d", len(result))
		}
		if _, ok := result[0][podContainerNameLabel]; !ok {
			t.Fatalf("expected result[0][podContainerNameLabel] to be 'a', but was missing")
		}
		if result[0][podContainerNameLabel] != "a" {
			t.Fatalf("expected result[0][podContainerNameLabel] to be 'a', but was '%s'", result[0][podContainerNameLabel])
		}

		// A pod with some non-targetable containers should return one target per targetable container with allContainers=true
		result = updatePodTargets(pod("mixed", []Container{container("a", portsA), container("no-tcp", portsNoTcp), container("b", portsB)}), true)
		if len(result) != 2 {
			t.Fatalf("expected 2 targets, received %d", len(result))
		}

		// A pod with a container with multiple ports should return the numerically smallest port
		result = updatePodTargets(pod("hard", []Container{container("multiA", portsMultiA), container("multiB", portsMultiB)}), true)
		if len(result) != 2 {
			t.Fatalf("expected 2 targets, received %d", len(result))
		}
		if result[0][model.AddressLabel] != "1.1.1.1:22" {
			t.Fatalf("expected result[0] address to be 1.1.1.1:22, received %s", result[0][model.AddressLabel])
		}
		if result[0][podContainerPortListLabel] != ",ssh=22,http=80," {
			t.Fatalf("expected result[0] podContainerPortListLabel to be ',ssh=22,http=80,', received '%s'", result[0][podContainerPortListLabel])
		}
		if result[1][model.AddressLabel] != "1.1.1.1:80" {
			t.Fatalf("expected result[1] address to be 1.1.1.1:80, received %s", result[1][model.AddressLabel])
		}
		if result[1][podContainerPortListLabel] != ",http=80,https=443," {
			t.Fatalf("expected result[1] podContainerPortListLabel to be ',http=80,https=443,', received '%s'", result[1][podContainerPortListLabel])
		}
	}
}