Move the constants for config injection into the built-in config interface module.

Author: carl-adams-planet

src/planet_auth_utils/builtins.py

@@ -17,9 +17,12 @@
 
 from planet_auth import AuthClientConfig
 from planet_auth_utils.profile import ProfileException
-from planet_auth_utils.constants import EnvironmentVariables
 from planet_auth.logging.auth_logger import getAuthLogger
-from .builtins_provider import BuiltinConfigurationProviderInterface, EmptyBuiltinProfileConstants
+from .builtins_provider import (
+    BuiltinConfigurationProviderInterface,
+    EmptyBuiltinProfileConstants,
+    AUTH_BUILTIN_PROVIDER,
+)
 
 auth_logger = getAuthLogger()
 
@@ -61,7 +64,7 @@ def _load_builtins() -> BuiltinConfigurationProviderInterface:
     #     Undermining it can undermine client or service security.
     #     It is a convenience for seamless developer experience, but maybe
     #     we should not be so eager to please.
-    builtin_provider = _load_builtins_worker(os.getenv(EnvironmentVariables.AUTH_BUILTIN_PROVIDER))
+    builtin_provider = _load_builtins_worker(os.getenv(AUTH_BUILTIN_PROVIDER))
     if builtin_provider:
         return builtin_provider
 

src/planet_auth_utils/builtins_provider.py

@@ -16,6 +16,16 @@
 from typing import Dict, List, Optional
 
 
+# Unlike other environment variables, AUTH_BUILTIN_PROVIDER is not name-spaced.
+# It is intended for libraries and applications to inject configuration by
+# being set within the program.  It's not generally expected to be set by
+# users.
+AUTH_BUILTIN_PROVIDER = "PL_AUTH_BUILTIN_CONFIG_PROVIDER"
+"""
+Specify a python module and class that implement the BuiltinConfigurationProviderInterface abstract
+interface to provide the library and utility commands with some built-in configurations.
+"""
+
 _NOOP_AUTH_CLIENT_CONFIG = {
     "client_type": "none",
 }

src/planet_auth_utils/constants.py

@@ -98,9 +98,3 @@ class EnvironmentVariables:
     """
     Specify the log level.
     """
-
-    AUTH_BUILTIN_PROVIDER = "PL_AUTH_BUILTIN_CONFIG_PROVIDER"
-    """
-    Specify a python module and class that implement the BuiltinConfigurationProviderInterface abstract
-    interface to provide the library and utility commands with some built-in configurations.
-    """

tests/test_planet_auth_utils/unit/auth_utils/test_builtins.py

@@ -16,8 +16,8 @@
 import pytest
 import unittest
 
+from planet_auth_utils.builtins_provider import AUTH_BUILTIN_PROVIDER
 from planet_auth_utils.builtins import Builtins, BuiltinsException
-from planet_auth_utils.constants import EnvironmentVariables
 
 from tests.test_planet_auth_utils.util import TestWithHomeDirProfiles
 from tests.test_planet_auth_utils.unit.auth_utils.builtins_test_impl import BuiltinConfigurationProviderMockTestImpl
@@ -56,7 +56,7 @@ def test_builtin_all_profile_dicts_are_valid(self):
 
 class TestAuthClientContextInitHelpers(TestWithHomeDirProfiles, unittest.TestCase):
     def setUp(self):
-        os.environ[EnvironmentVariables.AUTH_BUILTIN_PROVIDER] = (
+        os.environ[AUTH_BUILTIN_PROVIDER] = (
             "tests.test_planet_auth_utils.unit.auth_utils.builtins_test_impl.BuiltinConfigurationProviderMockTestImpl"
         )
         Builtins._builtin = None  # Reset built-in state.

tests/test_planet_auth_utils/unit/auth_utils/test_plauth_factory.py

@@ -20,6 +20,7 @@
 import planet_auth.storage_utils
 from planet_auth.constants import AUTH_CONFIG_FILE_PLAIN
 
+from planet_auth_utils.builtins_provider import AUTH_BUILTIN_PROVIDER
 from planet_auth_utils.builtins import Builtins
 from planet_auth_utils.constants import EnvironmentVariables
 from planet_auth_utils.plauth_factory import PlanetAuthFactory, MissingArgumentException
@@ -37,7 +38,7 @@
 
 class TestAuthClientContextInitHelpers(TestWithHomeDirProfiles, unittest.TestCase):
     def setUp(self):
-        os.environ[EnvironmentVariables.AUTH_BUILTIN_PROVIDER] = (
+        os.environ[AUTH_BUILTIN_PROVIDER] = (
             "tests.test_planet_auth_utils.unit.auth_utils.builtins_test_impl.BuiltinConfigurationProviderMockTestImpl"
         )
         Builtins._builtin = None  # Reset built-in state.
@@ -391,7 +392,7 @@ def test_save_profile_does_not_save_when_false(self):
 
 class TestResourceServerValidatorInitHelper(TestWithHomeDirProfiles, unittest.TestCase):
     def setUp(self):
-        os.environ[EnvironmentVariables.AUTH_BUILTIN_PROVIDER] = (
+        os.environ[AUTH_BUILTIN_PROVIDER] = (
             "tests.test_planet_auth_utils.unit.auth_utils.builtins_test_impl.BuiltinConfigurationProviderMockTestImpl"
         )
         Builtins._builtin = None  # Reset built-in state.