feat: additional template functions

[matkam]

Description

Adds a few useful text/template functions:

• replaceAll: strings.replaceAll
• isIPv6: exposes an existing function that returns a bool to let you know if a string is an IPv6 address
• isIPv4: a new function that returns a bool to let you know if a string is an IPv4 address

N/A

Checklist

• Unit tests updated
• End user documentation updated

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: matkam / name: Mathew Kamkar (6b0d792, a5f3a17, 68be9bd, b0f3beb, b610c94, 42f79f8, 88bfa60, 267cb1f)

[k8s-ci-robot]

Welcome @matkam!

It looks like this is your first PR to kubernetes-sigs/external-dns 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/external-dns has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @matkam. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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/test-infra repository.

[johngmyers]

Please submit a CLA per the instructions above.

[matkam]

Please submit a CLA per the instructions above.

Yes 👍
I'm just waiting on my employer to click the button.

[matkam]

@johngmyers we are good to go here 👍

[johngmyers]

Is this function intended to return true for IPv4-mapped IPv6 addresses?

[matkam]

It just returns true when the input string is an IPv4 address. It'll return false if its IPv6 or otherwise invalid IP address.

[johngmyers]

https://go.dev/play/p/2SNDvrwxdh-

[matkam]

how about something like this?

func isIPv4String(input string) bool {
	netIP := net.ParseIP(input)
	return netIP != nil && netIP.To4() != nil && !strings.Contains(input, ":")
}

[johngmyers]

Sprig has replace, which is similar. Perhaps we should follow their syntax?

[johngmyers]

/ok-to-test

[matkam]

Sprig has replace, which is similar. Perhaps we should follow their syntax?

does replace work differently? I could also add strings.replace to the FuncMap.

[johngmyers]

I believe replace has the arguments in a different order. See the documentation in https://masterminds.github.io/sprig/strings.html

[matkam]

I believe replace has the arguments in a different order. See the documentation in https://masterminds.github.io/sprig/strings.html

sprig looks like a nice package. how about just importing it and using hermeticTxtFuncMap like this:

func parseTemplate(fqdnTemplate string) (tmpl *template.Template, err error) {
	if fqdnTemplate == "" {
		return nil, nil
	}
	
	funcs := sprig.HermeticTxtFuncMap()
	funcs["isIPv6"] = isIPv6String
	funcs["isIPv4"] = isIPv4String

	return template.New("endpoint").Funcs(funcs).Parse(fqdnTemplate)
}

[matkam]

@johngmyers let me know what you think. I've updated the template functions to include Sprig's hermetic text functions, and fixed the isIPv4String function so that it only returns true for valid IPv4 strings.

[k8s-ci-robot]

@matkam: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-external-dns-lint	c16c175	link	true	/test pull-external-dns-lint

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

[mloiseleur]

@matkam Since slim-sprig maintainer does not review your PR, I think we can merge this one. Do you think you can rebase this PR ? And precise in documentation those additional functions of isIPv4 and isIPv6 ?

[matkam]

@mloiseleur done!

[mloiseleur]

/lgtm

[matkam]

@mloiseleur whats the next step required to get this merged?

[mloiseleur]

A review from @szuecs or @Raffo
They will review this PR when they have time.

[mloiseleur]

/unhold

[mloiseleur]

/retitle feat: additional template functions

[simonostendorf]

Hello, I would like to see this merged and released. What needs to be done?

[k8s-ci-robot]

New changes are detected. LGTM label has been removed.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from mloiseleur. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

• OWNERS

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

[szuecs]

Please no import for a single func.