RD-6537 agents list: add --all-states (#1457)

* RD-6537 agents list: add `--all-states`

By default, `cfy agents list` only shows started agents; with this,
it still does that, but CLI-side rather than restclient-side;
and now it's also possible to list agents in other states.

Additionally, also show that state.

* update tests

- make all the mocks now expect the implicit state
- check --all-states too

* flake & format

Author: tehasdf

cloudify_cli/cli/cfy.py

@@ -16,6 +16,7 @@
 
 import click
 
+from cloudify.models_states import AgentState
 from cloudify_rest_client.constants import VisibilityState
 from cloudify_rest_client.exceptions import NotModifiedError
 from cloudify_rest_client.exceptions import CloudifyClientError
@@ -1949,18 +1950,36 @@ def agent_filters(self, f):
 
         Applies deployment id, node id and node instance id filters.
         """
-        node_instance_id = click.option('--node-instance-id', multiple=True,
-                                        help=helptexts.AGENT_NODE_INSTANCE_ID,
-                                        callback=self.parse_comma_separated)
-        node_id = click.option('--node-id', multiple=True,
-                               help=helptexts.AGENT_NODE_ID,
-                               callback=self.parse_comma_separated)
-        install_method = click.option('--install-method', multiple=True,
-                                      help=helptexts.AGENT_INSTALL_METHOD,
-                                      callback=self.parse_comma_separated)
-        deployment_id = click.option('--deployment-id', multiple=True,
-                                     help=helptexts.AGENT_DEPLOYMENT_ID,
-                                     callback=self.parse_comma_separated)
+        node_instance_id = click.option(
+            '--node-instance-id',
+            multiple=True,
+            help=helptexts.AGENT_NODE_INSTANCE_ID,
+            callback=self.parse_comma_separated,
+        )
+        node_id = click.option(
+            '--node-id',
+            multiple=True,
+            help=helptexts.AGENT_NODE_ID,
+            callback=self.parse_comma_separated,
+        )
+        install_method = click.option(
+            '--install-method',
+            multiple=True,
+            help=helptexts.AGENT_INSTALL_METHOD,
+            callback=self.parse_comma_separated,
+        )
+        deployment_id = click.option(
+            '--deployment-id',
+            multiple=True,
+            help=helptexts.AGENT_DEPLOYMENT_ID,
+            callback=self.parse_comma_separated,
+        )
+        all_states = click.option(
+            '--all-states',
+            default=False,
+            is_flag=True,
+            help=helptexts.AGENT_ALL_STATES,
+        )
 
         # we add separate --node-instance-id, --node-id and --deployment-id
         # arguments, but only expose a agents_filter = {'node_id': ..} dict
@@ -1976,12 +1995,14 @@ def _inner(*args, **kwargs):
                         ('install_method', AGENT_FILTER_INSTALL_METHODS)]:
                     filters[filter_name] = kwargs.pop(arg_name, None)
 
+                if not kwargs.pop('all_states', False):
+                    filters['state'] = [AgentState.STARTED]
                 kwargs['agent_filters'] = filters
                 return f(*args, **kwargs)
             return _inner
 
         for arg in [install_method, node_instance_id, node_id,
-                    deployment_id, _filters_deco]:
+                    deployment_id, all_states, _filters_deco]:
             f = arg(f)
         return f
 

cloudify_cli/cli/helptexts.py

@@ -433,6 +433,7 @@
 AGENT_INSTALL_METHOD = 'Only show agents installed with this install_method' \
                        + _MULTIPLE_TIMES_FRAGMENT
 AGENT_DEPLOYMENT_ID = DEPLOYMENT_ID + _MULTIPLE_TIMES_FRAGMENT
+AGENT_ALL_STATES = 'Show agents in all states, not only started ones'
 
 AGENTS_WAIT = "Wait for agents operations to end, and show execution logs"
 INSTALL_AGENT_TIMEOUT = "Agent installation timeout"

cloudify_cli/commands/agents.py

@@ -35,8 +35,8 @@
 
 
 _NODE_INSTANCE_STATE_STARTED = 'started'
-AGENT_COLUMNS = ['id', 'ip', 'deployment', 'node', 'system', 'version',
-                 'install_method', 'tenant_name']
+AGENT_COLUMNS = ['id', 'ip', 'deployment', 'state', 'node', 'system',
+                 'version', 'install_method', 'tenant_name']
 
 MAX_TRACKER_THREADS = 20
 

cloudify_cli/tests/commands/test_options.py

@@ -1,5 +1,6 @@
 from mock import MagicMock
 
+from cloudify.models_states import AgentState
 from cloudify_cli.logger import get_global_json_output
 
 from .mocks import MockListResponse
@@ -33,7 +34,9 @@ def test_agent_filters_all_tenants(self):
             install_methods=[],
             node_ids=['a'],
             node_instance_ids=[],
-            _all_tenants=True)
+            _all_tenants=True,
+            state=[AgentState.STARTED],
+        )
 
     def test_agent_filters_multiple(self):
         self.invoke('agents list --node-id a --node-id b')
@@ -42,7 +45,9 @@ def test_agent_filters_multiple(self):
             install_methods=[],
             node_ids=['a', 'b'],
             node_instance_ids=[],
-            _all_tenants=False)
+            _all_tenants=False,
+            state=[AgentState.STARTED],
+        )
 
     def test_agent_filters_commaseparated(self):
         self.invoke('agents list --node-id a,b')
@@ -51,7 +56,9 @@ def test_agent_filters_commaseparated(self):
             install_methods=[],
             node_ids=['a', 'b'],
             node_instance_ids=[],
-            _all_tenants=False)
+            _all_tenants=False,
+            state=[AgentState.STARTED],
+        )
 
     def test_agent_filters_commaseparated_multiple(self):
         self.invoke('agents list --node-id a,b --node-id c')
@@ -60,4 +67,16 @@ def test_agent_filters_commaseparated_multiple(self):
             install_methods=[],
             node_ids=['a', 'b', 'c'],
             node_instance_ids=[],
-            _all_tenants=False)
+            _all_tenants=False,
+            state=[AgentState.STARTED],
+        )
+
+    def test_agents_filters_all_states(self):
+        self.invoke('agents list --all-states')
+        self.client.agents.list.assert_called_with(
+            deployment_id=[],
+            install_methods=[],
+            node_ids=[],
+            node_instance_ids=[],
+            _all_tenants=False,
+        )