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

[Christine Wanjau (ChristineWanjau)]

🤖 PR Validation — ️✔️ All clear

Breaking Changes	Tests
️✔️ None	️✔️ 130/130

Description

App Configuration data-plane tests use Microsoft Entra ID (--auth-mode login) against stores created with local authentication disabled, which requires the recording principal to hold App Configuration Data Owner on a resource group. Recording against such a group caused the environment-specific resource group name to be baked into the checked-in cassettes.

This change:

• Adds a recording processor (ResourceGroupNameReplacer) that rewrites the reused live resource group (from the standard AZURE_CLI_TEST_DEV_RESOURCE_GROUP_NAME) to a neutral stub in the recordings, and registers it on the data-plane test classes.
• Defaults get_test_resource_group() to that same stub during playback so requests match the sanitized cassettes, and fails fast (only in live mode) when no resource group is provided.
• Sanitizes the resource group name out of the existing data-plane recordings.

Management-plane test recordings are intentionally left untouched.

Testing Guide

Data-plane suite: 20 passed / 3 skipped (live-only). Management suite: 10 passed / 5 skipped. No regressions.

History Notes

[Component Name] az appconfig: Keep environment-specific resource group names out of data-plane test recordings (test-only change).

[azure-client-tools-bot-prd]

Hi Christine Wanjau (@ChristineWanjau),
Since the current milestone time is less than 7 days, this pr may not catch up with this release.

[azure-pipelines]

Azure Pipelines:
There may be pipelines that require an authorized user to comment /azp run to run.

[Aditya Pujara (a0x1ab)]

/azp run

[azure-pipelines]

Azure Pipelines:
Successfully started running 3 pipeline(s).

[azure-pipelines]

Azure Pipelines:
There may be pipelines that require an authorized user to comment /azp run to run.

[Copilot]

Pull request overview

This PR updates the az appconfig test infrastructure to prevent environment-specific resource group names from being persisted into App Configuration data-plane test recordings, enabling stable playback across environments.

Changes:

• Introduces a ResourceGroupNameReplacer recording processor (and registers it on data-plane test classes) to scrub the live dev resource group name into a deterministic stub in recordings.
• Updates get_test_resource_group() to use AZURE_CLI_TEST_DEV_RESOURCE_GROUP_NAME for live runs, fall back to a sanitized stub in playback, and fail fast in live mode when not configured.
• Sanitizes existing App Configuration data-plane cassette YAML recordings to replace the previously recorded resource group name with the stub.

Reviewed changes

Copilot reviewed 24 out of 25 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/_test_utils.py	Adds sanitized RG stub constant, live/playback RG selection logic, and ResourceGroupNameReplacer processor registration.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_kv_import_export_commands.py	Registers AppConfig-specific recording processors on scenario tests.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_kv_commands.py	Registers AppConfig-specific recording processors on scenario tests; updates one live-run guidance comment.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_key_validation.py	Registers AppConfig-specific recording processors on scenario tests.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_json_content_type.py	Registers AppConfig-specific recording processors on scenario tests.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_feature_commands.py	Registers AppConfig-specific recording processors on scenario tests.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_strict_import.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_snapshot_mgmt.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_snapshot_filtering.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_kv.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_kv_set_snapshot_reference.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_kv_revision_list.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_kv_list_resolve_snapshot_references.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_key_validation.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_json_content_type.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_import_export.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_import_export_respect_both_schemas_naming_conventions.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_import_export_new_fm_schema.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_import_export_naming_conventions.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_import_export_kvset.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_feature.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_feature_telemetry.yaml	Sanitizes resource group name in recorded ARM interactions (including telemetry resource IDs).
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_feature_namespacing.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_azconfig_feature_filter.yaml	Sanitizes resource group name in recorded ARM interactions.
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/recordings/test_appconfig_to_appconfig_import_export.yaml	Sanitizes resource group name in recorded ARM interactions.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[Aditya Pujara (a0x1ab)]

/azp run

[azure-pipelines]

Azure Pipelines:
Successfully started running 3 pipeline(s).

[azure-client-tools-agent]

Live test results — azdev test --live --series (changed test files only)

❌ FAIL (exit 1)

Selectors: _test_utils test_appconfig_feature_commands test_appconfig_json_content_type test_appconfig_key_validation test_appconfig_kv_commands test_appconfig_kv_import_export_commands (module)
PR head ref: cwanjau/sanitizeResourceGroup
PR head sha: d736883cc1ec809b986d4199a9edc6745d08a10f
PR base ref: dev
New test files in PR: false

Changed test files run

src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/_test_utils.py
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_feature_commands.py
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_json_content_type.py
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_key_validation.py
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_kv_commands.py
src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_kv_import_export_commands.py

Workflow run: https://github.com/Azure/issue-sentinel/actions/runs/32219486926

Last 80 lines of azdev output

azure-cli/src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_feature_commands.py::AppConfigFeatureScenarioTest::test_azconfig_feature FAILED [  5%]

=================================== FAILURES ===================================
______________ AppConfigFeatureScenarioTest.test_azconfig_feature ______________
self = <azure.cli.command_modules.appconfig.tests.latest.test_appconfig_feature_commands.AppConfigFeatureScenarioTest testMethod=test_azconfig_feature>

    @AllowLargeResponse()
    # Uses Entra ID auth (store created with local auth disabled); target a resource group where the
    # recording principal holds "App Configuration Data Owner". Override via AZURE_CLI_APPCONFIG_TEST_RG.
    def test_azconfig_feature(self):
        feature_test_store_prefix = get_resource_name_prefix('featuretest')
        config_store_name = self.create_random_name(prefix=feature_test_store_prefix, length=24)
    
        location = 'eastus'
        sku = 'standard'
        self.kwargs.update({
            'config_store_name': config_store_name,
            'rg_loc': location,
>           'rg': get_test_resource_group(),
                  ^^^^^^^^^^^^^^^^^^^^^^^^^
            'sku': sku,
            'endpoint': 'https://' + config_store_name + '.azconfig.io'
        })

azure-cli/src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_feature_commands.py:39: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 

    def get_test_resource_group():
        resource_group = os.environ.get("AZURE_CLI_TEST_DEV_RESOURCE_GROUP_NAME")
        if resource_group:
            return resource_group
        # The stub only exists inside sanitized recordings; a live run needs a real group where the
        # recording principal holds "App Configuration Data Owner".
        if os.environ.get("AZURE_TEST_RUN_LIVE"):
>           raise CliTestError(
                "Set AZURE_CLI_TEST_DEV_RESOURCE_GROUP_NAME to a resource group where you hold "
                "'App Configuration Data Owner' to record App Configuration data-plane tests.")
E           azure.cli.testsdk.exceptions.CliTestError: An error caused by the CLI test harness failed the test: Set AZURE_CLI_TEST_DEV_RESOURCE_GROUP_NAME to a resource group where you hold 'App Configuration Data Owner' to record App Configuration data-plane tests.

azure-cli/src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/_test_utils.py:44: CliTestError
- generated xml file: /home/runner/work/issue-sentinel/issue-sentinel/test-output/results.xml -
=========================== short test summary info ============================
FAILED azure-cli/src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_feature_commands.py::AppConfigFeatureScenarioTest::test_azconfig_feature - self = <azure.cli.command_modules.appconfig.tests.latest.test_appconfig_feature_commands.AppConfigFeatureScenarioTest testMethod=test_azconfig_feature>

    @AllowLargeResponse()
    # Uses Entra ID auth (store created with local auth disabled); target a resource group where the
    # recording principal holds "App Configuration Data Owner". Override via AZURE_CLI_APPCONFIG_TEST_RG.
    def test_azconfig_feature(self):
        feature_test_store_prefix = get_resource_name_prefix('featuretest')
        config_store_name = self.create_random_name(prefix=feature_test_store_prefix, length=24)
    
        location = 'eastus'
        sku = 'standard'
        self.kwargs.update({
            'config_store_name': config_store_name,
            'rg_loc': location,
>           'rg': get_test_resource_group(),
                  ^^^^^^^^^^^^^^^^^^^^^^^^^
            'sku': sku,
            'endpoint': 'https://' + config_store_name + '.azconfig.io'
        })

azure-cli/src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_feature_commands.py:39: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 

    def get_test_resource_group():
        resource_group = os.environ.get("AZURE_CLI_TEST_DEV_RESOURCE_GROUP_NAME")
        if resource_group:
            return resource_group
        # The stub only exists inside sanitized recordings; a live run needs a real group where the
        # recording principal holds "App Configuration Data Owner".
        if os.environ.get("AZURE_TEST_RUN_LIVE"):
>           raise CliTestError(
                "Set AZURE_CLI_TEST_DEV_RESOURCE_GROUP_NAME to a resource group where you hold "
                "'App Configuration Data Owner' to record App Configuration data-plane tests.")
E           azure.cli.testsdk.exceptions.CliTestError: An error caused by the CLI test harness failed the test: Set AZURE_CLI_TEST_DEV_RESOURCE_GROUP_NAME to a resource group where you hold 'App Configuration Data Owner' to record App Configuration data-plane tests.

azure-cli/src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/_test_utils.py:44: CliTestError
!!!!!!!!!!!!!!!!!!!!!!!!!! stopping after 1 failures !!!!!!!!!!!!!!!!!!!!!!!!!!!
============================== 1 failed in 0.42s ===============================

Posted by agent-assist live-test workflow.

[azure-client-tools-agent]

• Live test run failed (see the dispatched live-test.yml workflow run for details).

[Aditya Pujara (a0x1ab)]

/azp run

[azure-pipelines]

Azure Pipelines:
Successfully started running 3 pipeline(s).