Merge pull request #364 from jaipreet-s/change-files-api

Server API to list changed files in Git

Author: saulshanabrook

jupyterlab_git/git.py

@@ -3,9 +3,11 @@
 """
 import os
 import subprocess
-from subprocess import Popen, PIPE
+from subprocess import Popen, PIPE, CalledProcessError
 from urllib.parse import unquote
 
+from tornado.web import HTTPError
+
 
 class Git:
     """
@@ -16,6 +18,55 @@ def __init__(self, root_dir, *args, **kwargs):
         super(Git, self).__init__(*args, **kwargs)
         self.root_dir = os.path.realpath(os.path.expanduser(root_dir))
 
+
+    def changed_files(self, base=None, remote=None, single_commit=None):
+        """Gets the list of changed files between two Git refs, or the files changed in a single commit
+
+        There are two reserved "refs" for the base
+            1. WORKING : Represents the Git working tree
+            2. INDEX: Represents the Git staging area / index
+        
+        Keyword Arguments:
+            single_commit {string} -- The single commit ref
+            base {string} -- the base Git ref
+            remote {string} -- the remote Git ref
+        
+        Returns:
+            dict -- the response of format {
+                "code": int, # Command status code
+                "files": [string, string], # List of files changed.
+                "message": [string] # Error response
+            }
+        """
+        if single_commit:
+            cmd = ['git', 'diff', f'{single_commit}^!', '--name-only']
+        elif base and remote:
+            if base == 'WORKING':
+                cmd = ['git', 'diff', remote, '--name-only']
+            elif base == 'INDEX':
+                cmd = ['git', 'diff', '--staged', remote, '--name-only']
+            else:
+                cmd = ['git', 'diff', base, remote, '--name-only']
+        else:
+            raise HTTPError(400, f'Either single_commit or (base and remote) must be provided')
+
+        
+        response = {}
+        try:
+            stdout = subprocess.check_output(
+                cmd, 
+                cwd=self.root_dir,
+                stderr=subprocess.STDOUT
+            )
+            response['files'] = stdout.decode('utf-8').strip().split('\n')
+            response['code'] = 0
+        except CalledProcessError as e:
+            response['message'] =  e.output.decode('utf-8')
+            response['code'] = e.returncode
+
+        return response
+
+
     def clone(self, current_path, repo_url):
         """
         Execute `git clone`. Disables prompts for the password to avoid the terminal hanging.

jupyterlab_git/handlers.py

@@ -413,6 +413,15 @@ def post(self):
         print(my_output)
         self.finish(my_output)
 
+class GitChangedFilesHandler(GitHandler):
+
+    def post(self):
+        self.finish(
+            json.dumps(
+                self.git.changed_files(**self.get_json_body())
+            )
+        )
+
 
 def setup_handlers(web_app):
     """
@@ -440,7 +449,8 @@ def setup_handlers(web_app):
         ("/git/all_history", GitAllHistoryHandler),
         ("/git/add_all_untracked", GitAddAllUntrackedHandler),
         ("/git/clone", GitCloneHandler),
-        ("/git/upstream", GitUpstreamHandler)
+        ("/git/upstream", GitUpstreamHandler),
+        ("/git/changed_files", GitChangedFilesHandler)
     ]
 
     # add the baseurl to our paths

tests/unit/test_diff.py

@@ -0,0 +1,98 @@
+from subprocess import PIPE, STDOUT, CalledProcessError
+
+from mock import Mock, call, patch
+import pytest
+from tornado.web import HTTPError
+
+
+from jupyterlab_git.git import Git
+
+
+def test_changed_files_invalid_input():
+    with pytest.raises(HTTPError):
+        actual_response = Git(root_dir="/bin").changed_files(
+            base="64950a634cd11d1a01ddfedaeffed67b531cb11e"
+        )
+
+
+@patch("subprocess.check_output")
+def test_changed_files_single_commit(mock_call):
+    # Given
+    mock_call.return_value = b"file1.ipynb\nfile2.py"
+
+    # When
+    actual_response = Git(root_dir="/bin").changed_files(
+        single_commit="64950a634cd11d1a01ddfedaeffed67b531cb11e"
+    )
+
+    # Then
+    mock_call.assert_called_with(
+        ["git", "diff", "64950a634cd11d1a01ddfedaeffed67b531cb11e^!", "--name-only"],
+        cwd="/bin",
+        stderr=STDOUT,
+    )
+    assert {"code": 0, "files": ["file1.ipynb", "file2.py"]} == actual_response
+
+
+@patch("subprocess.check_output")
+def test_changed_files_working_tree(mock_call):
+    # Given
+    mock_call.return_value = b"file1.ipynb\nfile2.py"
+
+    # When
+    actual_response = Git(root_dir="/bin").changed_files(base="WORKING", remote="HEAD")
+
+    # Then
+    mock_call.assert_called_with(
+        ["git", "diff", "HEAD", "--name-only"], cwd="/bin", stderr=STDOUT
+    )
+    assert {"code": 0, "files": ["file1.ipynb", "file2.py"]} == actual_response
+
+
+@patch("subprocess.check_output")
+def test_changed_files_index(mock_call):
+    # Given
+    mock_call.return_value = b"file1.ipynb\nfile2.py"
+
+    # When
+    actual_response = Git(root_dir="/bin").changed_files(base="INDEX", remote="HEAD")
+
+    # Then
+    mock_call.assert_called_with(
+        ["git", "diff", "--staged", "HEAD", "--name-only"], cwd="/bin", stderr=STDOUT
+    )
+    assert {"code": 0, "files": ["file1.ipynb", "file2.py"]} == actual_response
+
+
+@patch("subprocess.check_output")
+def test_changed_files_two_commits(mock_call):
+    # Given
+    mock_call.return_value = b"file1.ipynb\nfile2.py"
+
+    # When
+    actual_response = Git(root_dir="/bin").changed_files(
+        base="HEAD", remote="origin/HEAD"
+    )
+
+    # Then
+    mock_call.assert_called_with(
+        ["git", "diff", "HEAD", "origin/HEAD", "--name-only"], cwd="/bin", stderr=STDOUT
+    )
+    assert {"code": 0, "files": ["file1.ipynb", "file2.py"]} == actual_response
+
+
+@patch("subprocess.check_output")
+def test_changed_files_git_diff_error(mock_call):
+    # Given
+    mock_call.side_effect = CalledProcessError(128, "cmd", b"error message")
+
+    # When
+    actual_response = Git(root_dir="/bin").changed_files(
+        base="HEAD", remote="origin/HEAD"
+    )
+
+    # Then
+    mock_call.assert_called_with(
+        ["git", "diff", "HEAD", "origin/HEAD", "--name-only"], cwd="/bin", stderr=STDOUT
+    )
+    assert {"code": 128, "message": "error message"} == actual_response