external-dns/source/service_test.go
Kevin J. Qiu 71723bdd5b Allow specifying a custom TTL through annotation on Ingress or Service (#320)
* Add RecordTTL

* Route53: test for custom TTL

* Fix tests

* Fix remaining tests

* Add ttl when endpoint is created from ingress

* Missed a word

* Fix bad refactoring

* Add ingress custom TTL test

* gofmt

* Satisfy go-lint

* Unshadow `endpoint` in azure provider

* Fix and add an output test

* Add TTL for endpoints generated from service templates

* Take TTL into account when generating update plan

* Tests for TTL change impact on the plan

* Refactor factory method name

* Refactoring

* Run gofmt

* Make endpoint string format look like BIND config

* Update plan and plan_test

* Replace NewEndpointWithTTLValue with NewEndpointWithTTL in aws

* Remove NewEndpointWithTTLValue func

* Update references to TTL

* Remove getTTLValue func

* Handle merge conflict

* Update tests

* Update README, CHANGELOG and documentation

* Run gofmt

* Move getTTLFromAnnotations to a common file

* Refactor getTTLFromAnnotations

* Gofmt

* Add tests for getTTLFromAnnotations

* Trigger build

* Add boilerplate header

* Update README/CHANGELOG according to code review

* Add ttl.md and link it from README

* change CNAME string to endpoint.RecordTypeCNAME

* fix test cases with AWS ALIAS records, these do not behave different in these tests
2017-10-11 14:17:02 +02:00

788 lines
17 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 (
"net"
"testing"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes/fake"
"k8s.io/client-go/pkg/api/v1"
"github.com/kubernetes-incubator/external-dns/endpoint"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestServiceSource(t *testing.T) {
t.Run("Interface", testServiceSourceImplementsSource)
t.Run("NewServiceSource", testServiceSourceNewServiceSource)
t.Run("Endpoints", testServiceSourceEndpoints)
}
// testServiceSourceImplementsSource tests that serviceSource is a valid Source.
func testServiceSourceImplementsSource(t *testing.T) {
assert.Implements(t, (*Source)(nil), new(serviceSource))
}
// testServiceSourceNewServiceSource tests that NewServiceSource doesn't return an error.
func testServiceSourceNewServiceSource(t *testing.T) {
for _, ti := range []struct {
title 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",
},
} {
t.Run(ti.title, func(t *testing.T) {
_, err := NewServiceSource(
fake.NewSimpleClientset(),
"",
ti.fqdnTemplate,
"",
false,
)
if ti.expectError {
assert.Error(t, err)
} else {
assert.NoError(t, err)
}
})
}
}
// testServiceSourceEndpoints tests that various services generate the correct endpoints.
func testServiceSourceEndpoints(t *testing.T) {
for _, tc := range []struct {
title string
targetNamespace string
svcNamespace string
svcName string
svcType v1.ServiceType
compatibility string
fqdnTemplate string
labels map[string]string
annotations map[string]string
clusterIP string
lbs []string
expected []*endpoint.Endpoint
expectError bool
}{
{
"no annotated services return no endpoints",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{},
false,
},
{
"annotated services return an endpoint with target IP",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org.",
},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "1.2.3.4"},
},
false,
},
{
"annotated ClusterIp aren't processed without explicit authorization",
"",
"testing",
"foo",
v1.ServiceTypeClusterIP,
"",
"",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org.",
},
"1.2.3.4",
[]string{},
[]*endpoint.Endpoint{},
false,
},
{
"annotated services with multiple hostnames return an endpoint with target IP",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org., bar.example.org.",
},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "1.2.3.4"},
{DNSName: "bar.example.org", Target: "1.2.3.4"},
},
false,
},
{
"annotated services with multiple hostnames and without trailing period return an endpoint with target IP",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org, bar.example.org",
},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "1.2.3.4"},
{DNSName: "bar.example.org", Target: "1.2.3.4"},
},
false,
},
{
"annotated services return an endpoint with target hostname",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org.",
},
"",
[]string{"lb.example.com"}, // Kubernetes omits the trailing dot
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "lb.example.com"},
},
false,
},
{
"annotated services can omit trailing dot",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org", // Trailing dot is omitted
},
"",
[]string{"1.2.3.4", "lb.example.com"}, // Kubernetes omits the trailing dot
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "1.2.3.4"},
{DNSName: "foo.example.org", Target: "lb.example.com"},
},
false,
},
{
"our controller type is dns-controller",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{
controllerAnnotationKey: controllerAnnotationValue,
hostnameAnnotationKey: "foo.example.org.",
},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "1.2.3.4"},
},
false,
},
{
"different controller types are ignored even (with template specified)",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"{{.Name}}.ext-dns.test.com",
map[string]string{},
map[string]string{
controllerAnnotationKey: "some-other-tool",
hostnameAnnotationKey: "foo.example.org.",
},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{},
false,
},
{
"services are found in target namespace",
"testing",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org.",
},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "1.2.3.4"},
},
false,
},
{
"services that are not in target namespace are ignored",
"testing",
"other-testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org.",
},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{},
false,
},
{
"services are found in all namespaces",
"",
"other-testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org.",
},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "1.2.3.4"},
},
false,
},
{
"no external entrypoints return no endpoints",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org.",
},
"",
[]string{},
[]*endpoint.Endpoint{},
false,
},
{
"multiple external entrypoints return multiple endpoints",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org.",
},
"",
[]string{"1.2.3.4", "8.8.8.8"},
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "1.2.3.4"},
{DNSName: "foo.example.org", Target: "8.8.8.8"},
},
false,
},
{
"services annotated with legacy mate annotations are ignored in default mode",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{
"zalando.org/dnsname": "foo.example.org.",
},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{},
false,
},
{
"services annotated with legacy mate annotations return an endpoint in compatibility mode",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"mate",
"",
map[string]string{},
map[string]string{
"zalando.org/dnsname": "foo.example.org.",
},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "1.2.3.4"},
},
false,
},
{
"services annotated with legacy molecule annotations return an endpoint in compatibility mode",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"molecule",
"",
map[string]string{
"dns": "route53",
},
map[string]string{
"domainName": "foo.example.org., bar.example.org",
},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "1.2.3.4"},
{DNSName: "bar.example.org", Target: "1.2.3.4"},
},
false,
},
{
"not annotated services with set fqdnTemplate return an endpoint with target IP",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"{{.Name}}.bar.example.com",
map[string]string{},
map[string]string{},
"",
[]string{"1.2.3.4", "elb.com"},
[]*endpoint.Endpoint{
{DNSName: "foo.bar.example.com", Target: "1.2.3.4"},
{DNSName: "foo.bar.example.com", Target: "elb.com"},
},
false,
},
{
"annotated services with set fqdnTemplate annotation takes precedence",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"{{.Name}}.bar.example.com",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org.",
},
"",
[]string{"1.2.3.4", "elb.com"},
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "1.2.3.4"},
{DNSName: "foo.example.org", Target: "elb.com"},
},
false,
},
{
"compatibility annotated services with tmpl. compatibility takes precedence",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"mate",
"{{.Name}}.bar.example.com",
map[string]string{},
map[string]string{
"zalando.org/dnsname": "mate.example.org.",
},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{
{DNSName: "mate.example.org", Target: "1.2.3.4"},
},
false,
},
{
"not annotated services with unknown tmpl field should not return anything",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"{{.Calibre}}.bar.example.com",
map[string]string{},
map[string]string{},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{},
true,
},
{
"ttl not annotated should have RecordTTL.IsConfigured set to false",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org.",
},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "1.2.3.4", RecordTTL: endpoint.TTL(0)},
},
false,
},
{
"ttl annotated but invalid should have RecordTTL.IsConfigured set to false",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org.",
ttlAnnotationKey: "foo",
},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "1.2.3.4", RecordTTL: endpoint.TTL(0)},
},
false,
},
{
"ttl annotated and is valid should set Record.TTL",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org.",
ttlAnnotationKey: "10",
},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "1.2.3.4", RecordTTL: endpoint.TTL(10)},
},
false,
},
{
"Negative ttl is not valid",
"",
"testing",
"foo",
v1.ServiceTypeLoadBalancer,
"",
"",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org.",
ttlAnnotationKey: "-10",
},
"",
[]string{"1.2.3.4"},
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "1.2.3.4", RecordTTL: endpoint.TTL(0)},
},
false,
},
} {
t.Run(tc.title, func(t *testing.T) {
// Create a Kubernetes testing client
kubernetes := fake.NewSimpleClientset()
// Create a service to test against
ingresses := []v1.LoadBalancerIngress{}
for _, lb := range tc.lbs {
if net.ParseIP(lb) != nil {
ingresses = append(ingresses, v1.LoadBalancerIngress{IP: lb})
} else {
ingresses = append(ingresses, v1.LoadBalancerIngress{Hostname: lb})
}
}
service := &v1.Service{
Spec: v1.ServiceSpec{
Type: tc.svcType,
ClusterIP: tc.clusterIP,
},
ObjectMeta: metav1.ObjectMeta{
Namespace: tc.svcNamespace,
Name: tc.svcName,
Labels: tc.labels,
Annotations: tc.annotations,
},
Status: v1.ServiceStatus{
LoadBalancer: v1.LoadBalancerStatus{
Ingress: ingresses,
},
},
}
_, err := kubernetes.CoreV1().Services(service.Namespace).Create(service)
require.NoError(t, err)
// Create our object under test and get the endpoints.
client, _ := NewServiceSource(
kubernetes,
tc.targetNamespace,
tc.fqdnTemplate,
tc.compatibility,
false,
)
require.NoError(t, err)
endpoints, err := client.Endpoints()
if tc.expectError {
require.Error(t, err)
} else {
require.NoError(t, err)
}
// Validate returned endpoints against desired endpoints.
validateEndpoints(t, endpoints, tc.expected)
})
}
}
// testServiceSourceEndpoints tests that various services generate the correct endpoints.
func TestClusterIpServices(t *testing.T) {
for _, tc := range []struct {
title string
targetNamespace string
svcNamespace string
svcName string
svcType v1.ServiceType
compatibility string
fqdnTemplate string
labels map[string]string
annotations map[string]string
clusterIP string
lbs []string
expected []*endpoint.Endpoint
expectError bool
}{
{
"annotated ClusterIp services return an endpoint with Cluster IP",
"",
"testing",
"foo",
v1.ServiceTypeClusterIP,
"",
"",
map[string]string{},
map[string]string{
hostnameAnnotationKey: "foo.example.org.",
},
"1.2.3.4",
[]string{},
[]*endpoint.Endpoint{
{DNSName: "foo.example.org", Target: "1.2.3.4"},
},
false,
},
{
"non-annotated ClusterIp services with set fqdnTemplate return an endpoint with target IP",
"",
"testing",
"foo",
v1.ServiceTypeClusterIP,
"",
"{{.Name}}.bar.example.com",
map[string]string{},
map[string]string{},
"4.5.6.7",
[]string{},
[]*endpoint.Endpoint{
{DNSName: "foo.bar.example.com", Target: "4.5.6.7"},
},
false,
},
{
"Headless services do not generate endpoints",
"",
"testing",
"foo",
v1.ServiceTypeClusterIP,
"",
"",
map[string]string{},
map[string]string{},
v1.ClusterIPNone,
[]string{},
[]*endpoint.Endpoint{},
false,
},
} {
t.Run(tc.title, func(t *testing.T) {
// Create a Kubernetes testing client
kubernetes := fake.NewSimpleClientset()
// Create a service to test against
ingresses := []v1.LoadBalancerIngress{}
for _, lb := range tc.lbs {
if net.ParseIP(lb) != nil {
ingresses = append(ingresses, v1.LoadBalancerIngress{IP: lb})
} else {
ingresses = append(ingresses, v1.LoadBalancerIngress{Hostname: lb})
}
}
service := &v1.Service{
Spec: v1.ServiceSpec{
Type: tc.svcType,
ClusterIP: tc.clusterIP,
},
ObjectMeta: metav1.ObjectMeta{
Namespace: tc.svcNamespace,
Name: tc.svcName,
Labels: tc.labels,
Annotations: tc.annotations,
},
Status: v1.ServiceStatus{
LoadBalancer: v1.LoadBalancerStatus{
Ingress: ingresses,
},
},
}
_, err := kubernetes.CoreV1().Services(service.Namespace).Create(service)
require.NoError(t, err)
// Create our object under test and get the endpoints.
client, _ := NewServiceSource(
kubernetes,
tc.targetNamespace,
tc.fqdnTemplate,
tc.compatibility,
true,
)
require.NoError(t, err)
endpoints, err := client.Endpoints()
if tc.expectError {
require.Error(t, err)
} else {
require.NoError(t, err)
}
// Validate returned endpoints against desired endpoints.
validateEndpoints(t, endpoints, tc.expected)
})
}
}
func BenchmarkServiceEndpoints(b *testing.B) {
kubernetes := fake.NewSimpleClientset()
service := &v1.Service{
ObjectMeta: metav1.ObjectMeta{
Namespace: "testing",
Name: "foo",
Annotations: map[string]string{
hostnameAnnotationKey: "foo.example.org.",
},
},
Status: v1.ServiceStatus{
LoadBalancer: v1.LoadBalancerStatus{
Ingress: []v1.LoadBalancerIngress{
{IP: "1.2.3.4"},
{IP: "8.8.8.8"},
},
},
},
}
_, err := kubernetes.CoreV1().Services(service.Namespace).Create(service)
require.NoError(b, err)
client, err := NewServiceSource(kubernetes, v1.NamespaceAll, "", "", false)
require.NoError(b, err)
for i := 0; i < b.N; i++ {
_, err := client.Endpoints()
require.NoError(b, err)
}
}