Allow filtering resources by status

We're adding a "status" search option that can be specified when
listing the following resources:

* deployments
    * status -> last_execution_status db field
* transfers
* transfer executions

The filtering will be performed on the service side.

Author: petrutlucian94

coriolisclient/cli/deployments.py

@@ -284,14 +284,21 @@ def get_parser(self, prog_name):
             help='Comma-separated list of sort keys and directions in the '
                  'form of <key>[:<asc|desc>]. The direction defaults to '
                  'descending if not specified.')
+        parser.add_argument(
+            '--status',
+            help='Search by deployment status.')
         return parser
 
     def take_action(self, args):
+        filters = {}
+        if args.status:
+            filters["status"] = args.status
         sort_keys, sort_dirs = cli_utils.parse_sort_arg(args.sort)
         obj_list = self.app.client_manager.coriolis.deployments.list(
             marker=args.marker,
             limit=args.limit,
             sort_keys=sort_keys,
             sort_dirs=sort_dirs,
+            filters=filters,
         )
         return DeploymentFormatter().list_objects(obj_list)

coriolisclient/cli/transfer_executions.py

@@ -192,14 +192,22 @@ def get_parser(self, prog_name):
             help='Comma-separated list of sort keys and directions in the '
                  'form of <key>[:<asc|desc>]. The direction defaults to '
                  'descending if not specified.')
+        parser.add_argument(
+            '--status',
+            help='Search by execution status.')
         return parser
 
     def take_action(self, args):
+        filters = {}
+        if args.status:
+            filters["status"] = args.status
         sort_keys, sort_dirs = cli_utils.parse_sort_arg(args.sort)
         obj_list = self.app.client_manager.coriolis.transfer_executions.list(
             args.transfer,
             marker=args.marker,
             limit=args.limit,
             sort_keys=sort_keys,
-            sort_dirs=sort_dirs)
+            sort_dirs=sort_dirs,
+            filters=filters,
+        )
         return TransferExecutionFormatter().list_objects(obj_list)

coriolisclient/cli/transfers.py

@@ -331,15 +331,22 @@ def get_parser(self, prog_name):
             help='Comma-separated list of sort keys and directions in the '
                  'form of <key>[:<asc|desc>]. The direction defaults to '
                  'descending if not specified.')
+        parser.add_argument(
+            '--status',
+            help='Search by transfer status.')
         return parser
 
     def take_action(self, args):
+        filters = {}
+        if args.status:
+            filters["status"] = args.status
         sort_keys, sort_dirs = cli_utils.parse_sort_arg(args.sort)
         obj_list = self.app.client_manager.coriolis.transfers.list(
             marker=args.marker,
             limit=args.limit,
             sort_keys=sort_keys,
             sort_dirs=sort_dirs,
+            filters=filters,
         )
         return TransferFormatter().list_objects(obj_list)
 

coriolisclient/tests/cli/test_deployments.py

@@ -348,4 +348,5 @@ def test_take_action(self, mock_parse_sort_arg):
             limit=mock_args.limit,
             sort_keys=mock.sentinel.sort_keys,
             sort_dirs=mock.sentinel.sort_dirs,
+            filters={'status': mock_args.status},
         )

coriolisclient/tests/cli/test_transfer_executions.py

@@ -446,6 +446,7 @@ def test_take_action(
             limit=args.limit,
             sort_keys=mock.sentinel.sort_keys,
             sort_dirs=mock.sentinel.sort_dirs,
+            filters={'status': args.status},
         )
         mock_list_objects.assert_called_once_with(
             mock_transfer_list.return_value)

coriolisclient/tests/cli/test_transfers.py

@@ -494,6 +494,7 @@ def test_take_action(self, mock_parse_sort_arg, mock_list_objects):
             limit=args.limit,
             sort_keys=mock.sentinel.sort_keys,
             sort_dirs=mock.sentinel.sort_dirs,
+            filters={'status': args.status},
         )
 
 

coriolisclient/tests/v1/test_deployments.py

@@ -85,6 +85,7 @@ def test_list_with_pagination(self):
                 limit=mock.sentinel.limit,
                 sort_keys=[mock.sentinel.sort_key0, mock.sentinel.sort_key1],
                 sort_dirs=[mock.sentinel.sort_dir0, mock.sentinel.sort_dir1],
+                filters={"status": mock.sentinel.status},
             )
             exp_query = [
                 ("marker", mock.sentinel.marker),
@@ -93,6 +94,7 @@ def test_list_with_pagination(self):
                 ("sort_key", mock.sentinel.sort_key1),
                 ("sort_dir", mock.sentinel.sort_dir0),
                 ("sort_dir", mock.sentinel.sort_dir1),
+                ("status", mock.sentinel.status),
             ]
             self.assertEqual(mock_list.return_value, result)
             mock_list.assert_called_once_with(

coriolisclient/tests/v1/test_transfer_executions.py

@@ -60,6 +60,7 @@ def test_list_with_pagination(self, mock_list):
             limit=mock.sentinel.limit,
             sort_keys=[mock.sentinel.sort_key0, mock.sentinel.sort_key1],
             sort_dirs=[mock.sentinel.sort_dir0, mock.sentinel.sort_dir1],
+            filters={"status": mock.sentinel.status},
         )
         exp_query = [
             ("marker", mock.sentinel.marker),
@@ -68,6 +69,7 @@ def test_list_with_pagination(self, mock_list):
             ("sort_key", mock.sentinel.sort_key1),
             ("sort_dir", mock.sentinel.sort_dir0),
             ("sort_dir", mock.sentinel.sort_dir1),
+            ("status", mock.sentinel.status),
         ]
         self.assertEqual(
             mock_list.return_value,

coriolisclient/tests/v1/test_transfers.py

@@ -94,14 +94,17 @@ def test_list_with_pagination(self, mock_list):
             marker=mock.sentinel.marker,
             limit=mock.sentinel.limit,
             sort_keys=[mock.sentinel.sort_key0, mock.sentinel.sort_key1],
-            sort_dirs=[mock.sentinel.sort_dir0, mock.sentinel.sort_dir1],)
+            sort_dirs=[mock.sentinel.sort_dir0, mock.sentinel.sort_dir1],
+            filters={"status": mock.sentinel.status},
+        )
         exp_query = [
             ("marker", mock.sentinel.marker),
             ("limit", mock.sentinel.limit),
             ("sort_key", mock.sentinel.sort_key0),
             ("sort_key", mock.sentinel.sort_key1),
             ("sort_dir", mock.sentinel.sort_dir0),
             ("sort_dir", mock.sentinel.sort_dir1),
+            ("status", mock.sentinel.status)
         ]
         self.assertEqual(
             mock_list.return_value,

coriolisclient/v1/deployments.py

@@ -54,7 +54,7 @@ def __init__(self, api):
 
     def list(self, detail=False,
              marker=None, limit=None,
-             sort_keys=None, sort_dirs=None):
+             sort_keys=None, sort_dirs=None, filters=None):
         query = []
         if marker is not None:
             query.append(("marker", marker))
@@ -66,6 +66,8 @@ def list(self, detail=False,
         if sort_dirs is not None:
             query.extend(('sort_dir', sort_dir)
                          for sort_dir in sort_dirs)
+        if filters:
+            query.extend((key, value) for key, value in filters.items())
 
         path = "/deployments"
         if detail: