File: test_source_aws_secrets_manager.py

package info (click to toggle)
pydantic-settings 2.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,180 kB
  • sloc: python: 11,040; makefile: 33
file content (160 lines) | stat: -rw-r--r-- 5,452 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
"""
Test pydantic_settings.AWSSecretsManagerSettingsSource.
"""

import json
import os

import pytest

try:
    import yaml
    from moto import mock_aws
except ImportError:
    yaml = None
    mock_aws = None

from pydantic import BaseModel, Field

from pydantic_settings import (
    AWSSecretsManagerSettingsSource,
    BaseSettings,
    PydanticBaseSettingsSource,
)
from pydantic_settings.sources.providers.aws import import_aws_secrets_manager

try:
    aws_secrets_manager = True
    import_aws_secrets_manager()
    import boto3

    os.environ['AWS_DEFAULT_REGION'] = os.environ.get('AWS_DEFAULT_REGION', 'us-east-1')
except ImportError:
    aws_secrets_manager = False


MODULE = 'pydantic_settings.sources'

if not yaml:
    pytest.skip('PyYAML is not installed', allow_module_level=True)


@pytest.mark.skipif(not aws_secrets_manager, reason='pydantic-settings[aws-secrets-manager] is not installed')
class TestAWSSecretsManagerSettingsSource:
    """Test AWSSecretsManagerSettingsSource."""

    @mock_aws
    def test_repr(self) -> None:
        client = boto3.client('secretsmanager')
        client.create_secret(Name='test-secret', SecretString='{}')

        source = AWSSecretsManagerSettingsSource(BaseSettings, 'test-secret')
        assert repr(source) == "AWSSecretsManagerSettingsSource(secret_id='test-secret', env_nested_delimiter='--')"

    @mock_aws
    def test___init__(self) -> None:
        """Test __init__."""

        class AWSSecretsManagerSettings(BaseSettings):
            """AWSSecretsManager settings."""

        client = boto3.client('secretsmanager')
        client.create_secret(Name='test-secret', SecretString='{}')

        AWSSecretsManagerSettingsSource(AWSSecretsManagerSettings, 'test-secret')

    @mock_aws
    def test___call__(self) -> None:
        """Test __call__."""

        class SqlServer(BaseModel):
            password: str = Field(..., alias='Password')

        class AWSSecretsManagerSettings(BaseSettings):
            """AWSSecretsManager settings."""

            sql_server_user: str = Field(..., alias='SqlServerUser')
            sql_server: SqlServer = Field(..., alias='SqlServer')

        secret_data = {'SqlServerUser': 'test-user', 'SqlServer--Password': 'test-password'}

        client = boto3.client('secretsmanager')
        client.create_secret(Name='test-secret', SecretString=json.dumps(secret_data))

        obj = AWSSecretsManagerSettingsSource(AWSSecretsManagerSettings, 'test-secret')

        settings = obj()

        assert settings['SqlServerUser'] == 'test-user'
        assert settings['SqlServer']['Password'] == 'test-password'

    @mock_aws
    def test_secret_manager_case_insensitive_success(self) -> None:
        """Test secret manager getitem case insensitive success."""

        class SqlServer(BaseModel):
            password: str = Field(..., alias='Password')

        class AWSSecretsManagerSettings(BaseSettings):
            """AWSSecretsManager settings."""

            sql_server_user: str
            sql_server: SqlServer

            @classmethod
            def settings_customise_sources(
                cls,
                settings_cls: type[BaseSettings],
                init_settings: PydanticBaseSettingsSource,
                env_settings: PydanticBaseSettingsSource,
                dotenv_settings: PydanticBaseSettingsSource,
                file_secret_settings: PydanticBaseSettingsSource,
            ) -> tuple[PydanticBaseSettingsSource, ...]:
                return (AWSSecretsManagerSettingsSource(settings_cls, 'test-secret', case_sensitive=False),)

        secret_data = {
            'SQL_SERVER_USER': 'test-user',
            'SQL_SERVER--PASSWORD': 'test-password',
        }

        client = boto3.client('secretsmanager')
        client.create_secret(Name='test-secret', SecretString=json.dumps(secret_data))

        settings = AWSSecretsManagerSettings()  # type: ignore

        assert settings.sql_server_user == 'test-user'
        assert settings.sql_server.password == 'test-password'

    @mock_aws
    def test_aws_secrets_manager_settings_source(self) -> None:
        """Test AWSSecretsManagerSettingsSource."""

        class SqlServer(BaseModel):
            password: str = Field(..., alias='Password')

        class AWSSecretsManagerSettings(BaseSettings):
            """AWSSecretsManager settings."""

            sql_server_user: str = Field(..., alias='SqlServerUser')
            sql_server: SqlServer = Field(..., alias='SqlServer')

            @classmethod
            def settings_customise_sources(
                cls,
                settings_cls: type[BaseSettings],
                init_settings: PydanticBaseSettingsSource,
                env_settings: PydanticBaseSettingsSource,
                dotenv_settings: PydanticBaseSettingsSource,
                file_secret_settings: PydanticBaseSettingsSource,
            ) -> tuple[PydanticBaseSettingsSource, ...]:
                return (AWSSecretsManagerSettingsSource(settings_cls, 'test-secret'),)

        secret_data = {'SqlServerUser': 'test-user', 'SqlServer--Password': 'test-password'}

        client = boto3.client('secretsmanager')
        client.create_secret(Name='test-secret', SecretString=json.dumps(secret_data))

        settings = AWSSecretsManagerSettings()  # type: ignore

        assert settings.sql_server_user == 'test-user'
        assert settings.sql_server.password == 'test-password'