From 38679a0d32ad4897d1f60a68bac4cfc03aad3b89 Mon Sep 17 00:00:00 2001
From: John Chilton <jmchilton@gmail.com>
Date: Mon, 9 Feb 2015 21:43:42 -0500
Subject: [PATCH] Dynamically fetch and cache test-data from git repositories
 if needed... ... for tool tests. Longer term this functionality should be
 dropped (i.e. after all the tools are out of Galaxy) and the test-data always
 lives next to the tool - but for now it decreases the size of the repository
 ahead of a potential move to github.

---
 .hgignore                   |  1 +
 scripts/functional_tests.py |  2 +-
 test/base/test_data.py      | 75 ++++++++++++++++++++++++++++++++++++-
 3 files changed, 76 insertions(+), 2 deletions(-)

diff --git a/.hgignore b/.hgignore
index beab290cf6b..697cb030a0e 100644
--- a/.hgignore
+++ b/.hgignore
@@ -89,6 +89,7 @@ tool-data/*.loc
 tool-data/genome/*
 
 # Test output
+test-data-cache
 run_functional_tests.html
 test/tool_shed/tmp/*
 .coverage
diff --git a/scripts/functional_tests.py b/scripts/functional_tests.py
index a1aff16f495..64c9f8bcdc6 100644
--- a/scripts/functional_tests.py
+++ b/scripts/functional_tests.py
@@ -68,7 +68,7 @@ default_galaxy_test_host = "localhost"
 default_galaxy_test_port_min = 8000
 default_galaxy_test_port_max = 9999
 default_galaxy_locales = 'en'
-default_galaxy_test_file_dir = "test-data"
+default_galaxy_test_file_dir = "test-data,https://github.com/galaxyproject/galaxy-test-data.git"
 migrated_tool_panel_config = 'config/migrated_tools_conf.xml'
 installed_tool_panel_configs = [ 'config/shed_tool_conf.xml' ]
 
diff --git a/test/base/test_data.py b/test/base/test_data.py
index 255ff47cd51..7b04e7c6b77 100644
--- a/test/base/test_data.py
+++ b/test/base/test_data.py
@@ -1,5 +1,22 @@
+from __future__ import print_function
+import hashlib
 import os
 import re
+from string import Template
+import subprocess
+
+from galaxy.util import asbool
+
+UPDATE_TEMPLATE = Template(
+    "git --work-tree $dir --git-dir $dir/.git fetch && "
+    "git --work-tree $dir --git-dir $dir/.git merge origin/master"
+)
+
+UPDATE_FAILED_TEMPLATE = Template(
+    "Warning failed to update test repository $dir - "
+    "update stdout was [$stdout] and stderr was [$stderr]."
+)
+
 
 LIST_SEP = re.compile("\s*,\s*")
 
@@ -9,7 +26,7 @@ class TestDataResolver(object):
     def __init__(self, env_var, environ=os.environ):
         file_dirs = environ.get(env_var, None)
         if file_dirs:
-            self.resolvers = map(FileDataResolver, LIST_SEP.split(file_dirs))
+            self.resolvers = map(lambda u: build_resolver(u, environ), LIST_SEP.split(file_dirs))
         else:
             self.resolvers = []
 
@@ -34,6 +51,13 @@ class TestDataResolver(object):
         return os.path.abspath(filename)
 
 
+def build_resolver(uri, environ):
+    if uri.startswith("http") and uri.endswith(".git"):
+        return GitDataResolver(uri, environ)
+    else:
+        return FileDataResolver(uri)
+
+
 class FileDataResolver(object):
 
     def __init__(self, file_dir):
@@ -44,3 +68,52 @@ class FileDataResolver(object):
 
     def path(self, filename):
         return os.path.join(self.file_dir, filename)
+
+
+class GitDataResolver(FileDataResolver):
+
+    def __init__(self, repository, environ):
+        self.repository = repository
+        self.updated = False
+        repo_cache = environ.get("GALAXY_TEST_DATA_REPO_CACHE", "test-data-repos")
+        m = hashlib.md5()
+        m.update(repository)
+        repo_path = os.path.join(repo_cache, m.hexdigest())
+        super(GitDataResolver, self).__init__(repo_path)
+        # My preference would be for this to be false, but for backward compat
+        # will leave it as true for now.
+        self.fetch_data = asbool(environ.get("GALAXY_TEST_FETCH_DATA", "true"))
+
+    def exists(self, filename):
+        exists_now = super(GitDataResolver, self).exists(filename)
+        if exists_now or not self.fetch_data or self.updated:
+            return exists_now
+        self.update_repository()
+        return super(GitDataResolver, self).exists(filename)
+
+    def update_repository(self):
+        self.updated = True
+        if not os.path.exists(self.file_dir):
+            parent_dir = os.path.dirname(self.file_dir)
+            if not os.path.exists(parent_dir):
+                os.makedirs(parent_dir)
+            self.execute("git clone '%s' '%s'" % (self.repository, self.file_dir))
+        update_command = UPDATE_TEMPLATE.safe_substitute(dir=self.file_dir)
+        self.execute(update_command)
+
+    def execute(self, cmd):
+        subprocess_kwds = dict(
+            shell=True,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+        )
+        print("Executing %s" % cmd)
+        p = subprocess.Popen(cmd, **subprocess_kwds)
+        stdout, stderr = p.communicate()
+        if p.returncode != 0:
+            kwds = {
+                'dir': self.file_dir,
+                'stdout': stdout,
+                'stderr': stderr,
+            }
+            print(UPDATE_FAILED_TEMPLATE.substitute(**kwds))