Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

vdk-control-cli: add --set-prompt option for secrets #2514

Merged
merged 3 commits into from
Aug 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ class SecretOperation(Enum):
"""

SET = "set"
SET_PROMPT = "set_prompt" # nosec
GET = "get"


Expand Down Expand Up @@ -182,9 +183,13 @@ def delete_all_job_secrets(self) -> None:
you'll get prompted so it's not printed on the screen.
vdk secrets --set my-key "my-value"
\b
# Will prompt for the value so it's not printed on the screen.
vdk secrets --set-prompt "my-secret"
\b
# Update multiple secrets at once.
vdk secrets --set "key1" "value1" --set "key2" "value2" --set "secret1" --set "secret2"
vdk secrets --set "key1" "value1" --set "key2" "value2" --set-prompt "secret1" --set-prompt "secret2"
\b
# Use backslash \\ to set them on multiple lines
Expand Down Expand Up @@ -228,6 +233,13 @@ def delete_all_job_secrets(self) -> None:
"Entirely new secrets will be set with string type"
"You can set multiple secrets by using --set multiple times",
)
@click.option(
"--set-prompt",
multiple=True,
type=click.STRING,
help="Set a secret by only passing a key without a value and enter it when prompted."
"The difference from --set is that it will be prompted and input would be masked. ",
)
@click.option(
"--delete",
nargs=1,
Expand Down Expand Up @@ -259,6 +271,7 @@ def secrets_command(
name: str,
team: str,
set: Tuple[str, str], # pylint: disable=redefined-builtin
set_prompt: Tuple[str, str], # pylint: disable=redefined-builtin
delete: Tuple[str],
delete_all_job_secrets: bool,
overwrite_all_job_secrets: _io.BufferedReader,
Expand All @@ -267,10 +280,10 @@ def secrets_command(
rest_api_url: str,
output: OutputFormat,
):
if (set or delete) and (get or list):
if (set or delete or set_prompt) and (get or list):
raise VDKException(
what="Invalid arguments",
why="Wrong input. Cannot pass --get or --list at the same time as --set and --delete.",
why="Wrong input. Cannot pass --get or --list at the same time as --set, --set-prompt and --delete.",
consequence="Command will abort with error.",
countermeasure="Fix passed arguments such that get/list are not passed in the same time as set/delete.",
)
Expand All @@ -283,10 +296,10 @@ def secrets_command(
)
log.debug(
f"secrets passed options: name: {name}, team: {team}, "
f"set: {set}, get: {get}, list: {list}, delete: {delete} "
f"set: {set}, set_prompt: {set_prompt}, get: {get}, list: {list}, delete: {delete} "
f"rest_api_url: {rest_api_url}, output: {output}"
)
key_value_pairs = _get_key_value_pairs(set)
key_value_pairs = _get_key_value_pairs(set, set_prompt)
cmd = JobSecrets(rest_api_url, name, team, output)
if key_value_pairs:
cmd.update_secrets(key_value_pairs)
Expand All @@ -312,13 +325,13 @@ def secrets_command(
)


def _get_key_value_pairs(set): # pylint: disable=redefined-builtin
def _get_key_value_pairs(set, set_prompt): # pylint: disable=redefined-builtin
key_value_pairs = {}
if set:
for key, value in set:
if value:
key_value_pairs[key] = value
else:
value = click.prompt(f"{key}", hide_input=True)
key_value_pairs[key] = value
key_value_pairs[key] = value
if set_prompt:
for key in set_prompt:
value = click.prompt(f"{key}", hide_input=True)
key_value_pairs[key] = value
return key_value_pairs
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ def test_secrets_set_secret_prompt(httpserver: PluginHTTPServer):
rest_api_url = _mock_secrets_server(httpserver)

result = _run_secrets_command(
rest_api_url, ["--set", "secret", ""], input="my-secret-value"
rest_api_url, ["--set-prompt", "secret"], input="my-secret-value"
)
test_utils.assert_click_status(result, 0)

Expand Down