feat: new account loader plugin with http auth #32
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The existing account loaders in the awsrun.acctload and their respective
CLI-counterparts in awsrun.plugins.accts do not support HTTP auth:
- awsrun.acctload.JSONAccountLoader (awsrun.plugins.accts.JSON)
- awsrun.acctload.YAMLAccountLoader (awsrun.plugins.accts.YAML)
- awsrun.acctload.CSVAccountLoader (awsrun.plugins.accts.CSV)
This change introduces a new account loader, which will eventually
replace those mentioned above:
- awsrun.acctload.URLAccountLoader (awsrun.plugins.accts.URLLoader)
The new loader can parse JSON, YAML, and CSV data depending on the
parser provided (library usage) or parser specified via the `parser`
configuration key (CLI usage).
In addition, the new loader supports HTTP basic, digest, ntlm, and
oauth2 authentication methods depending on the auth method provided
(library usage) or auth method specified via the `auth` configuration
key (CLI usage).
Sample usage via the library:
# Library usage
from awsrun.acctload import *
# JSON example with basic HTTP auth
loader = URLAccountLoader(
"https://example.com/data.json",
parser=JSONFormatter(),
auth=HTTPBasic(user, pw),
)
# CSV example with OAuth2 HTTP auth
loader = URLAccountLoader(
"https://example.com/data.csv",
parser=CSVFormatter(delimiter=","),
auth=HTTPOAuth2("https://token.example.com", user, pw),
)
Sample usage via the CLI configuration file:
Accounts:
plugin: awsrun.plugins.accts.URLLoader
options:
url: https://example.com/data.json
parser: json
auth: oauth2
auth_options:
token_url: https://token.example.com
At the time the URLLoader plug-in is instantiated, we don't know if the URLAccountLoader will even need to make an HTTP call as it may have cached data. So, if the user has not specified a password via CLI args, env vars, or config file, we don't want to prematurely prompt them unless URLAccountLoader really needs to make an HTTP request.
pkazmier
changed the title
a-medv
approved these changes
Jul 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The existing account loaders in the awsrun.acctload and their respective
CLI-counterparts in awsrun.plugins.accts do not support HTTP auth:
This change introduces a new account loader, which will eventually
replace those mentioned above:
The new loader can parse JSON, YAML, and CSV data depending on the
parser provided (library usage) or parser specified via the
parserconfiguration key (CLI usage).
In addition, the new loader supports HTTP basic, digest, ntlm, and
oauth2 authentication methods depending on the auth method provided
(library usage) or auth method specified via the
authconfigurationkey (CLI usage).
Sample usage via the library:
Sample usage via the CLI configuration file: