Remove Decorator Style Hand Authored Commands

azure-cli.pyproj

@@ -39,8 +39,20 @@
     <Compile Include="azure\cli\main.py" />
     <Compile Include="azure\cli\tests\test_add_resourcegroup_transform.py" />
     <Compile Include="azure\cli\tests\test_logging.py" />
+    <Compile Include="azure\cli\tests\test_test_script.py">
+      <SubType>Code</SubType>
+    </Compile>
     <Compile Include="azure\cli\tests\test_validators.py" />
     <Compile Include="azure\cli\utils\command_test_script.py" />
+    <Compile Include="command_modules\azure-cli-component\azure\cli\command_modules\component\custom.py" />
+    <Compile Include="command_modules\azure-cli-component\azure\cli\command_modules\component\generated.py" />
+    <Compile Include="command_modules\azure-cli-component\azure\cli\command_modules\component\_params.py" />
+    <Compile Include="command_modules\azure-cli-network\azure\cli\command_modules\network\custom.py">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="command_modules\azure-cli-network\azure\cli\command_modules\network\generated.py">
+      <SubType>Code</SubType>
+    </Compile>
     <Compile Include="command_modules\azure-cli-network\azure\cli\command_modules\network\mgmt\lib\credentials.py" />
     <Compile Include="command_modules\azure-cli-network\azure\cli\command_modules\network\mgmt\lib\exceptions.py" />
     <Compile Include="command_modules\azure-cli-network\azure\cli\command_modules\network\mgmt\lib\models\basic_dependency.py" />
@@ -62,6 +74,18 @@
     <Compile Include="command_modules\azure-cli-network\azure\cli\command_modules\network\mgmt\__init__.py">
       <SubType>Code</SubType>
     </Compile>
+    <Compile Include="command_modules\azure-cli-network\azure\cli\command_modules\network\_params.py">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="command_modules\azure-cli-profile\azure\cli\command_modules\profile\custom.py">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="command_modules\azure-cli-profile\azure\cli\command_modules\profile\generated.py">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="command_modules\azure-cli-profile\azure\cli\command_modules\profile\_params.py">
+      <SubType>Code</SubType>
+    </Compile>
     <Compile Include="command_modules\azure-cli-resource\azure\cli\command_modules\resource\custom.py" />
     <Compile Include="command_modules\azure-cli-resource\azure\cli\command_modules\resource\generated.py" />
     <Compile Include="command_modules\azure-cli-resource\azure\cli\command_modules\resource\tests\test_validators.py" />
@@ -70,8 +94,20 @@
       <SubType>Code</SubType>
     </Compile>
     <Compile Include="command_modules\azure-cli-storage\azure\cli\command_modules\storage\tests\test_validators.py" />
+    <Compile Include="command_modules\azure-cli-storage\azure\cli\command_modules\storage\custom.py">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="command_modules\azure-cli-storage\azure\cli\command_modules\storage\generated.py">
+      <SubType>Code</SubType>
+    </Compile>
     <Compile Include="command_modules\azure-cli-storage\azure\cli\command_modules\storage\_params.py" />
     <Compile Include="command_modules\azure-cli-storage\azure\cli\command_modules\storage\_validators.py" />
+    <Compile Include="command_modules\azure-cli-taskhelp\azure\cli\command_modules\taskhelp\custom.py">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="command_modules\azure-cli-taskhelp\azure\cli\command_modules\taskhelp\generated.py">
+      <SubType>Code</SubType>
+    </Compile>
     <Compile Include="command_modules\azure-cli-vm\azure\cli\command_modules\vm\mgmt\lib\credentials.py" />
     <Compile Include="command_modules\azure-cli-vm\azure\cli\command_modules\vm\mgmt\lib\exceptions.py" />
     <Compile Include="command_modules\azure-cli-vm\azure\cli\command_modules\vm\mgmt\lib\models\basic_dependency.py" />
@@ -82,7 +118,6 @@
     <Compile Include="command_modules\azure-cli-vm\azure\cli\command_modules\vm\mgmt\lib\models\deployment_properties_extended.py" />
     <Compile Include="command_modules\azure-cli-vm\azure\cli\command_modules\vm\mgmt\lib\models\deployment_vm.py" />
     <Compile Include="command_modules\azure-cli-vm\azure\cli\command_modules\vm\mgmt\lib\models\parameters_link.py" />
-    <Compile Include="command_modules\azure-cli-vm\azure\cli\command_modules\vm\mgmt\lib\models\provider - Copy.py" />
     <Compile Include="command_modules\azure-cli-vm\azure\cli\command_modules\vm\mgmt\lib\models\provider.py" />
     <Compile Include="command_modules\azure-cli-vm\azure\cli\command_modules\vm\mgmt\lib\models\provider_resource_type.py" />
     <Compile Include="command_modules\azure-cli-vm\azure\cli\command_modules\vm\mgmt\lib\models\template_link.py" />
@@ -139,10 +174,6 @@
     <Compile Include="command_modules\azure-cli-network\azure\cli\command_modules\network\tests\test_commands.py" />
     <Compile Include="command_modules\azure-cli-network\azure\cli\command_modules\network\__init__.py" />
     <Compile Include="command_modules\azure-cli-network\setup.py" />
-    <Compile Include="command_modules\azure-cli-profile\azure\cli\command_modules\profile\account.py" />
-    <Compile Include="command_modules\azure-cli-profile\azure\cli\command_modules\profile\command_tables.py" />
-    <Compile Include="command_modules\azure-cli-profile\azure\cli\command_modules\profile\login.py" />
-    <Compile Include="command_modules\azure-cli-profile\azure\cli\command_modules\profile\logout.py" />
     <Compile Include="command_modules\azure-cli-profile\azure\cli\command_modules\profile\__init__.py" />
     <Compile Include="command_modules\azure-cli-profile\setup.py" />
     <Compile Include="command_modules\azure-cli-resource\azure\cli\command_modules\resource\tests\command_specs.py">
@@ -167,6 +198,10 @@
     <Compile Include="command_modules\azure-cli-vm\azure\cli\command_modules\vm\custom.py" />
     <Compile Include="command_modules\azure-cli-vm\azure\cli\command_modules\vm\tests\test_vm_image.py" />
     <Compile Include="command_modules\azure-cli-vm\azure\cli\command_modules\vm\tests\__init__.py" />
+    <Compile Include="command_modules\azure-cli-vm\azure\cli\command_modules\vm\_actions.py">
+      <SubType>Code</SubType>
+    </Compile>
+    <Compile Include="command_modules\azure-cli-vm\azure\cli\command_modules\vm\_factory.py" />
     <Compile Include="command_modules\azure-cli-vm\azure\cli\command_modules\vm\_validators.py">
       <SubType>Code</SubType>
     </Compile>

src/azure/cli/commands/__init__.py

@@ -20,49 +20,46 @@
 
 logger.info('Installed command modules %s', INSTALLED_COMMAND_MODULES)
 
-RESOURCE_GROUP_ARG_NAME = 'resource_group_name'
-
 COMMON_PARAMETERS = {
     'deployment_name': {
         'name': '--deployment-name',
         'metavar': 'DEPLOYMENTNAME',
         'help': 'Name of the resource deployment',
         'default': 'azurecli' + str(time.time()) + str(random.randint(0, 10000000)),
-        'required': False
     },
     'location': {
         'name': '--location -l',
         'metavar': 'LOCATION',
         'help': 'Location',
-        'required': True
     },
     'resource_group_name': {
         'name': '--resource-group -g',
-        'dest': RESOURCE_GROUP_ARG_NAME,
         'metavar': 'RESOURCEGROUP',
         'help': 'The name of the resource group',
-        'required': True
     },
     'tag' : {
         'name': '--tag',
         'metavar': 'TAG',
         'help': L('a single tag in \'key[=value]\' format'),
-        'required': False,
         'type': validate_tag
     },
     'tags' : {
         'name': '--tags',
         'metavar': 'TAGS',
         'help': L('multiple semicolon separated tags in \'key[=value]\' format'),
-        'required': False,
         'type': validate_tags
     },
 }
 
 def extend_parameter(parameter_metadata, **kwargs):
-    modified_parameter_metadata = parameter_metadata.copy()
-    modified_parameter_metadata.update(kwargs)
-    return modified_parameter_metadata
+    extended_param = parameter_metadata.copy()
+    extended_param.update(kwargs)
+    return extended_param
+
+def patch_aliases(aliases, patch):
+    patched_aliases = aliases.copy()
+    patched_aliases.update(patch)
+    return patched_aliases
 
 class LongRunningOperation(object): #pylint: disable=too-few-public-methods
 

src/azure/cli/commands/_auto_command.py

@@ -8,9 +8,9 @@
 from ..commands import COMMON_PARAMETERS
 
 EXCLUDED_PARAMS = frozenset(['self', 'raw', 'custom_headers', 'operation_config',
-                             'content_version'])
+                             'content_version', 'kwargs'])
 
-class AutoCommandDefinition(object): #pylint: disable=too-few-public-methods
+class CommandDefinition(object): #pylint: disable=too-few-public-methods
 
     def __init__(self, operation, return_type, command_alias=None):
         self.operation = operation
@@ -35,13 +35,15 @@ def _get_member(obj, path):
             pass
     return obj
 
-def _make_func(client_factory, member_path, return_type_or_func, unbound_func):
-    def call_client(args):
-        client = client_factory(args)
+def _make_func(client_factory, member_path, return_type_or_func, unbound_func, extra_parameters):
+    def call_client(kwargs):
+        client = client_factory(**kwargs)
+        for param in extra_parameters.keys() if extra_parameters else []:
+            kwargs.pop(param)
         ops_instance = _get_member(client, member_path)
 
         try:
-            result = unbound_func(ops_instance, **args)
+            result = unbound_func(ops_instance, **kwargs)
             if not return_type_or_func:
                 return {}
             if callable(return_type_or_func):
@@ -59,32 +61,33 @@ def call_client(args):
 def _option_descriptions(operation):
     """Pull out parameter help from doccomments of the command
     """
-    lines = inspect.getdoc(operation).splitlines()
     option_descs = {}
-    index = 0
-    while index < len(lines):
-        l = lines[index]
-        regex = r'\s*(:param)\s+(.+)\s*:(.*)'
-        match = re.search(regex, l)
-        if match:
-            # 'arg name' portion might have type info, we don't need it
-            arg_name = str.split(match.group(2))[-1]
-            arg_desc = match.group(3).strip()
-            #look for more descriptions on subsequent lines
-            index += 1
-            while index < len(lines):
-                temp = lines[index].strip()
-                if temp.startswith(':'):
-                    break
-                else:
-                    if temp:
-                        arg_desc += (' ' + temp)
-                    index += 1
-
-            option_descs[arg_name] = arg_desc
-        else:
-            index += 1
-
+    lines = inspect.getdoc(operation)
+    if lines:
+        lines = lines.splitlines()
+        index = 0
+        while index < len(lines):
+            l = lines[index]
+            regex = r'\s*(:param)\s+(.+)\s*:(.*)'
+            match = re.search(regex, l)
+            if match:
+                # 'arg name' portion might have type info, we don't need it
+                arg_name = str.split(match.group(2))[-1]
+                arg_desc = match.group(3).strip()
+                #look for more descriptions on subsequent lines
+                index += 1
+                while index < len(lines):
+                    temp = lines[index].strip()
+                    if temp.startswith(':'):
+                        break
+                    else:
+                        if temp:
+                            arg_desc += (' ' + temp)
+                        index += 1
+
+                option_descs[arg_name] = arg_desc
+            else:
+                index += 1
     return option_descs
 
 
@@ -99,7 +102,7 @@ def build_operation(command_name,
 
     for op in operations:
 
-        func = _make_func(client_type, member_path, op.return_type, op.operation)
+        func = _make_func(client_type, member_path, op.return_type, op.operation, extra_parameters)
 
         args = []
         try:
@@ -152,8 +155,8 @@ def build_operation(command_name,
         # append any 'extra' args needed (for example to obtain a client) that aren't required
         # by the SDK.
         if extra_parameters:
-            for arg in extra_parameters:
-                options.append(arg.copy())
+            for arg in extra_parameters.keys():
+                options.append(extra_parameters[arg].copy())
 
         command_table[func] = {
             'name': ' '.join([command_name, op.opname]),

src/azure/cli/tests/test_autocommand.py

@@ -3,7 +3,7 @@
 
 from azure.cli.commands._auto_command import build_operation, _option_descriptions
 from azure.cli.commands import CommandTable
-from azure.cli.commands._auto_command import AutoCommandDefinition
+from azure.cli.commands._auto_command import CommandDefinition
 from azure.cli.main import main as cli
 
 from six import StringIO
@@ -45,7 +45,7 @@ def test_autocommand_basic(self):
                         "",
                         None,
                         [
-                            AutoCommandDefinition(Test_autocommand.sample_vm_get, None)
+                            CommandDefinition(Test_autocommand.sample_vm_get, None)
                         ],
                         command_table)
 
@@ -78,7 +78,7 @@ def test_autocommand_with_parameter_alias(self):
                         "",
                         None,
                         [
-                            AutoCommandDefinition(Test_autocommand.sample_vm_get, None)
+                            CommandDefinition(Test_autocommand.sample_vm_get, None)
                         ],
                         command_table,
                         VM_SPECIFIC_PARAMS
@@ -99,19 +99,19 @@ def test_autocommand_with_parameter_alias(self):
 
     def test_autocommand_with_extra_parameters(self):
         command_table = CommandTable()
-        NEW_PARAMETERS= [
-            {
+        NEW_PARAMETERS = {
+            'added_param': {
                 'name': '--added-param',
                 'metavar': 'ADDED',
                 'help': 'Just added this right now!',
                 'required': True
             }
-        ]
+        }
         build_operation("test autocommand",
                         "",
                         None,
                         [
-                            AutoCommandDefinition(Test_autocommand.sample_vm_get, None)
+                            CommandDefinition(Test_autocommand.sample_vm_get, None)
                         ],
                         command_table,
                         None, NEW_PARAMETERS
@@ -137,7 +137,7 @@ def test_autocommand_with_command_alias(self):
                         "",
                         None,
                         [
-                            AutoCommandDefinition(Test_autocommand.sample_vm_get, None, 'woot')
+                            CommandDefinition(Test_autocommand.sample_vm_get, None, 'woot')
                         ],
                         command_table
                         )
@@ -165,7 +165,7 @@ def sample_sdk_method_with_weired_docstring(self, param_a, param_b, param_c):
                         "",
                         None,
                         [
-                            AutoCommandDefinition(sample_sdk_method_with_weired_docstring, None)
+                            CommandDefinition(sample_sdk_method_with_weired_docstring, None)
                         ],
                         command_table)
 

src/azure/cli/tests/test_test_script.py

@@ -0,0 +1,45 @@
+import json
+import unittest
+from six import StringIO
+
+from azure.cli.utils.command_test_script import _check_json as check_json
+
+class Test_test_script_checks(unittest.TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        pass
+
+    @classmethod
+    def tearDownClass(cls):
+        pass
+
+    def setUp(self):
+        self.io = StringIO()
+
+    def tearDown(self):
+        self.io.close()
+
+    def test_json_string(self):
+        ''' Verify a simple string value can be used to match a property on a source object. '''
+        source = json.loads(json.dumps({'a': 'b', 'c': 'd'}))
+        check = {'c': 'd'}
+        check_json(source, check)
+
+    def test_json_dict(self):
+        ''' Verify a dict can be used to search within child objects without having to match the
+        child object exactly.'''
+        source = json.loads(json.dumps({'a': {'foo': 'bar', 'fizz': 'buzz'}}))
+        check = {'a': {'fizz': 'buzz'}}
+        check_json(source, check)
+
+    def test_json_list(self):
+        ''' Verify that if the source is a list, the check need only pass for any element of the
+        list. '''
+        source = json.loads(json.dumps([{'a': {'b': 1, 'c': 2}}, {'a': {'b': 3, 'c': 5}}]))
+        check = {'a': {'c': 5}}
+        check_json(source, check)
+
+
+if __name__ == '__main__':
+    unittest.main()