[Core] Update local context on/off status to global user level (#13277)

* [Core] update local context to global user level

* [Configure] az local-context: add list/show/delete/clear command

* {Network} refactor for local context

* {Resource} refactor for local context

* add LocalContextScenarioTest

* add vnet/subnet type definiton for local context

* remove unused file

* update default_from to default_value_source

* update knack version to 0.7.0

* drop using get_config_parser from knack

* fix CI error

* upgrade knack to 0.7.1

* fix CI error

* fix CI error

* fix sytle error

* fix style error

* update --subnet-name to --subnet

* fix review problems

* fix style error

* load local context file only when it is turned on

* add wanrning message when save to local context

src/azure-cli-core/azure/cli/core/__init__.py

@@ -23,7 +23,7 @@
 from knack.experimental import ExperimentalItem
 from knack.util import CLIError
 from knack.arguments import ArgumentsContext, CaseInsensitiveList  # pylint: disable=unused-import
-from .local_context import AzCLILocalContext, SET
+from .local_context import AzCLILocalContext, LocalContextAction
 
 logger = get_logger(__name__)
 
@@ -69,9 +69,7 @@ def __init__(self, **kwargs):
         SESSION.load(os.path.join(azure_folder, 'az.sess'), max_age=3600)
         self.cloud = get_active_cloud(self)
         logger.debug('Current cloud config:\n%s', str(self.cloud.name))
-        self.local_context = AzCLILocalContext(
-            dir_name=os.path.basename(self.config.config_dir), file_name='local_context'
-        )
+        self.local_context = AzCLILocalContext(self)
         register_global_transforms(self)
         register_global_subscription_argument(self)
         register_ids_argument(self)  # global subscription must be registered first!
@@ -162,20 +160,33 @@ def save_local_context(self, parsed_args, argument_definitions, specified_argume
         :param specified_arguments: Arguments which user specify in this command
         :type specified_arguments: list
         """
-
+        local_context_args = []
         for argument_name in specified_arguments:
             # make sure SET is defined
             if argument_name not in argument_definitions:
                 continue
             argtype = argument_definitions[argument_name].type
             lca = argtype.settings.get('local_context_attribute', None)
-            if not lca or not lca.actions or SET not in lca.actions:
+            if not lca or not lca.actions or LocalContextAction.SET not in lca.actions:
                 continue
             # get the specified value
             value = getattr(parsed_args, argument_name)
             # save when name and scopes have value
             if lca.name and lca.scopes:
                 self.local_context.set(lca.scopes, lca.name, value)
+            options = argtype.settings.get('options_list', None)
+            if options:
+                local_context_args.append((options[0], value))
+
+        # print warning if there are values saved to local context
+        if local_context_args:
+            logger.warning('Local context is turned on. Its information is saved in working directory %s. You can '
+                           'run `az local-context off` to turn it off.',
+                           self.local_context.effective_working_directory())
+            args_str = []
+            for name, value in local_context_args:
+                args_str.append('{}: {}'.format(name, value))
+            logger.warning('Command argument values saved to local context: %s', ', '.join(args_str))
 
 
 class MainCommandsLoader(CLICommandsLoader):

src/azure-cli-core/azure/cli/core/_help.py

@@ -69,23 +69,25 @@ def _print_detailed_help(self, cli_name, help_file):
 
     @staticmethod
     def _get_choices_defaults_sources_str(p):
-        choice_str = u'  Allowed values: {}.'.format(', '.join(sorted([str(x) for x in p.choices]))) \
+        choice_str = '  Allowed values: {}.'.format(', '.join(sorted([str(x) for x in p.choices]))) \
             if p.choices else ''
-        default_str = u'  Default: {}.'.format(p.default) if p.default and p.default != argparse.SUPPRESS else ''
+        default_value_source = p.default_value_source if p.default_value_source else 'Default'
+        default_str = '  {}: {}.'.format(default_value_source, p.default) \
+            if p.default and p.default != argparse.SUPPRESS else ''
         value_sources_str = CLIPrintMixin._process_value_sources(p) if p.value_sources else ''
-        return u'{}{}{}'.format(choice_str, default_str, value_sources_str)
+        return '{}{}{}'.format(choice_str, default_str, value_sources_str)
 
     @staticmethod
     def _print_examples(help_file):
         indent = 0
         _print_indent('Examples', indent)
         for e in help_file.examples:
             indent = 1
-            _print_indent(u'{0}'.format(e.short_summary), indent)
+            _print_indent('{0}'.format(e.short_summary), indent)
             indent = 2
             if e.long_summary:
-                _print_indent(u'{0}'.format(e.long_summary), indent)
-            _print_indent(u'{0}'.format(e.command), indent)
+                _print_indent('{0}'.format(e.long_summary), indent)
+            _print_indent('{0}'.format(e.command), indent)
             print('')
 
     @staticmethod
@@ -109,11 +111,11 @@ def _process_value_sources(p):
             elif "link" in item and "url" in item["link"]:
                 urls.append(item["link"]["url"])
 
-        command_str = u'  Values from: {}.'.format(", ".join(commands)) if commands else ''
-        string_str = u'  {}'.format(", ".join(strings)) if strings else ''
+        command_str = '  Values from: {}.'.format(", ".join(commands)) if commands else ''
+        string_str = '  {}'.format(", ".join(strings)) if strings else ''
         string_str = string_str + "." if string_str and not string_str.endswith(".") else string_str
-        urls_str = u'  For more info, go to: {}.'.format(", ".join(urls)) if urls else ''
-        return u'{}{}{}'.format(command_str, string_str, urls_str)
+        urls_str = '  For more info, go to: {}.'.format(", ".join(urls)) if urls else ''
+        return '{}{}{}'.format(command_str, string_str, urls_str)
 
     @staticmethod
     def _print_extensions_msg(help_file):
@@ -301,6 +303,7 @@ def __init__(self, help_ctx, delimiters, parser):
                     'deprecate_info': getattr(action, 'deprecate_info', None),
                     'preview_info': getattr(action, 'preview_info', None),
                     'experimental_info': getattr(action, 'experimental_info', None),
+                    'default_value_source': getattr(action, 'default_value_source', None),
                     'description': action.help,
                     'choices': action.choices,
                     'required': False,

src/azure-cli-core/azure/cli/core/cloud.py

@@ -6,15 +6,14 @@
 import os
 import json
 from pprint import pformat
-from six.moves import configparser
+import configparser
 
 from azure.cli.core.profiles import API_PROFILES
 from azure.cli.core._config import GLOBAL_CONFIG_DIR
 from azure.cli.core.util import urlretrieve
 
 from knack.log import get_logger
 from knack.util import CLIError
-from knack.config import get_config_parser
 
 logger = get_logger(__name__)
 
@@ -381,7 +380,7 @@ def _get_cloud_name(cli_ctx, cloud_name):
 
 def get_clouds(cli_ctx):
     clouds = []
-    config = get_config_parser()
+    config = configparser.ConfigParser()
     # Start off with known clouds and apply config file on top of current config
     for c in KNOWN_CLOUDS:
         _config_add_cloud(config, c)
@@ -438,7 +437,7 @@ def get_active_cloud(cli_ctx=None):
 
 
 def get_cloud_subscription(cloud_name):
-    config = get_config_parser()
+    config = configparser.ConfigParser()
     config.read(CLOUD_CONFIG_FILE)
     try:
         return config.get(cloud_name, 'subscription')
@@ -449,7 +448,7 @@ def get_cloud_subscription(cloud_name):
 def set_cloud_subscription(cli_ctx, cloud_name, subscription):
     if not _get_cloud(cli_ctx, cloud_name):
         raise CloudNotRegisteredException(cloud_name)
-    config = get_config_parser()
+    config = configparser.ConfigParser()
     config.read(CLOUD_CONFIG_FILE)
     if subscription:
         try:
@@ -519,7 +518,7 @@ def _config_add_cloud(config, cloud, overwrite=False):
 
 
 def _save_cloud(cloud, overwrite=False):
-    config = get_config_parser()
+    config = configparser.ConfigParser()
     config.read(CLOUD_CONFIG_FILE)
     _config_add_cloud(config, cloud, overwrite=overwrite)
     if not os.path.isdir(GLOBAL_CONFIG_DIR):
@@ -550,7 +549,7 @@ def remove_cloud(cli_ctx, cloud_name):
     if is_known_cloud:
         raise CannotUnregisterCloudException("The cloud '{}' cannot be unregistered "
                                              "as it's not a custom cloud.".format(cloud_name))
-    config = get_config_parser()
+    config = configparser.ConfigParser()
     config.read(CLOUD_CONFIG_FILE)
     config.remove_section(cloud_name)
     with open(CLOUD_CONFIG_FILE, 'w') as configfile:

src/azure-cli-core/azure/cli/core/commands/__init__.py

@@ -27,7 +27,7 @@
     AzArgumentContext, patch_arg_make_required, patch_arg_make_optional)
 from azure.cli.core.extension import get_extension
 from azure.cli.core.util import get_command_type_kwarg, read_file_content, get_arg_list, poller_classes
-from azure.cli.core.local_context import GET
+from azure.cli.core.local_context import LocalContextAction
 import azure.cli.core.telemetry as telemetry
 
 
@@ -293,9 +293,9 @@ def _resolve_default_value_from_config_file(self, arg, overrides):
         self._resolve_default_value_from_local_context(arg, overrides)
 
     def _resolve_default_value_from_local_context(self, arg, overrides):
-        if self.cli_ctx.local_context.is_on():
+        if self.cli_ctx.local_context.is_on:
             lca = overrides.settings.get('local_context_attribute', None)
-            if not lca or not lca.actions or GET not in lca.actions:
+            if not lca or not lca.actions or LocalContextAction.GET not in lca.actions:
                 return
             if lca.name:
                 local_context = self.cli_ctx.local_context
@@ -304,6 +304,7 @@ def _resolve_default_value_from_local_context(self, arg, overrides):
                     logger.debug("local context '%s' for arg %s", value, arg.name)
                     overrides.settings['default'] = DefaultStr(value)
                     overrides.settings['required'] = False
+                    overrides.settings['default_value_source'] = 'Local Context'
 
     def load_arguments(self):
         super(AzCliCommand, self).load_arguments()
@@ -578,6 +579,28 @@ def execute(self, args):
         parsed_args = self.parser.parse_args(args)
         self.cli_ctx.raise_event(EVENT_INVOKER_POST_PARSE_ARGS, command=parsed_args.command, args=parsed_args)
 
+        # print local context warning
+        if self.cli_ctx.local_context.is_on and command and command in self.commands_loader.command_table:
+            local_context_args = []
+            arguments = self.commands_loader.command_table[command].arguments
+            specified_arguments = self.parser.subparser_map[command].specified_arguments \
+                if command in self.parser.subparser_map else []
+            for name, argument in arguments.items():
+                default_value_source = argument.type.settings.get('default_value_source', None)
+                dest_name = argument.type.settings.get('dest', None)
+                options = argument.type.settings.get('options_list', None)
+                if default_value_source == 'Local Context' and dest_name not in specified_arguments and options:
+                    value = getattr(parsed_args, name)
+                    local_context_args.append((options[0], value))
+            if local_context_args:
+                logger.warning('Local context is turned on. Its information is saved in working directory %s. You can '
+                               'run `az local-context off` to turn it off.',
+                               self.cli_ctx.local_context.effective_working_directory())
+                args_str = []
+                for name, value in local_context_args:
+                    args_str.append('{}: {}'.format(name, value))
+                logger.warning('Command argument values from local context: %s', ', '.join(args_str))
+
         # TODO: This fundamentally alters the way Knack.invocation works here. Cannot be customized
         # with an event. Would need to be customized via inheritance.
 
@@ -643,7 +666,7 @@ def execute(self, args):
         self.cli_ctx.raise_event(EVENT_INVOKER_FILTER_RESULT, event_data=event_data)
 
         # save to local context if it is turned on after command executed successfully
-        if self.cli_ctx.local_context.is_on() and command and command in self.commands_loader.command_table and \
+        if self.cli_ctx.local_context.is_on and command and command in self.commands_loader.command_table and \
                 command in self.parser.subparser_map and self.parser.subparser_map[command].specified_arguments:
             self.cli_ctx.save_local_context(parsed_args, self.commands_loader.command_table[command].arguments,
                                             self.parser.subparser_map[command].specified_arguments)

src/azure-cli-core/azure/cli/core/commands/parameters.py

@@ -12,7 +12,7 @@
 from azure.cli.core.commands.validators import validate_tag, validate_tags, generate_deployment_name
 from azure.cli.core.decorators import Completer
 from azure.cli.core.profiles import ResourceType
-from azure.cli.core.local_context import LocalContextAttribute, SET, GET, ALL
+from azure.cli.core.local_context import LocalContextAttribute, LocalContextAction, ALL
 
 from knack.arguments import (
     CLIArgumentType, CaseInsensitiveList, ignore_type, ArgumentsContext)
@@ -242,7 +242,7 @@ def _type(value):
     configured_default='group',
     local_context_attribute=LocalContextAttribute(
         name='resource_group_name',
-        actions=[SET, GET],
+        actions=[LocalContextAction.SET, LocalContextAction.GET],
         scopes=[ALL]
     ))
 
@@ -303,6 +303,20 @@ def get_location_type(cli_ctx):
     nargs=1
 )
 
+vnet_name_type = CLIArgumentType(
+    options_list='--vnet-name',
+    metavar='NAME',
+    help='The virtual network (VNet) name.',
+    completer=get_resource_name_completion_list('Microsoft.Network/virtualNetworks'),
+    local_context_attribute=LocalContextAttribute(name='vnet_name', actions=[LocalContextAction.GET])
+)
+
+subnet_name_type = CLIArgumentType(
+    options_list='--subnet',
+    metavar='NAME',
+    help='The subnet name.',
+    local_context_attribute=LocalContextAttribute(name='subnet_name', actions=[LocalContextAction.GET]))
+
 
 def patch_arg_make_required(argument):
     argument.settings['required'] = True