Move summary commands to their respective entities

Author: Madda

cloudify_cli/commands/blueprints.py

@@ -37,13 +37,15 @@
 from ..utils import (prettify_client_error,
                      get_visibility,
                      validate_visibility)
+from .summary import BASE_SUMMARY_FIELDS, structure_summary_results
 
 
 DESCRIPTION_LIMIT = 20
 BASE_BLUEPRINT_COLUMNS = ['id', 'description', 'main_file_name', 'created_at']
 BLUEPRINT_COLUMNS = BASE_BLUEPRINT_COLUMNS + ['updated_at', 'visibility',
                                               'tenant_name', 'created_by']
 INPUTS_COLUMNS = ['name', 'type', 'default', 'description']
+BLUEPRINTS_SUMMARY_FIELDS = BASE_SUMMARY_FIELDS
 
 
 @cfy.group(name='blueprints')
@@ -457,3 +459,45 @@ def set_visibility(blueprint_id, visibility, logger, client):
         client.blueprints.set_visibility(blueprint_id, visibility)
         logger.info('Blueprint `{0}` was set to {1}'.format(blueprint_id,
                                                             visibility))
+
+
+@blueprints.command(name='summary',
+                    short_help='Retrieve summary of blueprint details '
+                               '[manager only]')
+@cfy.argument('target_field', type=click.Choice(BLUEPRINTS_SUMMARY_FIELDS))
+@cfy.argument('sub_field', type=click.Choice(BLUEPRINTS_SUMMARY_FIELDS),
+              default=None, required=False)
+@cfy.options.common_options
+@cfy.options.tenant_name(required=False, resource_name_for_help='summary')
+@cfy.options.all_tenants
+@cfy.pass_logger
+@cfy.pass_client()
+def summary(target_field, sub_field, logger, client, tenant_name,
+            all_tenants):
+    """Retrieve summary of blueprints, e.g. a count of each blueprint with
+    the same tenant name.
+
+    `TARGET_FIELD` is the field to summarise blueprints on.
+    """
+    utils.explicit_tenant_name_message(tenant_name, logger)
+    logger.info('Retrieving summary of blueprints on field {field}'.format(
+        field=target_field))
+
+    summary = client.summary.blueprints.get(
+        _target_field=target_field,
+        _sub_field=sub_field,
+        _all_tenants=all_tenants,
+    )
+
+    columns, items = structure_summary_results(
+        summary.items,
+        target_field,
+        sub_field,
+        'blueprints',
+    )
+
+    print_data(
+        columns,
+        items,
+        'Blueprint summary by {field}'.format(field=target_field),
+    )

cloudify_cli/commands/deployments.py

@@ -18,8 +18,7 @@
 import json
 import shutil
 
-from StringIO import StringIO
-
+import click
 from cloudify_rest_client.constants import VISIBILITY_EXCEPT_PRIVATE
 from cloudify_rest_client.exceptions import (
     DeploymentPluginNotFound,
@@ -29,6 +28,9 @@
     UnsupportedDeploymentGetSecretError,
     CloudifyClientError
 )
+from StringIO import StringIO
+
+
 from . import blueprints
 from ..local import load_env
 from ..table import print_data, print_single, print_details
@@ -44,6 +46,7 @@
                      get_visibility,
                      validate_visibility,
                      get_deployment_environment_execution)
+from .summary import BASE_SUMMARY_FIELDS, structure_summary_results
 
 
 DEPLOYMENT_COLUMNS = ['id', 'blueprint_id', 'created_at', 'updated_at',
@@ -52,6 +55,9 @@
                              'execution_id', 'created_at', 'visibility',
                              'old_blueprint_id', 'new_blueprint_id']
 TENANT_HELP_MESSAGE = 'The name of the tenant of the deployment'
+DEPLOYMENTS_SUMMARY_FIELDS = [
+    'blueprint_id',
+] + BASE_SUMMARY_FIELDS
 
 
 @cfy.group(name='deployments')
@@ -599,3 +605,45 @@ def local_outputs(blueprint_id, logger):
     """
     env = load_env(blueprint_id)
     logger.info(json.dumps(env.outputs() or {}, sort_keys=True, indent=2))
+
+
+@deployments.command(name='summary',
+                     short_help='Retrieve summary of deployment details '
+                                '[manager only]')
+@cfy.argument('target_field', type=click.Choice(DEPLOYMENTS_SUMMARY_FIELDS))
+@cfy.argument('sub_field', type=click.Choice(DEPLOYMENTS_SUMMARY_FIELDS),
+              default=None, required=False)
+@cfy.options.common_options
+@cfy.options.tenant_name(required=False, resource_name_for_help='summary')
+@cfy.options.all_tenants
+@cfy.pass_logger
+@cfy.pass_client()
+def summary(target_field, sub_field, logger, client, tenant_name,
+            all_tenants):
+    """Retrieve summary of deployments, e.g. a count of each deployment with
+    the same blueprint ID.
+
+    `TARGET_FIELD` is the field to summarise deployments on.
+    """
+    utils.explicit_tenant_name_message(tenant_name, logger)
+    logger.info('Retrieving summary of deployments on field {field}'.format(
+        field=target_field))
+
+    summary = client.summary.deployments.get(
+        _target_field=target_field,
+        _sub_field=sub_field,
+        _all_tenants=all_tenants,
+    )
+
+    columns, items = structure_summary_results(
+        summary.items,
+        target_field,
+        sub_field,
+        'deployments',
+    )
+
+    print_data(
+        columns,
+        items,
+        'Deployment summary by {field}'.format(field=target_field),
+    )

cloudify_cli/commands/executions.py

@@ -17,6 +17,7 @@
 import json
 import time
 
+import click
 from cloudify_rest_client import exceptions
 
 from .. import local
@@ -29,6 +30,7 @@
 from ..execution_events_fetcher import wait_for_execution
 from ..exceptions import CloudifyCliError, ExecutionTimeoutError, \
     SuppressedCloudifyCliError
+from .summary import BASE_SUMMARY_FIELDS, structure_summary_results
 
 _STATUS_CANCELING_MESSAGE = (
     'NOTE: Executions currently in a "canceling/force-canceling" status '
@@ -44,6 +46,12 @@
     'is_dry_run', 'deployment_id', 'created_at', 'started_at', 'scheduled_for',
     'visibility', 'tenant_name', 'created_by']
 EXECUTION_TABLE_LABELS = {'status_display': 'status'}
+EXECUTIONS_SUMMARY_FIELDS = [
+    'status',
+    'blueprint_id',
+    'deployment_id',
+    'workflow_id',
+] + BASE_SUMMARY_FIELDS
 
 
 @cfy.group(name='executions')
@@ -405,3 +413,45 @@ def local_start(workflow_id,
                          task_thread_pool_size=task_thread_pool_size)
     if result is not None:
         logger.info(json.dumps(result, sort_keys=True, indent=2))
+
+
+@executions.command(name='summary',
+                    short_help='Retrieve summary of execution details '
+                               '[manager only]')
+@cfy.argument('target_field', type=click.Choice(EXECUTIONS_SUMMARY_FIELDS))
+@cfy.argument('sub_field', type=click.Choice(EXECUTIONS_SUMMARY_FIELDS),
+              default=None, required=False)
+@cfy.options.common_options
+@cfy.options.tenant_name(required=False, resource_name_for_help='summary')
+@cfy.options.all_tenants
+@cfy.pass_logger
+@cfy.pass_client()
+def summary(target_field, sub_field, logger, client, tenant_name,
+            all_tenants):
+    """Retrieve summary of executions, e.g. a count of each execution with
+    the same deployment ID.
+
+    `TARGET_FIELD` is the field to summarise executions on.
+    """
+    utils.explicit_tenant_name_message(tenant_name, logger)
+    logger.info('Retrieving summary of executions on field {field}'.format(
+        field=target_field))
+
+    summary = client.summary.executions.get(
+        _target_field=target_field,
+        _sub_field=sub_field,
+        _all_tenants=all_tenants,
+    )
+
+    columns, items = structure_summary_results(
+        summary.items,
+        target_field,
+        sub_field,
+        'executions',
+    )
+
+    print_data(
+        columns,
+        items,
+        'Execution summary by {field}'.format(field=target_field),
+    )

cloudify_cli/commands/node_instances.py

@@ -16,6 +16,7 @@
 
 import json
 
+import click
 from cloudify_rest_client.exceptions import CloudifyClientError
 
 from .. import utils
@@ -24,24 +25,31 @@
 from ..logger import get_global_json_output
 from ..table import print_data, print_details, print_single
 from ..exceptions import CloudifyCliError
+from .summary import BASE_SUMMARY_FIELDS, structure_summary_results
 
 
 NODE_INSTANCE_COLUMNS = ['id', 'deployment_id', 'host_id', 'node_id', 'state',
                          'visibility', 'tenant_name', 'created_by']
+NODE_INSTANCES_SUMMARY_FIELDS = [
+    'deployment_id',
+    'node_id',
+    'state',
+    'host_id',
+] + BASE_SUMMARY_FIELDS
 
 
 @cfy.group(name='node-instances')
 @cfy.options.common_options
 @cfy.assert_manager_active()
-def manager():
+def node_instances():
     """Handle a deployment's node-instances
     """
     pass
 
 
-@manager.command(name='get',
-                 short_help='Retrieve node-instance information '
-                 '[manager only]')
+@node_instances.command(name='get',
+                        short_help='Retrieve node-instance information '
+                                   '[manager only]')
 @cfy.argument('node_instance_id')
 @cfy.options.common_options
 @cfy.options.tenant_name(
@@ -82,9 +90,9 @@ def get(node_instance_id, logger, client, tenant_name):
     logger.info('')
 
 
-@manager.command(name='list',
-                 short_help='List node-instances for a deployment '
-                 '[manager only]')
+@node_instances.command(name='list',
+                        short_help='List node-instances for a deployment '
+                                   '[manager only]')
 @cfy.options.deployment_id(required=False)
 @cfy.options.node_name
 @cfy.options.sort_by('node_id')
@@ -142,6 +150,53 @@ def list(deployment_id,
                 .format(len(node_instances), total))
 
 
+@node_instances.command(name='summary',
+                        short_help='Retrieve summary of node instance '
+                                   'details [manager only]')
+@cfy.argument('target_field',
+              type=click.Choice(NODE_INSTANCES_SUMMARY_FIELDS))
+@cfy.argument('sub_field',
+              type=click.Choice(NODE_INSTANCES_SUMMARY_FIELDS),
+              default=None, required=False)
+@cfy.options.common_options
+@cfy.options.tenant_name(required=False, resource_name_for_help='summary')
+@cfy.options.all_tenants
+@cfy.pass_logger
+@cfy.pass_client()
+def summary(target_field, sub_field, logger, client, tenant_name,
+            all_tenants):
+    """Retrieve summary of node instances, e.g. a count of each node instance
+    with the same deployment ID.
+
+    `TARGET_FIELD` is the field to summarise node instances on.
+    """
+    utils.explicit_tenant_name_message(tenant_name, logger)
+    logger.info(
+        'Retrieving summary of node instances on field {field}'.format(
+            field=target_field,
+        )
+    )
+
+    summary = client.summary.node_instances.get(
+        _target_field=target_field,
+        _sub_field=sub_field,
+        _all_tenants=all_tenants,
+    )
+
+    columns, items = structure_summary_results(
+        summary.items,
+        target_field,
+        sub_field,
+        'node_instances',
+    )
+
+    print_data(
+        columns,
+        items,
+        'Node instance summary by {field}'.format(field=target_field),
+    )
+
+
 @cfy.command(name='node-instances',
              short_help='Show node-instance information [locally]')
 @cfy.argument('node-id', required=False)