Merge "Add paging support in shell"

surveilclient/common/utils.py

@@ -12,6 +12,7 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.
+import json
 
 import os
 import prettytable
@@ -129,3 +130,39 @@ def get_columns(lines, ordered_columns):
             del columns_dict[col]
 
     return valid_columns + sorted(columns_dict.keys())
+
+def create_query(query=None, filters={}, start_time=None, end_time=None,
+                 page_size=None, page=None):
+    if query is None:
+        query = {}
+    else:
+        query = json.loads(query)
+
+    if start_time and end_time:
+        query['time_interval'] = {
+            "start_time": start_time,
+            "end_time": end_time
+        }
+
+    if 'filters' not in query:
+        query['filters'] = {}
+
+    for filter_type in filters:
+        if 'is' not in query['filters']:
+            query['filters'][filter_type] = {}
+
+        for value in filters[filter_type]:
+            if filters[filter_type][value] is not None:
+                query['filters'][filter_type][value] = [
+                    filters[filter_type][value]
+                ]
+
+    query['filters'] = json.dumps(query['filters'])
+
+    if page_size and page:
+        query['paging'] = {
+            'size': page_size,
+            'page': page
+        }
+
+    return query

surveilclient/tests/v2_0/status/test_events.py

@@ -32,7 +32,9 @@ class TestEvents(clienttest.ClientTest):
 
         events = self.client.status.events.list(host_name='sfl.com',
                                                 service_description='cpu',
-                                                event_type='ALERT')
+                                                event_type='ALERT',
+                                                page_size=50,
+                                                page=5)
 
         filters = json.loads(
             httpretty.last_request().body.decode())['filters']
@@ -42,6 +44,14 @@ class TestEvents(clienttest.ClientTest):
              "host_name": ["sfl.com"], "event_type": ["ALERT"]}
         )
 
+        paging = json.loads(
+            httpretty.last_request().body.decode())['paging']
+        self.assertEqual(
+            paging,
+            {u"page": 5,
+             u"size": 50}
+        )
+
         self.assertEqual(
             events,
             [{"host_name": "sfl.com", "service_description": "cpu",

surveilclient/v2_0/shell.py

@@ -368,6 +368,8 @@ def do_status_service_list(sc, args):
 @cliutils.arg("--end_time", help="end of the metric")
 @cliutils.arg("--service_description", help="Service description")
 @cliutils.arg("--live_query", help="Live query")
+@cliutils.arg("--page_size", help="Number of returned data")
+@cliutils.arg("--page", help="Page number")
 def do_status_metrics_list(sc, args):
     """List all status metrics."""
     arg_names = ['host_name',
@@ -376,6 +378,8 @@ def do_status_metrics_list(sc, args):
                  'end_time',
                  'service_description',
                  'live_query',
+                 'page_size',
+                 'page',
                  ]
     arg = _dict_from_args(args, arg_names)
 
@@ -454,6 +458,8 @@ def do_action_recheck(sc, args):
 @cliutils.arg("--event_type", help="Event type")
 @cliutils.arg("--start_time", help="Start of the event to query")
 @cliutils.arg("--end_time", help="End of the event to query")
+@cliutils.arg("--page_size", help="Number of returned data")
+@cliutils.arg("--page", help="Page number")
 @cliutils.arg("--live_query", help="A live query")
 def do_status_events_list(sc, args):
     """List all events."""
@@ -463,6 +469,8 @@ def do_status_events_list(sc, args):
                  'event_type',
                  'start_time',
                  'end_time',
+                 'page_size',
+                 'page',
                  'live_query']
     arg = _dict_from_args(args, arg_names)
     events = sc.status.events.list(**arg)

surveilclient/v2_0/status/events.py

@@ -12,48 +12,36 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-import json
-
 from surveilclient.common import surveil_manager
+from surveilclient.common import utils
 
 
 class EventsManager(surveil_manager.SurveilManager):
     base_url = '/status/events'
 
     def list(self, host_name=None, service_description=None, event_type=None,
-             start_time=None, end_time=None, live_query=None):
+             start_time=None, end_time=None, live_query=None,
+             page_size=None, page=None):
         """List events."""
 
-        if live_query is None:
-            live_query = {}
-        else:
-            live_query = json.loads(live_query)
-
-        if start_time and end_time:
-            live_query['time_interval'] = {
-                "start_time": start_time,
-                "end_time": end_time
+        filters = {
+            'is': {
+                'host_name': host_name,
+                'service_description': service_description,
+                'event_type': event_type
             }
+        }
 
-        if 'filters' not in live_query:
-            live_query['filters'] = {}
-
-        if 'is' not in live_query['filters']:
-            live_query['filters']['is'] = {}
-
-        if host_name:
-            live_query['filters']['is']['host_name'] = [host_name]
-
-        if service_description:
-            (live_query['filters']['is']
-                ['service_description']) = [service_description]
-
-        if event_type:
-            live_query['filters']['is']['event_type'] = [event_type]
-
-        live_query['filters'] = json.dumps(live_query['filters'])
+        query = utils.create_query(
+            query=live_query,
+            filters=filters,
+            start_time=start_time,
+            end_time=end_time,
+            page_size=page_size,
+            page=page
+        )
 
         resp, body = self.http_client.json_request(
-            EventsManager.base_url, 'POST', body=live_query
+            EventsManager.base_url, 'POST', body=query
         )
         return body

surveilclient/v2_0/status/metrics/metrics.py

@@ -11,9 +11,9 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.
-import json
 
 from surveilclient.common import surveil_manager
+from surveilclient.common import utils
 
 
 class MetricsManager(surveil_manager.SurveilManager):
@@ -30,23 +30,20 @@ class MetricsManager(surveil_manager.SurveilManager):
         return body
 
     def list(self, host_name, metric_name, service_description=None,
-             live_query=None, start_time=None, end_time=None):
+             live_query=None, start_time=None, end_time=None,
+             page_size=None, page=None):
         """Get a list of metrics name."""
-
-        if live_query is None:
-            live_query = {}
-        else:
-            live_query = json.loads(live_query)
-
-        if start_time and end_time:
-            live_query['time_interval'] = {
-                "start_time": start_time,
-                "end_time": end_time
-            }
+        query = utils.create_query(
+            query=live_query,
+            start_time=start_time,
+            end_time=end_time,
+            page_size=page_size,
+            page=page
+        )
 
         resp, body = self.http_client.json_request(
             self._create_url(host_name, service_description, metric_name),
-            'POST', body=live_query)
+            'POST', body=query)
 
         return body