ingress-nginx-helm/internal/ingress/annotations/opentelemetry/main_test.go

/*
Copyright 2022 The Kubernetes 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 opentelemetry

import (
	"testing"

	api "k8s.io/api/core/v1"
	networking "k8s.io/api/networking/v1"
	meta_v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/ingress-nginx/internal/ingress/annotations/parser"
	"k8s.io/ingress-nginx/internal/ingress/resolver"
)

const enableAnnotation = "true"

func buildIngress() *networking.Ingress {
	defaultBackend := networking.IngressBackend{
		Service: &networking.IngressServiceBackend{
			Name: "default-backend",
			Port: networking.ServiceBackendPort{
				Number: 80,
			},
		},
	}

	return &networking.Ingress{
		ObjectMeta: meta_v1.ObjectMeta{
			Name:      "foo",
			Namespace: api.NamespaceDefault,
		},
		Spec: networking.IngressSpec{
			DefaultBackend: &networking.IngressBackend{
				Service: &networking.IngressServiceBackend{
					Name: "default-backend",
					Port: networking.ServiceBackendPort{
						Number: 80,
					},
				},
			},
			Rules: []networking.IngressRule{
				{
					Host: "foo.bar.com",
					IngressRuleValue: networking.IngressRuleValue{
						HTTP: &networking.HTTPIngressRuleValue{
							Paths: []networking.HTTPIngressPath{
								{
									Path:    "/foo",
									Backend: defaultBackend,
								},
							},
						},
					},
				},
			},
		},
	}
}

func TestIngressAnnotationOpentelemetrySetTrue(t *testing.T) {
	ing := buildIngress()

	data := map[string]string{}
	data[parser.GetAnnotationWithPrefix(enableOpenTelemetryAnnotation)] = enableAnnotation
	ing.SetAnnotations(data)

	val, err := NewParser(&resolver.Mock{}).Parse(ing)
	if err != nil {
		t.Errorf("unexpected error: %v", err)
	}
	openTelemetry, ok := val.(*Config)
	if !ok {
		t.Errorf("expected a Config type")
	}

	if !openTelemetry.Enabled {
		t.Errorf("expected annotation value to be true, got false")
	}

	if !openTelemetry.Set {
		t.Errorf("expected annotation value to be true, got false")
	}

	if openTelemetry.TrustSet {
		t.Errorf("expected annotation value to be false, got true")
	}
}

func TestIngressAnnotationOpentelemetrySetFalse(t *testing.T) {
	ing := buildIngress()

	// Test with explicitly set to false
	data := map[string]string{}
	data[parser.GetAnnotationWithPrefix(enableOpenTelemetryAnnotation)] = "false"
	ing.SetAnnotations(data)

	val, err := NewParser(&resolver.Mock{}).Parse(ing)
	if err != nil {
		t.Errorf("unexpected error: %v", err)
	}
	openTelemetry, ok := val.(*Config)
	if !ok {
		t.Errorf("expected a Config type")
	}

	if openTelemetry.Enabled {
		t.Errorf("expected annotation value to be false, got true")
	}

	if !openTelemetry.Set {
		t.Errorf("expected annotation value to be true, got false")
	}
}

func TestIngressAnnotationOpentelemetryTrustSetTrue(t *testing.T) {
	ing := buildIngress()

	data := map[string]string{}
	opName := "foo-op"
	data[parser.GetAnnotationWithPrefix(enableOpenTelemetryAnnotation)] = enableAnnotation
	data[parser.GetAnnotationWithPrefix(otelTrustSpanAnnotation)] = enableAnnotation
	data[parser.GetAnnotationWithPrefix(otelOperationNameAnnotation)] = opName
	ing.SetAnnotations(data)

	val, err := NewParser(&resolver.Mock{}).Parse(ing)
	if err != nil {
		t.Fatal(err)
	}
	openTelemetry, ok := val.(*Config)
	if !ok {
		t.Errorf("expected a Config type")
	}

	if !openTelemetry.Enabled {
		t.Errorf("expected annotation value to be true, got false")
	}

	if !openTelemetry.Set {
		t.Errorf("expected annotation value to be true, got false")
	}

	if !openTelemetry.TrustEnabled {
		t.Errorf("expected annotation value to be true, got false")
	}

	if !openTelemetry.TrustSet {
		t.Errorf("expected annotation value to be true, got false")
	}

	if openTelemetry.OperationName != opName {
		t.Errorf("expected annotation value to be %v, got %v", opName, openTelemetry.OperationName)
	}
}

func TestIngressAnnotationOpentelemetryWithBadOpName(t *testing.T) {
	ing := buildIngress()

	data := map[string]string{}
	opName := "fooxpto_123$la;"
	data[parser.GetAnnotationWithPrefix(enableOpenTelemetryAnnotation)] = enableAnnotation
	data[parser.GetAnnotationWithPrefix(otelOperationNameAnnotation)] = opName
	ing.SetAnnotations(data)

	_, err := NewParser(&resolver.Mock{}).Parse(ing)
	if err == nil {
		t.Fatalf("This operation should return an error but no error was returned")
	}
}

func TestIngressAnnotationOpentelemetryUnset(t *testing.T) {
	ing := buildIngress()

	// Test with no annotation specified
	data := map[string]string{}
	ing.SetAnnotations(data)

	val, err := NewParser(&resolver.Mock{}).Parse(ing)
	if err != nil {
		t.Errorf("unexpected error: %v", err)
	}
	_, ok := val.(*Config)
	if !ok {
		t.Errorf("expected a Config type")
	}
}