{Core} Add random_config_dir param in DummyCli (Azure#25689)

avgale · Apr 13, 2023 · fb845fe · fb845fe
1 parent 0bf3005
commit fb845fe
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 9 deletions.
diff --git a/src/azure-cli-core/azure/cli/core/mock.py b/src/azure-cli-core/azure/cli/core/mock.py
@@ -8,14 +8,15 @@
 
 class DummyCli(AzCli):
     """A dummy CLI instance can be used to facilitate automation"""
-    def __init__(self, commands_loader_cls=None, **kwargs):
+    def __init__(self, commands_loader_cls=None, random_config_dir=False, **kwargs):
         import os
 
         from azure.cli.core import MainCommandsLoader
         from azure.cli.core.commands import AzCliCommandInvoker
         from azure.cli.core.azlogging import AzCliLogging
         from azure.cli.core.cloud import get_active_cloud
         from azure.cli.core.parser import AzCliCommandParser
+        from azure.cli.core.util import random_string
         from azure.cli.core._config import GLOBAL_CONFIG_DIR, ENV_VAR_PREFIX
         from azure.cli.core._help import AzCliHelp
         from azure.cli.core._output import AzOutputProducer
@@ -24,7 +25,8 @@ def __init__(self, commands_loader_cls=None, **kwargs):
 
         super(DummyCli, self).__init__(
             cli_name='az',
-            config_dir=GLOBAL_CONFIG_DIR,
+            config_dir=os.path.join(GLOBAL_CONFIG_DIR, 'dummy_cli_config_dir',
+                                    random_string()) if random_config_dir else GLOBAL_CONFIG_DIR,
             config_env_var_prefix=ENV_VAR_PREFIX,
             commands_loader_cls=commands_loader_cls or MainCommandsLoader,
             parser_cls=AzCliCommandParser,

diff --git a/src/azure-cli-testsdk/azure/cli/testsdk/base.py b/src/azure-cli-testsdk/azure/cli/testsdk/base.py
@@ -81,8 +81,10 @@ def is_empty(self):  # pylint: disable=no-self-use
 
 class ScenarioTest(ReplayableTest, CheckerMixin, unittest.TestCase):
     def __init__(self, method_name, config_file=None, recording_name=None,
-                 recording_processors=None, replay_processors=None, recording_patches=None, replay_patches=None):
-        self.cli_ctx = get_dummy_cli()
+                 recording_processors=None, replay_processors=None, recording_patches=None, replay_patches=None,
+                 random_config_dir=False):
+        self.cli_ctx = get_dummy_cli(random_config_dir=random_config_dir)
+        self.random_config_dir = random_config_dir
         self.name_replacer = GeneralNameReplacer()
         self.kwargs = {}
         self.test_guid_count = 0
@@ -137,6 +139,9 @@ def _merge_lists(base, patches):
     def tearDown(self):
         for processor in self._processors_to_reset:
             processor.reset()
+        if self.random_config_dir:
+            from azure.cli.core.util import rmtree_with_retry
+            rmtree_with_retry(self.cli_ctx.config.config_dir)
         super(ScenarioTest, self).tearDown()
 
     def create_random_name(self, prefix, length):
@@ -181,7 +186,8 @@ class LocalContextScenarioTest(ScenarioTest):
     def __init__(self, method_name, config_file=None, recording_name=None, recording_processors=None,
                  replay_processors=None, recording_patches=None, replay_patches=None, working_dir=None):
         super(LocalContextScenarioTest, self).__init__(method_name, config_file, recording_name, recording_processors,
-                                                       replay_processors, recording_patches, replay_patches)
+                                                       replay_processors, recording_patches, replay_patches,
+                                                       random_config_dir=True)
         if self.in_recording:
             self.recording_patches.append(patch_get_current_system_username)
         else:

diff --git a/src/azure-cli/azure/cli/command_modules/config/tests/latest/test_config.py b/src/azure-cli/azure/cli/command_modules/config/tests/latest/test_config.py
@@ -13,6 +13,9 @@
 
 class ConfigTest(ScenarioTest):
 
+    def __init__(self, *arg, **kwargs):
+        super().__init__(*arg, random_config_dir=True, **kwargs)
+
     def test_config(self):
 
         # [test_section1]
@@ -28,8 +31,9 @@ def test_config(self):
         os.chdir(tempdir)
         print("Using temp dir: {}".format(tempdir))
 
-        global_test_args = {"source": os.path.expanduser(os.path.join('~', '.azure', 'config')), "flag": ""}
-        local_test_args = {"source": os.path.join(tempdir, '.azure', 'config'), "flag": " --local"}
+        global_test_args = {"source": os.path.join(self.cli_ctx.config.config_dir, 'config'), "flag": ""}
+        local_test_args = {"source": os.path.join(tempdir, os.path.basename(self.cli_ctx.config.config_dir), 'config'),
+                           "flag": " --local"}
 
         for args in (global_test_args, local_test_args):
             print("Testing for {}".format(args))
@@ -75,7 +79,6 @@ def test_config(self):
             self.cmd('config unset test_section1.test_option1' + args['flag'])
             # Test unsetting multiple options
             self.cmd('config unset test_section2.test_option21 test_section2.test_option22' + args['flag'])
-
         os.chdir(original_path)
 
 

diff --git a/src/azure-cli/azure/cli/command_modules/configure/tests/latest/test_configure.py b/src/azure-cli/azure/cli/command_modules/configure/tests/latest/test_configure.py
@@ -26,6 +26,9 @@ def test_configure_output_options(self):
 
 class ConfigureGlobalDefaultsTest(ScenarioTest):
 
+    def __init__(self, *arg, **kwargs):
+        super().__init__(*arg, random_config_dir=True, **kwargs)
+
     def setUp(self):
         self.local_dir = tempfile.mkdtemp()
 

diff --git a/src/azure-cli/azure/cli/command_modules/resource/tests/latest/test_resource.py b/src/azure-cli/azure/cli/command_modules/resource/tests/latest/test_resource.py
@@ -358,6 +358,9 @@ def test_resource_create_and_show(self, resource_group, resource_group_location)
 
 class TagScenarioTest(ScenarioTest):
 
+    def __init__(self, *arg, **kwargs):
+        super().__init__(*arg, random_config_dir=True, **kwargs)
+
     def test_tag_scenario(self):
 
         self.kwargs.update({

diff --git a/src/azure-cli/azure/cli/command_modules/role/tests/latest/test_role.py b/src/azure-cli/azure/cli/command_modules/role/tests/latest/test_role.py
@@ -255,6 +255,9 @@ def test_role_definition_scenario(self):
 
 class RoleAssignmentScenarioTest(RoleScenarioTestBase):
 
+    def __init__(self, *arg, **kwargs):
+        super().__init__(*arg, random_config_dir=True, **kwargs)
+
     @ResourceGroupPreparer(name_prefix='cli_role_assign')
     @AllowLargeResponse()
     def test_role_assignment_scenario(self, resource_group):
@@ -568,7 +571,9 @@ def test_role_assignment_handle_conflicted_assignments(self, resource_group):
 
                 self.assertGreaterEqual(len(local_defaults_config), 1)
                 actual = set([(x['name'], x['source'], x['value']) for x in local_defaults_config if x['name'] == 'group'])
-                expected = set([('group', os.path.join(temp_dir, '.azure', 'config'), self.kwargs['rg'])])
+                # If global config_dir is ~/.azure/dummy_cli_config_dir/0azXbKR9OdJuZPFS/,
+                # local config file is  ./0azXbKR9OdJuZPFS/config
+                expected = set([('group', os.path.join(temp_dir, os.path.basename(self.cli_ctx.config.config_dir), 'config'), self.kwargs['rg'])])
                 self.assertEqual(actual, expected)
 
                 # test role assignments on a resource group