cli/(.*)list: Implement optional ad-hoc --limit

slapos/cli/computer_list.py

@@ -40,6 +40,10 @@ class ListCommand(ClientConfigCommand):
 
     def get_parser(self, prog_name):
         ap = super(ListCommand, self).get_parser(prog_name)
+
+        ap.add_argument('--limit',
+                        type=int,
+                        help='Count limit')
         return ap
 
     def take_action(self, args):
@@ -52,7 +56,7 @@ class ListCommand(ClientConfigCommand):
 
 def do_list(logger, conf, local):
     resetLogger(logger)
-    computer_dict = local['slap'].getComputerDict()
+    computer_dict = local['slap'].getComputerDict(limit=conf.limit)
     if computer_dict == {}:
       logger.info('No existing computer.')
       return

slapos/cli/list.py

@@ -41,6 +41,11 @@ class ListCommand(ClientConfigCommand):
 
     def get_parser(self, prog_name):
         ap = super(ListCommand, self).get_parser(prog_name)
+
+        ap.add_argument('--limit',
+                        type=int,
+                        help='Count limit')
+
         return ap
 
     def take_action(self, args):
@@ -54,7 +59,7 @@ class ListCommand(ClientConfigCommand):
 def do_list(logger, conf, local):
     resetLogger(logger)
     # XXX catch exception
-    instance_dict = local['slap'].getOpenOrderDict()
+    instance_dict = local['slap'].getOpenOrderDict(limit=conf.limit)
     logger.info(
       json.dumps(
         {title: instance._software_release_url

slapos/slap/hateoas.py

@@ -60,6 +60,9 @@ ALLOWED_JIO_FIELD_LIST = [
   "FloatField",
   "TextAreaField"]
 
+JIO_QUERY_DEFAULT_LIMIT = 40
+
+
 class TempDocument(object):
   def __init__(self, **kw):
     """
@@ -272,15 +275,14 @@ class HateoasNavigator(object):
       "form_data": form_data_dict
     }
 
-  def jio_allDocs(self, query):
+  def jio_allDocs(self, **query):
     # by default search_url is a Python script (ERP5Document_getHateoas)
     # which enforces a too low limit of what is to be returned (default = 10)
     # as testnode uses this to introspect created ERP5 instance which usually has
     # at least 18 sub instances this limit is too low thus we need to explicitly
     # increase it. 40 is the de-facto default ERP5 preference for number of objects
     # which are usually to be rendered in alistbox 'view' mode
-    if 'limit' not in query:
-       query['limit'] = 40
+    query.setdefault('limit', JIO_QUERY_DEFAULT_LIMIT)
     search_url = self._getSearchUrl()
     getter_link = expand(search_url, query)
 
@@ -342,17 +344,19 @@ class SlapHateoasNavigator(HateoasNavigator):
   ###############################################################
   # API for Client as a Person
   ###############################################################
-  def _getInstanceTreeList(self, title=None, select_list=["title", "url_string"]):
+  def _getInstanceTreeList(self, title=None, select_list=("title", "url_string"), limit=None):
     query_str = 'portal_type:"Instance Tree" AND validation_state:validated'
     if title is not None:
       query_str = 'portal_type:"Instance Tree" AND validation_state:validated AND title:="%s"' % title
 
     result = self.jio_allDocs(
-      query={"query" : query_str, "select_list": select_list})
+      query=query_str,
+      select_list=select_list,
+      limit=limit or JIO_QUERY_DEFAULT_LIMIT)
 
     return result['data']['rows']
 
-  def _getComputerList(self, title=None, reference=None, select_list=["title", "reference"]):
+  def _getComputerList(self, title=None, reference=None, select_list=("title", "reference"), limit=None):
     query_str = 'portal_type:"Computer" AND validation_state:validated'
     if title is not None:
       query_str += ' AND title:="%s"' % title
@@ -361,23 +365,27 @@ class SlapHateoasNavigator(HateoasNavigator):
       query_str += ' AND reference:="%s"' % reference
 
     result = self.jio_allDocs(
-      query={"query" : query_str, "select_list": select_list})
+      query=query_str,
+      select_list=select_list,
+      limit=limit or JIO_QUERY_DEFAULT_LIMIT)
 
     return result['data']['rows']
 
-  def getInstanceTreeInstanceList(self, title):
+  def getInstanceTreeInstanceList(self, title, limit=None):
     select_list = ['uid', 'title', 'relative_url', 'portal_type', 
             'url_string', 'text_content', 'getConnectionXmlAsDict',
             'SoftwareInstance_getNewsDict']
     query_str = 'portal_type:("Software Instance", "Slave Instance") AND validation_state:validated'
     query_str += ' AND default_specialise_title:="%s"' % title
     result = self.jio_allDocs(
-      query={"query" : query_str, "select_list": select_list})
+      query=query_str,
+      select_list=select_list,
+      limit=limit or JIO_QUERY_DEFAULT_LIMIT)
 
     return result['data']['rows']
 
-  def getInstanceTreeDict(self, title=None):
-    instance_tree_list = self._getInstanceTreeList(title=title)
+  def getInstanceTreeDict(self, title=None, limit=None):
+    instance_tree_list = self._getInstanceTreeList(title=title, limit=limit)
     instance_tree_dict = {}
     for instance_tree in instance_tree_list:
       software_instance = TempDocument()
@@ -390,8 +398,8 @@ class SlapHateoasNavigator(HateoasNavigator):
 
     return instance_tree_dict
 
-  def getComputerDict(self):
-    computer_list = self._getComputerList()
+  def getComputerDict(self, limit=None):
+    computer_list = self._getComputerList(limit=None)
     computer_dict = {}
     for computer_json  in computer_list:
       computer = TempDocument()
@@ -448,13 +456,16 @@ class SlapHateoasNavigator(HateoasNavigator):
     return self.jio_get(computer_jio_key)
 
   def getSoftwareInstallationList(self, computer_guid=None,
-          select_list=['uid', 'relative_url', 'url_string', 'SoftwareInstallation_getNewsDict']):
+          select_list=('uid', 'relative_url', 'url_string', 'SoftwareInstallation_getNewsDict'),
+          limit=None):
     query_str = 'portal_type:"Software Installation" AND validation_state:validated'
     if computer_guid is not None:
       query_str += ' AND default_aggregate_reference:="%s"' % computer_guid
 
     result = self.jio_allDocs(
-      query={"query" : query_str, "select_list": select_list})
+      query=query_str,
+      select_list=select_list,
+      limit=limit or JIO_QUERY_DEFAULT_LIMIT)
 
     return result['data']['rows']
 

slapos/slap/slap.py

@@ -887,13 +887,13 @@ class slap:
     assert(type(result) == list)
     return result
 
-  def getOpenOrderDict(self):
+  def getOpenOrderDict(self, limit=None):
     if not getattr(self, '_hateoas_navigator', None):
       raise Exception('SlapOS Master Hateoas API required for this operation is not available.')
-    return self._hateoas_navigator.getInstanceTreeDict()
+    return self._hateoas_navigator.getInstanceTreeDict(limit=limit)
 
-  def getComputerDict(self): 
+  def getComputerDict(self, limit=None):
     if not getattr(self, '_hateoas_navigator', None):
       raise Exception('SlapOS Master Hateoas API required for this operation is not available.')
-    return self._hateoas_navigator.getComputerDict()
+    return self._hateoas_navigator.getComputerDict(limit=limit)
 

slapos/tests/test_cli.py

@@ -594,6 +594,10 @@ class TestCliNode(CliMixin):
 
 
 class TestCliList(CliMixin):
+  def setUp(self):
+    super(TestCliList, self).setUp()
+    self.conf.limit = None
+
   def test_list(self):
     """
     Test "slapos service list" command output.
@@ -705,6 +709,10 @@ class TestCliInfo(CliMixin):
     self.logger.warning.assert_called_once_with('Instance %s does not exist.', self.conf.reference)
 
 class TestCliComputerList(CliMixin):
+  def setUp(self):
+    super(TestCliComputerList, self).setUp()
+    self.conf.limit = None
+
   def test_computer_list(self):
     """
     Test "slapos computer list" command output.
@@ -714,14 +722,14 @@ class TestCliComputerList(CliMixin):
       'computer2': slapos.slap.hateoas.TempDocument(title='computer2', _reference='COMP-0'),
     }
     with patch.object(slapos.slap.slap, 'getComputerDict', return_value=return_value) as _:
-      slapos.cli.computer_list.do_list(self.logger, None, self.local)
+      slapos.cli.computer_list.do_list(self.logger, self.conf, self.local)
 
     self.logger.info.assert_any_call('%s %s', 'COMP-1', 'computer1')
     self.logger.info.assert_any_call('%s %s', 'COMP-0', 'computer2')
 
   def test_computer_emptyList(self):
     with patch.object(slapos.slap.slap, 'getComputerDict', return_value={}) as _:
-      slapos.cli.computer_list.do_list(self.logger, None, self.local)
+      slapos.cli.computer_list.do_list(self.logger, self.conf, self.local)
 
     self.logger.info.assert_called_once_with('No existing computer.')