Skip to content

[App Config] Sanitize resource group name in data-plane test recordings #33906

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

Open
Christine Wanjau (ChristineWanjau) wants to merge 4 commits into
base: dev
Choose a base branch
from
+1,314 −1,237
Open

[App Config] Sanitize resource group name in data-plane test recordings #33906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1e4ada9
[App Config] Sanitize resource group name in data-plane test recordings
Aug 17, 2026
d736883
Potential fix for pull request finding
ChristineWanjau Aug 18, 2026
522c472
fix live tests
Aug 19, 2026
df36ec8
fix live tests
Aug 19, 2026
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
59 changes: 53 additions & 6 deletions src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/_test_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import json
import os

from azure.cli.testsdk import ResourceGroupPreparer
from azure.cli.testsdk.scenario_tests import RecordingProcessor
from azure.cli.testsdk.scenario_tests.utilities import is_json_payload
from azure.cli.core.util import shell_safe_json_parse
Expand All @@ -28,12 +29,24 @@ def get_resource_name_prefix(prefix):
resource_prefix = _get_local_test_resource_prefix()
return prefix if resource_prefix is None else resource_prefix + prefix

def get_test_resource_group():
# Data-plane tests use Microsoft Entra ID (--auth-mode login) against a store whose local auth
# is disabled. The recording principal must already hold "App Configuration Data Owner" at a
# scope covering the store, so tests target a fixed resource group with that standing role
# instead of an ephemeral @ResourceGroupPreparer group. Override via AZURE_CLI_APPCONFIG_TEST_RG.
return os.environ.get("AZURE_CLI_APPCONFIG_TEST_RG", "mametcal-python")
# Value the reused live test resource group (AZURE_CLI_TEST_DEV_RESOURCE_GROUP_NAME) is rewritten to
# in recordings by ResourceGroupNameReplacer. Matches the default ResourceGroupPreparer() moniker.
SANITIZED_TEST_RESOURCE_GROUP = "clitest.rg000001"


class AppConfigResourceGroupPreparer(ResourceGroupPreparer):
""" ResourceGroupPreparer that keeps moniker numbering aligned when reusing a dev resource group.

In dev-setting mode the base preparer returns early without calling live_only_execute, so it never
advances test_resources_count during recording the way it does in playback. That would desync
create_random_name numbering (e.g. store000001 vs store000002) between recording and playback, so
touch the moniker here to consume the same counter slot in both modes.
"""

def create_resource(self, name, **kwargs):
if self.dev_setting_name:
_ = self.moniker
return super().create_resource(name, **kwargs)


def _case_insensitive_query_matcher(r1, r2):
Expand Down Expand Up @@ -86,9 +99,43 @@ def process_response(self, response):
return response


class ResourceGroupNameReplacer(RecordingProcessor):
""" Scrub the reused live test resource group name from recordings.

Data-plane tests reuse a pre-provisioned resource group (AZURE_CLI_TEST_DEV_RESOURCE_GROUP_NAME)
that holds a standing "App Configuration Data Owner" role. ResourceGroupPreparer does not sanitize
a dev-setting resource group, so rewrite it to the moniker ResourceGroupPreparer uses in playback.
"""

def __init__(self):
self._real_rg = os.environ.get("AZURE_CLI_TEST_DEV_RESOURCE_GROUP_NAME")

def _scrub(self, value):
if self._real_rg and value:
return value.replace(self._real_rg, SANITIZED_TEST_RESOURCE_GROUP)
return value

def process_request(self, request):
request.uri = self._scrub(request.uri)
if isinstance(request.body, bytes):
try:
request.body = self._scrub(request.body.decode('utf-8')).encode('utf-8')
except UnicodeDecodeError:
pass
elif request.body:
request.body = self._scrub(request.body)
return request

def process_response(self, response):
if response.get('body', {}).get('string'):
response['body']['string'] = self._scrub(response['body']['string'])
return response


def register_appconfig_recording_processors(test):
""" Register App Configuration-specific recording processors on the test. """
test.recording_processors.append(OperationLocationSanitizer(test.name_replacer))
test.recording_processors.append(ResourceGroupNameReplacer())

class CredentialResponseSanitizer(RecordingProcessor):
def process_response(self, response):
Expand Down
230 changes: 115 additions & 115 deletions ..._modules/appconfig/tests/latest/recordings/test_appconfig_to_appconfig_import_export.yaml
View file
Open in desktop

Large diffs are not rendered by default.

120 changes: 60 additions & 60 deletions ...li/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_feature.yaml
View file
Open in desktop

Large diffs are not rendered by default.

72 changes: 36 additions & 36 deletions ...e/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_feature_filter.yaml
View file
Open in desktop

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions .../command_modules/appconfig/tests/latest/recordings/test_azconfig_feature_namespacing.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ interactions:
User-Agent:
- AZURECLI/2.88.0 azsdk-python-core/1.39.0 Python/3.14.3 (Windows-11-10.0.26200-SP0)
method: PUT
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mametcal-python/providers/Microsoft.AppConfiguration/configurationStores/featurenamespacetest000001?api-version=2025-08-01-preview
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clitest.rg000001/providers/Microsoft.AppConfiguration/configurationStores/featurenamespacetest000002?api-version=2025-08-01-preview
response:
body:
string: '{"type": "Microsoft.AppConfiguration/configurationStores", "location":
Expand All @@ -30,8 +30,8 @@ interactions:
"privateEndpointConnections": null, "disableLocalAuth": null, "softDeleteRetentionInDays":
null, "defaultKeyValueRevisionRetentionPeriodInSeconds": null, "enablePurgeProtection":
null, "dataPlaneProxy": null, "telemetry": null, "azureFrontDoor": null},
"sku": {"name": "Standard"}, "systemData": null, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mametcal-python/providers/Microsoft.AppConfiguration/configurationStores/featurenamespacetest000001",
"name": "featurenamespacetest000001", "tags": {}}'
"sku": {"name": "Standard"}, "systemData": null, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clitest.rg000001/providers/Microsoft.AppConfiguration/configurationStores/featurenamespacetest000002",
"name": "featurenamespacetest000002", "tags": {}}'
headers:
azure-asyncoperation:
- https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.AppConfiguration/locations/eastus/operationsStatus/Y29uZmlndXJhdGlvblN0b3Jlcw.cJ5BjhSPKSmVDT5-_QMzwrtr7aRT15UwzxrWV83BNyE?api-version=2025-08-01-preview&t=639186261997872239&c=MIIHlDCCBnygAwIBAgIQAcfN_Jd6ViGd1-EkFH97aDANBgkqhkiG9w0BAQsFADA2MTQwMgYDVQQDEytDQ01FIEcxIFRMUyBSU0EgMjA0OCBTSEEyNTYgMjA0OSBFVVMyIENBIDAxMB4XDTI2MDQwOTA0MzUxMFoXDTI2MTAwNDEwMzUxMFowQDE-MDwGA1UEAxM1YXN5bmNvcGVyYXRpb25zaWduaW5nY2VydGlmaWNhdGUubWFuYWdlbWVudC5henVyZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9nzXnnnT0V5cDY5fHgY6fvt0f5K67TLY5rf3kXsgNDiGJL9Ub1_cJuWgTTjGYmxaPP6HFz_YOLdMBGPkVhZavejw0qLifjw8nEBivhzrnSlLVzv8ThjIxvzYq7Pixu564lZgpE4tktNQwXrbdQ8_M_ltt8Ia4jO8Wc47QJt-BIUGY10RRyuDzAEGrQRCDbQB1Kyo6IjF95ihEDSUcGthqOIsbqMERKgZokdpO3a8ikGNKVtOb3zrePXR71iCDdkdamGIsPVfGxaBtUDO5vqdKugYbOQDFCYaQdk7x3VINyRpvZXpU4-B41mD-vXX5Rm_X9BL0jN1rjSRIFvfK3YkxAgMBAAGjggSSMIIEjjCBnQYDVR0gBIGVMIGSMAwGCisGAQQBgjd7AQEwZgYKKwYBBAGCN3sCAjBYMFYGCCsGAQUFBwICMEoeSAAzADMAZQAwADEAOQAyADEALQA0AGQANgA0AC0ANABmADgAYwAtAGEAMAA1ADUALQA1AGIAZABhAGYAZgBkADUAZQAzADMAZDAMBgorBgEEAYI3ewMCMAwGCisGAQQBgjd7BAIwDAYDVR0TAQH_BAIwADAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwDgYDVR0PAQH_BAQDAgWgMB0GA1UdDgQWBBRktXyyceQOrjzGGHfthVAJlrP3gjAfBgNVHSMEGDAWgBT87D7bqnwfgh4FuKEG-UPnArMKuTCCAbIGA1UdHwSCAakwggGlMGmgZ6BlhmNodHRwOi8vcHJpbWFyeS1jZG4ucGtpLmNvcmUud2luZG93cy5uZXQvZWFzdHVzMi9jcmxzL2NjbWVlYXN0dXMycGtpL2NjbWVlYXN0dXMyaWNhMDEvNzIvY3VycmVudC5jcmwwa6BpoGeGZWh0dHA6Ly9zZWNvbmRhcnktY2RuLnBraS5jb3JlLndpbmRvd3MubmV0L2Vhc3R1czIvY3Jscy9jY21lZWFzdHVzMnBraS9jY21lZWFzdHVzMmljYTAxLzcyL2N1cnJlbnQuY3JsMFqgWKBWhlRodHRwOi8vY3JsLm1pY3Jvc29mdC5jb20vZWFzdHVzMi9jcmxzL2NjbWVlYXN0dXMycGtpL2NjbWVlYXN0dXMyaWNhMDEvNzIvY3VycmVudC5jcmwwb6BtoGuGaWh0dHA6Ly9jY21lZWFzdHVzMnBraS5lYXN0dXMyLnBraS5jb3JlLndpbmRvd3MubmV0L2NlcnRpZmljYXRlQXV0aG9yaXRpZXMvY2NtZWVhc3R1czJpY2EwMS83Mi9jdXJyZW50LmNybDCCAbcGCCsGAQUFBwEBBIIBqTCCAaUwbAYIKwYBBQUHMAKGYGh0dHA6Ly9wcmltYXJ5LWNkbi5wa2kuY29yZS53aW5kb3dzLm5ldC9lYXN0dXMyL2NhY2VydHMvY2NtZWVhc3R1czJwa2kvY2NtZWVhc3R1czJpY2EwMS9jZXJ0LmNlcjBuBggrBgEFBQcwAoZiaHR0cDovL3NlY29uZGFyeS1jZG4ucGtpLmNvcmUud2luZG93cy5uZXQvZWFzdHVzMi9jYWNlcnRzL2NjbWVlYXN0dXMycGtpL2NjbWVlYXN0dXMyaWNhMDEvY2VydC5jZXIwXQYIKwYBBQUHMAKGUWh0dHA6Ly9jcmwubWljcm9zb2Z0LmNvbS9lYXN0dXMyL2NhY2VydHMvY2NtZWVhc3R1czJwa2kvY2NtZWVhc3R1czJpY2EwMS9jZXJ0LmNlcjBmBggrBgEFBQcwAoZaaHR0cDovL2NjbWVlYXN0dXMycGtpLmVhc3R1czIucGtpLmNvcmUud2luZG93cy5uZXQvY2VydGlmaWNhdGVBdXRob3JpdGllcy9jY21lZWFzdHVzMmljYTAxMA0GCSqGSIb3DQEBCwUAA4IBAQBx5I6Sofmi5yGOz0alPqrZuIh1Qv1Gc7iCefJl7OITobABfs9PqLqAUqQ0NZt02K2ag8zFQWRLn3xJESxYpGcBV7meAUTJOJhRHdvwqFTOMyPwYKbVpl-gdceRQV0J4MdXD1EG8ZfrQqJh4yTpH9fs1bJNlNwJZx_jinURgGNM3AvMcEe8RipqTE4QFDEFqJqWftJzvHLBetVu8Z6AGm5099Z3hgXzQkneb6E4dITNtuFdibgZ_w2TYC64wJ1VSMZoWDioo50604N9fZooi7RvEeWH1iooHPyFIUtevrquxTYiMdLAwbW0FzEjba2h2TLxHn3wd3uzwLiJoLGRIzBT&s=FKoaM662GTabinRh5fUqD0dje2tdAgwApwwEgI1JTCHxL8tgtXXG5mCJMw28jy3ppABvQ4KK6uilJeLIUw1eCmylmhvwXQoyonc5o4EKdvTB6jn9agnzHalgNy8L-htiYIDaSgqjFcR2qSQ3FfdUEUC0K6-E9BW4iWrae0Je8S9UfwUU6GnoIRIZzQPqo8Tjx3ZY_bD5jgTr_Uio4_koydZxehQUVNZkX4rGdwMyDsIi45iBGam8Nm6OpjLXeoQq5pyi2vsg1OvaNg0hbcRZtqoIw__tiaC7dDZyDUkMmGPA9S6f2pvd7UVh67ICpI-pHeGGUHlssiP04JvdIRwGWw&h=0p20phmjahMMOgDHY2kcGdycxtEJPe9gKVocFj7orgs
Expand Down Expand Up @@ -288,21 +288,21 @@ interactions:
User-Agent:
- AZURECLI/2.88.0 azsdk-python-core/1.39.0 Python/3.14.3 (Windows-11-10.0.26200-SP0)
method: GET
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mametcal-python/providers/Microsoft.AppConfiguration/configurationStores/featurenamespacetest000001?api-version=2025-08-01-preview
uri: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clitest.rg000001/providers/Microsoft.AppConfiguration/configurationStores/featurenamespacetest000002?api-version=2025-08-01-preview
response:
body:
string: '{"type": "Microsoft.AppConfiguration/configurationStores", "location":
"eastus", "properties": {"provisioningState": "Succeeded", "creationDate":
"2026-07-02T21:56:39+00:00", "endpoint": "https://featurenamespacetest000001.azconfig.io",
"2026-07-02T21:56:39+00:00", "endpoint": "https://featurenamespacetest000002.azconfig.io",
"encryption": {"keyVaultProperties": null}, "privateEndpointConnections":
null, "disableLocalAuth": true, "softDeleteRetentionInDays": 1, "defaultKeyValueRevisionRetentionPeriodInSeconds":
2592000, "enablePurgeProtection": false, "dataPlaneProxy": {"authenticationMode":
"Local", "privateLinkDelegation": "Disabled"}, "telemetry": {"resourceId":
null}, "azureFrontDoor": {"resourceId": null}}, "sku": {"name": "standard"},
"systemData": {"createdBy": "test@example.com", "createdByType": "User", "createdAt":
"2026-07-02T21:56:39+00:00", "lastModifiedBy": "test@example.com", "lastModifiedByType":
"User", "lastModifiedAt": "2026-07-02T21:56:39+00:00"}, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mametcal-python/providers/Microsoft.AppConfiguration/configurationStores/featurenamespacetest000001",
"name": "featurenamespacetest000001", "tags": {}}'
"User", "lastModifiedAt": "2026-07-02T21:56:39+00:00"}, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/clitest.rg000001/providers/Microsoft.AppConfiguration/configurationStores/featurenamespacetest000002",
"name": "featurenamespacetest000002", "tags": {}}'
headers:
cache-control:
- no-cache
Expand Down Expand Up @@ -344,7 +344,7 @@ interactions:
- AZURECLI.APPCONFIG/2.88.0 azsdk-python-appconfiguration/1.8.0 Python/3.14.3
(Windows-11-10.0.26200-SP0)
method: GET
uri: https://featurenamespacetest000001.azconfig.io/kv/.appconfig.featureflag%2FMyApp%3ABeta?api-version=2023-11-01&label=v1
uri: https://featurenamespacetest000002.azconfig.io/kv/.appconfig.featureflag%2FMyApp%3ABeta?api-version=2023-11-01&label=v1
response:
body:
string: ''
Expand Down Expand Up @@ -390,7 +390,7 @@ interactions:
- AZURECLI.APPCONFIG/2.88.0 azsdk-python-appconfiguration/1.8.0 Python/3.14.3
(Windows-11-10.0.26200-SP0)
method: PUT
uri: https://featurenamespacetest000001.azconfig.io/kv/.appconfig.featureflag%2FMyApp%3ABeta?api-version=2023-11-01&label=v1
uri: https://featurenamespacetest000002.azconfig.io/kv/.appconfig.featureflag%2FMyApp%3ABeta?api-version=2023-11-01&label=v1
response:
body:
string: '{"etag":"ND9fxz4tD1dql7R_z9joI_mE60z0GqGZnwL9RSRtFsU","key":".appconfig.featureflag/MyApp:Beta","label":"v1","content_type":"application/vnd.microsoft.appconfig.ff+json;charset=utf-8","value":"{\"id\":
Expand Down Expand Up @@ -433,7 +433,7 @@ interactions:
- AZURECLI.APPCONFIG/2.88.0 azsdk-python-appconfiguration/1.8.0 Python/3.14.3
(Windows-11-10.0.26200-SP0)
method: GET
uri: https://featurenamespacetest000001.azconfig.io/kv/.appconfig.featureflag%2FMyApp%3ABeta?api-version=2023-11-01&label=v1
uri: https://featurenamespacetest000002.azconfig.io/kv/.appconfig.featureflag%2FMyApp%3ABeta?api-version=2023-11-01&label=v1
response:
body:
string: '{"etag":"ND9fxz4tD1dql7R_z9joI_mE60z0GqGZnwL9RSRtFsU","key":".appconfig.featureflag/MyApp:Beta","label":"v1","content_type":"application/vnd.microsoft.appconfig.ff+json;charset=utf-8","value":"{\"id\":
Expand Down Expand Up @@ -488,7 +488,7 @@ interactions:
- AZURECLI.APPCONFIG/2.88.0 azsdk-python-appconfiguration/1.8.0 Python/3.14.3
(Windows-11-10.0.26200-SP0)
method: PUT
uri: https://featurenamespacetest000001.azconfig.io/kv/.appconfig.featureflag%2FMyApp%3ABeta?api-version=2023-11-01&label=v1
uri: https://featurenamespacetest000002.azconfig.io/kv/.appconfig.featureflag%2FMyApp%3ABeta?api-version=2023-11-01&label=v1
response:
body:
string: '{"etag":"ocTV-H7Gvwa8X16FdsKYivH5oxPz4CJntwmM4qE_50M","key":".appconfig.featureflag/MyApp:Beta","label":"v1","content_type":"application/vnd.microsoft.appconfig.ff+json;charset=utf-8","value":"{\"id\":
Expand Down Expand Up @@ -531,7 +531,7 @@ interactions:
- AZURECLI.APPCONFIG/2.88.0 azsdk-python-appconfiguration/1.8.0 Python/3.14.3
(Windows-11-10.0.26200-SP0)
method: GET
uri: https://featurenamespacetest000001.azconfig.io/kv/.appconfig.featureflag%2FMyApp%3AGlobalFeature?api-version=2023-11-01&label=v1
uri: https://featurenamespacetest000002.azconfig.io/kv/.appconfig.featureflag%2FMyApp%3AGlobalFeature?api-version=2023-11-01&label=v1
response:
body:
string: ''
Expand Down Expand Up @@ -577,7 +577,7 @@ interactions:
- AZURECLI.APPCONFIG/2.88.0 azsdk-python-appconfiguration/1.8.0 Python/3.14.3
(Windows-11-10.0.26200-SP0)
method: PUT
uri: https://featurenamespacetest000001.azconfig.io/kv/.appconfig.featureflag%2FMyApp%3AGlobalFeature?api-version=2023-11-01&label=v1
uri: https://featurenamespacetest000002.azconfig.io/kv/.appconfig.featureflag%2FMyApp%3AGlobalFeature?api-version=2023-11-01&label=v1
response:
body:
string: '{"etag":"t76tJYws7j9Ur6XmJZprJ9QgH4yNJLM2rxIBMeAAReI","key":".appconfig.featureflag/MyApp:GlobalFeature","label":"v1","content_type":"application/vnd.microsoft.appconfig.ff+json;charset=utf-8","value":"{\"id\":
Expand Down Expand Up @@ -620,7 +620,7 @@ interactions:
- AZURECLI.APPCONFIG/2.88.0 azsdk-python-appconfiguration/1.8.0 Python/3.14.3
(Windows-11-10.0.26200-SP0)
method: GET
uri: https://featurenamespacetest000001.azconfig.io/kv?api-version=2023-11-01&key=.appconfig.featureflag%2FMyApp%3A%2A&label=%2A
uri: https://featurenamespacetest000002.azconfig.io/kv?api-version=2023-11-01&key=.appconfig.featureflag%2FMyApp%3A%2A&label=%2A
response:
body:
string: '{"etag":"nQfoiAa6UapCYyfs6W_EIpQpugkuIHktFCW2KMaVLpw","items":[{"etag":"ocTV-H7Gvwa8X16FdsKYivH5oxPz4CJntwmM4qE_50M","key":".appconfig.featureflag/MyApp:Beta","label":"v1","content_type":"application/vnd.microsoft.appconfig.ff+json;charset=utf-8","value":"{\"id\":
Expand Down
Loading
Loading