From 0d457d30c105d78d120e2a8259cdc1264faf3833 Mon Sep 17 00:00:00 2001
From: John Chilton <jmchilton@gmail.com>
Date: Sun, 17 Aug 2014 18:43:54 -0400
Subject: [PATCH] Dynamic destinations - easier, high-level reasoning about
 docker tool support. Added supports_docker function to RuleHelper for use in
 dynamic destination rules.

Add a very simple stock dynamic destination type (docker_dispatcher) that will send all jobs into either a docker enabled destination or a vanilla destination depending on whether the tool being mapped supports docker (at this time that means is annotated explicitly with a container id).
---
 job_conf.xml.sample_advanced   | 11 +++++++++++
 lib/galaxy/jobs/mapper.py      |  3 ++-
 lib/galaxy/jobs/rule_helper.py | 18 ++++++++++++++++++
 lib/galaxy/jobs/stock_rules.py |  4 ++++
 4 files changed, 35 insertions(+), 1 deletion(-)

diff --git a/job_conf.xml.sample_advanced b/job_conf.xml.sample_advanced
index 7f905635300..0d2127ff1f5 100644
--- a/job_conf.xml.sample_advanced
+++ b/job_conf.xml.sample_advanced
@@ -266,6 +266,17 @@
             <param id="num_jobs">50</param>
             <!-- <param id="job_states">queued</param> -->
         </destination>
+        <destination id="docker_dispatch" runner="dynamic">
+            <!-- Follow dynamic destination type will send all tool's that
+            support docker to static destination defined by
+            docker_destination_id (docker_cluster in this example) and all
+            other tools to default_destination_id (normal_cluster in this
+            example).
+            -->
+            <param id="type">docker_dispatch</param>
+            <param id="docker_destination_id">docker_cluster</param>
+            <param id="default_destination_id">normal_cluster</param>
+        </destination>
         <destination id="secure_pulsar_rest_dest" runner="pulsar_rest">
             <param id="url">https://examle.com:8913/</param>
             <!-- If set, private_token must match token in remote Pulsar's
diff --git a/lib/galaxy/jobs/mapper.py b/lib/galaxy/jobs/mapper.py
index b395b9cc899..4f170f09477 100644
--- a/lib/galaxy/jobs/mapper.py
+++ b/lib/galaxy/jobs/mapper.py
@@ -31,7 +31,8 @@ class JobNotReadyException( Exception ):
 
 STOCK_RULES = dict(
     choose_one=stock_rules.choose_one,
-    burst=stock_rules.burst
+    burst=stock_rules.burst,
+    docker_dispatch=stock_rules.docker_dispatch,
 )
 
 
diff --git a/lib/galaxy/jobs/rule_helper.py b/lib/galaxy/jobs/rule_helper.py
index b8614d72683..536f98b8126 100644
--- a/lib/galaxy/jobs/rule_helper.py
+++ b/lib/galaxy/jobs/rule_helper.py
@@ -27,6 +27,24 @@ class RuleHelper( object ):
     def __init__( self, app ):
         self.app = app
 
+    def supports_docker( self, job_or_tool ):
+        """ Job rules can pass this function a job, job_wrapper, or tool and
+        determine if the underlying tool believes it can be containered.
+        """
+        # Not a ton of logic in this method - but the idea is to shield rule
+        # developers from the details and they shouldn't have to know how to
+        # interrogate tool or job to figure out if it can be run in a
+        # container.
+        if hasattr( job_or_tool, 'containers' ):
+            tool = job_or_tool
+        elif hasattr( job_or_tool, 'tool' ):
+            # Have a JobWrapper-like
+            tool = job_or_tool.tool
+        else:
+            # Have a Job object.
+            tool = self.app.toolbox.get_tool( job_or_tool.tool_id )
+        return any( [ c.type == "docker" for c in tool.containers ] )
+
     def job_count(
         self,
         **kwds
diff --git a/lib/galaxy/jobs/stock_rules.py b/lib/galaxy/jobs/stock_rules.py
index 666e9831a02..9d1d79b2643 100644
--- a/lib/galaxy/jobs/stock_rules.py
+++ b/lib/galaxy/jobs/stock_rules.py
@@ -19,3 +19,7 @@ def burst( rule_helper, job, from_destination_ids, to_destination_id, num_jobs,
         return to_destination_id
     else:
         return from_destination_ids[ 0 ]
+
+
+def docker_dispatch( rule_helper, tool, docker_destination_id, default_destination_id ):
+    return docker_destination_id if rule_helper.supports_docker( tool ) else default_destination_id