Ignore unknown provider specific properties

endpoint/provider_specific_property_filter.go

@@ -0,0 +1,61 @@
+/*
+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 endpoint
+
+import (
+	"strings"
+
+	log "github.com/sirupsen/logrus"
+)
+
+type ProviderSpecificPropertyFilter struct {
+	// Names of the provider specific properties to match
+	Names []string
+	// Prefixes of the provider specific properties to match
+	Prefixes []string
+}
+
+// Match checks whether a ProviderSpecificProperty.Name can be found in the
+// ProviderSpecificPropertyFilter.
+func (pf ProviderSpecificPropertyFilter) Match(name string) bool {
+	for _, pfName := range pf.Names {
+		if pfName == name {
+			return true
+		}
+	}
+	for _, prefix := range pf.Prefixes {
+		if strings.HasPrefix(name, prefix) {
+			return true
+		}
+	}
+	return false
+}
+
+// Filter removes all ProviderSpecificProperty's that don't match from every endpoint.
+func (pf ProviderSpecificPropertyFilter) Filter(endpoints []*Endpoint) {
+	for _, ep := range endpoints {
+		for _, providerSpecific := range ep.ProviderSpecific {
+			if !pf.Match(providerSpecific.Name) {
+				log.WithFields(log.Fields{
+					"dnsName": ep.DNSName,
+					"targets": ep.Targets,
+				}).Debugf("Provider specific property ignored by provider: %s", providerSpecific.Name)
+				ep.DeleteProviderSpecificProperty(providerSpecific.Name)
+			}
+		}
+	}
+}

endpoint/provider_specific_property_filter_test.go

@@ -0,0 +1,175 @@
+/*
+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 endpoint
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+type providerSpecificPropertyFilterTest struct {
+	names             []string
+	prefixes          []string
+	endpoints         []*Endpoint
+	expectedEndpoints []*Endpoint
+}
+
+var providerSpecificPropertyFilterTests = []providerSpecificPropertyFilterTest{
+	// 0. No Names or Prefixes
+	{
+		[]string{},
+		[]string{},
+		[]*Endpoint{
+			{
+				DNSName: "a.example.com",
+				ProviderSpecific: []ProviderSpecificProperty{
+					{Name: "prefix1/name1"},
+					{Name: "name1"},
+				},
+			},
+			{
+				DNSName: "b.example.com",
+				ProviderSpecific: []ProviderSpecificProperty{
+					{Name: "prefix2/name1"},
+					{Name: "name2"},
+				},
+			},
+		},
+		[]*Endpoint{
+			{
+				DNSName:          "a.example.com",
+				ProviderSpecific: []ProviderSpecificProperty{},
+			},
+			{
+				DNSName:          "b.example.com",
+				ProviderSpecific: []ProviderSpecificProperty{},
+			},
+		},
+	},
+	// 1. Only Names
+	{
+		[]string{"name1", "name2"},
+		[]string{},
+		[]*Endpoint{
+			{
+				DNSName: "a.example.com",
+				ProviderSpecific: []ProviderSpecificProperty{
+					{Name: "name1"},
+					{Name: "name2"},
+					{Name: "name3"},
+					{Name: "prefix1/name1"},
+				},
+			},
+		},
+		[]*Endpoint{
+			{
+				DNSName: "a.example.com",
+				ProviderSpecific: []ProviderSpecificProperty{
+					{Name: "name1"},
+					{Name: "name2"},
+				},
+			},
+		},
+	},
+	// 2. Only Prefixes
+	{
+		[]string{},
+		[]string{"prefix1/", "prefix2"},
+		[]*Endpoint{
+			{
+				DNSName: "a.example.com",
+				ProviderSpecific: []ProviderSpecificProperty{
+					{Name: "prefix1/foo"},
+					{Name: "prefix1-bar"},
+					{Name: "prefix2"},
+					{Name: "prefix3"},
+				},
+			},
+		},
+		[]*Endpoint{
+			{
+				DNSName: "a.example.com",
+				ProviderSpecific: []ProviderSpecificProperty{
+					{Name: "prefix1/foo"},
+					{Name: "prefix2"},
+				},
+			},
+		},
+	},
+	// 3. No Endpoints
+	{
+		[]string{"name1"},
+		[]string{"prefix1/"},
+		[]*Endpoint{},
+		[]*Endpoint{},
+	},
+	// 4. Both Names and Prefixes
+	{
+		[]string{"name1"},
+		[]string{"prefix1/"},
+		[]*Endpoint{
+			{
+				DNSName: "a.example.com",
+				ProviderSpecific: []ProviderSpecificProperty{
+					{Name: "prefix1/property"},
+					{Name: "prefix2/property"},
+					{Name: "name10"},
+				},
+			},
+			{
+				DNSName: "b.example.com",
+				ProviderSpecific: []ProviderSpecificProperty{
+					{Name: "prefix1/property"},
+					{Name: "name1"},
+					{Name: "name2"},
+				},
+			},
+		},
+		[]*Endpoint{
+			{
+				DNSName: "a.example.com",
+				ProviderSpecific: []ProviderSpecificProperty{
+					{Name: "prefix1/property"},
+				},
+			},
+			{
+				DNSName: "b.example.com",
+				ProviderSpecific: []ProviderSpecificProperty{
+					{Name: "prefix1/property"},
+					{Name: "name1"},
+				},
+			},
+		},
+	},
+}
+
+func TestPropertyFilter(t *testing.T) {
+	for i, tt := range providerSpecificPropertyFilterTests {
+		t.Run(fmt.Sprintf("%d", i), func(t *testing.T) {
+			propertyFilter := ProviderSpecificPropertyFilter{
+				Names:    tt.names,
+				Prefixes: tt.prefixes,
+			}
+
+			propertyFilter.Filter(tt.endpoints)
+
+			assert.Equal(t, tt.expectedEndpoints, tt.endpoints)
+		})
+	}
+}

provider/aws/aws.go

@@ -64,6 +64,11 @@ const (
 	sameZoneAlias                              = "same-zone"
 )
 
+var awsProviderSpecificPropertyFilter = endpoint.ProviderSpecificPropertyFilter{
+	Names:    []string{providerSpecificAlias},
+	Prefixes: []string{"aws/"},
+}
+
 // see: https://docs.aws.amazon.com/general/latest/gr/elb.html
 var canonicalHostedZones = map[string]string{
 	// Application Load Balancers and Classic Load Balancers
@@ -296,6 +301,9 @@ func NewAWSProvider(awsConfig AWSConfig, clients map[string]Route53API) (*AWSPro
 		dryRun:                awsConfig.DryRun,
 		zonesCache:            &zonesListCache{duration: awsConfig.ZoneCacheDuration},
 		failedChangesQueue:    make(map[string]Route53Changes),
+		BaseProvider: provider.BaseProvider{
+			ProviderSpecificPropertyFilter: awsProviderSpecificPropertyFilter,
+		},
 	}
 
 	return provider, nil
@@ -749,6 +757,11 @@ func (p *AWSProvider) newChanges(action route53types.ChangeAction, endpoints []*
 // Example: CNAME endpoints pointing to ELBs will have a `alias` provider-specific property
 // added to match the endpoints generated from existing alias records in Route53.
 func (p *AWSProvider) AdjustEndpoints(endpoints []*endpoint.Endpoint) ([]*endpoint.Endpoint, error) {
+	endpoints, err := p.BaseProvider.AdjustEndpoints(endpoints)
+	if err != nil {
+		return endpoints, err
+	}
+
 	for _, ep := range endpoints {
 		alias := false
 

provider/aws/aws_test.go

@@ -568,6 +568,7 @@ func TestAWSAdjustEndpoints(t *testing.T) {
 		endpoint.NewEndpoint("cname-test-elb-no-alias.zone-2.ext-dns-test-2.teapot.zalan.do", endpoint.RecordTypeCNAME, "foo.eu-central-1.elb.amazonaws.com").WithProviderSpecific(providerSpecificAlias, "false"),
 		endpoint.NewEndpoint("cname-test-elb-no-eth.ext-dns-test-2.teapot.zalan.do", endpoint.RecordTypeCNAME, "foo.eu-central-1.elb.amazonaws.com").WithProviderSpecific(providerSpecificEvaluateTargetHealth, "false"), // eth = evaluate target health
 		endpoint.NewEndpoint("cname-test-elb-alias.zone-2.ext-dns-test-2.teapot.zalan.do", endpoint.RecordTypeCNAME, "foo.eu-central-1.elb.amazonaws.com").WithProviderSpecific(providerSpecificAlias, "true").WithProviderSpecific(providerSpecificEvaluateTargetHealth, "true"),
+		endpoint.NewEndpoint("a-test-other-provider-specific.zone-1.ext-dns-test-2.teapot.zalan.do", endpoint.RecordTypeA, "8.8.8.8").WithProviderSpecific(providerSpecificAlias, "true").WithProviderSpecific(providerSpecificEvaluateTargetHealth, "true").WithProviderSpecific("external-dns.alpha.kubernetes.io/cloudflare-proxied", "false"),
 	}
 
 	records, err := provider.AdjustEndpoints(records)
@@ -581,6 +582,7 @@ func TestAWSAdjustEndpoints(t *testing.T) {
 		endpoint.NewEndpoint("cname-test-elb-no-alias.zone-2.ext-dns-test-2.teapot.zalan.do", endpoint.RecordTypeCNAME, "foo.eu-central-1.elb.amazonaws.com").WithProviderSpecific(providerSpecificAlias, "false"),
 		endpoint.NewEndpoint("cname-test-elb-no-eth.ext-dns-test-2.teapot.zalan.do", endpoint.RecordTypeA, "foo.eu-central-1.elb.amazonaws.com").WithProviderSpecific(providerSpecificAlias, "true").WithProviderSpecific(providerSpecificEvaluateTargetHealth, "false"), // eth = evaluate target health
 		endpoint.NewEndpoint("cname-test-elb-alias.zone-2.ext-dns-test-2.teapot.zalan.do", endpoint.RecordTypeA, "foo.eu-central-1.elb.amazonaws.com").WithProviderSpecific(providerSpecificAlias, "true").WithProviderSpecific(providerSpecificEvaluateTargetHealth, "true"),
+		endpoint.NewEndpoint("a-test-other-provider-specific.zone-1.ext-dns-test-2.teapot.zalan.do", endpoint.RecordTypeA, "8.8.8.8").WithProviderSpecific(providerSpecificAlias, "true").WithProviderSpecific(providerSpecificEvaluateTargetHealth, "true"),
 	})
 }
 
@@ -1970,6 +1972,9 @@ func newAWSProviderWithTagFilter(t *testing.T, domainFilter endpoint.DomainFilte
 		dryRun:                false,
 		zonesCache:            &zonesListCache{duration: 1 * time.Minute},
 		failedChangesQueue:    make(map[string]Route53Changes),
+		BaseProvider: provider.BaseProvider{
+			ProviderSpecificPropertyFilter: awsProviderSpecificPropertyFilter,
+		},
 	}
 
 	createAWSZone(t, provider, &route53types.HostedZone{

provider/cloudflare/cloudflare.go

@@ -43,8 +43,13 @@ const (
 	cloudFlareUpdate = "UPDATE"
 	// defaultCloudFlareRecordTTL 1 = automatic
 	defaultCloudFlareRecordTTL = 1
+	providerSpecificProxied    = "external-dns.alpha.kubernetes.io/cloudflare-proxied"
 )
 
+var cloudflareProviderSpecificPropertyFilter = endpoint.ProviderSpecificPropertyFilter{
+	Names: []string{providerSpecificProxied},
+}
+
 // We have to use pointers to bools now, as the upstream cloudflare-go library requires them
 // see: https://github.com/cloudflare/cloudflare-go/pull/595
 
@@ -210,6 +215,9 @@ func NewCloudFlareProvider(domainFilter endpoint.DomainFilter, zoneIDFilter prov
 		DryRun:            dryRun,
 		DNSRecordsPerPage: dnsRecordsPerPage,
 		RegionKey:         regionKey,
+		BaseProvider: provider.BaseProvider{
+			ProviderSpecificPropertyFilter: cloudflareProviderSpecificPropertyFilter,
+		},
 	}
 	return provider, nil
 }
@@ -416,6 +424,11 @@ func (p *CloudFlareProvider) submitChanges(ctx context.Context, changes []*cloud
 
 // AdjustEndpoints modifies the endpoints as needed by the specific provider
 func (p *CloudFlareProvider) AdjustEndpoints(endpoints []*endpoint.Endpoint) ([]*endpoint.Endpoint, error) {
+	endpoints, err := p.BaseProvider.AdjustEndpoints(endpoints)
+	if err != nil {
+		return endpoints, err
+	}
+
 	adjustedEndpoints := []*endpoint.Endpoint{}
 	for _, e := range endpoints {
 		proxied := shouldBeProxied(e, p.proxiedByDefault)