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

/*
Copyright 2016 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 proxy

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/defaults"
	"k8s.io/ingress-nginx/internal/ingress/resolver"
)

const (
	off                  = "off"
	proxyHTTPVersion     = "1.0"
	proxyMaxTempFileSize = "128k"
)

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,
								},
							},
						},
					},
				},
			},
		},
	}
}

type mockBackend struct {
	resolver.Mock
}

func (m mockBackend) GetDefaultBackend() defaults.Backend {
	return defaults.Backend{
		ProxyConnectTimeout:      10,
		ProxySendTimeout:         15,
		ProxyReadTimeout:         20,
		ProxyBuffersNumber:       4,
		ProxyBufferSize:          "10k",
		ProxyBodySize:            "3k",
		ProxyNextUpstream:        "error",
		ProxyNextUpstreamTimeout: 0,
		ProxyNextUpstreamTries:   3,
		ProxyRequestBuffering:    "on",
		ProxyBuffering:           off,
		ProxyHTTPVersion:         "1.1",
		ProxyMaxTempFileSize:     "1024m",
	}
}

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

	data := map[string]string{}
	data[parser.GetAnnotationWithPrefix("proxy-connect-timeout")] = "1"
	data[parser.GetAnnotationWithPrefix("proxy-send-timeout")] = "2"
	data[parser.GetAnnotationWithPrefix("proxy-read-timeout")] = "3"
	data[parser.GetAnnotationWithPrefix("proxy-buffers-number")] = "8"
	data[parser.GetAnnotationWithPrefix("proxy-buffer-size")] = "1k"
	data[parser.GetAnnotationWithPrefix("proxy-body-size")] = "2k"
	data[parser.GetAnnotationWithPrefix("proxy-next-upstream")] = off
	data[parser.GetAnnotationWithPrefix("proxy-next-upstream-timeout")] = "5"
	data[parser.GetAnnotationWithPrefix("proxy-next-upstream-tries")] = "3"
	data[parser.GetAnnotationWithPrefix("proxy-request-buffering")] = off
	data[parser.GetAnnotationWithPrefix("proxy-buffering")] = "on"
	data[parser.GetAnnotationWithPrefix("proxy-http-version")] = proxyHTTPVersion
	data[parser.GetAnnotationWithPrefix("proxy-max-temp-file-size")] = proxyMaxTempFileSize
	ing.SetAnnotations(data)

	i, err := NewParser(mockBackend{}).Parse(ing)
	if err != nil {
		t.Fatalf("unexpected error parsing a valid")
	}
	p, ok := i.(*Config)
	if !ok {
		t.Fatalf("expected a Config type")
	}
	if p.ConnectTimeout != 1 {
		t.Errorf("expected 1 as connect-timeout but returned %v", p.ConnectTimeout)
	}
	if p.SendTimeout != 2 {
		t.Errorf("expected 2 as send-timeout but returned %v", p.SendTimeout)
	}
	if p.ReadTimeout != 3 {
		t.Errorf("expected 3 as read-timeout but returned %v", p.ReadTimeout)
	}
	if p.BuffersNumber != 8 {
		t.Errorf("expected 8 as proxy-buffers-number but returned %v", p.BuffersNumber)
	}
	if p.BufferSize != "1k" {
		t.Errorf("expected 1k as buffer-size but returned %v", p.BufferSize)
	}
	if p.BodySize != "2k" {
		t.Errorf("expected 2k as body-size but returned %v", p.BodySize)
	}
	if p.NextUpstream != off {
		t.Errorf("expected off as next-upstream but returned %v", p.NextUpstream)
	}
	if p.NextUpstreamTimeout != 5 {
		t.Errorf("expected 5 as next-upstream-timeout but returned %v", p.NextUpstreamTimeout)
	}
	if p.NextUpstreamTries != 3 {
		t.Errorf("expected 3 as next-upstream-tries but returned %v", p.NextUpstreamTries)
	}
	if p.RequestBuffering != off {
		t.Errorf("expected off as request-buffering but returned %v", p.RequestBuffering)
	}
	if p.ProxyBuffering != "on" {
		t.Errorf("expected on as proxy-buffering but returned %v", p.ProxyBuffering)
	}
	if p.ProxyHTTPVersion != proxyHTTPVersion {
		t.Errorf("expected 1.0 as proxy-http-version but returned %v", p.ProxyHTTPVersion)
	}
	if p.ProxyMaxTempFileSize != proxyMaxTempFileSize {
		t.Errorf("expected 128k as proxy-max-temp-file-size but returned %v", p.ProxyMaxTempFileSize)
	}
}

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

	data := map[string]string{}
	data[parser.GetAnnotationWithPrefix("proxy-connect-timeout")] = "1"
	data[parser.GetAnnotationWithPrefix("proxy-send-timeout")] = "2"
	data[parser.GetAnnotationWithPrefix("proxy-read-timeout")] = "3"
	data[parser.GetAnnotationWithPrefix("proxy-buffers-number")] = "8"
	data[parser.GetAnnotationWithPrefix("proxy-buffer-size")] = "1k"
	data[parser.GetAnnotationWithPrefix("proxy-body-size")] = "2k"
	data[parser.GetAnnotationWithPrefix("proxy-next-upstream")] = "error http_502"
	data[parser.GetAnnotationWithPrefix("proxy-next-upstream-timeout")] = "5"
	data[parser.GetAnnotationWithPrefix("proxy-next-upstream-tries")] = "3"
	data[parser.GetAnnotationWithPrefix("proxy-request-buffering")] = "off"
	data[parser.GetAnnotationWithPrefix("proxy-buffering")] = "on"
	data[parser.GetAnnotationWithPrefix("proxy-http-version")] = proxyHTTPVersion
	data[parser.GetAnnotationWithPrefix("proxy-max-temp-file-size")] = proxyMaxTempFileSize
	ing.SetAnnotations(data)

	i, err := NewParser(mockBackend{}).Parse(ing)
	if err != nil {
		t.Fatalf("unexpected error parsing a valid")
	}
	p, ok := i.(*Config)
	if !ok {
		t.Fatalf("expected a Config type")
	}
	if p.ConnectTimeout != 1 {
		t.Errorf("expected 1 as connect-timeout but returned %v", p.ConnectTimeout)
	}
	if p.SendTimeout != 2 {
		t.Errorf("expected 2 as send-timeout but returned %v", p.SendTimeout)
	}
	if p.ReadTimeout != 3 {
		t.Errorf("expected 3 as read-timeout but returned %v", p.ReadTimeout)
	}
	if p.BuffersNumber != 8 {
		t.Errorf("expected 8 as proxy-buffers-number but returned %v", p.BuffersNumber)
	}
	if p.BufferSize != "1k" {
		t.Errorf("expected 1k as buffer-size but returned %v", p.BufferSize)
	}
	if p.BodySize != "2k" {
		t.Errorf("expected 2k as body-size but returned %v", p.BodySize)
	}
	if p.NextUpstream != "error http_502" {
		t.Errorf("expected off as next-upstream but returned %v", p.NextUpstream)
	}
	if p.NextUpstreamTimeout != 5 {
		t.Errorf("expected 5 as next-upstream-timeout but returned %v", p.NextUpstreamTimeout)
	}
	if p.NextUpstreamTries != 3 {
		t.Errorf("expected 3 as next-upstream-tries but returned %v", p.NextUpstreamTries)
	}
	if p.RequestBuffering != "off" {
		t.Errorf("expected off as request-buffering but returned %v", p.RequestBuffering)
	}
	if p.ProxyBuffering != "on" {
		t.Errorf("expected on as proxy-buffering but returned %v", p.ProxyBuffering)
	}
	if p.ProxyHTTPVersion != proxyHTTPVersion {
		t.Errorf("expected 1.0 as proxy-http-version but returned %v", p.ProxyHTTPVersion)
	}
	if p.ProxyMaxTempFileSize != proxyMaxTempFileSize {
		t.Errorf("expected 128k as proxy-max-temp-file-size but returned %v", p.ProxyMaxTempFileSize)
	}
}

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

	data := map[string]string{}
	ing.SetAnnotations(data)

	i, err := NewParser(mockBackend{}).Parse(ing)
	if err != nil {
		t.Fatalf("unexpected error parsing a valid")
	}
	p, ok := i.(*Config)
	if !ok {
		t.Fatalf("expected a Config type")
	}
	if p.ConnectTimeout != 10 {
		t.Errorf("expected 10 as connect-timeout but returned %v", p.ConnectTimeout)
	}
	if p.SendTimeout != 15 {
		t.Errorf("expected 15 as send-timeout but returned %v", p.SendTimeout)
	}
	if p.ReadTimeout != 20 {
		t.Errorf("expected 20 as read-timeout but returned %v", p.ReadTimeout)
	}
	if p.BuffersNumber != 4 {
		t.Errorf("expected 4 as buffer-number but returned %v", p.BuffersNumber)
	}
	if p.BufferSize != "10k" {
		t.Errorf("expected 10k as buffer-size but returned %v", p.BufferSize)
	}
	if p.BodySize != "3k" {
		t.Errorf("expected 3k as body-size but returned %v", p.BodySize)
	}
	if p.NextUpstream != "error" {
		t.Errorf("expected error as next-upstream but returned %v", p.NextUpstream)
	}
	if p.NextUpstreamTimeout != 0 {
		t.Errorf("expected 0 as next-upstream-timeout but returned %v", p.NextUpstreamTimeout)
	}
	if p.NextUpstreamTries != 3 {
		t.Errorf("expected 3 as next-upstream-tries but returned %v", p.NextUpstreamTries)
	}
	if p.RequestBuffering != "on" {
		t.Errorf("expected on as request-buffering but returned %v", p.RequestBuffering)
	}
	if p.ProxyHTTPVersion != "1.1" {
		t.Errorf("expected 1.1 as proxy-http-version but returned %v", p.ProxyHTTPVersion)
	}
	if p.ProxyMaxTempFileSize != "1024m" {
		t.Errorf("expected 1024m as proxy-max-temp-file-size but returned %v", p.ProxyMaxTempFileSize)
	}
}