Skip to content

{Core} Copy login credential when run test with --live and random_config_dir is enabled #26475

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

Merged
bebound merged 7 commits into from
Sep 13, 2023
Merged

{Core} Copy login credential when run test with --live and random_config_dir is enabled #26475

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
16fdfbc
Init
bebound May 18, 2023
1358bd6
Minor fix
bebound May 18, 2023
a09cae0
Merge branch 'dev' into live-test
bebound May 18, 2023
c1eed81
Minor fix
bebound May 18, 2023
31f4403
Minor fix
bebound May 18, 2023
204858b
Copy credential
bebound May 18, 2023
5988396
Copy more files
bebound Aug 24, 2023
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
1 change: 1 addition & 0 deletions src/azure-cli-core/azure/cli/core/_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@
CONFIG_FILE_NAME = 'config'
GLOBAL_CONFIG_PATH = os.path.join(GLOBAL_CONFIG_DIR, CONFIG_FILE_NAME)
ENV_VAR_PREFIX = 'AZURE'
ENV_VAR_TEST_LIVE = 'AZURE_TEST_RUN_LIVE'
23 changes: 20 additions & 3 deletions src/azure-cli-core/azure/cli/core/mock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,33 @@ def __init__(self, commands_loader_cls=None, random_config_dir=False, **kwargs):
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._config import GLOBAL_CONFIG_DIR, ENV_VAR_PREFIX, ENV_VAR_TEST_LIVE
from azure.cli.core._help import AzCliHelp
from azure.cli.core._output import AzOutputProducer

from knack.completion import ARGCOMPLETE_ENV_NAME
from knack.util import ensure_dir

# random_config_dir only takes effects in playback mode
if random_config_dir:
config_dir = os.path.join(GLOBAL_CONFIG_DIR, 'dummy_cli_config_dir', random_string())

# In recording mode, copy login credentials from global config dir to the dummy config dir
if os.getenv(ENV_VAR_TEST_LIVE, '').lower() == 'true':
if os.path.exists(GLOBAL_CONFIG_DIR):
ensure_dir(config_dir)
import shutil
for file in ['azureProfile.json', 'msal_token_cache.bin', 'clouds.config']:

@bebound bebound May 22, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jiasli Are these files requires as login credential?

@jiasli jiasli Aug 14, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Service principal credentials are saved as service_principal_entries.bin:

azure-cli/src/azure-cli-core/azure/cli/core/auth/identity.py

Line 79 in f0c87ca

self._secret_file = os.path.join(config_dir, "service_principal_entries")

If token encryption is disabled, .json is used as the file extension:

  • msal_token_cache.json
  • service_principal_entries.json

try:
shutil.copy(os.path.join(GLOBAL_CONFIG_DIR, file), config_dir)
except FileNotFoundError:
pass
Comment on lines +39 to +40

@zhoxing-ms zhoxing-ms Jul 12, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not very familiar with the knowledge in the auth field, may I ask why do we pass for the FileNotFoundError?

@bebound bebound Jul 12, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the user is not logged in yet, these files do not exist in ~/.azure. Skip copying them.

else:
config_dir = GLOBAL_CONFIG_DIR

super(DummyCli, self).__init__(
cli_name='az',
config_dir=os.path.join(GLOBAL_CONFIG_DIR, 'dummy_cli_config_dir',
random_string()) if random_config_dir else GLOBAL_CONFIG_DIR,
config_dir=config_dir,
config_env_var_prefix=ENV_VAR_PREFIX,
commands_loader_cls=commands_loader_cls or MainCommandsLoader,
parser_cls=AzCliCommandParser,
Expand Down