Add endpoint tests

Author: Frederic Collonval

.gitignore

@@ -110,3 +110,4 @@ MANIFEST
 jupyterlab_git/labextension/*.tgz
 .pytest_cache/
 *.tsbuildinfo
+.pytest_cache/

jupyterlab_git/git.py

@@ -24,6 +24,7 @@ def __init__(self, command, cwd, env, username, password):
         self.env = env
         self.username = username
         self.password = password
+
     def communicate(self):
         try:
             p = pexpect.spawn(
@@ -896,7 +897,7 @@ def _get_tag(self, current_path, commit_sha):
 
     def show(self, filename, ref, top_repo_path):
         """
-        Execute git show<ref:filename> command & return the result.
+        Execute git show <ref:filename> command & return the result.
         """
         command = ["git", "show", '{}:{}'.format(ref, filename)]
         p = subprocess.Popen(
@@ -917,7 +918,7 @@ def show(self, filename, ref, top_repo_path):
         elif any([msg in lower_error for msg in error_messages]):
             return ""
         else:
-            raise Exception('Error [{}] occurred while executing [{}] command to retrieve plaintext diff.'.format(
+            raise HTTPError(log_message='Error [{}] occurred while executing [{}] command to retrieve plaintext diff.'.format(
                 error.decode('utf-8'),
                 ' '.join(command)
             ))
@@ -934,17 +935,14 @@ def diff_content(self, filename, prev_ref, curr_ref, top_repo_path):
         """
         Collect get content of prev and curr and return.
         """
-        try:
-            prev_content = self.show(filename, prev_ref["git"], top_repo_path)
-            if "special" in curr_ref:
-                if curr_ref["special"] == "WORKING":
-                    curr_content = self.get_content(filename, top_repo_path)
-                elif curr_ref["special"] == "INDEX":
-                    curr_content = self.show(filename, "", top_repo_path)
-                else:
-                    raise Exception("Error while retrieving plaintext diff, unknown special ref '{}'.".format(curr_ref["specialref"]))
+        prev_content = self.show(filename, prev_ref["git"], top_repo_path)
+        if "special" in curr_ref:
+            if curr_ref["special"] == "WORKING":
+                curr_content = self.get_content(filename, top_repo_path)
+            elif curr_ref["special"] == "INDEX":
+                curr_content = self.show(filename, "", top_repo_path)
             else:
-                curr_content = self.show(filename, curr_ref["git"], top_repo_path)
-            return {"prev_content": prev_content, "curr_content": curr_content}
-        except:
-            raise
+                raise HTTPError(log_message="Error while retrieving plaintext diff, unknown special ref '{}'.".format(curr_ref["special"]))
+        else:
+            curr_content = self.show(filename, curr_ref["git"], top_repo_path)
+        return {"prev_content": prev_content, "curr_content": curr_content}

jupyterlab_git/tests/test_handlers.py

@@ -1,5 +1,7 @@
 import json
-from unittest.mock import Mock, ANY, patch
+import os
+import subprocess
+from unittest.mock import ANY, call, Mock, patch
 
 from jupyterlab_git.handlers import (
     GitAllHistoryHandler,
@@ -10,6 +12,8 @@
     setup_handlers
 )
 
+from .testutils import assert_http_error, ServerTest
+
 def test_mapping_added():
     mock_web_app = Mock()
     mock_web_app.settings = {
@@ -231,3 +235,284 @@ def test_upstream_handler_localbranch(mock_finish, mock_git):
     mock_git.get_current_branch.assert_called_with('test_path')
     mock_git.get_upstream_branch.assert_called_with('test_path', 'foo')
     mock_finish.assert_called_with('{"upstream": "bar"}')
+
+class TestDiffContent(ServerTest):
+
+    @patch("subprocess.Popen")
+    def test_diffcontent(self, popen):
+        # Given
+        top_repo_path = "path/to/repo"
+        filename = "my/file"
+        content = "dummy content file\nwith multiplelines"
+
+        process_mock = Mock()
+        attrs = {
+            "communicate": Mock(
+                return_value=(
+                    bytes(content, encoding="utf-8"),
+                    b"",
+                )
+            ),
+            "returncode": 0,
+        }
+        process_mock.configure_mock(**attrs)
+        popen.return_value = process_mock
+
+        # When
+        body = {
+            "filename": filename,
+            "prev_ref": {"git": "previous"},
+            "curr_ref": {"git": "current"},
+            "top_repo_path" : top_repo_path
+        }
+        response = self.tester.post(["diffcontent"], body=body)
+
+        # Then
+        assert response.status_code == 200
+        payload = response.json()
+        assert payload["prev_content"] == content
+        assert payload["curr_content"] == content
+        popen.assert_has_calls([
+            call(
+                ["git", "show", '{}:{}'.format("previous", filename)],
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+                cwd=os.path.join(self.notebook_dir, top_repo_path)
+            ),
+            call().communicate(),
+            call(
+                ["git", "show", '{}:{}'.format("current", filename)],
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+                cwd=os.path.join(self.notebook_dir, top_repo_path)
+            ),
+            call().communicate()
+        ])
+
+    @patch("subprocess.Popen")
+    def test_diffcontent_working(self, popen):
+        # Given
+        top_repo_path = "path/to/repo"
+        filename = "my/file"
+        content = "dummy content file\nwith multiplelines"
+
+        process_mock = Mock()
+        attrs = {
+            "communicate": Mock(
+                return_value=(
+                    bytes(content, encoding="utf-8"),
+                    b"",
+                )
+            ),
+            "returncode": 0,
+        }
+        process_mock.configure_mock(**attrs)
+        popen.return_value = process_mock
+
+        dummy_file = os.path.join(self.notebook_dir, top_repo_path, filename)
+        os.makedirs(os.path.dirname(dummy_file))
+        with open(dummy_file, 'w') as f:
+            f.write(content)
+
+        # When
+        body = {
+            "filename": filename,
+            "prev_ref": {"git": "previous"},
+            "curr_ref": {"special": "WORKING"},
+            "top_repo_path" : top_repo_path
+        }
+        response = self.tester.post(["diffcontent"], body=body)
+
+        # Then
+        assert response.status_code == 200
+        payload = response.json()
+        assert payload["prev_content"] == content
+        assert payload["curr_content"] == content
+        popen.assert_has_calls([
+            call(
+                ["git", "show", '{}:{}'.format("previous", filename)],
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+                cwd=os.path.join(self.notebook_dir, top_repo_path)
+            ),
+            call().communicate()
+        ])
+
+    @patch("subprocess.Popen")
+    def test_diffcontent_index(self, popen):
+        # Given
+        top_repo_path = "path/to/repo"
+        filename = "my/file"
+        content = "dummy content file\nwith multiplelines"
+
+        process_mock = Mock()
+        attrs = {
+            "communicate": Mock(
+                return_value=(
+                    bytes(content, encoding="utf-8"),
+                    b"",
+                )
+            ),
+            "returncode": 0,
+        }
+        process_mock.configure_mock(**attrs)
+        popen.return_value = process_mock
+
+        # When
+        body = {
+            "filename": filename,
+            "prev_ref": {"git": "previous"},
+            "curr_ref": {"special": "INDEX"},
+            "top_repo_path" : top_repo_path
+        }
+        response = self.tester.post(["diffcontent"], body=body)
+
+        # Then
+        assert response.status_code == 200
+        payload = response.json()
+        assert payload["prev_content"] == content
+        assert payload["curr_content"] == content
+        popen.assert_has_calls([
+            call(
+                ["git", "show", '{}:{}'.format("previous", filename)],
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+                cwd=os.path.join(self.notebook_dir, top_repo_path)
+            ),
+            call().communicate(),
+            call(
+                ["git", "show", '{}:{}'.format("", filename)],
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+                cwd=os.path.join(self.notebook_dir, top_repo_path)
+            ),
+            call().communicate()
+        ])
+
+    @patch("subprocess.Popen")
+    def test_diffcontent_unknown_special(self, popen):
+        # Given
+        top_repo_path = "path/to/repo"
+        filename = "my/file"
+        content = "dummy content file\nwith multiplelines"
+
+        process_mock = Mock()
+        attrs = {
+            "communicate": Mock(
+                return_value=(
+                    bytes(content, encoding="utf-8"),
+                    b"",
+                )
+            ),
+            "returncode": 0,
+        }
+        process_mock.configure_mock(**attrs)
+        popen.return_value = process_mock
+
+        # When
+        body = {
+            "filename": filename,
+            "prev_ref": {"git": "previous"},
+            "curr_ref": {"special": "unknown"},
+            "top_repo_path" : top_repo_path
+        }
+
+        with assert_http_error(500, msg="unknown special ref"):
+            self.tester.post(["diffcontent"], body=body)
+
+    @patch("subprocess.Popen")
+    def test_diffcontent_show_handled_error(self, popen):
+        # Given
+        top_repo_path = "path/to/repo"
+        filename = "my/file"
+
+        process_mock = Mock()
+        attrs = {
+            "communicate": Mock(
+                return_value=(
+                    b"",
+                    bytes("fatal: Path '{}' does not exist (neither on disk nor in the index)".format(filename), encoding="utf-8"),
+                )
+            ),
+            "returncode": -1,
+        }
+        process_mock.configure_mock(**attrs)
+        popen.return_value = process_mock
+
+        # When
+        body = {
+            "filename": filename,
+            "prev_ref": {"git": "previous"},
+            "curr_ref": {"git": "current"},
+            "top_repo_path" : top_repo_path
+        }
+        response = self.tester.post(["diffcontent"], body=body)
+
+        # Then
+        assert response.status_code == 200
+        payload = response.json()
+        assert payload["prev_content"] == ""
+        assert payload["curr_content"] == ""
+
+    @patch("subprocess.Popen")
+    def test_diffcontent_show_unhandled_error(self, popen):
+        # Given
+        top_repo_path = "path/to/repo"
+        filename = "my/file"
+
+        process_mock = Mock()
+        attrs = {
+            "communicate": Mock(
+                return_value=(
+                    b"",
+                    b"Dummy error",
+                )
+            ),
+            "returncode": -1,
+        }
+        process_mock.configure_mock(**attrs)
+        popen.return_value = process_mock
+
+        # When
+        body = {
+            "filename": filename,
+            "prev_ref": {"git": "previous"},
+            "curr_ref": {"git": "current"},
+            "top_repo_path" : top_repo_path
+        }
+
+        # Then
+        with assert_http_error(500, msg="command to retrieve plaintext diff"):
+            self.tester.post(["diffcontent"], body=body)
+
+    @patch("subprocess.Popen")
+    def test_diffcontent_getcontent_error(self, popen):
+        # Given
+        top_repo_path = "path/to/repo"
+        filename = "my/absent_file"
+        content = "dummy content file\nwith multiplelines"
+
+        process_mock = Mock()
+        attrs = {
+            "communicate": Mock(
+                return_value=(
+                    bytes(content, encoding="utf-8"),
+                    b"",
+                )
+            ),
+            "returncode": 0,
+        }
+        process_mock.configure_mock(**attrs)
+        popen.return_value = process_mock
+
+        # When
+        body = {
+            "filename": filename,
+            "prev_ref": {"git": "previous"},
+            "curr_ref": {"special": "WORKING"},
+            "top_repo_path" : top_repo_path
+        }
+        # Then
+        with assert_http_error(404, msg="No such file or directory"):
+            r = self.tester.post(["diffcontent"], body=body)
+            print(r.json())