mirror of
https://github.com/kubernetes-sigs/external-dns.git
synced 2026-04-19 15:01:34 +02:00
e3d8983ed4
* feat: Add Azure DNS metadata (tags) support * fix: address PR review comments for Azure metadata support * test: add Azure metadata annotation test cases and fix prefix initialization * Replace azure-metadata-* annotations with azure-tags * refactor: move Azure tags parsing to provider package Move provider-specific Azure tags annotation parsing from source/annotations to provider/azure, following the same pattern as Cloudflare tags handling. * fix: use GetProviderSpecificProperty and handle duplicate tags * fix: align with upstream Go 1.26 migration and short-form property names
467 lines
15 KiB
Go
467 lines
15 KiB
Go
/*
|
|
Copyright 2025 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 annotations
|
|
|
|
import (
|
|
"os"
|
|
"strconv"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
"sigs.k8s.io/external-dns/endpoint"
|
|
)
|
|
|
|
func TestMain(m *testing.M) {
|
|
// Initialize annotation prefixes before running tests
|
|
SetAnnotationPrefix(DefaultAnnotationPrefix)
|
|
os.Exit(m.Run())
|
|
}
|
|
|
|
func TestProviderSpecificAnnotations(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
annotations map[string]string
|
|
expected endpoint.ProviderSpecific
|
|
setIdentifier string
|
|
}{
|
|
{
|
|
name: "no annotations",
|
|
annotations: map[string]string{},
|
|
expected: endpoint.ProviderSpecific{},
|
|
setIdentifier: "",
|
|
},
|
|
{
|
|
name: "Cloudflare proxied annotation",
|
|
annotations: map[string]string{
|
|
CloudflareProxiedKey: "true",
|
|
},
|
|
expected: endpoint.ProviderSpecific{
|
|
{Name: CloudflareProxiedKey, Value: "true"},
|
|
},
|
|
setIdentifier: "",
|
|
},
|
|
{
|
|
name: "Cloudflare custom hostname annotation",
|
|
annotations: map[string]string{
|
|
CloudflareCustomHostnameKey: "custom.example.com",
|
|
},
|
|
expected: endpoint.ProviderSpecific{
|
|
{Name: CloudflareCustomHostnameKey, Value: "custom.example.com"},
|
|
},
|
|
setIdentifier: "",
|
|
},
|
|
{
|
|
name: "AWS annotation",
|
|
annotations: map[string]string{
|
|
"external-dns.alpha.kubernetes.io/aws-weight": "100",
|
|
},
|
|
expected: endpoint.ProviderSpecific{
|
|
{Name: "aws/weight", Value: "100"},
|
|
},
|
|
setIdentifier: "",
|
|
},
|
|
{
|
|
name: "CoreDNS annotation",
|
|
annotations: map[string]string{
|
|
"external-dns.alpha.kubernetes.io/coredns-group": "g1",
|
|
},
|
|
expected: endpoint.ProviderSpecific{
|
|
{Name: "coredns/group", Value: "g1"},
|
|
},
|
|
setIdentifier: "",
|
|
},
|
|
{
|
|
name: "Azure tags annotation",
|
|
annotations: map[string]string{
|
|
AzureTagsKey: "cost-center=12345,owner=backend-team",
|
|
},
|
|
expected: endpoint.ProviderSpecific{
|
|
{Name: "azure/tags", Value: "cost-center=12345,owner=backend-team"},
|
|
},
|
|
setIdentifier: "",
|
|
},
|
|
{
|
|
name: "Azure tags annotation with spaces",
|
|
annotations: map[string]string{
|
|
AzureTagsKey: "environment=production, app=myapp ",
|
|
},
|
|
expected: endpoint.ProviderSpecific{
|
|
{Name: "azure/tags", Value: "environment=production, app=myapp "},
|
|
},
|
|
setIdentifier: "",
|
|
},
|
|
{
|
|
name: "Set identifier annotation",
|
|
annotations: map[string]string{
|
|
SetIdentifierKey: "identifier",
|
|
},
|
|
expected: endpoint.ProviderSpecific{},
|
|
setIdentifier: "identifier",
|
|
},
|
|
{
|
|
name: "Record type annotation",
|
|
annotations: map[string]string{
|
|
RecordTypeKey: "ptr",
|
|
},
|
|
expected: endpoint.ProviderSpecific{
|
|
{Name: endpoint.ProviderSpecificRecordType, Value: "ptr"},
|
|
},
|
|
setIdentifier: "",
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
result, setIdentifier := ProviderSpecificAnnotations(tt.annotations)
|
|
assert.Equal(t, tt.expected, result)
|
|
assert.Equal(t, tt.setIdentifier, setIdentifier)
|
|
|
|
for _, prop := range result {
|
|
slashIdx := strings.Index(prop.Name, "/")
|
|
if slashIdx == -1 || strings.HasPrefix(prop.Name, CloudflarePrefix) {
|
|
continue
|
|
}
|
|
assert.NotContains(t, prop.Name[:slashIdx], ".",
|
|
"property %q uses a full annotation name; only cloudflare is allowed to — use the short \"provider/attr\" form instead", prop.Name)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestGetProviderSpecificCloudflareAnnotations(t *testing.T) {
|
|
|
|
for _, tc := range []struct {
|
|
title string
|
|
annotations map[string]string
|
|
expectedKey string
|
|
expectedValue string
|
|
}{
|
|
{
|
|
title: "Cloudflare tags annotation is set correctly",
|
|
annotations: map[string]string{CloudflareTagsKey: "env:test,owner:team-a"},
|
|
expectedKey: CloudflareTagsKey,
|
|
expectedValue: "env:test,owner:team-a",
|
|
},
|
|
{
|
|
title: "Cloudflare tags annotation among another annotations is set correctly",
|
|
annotations: map[string]string{
|
|
"random annotation 1": "random value 1",
|
|
CloudflareTagsKey: "env:test,owner:team-b",
|
|
"random annotation 2": "random value 2"},
|
|
expectedKey: CloudflareTagsKey,
|
|
expectedValue: "env:test,owner:team-b",
|
|
},
|
|
} {
|
|
t.Run(tc.title, func(t *testing.T) {
|
|
providerSpecificAnnotations, _ := ProviderSpecificAnnotations(tc.annotations)
|
|
for _, providerSpecificAnnotation := range providerSpecificAnnotations {
|
|
if providerSpecificAnnotation.Name == tc.expectedKey {
|
|
assert.Equal(t, tc.expectedValue, providerSpecificAnnotation.Value)
|
|
return
|
|
}
|
|
}
|
|
t.Errorf("Cloudflare provider specific annotation %s is not set correctly to %s", tc.expectedKey, tc.expectedValue)
|
|
})
|
|
}
|
|
|
|
for _, tc := range []struct {
|
|
title string
|
|
annotations map[string]string
|
|
expectedKey string
|
|
expectedValue bool
|
|
}{
|
|
{
|
|
title: "Cloudflare proxied annotation is set correctly to true",
|
|
annotations: map[string]string{CloudflareProxiedKey: "true"},
|
|
expectedKey: CloudflareProxiedKey,
|
|
expectedValue: true,
|
|
},
|
|
{
|
|
title: "Cloudflare proxied annotation is set correctly to false",
|
|
annotations: map[string]string{CloudflareProxiedKey: "false"},
|
|
expectedKey: CloudflareProxiedKey,
|
|
expectedValue: false,
|
|
},
|
|
{
|
|
title: "Cloudflare proxied annotation among another annotations is set correctly to true",
|
|
annotations: map[string]string{
|
|
"random annotation 1": "random value 1",
|
|
CloudflareProxiedKey: "false",
|
|
"random annotation 2": "random value 2",
|
|
},
|
|
expectedKey: CloudflareProxiedKey,
|
|
expectedValue: false,
|
|
},
|
|
} {
|
|
t.Run(tc.title, func(t *testing.T) {
|
|
providerSpecificAnnotations, _ := ProviderSpecificAnnotations(tc.annotations)
|
|
for _, providerSpecificAnnotation := range providerSpecificAnnotations {
|
|
if providerSpecificAnnotation.Name == tc.expectedKey {
|
|
assert.Equal(t, strconv.FormatBool(tc.expectedValue), providerSpecificAnnotation.Value)
|
|
return
|
|
}
|
|
}
|
|
t.Errorf("Cloudflare provider specific annotation %s is not set correctly to %v", tc.expectedKey, tc.expectedValue)
|
|
})
|
|
}
|
|
|
|
for _, tc := range []struct {
|
|
title string
|
|
annotations map[string]string
|
|
expectedKey string
|
|
expectedValue string
|
|
}{
|
|
{
|
|
title: "Cloudflare region key annotation is set correctly",
|
|
annotations: map[string]string{CloudflareRegionKey: "us"},
|
|
expectedKey: CloudflareRegionKey,
|
|
expectedValue: "us",
|
|
},
|
|
{
|
|
title: "Cloudflare region key annotation among another annotations is set correctly",
|
|
annotations: map[string]string{
|
|
"random annotation 1": "random value 1",
|
|
CloudflareRegionKey: "us",
|
|
"random annotation 2": "random value 2",
|
|
},
|
|
expectedKey: CloudflareRegionKey,
|
|
expectedValue: "us",
|
|
},
|
|
{
|
|
title: "Cloudflare DNS record comment annotation is set correctly",
|
|
annotations: map[string]string{
|
|
CloudflareRecordCommentKey: "comment",
|
|
},
|
|
expectedKey: CloudflareRecordCommentKey,
|
|
expectedValue: "comment",
|
|
},
|
|
} {
|
|
t.Run(tc.title, func(t *testing.T) {
|
|
providerSpecificAnnotations, _ := ProviderSpecificAnnotations(tc.annotations)
|
|
for _, providerSpecificAnnotation := range providerSpecificAnnotations {
|
|
if providerSpecificAnnotation.Name == tc.expectedKey {
|
|
assert.Equal(t, tc.expectedValue, providerSpecificAnnotation.Value)
|
|
return
|
|
}
|
|
}
|
|
t.Errorf("Cloudflare provider specific annotation %s is not set correctly to %v", tc.expectedKey, tc.expectedValue)
|
|
})
|
|
}
|
|
|
|
for _, tc := range []struct {
|
|
title string
|
|
annotations map[string]string
|
|
expectedKey string
|
|
expectedValue string
|
|
}{
|
|
{
|
|
title: "Cloudflare custom hostname annotation is set correctly",
|
|
annotations: map[string]string{CloudflareCustomHostnameKey: "a.foo.fancybar.com"},
|
|
expectedKey: CloudflareCustomHostnameKey,
|
|
expectedValue: "a.foo.fancybar.com",
|
|
},
|
|
{
|
|
title: "Cloudflare custom hostname annotation among another annotations is set correctly",
|
|
annotations: map[string]string{
|
|
"random annotation 1": "random value 1",
|
|
CloudflareCustomHostnameKey: "a.foo.fancybar.com",
|
|
"random annotation 2": "random value 2"},
|
|
expectedKey: CloudflareCustomHostnameKey,
|
|
expectedValue: "a.foo.fancybar.com",
|
|
},
|
|
} {
|
|
t.Run(tc.title, func(t *testing.T) {
|
|
providerSpecificAnnotations, _ := ProviderSpecificAnnotations(tc.annotations)
|
|
for _, providerSpecificAnnotation := range providerSpecificAnnotations {
|
|
if providerSpecificAnnotation.Name == tc.expectedKey {
|
|
assert.Equal(t, tc.expectedValue, providerSpecificAnnotation.Value)
|
|
return
|
|
}
|
|
}
|
|
t.Errorf("Cloudflare provider specific annotation %s is not set correctly to %s", tc.expectedKey, tc.expectedValue)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestGetProviderSpecificAliasAnnotations(t *testing.T) {
|
|
for _, tc := range []struct {
|
|
title string
|
|
annotations map[string]string
|
|
expectedKey string
|
|
expectedValue bool
|
|
}{
|
|
{
|
|
title: "alias annotation is set correctly to true",
|
|
annotations: map[string]string{AliasKey: "true"},
|
|
expectedKey: AliasKey,
|
|
expectedValue: true,
|
|
},
|
|
{
|
|
title: "alias annotation among another annotations is set correctly to true",
|
|
annotations: map[string]string{
|
|
"random annotation 1": "random value 1",
|
|
AliasKey: "true",
|
|
"random annotation 2": "random value 2",
|
|
},
|
|
expectedKey: AliasKey,
|
|
expectedValue: true,
|
|
},
|
|
} {
|
|
t.Run(tc.title, func(t *testing.T) {
|
|
providerSpecificAnnotations, _ := ProviderSpecificAnnotations(tc.annotations)
|
|
for _, providerSpecificAnnotation := range providerSpecificAnnotations {
|
|
if providerSpecificAnnotation.Name == "alias" {
|
|
assert.Equal(t, strconv.FormatBool(tc.expectedValue), providerSpecificAnnotation.Value)
|
|
return
|
|
}
|
|
}
|
|
t.Errorf("provider specific annotation alias is not set correctly to %v", tc.expectedValue)
|
|
})
|
|
}
|
|
|
|
for _, tc := range []struct {
|
|
title string
|
|
annotations map[string]string
|
|
}{
|
|
{
|
|
title: "alias annotation is set to false",
|
|
annotations: map[string]string{AliasKey: "false"},
|
|
},
|
|
{
|
|
title: "alias annotation is not set",
|
|
annotations: map[string]string{
|
|
"random annotation 1": "random value 1",
|
|
"random annotation 2": "random value 2",
|
|
},
|
|
},
|
|
} {
|
|
t.Run(tc.title, func(t *testing.T) {
|
|
providerSpecificAnnotations, _ := ProviderSpecificAnnotations(tc.annotations)
|
|
for _, providerSpecificAnnotation := range providerSpecificAnnotations {
|
|
if providerSpecificAnnotation.Name == "alias" {
|
|
t.Error("provider specific annotation alias is not expected to be set")
|
|
}
|
|
}
|
|
|
|
})
|
|
}
|
|
}
|
|
|
|
// TestProviderSpecificPropertyNameConvention enforces that only Cloudflare may
|
|
// emit the full annotation name (e.g. "external-dns.alpha.kubernetes.io/cloudflare-proxied")
|
|
// as a property name. All other providers must normalise to the short "provider/attr" form
|
|
// (e.g. "aws/weight"). If a new provider (e.g. azure-, ovh-) is added but accidentally
|
|
// outputs the full annotation name, this test will catch it.
|
|
func TestProviderSpecificPropertyNameConvention(t *testing.T) {
|
|
annotations := map[string]string{
|
|
AnnotationKeyPrefix + "aws-weight": "10",
|
|
AnnotationKeyPrefix + "scw-something": "val",
|
|
AnnotationKeyPrefix + "webhook-something": "val",
|
|
AnnotationKeyPrefix + "coredns-group": "g1",
|
|
CloudflareProxiedKey: "true",
|
|
CloudflareTagsKey: "tag1",
|
|
CloudflareRegionKey: "us",
|
|
CloudflareRecordCommentKey: "comment",
|
|
CloudflareCustomHostnameKey: "host.example.com",
|
|
AliasKey: "true",
|
|
}
|
|
|
|
props, _ := ProviderSpecificAnnotations(annotations)
|
|
for _, prop := range props {
|
|
name := prop.Name
|
|
providerSegment, _, ok := strings.Cut(name, "/")
|
|
if !ok {
|
|
// No slash: provider-agnostic property (e.g. "alias") — always OK.
|
|
continue
|
|
}
|
|
// Cloudflare exception: retains the full annotation name.
|
|
if strings.HasPrefix(name, CloudflarePrefix) {
|
|
continue
|
|
}
|
|
// All other providers must use the short "provider/attr" form.
|
|
// The segment before "/" must be a plain word with no dots.
|
|
assert.NotContains(t, providerSegment, ".",
|
|
"property %q uses a full annotation name; only cloudflare is allowed to — use the short \"provider/attr\" form instead", name)
|
|
}
|
|
}
|
|
|
|
func TestGetProviderSpecificIdentifierAnnotations(t *testing.T) {
|
|
for _, tc := range []struct {
|
|
title string
|
|
annotations map[string]string
|
|
expectedResult map[string]string
|
|
expectedIdentifier string
|
|
}{
|
|
{
|
|
title: "aws- provider specific annotations are set correctly",
|
|
annotations: map[string]string{
|
|
"external-dns.alpha.kubernetes.io/aws-annotation-1": "value 1",
|
|
SetIdentifierKey: "id1",
|
|
"external-dns.alpha.kubernetes.io/aws-annotation-2": "value 2",
|
|
},
|
|
expectedResult: map[string]string{
|
|
"aws/annotation-1": "value 1",
|
|
"aws/annotation-2": "value 2",
|
|
},
|
|
expectedIdentifier: "id1",
|
|
},
|
|
{
|
|
title: "scw- provider specific annotations are set correctly",
|
|
annotations: map[string]string{
|
|
"external-dns.alpha.kubernetes.io/scw-annotation-1": "value 1",
|
|
SetIdentifierKey: "id1",
|
|
"external-dns.alpha.kubernetes.io/scw-annotation-2": "value 2",
|
|
},
|
|
expectedResult: map[string]string{
|
|
"scw/annotation-1": "value 1",
|
|
"scw/annotation-2": "value 2",
|
|
},
|
|
expectedIdentifier: "id1",
|
|
},
|
|
{
|
|
title: "webhook- provider specific annotations are set correctly",
|
|
annotations: map[string]string{
|
|
"external-dns.alpha.kubernetes.io/webhook-annotation-1": "value 1",
|
|
SetIdentifierKey: "id1",
|
|
"external-dns.alpha.kubernetes.io/webhook-annotation-2": "value 2",
|
|
},
|
|
expectedResult: map[string]string{
|
|
"webhook/annotation-1": "value 1",
|
|
"webhook/annotation-2": "value 2",
|
|
},
|
|
expectedIdentifier: "id1",
|
|
},
|
|
} {
|
|
t.Run(tc.title, func(t *testing.T) {
|
|
providerSpecificAnnotations, identifier := ProviderSpecificAnnotations(tc.annotations)
|
|
assert.Equal(t, tc.expectedIdentifier, identifier)
|
|
for expectedAnnotationKey, expectedAnnotationValue := range tc.expectedResult {
|
|
expectedResultFound := false
|
|
for _, providerSpecificAnnotation := range providerSpecificAnnotations {
|
|
if providerSpecificAnnotation.Name == expectedAnnotationKey {
|
|
assert.Equal(t, expectedAnnotationValue, providerSpecificAnnotation.Value)
|
|
expectedResultFound = true
|
|
break
|
|
}
|
|
}
|
|
if !expectedResultFound {
|
|
t.Errorf("provider specific annotation %s has not been set", expectedAnnotationKey)
|
|
}
|
|
}
|
|
})
|
|
}
|
|
}
|