add workspace that clones repo

Author: ggilmore

.gitignore

@@ -6,3 +6,4 @@ __pycache__/
 src
 .cache/
 python-langserver-cache/
+python-cloned-projects-cache/

Makefile

@@ -9,4 +9,4 @@ lint:
 
 test:
 	pipenv run pytest test_langserver.py
-	cd ./test && pipenv run pytest test_*.py
+	cd ./test && pipenv run pytest test_clone_workspace.py

Pipfile

@@ -11,6 +11,7 @@ jedi = {git = "git://github.com/sourcegraph/jedi.git", editable = true, ref = "9
 requirements = {git = "git://github.com/sourcegraph/requirements-parser.git", editable = true, ref = "69f1a9cb916b2995843c3ea9b988da46c9dd65c7"}
 opentracing = "*"
 lightstep = "*"
+"delegator.py" = "*"
 
 
 [dev-packages]

Pipfile.lock

@@ -0,0 +1,65 @@
+import logging
+import os
+import os.path
+from .config import GlobalConfig
+from .fs import FileSystem
+from shutil import rmtree
+
+log = logging.getLogger(__name__)
+
+
+class CloneWorkspace:
+
+    def __init__(self, fs: FileSystem, project_root: str,
+                 original_root_path: str= ""):
+
+        self.PROJECT_ROOT = project_root
+        self.repo = None
+        self.hash = None
+
+        if original_root_path.startswith(
+                "git://") and "?" in original_root_path:
+            repo_and_hash = original_root_path.split("?")
+            self.repo = repo_and_hash[0]
+            original_root_path = self.repo
+            self.hash = repo_and_hash[1]
+
+        if original_root_path.startswith("git://"):
+            original_root_path = original_root_path[6:]
+
+        # turn the original root path into something that can be used as a
+        # file/path name or cache key
+        self.key = original_root_path.replace("/", ".").replace("\\", ".")
+        if self.hash:
+            self.key = ".".join((self.key, self.hash))
+
+        # TODO: allow different Python versions per project/workspace
+        self.PYTHON_PATH = GlobalConfig.PYTHON_PATH
+        self.CLONED_PROJECT_PATH = os.path.join(
+            GlobalConfig.CLONED_PROJECT_PATH, self.key)
+        log.debug("Setting Python path to %s", self.PYTHON_PATH)
+        log.debug("Setting Cloned Project path to %s",
+                  self.CLONED_PROJECT_PATH)
+
+        self.fs = fs
+
+    def clone_project(self):
+        """
+        Clones the project from the provided filesystem into the local
+        cache
+        """
+        all_files = self.fs.walk(self.PROJECT_ROOT)
+        for file_path, file_contents in self.fs.batch_open(all_files, parent_span=None):
+            # strip the leading '/' so that we can join it properly
+            file_path = os.path.relpath(file_path, "/")
+
+            cache_file_path = os.path.join(self.CLONED_PROJECT_PATH, file_path)
+
+            os.makedirs(os.path.dirname(cache_file_path), exist_ok=True)
+
+            with open(cache_file_path, "w") as f:
+                f.write(file_contents)
+
+    def cleanup(self):
+        log.info("Removing cloned project cache %s", self.CLONED_PROJECT_PATH)
+        rmtree(self.CLONED_PROJECT_PATH, ignore_errors=True)

langserver/clone_workspace.py

@@ -7,5 +7,6 @@ class GlobalConfig:
 
     PYTHON_PATH = distutils.sysconfig.get_python_lib(standard_lib=True)
     PACKAGES_PARENT = "python-langserver-cache"
+    CLONED_PROJECT_PATH = "python-cloned-projects-cache"
     STDLIB_REPO_URL = "git://github.com/python/cpython"
     STDLIB_SRC_PATH = "Lib"

langserver/config.py

@@ -4,6 +4,7 @@ exclude =
     __pycache__,
     test_langserver.py,
     *python-langserver-cache*,
+    *python-cloned-projects-cache*,
     # don't run flake8 on repo submodules
     test/repos/*
 max-line-length=100
@@ -14,6 +15,7 @@ exclude =
     __pycache__,
     test_langserver.py,
     *python-langserver-cache*,
+    *python-cloned-projects-cache*,
     # don't run flake8 on repo submodules
     test/repos/*
 max-line-length=100

setup.cfg

@@ -0,0 +1,24 @@
+from langserver.clone_workspace import CloneWorkspace
+from langserver.fs import TestFileSystem
+import delegator
+import pytest
+
+
+@pytest.fixture()
+def test_data():
+    repoPath = "repos/fizzbuzz_service"
+    workspace = CloneWorkspace(TestFileSystem(repoPath), repoPath, repoPath)
+    yield (workspace, repoPath)
+    workspace.cleanup()
+
+
+class TestCloningWorkspace:
+    def test_clone(self, test_data):
+        workspace, repoPath = test_data
+        workspace.clone_project()
+
+        c = delegator.run("diff -r {} {}".format(repoPath,
+                                                 workspace.CLONED_PROJECT_PATH))
+        assert c.out == ""
+        assert c.err == ""
+        assert c.return_code == 0