Feat: fallback to CLI config for token #248

Praveen005 · 2024-07-08T16:43:45Z

This pull request introduces the feature requested in #246

It Implements a priority-based token retrieval:

Environment variable (CIVO_TOKEN).
Token provided via a Credential file.
Lastly, fall back to CLI config file (~/.civo.json)

Tests' Screenshots:

I have introduced coloured debug messages(removed from the main code), which correctly prints the token it abstracts:

Below, I have set the token using Civo CLI command civo apikey save CIVO_TOKEN clitoken96 which saves it in ~/.civo.json.
You can see, it correctly prints a different token(last coloured debug message):

uzaxirr · 2024-07-09T07:34:22Z

@Praveen005 is this ready for review?

Praveen005 · 2024-07-09T07:35:57Z

Yes @uzaxirr it is ready for review.

uzaxirr · 2024-07-09T07:56:03Z

@Praveen005 can you also build the provider locally, test it and attach corresponding screenshots.
Refer to this for local setup.

uzaxirr

I've tested your branch locally. It works when credential_file is specified or env vars are there but it fails when it has to fallback to CLI configs i.e when credential_file is not specified and env vars are also absent. can you please verify this.

uzaxirr · 2024-07-09T08:53:46Z

civo/provider.go

-			"token": {
+			"credential_file": {
 				Type:        schema.TypeString,
 				Optional:    true,
-				DefaultFunc: schema.EnvDefaultFunc("CIVO_TOKEN", ""),
-				Description: "This is the Civo API token. Alternatively, this can also be specified using `CIVO_TOKEN` environment variable.",


Instead of removing token, we can deprecate this field from the schema. This would be a better way.

"token": { Type: schema.TypeString, Optional: true, DefaultFunc: schema.EnvDefaultFunc("CIVO_TOKEN", ""), Deprecated: "\"token\" attribute is deprecated. Moving forward, please use \"credential_file\" attribute.", Description: "This is the Civo API token. Alternatively, this can also be specified using `CIVO_TOKEN` environment variable.", },

Hey @uzaxirr I zeroed in on the likely bottleneck,

The token variable in provider.tf in build.sh script was still there, I removed it.

Also updated the provider.tf in examples directory.

I also incorporated your suggestion of deprecating the token field. Thanks for the heads up.

Following are the screen grabs from local build:

The resource didn't get created, likely because I don't have an active Civo Account.
Can you now try again?

Regards.

While you performed the above operation was there any token or credential_file attribute present in your provider.tf civo config block?

@uzaxirr No, it was not in provider.tf. I will share you the terraform debug log which shows token being read from ~/.civo.json. The code need some more changes and I am working on that.

Sure, great work so far

…ken field in provider schema

* Last commit was not reading from the token variable, so fixed that. * Added one test case to cater for above change. * Since, we still can read token from the token attribute, we need not remove civo_api_key variable from build.sh.

Praveen005 · 2024-07-10T07:57:25Z

Hi @uzaxirr Thank you for your patience.

Here are the details about the changes:

Earlier commit was not reading token from the token attribute, so fixed it.
Added one test case, to cater for this change.
In last commit I removed, civo_api_key and token = "$civo_api_key" from the local build script local.sh but that's not needed, so added them back.
The code now, passes the local build test, all the unit tests and also correctly reads the token from ~/.civo.json

Screenshots:

provider.tf file on which I'm running the local build:
You can see, I haven't provided it the token nor the credential_file path. I haven't set the environment variable either.
Meaning it will have to fall back to reading from ~/.civo.json

No environment variable set:

Token in ~/.civo.json

Added debug log(removed from main code) to print the token when it is read:

Starting local build:

Terraform debug log, shows CIVO_TOKEN being correctly read from CLI config.

See deprecation warning being correctly displayed:

Terraform apply:

Token again being read again after terraform apply command:

Attempts being made to create the resource, but fails because I don't have an active civo account

Passing all the unit tests:

Test coverage:

Can you please review these changes again?

Regards.

uzaxirr

Hey @Praveen005
I've pulled up your latest changes locally, again the same scenario works fine when crediential_file or CIVO_TOKEN env var is specified. but fails to obtain the token from CLI when nothing is specified. Please refer to the below screen shot

Also why do i see the Argument is deprecated warning even though i haven't specified any token field in my schema.

I would suggest you to create a CIVO account, set up the CLI and then try spinning up resources via terraform with all the different scnerios.

Praveen005 · 2024-07-15T05:19:14Z

I will check it right away, @uzaxirr.

Added a validation function in token field, which will ensure warning is shown only when user uses the token variable. Removed hardcoded api key name. Made minor changes to unit tests

Praveen005 · 2024-07-15T16:58:29Z

Hi @uzaxirr, sorry it took way more time than I anticipated.

I believe, it fixes all the above issues you pointed. I have tested it thoroughly and it works fine, can you kindly check once from your end?

I added a validation function under the token attribute in provider schema. The warnings are now logged only when you use the token variable.
If you see the token field, I removed the deprecated message, because the warning was shown twice in quick succession, once because I used Deprecated attribute, while other in validateTokenUsage function.
Earlier I had hardcoded the API key name to CIVO_TOKEN, and this was causing the trouble while reading the token from cli config. on your machine. I corrected it.
This change now will enable the user to use multiple API keys.
The credential file now will look like:

{
				"apikeys": {
					"my_token1": "123456",
					"my_token2": "785645"
				},
				"meta": {
					"current_apikey": "my_token1"
				}
}

Screenshots:

provider.tf

Network resource successfully created:

uzaxirr · 2024-07-16T18:56:59Z

@Praveen005 can you test the following locally and attach screenshots for them.

with credential_file attribute
with token attribute
with just the CIVO_TOKEN env var, no credential file or token
Without credential_file, token or the env var (i.e token should be picked up from the CLI config)
without credential_file, token, env var or ~/.civo.json file present (i.e some error should occour)

Praveen005 · 2024-07-16T21:34:46Z

Thank you for reviewing it @uzaxirr.

Here are all the relevant screenshots:

Token provided only via credential_file attribute.

Token provided only via token attribute

Warning message being correctly displayed:

Token provided only via CIVO_TOKEN environment variable

Token available only in ~/.civo.json

No token Provider at all.

Resource creation failed:

fernando-villalba · 2024-07-17T07:26:02Z

Looks great to me so far. As a suggested improvement, if no token is found at all. We could point the user to where to get one:

https://dashboard.civo.com/security

For example:

"No token configuration found in $CIVO_TOKEN or ~/.civo.json, please go to https://dashboard.civo.com/security to fetch one"

Praveen005 · 2024-07-17T09:06:15Z

Hi @fernando-villalba,

I’ve updated the error message to be more expressive as suggested. Here is the new version:

Can you kindly, check it now?

Thank you!

fernando-villalba · 2024-07-17T13:05:29Z

LGTM!

Praveen005 · 2024-07-18T07:22:23Z

Hi @alessandroargentieri,

I hope you're doing well. When you have a moment, could you please review this PR?

Thank you!

uzaxirr · 2024-07-18T07:23:53Z

hey @Praveen005 the PR looks fine, i'm in process of updating the corresponding docs for this before we merge off this one

Praveen005 · 2024-07-18T07:27:35Z

Thank you @uzaxirr. Let me know if there's anything I can assist with regarding the documentation.

Regards!

fernando-villalba · 2024-07-18T08:41:37Z

One more thing, when we have the updated documents, I would also add a link to the documentation in the deprecation message. Thank you for your hard work and patience @Praveen005 !

Praveen005 · 2024-07-18T09:41:20Z

@fernando-villalba That would be better.

Just a caveat, the link to the documentation will have to be added in validateTokenUsage function.

Also, in the documentation, should we mention the format in which user should store their token in the credential file?
Like:

{
  "apikeys": {
    "demo_key": "2p35nGkS9NQncivoko5qqX3FtF643RUfqjniiH2"
  },
  "meta": {
    "current_apikey": "demo_key"
  }
}

This way user can store multiple API keys for multiple accounts (home, work etc.). Also it would be consistent with the way, Civo CLI stores token in ~/.civo.json

fernando-villalba · 2024-08-07T09:05:25Z

By the way, @Praveen005 and @uzaxirr

Sorry to be a stickler for detail but change credential_file to credentials_file as originally proposed on the ticket.

I know that technically we are only using one credential, the one token, but in a security context is weird referring to it as singular.

Other than that, let's get this out on next release - doing documentation for it now!

Praveen005 · 2024-08-07T09:24:24Z

Hi @fernando-villalba,

That is a lapse on my part, and I’ll be more mindful in future. Thanks for the heads up. I'll update the code to use credentials_file as suggested.

Regards,

Praveen

uzaxirr · 2024-08-07T13:13:57Z

@Praveen005 can you do the above change on priority so that i could merge this PR

Praveen005 · 2024-08-07T14:42:21Z

Hey @uzaxirr, I have tested it again and it works as intended.

with credentials_file attribute:

with credential_file attribute:

uzaxirr

Thankss a ton for this PR

Praveen005 · 2024-08-07T16:29:17Z

Thank you @uzaxirr . It means a lot.

feat: fallback to CLI config for token

19b9f6c

Praveen005 requested a review from alessandroargentieri as a code owner July 8, 2024 16:43

uzaxirr requested changes Jul 9, 2024

View reviewed changes

Praveen005 added 2 commits July 9, 2024 17:41

removed token variable from provider.tf in local.sh and deprecated to…

33b3518

…ken field in provider schema

fix: read token from token attribute

5e385b4

* Last commit was not reading from the token variable, so fixed that. * Added one test case to cater for above change. * Since, we still can read token from the token attribute, we need not remove civo_api_key variable from build.sh.

Praveen005 requested a review from uzaxirr July 10, 2024 20:20

uzaxirr requested changes Jul 15, 2024

View reviewed changes

fix: read token from cli config and fix warning issues

50b6b59

Added a validation function in token field, which will ensure warning is shown only when user uses the token variable. Removed hardcoded api key name. Made minor changes to unit tests

uzaxirr assigned Praveen005 Jul 17, 2024

chore: improve error message for missing API token

9ab007e

chore: change credential_file attribute to credentials_file

6c56163

uzaxirr approved these changes Aug 7, 2024

View reviewed changes

uzaxirr merged commit cbcaa08 into civo:master Aug 7, 2024
1 check passed

Praveen005 deleted the fix246 branch August 7, 2024 16:24

uzaxirr mentioned this pull request Aug 13, 2024

[FEATURE] Provider should take configuration from the CLI config (~/.civo.json) #246

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: fallback to CLI config for token #248

Feat: fallback to CLI config for token #248

Praveen005 commented Jul 8, 2024

uzaxirr commented Jul 9, 2024

Praveen005 commented Jul 9, 2024

uzaxirr commented Jul 9, 2024

uzaxirr left a comment

uzaxirr Jul 9, 2024

Praveen005 Jul 9, 2024

uzaxirr Jul 9, 2024

Praveen005 Jul 9, 2024

uzaxirr Jul 9, 2024

Praveen005 commented Jul 10, 2024

uzaxirr left a comment

Praveen005 commented Jul 15, 2024

Praveen005 commented Jul 15, 2024 •

edited

Loading

uzaxirr commented Jul 16, 2024

Praveen005 commented Jul 16, 2024

fernando-villalba commented Jul 17, 2024

Praveen005 commented Jul 17, 2024

fernando-villalba commented Jul 17, 2024

Praveen005 commented Jul 18, 2024

uzaxirr commented Jul 18, 2024

Praveen005 commented Jul 18, 2024

fernando-villalba commented Jul 18, 2024

Praveen005 commented Jul 18, 2024 •

edited

Loading

fernando-villalba commented Aug 7, 2024

Praveen005 commented Aug 7, 2024

uzaxirr commented Aug 7, 2024

Praveen005 commented Aug 7, 2024

uzaxirr left a comment

Praveen005 commented Aug 7, 2024

Feat: fallback to CLI config for token #248

Feat: fallback to CLI config for token #248

Conversation

Praveen005 commented Jul 8, 2024

uzaxirr commented Jul 9, 2024

Praveen005 commented Jul 9, 2024

uzaxirr commented Jul 9, 2024

uzaxirr left a comment

Choose a reason for hiding this comment

uzaxirr Jul 9, 2024

Choose a reason for hiding this comment

Praveen005 Jul 9, 2024

Choose a reason for hiding this comment

uzaxirr Jul 9, 2024

Choose a reason for hiding this comment

Praveen005 Jul 9, 2024

Choose a reason for hiding this comment

uzaxirr Jul 9, 2024

Choose a reason for hiding this comment

Praveen005 commented Jul 10, 2024

uzaxirr left a comment

Choose a reason for hiding this comment

Praveen005 commented Jul 15, 2024

Praveen005 commented Jul 15, 2024 • edited Loading

uzaxirr commented Jul 16, 2024

Praveen005 commented Jul 16, 2024

fernando-villalba commented Jul 17, 2024

Praveen005 commented Jul 17, 2024

fernando-villalba commented Jul 17, 2024

Praveen005 commented Jul 18, 2024

uzaxirr commented Jul 18, 2024

Praveen005 commented Jul 18, 2024

fernando-villalba commented Jul 18, 2024

Praveen005 commented Jul 18, 2024 • edited Loading

fernando-villalba commented Aug 7, 2024

Praveen005 commented Aug 7, 2024

uzaxirr commented Aug 7, 2024

Praveen005 commented Aug 7, 2024

uzaxirr left a comment

Choose a reason for hiding this comment

Praveen005 commented Aug 7, 2024

Praveen005 commented Jul 15, 2024 •

edited

Loading

Praveen005 commented Jul 18, 2024 •

edited

Loading