Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance Unit Tests for Annotations #3749

Merged
merged 1 commit into from
Feb 10, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions internal/ingress/annotations/auth/main_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import (
meta_v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/intstr"
"k8s.io/ingress-nginx/internal/ingress/annotations/parser"
ing_errors "k8s.io/ingress-nginx/internal/ingress/errors"
"k8s.io/ingress-nginx/internal/ingress/resolver"
)

Expand Down Expand Up @@ -96,6 +97,42 @@ func TestIngressWithoutAuth(t *testing.T) {
}
}

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

data := map[string]string{}
data[parser.GetAnnotationWithPrefix("auth-type")] = "invalid"
ing.SetAnnotations(data)

_, dir, _ := dummySecretContent(t)
defer os.RemoveAll(dir)

expected := ing_errors.NewLocationDenied("invalid authentication type")
_, err := NewParser(dir, &mockSecret{}).Parse(ing)
if err.Error() != expected.Error() {
t.Errorf("expected '%v' but got '%v'", expected, err)
}
}

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

data := map[string]string{}
data[parser.GetAnnotationWithPrefix("auth-type")] = "basic"
ing.SetAnnotations(data)

_, dir, _ := dummySecretContent(t)
defer os.RemoveAll(dir)

expected := ing_errors.LocationDenied{
Reason: errors.New("error reading secret name from annotation: ingress rule without annotations"),
}
_, err := NewParser(dir, &mockSecret{}).Parse(ing)
if err.Error() != expected.Reason.Error() {
t.Errorf("expected '%v' but got '%v'", expected, err)
}
}

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

Expand Down
102 changes: 61 additions & 41 deletions internal/ingress/annotations/authtls/main_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ import (
extensions "k8s.io/api/extensions/v1beta1"
meta_v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/intstr"
"k8s.io/ingress-nginx/internal/ingress/annotations/parser"
"k8s.io/ingress-nginx/internal/ingress/errors"
"k8s.io/ingress-nginx/internal/ingress/resolver"
)

func buildIngress() *extensions.Ingress {
Expand Down Expand Up @@ -60,49 +63,66 @@ func buildIngress() *extensions.Ingress {
}
}

// mocks the resolver for authTLS
type mockSecret struct {
resolver.Mock
}

// GetAuthCertificate from mockSecret mocks the GetAuthCertificate for authTLS
func (m mockSecret) GetAuthCertificate(name string) (*resolver.AuthSSLCert, error) {
if name != "default/demo-secret" {
return nil, errors.Errorf("there is no secret with name %v", name)
}

return &resolver.AuthSSLCert{
Secret: "default/demo-secret",
CAFileName: "/ssl/ca.crt",
PemSHA: "abc",
}, nil

}

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

data := map[string]string{}

data[parser.GetAnnotationWithPrefix("auth-tls-secret")] = "default/demo-secret"
data[parser.GetAnnotationWithPrefix("auth-tls-verify-client")] = "off"
data[parser.GetAnnotationWithPrefix("auth-tls-verify-depth")] = "1"
data[parser.GetAnnotationWithPrefix("auth-tls-error-page")] = "ok.com/error"
data[parser.GetAnnotationWithPrefix("auth-tls-pass-certificate-to-upstream")] = "true"

ing.SetAnnotations(data)
/*
tests := []struct {
title string
url string
method string
sendBody bool
expErr bool
}{
{"empty", "", "", false, true},
{"no scheme", "bar", "", false, true},
{"invalid host", "http://", "", false, true},
{"invalid host (multiple dots)", "http://foo..bar.com", "", false, true},
{"valid URL", "http://bar.foo.com/external-auth", "", false, false},
{"valid URL - send body", "http://foo.com/external-auth", "POST", true, false},
{"valid URL - send body", "http://foo.com/external-auth", "GET", true, false},
}

for _, test := range tests {
data[authTLSSecret] = ""
test.title

u, err := ParseAnnotations(ing)

if test.expErr {
if err == nil {
t.Errorf("%v: expected error but retuned nil", test.title)
}
continue
}

if u.URL != test.url {
t.Errorf("%v: expected \"%v\" but \"%v\" was returned", test.title, test.url, u.URL)
}
if u.Method != test.method {
t.Errorf("%v: expected \"%v\" but \"%v\" was returned", test.title, test.method, u.Method)
}
if u.SendBody != test.sendBody {
t.Errorf("%v: expected \"%v\" but \"%v\" was returned", test.title, test.sendBody, u.SendBody)
}
}*/

fakeSecret := &mockSecret{}
i, err := NewParser(fakeSecret).Parse(ing)
if err != nil {
t.Errorf("Uxpected error with ingress: %v", err)
}

u, ok := i.(*Config)
if !ok {
t.Errorf("expected *Config but got %v", u)
}

secret, err := fakeSecret.GetAuthCertificate("default/demo-secret")
if err != nil {
t.Errorf("unexpected error getting secret %v", err)
}

if u.AuthSSLCert.Secret != secret.Secret {
t.Errorf("expected %v but got %v", secret.Secret, u.AuthSSLCert.Secret)
}
if u.VerifyClient != "off" {
t.Errorf("expected %v but got %v", "off", u.VerifyClient)
}
if u.ValidationDepth != 1 {
t.Errorf("expected %v but got %v", 1, u.ValidationDepth)
}
if u.ErrorPage != "ok.com/error" {
t.Errorf("expected %v but got %v", "ok.com/error", u.ErrorPage)
}
if u.PassCertToUpstream != true {
t.Errorf("expected %v but got %v", true, u.PassCertToUpstream)
}
}
52 changes: 48 additions & 4 deletions internal/ingress/annotations/backendprotocol/main_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,62 @@ func buildIngress() *extensions.Ingress {
},
}
}

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

_, err := NewParser(&resolver.Mock{}).Parse(ing)
// Test no annotations set
i, err := NewParser(&resolver.Mock{}).Parse(ing)
if err != nil {
t.Errorf("unexpected error parsing ingress with backend-protocol")
}
val, ok := i.(string)
if !ok {
t.Errorf("expected a string type")
}
if val != "HTTP" {
t.Errorf("expected HTTPS but %v returned", val)
}

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

// Test with empty annotations
i, err = NewParser(&resolver.Mock{}).Parse(ing)
if err != nil {
t.Errorf("unexpected error parsing ingress with backend-protocol")
}
val, ok = i.(string)
if !ok {
t.Errorf("expected a string type")
}
if val != "HTTP" {
t.Errorf("expected HTTPS but %v returned", val)
}

// Test invalid annotation set
data[parser.GetAnnotationWithPrefix("backend-protocol")] = "INVALID"
ing.SetAnnotations(data)

i, err = NewParser(&resolver.Mock{}).Parse(ing)
if err != nil {
t.Errorf("unexpected error: %v", err)
t.Errorf("unexpected error parsing ingress with backend-protocol")
}
val, ok = i.(string)
if !ok {
t.Errorf("expected a string type")
}
if val != "HTTP" {
t.Errorf("expected HTTPS but %v returned", val)
}
}

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

data := map[string]string{}
data[parser.GetAnnotationWithPrefix("backend-protocol")] = "HTTPS"
ing.SetAnnotations(data)

i, err := NewParser(&resolver.Mock{}).Parse(ing)
if err != nil {
t.Errorf("unexpected error parsing ingress with backend-protocol")
Expand Down
30 changes: 28 additions & 2 deletions internal/ingress/annotations/canary/main_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,17 @@ limitations under the License.
package canary

import (
"testing"

api "k8s.io/api/core/v1"
extensions "k8s.io/api/extensions/v1beta1"
metaV1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/intstr"
"k8s.io/ingress-nginx/internal/ingress/annotations/parser"
"testing"

"k8s.io/ingress-nginx/internal/ingress/resolver"
"strconv"

"k8s.io/ingress-nginx/internal/ingress/resolver"
)

func buildIngress() *extensions.Ingress {
Expand Down Expand Up @@ -63,6 +65,30 @@ func buildIngress() *extensions.Ingress {
}
}

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

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

i, err := NewParser(&resolver.Mock{}).Parse(ing)
if err != nil {
t.Errorf("Error Parsing Canary Annotations")
}

val, ok := i.(*Config)
if !ok {
t.Errorf("Expected %v and got %v", "*Config", val)
}
if val.Enabled != false {
t.Errorf("Expected %v but got %v", false, val.Enabled)
}
if val.Weight != 0 {
t.Errorf("Expected %v but got %v", 0, val.Weight)
}

}

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

Expand Down
91 changes: 91 additions & 0 deletions internal/ingress/annotations/customhttperrors/main_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
/*
Copyright 2019 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 customhttperrors

import (
"reflect"
"sort"
"testing"

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

"k8s.io/apimachinery/pkg/util/intstr"
)

func buildIngress() *extensions.Ingress {
return &extensions.Ingress{
ObjectMeta: meta_v1.ObjectMeta{
Name: "foo",
Namespace: api.NamespaceDefault,
},
Spec: extensions.IngressSpec{
Backend: &extensions.IngressBackend{
ServiceName: "default-backend",
ServicePort: intstr.FromInt(80),
},
},
}
}

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

_, err := NewParser(&resolver.Mock{}).Parse(ing)
if err == nil {
t.Errorf("expected error parsing ingress with custom-http-errors")
}

data := map[string]string{}
data[parser.GetAnnotationWithPrefix("custom-http-errors")] = "400,404,abc,502"
ing.SetAnnotations(data)

i, err := NewParser(&resolver.Mock{}).Parse(ing)
if err == nil {
t.Errorf("expected error parsing ingress with custom-http-errors")
}
if i != nil {
t.Errorf("expected %v but got %v", nil, i)
}
}

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

data := map[string]string{}
data[parser.GetAnnotationWithPrefix("custom-http-errors")] = "400,404,500,502"
ing.SetAnnotations(data)

i, err := NewParser(&resolver.Mock{}).Parse(ing)
if err != nil {
t.Errorf("unexpected error parsing ingress with custom-http-errors")
}
val, ok := i.([]int)
if !ok {
t.Errorf("expected a []int type")
}

expected := []int{400, 404, 500, 502}
sort.Ints(val)

if !reflect.DeepEqual(expected, val) {
t.Errorf("expected %v but got %v", expected, val)
}
}
Loading