mirror of
https://github.com/kubernetes-sigs/external-dns.git
synced 2025-08-06 09:36:58 +02:00
ec07f45c8e
* Make suitableType() be Endpoint method With this change it becomes possible to work with endpoint of empty type in packages other than "provider". Also it seems logical for a smart property getter without side effects to be a method rather than a function in different package * Make plan computation work correctly with multi-target domains * fix drawing * drop comments * fix boilerplate header * fix comment * fix the bug with empty map * rework registry to support random lables * serialize->serializeLabel function rename * golint for err variable naming * add additional test * add tests for current case where one resource can generate multiple endpoints * make labels have its own type, add serialization as a method * add comment for exported error * use greater rather than not equal zero * update changelog
699 lines
16 KiB
Go
699 lines
16 KiB
Go
/*
|
|
Copyright 2017 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 source
|
|
|
|
import (
|
|
"testing"
|
|
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
"k8s.io/client-go/kubernetes/fake"
|
|
"k8s.io/client-go/pkg/api/v1"
|
|
"k8s.io/client-go/pkg/apis/extensions/v1beta1"
|
|
|
|
"github.com/kubernetes-incubator/external-dns/endpoint"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"github.com/stretchr/testify/suite"
|
|
)
|
|
|
|
// Validates that ingressSource is a Source
|
|
var _ Source = &ingressSource{}
|
|
|
|
type IngressSuite struct {
|
|
suite.Suite
|
|
sc Source
|
|
fooWithTargets *v1beta1.Ingress
|
|
}
|
|
|
|
func (suite *IngressSuite) SetupTest() {
|
|
fakeClient := fake.NewSimpleClientset()
|
|
var err error
|
|
|
|
suite.sc, err = NewIngressSource(
|
|
fakeClient,
|
|
"",
|
|
"",
|
|
"{{.Name}}",
|
|
)
|
|
suite.NoError(err, "should initialize ingress source")
|
|
|
|
suite.fooWithTargets = (fakeIngress{
|
|
name: "foo-with-targets",
|
|
namespace: "default",
|
|
dnsnames: []string{"foo"},
|
|
ips: []string{"8.8.8.8"},
|
|
hostnames: []string{"v1"},
|
|
}).Ingress()
|
|
_, err = fakeClient.Extensions().Ingresses(suite.fooWithTargets.Namespace).Create(suite.fooWithTargets)
|
|
suite.NoError(err, "should succeed")
|
|
}
|
|
|
|
func (suite *IngressSuite) TestResourceLabelIsSet() {
|
|
endpoints, _ := suite.sc.Endpoints()
|
|
for _, ep := range endpoints {
|
|
suite.Equal("ingress/default/foo-with-targets", ep.Labels[endpoint.ResourceLabelKey], "should set correct resource label")
|
|
}
|
|
}
|
|
|
|
func TestIngress(t *testing.T) {
|
|
suite.Run(t, new(IngressSuite))
|
|
t.Run("endpointsFromIngress", testEndpointsFromIngress)
|
|
t.Run("Endpoints", testIngressEndpoints)
|
|
}
|
|
|
|
func TestNewIngressSource(t *testing.T) {
|
|
for _, ti := range []struct {
|
|
title string
|
|
annotationFilter string
|
|
fqdnTemplate string
|
|
expectError bool
|
|
}{
|
|
{
|
|
title: "invalid template",
|
|
expectError: true,
|
|
fqdnTemplate: "{{.Name",
|
|
},
|
|
{
|
|
title: "valid empty template",
|
|
expectError: false,
|
|
},
|
|
{
|
|
title: "valid template",
|
|
expectError: false,
|
|
fqdnTemplate: "{{.Name}}-{{.Namespace}}.ext-dns.test.com",
|
|
},
|
|
{
|
|
title: "non-empty annotation filter label",
|
|
expectError: false,
|
|
annotationFilter: "kubernetes.io/ingress.class=nginx",
|
|
},
|
|
} {
|
|
t.Run(ti.title, func(t *testing.T) {
|
|
_, err := NewIngressSource(
|
|
fake.NewSimpleClientset(),
|
|
"",
|
|
ti.annotationFilter,
|
|
ti.fqdnTemplate,
|
|
)
|
|
if ti.expectError {
|
|
assert.Error(t, err)
|
|
} else {
|
|
assert.NoError(t, err)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func testEndpointsFromIngress(t *testing.T) {
|
|
for _, ti := range []struct {
|
|
title string
|
|
ingress fakeIngress
|
|
expected []*endpoint.Endpoint
|
|
}{
|
|
{
|
|
title: "one rule.host one lb.hostname",
|
|
ingress: fakeIngress{
|
|
dnsnames: []string{"foo.bar"}, // Kubernetes requires removal of trailing dot
|
|
hostnames: []string{"lb.com"}, // Kubernetes omits the trailing dot
|
|
},
|
|
expected: []*endpoint.Endpoint{
|
|
{
|
|
DNSName: "foo.bar",
|
|
Target: "lb.com",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
title: "one rule.host one lb.IP",
|
|
ingress: fakeIngress{
|
|
dnsnames: []string{"foo.bar"},
|
|
ips: []string{"8.8.8.8"},
|
|
},
|
|
expected: []*endpoint.Endpoint{
|
|
{
|
|
DNSName: "foo.bar",
|
|
Target: "8.8.8.8",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
title: "one rule.host two lb.IP and two lb.Hostname",
|
|
ingress: fakeIngress{
|
|
dnsnames: []string{"foo.bar"},
|
|
ips: []string{"8.8.8.8", "127.0.0.1"},
|
|
hostnames: []string{"elb.com", "alb.com"},
|
|
},
|
|
expected: []*endpoint.Endpoint{
|
|
{
|
|
DNSName: "foo.bar",
|
|
Target: "8.8.8.8",
|
|
},
|
|
{
|
|
DNSName: "foo.bar",
|
|
Target: "127.0.0.1",
|
|
},
|
|
{
|
|
DNSName: "foo.bar",
|
|
Target: "elb.com",
|
|
},
|
|
{
|
|
DNSName: "foo.bar",
|
|
Target: "alb.com",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
title: "no rule.host",
|
|
ingress: fakeIngress{
|
|
ips: []string{"8.8.8.8", "127.0.0.1"},
|
|
hostnames: []string{"elb.com", "alb.com"},
|
|
},
|
|
expected: []*endpoint.Endpoint{},
|
|
},
|
|
{
|
|
title: "one empty rule.host",
|
|
ingress: fakeIngress{
|
|
dnsnames: []string{""},
|
|
ips: []string{"8.8.8.8", "127.0.0.1"},
|
|
hostnames: []string{"elb.com", "alb.com"},
|
|
},
|
|
expected: []*endpoint.Endpoint{},
|
|
},
|
|
{
|
|
title: "no targets",
|
|
ingress: fakeIngress{
|
|
dnsnames: []string{""},
|
|
},
|
|
expected: []*endpoint.Endpoint{},
|
|
},
|
|
} {
|
|
t.Run(ti.title, func(t *testing.T) {
|
|
realIngress := ti.ingress.Ingress()
|
|
validateEndpoints(t, endpointsFromIngress(realIngress), ti.expected)
|
|
})
|
|
}
|
|
}
|
|
|
|
func testIngressEndpoints(t *testing.T) {
|
|
namespace := "testing"
|
|
for _, ti := range []struct {
|
|
title string
|
|
targetNamespace string
|
|
annotationFilter string
|
|
ingressItems []fakeIngress
|
|
expected []*endpoint.Endpoint
|
|
expectError bool
|
|
fqdnTemplate string
|
|
}{
|
|
{
|
|
title: "no ingress",
|
|
targetNamespace: "",
|
|
},
|
|
{
|
|
title: "two simple ingresses",
|
|
targetNamespace: "",
|
|
ingressItems: []fakeIngress{
|
|
{
|
|
name: "fake1",
|
|
namespace: namespace,
|
|
dnsnames: []string{"example.org"},
|
|
ips: []string{"8.8.8.8"},
|
|
},
|
|
{
|
|
name: "fake2",
|
|
namespace: namespace,
|
|
dnsnames: []string{"new.org"},
|
|
hostnames: []string{"lb.com"},
|
|
},
|
|
},
|
|
expected: []*endpoint.Endpoint{
|
|
{
|
|
DNSName: "example.org",
|
|
Target: "8.8.8.8",
|
|
},
|
|
{
|
|
DNSName: "new.org",
|
|
Target: "lb.com",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
title: "two simple ingresses on different namespaces",
|
|
targetNamespace: "",
|
|
ingressItems: []fakeIngress{
|
|
{
|
|
name: "fake1",
|
|
namespace: "testing1",
|
|
dnsnames: []string{"example.org"},
|
|
ips: []string{"8.8.8.8"},
|
|
},
|
|
{
|
|
name: "fake2",
|
|
namespace: "testing2",
|
|
dnsnames: []string{"new.org"},
|
|
hostnames: []string{"lb.com"},
|
|
},
|
|
},
|
|
expected: []*endpoint.Endpoint{
|
|
{
|
|
DNSName: "example.org",
|
|
Target: "8.8.8.8",
|
|
},
|
|
{
|
|
DNSName: "new.org",
|
|
Target: "lb.com",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
title: "two simple ingresses on different namespaces with target namespace",
|
|
targetNamespace: "testing1",
|
|
ingressItems: []fakeIngress{
|
|
{
|
|
name: "fake1",
|
|
namespace: "testing1",
|
|
dnsnames: []string{"example.org"},
|
|
ips: []string{"8.8.8.8"},
|
|
},
|
|
{
|
|
name: "fake2",
|
|
namespace: "testing2",
|
|
dnsnames: []string{"new.org"},
|
|
hostnames: []string{"lb.com"},
|
|
},
|
|
},
|
|
expected: []*endpoint.Endpoint{
|
|
{
|
|
DNSName: "example.org",
|
|
Target: "8.8.8.8",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
title: "valid matching annotation filter expression",
|
|
targetNamespace: "",
|
|
annotationFilter: "kubernetes.io/ingress.class in (alb, nginx)",
|
|
ingressItems: []fakeIngress{
|
|
{
|
|
name: "fake1",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
"kubernetes.io/ingress.class": "nginx",
|
|
},
|
|
dnsnames: []string{"example.org"},
|
|
ips: []string{"8.8.8.8"},
|
|
},
|
|
},
|
|
expected: []*endpoint.Endpoint{
|
|
{
|
|
DNSName: "example.org",
|
|
Target: "8.8.8.8",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
title: "valid non-matching annotation filter expression",
|
|
targetNamespace: "",
|
|
annotationFilter: "kubernetes.io/ingress.class in (alb, nginx)",
|
|
ingressItems: []fakeIngress{
|
|
{
|
|
name: "fake1",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
"kubernetes.io/ingress.class": "tectonic",
|
|
},
|
|
dnsnames: []string{"example.org"},
|
|
ips: []string{"8.8.8.8"},
|
|
},
|
|
},
|
|
expected: []*endpoint.Endpoint{},
|
|
},
|
|
{
|
|
title: "invalid annotation filter expression",
|
|
targetNamespace: "",
|
|
annotationFilter: "kubernetes.io/ingress.name in (a b)",
|
|
ingressItems: []fakeIngress{
|
|
{
|
|
name: "fake1",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
"kubernetes.io/ingress.class": "alb",
|
|
},
|
|
dnsnames: []string{"example.org"},
|
|
ips: []string{"8.8.8.8"},
|
|
},
|
|
},
|
|
expected: []*endpoint.Endpoint{},
|
|
expectError: true,
|
|
},
|
|
{
|
|
title: "valid matching annotation filter label",
|
|
targetNamespace: "",
|
|
annotationFilter: "kubernetes.io/ingress.class=nginx",
|
|
ingressItems: []fakeIngress{
|
|
{
|
|
name: "fake1",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
"kubernetes.io/ingress.class": "nginx",
|
|
},
|
|
dnsnames: []string{"example.org"},
|
|
ips: []string{"8.8.8.8"},
|
|
},
|
|
},
|
|
expected: []*endpoint.Endpoint{
|
|
{
|
|
DNSName: "example.org",
|
|
Target: "8.8.8.8",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
title: "valid non-matching annotation filter label",
|
|
targetNamespace: "",
|
|
annotationFilter: "kubernetes.io/ingress.class=nginx",
|
|
ingressItems: []fakeIngress{
|
|
{
|
|
name: "fake1",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
"kubernetes.io/ingress.class": "alb",
|
|
},
|
|
dnsnames: []string{"example.org"},
|
|
ips: []string{"8.8.8.8"},
|
|
},
|
|
},
|
|
expected: []*endpoint.Endpoint{},
|
|
},
|
|
{
|
|
title: "our controller type is dns-controller",
|
|
targetNamespace: "",
|
|
ingressItems: []fakeIngress{
|
|
{
|
|
name: "fake1",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
controllerAnnotationKey: controllerAnnotationValue,
|
|
},
|
|
dnsnames: []string{"example.org"},
|
|
ips: []string{"8.8.8.8"},
|
|
},
|
|
},
|
|
expected: []*endpoint.Endpoint{
|
|
{
|
|
DNSName: "example.org",
|
|
Target: "8.8.8.8",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
title: "different controller types are ignored",
|
|
targetNamespace: "",
|
|
ingressItems: []fakeIngress{
|
|
{
|
|
name: "fake1",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
controllerAnnotationKey: "some-other-tool",
|
|
},
|
|
dnsnames: []string{"example.org"},
|
|
ips: []string{"8.8.8.8"},
|
|
},
|
|
},
|
|
expected: []*endpoint.Endpoint{},
|
|
},
|
|
{
|
|
title: "template for ingress if host is missing",
|
|
targetNamespace: "",
|
|
ingressItems: []fakeIngress{
|
|
{
|
|
name: "fake1",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
controllerAnnotationKey: controllerAnnotationValue,
|
|
},
|
|
dnsnames: []string{},
|
|
ips: []string{"8.8.8.8"},
|
|
hostnames: []string{"elb.com"},
|
|
},
|
|
},
|
|
expected: []*endpoint.Endpoint{
|
|
{
|
|
DNSName: "fake1.ext-dns.test.com",
|
|
Target: "8.8.8.8",
|
|
},
|
|
{
|
|
DNSName: "fake1.ext-dns.test.com",
|
|
Target: "elb.com",
|
|
},
|
|
},
|
|
fqdnTemplate: "{{.Name}}.ext-dns.test.com",
|
|
},
|
|
{
|
|
title: "another controller annotation skipped even with template",
|
|
targetNamespace: "",
|
|
ingressItems: []fakeIngress{
|
|
{
|
|
name: "fake1",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
controllerAnnotationKey: "other-controller",
|
|
},
|
|
dnsnames: []string{},
|
|
ips: []string{"8.8.8.8"},
|
|
},
|
|
},
|
|
expected: []*endpoint.Endpoint{},
|
|
fqdnTemplate: "{{.Name}}.ext-dns.test.com",
|
|
},
|
|
{
|
|
title: "ingress rules with annotation",
|
|
targetNamespace: "",
|
|
ingressItems: []fakeIngress{
|
|
{
|
|
name: "fake1",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
targetAnnotationKey: "ingress-target.com",
|
|
},
|
|
dnsnames: []string{"example.org"},
|
|
ips: []string{},
|
|
},
|
|
{
|
|
name: "fake2",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
targetAnnotationKey: "ingress-target.com",
|
|
},
|
|
dnsnames: []string{"example2.org"},
|
|
ips: []string{"8.8.8.8"},
|
|
},
|
|
{
|
|
name: "fake3",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
targetAnnotationKey: "1.2.3.4",
|
|
},
|
|
dnsnames: []string{"example3.org"},
|
|
ips: []string{},
|
|
},
|
|
},
|
|
expected: []*endpoint.Endpoint{
|
|
{
|
|
DNSName: "example.org",
|
|
Target: "ingress-target.com",
|
|
RecordType: endpoint.RecordTypeCNAME,
|
|
},
|
|
{
|
|
DNSName: "example2.org",
|
|
Target: "ingress-target.com",
|
|
RecordType: endpoint.RecordTypeCNAME,
|
|
},
|
|
{
|
|
DNSName: "example3.org",
|
|
Target: "1.2.3.4",
|
|
RecordType: endpoint.RecordTypeA,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
title: "ingress rules with annotation and custom TTL",
|
|
targetNamespace: "",
|
|
ingressItems: []fakeIngress{
|
|
{
|
|
name: "fake1",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
targetAnnotationKey: "ingress-target.com",
|
|
ttlAnnotationKey: "6",
|
|
},
|
|
dnsnames: []string{"example.org"},
|
|
ips: []string{},
|
|
},
|
|
{
|
|
name: "fake2",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
targetAnnotationKey: "ingress-target.com",
|
|
ttlAnnotationKey: "1",
|
|
},
|
|
dnsnames: []string{"example2.org"},
|
|
ips: []string{"8.8.8.8"},
|
|
},
|
|
},
|
|
expected: []*endpoint.Endpoint{
|
|
{
|
|
DNSName: "example.org",
|
|
Target: "ingress-target.com",
|
|
RecordTTL: endpoint.TTL(6),
|
|
},
|
|
{
|
|
DNSName: "example2.org",
|
|
Target: "ingress-target.com",
|
|
RecordTTL: endpoint.TTL(1),
|
|
},
|
|
},
|
|
},
|
|
{
|
|
title: "template for ingress with annotation",
|
|
targetNamespace: "",
|
|
ingressItems: []fakeIngress{
|
|
{
|
|
name: "fake1",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
targetAnnotationKey: "ingress-target.com",
|
|
},
|
|
dnsnames: []string{},
|
|
ips: []string{},
|
|
hostnames: []string{},
|
|
},
|
|
{
|
|
name: "fake2",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
targetAnnotationKey: "ingress-target.com",
|
|
},
|
|
dnsnames: []string{},
|
|
ips: []string{"8.8.8.8"},
|
|
},
|
|
{
|
|
name: "fake3",
|
|
namespace: namespace,
|
|
annotations: map[string]string{
|
|
targetAnnotationKey: "1.2.3.4",
|
|
},
|
|
dnsnames: []string{},
|
|
ips: []string{},
|
|
hostnames: []string{},
|
|
},
|
|
},
|
|
expected: []*endpoint.Endpoint{
|
|
{
|
|
DNSName: "fake1.ext-dns.test.com",
|
|
Target: "ingress-target.com",
|
|
RecordType: endpoint.RecordTypeCNAME,
|
|
},
|
|
{
|
|
DNSName: "fake2.ext-dns.test.com",
|
|
Target: "ingress-target.com",
|
|
RecordType: endpoint.RecordTypeCNAME,
|
|
},
|
|
{
|
|
DNSName: "fake3.ext-dns.test.com",
|
|
Target: "1.2.3.4",
|
|
RecordType: endpoint.RecordTypeA,
|
|
},
|
|
},
|
|
fqdnTemplate: "{{.Name}}.ext-dns.test.com",
|
|
},
|
|
} {
|
|
t.Run(ti.title, func(t *testing.T) {
|
|
ingresses := make([]*v1beta1.Ingress, 0)
|
|
for _, item := range ti.ingressItems {
|
|
ingresses = append(ingresses, item.Ingress())
|
|
}
|
|
|
|
fakeClient := fake.NewSimpleClientset()
|
|
ingressSource, _ := NewIngressSource(
|
|
fakeClient,
|
|
ti.targetNamespace,
|
|
ti.annotationFilter,
|
|
ti.fqdnTemplate,
|
|
)
|
|
for _, ingress := range ingresses {
|
|
_, err := fakeClient.Extensions().Ingresses(ingress.Namespace).Create(ingress)
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
res, err := ingressSource.Endpoints()
|
|
if ti.expectError {
|
|
assert.Error(t, err)
|
|
} else {
|
|
assert.NoError(t, err)
|
|
}
|
|
|
|
validateEndpoints(t, res, ti.expected)
|
|
})
|
|
}
|
|
}
|
|
|
|
// ingress specific helper functions
|
|
type fakeIngress struct {
|
|
dnsnames []string
|
|
ips []string
|
|
hostnames []string
|
|
namespace string
|
|
name string
|
|
annotations map[string]string
|
|
}
|
|
|
|
func (ing fakeIngress) Ingress() *v1beta1.Ingress {
|
|
ingress := &v1beta1.Ingress{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Namespace: ing.namespace,
|
|
Name: ing.name,
|
|
Annotations: ing.annotations,
|
|
},
|
|
Spec: v1beta1.IngressSpec{
|
|
Rules: []v1beta1.IngressRule{},
|
|
},
|
|
Status: v1beta1.IngressStatus{
|
|
LoadBalancer: v1.LoadBalancerStatus{
|
|
Ingress: []v1.LoadBalancerIngress{},
|
|
},
|
|
},
|
|
}
|
|
for _, dnsname := range ing.dnsnames {
|
|
ingress.Spec.Rules = append(ingress.Spec.Rules, v1beta1.IngressRule{
|
|
Host: dnsname,
|
|
})
|
|
}
|
|
for _, ip := range ing.ips {
|
|
ingress.Status.LoadBalancer.Ingress = append(ingress.Status.LoadBalancer.Ingress, v1.LoadBalancerIngress{
|
|
IP: ip,
|
|
})
|
|
}
|
|
for _, hostname := range ing.hostnames {
|
|
ingress.Status.LoadBalancer.Ingress = append(ingress.Status.LoadBalancer.Ingress, v1.LoadBalancerIngress{
|
|
Hostname: hostname,
|
|
})
|
|
}
|
|
return ingress
|
|
}
|