chore(cloudflare): migrate customhostname to v5 by AndrewCharlesHay · Pull Request #5891 · kubernetes-sigs/external-dns

AndrewCharlesHay · 2025-10-06T21:49:49Z

What does it do ?

Migrate customhostname to v5

Motivation

Closes #5540

More

Yes, this PR title follows Conventional Commits
Yes, I added unit tests
Yes, I updated end user documentation accordingly

coveralls · 2025-10-06T21:57:47Z

Pull Request Test Coverage Report for Build 20995964271

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

0 of 0 changed or added relevant lines in 0 files are covered.
1012 unchanged lines in 43 files lost coverage.
Overall coverage increased (+0.4%) to 79.084%

Files with Coverage Reduction	New Missed Lines	%
utils.go	1	96.0%
apis/externaldns/types.go	1	99.62%
empty.go	2	75.0%
fake.go	2	96.23%
source.go	2	72.22%
gateway_udproute.go	2	92.59%
gateway_grpcroute.go	2	92.59%
gateway_tlsroute.go	2	92.59%
gateway_httproute.go	2	92.59%
gateway_tcproute.go	2	92.59%

Totals
Change from base Build 20455488225:	0.4%
Covered Lines:	16032
Relevant Lines:	20272

💛 - Coveralls

docs/tutorials/cloudflare.md

mloiseleur · 2025-10-09T06:01:56Z

@vflaux @mrozentsvayg Any comment on this PR ? Do you think you can review it ?

go.mod

provider/cloudflare/cloudflare.go

k8s-ci-robot · 2025-10-09T15:47:49Z

@vflaux: changing LGTM is restricted to collaborators

Details

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

AndrewCharlesHay · 2025-10-10T17:11:58Z

How did broken tests get merged in?

vflaux · 2025-10-13T11:06:27Z

How did broken tests get merged in?

This should be fixed, see #5896.

AndrewCharlesHay · 2025-10-13T15:01:36Z

/retest

AndrewCharlesHay · 2025-10-13T19:55:19Z

@vflaux everything look good now?

vflaux

I've not review all the new tests yet.
Looks like IA generated, some clearly improve test coverage, others seems less relevant. 😄

provider/cloudflare/cloudflare.go

provider/cloudflare/cloudflare_test.go

provider/cloudflare/cloudflare.go

go.mod

AndrewCharlesHay · 2025-10-24T18:44:37Z

The tests just fail because of rate limits to coveralls

provider/cloudflare/cloudflare.go

szuecs · 2025-10-31T09:01:58Z

Did you @AndrewCharlesHay address comments by @vflaux ?

Cleaning up things that are not useful is always great for maintaining the software.

AndrewCharlesHay · 2025-11-04T23:03:46Z

@szuecs yep all updated

mloiseleur · 2025-11-08T11:46:15Z

@AndrewCharlesHay Would you please rebase ?

mloiseleur · 2025-11-11T15:30:38Z

@vflaux @szuecs Anything left on your side ?

cloudflare_coverage22.out

provider/cloudflare/cloudflare_test.go

provider/cloudflare/cloudflare.go

vflaux · 2025-11-09T20:24:35Z

provider/cloudflare/cloudflare_test.go

+func TestSubmitChangesEdgeCases(t *testing.T) {
+	ctx := context.Background()
+
+	t.Run("EmptyChanges", func(t *testing.T) {
+		client := NewMockCloudFlareClient()
+		provider := &CloudFlareProvider{
+			Client: client,
+		}
+
+		err := provider.submitChanges(ctx, []*cloudFlareChange{})
+		assert.NoError(t, err, "Empty changes should not error")
+	})
+
+	t.Run("DryRun", func(t *testing.T) {
+		client := NewMockCloudFlareClient()
+		provider := &CloudFlareProvider{
+			Client: client,
+			DryRun: true,
+		}
+
+		changes := []*cloudFlareChange{
+			{
+				Action: cloudFlareCreate,
+				ResourceRecord: dns.RecordResponse{
+					Name:    "test.bar.com",
+					Type:    "A",
+					Content: "1.2.3.4",
+				},
+			},
+		}
+
+		err := provider.submitChanges(ctx, changes)
+		assert.NoError(t, err, "Dry run should not error")
+		assert.Empty(t, client.Actions, "Dry run should not execute actions")
+	})
+}


This don't increase test coverage.

This has been addressed by the v5 test migration. Verification is included in the updated cloudflare_test.go.

vflaux · 2025-11-09T20:24:58Z

provider/cloudflare/cloudflare_test.go

+func TestGroupByNameAndTypeWithCustomHostnames(t *testing.T) {
+	provider := &CloudFlareProvider{}
+
+	t.Run("WithCustomHostnames", func(t *testing.T) {
+		records := DNSRecordsMap{
+			DNSRecordIndex{Name: "origin.example.com", Type: "A", Content: "1.2.3.4"}: {
+				ID:      "rec1",
+				Name:    "origin.example.com",
+				Type:    "A",
+				Content: "1.2.3.4",
+				TTL:     300,
+			},
+		}
+
+		customHostnames := CustomHostnamesMap{
+			CustomHostnameIndex{Hostname: "custom1.example.com"}: {
+				ID:                 "ch1",
+				Hostname:           "custom1.example.com",
+				CustomOriginServer: "origin.example.com",
+			},
+			CustomHostnameIndex{Hostname: "custom2.example.com"}: {
+				ID:                 "ch2",
+				Hostname:           "custom2.example.com",
+				CustomOriginServer: "origin.example.com",
+			},
+		}
+
+		endpoints := provider.groupByNameAndTypeWithCustomHostnames(records, customHostnames)
+		require.Len(t, endpoints, 1)
+
+		customHostnamesProp, ok := endpoints[0].GetProviderSpecificProperty(annotations.CloudflareCustomHostnameKey)
+		assert.True(t, ok)
+		assert.Contains(t, customHostnamesProp, "custom1.example.com")
+		assert.Contains(t, customHostnamesProp, "custom2.example.com")
+	})
+
+	t.Run("WithoutCustomHostnames", func(t *testing.T) {
+		records := DNSRecordsMap{
+			DNSRecordIndex{Name: "example.com", Type: "A", Content: "1.2.3.4"}: {
+				ID:      "rec1",
+				Name:    "example.com",
+				Type:    "A",
+				Content: "1.2.3.4",
+				TTL:     300,
+			},
+		}
+
+		endpoints := provider.groupByNameAndTypeWithCustomHostnames(records, nil)
+		require.Len(t, endpoints, 1)
+
+		_, ok := endpoints[0].GetProviderSpecificProperty(annotations.CloudflareCustomHostnameKey)
+		assert.False(t, ok, "Should not have custom hostname when none exist")
+	})
+}


This don't increase test coverage.

This has been addressed by the v5 test migration. Verification is included in the updated cloudflare_test.go.

provider/cloudflare/cloudflare_test.go

vflaux · 2025-11-09T20:25:57Z

provider/cloudflare/cloudflare_test.go

+func TestBuildCustomHostnameSSLParams(t *testing.T) {
+	ssl := &CustomHostnameSSL{
+		Type:                 "dv",
+		Method:               "http",
+		BundleMethod:         "ubiquitous",
+		CertificateAuthority: "lets_encrypt",
+		Settings:             CustomHostnameSSLSettings{MinTLSVersion: "1.2"},
+	}
+
+	params := custom_hostnames.CustomHostnameNewParamsSSL{}
+	if ssl.Method != "" {
+		params.Method = cloudflare.F(custom_hostnames.DCVMethod(ssl.Method))
+	}
+	if ssl.Type != "" {
+		params.Type = cloudflare.F(custom_hostnames.DomainValidationType(ssl.Type))
+	}
+	if ssl.BundleMethod != "" {
+		params.BundleMethod = cloudflare.F(custom_hostnames.BundleMethod(ssl.BundleMethod))
+	}
+	if ssl.CertificateAuthority != "" && ssl.CertificateAuthority != "none" {
+		params.CertificateAuthority = cloudflare.F(cloudflare.CertificateCA(ssl.CertificateAuthority))
+	}
+	if ssl.Settings.MinTLSVersion != "" {
+		params.Settings = cloudflare.F(custom_hostnames.CustomHostnameNewParamsSSLSettings{
+			MinTLSVersion: cloudflare.F(custom_hostnames.CustomHostnameNewParamsSSLSettingsMinTLSVersion(ssl.Settings.MinTLSVersion)),
+		})
+	}
+
+	// Assert all fields are set as expected
+	require.Equal(t, custom_hostnames.DCVMethod("http"), params.Method.Value)
+	require.Equal(t, custom_hostnames.DomainValidationType("dv"), params.Type.Value)
+	require.Equal(t, custom_hostnames.BundleMethod("ubiquitous"), params.BundleMethod.Value)
+	require.Equal(t, cloudflare.CertificateCA("lets_encrypt"), params.CertificateAuthority.Value)
+	require.Equal(t, custom_hostnames.CustomHostnameNewParamsSSLSettingsMinTLSVersion("1.2"), params.Settings.Value.MinTLSVersion.Value)
+}


This don't test anything.

This has been addressed by the v5 test migration. Verification is included in the updated cloudflare_test.go.

…handling - Replace all cloudflarev0.Error usages with cloudflare.Error in tests - Remove unused cloudflarev0 import - Fix getDNSRecordsMap to use PerPage configuration - Add early return in convertCloudflareError for structured v5 errors - Update TestConvertCloudflareError to handle v5 error types safely - Remove ErrorCodes field from error structs (not in v5 SDK) Signed-off-by: Andrew Hay <andrew.hay@benchmarkanalytics.com>

Signed-off-by: Andrew Hay <andrew.hay@benchmarkanalytics.com>

AndrewCharlesHay · 2026-01-08T03:05:04Z

@vflaux I believe I've addressed your previous concerns regarding test coverage and relevance. The tests have been updated to fully support the v5 SDK migration, including the new CustomHostname structures. Please let me know if there are any remaining specific scenarios you think are missing coverage.

docs/tutorials/cloudflare.md

vflaux

Sorry for the additional change requests.

Could you also move back TestGroupByNameAndTypeWithCustomHostnames_MX, TestProviderPropertiesIdempotency & ExampleDomain to their original location to minimize the diff noise?

After that, we should be good.

provider/cloudflare/cloudflare.go

provider/cloudflare/cloudflare_test.go

docs/tutorials/cloudflare.md

Co-authored-by: vflaux <38909103+vflaux@users.noreply.github.com>

- Remove SDK migration status section from cloudflare.md (per vflaux and ivankatliarchuk) - Add newCloudflareError() helper for proper v5 SDK error testing - Move ExampleDomain, TestGroupByNameAndTypeWithCustomHostnames_MX, and TestProviderPropertiesIdempotency back to original locations to minimize diff

Co-authored-by: vflaux <38909103+vflaux@users.noreply.github.com>

provider/cloudflare/cloudflare.go

ivankatliarchuk · 2026-01-14T09:41:43Z

/lgtm

.gitignore

Co-authored-by: vflaux <38909103+vflaux@users.noreply.github.com>

vflaux · 2026-01-14T16:45:27Z

/lgtm

mrozentsvayg · 2026-01-14T17:44:43Z

Running d9921ef build in our stage environment for about a week now.
No issues so far.

Until merged, this PR is effectively blocking further development of the Cloudflare provider. For example, I have a new feature/extension pending (Origin SNI Override), but it doesn't make sense to implement it on top of the older API.

If there are no further concerns to address, it would be great to get this merged.

ivankatliarchuk · 2026-01-14T20:28:32Z

/approve

k8s-ci-robot · 2026-01-14T20:28:41Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ivankatliarchuk

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [ivankatliarchuk]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

* master: (25 commits) feat(event): standardize event messages and add resource kind lookup for events (kubernetes-sigs#6101) refactor(informers): unify cache sync functions using generics (kubernetes-sigs#6102) fix(fqdn): support kind and api version (kubernetes-sigs#6097) test(fqdn): cover sources without any fqdn tests (kubernetes-sigs#6094) chore(tools): CRD generation script moved and add validation workflow (kubernetes-sigs#6079) fix(metrics): add CNAME to known record types (kubernetes-sigs#6115) chore(cloudflare): migrate customhostname to v5 (kubernetes-sigs#5891) test(provider/exoscale): improved the test coverage for exoscale provider from 62.8% to 80.4% (kubernetes-sigs#6112) feat(source): gateway api hostname source annotation (kubernetes-sigs#5959) test: cover pkg/events/fake package (kubernetes-sigs#6096) refactor(controller): controller no longer responsible for SingletonClientGenerator creation (kubernetes-sigs#6077) refactor(source): standardize FQDN template accross sources (kubernetes-sigs#6093) feat(coredns): rename ownerId and ownedBy to owner (kubernetes-sigs#6032) docs: fix typo in README (The are → There are) (kubernetes-sigs#6095) refactor(aws): abstract provider-specific boolean parsing (kubernetes-sigs#6078) refactor(api): deduplicate addKnownTypes (kubernetes-sigs#6087) fix(api): rollback changes for omitempty (kubernetes-sigs#6086) chore(deps): bump renovatebot/github-action (kubernetes-sigs#6080) fix(aws): enable AWS API validation for routing policies without setIdentifier (kubernetes-sigs#6082) chore(aws): document and test behavior for ALB and NLB (kubernetes-sigs#6063) ...

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 6, 2025

k8s-ci-robot requested a review from ivankatliarchuk October 6, 2025 21:49

k8s-ci-robot added the provider Issues or PRs related to a provider label Oct 6, 2025

k8s-ci-robot requested a review from szuecs October 6, 2025 21:49

k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Oct 6, 2025

k8s-ci-robot added the docs label Oct 7, 2025

mloiseleur reviewed Oct 7, 2025

View reviewed changes

docs/tutorials/cloudflare.md Outdated Show resolved Hide resolved

AndrewCharlesHay changed the title ~~Andrewcharleshay/cloudflare migration v5~~ chore(cloudflare): migrate customhostname to v5 Oct 7, 2025

vflaux suggested changes Oct 9, 2025

View reviewed changes

vflaux mentioned this pull request Oct 14, 2025

REQUEST: New membership for @vflaux kubernetes/org#5925

Closed

11 tasks

vflaux suggested changes Oct 17, 2025

View reviewed changes

k8s-ci-robot assigned vflaux Oct 17, 2025

szuecs reviewed Oct 24, 2025

View reviewed changes

go.mod Outdated Show resolved Hide resolved

szuecs reviewed Oct 31, 2025

View reviewed changes

provider/cloudflare/cloudflare.go Outdated Show resolved Hide resolved

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 8, 2025

AndrewCharlesHay force-pushed the andrewcharleshay/cloudflare-migration-v5 branch from e0eb277 to bcad628 Compare November 10, 2025 15:43

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 10, 2025

vflaux suggested changes Nov 11, 2025

View reviewed changes

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 6, 2026

style(cloudflare): apply gofmt formatting

d9921ef

Signed-off-by: Andrew Hay <andrew.hay@benchmarkanalytics.com>

ivankatliarchuk reviewed Jan 12, 2026

View reviewed changes

docs/tutorials/cloudflare.md Outdated Show resolved Hide resolved

vflaux suggested changes Jan 13, 2026

View reviewed changes

AndrewCharlesHay and others added 6 commits January 13, 2026 10:14

Update provider/cloudflare/cloudflare_test.go

680be39

Co-authored-by: vflaux <38909103+vflaux@users.noreply.github.com>

test: add to test

e24091d

Co-authored-by: vflaux <38909103+vflaux@users.noreply.github.com>

fix: change context

cb4327c

Co-authored-by: vflaux <38909103+vflaux@users.noreply.github.com>

style: use short variable declaration operator instead of var

beaec3d

Co-authored-by: vflaux <38909103+vflaux@users.noreply.github.com>

test: add customhostname test

33e7de6

Co-authored-by: vflaux <38909103+vflaux@users.noreply.github.com>

ivankatliarchuk suggested changes Jan 13, 2026

View reviewed changes

provider/cloudflare/cloudflare.go Outdated Show resolved Hide resolved

provider/cloudflare/cloudflare.go Outdated Show resolved Hide resolved

provider/cloudflare/cloudflare.go Outdated Show resolved Hide resolved

k8s-ci-robot assigned ivankatliarchuk Jan 13, 2026

AndrewCharlesHay added 2 commits January 13, 2026 15:20

refactor: make CustomHostname types package-internal

a433c27

style: fix gofmt formatting

9846b7a

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 14, 2026

vflaux reviewed Jan 14, 2026

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

Update .gitignore

3cf32f4

Co-authored-by: vflaux <38909103+vflaux@users.noreply.github.com>

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 14, 2026

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 14, 2026

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 14, 2026

k8s-ci-robot merged commit 3dd839a into kubernetes-sigs:master Jan 14, 2026
18 checks passed

Conversation

AndrewCharlesHay commented Oct 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does it do ?

Motivation

More

Uh oh!

coveralls commented Oct 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 20995964271

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

Uh oh!

Uh oh!

mloiseleur commented Oct 9, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

k8s-ci-robot commented Oct 9, 2025

Uh oh!

AndrewCharlesHay commented Oct 10, 2025

Uh oh!

vflaux commented Oct 13, 2025

Uh oh!

AndrewCharlesHay commented Oct 13, 2025

Uh oh!

AndrewCharlesHay commented Oct 13, 2025

Uh oh!

vflaux left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AndrewCharlesHay commented Oct 24, 2025

Uh oh!

Uh oh!

szuecs commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AndrewCharlesHay commented Nov 4, 2025

Uh oh!

mloiseleur commented Nov 8, 2025

Uh oh!

mloiseleur commented Nov 11, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vflaux Nov 9, 2025

Choose a reason for hiding this comment

Uh oh!

AndrewCharlesHay Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

vflaux Nov 9, 2025

Choose a reason for hiding this comment

Uh oh!

AndrewCharlesHay Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

vflaux Nov 9, 2025

Choose a reason for hiding this comment

Uh oh!

AndrewCharlesHay Jan 8, 2026

Choose a reason for hiding this comment

AndrewCharlesHay commented Oct 6, 2025 •

edited

Loading

coveralls commented Oct 6, 2025 •

edited

Loading

szuecs commented Oct 31, 2025 •

edited

Loading