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

Author: carl-adams-planet

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

tests/test_planet_auth_utils/unit/auth_utils/builtins_test_impl.py

@@ -186,8 +186,5 @@ def builtin_default_profile_by_client_type(self) -> Dict[str, str]:
     def builtin_default_profile(self) -> str:
         return self.DEFAULT_PROFILE
 
-    def builtin_trust_environment_names(self) -> List[str]:
-        return list(BuiltinConfigurationProviderMockTestImpl._builtin_trust_realms.keys())
-
     def builtin_trust_environments(self) -> Dict[str, Optional[List[dict]]]:
         return BuiltinConfigurationProviderMockTestImpl._builtin_trust_realms