feat(DNSimple): User API tokens

[IntegralProgrammer]

Description

This Pull Request introduces the following environment variables for overriding data retrieved from the DNSimple API. This is needed when using User API DNSimple tokens (as opposed to Account API DNSimple tokens) as this data cannot be accessed with a User API token:

• DNSIMPLE_ACCOUNT_ID: The DNSimple account which owns the DNS records to be updated
• DNSIMPLE_ZONES: A comma separated list of DNS Zones in DNSimple which External-DNS will be allowed to manipulate

Fixes #4273

Checklist

• Unit tests updated
• End user documentation updated

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: IntegralProgrammer / name: Michael Lescisin (660b20b, d475eb6, 9b3c285, 26694e4, acf188f, d0c121b, ea2d259, 3babcbc, 9c24ecc, 3eb852f, c54a9a8, 487501d, eb59b9b, ed3efdb)

[k8s-ci-robot]

Welcome @IntegralProgrammer!

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 @IntegralProgrammer. 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.

[szuecs]

@IntegralProgrammer every feature requires a test.

[IntegralProgrammer]

This change wasn't really within the scope of this PR but this should be added in any case as without it, NewDnsimpleProvider isn't actually tested with an unset DNSIMPLE_OAUTH environment variable.

[IntegralProgrammer]

@IntegralProgrammer every feature requires a test.

Thank you for your feedback - I have added tests for this new feature in provider/dnsimple/dnsimple_test.go and have updated the documentation in docs/tutorials/dnsimple.md.

[mloiseleur]

/ok-to-test

[mloiseleur]

@IntegralProgrammer Thanks. Now you need to fix what is required by the linter. you can test it locally with make lint

[mloiseleur]

/retitle feat(DNSimple): User API tokens

[mloiseleur]

Suggested change

	whoamiResponse := &dnsimple.WhoamiResponse{}
	if !skipWhoami {
	var err error
	whoamiResponse, err = provider.identity.Whoami(context.Background())
	if err != nil {
	return nil, err
	}
	}
	if dnsimpleAccountId == "" {
	provider.accountID = int64ToString(whoamiResponse.Data.Account.ID)
	} else {
	provider.accountID = dnsimpleAccountId
	provider.accountID = dnsimpleAccountId
	if provider.accountID == "" {
	whoamiResponse, err := provider.identity.Whoami(context.Background())
	if err != nil {
	return nil, err
	}
	provider.accountID = int64ToString(whoamiResponse.Data.Account.ID)

I suggest to remove skipWhoami bool and also to avoid if ... else.
If you want to test also this part, you'll need to use mock.

[IntegralProgrammer]

Good suggestion - I have implemented this in 9c24ecc and 660b20b

[mloiseleur]

Suggested change

	provider.accountID = dnsimpleAccountId
	provider.accountID = os.Getenv("DNSIMPLE_ACCOUNT_ID")

[IntegralProgrammer]

Added in 487501d

[mloiseleur]

Suggested change

dnsimpleAccountId := os.Getenv("DNSIMPLE_ACCOUNT_ID")

[IntegralProgrammer]

Added in 487501d

[mloiseleur]

See my last suggestion about dnsimpleAccountId + Wdyt about keeping only NewDnsimpleProvider func without adding BuildDnsimpleProvider ?

[IntegralProgrammer]

See my last suggestion about dnsimpleAccountId + Wdyt about keeping only NewDnsimpleProvider func without adding BuildDnsimpleProvider ?

I've removed the need for the dnsimpleAccountId variable in commit 487501d and have refactored the code in dnsimple_test.go using a type assertion so that BuildDnsimpleProvider is no longer needed - ed3efdb

[mloiseleur]

/lgtm

[szuecs]

/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: szuecs

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

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [szuecs]

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