Allow botlist API call to respond to quarantined: and is_dead:

appengine/swarming/handlers_endpoints.py

 # Copyright 2015 The LUCI Authors. All rights reserved.
 # Use of this source code is governed under the Apache License, Version 2.0
 # that can be found in the LICENSE file.
 
 """This module defines Swarming Server endpoints handlers."""
 
 import datetime
 import logging
 
 from google.appengine.api import datastore_errors
@@ skipping 590 matching lines @@
           message_conversion.task_result_to_rpc(
               r, request.include_performance_stats)
           for r in items
         ],
         now=now)
 
 
 @swarming_api.api_class(resource_name='bots', path='bots')
 class SwarmingBotsService(remote.Service):
   """Bots-related API."""
+
+  def _build_query(self, request, now):

[M-A Ruel, 2016/08/09 17:10:34]

"""Returns a ndb.Query for BotInfo based on the request."""

[kjlubick, 2016/08/09 17:41:32]

Done.

+    q = bot_management.BotInfo.query()
+    for d in request.dimensions:
+      if not ':' in d:

[M-A Ruel, 2016/08/09 17:10:34]

This check is not necessary, the len(parts) != 2 already checks for this
condition. So remove lines 615-616.

[kjlubick, 2016/08/09 17:41:32]

Done.

+        raise endpoints.BadRequestException('Invalid dimensions')
+      parts = d.split(':', 1)
+      if len(parts) != 2 or any(i.strip() != i or not i for i in parts):
+        raise endpoints.BadRequestException('Invalid dimensions')
+      q = q.filter(bot_management.BotInfo.dimensions_flat == d)
+
+    if request.quarantined == swarming_rpcs.ThreeStateBool.TRUE:
+      q = q.filter(bot_management.BotInfo.quarantined == True)
+    elif request.quarantined == swarming_rpcs.ThreeStateBool.FALSE:
+      q = q.filter(bot_management.BotInfo.quarantined == False)
+
+    dt = datetime.timedelta(

[M-A Ruel, 2016/08/09 17:10:34]

according to line 617, this fits one line.

[kjlubick, 2016/08/09 17:41:32]

Done.

+        seconds=config.settings().bot_death_timeout_secs)
+    timeout = now - dt
+    if request.is_dead == swarming_rpcs.ThreeStateBool.TRUE:
+      q = q.filter(bot_management.BotInfo.last_seen_ts < timeout)
+    elif request.is_dead == swarming_rpcs.ThreeStateBool.FALSE:
+      q = q.filter(bot_management.BotInfo.last_seen_ts > timeout)
+
+    return q
+
+
   @gae_ts_mon.instrument_endpoint()
   @auth.endpoints_method(
       swarming_rpcs.BotsRequest, swarming_rpcs.BotList,
       http_method='GET')
   @auth.require(acl.is_privileged_user)
   def list(self, request):
     """Provides list of known bots.
 
     Deleted bots will not be listed.
     """
     logging.info('%s', request)
     now = utils.utcnow()
-    q = bot_management.BotInfo.query().order(bot_management.BotInfo.key)
-    for d in request.dimensions:
-      if not ':' in d:
-        raise endpoints.BadRequestException('Invalid dimensions')
-      parts = d.split(':', 1)
-      if len(parts) != 2 or any(i.strip() != i or not i for i in parts):
-        raise endpoints.BadRequestException('Invalid dimensions')
-      q = q.filter(bot_management.BotInfo.dimensions_flat == d)
+    q = self._build_query(request, now)
+
     bots, cursor = datastore_utils.fetch_page(q, request.limit, request.cursor)
     return swarming_rpcs.BotList(
         cursor=cursor,
         death_timeout=config.settings().bot_death_timeout_secs,
         items=[message_conversion.bot_info_to_rpc(bot, now) for bot in bots],
         now=now)
 
   @gae_ts_mon.instrument_endpoint()
   @auth.endpoints_method(
       swarming_rpcs.BotsRequest, swarming_rpcs.BotsCount,
       http_method='GET')
   @auth.require(acl.is_privileged_user)
   def count(self, request):
     """Counts number of bots with given dimensions."""
     logging.info('%s', request)
     now = utils.utcnow()
-    q = bot_management.BotInfo.query()
-    for d in request.dimensions:
-      parts = d.split(':', 1)
-      if len(parts) != 2 or any(i.strip() != i or not i for i in parts):
-        raise endpoints.BadRequestException('Invalid dimensions: %s' % d)
-      q = q.filter(bot_management.BotInfo.dimensions_flat == d)
+    q = self._build_query(request, now)
+
     f_count = q.count_async()
     dt = datetime.timedelta(seconds=config.settings().bot_death_timeout_secs)
     timeout = now - dt
     f_dead = q.filter(
         bot_management.BotInfo.last_seen_ts < timeout).count_async()
     f_quarantined = q.filter(
         bot_management.BotInfo.quarantined == True).count_async()
     f_busy = q.filter(bot_management.BotInfo.is_busy == True).count_async()
     return swarming_rpcs.BotsCount(
         count=f_count.get_result(),
@@ skipping 20 matching lines @@
 def get_routes():
   return (
     endpoints_webapp2.api_routes(SwarmingServerService) +
     endpoints_webapp2.api_routes(SwarmingTaskService) +
     endpoints_webapp2.api_routes(SwarmingTasksService) +
     endpoints_webapp2.api_routes(SwarmingBotService) +
     endpoints_webapp2.api_routes(SwarmingBotsService) +
     # components.config endpoints for validation and configuring of luci-config
     # service URL.
     endpoints_webapp2.api_routes(config.ConfigApi))