File: test_async_provider_refresh.py

package info (click to toggle)
python-azure 20251118%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 783,356 kB
  • sloc: python: 6,474,533; ansic: 804; javascript: 287; sh: 205; makefile: 198; xml: 109
file content (187 lines) | stat: -rw-r--r-- 8,715 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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import time
import unittest
import pytest
import sys

from azure.appconfiguration import ConfigurationSetting
from azure.appconfiguration.provider import WatchKey
from devtools_testutils.aio import recorded_by_proxy_async
from async_preparers import app_config_decorator_async
from testcase import has_feature_flag
from asynctestcase import AppConfigTestCase
from test_constants import FEATURE_MANAGEMENT_KEY
from unittest.mock import Mock

try:
    # Python 3.7 does not support AsyncMock
    from unittest.mock import AsyncMock

    class TestAppConfigurationProvider(AppConfigTestCase, unittest.TestCase):
        # method: refresh
        @app_config_decorator_async
        @recorded_by_proxy_async
        @pytest.mark.skipif(sys.version_info < (3, 8), reason="Python 3.7 does not support AsyncMock")
        @pytest.mark.asyncio
        async def test_refresh(self, appconfiguration_endpoint_string, appconfiguration_keyvault_secret_url):
            mock_callback = Mock()
            async with await self.create_client(
                endpoint=appconfiguration_endpoint_string,
                keyvault_secret_url=appconfiguration_keyvault_secret_url,
                refresh_on=[WatchKey("refresh_message")],
                refresh_interval=1,
                on_refresh_success=mock_callback,
                feature_flag_enabled=True,
                feature_flag_refresh_enabled=True,
            ) as client:
                assert client["refresh_message"] == "original value"
                assert client["my_json"]["key"] == "value"
                assert FEATURE_MANAGEMENT_KEY in client
                assert has_feature_flag(client, "Alpha")

                appconfig_client = self.create_aad_sdk_client(appconfiguration_endpoint_string)

                setting = await appconfig_client.get_configuration_setting(key="refresh_message")
                setting.value = "updated value"
                feature_flag = await appconfig_client.get_configuration_setting(key=".appconfig.featureflag/Alpha")
                feature_flag.enabled = True
                await appconfig_client.set_configuration_setting(setting)
                await appconfig_client.set_configuration_setting(feature_flag)

                # Waiting for the refresh interval to pass
                time.sleep(2)

                await client.refresh()
                assert client["refresh_message"] == "updated value"
                assert has_feature_flag(client, "Alpha", True)
                assert mock_callback.call_count == 1

                setting.value = "original value"
                feature_flag.enabled = False
                await appconfig_client.set_configuration_setting(setting)
                await appconfig_client.set_configuration_setting(feature_flag)

                # Waiting for the refresh interval to pass
                time.sleep(2)

                await client.refresh()
                assert client["refresh_message"] == "original value"
                assert has_feature_flag(client, "Alpha", False)
                assert mock_callback.call_count == 2

                setting.value = "updated value 2"
                feature_flag.enabled = True
                await appconfig_client.set_configuration_setting(setting)
                await appconfig_client.set_configuration_setting(feature_flag)

                # Not waiting for the refresh interval to pass
                await client.refresh()
                assert client["refresh_message"] == "original value"
                assert has_feature_flag(client, "Alpha", False)
                assert mock_callback.call_count == 2

                setting.value = "original value"
                await appconfig_client.set_configuration_setting(setting)

                await client.refresh()
                assert client["refresh_message"] == "original value"
                assert mock_callback.call_count == 2

        # method: refresh
        @app_config_decorator_async
        @recorded_by_proxy_async
        @pytest.mark.skipif(sys.version_info < (3, 8), reason="Python 3.7 does not support AsyncMock")
        @pytest.mark.asyncio
        async def test_no_refresh(self, appconfiguration_endpoint_string, appconfiguration_keyvault_secret_url):

            appconfig_client = self.create_aad_sdk_client(appconfiguration_endpoint_string)

            watch_key = ConfigurationSetting(key="watch key", value="0")
            await appconfig_client.set_configuration_setting(watch_key)

            mock_callback = Mock()
            async with await self.create_client(
                endpoint=appconfiguration_endpoint_string,
                keyvault_secret_url=appconfiguration_keyvault_secret_url,
                refresh_on=[WatchKey("watch key")],
                refresh_interval=1,
                on_refresh_success=mock_callback,
                feature_flag_enabled=True,
                feature_flag_refresh_enabled=True,
            ) as client:
                assert client["refresh_message"] == "original value"
                assert client["my_json"]["key"] == "value"
                assert FEATURE_MANAGEMENT_KEY in client
                assert has_feature_flag(client, "Alpha")

                setting = await appconfig_client.get_configuration_setting(key="refresh_message")
                setting.value = "updated value"
                await appconfig_client.set_configuration_setting(setting)

                # Waiting for the refresh interval to pass
                time.sleep(2)

                await client.refresh()
                # No Change the Watch Key wasn't updated
                assert client["refresh_message"] == "original value"
                assert has_feature_flag(client, "Alpha", False)
                assert mock_callback.call_count == 0

                watch_key.value = "1"
                await appconfig_client.set_configuration_setting(watch_key)

                # Waiting for the refresh interval to pass
                time.sleep(2)

                await client.refresh()
                assert client["refresh_message"] == "updated value"
                assert has_feature_flag(client, "Alpha", False)
                assert mock_callback.call_count == 1

        # method: refresh
        @app_config_decorator_async
        @recorded_by_proxy_async
        @pytest.mark.skipif(sys.version_info < (3, 8), reason="Python 3.7 does not support AsyncMock")
        @pytest.mark.asyncio
        async def test_empty_refresh(self, appconfiguration_endpoint_string, appconfiguration_keyvault_secret_url):
            mock_callback = AsyncMock()
            async with await self.create_client(
                endpoint=appconfiguration_endpoint_string,
                keyvault_secret_url=appconfiguration_keyvault_secret_url,
                on_refresh_success=mock_callback,
                feature_flag_enabled=True,
            ) as client:
                assert client["refresh_message"] == "original value"
                assert client["non_refreshed_message"] == "Static"
                assert client["my_json"]["key"] == "value"
                assert FEATURE_MANAGEMENT_KEY in client
                assert has_feature_flag(client, "Alpha")

                appconfig_client = self.create_aad_sdk_client(appconfiguration_endpoint_string)

                setting = await appconfig_client.get_configuration_setting(key="refresh_message")
                setting.value = "updated value"
                await appconfig_client.set_configuration_setting(setting)
                static_setting = await appconfig_client.get_configuration_setting(key="non_refreshed_message")
                static_setting.value = "updated static"
                await appconfig_client.set_configuration_setting(static_setting)

                # Waiting for the refresh interval to pass
                time.sleep(2)

                await client.refresh()
                assert client["refresh_message"] == "original value"
                assert client["non_refreshed_message"] == "Static"
                assert mock_callback.call_count == 0

                setting.value = "original value"
                await appconfig_client.set_configuration_setting(setting)
                static_setting.value = "Static"
                await appconfig_client.set_configuration_setting(static_setting)

except ImportError:
    pass