Add unit test for _is_binary

Author: fcollonval

jupyterlab_git/git.py

@@ -1004,12 +1004,26 @@ async def _is_binary(self, filename, ref, top_repo_path):
         -   <https://stackoverflow.com/questions/6119956/how-to-determine-if-git-handles-a-file-as-binary-or-as-text/6134127#6134127>
         -   <https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---numstat>
         -   <https://git-scm.com/docs/git-diff#_other_diff_formats>
+
+        Args:
+            filename (str): Filename (relative to the git repository)
+            ref (str): Commit reference or "INDEX" if file is staged
+            top_repo_path (str): Git repository filepath
+
+        Returns:
+            bool: Is file binary?
+        
+        Raises:
+            HTTPError: if git command failed
         """
         if ref == "INDEX":
             command = ["git", "diff", "--numstat", "--cached", "4b825dc642cb6eb9a060e54bf8d69288fbee4904", "--", filename]
         else:
             command = ["git", "diff", "--numstat", "4b825dc642cb6eb9a060e54bf8d69288fbee4904", ref, "--", filename]  # where 4b825... is a magic SHA which represents the empty tree
-        code, output, error = await execute(command, cwd=top_repo_path)
+        # code, output, error = await execute(command, cwd=top_repo_path)
+        r = await execute(command, cwd=top_repo_path)
+        print(r)
+        code, output, error = r
 
         if code != 0:
             err_msg = "fatal: Path '{}' does not exist (neither on disk nor in the index)".format(filename).lower()

jupyterlab_git/tests/test_branch.py

@@ -8,7 +8,7 @@
 # local lib
 from jupyterlab_git.git import Git
 
-from .testutils import FakeContentManager
+from .testutils import FakeContentManager, maybe_future
 
 
 def test_is_remote_branch():
@@ -33,7 +33,7 @@ async def test_get_current_branch_success():
 
     with patch("jupyterlab_git.git.execute") as mock_execute:
         # Given
-        mock_execute.return_value = tornado.gen.maybe_future((0, "feature-foo", ""))
+        mock_execute.return_value = maybe_future((0, "feature-foo", ""))
 
         # When
         actual_response = await (
@@ -59,10 +59,10 @@ async def test_checkout_branch_noref_success():
 
     with patch("jupyterlab_git.git.execute") as mock_execute:
         with patch.object(
-            Git, "_get_branch_reference", return_value=tornado.gen.maybe_future(None)
+            Git, "_get_branch_reference", return_value=maybe_future(None)
         ) as mock__get_branch_reference:
             # Given
-            mock_execute.return_value = tornado.gen.maybe_future(
+            mock_execute.return_value = maybe_future(
                 (rc, stdout_message, stderr_message)
             )
 
@@ -93,10 +93,10 @@ async def test_checkout_branch_noref_failure():
     rc = 1
     with patch("jupyterlab_git.git.execute") as mock_execute:
         with patch.object(
-            Git, "_get_branch_reference", return_value=tornado.gen.maybe_future(None)
+            Git, "_get_branch_reference", return_value=maybe_future(None)
         ) as mock__get_branch_reference:
             # Given
-            mock_execute.return_value = tornado.gen.maybe_future(
+            mock_execute.return_value = maybe_future(
                 (rc, stdout_message, stderr_message)
             )
 
@@ -132,10 +132,10 @@ async def test_checkout_branch_remoteref_success():
         with patch.object(
             Git,
             "_get_branch_reference",
-            return_value=tornado.gen.maybe_future("refs/remotes/remote_branch"),
+            return_value=maybe_future("refs/remotes/remote_branch"),
         ) as mock__get_branch_reference:
             # Given
-            mock_execute.return_value = tornado.gen.maybe_future(
+            mock_execute.return_value = maybe_future(
                 (rc, stdout_message, stderr_message)
             )
 
@@ -169,10 +169,10 @@ async def test_checkout_branch_headsref_failure():
         with patch.object(
             Git,
             "_get_branch_reference",
-            return_value=tornado.gen.maybe_future("refs/heads/local_branch"),
+            return_value=maybe_future("refs/heads/local_branch"),
         ) as mock__get_branch_reference:
             # Given
-            mock_execute.return_value = tornado.gen.maybe_future(
+            mock_execute.return_value = maybe_future(
                 (rc, stdout_message, stderr_message)
             )
 
@@ -206,10 +206,10 @@ async def test_checkout_branch_headsref_success():
         with patch.object(
             Git,
             "_get_branch_reference",
-            return_value=tornado.gen.maybe_future("refs/heads/local_branch"),
+            return_value=maybe_future("refs/heads/local_branch"),
         ):
             # Given
-            mock_execute.return_value = tornado.gen.maybe_future(
+            mock_execute.return_value = maybe_future(
                 (rc, stdout_message, stderr_message)
             )
 
@@ -239,10 +239,10 @@ async def test_checkout_branch_remoteref_failure():
         with patch.object(
             Git,
             "_get_branch_reference",
-            return_value=tornado.gen.maybe_future("refs/remotes/remote_branch"),
+            return_value=maybe_future("refs/remotes/remote_branch"),
         ):
             # Given
-            mock_execute.return_value = tornado.gen.maybe_future(
+            mock_execute.return_value = maybe_future(
                 (rc, stdout_message, stderr_message)
             )
 
@@ -272,7 +272,7 @@ async def test_get_branch_reference_success():
         branch = "test-branch"
         reference = "refs/remotes/origin/test_branch"
 
-        mock_execute.return_value = tornado.gen.maybe_future((0, reference, ""))
+        mock_execute.return_value = maybe_future((0, reference, ""))
 
         # When
         actual_response = await Git(FakeContentManager("/bin"))._get_branch_reference(
@@ -294,7 +294,7 @@ async def test_get_branch_reference_failure():
         branch = "test-branch"
         reference = "test-branch"
         # Given
-        mock_execute.return_value = tornado.gen.maybe_future(
+        mock_execute.return_value = maybe_future(
             (
                 128,
                 reference,
@@ -321,7 +321,7 @@ async def test_get_branch_reference_failure():
 async def test_get_current_branch_failure():
     with patch("jupyterlab_git.git.execute") as mock_execute:
         # Given
-        mock_execute.return_value = tornado.gen.maybe_future(
+        mock_execute.return_value = maybe_future(
             (
                 128,
                 "",
@@ -356,7 +356,7 @@ async def test_get_current_branch_detached_success():
             "  remotes/origin/feature-foo",
             "  remotes/origin/HEAD",
         ]
-        mock_execute.return_value = tornado.gen.maybe_future(
+        mock_execute.return_value = maybe_future(
             (0, "\n".join(process_output), "")
         )
 
@@ -376,7 +376,7 @@ async def test_get_current_branch_detached_success():
 async def test_get_current_branch_detached_failure():
     with patch("jupyterlab_git.git.execute") as mock_execute:
         # Given
-        mock_execute.return_value = tornado.gen.maybe_future(
+        mock_execute.return_value = maybe_future(
             (
                 128,
                 "",
@@ -413,7 +413,7 @@ async def test_get_current_branch_detached_failure():
 async def test_get_upstream_branch_success(branch, upstream):
     with patch("jupyterlab_git.git.execute") as mock_execute:
         # Given
-        mock_execute.return_value = tornado.gen.maybe_future((0, upstream, ""))
+        mock_execute.return_value = maybe_future((0, upstream, ""))
 
         # When
         actual_response = await Git(FakeContentManager("/bin")).get_upstream_branch(
@@ -451,7 +451,7 @@ async def test_get_upstream_branch_success(branch, upstream):
 async def test_get_upstream_branch_failure(outputs, message):
     with patch("jupyterlab_git.git.execute") as mock_execute:
         # Given
-        mock_execute.return_value = tornado.gen.maybe_future(outputs)
+        mock_execute.return_value = maybe_future(outputs)
 
         # When
         if message:
@@ -482,7 +482,7 @@ async def test_get_upstream_branch_failure(outputs, message):
 async def test_get_tag_success():
     with patch("jupyterlab_git.git.execute") as mock_execute:
         # Given
-        mock_execute.return_value = tornado.gen.maybe_future((0, "v0.3.0", ""))
+        mock_execute.return_value = maybe_future((0, "v0.3.0", ""))
 
         # When
         actual_response = await Git(FakeContentManager("/bin"))._get_tag(
@@ -503,8 +503,8 @@ async def test_get_tag_failure():
     with patch("jupyterlab_git.git.execute") as mock_execute:
         # Given
         mock_execute.side_effect = [
-            tornado.gen.maybe_future((128, "", "fatal: Not a valid object name blah")),
-            tornado.gen.maybe_future(
+            maybe_future((128, "", "fatal: Not a valid object name blah")),
+            maybe_future(
                 (
                     128,
                     "",
@@ -557,7 +557,7 @@ async def test_get_tag_failure():
 async def test_no_tags():
     with patch("jupyterlab_git.git.execute") as mock_execute:
         # Given
-        mock_execute.return_value = tornado.gen.maybe_future(
+        mock_execute.return_value = maybe_future(
             (128, "", "fatal: No names found, cannot describe anything.\n")
         )
 
@@ -590,9 +590,9 @@ async def test_branch_success():
 
         mock_execute.side_effect = [
             # Response for get all refs/heads
-            tornado.gen.maybe_future((0, "\n".join(process_output_heads), "")),
+            maybe_future((0, "\n".join(process_output_heads), "")),
             # Response for get all refs/remotes
-            tornado.gen.maybe_future((0, "\n".join(process_output_remotes), "")),
+            maybe_future((0, "\n".join(process_output_remotes), "")),
         ]
 
         expected_response = {
@@ -694,7 +694,7 @@ async def test_branch_failure():
             "--format=%(refname:short)%09%(objectname)%09%(upstream:short)%09%(HEAD)",
             "refs/heads/",
         ]
-        mock_execute.return_value = tornado.gen.maybe_future(
+        mock_execute.return_value = maybe_future(
             (
                 128,
                 "",
@@ -738,15 +738,15 @@ async def test_branch_success_detached_head():
 
         mock_execute.side_effect = [
             # Response for get all refs/heads
-            tornado.gen.maybe_future((0, "\n".join(process_output_heads), "")),
+            maybe_future((0, "\n".join(process_output_heads), "")),
             # Response for get current branch
-            tornado.gen.maybe_future(
+            maybe_future(
                 (128, "", "fatal: ref HEAD is not a symbolic ref")
             ),
             # Response for get current branch detached
-            tornado.gen.maybe_future((0, "\n".join(detached_head_output), "")),
+            maybe_future((0, "\n".join(detached_head_output), "")),
             # Response for get all refs/remotes
-            tornado.gen.maybe_future((0, "\n".join(process_output_remotes), "")),
+            maybe_future((0, "\n".join(process_output_remotes), "")),
         ]
 
         expected_response = {

jupyterlab_git/tests/test_clone.py

@@ -6,15 +6,15 @@
 
 from jupyterlab_git.git import Git
 
-from .testutils import FakeContentManager
+from .testutils import FakeContentManager, maybe_future
 
 
 @pytest.mark.asyncio
 async def test_git_clone_success():
     with patch("os.environ", {"TEST": "test"}):
         with patch("jupyterlab_git.git.execute") as mock_execute:
             # Given
-            mock_execute.return_value = tornado.gen.maybe_future((0, "output", "error"))
+            mock_execute.return_value = maybe_future((0, "output", "error"))
 
             # When
             actual_response = await Git(FakeContentManager("/bin")).clone(
@@ -40,7 +40,7 @@ async def test_git_clone_failure_from_git():
     with patch("os.environ", {"TEST": "test"}):
         with patch("jupyterlab_git.git.execute") as mock_execute:
             # Given
-            mock_execute.return_value = tornado.gen.maybe_future(
+            mock_execute.return_value = maybe_future(
                 (128, "test_output", "fatal: Not a git repository")
             )
 
@@ -66,7 +66,7 @@ async def test_git_clone_with_auth_success():
     with patch("os.environ", {"TEST": "test"}):
         with patch("jupyterlab_git.git.execute") as mock_authentication:
             # Given
-            mock_authentication.return_value = tornado.gen.maybe_future((0, "", ""))
+            mock_authentication.return_value = maybe_future((0, "", ""))
 
             # When
             auth = {"username": "asdf", "password": "qwerty"}
@@ -95,7 +95,7 @@ async def test_git_clone_with_auth_wrong_repo_url_failure_from_git():
     with patch("os.environ", {"TEST": "test"}):
         with patch("jupyterlab_git.git.execute") as mock_authentication:
             # Given
-            mock_authentication.return_value = tornado.gen.maybe_future(
+            mock_authentication.return_value = maybe_future(
                 (128, "", "fatal: repository 'ghjkhjkl' does not exist")
             )
 
@@ -129,7 +129,7 @@ async def test_git_clone_with_auth_auth_failure_from_git():
     with patch("os.environ", {"TEST": "test"}):
         with patch("jupyterlab_git.git.execute") as mock_authentication:
             # Given
-            mock_authentication.return_value = tornado.gen.maybe_future(
+            mock_authentication.return_value = maybe_future(
                 (
                     128,
                     "",

jupyterlab_git/tests/test_config.py

@@ -7,14 +7,14 @@
 from jupyterlab_git.git import Git
 from jupyterlab_git.handlers import GitConfigHandler
 
-from .testutils import FakeContentManager, ServerTest
+from .testutils import FakeContentManager, ServerTest, maybe_future
 
 
 class TestConfig(ServerTest):
     @patch("jupyterlab_git.git.execute")
     def test_git_get_config_success(self, mock_execute):
         # Given
-        mock_execute.return_value = tornado.gen.maybe_future(
+        mock_execute.return_value = maybe_future(
             (0, "user.name=John Snow\n[email protected]", "")
         )
 
@@ -52,7 +52,7 @@ def test_git_get_config_multiline(self, mock_execute):
             '";   };f\n'
             'alias.topic-start=!f(){     topic_branch="$1";     git topic-create "$topic_branch";     git topic-push;   };f'
         )
-        mock_execute.return_value = tornado.gen.maybe_future((0, output, ""))
+        mock_execute.return_value = maybe_future((0, output, ""))
 
         # When
         body = {"path": "test_path"}
@@ -92,7 +92,7 @@ def test_git_get_config_accepted_multiline(self, mock_execute):
             '";   };f\n'
             'alias.topic-start=!f(){     topic_branch="$1";     git topic-create "$topic_branch";     git topic-push;   };f'
         )
-        mock_execute.return_value = tornado.gen.maybe_future((0, output, ""))
+        mock_execute.return_value = maybe_future((0, output, ""))
 
         # When
         body = {"path": "test_path"}
@@ -120,7 +120,7 @@ def test_git_get_config_accepted_multiline(self, mock_execute):
     @patch("jupyterlab_git.git.execute")
     def test_git_set_config_success(self, mock_execute):
         # Given
-        mock_execute.return_value = tornado.gen.maybe_future((0, "", ""))
+        mock_execute.return_value = maybe_future((0, "", ""))
 
         # When
         body = {

jupyterlab_git/tests/test_detailed_log.py

@@ -8,7 +8,7 @@
 # local lib
 from jupyterlab_git.git import Git
 
-from .testutils import FakeContentManager
+from .testutils import FakeContentManager, maybe_future
 
 
 @pytest.mark.asyncio
@@ -29,7 +29,7 @@ async def test_detailed_log():
         ]
 
 
-        mock_execute._mock_return_value = tornado.gen.maybe_future(
+        mock_execute._mock_return_value = maybe_future(
             (0, "\x00".join(process_output)+"\x00", "")
         )