RD-2141 Add deployments display name (#1292)

* Adding display name to deployments create.
* Adding --generate-id to deployments create.
* Adding --search-name to deployments list.

Author: YoniItzhak

cloudify_cli/cli/cfy.py

@@ -250,6 +250,17 @@ def parse_and_validate_label_to_delete(ctx, param, value):
     return get_formatted_labels_list(value, allow_only_key=True)
 
 
+def validate_value_not_empty(ctx, param, value):
+    if value is None or ctx.resilient_parsing:
+        return
+
+    if not value:
+        raise CloudifyValidationError(
+            'ERROR: The `{0}` argument is empty'.format(param.name))
+
+    return value
+
+
 def get_formatted_labels_list(raw_labels_string, allow_only_key=False):
     labels_list = []
     if any(unicodedata.category(char)[0] == 'C' or char == '"'
@@ -1734,6 +1745,26 @@ def __init__(self):
             help=helptexts.FILTER_ID
         )
 
+        self.generate_id = click.option(
+            '--generate-id',
+            is_flag=True,
+            default=False,
+            help=helptexts.GENERATE_ID
+        )
+
+        self.display_name = click.option(
+            '-n',
+            '--display-name',
+            callback=validate_value_not_empty,
+            help=helptexts.DISPLAY_NAME
+        )
+
+        self.search_name = click.option(
+            '--search-name',
+            callback=validate_value_not_empty,
+            help=helptexts.SEARCH_NAME
+        )
+
     def common_options(self, f):
         """A shorthand for applying commonly used arguments.
 

cloudify_cli/cli/helptexts.py

@@ -209,7 +209,7 @@
 
 SORT_BY = "Key for sorting the list"
 DESCENDING = "Sort list in descending order [default: False]"
-SEARCH = 'Search resources by name/id. The returned list will include only ' \
+SEARCH = 'Search resources by id. The returned list will include only ' \
          'resources that contain the given search pattern'
 
 TENANT = 'The name of the tenant'
@@ -543,3 +543,13 @@
                               'already existing in this group.'
 GROUP_ID_FILTER = 'Show only results belonging to this group'
 DELETE_GROUP_DEPLOYMENTS = 'Delete all deployments belonging to this group'
+
+GENERATE_ID = 'Generate a UUID to serve as the deployment ID. This flag ' \
+              'cannot be provided if a deployment ID is specified'
+
+DISPLAY_NAME = 'The display name of the deployment. If not specified, ' \
+               'the deployment ID will be used instead.'
+
+SEARCH_NAME = 'Search deployments by their display name. The returned list ' \
+              'will include only deployments that contain the given search ' \
+              'pattern'

cloudify_cli/commands/deployments.py

@@ -15,6 +15,7 @@
 ############
 
 import os
+import uuid
 import json
 import shutil
 from datetime import datetime
@@ -65,8 +66,8 @@
 
 
 DEPLOYMENT_COLUMNS = [
-    'id', 'blueprint_id', 'created_at', 'updated_at', 'visibility',
-    'tenant_name', 'created_by', 'site_name', 'labels',
+    'id', 'display_name', 'blueprint_id', 'created_at', 'updated_at',
+    'visibility', 'tenant_name', 'created_by', 'site_name', 'labels',
     'deployment_status', 'installation_status'
 ]
 DEPLOYMENT_UPDATE_COLUMNS = [
@@ -205,6 +206,7 @@ def _print_single_update(deployment_update_dict,
     required=False, resource_name_for_help='deployment')
 @cfy.options.all_tenants
 @cfy.options.search
+@cfy.options.search_name
 @cfy.options.pagination_offset
 @cfy.options.pagination_size
 @cfy.options.common_options
@@ -219,6 +221,7 @@ def manager_list(blueprint_id,
                  descending,
                  all_tenants,
                  search,
+                 search_name,
                  pagination_offset,
                  pagination_size,
                  logger,
@@ -245,7 +248,8 @@ def manager_list(blueprint_id,
                                           _offset=pagination_offset,
                                           _size=pagination_size,
                                           _group_id=group_id,
-                                          blueprint_id=blueprint_id)
+                                          blueprint_id=blueprint_id,
+                                          _search_name=search_name)
     modify_resource_labels(deployments)
     total = deployments.metadata.pagination.total
     print_data(DEPLOYMENT_COLUMNS, deployments, 'Deployments:')
@@ -522,6 +526,8 @@ def manager_update(ctx,
 @cfy.options.visibility()
 @cfy.options.site_name
 @cfy.options.labels
+@cfy.options.generate_id
+@cfy.options.display_name
 @cfy.options.common_options
 @cfy.options.tenant_name(required=False, resource_name_for_help='deployment')
 @cfy.options.runtime_only_evaluation
@@ -536,6 +542,8 @@ def manager_create(blueprint_id,
                    visibility,
                    site_name,
                    labels,
+                   generate_id,
+                   display_name,
                    logger,
                    client,
                    tenant_name,
@@ -549,8 +557,18 @@ def manager_create(blueprint_id,
     utils.explicit_tenant_name_message(tenant_name, logger)
     logger.info('Creating new deployment from blueprint {0}...'.format(
         blueprint_id))
-    deployment_id = deployment_id or blueprint_id
     visibility = get_visibility(private_resource, visibility, logger)
+    if deployment_id:
+        if generate_id:
+            raise CloudifyCliError('`--generate-id` cannot be provided if a '
+                                   'deployment ID is specified')
+    else:
+        if generate_id:
+            deployment_id = str(uuid.uuid4())
+        else:
+            deployment_id = blueprint_id
+
+    display_name = display_name or deployment_id
 
     try:
         deployment = client.deployments.create(
@@ -561,7 +579,8 @@ def manager_create(blueprint_id,
             skip_plugins_validation=skip_plugins_validation,
             site_name=site_name,
             runtime_only_evaluation=runtime_only_evaluation,
-            labels=labels
+            labels=labels,
+            display_name=display_name
         )
     except (MissingRequiredDeploymentInputError,
             UnknownDeploymentInputError) as e:
@@ -580,8 +599,8 @@ def manager_create(blueprint_id,
         logger.info('Unable to create deployment due to invalid secret')
         raise CloudifyCliError(str(e))
 
-    logger.info("Deployment created. The deployment's id is {0}".format(
-        deployment.id))
+    logger.info("Deployment `{0}` created. The deployment's id is "
+                "{1}".format(deployment.display_name, deployment.id))
 
 
 @cfy.command(name='delete',

cloudify_cli/tests/commands/test_deployments.py

@@ -14,11 +14,14 @@
 # limitations under the License.
 ############
 
+from __future__ import unicode_literals
+
 
 import json
 import inspect
 import datetime
 import warnings
+from uuid import UUID
 
 from mock import patch, MagicMock, PropertyMock, Mock
 
@@ -724,6 +727,43 @@ def raise_error(*args, **kwargs):
             self.assertTrue(found, 'String ''{0}'' not found in outcome {1}'
                             .format(output, outcome))
 
+    def test_create_deployment_with_display_name(self):
+        dep_display_name = 'Depl\xf3yment'
+        self.client.deployments.create = Mock()
+        self.invoke('cfy deployments create -b bp1 -n {0} '
+                    'dep1'.format(dep_display_name))
+        call_args = list(self.client.deployments.create.call_args)
+        self.assertEqual(call_args[1]['display_name'], dep_display_name)
+
+    def test_create_deployment_display_name_defaults_to_id(self):
+        dep_id = 'dep1'
+        self.client.deployments.create = Mock()
+        self.invoke('cfy deployments create -b bp1 {0}'.format(dep_id))
+        call_args = list(self.client.deployments.create.call_args)
+        self.assertEqual(call_args[1]['display_name'], dep_id)
+
+    def test_create_deployment_with_generated_id(self):
+        self.client.deployments.create = Mock()
+        self.invoke('cfy deployments create -b bp1 --generate-id')
+        call_args = list(self.client.deployments.create.call_args)
+        try:
+            UUID(call_args[0][1], version=4)
+        except ValueError:
+            raise Exception('The deployment was not created with a valid UUID')
+
+    def test_create_deployment_with_id_and_generate_id_fails(self):
+        self.invoke('cfy deployments create -b bp1 --generate-id dep1',
+                    err_str_segment='cannot be provided',
+                    exception=CloudifyCliError)
+
+    def test_list_deployments_with_search_name(self):
+        search_name_pattern = 'De#pl\xf3yment 1'
+        self.client.deployments.list = Mock(return_value=MockListResponse())
+        self.invoke('cfy deployments list --search-name '
+                    '"{0}"'.format(search_name_pattern))
+        call_args = list(self.client.deployments.list.call_args)
+        self.assertEqual(call_args[1].get('_search_name'), search_name_pattern)
+
 
 class DeploymentModificationsTest(CliCommandTest):
     def _mock_wait_for_executions(self, value):