add --extra option to login CLI to pass extra query params to /author… (#4)

* add --extra option to login CLI to pass extra query params to /authorize requests

* black formatting

Author: carl-adams-planet

src/planet_auth_utils/__init__.py

@@ -62,6 +62,7 @@
     opt_audience,
     opt_client_id,
     opt_client_secret,
+    opt_extra,
     opt_human_readable,
     opt_issuer,
     opt_loglevel,
@@ -122,6 +123,7 @@
     "opt_audience",
     "opt_client_id",
     "opt_client_secret",
+    "opt_extra",
     "opt_human_readable",
     "opt_issuer",
     "opt_loglevel",

src/planet_auth_utils/commands/cli/oauth_cmd.py

@@ -27,6 +27,7 @@
     opt_audience,
     opt_client_id,
     opt_client_secret,
+    opt_extra,
     opt_human_readable,
     opt_open_browser,
     opt_organization,
@@ -77,8 +78,9 @@ def cmd_oauth(ctx):
 @opt_client_secret
 @opt_sops
 @opt_yes_no
+@opt_extra
 @click.pass_context
-@recast_exceptions_to_click(AuthException)
+@recast_exceptions_to_click(AuthException, ValueError)
 def cmd_oauth_login(
     ctx,
     scope,
@@ -93,18 +95,23 @@ def cmd_oauth_login(
     sops,
     yes,
     project,
+    extra,
 ):
     """
     Perform an initial login using OAuth.
     """
-    extra = {}
+    login_extra = {}
+    if extra:
+        for extra_opt in extra:
+            key, value = extra_opt.split("=", 1)
+            login_extra[key] = value
     if project:
         # Planet Labs OAuth extension to request a token for a particular project
-        extra["project_id"] = project
+        login_extra["project_id"] = project
     if organization:
         # Used by Auth0's OAuth implementation to support their concept of selecting
         # a particular organization at login when the user belongs to more than one.
-        extra["organization"] = organization
+        login_extra["organization"] = organization
 
     current_auth_context = ctx.obj["AUTH"]
     current_auth_context.login(
@@ -117,7 +124,7 @@ def cmd_oauth_login(
         password=password,
         client_id=auth_client_id,
         client_secret=auth_client_secret,
-        extra=extra,
+        extra=login_extra,
     )
     print("Login succeeded.")  # Errors should throw.
     post_login_cmd_helper(override_auth_context=current_auth_context, use_sops=sops, prompt_pre_selection=yes)

src/planet_auth_utils/commands/cli/options.py

@@ -385,3 +385,24 @@ def opt_sops(function):
         show_default=True,
     )(function)
     return function
+
+
+def opt_extra(function):
+    """
+    Click option for specifying extra options.
+    """
+    function = click.option(
+        "--extra",
+        "-O",
+        multiple=True,
+        type=str,
+        envvar=EnvironmentVariables.AUTH_EXTRA,
+        help="Specify an extra option.  Specify multiple options to specify"
+        " multiple extra options.  The format of an option is <key>=<value>."
+        " When set via environment variable, values should be delimited by"
+        " whitespace.",
+        default=None,
+        show_envvar=True,
+        show_default=True,
+    )(function)
+    return function

src/planet_auth_utils/constants.py

@@ -33,6 +33,12 @@ class EnvironmentVariables:
     Client Secret for an OAuth service account
     """
 
+    AUTH_EXTRA = "PL_AUTH_EXTRA"
+    """
+    List of extra options.  Values should be formatted as <key>=<value>.
+    Multiple options should be whitespace delimited.
+    """
+
     AUTH_PROFILE = "PL_AUTH_PROFILE"
     """
     Name of a profile to use for auth client configuration.
@@ -73,6 +79,7 @@ class EnvironmentVariables:
     AUTH_SCOPE = "PL_AUTH_SCOPE"
     """
     List of scopes to request when requesting OAuth tokens.
+    Multiple scopes should be whitespace delimited.
     """
 
     AUTH_USERNAME = "PL_AUTH_USERNAME"