Beta feedback 1 - login command ergonomics - Initial cleanup (#31)

* avoid degenerate variable names

* allow env var to be None for click CLI options.

* profile names are not case sensitive. Avoid silly prompts.

* Make what configs are consulted configurable

Author: carl-adams-planet

src/planet_auth_utils/commands/cli/options.py

@@ -14,7 +14,7 @@
 
 import click
 import pathlib
-from typing import Any, Callable
+from typing import Any, Callable, Optional
 
 from planet_auth_utils.constants import EnvironmentVariables
 
@@ -25,7 +25,7 @@
 # TODO: Should we make "required" param universal for all options?
 #     Maybe rather than being so prescriptive, we pass **kwargs to click options?
 def opt_api_key(
-    default=None, hidden: bool = False, envvar: str = EnvironmentVariables.AUTH_API_KEY
+    default=None, hidden: bool = False, envvar: Optional[str] = EnvironmentVariables.AUTH_API_KEY
 ) -> _click_option_decorator_type:
     """
     Click option for specifying an API key
@@ -48,7 +48,7 @@ def decorator(function) -> _click_option_decorator_type:
 
 
 def opt_audience(
-    default=None, hidden: bool = False, required=False, envvar: str = EnvironmentVariables.AUTH_AUDIENCE
+    default=None, hidden: bool = False, required=False, envvar: Optional[str] = EnvironmentVariables.AUTH_AUDIENCE
 ) -> _click_option_decorator_type:
     """
     Click option for specifying an OAuth token audience for the
@@ -76,7 +76,7 @@ def decorator(function) -> _click_option_decorator_type:
 
 
 def opt_client_id(
-    default=None, hidden: bool = False, envvar: str = EnvironmentVariables.AUTH_CLIENT_ID
+    default=None, hidden: bool = False, envvar: Optional[str] = EnvironmentVariables.AUTH_CLIENT_ID
 ) -> _click_option_decorator_type:
     """
     Click option for specifying an OAuth client ID.
@@ -99,7 +99,7 @@ def decorator(function) -> _click_option_decorator_type:
 
 
 def opt_client_secret(
-    default=None, hidden: bool = False, envvar: str = EnvironmentVariables.AUTH_CLIENT_SECRET
+    default=None, hidden: bool = False, envvar: Optional[str] = EnvironmentVariables.AUTH_CLIENT_SECRET
 ) -> _click_option_decorator_type:
     """
     Click option for specifying an OAuth client secret.
@@ -122,7 +122,7 @@ def decorator(function) -> _click_option_decorator_type:
 
 
 def opt_extra(
-    default=None, hidden: bool = False, envvar: str = EnvironmentVariables.AUTH_EXTRA
+    default=None, hidden: bool = False, envvar: Optional[str] = EnvironmentVariables.AUTH_EXTRA
 ) -> _click_option_decorator_type:
     """
     Click option for specifying extra options.
@@ -169,7 +169,7 @@ def decorator(function) -> _click_option_decorator_type:
 
 
 def opt_issuer(
-    default=None, hidden: bool = False, required=False, envvar: str = EnvironmentVariables.AUTH_ISSUER
+    default=None, hidden: bool = False, required=False, envvar: Optional[str] = EnvironmentVariables.AUTH_ISSUER
 ) -> _click_option_decorator_type:
     """
     Click option for specifying an OAuth token issuer for the
@@ -194,7 +194,7 @@ def decorator(function) -> _click_option_decorator_type:
 
 
 def opt_loglevel(
-    default="INFO", hidden: bool = False, envvar: str = EnvironmentVariables.AUTH_LOGLEVEL
+    default="INFO", hidden: bool = False, envvar: Optional[str] = EnvironmentVariables.AUTH_LOGLEVEL
 ) -> _click_option_decorator_type:
     """
     Click option for specifying a log level.
@@ -257,7 +257,7 @@ def decorator(function) -> _click_option_decorator_type:
 
 
 def opt_organization(
-    default=None, hidden: bool = False, envvar: str = EnvironmentVariables.AUTH_ORGANIZATION
+    default=None, hidden: bool = False, envvar: Optional[str] = EnvironmentVariables.AUTH_ORGANIZATION
 ) -> _click_option_decorator_type:
     """
     Click option for specifying an Organization.
@@ -287,7 +287,7 @@ def decorator(function) -> _click_option_decorator_type:
 #         lib also handles things like browser interaction this is not entirely easy to abstract
 #         away.
 def opt_password(
-    default=None, hidden: bool = True, envvar: str = EnvironmentVariables.AUTH_PASSWORD
+    default=None, hidden: bool = True, envvar: Optional[str] = EnvironmentVariables.AUTH_PASSWORD
 ) -> _click_option_decorator_type:
     """
     Click option for specifying a password for the
@@ -311,7 +311,7 @@ def decorator(function) -> _click_option_decorator_type:
 
 
 def opt_profile(
-    default=None, hidden: bool = False, envvar: str = EnvironmentVariables.AUTH_PROFILE
+    default=None, hidden: bool = False, envvar: Optional[str] = EnvironmentVariables.AUTH_PROFILE
 ) -> _click_option_decorator_type:
     """
     Click option for specifying an auth profile for the
@@ -336,7 +336,7 @@ def decorator(function) -> _click_option_decorator_type:
 
 
 def opt_project(
-    default=None, hidden: bool = False, envvar: str = EnvironmentVariables.AUTH_PROJECT
+    default=None, hidden: bool = False, envvar: Optional[str] = EnvironmentVariables.AUTH_PROJECT
 ) -> _click_option_decorator_type:
     """
     Click option for specifying a project ID.
@@ -397,7 +397,7 @@ def decorator(function) -> _click_option_decorator_type:
 
 
 def opt_token(
-    default=None, hidden: bool = False, envvar: str = EnvironmentVariables.AUTH_TOKEN
+    default=None, hidden: bool = False, envvar: Optional[str] = EnvironmentVariables.AUTH_TOKEN
 ) -> _click_option_decorator_type:
     """
     Click option for specifying a token literal.
@@ -421,7 +421,7 @@ def decorator(function) -> _click_option_decorator_type:
 
 
 def opt_scope(
-    default=None, hidden: bool = False, envvar: str = EnvironmentVariables.AUTH_SCOPE
+    default=None, hidden: bool = False, envvar: Optional[str] = EnvironmentVariables.AUTH_SCOPE
 ) -> _click_option_decorator_type:
     """
     Click option for specifying an OAuth token scope for the
@@ -468,7 +468,7 @@ def decorator(function) -> _click_option_decorator_type:
 
 
 def opt_token_file(
-    default=None, hidden: bool = False, envvar: str = EnvironmentVariables.AUTH_TOKEN_FILE
+    default=None, hidden: bool = False, envvar: Optional[str] = EnvironmentVariables.AUTH_TOKEN_FILE
 ) -> _click_option_decorator_type:
     """
     Click option for specifying a token file location for the
@@ -492,7 +492,7 @@ def decorator(function) -> _click_option_decorator_type:
 
 
 def opt_username(
-    default=None, hidden: bool = True, envvar: str = EnvironmentVariables.AUTH_USERNAME
+    default=None, hidden: bool = True, envvar: Optional[str] = EnvironmentVariables.AUTH_USERNAME
 ) -> _click_option_decorator_type:
     """
     Click option for specifying a username for the

src/planet_auth_utils/commands/cli/prompts.py

@@ -44,7 +44,7 @@ def prompt_and_change_user_default_profile_if_different(
         do_change_default = change_default_selection
     else:
         do_change_default = False
-        if saved_profile_name != candidate_profile_name:
+        if str.lower(saved_profile_name) != str.lower(candidate_profile_name):
             # do_change_default = yes_no_dialog(
             #     title=f'Change user default {EnvironmentVariables.AUTH_PROFILE} saved in {config_file.path()}?',
             #     text=f'Current value and user default differ.\nDo you want to change the user default {EnvironmentVariables.AUTH_PROFILE} from "{saved_profile_name}" to "{candidate_profile_name}"?',

src/planet_auth_utils/constants.py

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import Optional
+
 from planet_auth_utils.builtins import Builtins
 
 
@@ -29,15 +31,15 @@ class EnvironmentVariables:
     """
 
     @staticmethod
-    def _namespace_variable(undecorated_variable: str):
+    def _namespace_variable(undecorated_variable: Optional[str]):
         """
         Decorate the variable name with a namespace.
         This is done so that multiple applications may use
         the Planet auth library without conflicting.
         """
 
         namespace = Builtins.namespace()
-        if namespace:
+        if namespace and undecorated_variable:
             return f"{namespace.upper()}_{undecorated_variable}"
         return undecorated_variable
 

src/planet_auth_utils/plauth_factory.py

@@ -243,6 +243,8 @@ def initialize_auth_client_context(
         # TODO?: initial_token_data: dict = None,
         save_token_file: bool = True,
         save_profile_config: bool = False,
+        use_env: bool = True,
+        use_configfile: bool = True,
         # Not supporting custom storage providers at this time.
         # The preferred behavior of Profiles with custom storage providers is TBD.
         # storage_provider: Optional[ObjectStorageProvider] = None,
@@ -312,6 +314,8 @@ def my_cli_main(ctx, auth_profile, auth_client_id, auth_client_secret):
             save_token_file: Whether to save the access token to disk.  If `False`, in-memory
                 operation will be used, and login sessions will not be persisted locally.
             save_profile_config: Whether to save the profile configuration to disk.
+            use_env: Whether to use environment variables to determine configuration values.
+            use_configfile: Whether to use configuration files to determine configuration values.
         """
         #
         # Initialize from explicit user selected options
@@ -346,6 +350,8 @@ def my_cli_main(ctx, auth_profile, auth_client_id, auth_client_secret):
         effective_user_selected_profile = user_config_file.effective_conf_value(
             config_key=EnvironmentVariables.AUTH_PROFILE,
             override_value=auth_profile_opt,
+            use_env=use_env,
+            use_configfile=use_configfile,
         )
         if effective_user_selected_profile:
             try:
@@ -365,10 +371,14 @@ def my_cli_main(ctx, auth_profile, auth_client_id, auth_client_secret):
         effective_user_selected_client_id = user_config_file.effective_conf_value(
             config_key=EnvironmentVariables.AUTH_CLIENT_ID,
             override_value=auth_client_id_opt,
+            use_env=use_env,
+            use_configfile=use_configfile,
         )
         effective_user_selected_client_secret = user_config_file.effective_conf_value(
             config_key=EnvironmentVariables.AUTH_CLIENT_SECRET,
             override_value=auth_client_secret_opt,
+            use_env=use_env,
+            use_configfile=use_configfile,
         )
         if effective_user_selected_client_id and effective_user_selected_client_secret:
             return PlanetAuthFactory._init_context_from_oauth_svc_account(
@@ -383,16 +393,19 @@ def my_cli_main(ctx, auth_profile, auth_client_id, auth_client_secret):
         effective_user_selected_api_key = user_config_file.effective_conf_value(
             config_key=EnvironmentVariables.AUTH_API_KEY,
             override_value=auth_api_key_opt,
+            use_env=use_env,
+            use_configfile=use_configfile,
         )
         if effective_user_selected_api_key:
             return PlanetAuthFactory._init_context_from_api_key(
                 api_key=effective_user_selected_api_key,
             )
 
         effective_user_selected_api_key = user_config_file.effective_conf_value(
-            config_key="key",  # For backwards compatibility
+            config_key="key",  # For backwards compatibility, we know the old SDK used this in json files.
             override_value=auth_api_key_opt,
             use_env=False,
+            use_configfile=use_configfile,
         )
         if effective_user_selected_api_key:
             return PlanetAuthFactory._init_context_from_api_key(