Git python3 refactor

kupsef · kupsef · commit 91bba13255c0 · 2020-04-30T14:11:48.000+01:00
diff --git a/codespeed/commits/git.py b/codespeed/commits/git.py
@@ -1,37 +1,39 @@
 import datetime
 import logging
 import os
-from string import strip
-from subprocess import Popen, PIPE
 
+from subprocess import Popen, PIPE
 from django.conf import settings
-
 from .exceptions import CommitLogError
 
 logger = logging.getLogger(__name__)
 
 
+def execute_command(cmd, cwd):
+    p = Popen(cmd, stdout=PIPE, stderr=PIPE, cwd=cwd)
+    stdout, stderr = p.communicate()
+    stdout = stdout.decode('utf8') if stdout is not None else stdout
+    stderr = stderr.decode('utf8') if stderr is not None else stderr
+    return (p, stdout, stderr)
+
+
 def updaterepo(project, update=True):
     if os.path.exists(project.working_copy):
         if not update:
             return
 
-        p = Popen(['git', 'pull'], stdout=PIPE, stderr=PIPE,
-                  cwd=project.working_copy)
+        p, _, stderr = execute_command(['git', 'pull'], cwd=project.working_copy)
 
-        stdout, stderr = p.communicate()
         if p.returncode != 0:
             raise CommitLogError("git pull returned %s: %s" % (p.returncode,
                                                                stderr))
         else:
             return [{'error': False}]
     else:
         cmd = ['git', 'clone', project.repo_path, project.repo_name]
-        p = Popen(cmd, stdout=PIPE, stderr=PIPE,
-                  cwd=settings.REPOSITORY_BASE_PATH)
+        p, stdout, stderr = execute_command(cmd, settings.REPOSITORY_BASE_PATH)
         logger.debug('Cloning Git repo {0} for project {1}'.format(
             project.repo_path, project))
-        stdout, stderr = p.communicate()
 
         if p.returncode != 0:
             raise CommitLogError("%s returned %s: %s" % (
@@ -59,32 +61,24 @@ def getlogs(endrev, startrev):
         cmd.append(endrev.commitid)
 
     working_copy = endrev.branch.project.working_copy
-    p = Popen(cmd, stdout=PIPE, stderr=PIPE, cwd=working_copy)
-
-    stdout, stderr = p.communicate()
+    p, stdout, stderr = execute_command(cmd, working_copy)
 
     if p.returncode != 0:
         raise CommitLogError("%s returned %s: %s" % (
                              " ".join(cmd), p.returncode, stderr))
     logs = []
-    for log in filter(None, stdout.split(b'\x1e')):
+    for log in filter(None, stdout.split('\x1e')):
         (short_commit_id, commit_id, date_t, author_name, author_email,
-         subject, body) = map(strip, log.split(b'\x00', 7))
-
-        tag = ""
+            subject, body) = map(lambda s: s.strip(), log.split('\x00', 7))
 
         cmd = ["git", "tag", "--points-at", commit_id]
-        proc = Popen(cmd, stdout=PIPE, stderr=PIPE, cwd=working_copy)
 
         try:
-            stdout, stderr = proc.communicate()
-        except ValueError:
-            stdout = b''
-            stderr = b''
-
-        if proc.returncode == 0:
-            tag = stdout.strip()
+            p, stdout, stderr = execute_command(cmd, working_copy)
+        except Exception:
+            logger.debug('Failed to get tag', exc_info=True)
 
+        tag = stdout.strip() if p.returncode == 0 else ""
         date = datetime.datetime.fromtimestamp(
             int(date_t)).strftime("%Y-%m-%d %H:%M:%S")
 
diff --git a/codespeed/commits/tests/__init__.py b/codespeed/commits/tests/__init__.py
diff --git a/codespeed/commits/tests/test_git.py b/codespeed/commits/tests/test_git.py
@@ -0,0 +1,60 @@
+from datetime import datetime
+from django.test import TestCase, override_settings
+from mock import Mock, patch
+
+from codespeed.commits.git import getlogs
+from codespeed.models import Project, Revision, Branch, Environment
+
+
+@override_settings(ALLOW_ANONYMOUS_POST=True)
+class GitTest(TestCase):
+    def setUp(self):
+        self.env = Environment.objects.create(name='env')
+        self.project = Project.objects.create(name='project',
+                                              repo_path='path',
+                                              repo_type=Project.GIT)
+        self.branch = Branch.objects.create(name='default',
+                                            project_id=self.project.id)
+        self.revision = Revision.objects.create(
+            **{
+               'commitid': 'id1',
+               'date': datetime.now(),
+               'project_id': self.project.id,
+               'branch_id': self.branch.id,
+            }
+        )
+
+    @patch("codespeed.commits.git.Popen")
+    def test_git_output_parsing(self, popen):
+        # given
+        outputs = {
+            "log": b"id\x00long_id\x001583489681\x00author\x00email\x00msg\x00\x1e",
+            "tag": b'tag',
+        }
+
+        def side_effect(cmd, *args, **kwargs):
+            ret = Mock()
+            ret.returncode = 0
+            git_command = cmd[1] if len(cmd) > 0 else None
+            output = outputs.get(git_command, b'')
+            ret.communicate.return_value = (output, b'')
+            return ret
+
+        popen.side_effect = side_effect
+
+        # when
+        # revision doesn't matter here, git commands are mocked
+        logs = getlogs(self.revision, self.revision)
+
+        # then
+        expected = {
+            'date': '2020-03-06 04:14:41',
+            'message': 'msg',
+            'commitid': 'long_id',
+            'author': 'author',
+            'author_email': 'email',
+            'body': '',
+            'short_commit_id': 'id',
+            'tag': 'tag',
+        }
+        self.assertEquals([expected], logs)
