Carl/wx integration feedback (#23)

* clean-up option code.  Make all options functions for consistency.

* sort option members

* export built-in provider interface

* clean up option defaults

* unify handling of hiding options.

* better handling of env vars for exported CLI options

* formatting for options.py

* provide some base class implementations for built-in provider to make life easier for integrators

Author: carl-adams-planet

docs/examples/cli/embed-plauth-click.py

@@ -13,8 +13,8 @@
 
 @click.group(help="my cli main help message")
 @planet_auth_utils.opt_profile
-@planet_auth_utils.opt_client_id
-@planet_auth_utils.opt_client_secret
+@planet_auth_utils.opt_client_id()
+@planet_auth_utils.opt_client_secret()
 @click.pass_context
 def my_cli_main(ctx, auth_profile, auth_client_id, auth_client_secret):
     ctx.ensure_object(dict)

src/planet_auth_utils/__init__.py

@@ -87,9 +87,9 @@
     opt_password,
     opt_profile,
     opt_project,
+    opt_qr_code,
     opt_refresh,
     opt_scope,
-    opt_show_qr_code,
     opt_sops,
     opt_token,
     opt_token_file,
@@ -99,7 +99,7 @@
 from .commands.cli.util import recast_exceptions_to_click
 from planet_auth_utils.constants import EnvironmentVariables
 from planet_auth_utils.plauth_factory import PlanetAuthFactory
-from planet_auth_utils.builtins import Builtins
+from planet_auth_utils.builtins import Builtins, BuiltinConfigurationProviderInterface
 from planet_auth_utils.profile import Profile
 from planet_auth_utils.plauth_user_config import PlanetAuthUserConfig
 
@@ -150,9 +150,9 @@
     "opt_password",
     "opt_profile",
     "opt_project",
+    "opt_qr_code",
     "opt_refresh",
     "opt_scope",
-    "opt_show_qr_code",
     "opt_sops",
     "opt_token",
     "opt_token_file",
@@ -161,6 +161,7 @@
     "recast_exceptions_to_click",
     #
     "Builtins",
+    "BuiltinConfigurationProviderInterface",
     "EnvironmentVariables",
     "PlanetAuthFactory",
     "Profile",

src/planet_auth_utils/builtins_provider.py

@@ -50,13 +50,13 @@ def builtin_client_authclient_config_dicts(self) -> Dict[str, dict]:
         `planet_auth.AuthClientConfig.config_from_dict`
         """
 
-    @abstractmethod
     def builtin_client_profile_aliases(self) -> Dict[str, str]:
         """
         Return a dictionary profile aliases.  Aliases allow
         for a single built-in configuration to be referred to
         by multiple names.
         """
+        return {}
 
     @abstractmethod
     def builtin_default_profile_by_client_type(self) -> Dict[str, str]:
@@ -70,18 +70,30 @@ def builtin_default_profile(self) -> str:
         Return the built-in default fallback auth profile name of last resort.
         """
 
-    @abstractmethod
     def builtin_trust_environment_names(self) -> List[str]:
         """
         Return a list of the names of built-in trust environments.
         """
+        _realms = self.builtin_trust_environments()
+        if _realms:
+            return list(_realms.keys())
+        return []
 
-    @abstractmethod
     def builtin_trust_environments(self) -> Dict[str, Optional[List[dict]]]:
         """
         Return a dictionary of the trust environment configurations.
         Each item in the lists should be valid AuthClient config dictionary.
+
+        This is primarily used for cases where planet_auth is used to validate
+        tokens on the service side.  This is the flip side of most of the other
+        BuiltinConfigurationProviderInterface methods which are geared towards
+        helping clients obtain tokens.
         """
+        return {
+            # "PRODUCTION": [MY_REALM_PRODUCTION],
+            # "STAGING": [MY_REALM_STAGING],
+            "CUSTOM": None,
+        }
 
 
 class EmptyBuiltinProfileConstants(BuiltinConfigurationProviderInterface):
@@ -95,29 +107,15 @@ class EmptyBuiltinProfileConstants(BuiltinConfigurationProviderInterface):
         BUILTIN_PROFILE_NAME_NONE: NONE_AUTH_CLIENT_CONFIG,
     }
 
-    _builtin_profile_aliases: Dict[str, str] = {}
-
     _builtin_profile_default_by_client_type = {
         "none": BUILTIN_PROFILE_NAME_NONE,
     }
-    _builtin_trust_realms: Dict[str, Optional[List[dict]]] = {
-        "CUSTOM": None,
-    }
 
     def builtin_client_authclient_config_dicts(self) -> Dict[str, dict]:
         return EmptyBuiltinProfileConstants._builtin_profile_auth_client_configs
 
-    def builtin_client_profile_aliases(self) -> Dict[str, str]:
-        return EmptyBuiltinProfileConstants._builtin_profile_aliases
-
     def builtin_default_profile_by_client_type(self) -> Dict[str, str]:
         return EmptyBuiltinProfileConstants._builtin_profile_default_by_client_type
 
     def builtin_default_profile(self) -> str:
         return EmptyBuiltinProfileConstants.BUILTIN_PROFILE_NAME_NONE
-
-    def builtin_trust_environment_names(self) -> List[str]:
-        return list(EmptyBuiltinProfileConstants._builtin_trust_realms.keys())
-
-    def builtin_trust_environments(self) -> Dict[str, Optional[List[dict]]]:
-        return EmptyBuiltinProfileConstants._builtin_trust_realms

src/planet_auth_utils/commands/cli/jwt_cmd.py

@@ -146,9 +146,9 @@ def _get_token_or_fail(token_opt: typing.Optional[str], token_file_opt: typing.O
 
 @cmd_jwt.command("decode")
 @click.pass_context
-@opt_human_readable
-@opt_token
-@opt_token_file
+@opt_human_readable()
+@opt_token()
+@opt_token_file()
 @recast_exceptions_to_click(AuthException, FileNotFoundError)
 def cmd_jwt_decode(ctx, token: str, token_file: pathlib.Path, human_readable):
     """
@@ -160,9 +160,9 @@ def cmd_jwt_decode(ctx, token: str, token_file: pathlib.Path, human_readable):
 
 @cmd_jwt.command("validate-oauth")
 @click.pass_context
-@opt_human_readable
-@opt_token
-@opt_token_file
+@opt_human_readable()
+@opt_token()
+@opt_token_file()
 @opt_audience()
 @opt_issuer()
 @recast_exceptions_to_click(AuthException, FileNotFoundError)
@@ -227,9 +227,9 @@ def cmd_jwt_validate_oauth(ctx, token, token_file, audience, issuer, human_reada
 
 @cmd_jwt.command("validate-rs256", hidden=True)
 @click.pass_context
-@opt_human_readable
-@opt_token
-@opt_token_file
+@opt_human_readable()
+@opt_token()
+@opt_token_file()
 @recast_exceptions_to_click(AuthException, FileNotFoundError, NotImplementedError)
 def cmd_jwt_validate_rs256(ctx, token, token_file, human_readable):
     """
@@ -241,9 +241,9 @@ def cmd_jwt_validate_rs256(ctx, token, token_file, human_readable):
 
 @cmd_jwt.command("validate-hs512", hidden=True)
 @click.pass_context
-@opt_human_readable
-@opt_token
-@opt_token_file
+@opt_human_readable()
+@opt_token()
+@opt_token_file()
 @recast_exceptions_to_click(AuthException, FileNotFoundError, NotImplementedError)
 def cmd_jwt_validate_hs512(ctx, token, token_file, human_readable):
     """

src/planet_auth_utils/commands/cli/main.py

@@ -35,7 +35,7 @@
     opt_password,
     opt_loglevel,
     opt_open_browser,
-    opt_show_qr_code,
+    opt_qr_code,
     opt_sops,
     opt_audience,
     opt_scope,
@@ -49,8 +49,8 @@
 
 
 @click.group("plauth", invoke_without_command=True, help="Planet authentication utility")
-@opt_loglevel
-@opt_profile
+@opt_loglevel()
+@opt_profile()
 @click.pass_context
 @recast_exceptions_to_click(AuthException, FileNotFoundError, PermissionError)
 def cmd_plauth(ctx, loglevel, auth_profile):
@@ -146,20 +146,20 @@ def cmd_plauth_reset():
 
 
 @cmd_plauth.command("login")
-@opt_open_browser
-@opt_show_qr_code
-@opt_scope
+@opt_open_browser()
+@opt_qr_code()
+@opt_scope()
 @opt_audience()
-@opt_organization
-@opt_project
-@opt_profile
-@opt_client_id
-@opt_client_secret
-@opt_api_key
+@opt_organization()
+@opt_project()
+@opt_profile()
+@opt_client_id()
+@opt_client_secret()
+@opt_api_key()
 @opt_username()
 @opt_password()
-@opt_sops
-@opt_yes_no
+@opt_sops()
+@opt_yes_no()
 @click.pass_context
 @recast_exceptions_to_click(AuthException, FileNotFoundError, PermissionError)
 def cmd_plauth_login(

src/planet_auth_utils/commands/cli/oauth_cmd.py

@@ -35,7 +35,7 @@
     opt_project,
     opt_refresh,
     opt_scope,
-    opt_show_qr_code,
+    opt_qr_code,
     opt_sops,
     opt_username,
     opt_yes_no,
@@ -66,19 +66,19 @@ def cmd_oauth(ctx):
 
 
 @cmd_oauth.command("login")
-@opt_open_browser
-@opt_show_qr_code
-@opt_scope
+@opt_open_browser()
+@opt_qr_code()
+@opt_scope()
 @opt_audience()
-@opt_organization
-@opt_project
+@opt_organization()
+@opt_project()
 @opt_username()
 @opt_password()
-@opt_client_id
-@opt_client_secret
-@opt_sops
-@opt_yes_no
-@opt_extra
+@opt_client_id()
+@opt_client_secret()
+@opt_sops()
+@opt_yes_no()
+@opt_extra()
 @click.pass_context
 @recast_exceptions_to_click(AuthException, ValueError)
 def cmd_oauth_login(
@@ -132,7 +132,7 @@ def cmd_oauth_login(
 
 
 @cmd_oauth.command("refresh")
-@opt_scope
+@opt_scope()
 @click.pass_context
 @recast_exceptions_to_click(AuthException, FileNotFoundError)
 def cmd_oauth_refresh(ctx, scope):
@@ -185,7 +185,7 @@ def cmd_oauth_discovery(ctx):
 
 @cmd_oauth.command("validate-access-token")
 @click.pass_context
-@opt_human_readable
+@opt_human_readable()
 @recast_exceptions_to_click(AuthException, FileNotFoundError)
 def cmd_oauth_validate_access_token_remote(ctx, human_readable):
     """
@@ -207,8 +207,8 @@ def cmd_oauth_validate_access_token_remote(ctx, human_readable):
 @cmd_oauth.command("validate-access-token-local")
 @click.pass_context
 @opt_audience()
-@opt_scope
-@opt_human_readable
+@opt_scope()
+@opt_human_readable()
 @recast_exceptions_to_click(AuthException, FileNotFoundError)
 def cmd_oauth_validate_access_token_local(ctx, audience, scope, human_readable):
     """
@@ -239,7 +239,7 @@ def cmd_oauth_validate_access_token_local(ctx, audience, scope, human_readable):
 
 @cmd_oauth.command("validate-id-token")
 @click.pass_context
-@opt_human_readable
+@opt_human_readable()
 @recast_exceptions_to_click(AuthException, FileNotFoundError)
 def cmd_oauth_validate_id_token_remote(ctx, human_readable):
     """
@@ -260,7 +260,7 @@ def cmd_oauth_validate_id_token_remote(ctx, human_readable):
 
 @cmd_oauth.command("validate-id-token-local")
 @click.pass_context
-@opt_human_readable
+@opt_human_readable()
 @recast_exceptions_to_click(AuthException, FileNotFoundError)
 def cmd_oauth_validate_id_token_local(ctx, human_readable):
     """
@@ -280,7 +280,7 @@ def cmd_oauth_validate_id_token_local(ctx, human_readable):
 
 @cmd_oauth.command("validate-refresh-token")
 @click.pass_context
-@opt_human_readable
+@opt_human_readable()
 @recast_exceptions_to_click(AuthException, FileNotFoundError)
 def cmd_oauth_validate_refresh_token_remote(ctx, human_readable):
     """
@@ -357,7 +357,7 @@ def cmd_oauth_userinfo(ctx):
 
 @cmd_oauth.command("print-access-token")
 @click.pass_context
-@opt_refresh
+@opt_refresh()
 @recast_exceptions_to_click(AuthException, FileNotFoundError)
 def cmd_oauth_print_access_token(ctx, refresh):
     """
@@ -390,7 +390,7 @@ def cmd_oauth_print_access_token(ctx, refresh):
 
 @cmd_oauth.command("decode-access-token")
 @click.pass_context
-@opt_human_readable
+@opt_human_readable()
 @recast_exceptions_to_click(AuthException, FileNotFoundError)
 def cmd_oauth_decode_jwt_access_token(ctx, human_readable):
     """
@@ -406,7 +406,7 @@ def cmd_oauth_decode_jwt_access_token(ctx, human_readable):
 
 @cmd_oauth.command("decode-id-token")
 @click.pass_context
-@opt_human_readable
+@opt_human_readable()
 @recast_exceptions_to_click(AuthException, FileNotFoundError)
 def cmd_oauth_decode_jwt_id_token(ctx, human_readable):
     """
@@ -420,7 +420,7 @@ def cmd_oauth_decode_jwt_id_token(ctx, human_readable):
 
 @cmd_oauth.command("decode-refresh-token")
 @click.pass_context
-@opt_human_readable
+@opt_human_readable()
 @recast_exceptions_to_click(AuthException, FileNotFoundError)
 def cmd_oauth_decode_jwt_refresh_token(ctx, human_readable):
     """