Skip to content

Expose GCP Secret Manager case sensitive option #626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 9, 2025
Merged

Expose GCP Secret Manager case sensitive option #626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c6a3531
Expose case sensitive
bellmatthewf Jun 2, 2025
83b9a69
Remove import
bellmatthewf Jun 2, 2025
843c214
Update tests
bellmatthewf Jun 2, 2025
c831539
Format
bellmatthewf Jun 2, 2025
d84cfc7
Improve readability
bellmatthewf Jun 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions pydantic_settings/sources/providers/gcp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,26 +37,34 @@ class GoogleSecretManagerMapping(Mapping[str, Optional[str]]):
_loaded_secrets: dict[str, str | None]
_secret_client: SecretManagerServiceClient

def __init__(self, secret_client: SecretManagerServiceClient, project_id: str) -> None:
def __init__(self, secret_client: SecretManagerServiceClient, project_id: str, case_sensitive: bool) -> None:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we need to define a default value for case_sensitive for backward compatibility?

Copy link
Contributor Author

@bellmatthewf bellmatthewf Jun 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Users should never be instantiating this class directly. The GoogleSecretManagerMapping class is only instantiated internally within the GoogleSecretManagerSettingsSource class.

I added a default value to the new case_sensitive parameter of that class which will carry through to here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bellmatthewf - That makes sense to me.

self._loaded_secrets = {}
self._secret_client = secret_client
self._project_id = project_id
self._case_sensitive = case_sensitive

@property
def _gcp_project_path(self) -> str:
return self._secret_client.common_project_path(self._project_id)

@cached_property
def _secret_names(self) -> list[str]:
return [
self._secret_client.parse_secret_path(secret.name).get('secret', '')
for secret in self._secret_client.list_secrets(parent=self._gcp_project_path)
]
rv: list[str] = []

secrets = self._secret_client.list_secrets(parent=self._gcp_project_path)
for secret in secrets:
name = self._secret_client.parse_secret_path(secret.name).get('secret', '')
if not self._case_sensitive:
name = name.lower()
rv.append(name)
return rv

def _secret_version_path(self, key: str, version: str = 'latest') -> str:
return self._secret_client.secret_version_path(self._project_id, key, version)

def __getitem__(self, key: str) -> str | None:
if not self._case_sensitive:
key = key.lower()
if key not in self._loaded_secrets:
# If we know the key isn't available in secret manager, raise a key error
if key not in self._secret_names:
Expand Down Expand Up @@ -92,6 +100,7 @@ def __init__(
env_parse_none_str: str | None = None,
env_parse_enums: bool | None = None,
secret_client: SecretManagerServiceClient | None = None,
case_sensitive: bool | None = True,
) -> None:
# Import Google Packages if they haven't already been imported
if SecretManagerServiceClient is None or Credentials is None or google_auth_default is None:
Expand Down Expand Up @@ -124,15 +133,17 @@ def __init__(

super().__init__(
settings_cls,
case_sensitive=True,
case_sensitive=case_sensitive,
env_prefix=env_prefix,
env_ignore_empty=False,
env_parse_none_str=env_parse_none_str,
env_parse_enums=env_parse_enums,
)

def _load_env_vars(self) -> Mapping[str, Optional[str]]:
return GoogleSecretManagerMapping(self._secret_client, project_id=self._project_id)
return GoogleSecretManagerMapping(
self._secret_client, project_id=self._project_id, case_sensitive=self.case_sensitive
)

def __repr__(self) -> str:
return f'{self.__class__.__name__}(project_id={self._project_id!r}, env_nested_delimiter={self.env_nested_delimiter!r})'
Expand Down
9 changes: 8 additions & 1 deletion tests/test_source_gcp_secret_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ def mock_access_secret_version(name: str):

@pytest.fixture
def secret_manager_mapping(mock_secret_client):
return GoogleSecretManagerMapping(mock_secret_client, 'test-project')
return GoogleSecretManagerMapping(mock_secret_client, project_id='test-project', case_sensitive=True)


@pytest.fixture
Expand Down Expand Up @@ -96,6 +96,13 @@ def test_secret_manager_mapping_getitem_success(self, secret_manager_mapping):
value = secret_manager_mapping['test-secret']
assert value == 'test-value'

def test_secret_manager_mapping_getitem_case_insensitive_success(self, mock_secret_client):
case_insensitive_mapping = GoogleSecretManagerMapping(
mock_secret_client, project_id='test-project', case_sensitive=False
)
value = case_insensitive_mapping['TEST-SECRET']
assert value == 'test-value'

def test_secret_manager_mapping_getitem_nonexistent_key(self, secret_manager_mapping):
with pytest.raises(KeyError):
_ = secret_manager_mapping['nonexistent-secret']
Expand Down