Add ACR Image Import Commands (#6375)

Author: Natalie

src/command_modules/azure-cli-acr/HISTORY.rst

@@ -5,6 +5,7 @@ Release History
 2.0.26
 ++++++
 * Allow VSTS as a remote source location
+* Add 'acr import' command.
 
 2.0.25
 ++++++

src/command_modules/azure-cli-acr/azure/cli/command_modules/acr/_help.py

@@ -429,3 +429,15 @@
           text: >
             az acr build -r MyRegistry .
 """
+
+helps['acr import'] = """
+    type: command
+    short-summary: Imports an image to the container registry from source.
+    examples:
+        - name: Import an image to the target registry and inherits sourcerepository:sourcetag from source.
+          text: >
+            az acr import -n MyRegistry --source sourceregistry.azurecr.io/sourcerepository:sourcetag
+        - name: Import an image from a registry in a different subscription.
+          text: >
+            az acr import -n MyRegistry --source sourcerepository:sourcetag -t targetrepository:targettag -r /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sourceResourceGroup/providers/Microsoft.ContainerRegistry/registries/sourceRegistry
+"""

src/command_modules/azure-cli-acr/azure/cli/command_modules/acr/_params.py

@@ -62,6 +62,13 @@ def load_arguments(self, _):  # pylint: disable=too-many-statements
         c.argument('no_push', help="Indicates whether the image built should be pushed to the registry.", arg_type=get_three_state_flag())
         c.argument('no_logs', help="Do not show logs after successfully queuing the build.", action='store_true')
 
+    with self.argument_context('acr import') as c:
+        c.argument('source', help="The source identifier in the format '[registry.azurecr.io/]repository[:tag]' or '[registry.azurecr.io/]repository@digest'.")
+        c.argument('source_registry', options_list=['--registry', '-r'], help='The source container registry can be name, login server or resource ID of the source registry.')
+        c.argument('target_tags', options_list=['--image', '-t'], help="The repository and optionally a tag in the 'repository:tag' format for target images.", action='append')
+        c.argument('repository', help='The repository name to do a manifest-only copy for images.', action='append')
+        c.argument('force', help='Overwrite the existing tag of the image to be imported.', action='store_true')
+
     with self.argument_context('acr repository delete') as c:
         c.argument('manifest', nargs='?', required=False, const='', default=None, help=argparse.SUPPRESS)
         c.argument('yes', options_list=['--yes', '-y'], action='store_true', help='Do not prompt for confirmation')

src/command_modules/azure-cli-acr/azure/cli/command_modules/acr/_utils.py

@@ -4,6 +4,7 @@
 # --------------------------------------------------------------------------------------------
 
 from knack.util import CLIError
+from knack.log import get_logger
 from azure.cli.core.commands.parameters import get_resources_in_subscription
 
 from azure.mgmt.containerregistry.v2017_10_01.models import SkuName, Sku
@@ -21,6 +22,8 @@
     get_acr_service_client
 )
 
+logger = get_logger(__name__)
+
 
 def _arm_get_resource_by_name(cli_ctx, resource_name, resource_type):
     """Returns the ARM resource in the current subscription with resource_name.
@@ -91,6 +94,27 @@ def get_registry_by_name(cli_ctx, registry_name, resource_group_name=None):
     return client.get(resource_group_name, registry_name), resource_group_name
 
 
+def get_registry_from_name_or_login_server(cli_ctx, login_server, registry_name=None):
+    """Returns a Registry object for the specified name.
+    :param str name: either the registry name or the login server of the registry.
+    """
+    client = get_acr_service_client(cli_ctx).registries
+    registry_list = client.list()
+
+    if registry_name:
+        elements = [item for item in registry_list if
+                    item.login_server.lower() == login_server.lower() or item.name.lower() == registry_name.lower()]
+    else:
+        elements = [item for item in registry_list if
+                    item.login_server.lower() == login_server.lower()]
+
+    if len(elements) == 1:
+        return elements[0]
+    elif len(elements) > 1:
+        logger.warning("More than one registries were found by %s.", login_server)
+    return None
+
+
 def arm_deploy_template_new_storage(cli_ctx,
                                     resource_group_name,
                                     registry_name,

src/command_modules/azure-cli-acr/azure/cli/command_modules/acr/commands.py

@@ -36,6 +36,11 @@ def load_command_table(self, _):  # pylint: disable=too-many-statements
         client_factory=cf_acr_registries
     )
 
+    acr_import_util = CliCommandType(
+        operations_tmpl='azure.cli.command_modules.acr.import#{}',
+        client_factory=cf_acr_registries
+    )
+
     acr_cred_util = CliCommandType(
         operations_tmpl='azure.cli.command_modules.acr.credential#{}',
         table_transformer=credential_output_format,
@@ -86,6 +91,9 @@ def load_command_table(self, _):  # pylint: disable=too-many-statements
                                  client_factory=cf_acr_registries,
                                  table_transformer=registry_output_format)
 
+    with self.command_group('acr', acr_import_util) as g:
+        g.command('import', 'acr_import')
+
     with self.command_group('acr credential', acr_cred_util) as g:
         g.command('show', 'acr_credential_show', exception_handler=empty_on_404)
         g.command('renew', 'acr_credential_renew')

src/command_modules/azure-cli-acr/azure/cli/command_modules/acr/import.py

@@ -0,0 +1,92 @@
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+from knack.util import CLIError
+from msrestazure.tools import is_valid_resource_id
+from azure.mgmt.containerregistry.v2018_02_01_preview.models import (
+    ImportImageParameters,
+    ImportSource,
+    ImportMode
+)
+from ._utils import (
+    validate_managed_registry,
+    get_registry_from_name_or_login_server
+)
+
+SOURCE_REGISTRY_MISSING = "Please specify the source container registry name, login server or resource ID: "
+IMPORT_NOT_SUPPORTED = "Imports are only supported for managed registries."
+INVALID_SOURCE_IMAGE = "Please specify source image in the format '[registry.azurecr.io/]repository[:tag]' or " \
+                       "'[registry.azurecr.io/]repository@digest'"
+SOURCE_REGISTRY_NOT_FOUND = "Source registry could not be found in the current subscription. " \
+                            "Please specify the full resource ID for it: "
+NO_TTY_ERROR = "Please specify source registry ID by passing parameters to import command directly."
+REGISTRY_MISMATCH = "Registry mismatch. Please check either source-image or resource ID " \
+                    "to make sure that they are referring to the same registry and try again."
+
+
+def acr_import(cmd,
+               client,
+               registry_name,
+               source,
+               source_registry=None,
+               target_tags=None,
+               resource_group_name=None,
+               repository=None,
+               force=False):
+    _, resource_group_name = validate_managed_registry(
+        cmd.cli_ctx, registry_name, resource_group_name, IMPORT_NOT_SUPPORTED)
+
+    if not source:
+        raise CLIError(INVALID_SOURCE_IMAGE)
+    source_image = source
+
+    slash = source.find('/')
+
+    if slash < 0:
+        if not source_registry:
+            from knack.prompting import prompt, NoTTYException
+            try:
+                source_registry = prompt(SOURCE_REGISTRY_MISSING)
+            except NoTTYException:
+                raise CLIError(NO_TTY_ERROR)
+        if not is_valid_resource_id(source_registry):
+            registry = get_registry_from_name_or_login_server(cmd.cli_ctx, source_registry, source_registry)
+            if registry:
+                source_registry = registry.id
+    else:
+        source_image = source[slash + 1:]
+        source_registry_login_server = source[:slash]
+        if not source_image or not source_registry_login_server:
+            raise CLIError(INVALID_SOURCE_IMAGE)
+        registry = get_registry_from_name_or_login_server(cmd.cli_ctx, source_registry_login_server)
+        if registry:
+            if source_registry and \
+               source_registry.lower() != registry.id.lower() and \
+               source_registry.lower() != registry.name.lower() and \
+               source_registry.lower() != registry.login_server.lower():
+                raise CLIError(REGISTRY_MISMATCH)
+            source_registry = registry.id
+
+    if not is_valid_resource_id(source_registry):
+        from knack.prompting import prompt, NoTTYException
+        try:
+            source_registry = prompt(SOURCE_REGISTRY_NOT_FOUND)
+        except NoTTYException:
+            raise CLIError(NO_TTY_ERROR)
+
+    image_source = ImportSource(resource_id=source_registry, source_image=source_image)
+
+    if not target_tags and not repository:
+        target_tags = [source_image]
+
+    import_parameters = ImportImageParameters(source=image_source,
+                                              target_tags=target_tags,
+                                              untagged_target_repositories=repository,
+                                              mode=ImportMode.force.value if force else ImportMode.no_force.value)
+
+    return client.import_image(
+        resource_group_name=resource_group_name,
+        registry_name=registry_name,
+        parameters=import_parameters)

src/command_modules/azure-cli-acr/azure/cli/command_modules/acr/tests/latest/recordings/test_acr_image_import.yaml

@@ -400,3 +400,66 @@ def test_acr_create_build_task(self, resource_group, resource_group_location):
 
         # test acr delete
         self.cmd('acr delete -n {registry_name} -g {rg}')
+
+    @ResourceGroupPreparer()
+    def test_acr_image_import(self, resource_group):
+        '''There are six test cases in the function.
+        Case 1: Import image from a regsitry in a different subscription from the current one
+        Case 2: Import image from one regsitry to another where both registries belong to the same subscription
+        Case 3: Import image to the target regsitry and keep the repository:tag the same as that in the source
+        Case 4: Import image to enable multiple tags in the target registry
+        Case 5: Import image within the same registry
+        Case 6: Import image by manifest digest
+        '''
+
+        registry_name = self.create_random_name("targetregsitry", 20)
+
+        '''
+        To be able to run the tests, we are assuming the following resources before the test:
+        Current active cloud account and subscription.
+        Two source registries, one in the subscription other than the current one and another in the subscription the same as the current one.
+        Two source images each of which stays in a different source registries mentioned above.
+        '''
+        self.kwargs.update({
+            'registry_name': registry_name,
+            'rg_loc': 'eastus',
+            'sku': 'Standard',
+            'resource_id': '/subscriptions/a7ee80a4-3d5e-45c2-9378-36e8d98f4d13/resourceGroups/resourcegroupdiffsub/providers/Microsoft.ContainerRegistry/registries/sourceregistrydiffsub',
+            'source_image_diff_sub': 'builder:latest',
+            'source_image_same_sub': 'sourceregistrysamesub.azurecr.io/builder:latest',
+            'source_image_same_registry': '{}.azurecr.io/builder:latest'.format(registry_name),
+            'source_image_by_digest': 'sourceregistrysamesub.azurecr.io/builder@sha256:bc3842ba36fcc182317c07a8643daa4a8e4e7aed45958b1f7e2a2b30c2f5a64f',
+            'tag_diff_sub': 'repository_diff_sub:tag_diff_sub',
+            'tag_same_sub': 'repository_same_sub:tag_same_sub',
+            'tag_multitag1': 'repository_multi1:tag_multi1',
+            'tag_multitag2': 'repository_multi2:tag_multi2',
+            'tag_same_registry': 'repository_same_registry:tag_same_registry',
+            'tag_by_digest': 'repository_by_digest:tag_by_digest'
+        })
+
+        # create a target registry to hold the imported images
+        self.cmd('acr create -n {registry_name} -g {rg} -l {rg_loc} --sku {sku}',
+                 checks=[self.check('name', '{registry_name}'),
+                         self.check('location', '{rg_loc}'),
+                         self.check('adminUserEnabled', False),
+                         self.check('sku.name', 'Standard'),
+                         self.check('sku.tier', 'Standard'),
+                         self.check('provisioningState', 'Succeeded')])
+
+        # Case 1: Import image from a regsitry in a different subscription from the current one
+        self.cmd('acr import -n {registry_name} -r {resource_id} --source {source_image_diff_sub} -t {tag_diff_sub}')
+
+        # Case 2: Import image from one regsitry to another where both registries belong to the same subscription
+        self.cmd('acr import -n {registry_name} --source {source_image_same_sub} -t {tag_same_sub}')
+
+        # Case 3: Import image to the target regsitry and keep the repository:tag the same as that in the source
+        self.cmd('acr import -n {registry_name} --source {source_image_same_sub}')
+
+        # Case 4: Import image to enable multiple tags in the target registry
+        self.cmd('acr import -n {registry_name} --source {source_image_same_sub} -t {tag_multitag1} -t {tag_multitag2}')
+
+        # Case 5: Import image within the same registry
+        self.cmd('acr import -n {registry_name} --source {source_image_same_registry} -t {tag_same_registry}')
+
+        # Case 6: Import image by manifest digest
+        self.cmd('acr import -n {registry_name} --source {source_image_by_digest} -t {tag_by_digest}')