Use regex to capture git options

Author: fcollonval

jupyterlab_git/git.py

@@ -1,8 +1,8 @@
 """
 Module for executing git commands, sending results back to the handlers
 """
-import logging
 import os
+import re
 import subprocess
 from subprocess import Popen, PIPE, CalledProcessError
 
@@ -11,10 +11,10 @@
 from tornado.web import HTTPError
 
 
-logger = logging.getLogger(__name__)
-
-
+# Git configuration options exposed through the REST API
 ALLOWED_OPTIONS = ['user.name', 'user.email']
+# Regex pattern to capture (key, value) of Git configuration options
+CONFIG_PATTERN = re.compile(r"(?:^|\n)(\S+)\=")
 
 
 class GitAuthInputWrapper:
@@ -106,18 +106,8 @@ def config(self, top_repo_path, **kwargs):
                 response["message"] = error.decode("utf-8").strip()
             else:
                 raw = output.decode("utf-8").strip()
-                response["options"] = dict()
-                previous_key = None
-                for l in raw.split("\n"):
-                    if l.startswith('"') and previous_key in ALLOWED_OPTIONS:
-                        response["options"][previous_key] += l
-                    elif "=" in l:
-                        key, v = l.split("=", maxsplit=1)
-                        previous_key = key
-                        if key in ALLOWED_OPTIONS:
-                            response["options"][key] = v
-                    else:
-                        logger.debug("[jupyterlab-git] Unable to interpret git option {}.".format(l))
+                s = CONFIG_PATTERN.split(raw)
+                response["options"] = {k:v for k, v in zip(s[1::2], s[2::2]) if k in ALLOWED_OPTIONS}
 
         return response
 

jupyterlab_git/tests/test_config.py

@@ -59,6 +59,11 @@ def test_git_get_config_multiline(self, popen):
                 return_value=(
                     b"user.name=John Snow\n"
                     b"user.email=john.snow@iscoming.com\n"
+                    b'alias.summary=!f() {     printf "Summary of this branch...\n'
+                    b'";     printf "%s\n'
+                    b'" $(git rev-parse --abbrev-ref HEAD);     printf "\n'
+                    b"Most-active files, with churn count\n"
+                    b'"; git churn | head -7;   }; f\n'
                     b'alias.topic-base-branch-name=!f(){     printf "master\n'
                     b'";   };f\n'
                     b'alias.topic-start=!f(){     topic_branch="$1";     git topic-create "$topic_branch";     git topic-push;   };f',
@@ -94,7 +99,10 @@ def test_git_get_config_multiline(self, popen):
         }
 
     @patch("subprocess.Popen")
-    @patch("jupyterlab_git.git.ALLOWED_OPTIONS", ["user.name", "alias.topic-base-branch-name"])
+    @patch(
+        "jupyterlab_git.git.ALLOWED_OPTIONS",
+        ["alias.summary", "alias.topic-base-branch-name"],
+    )
     def test_git_get_config_accepted_multiline(self, popen):
         # Given
         process_mock = Mock()
@@ -103,6 +111,11 @@ def test_git_get_config_accepted_multiline(self, popen):
                 return_value=(
                     b"user.name=John Snow\n"
                     b"user.email=john.snow@iscoming.com\n"
+                    b'alias.summary=!f() {     printf "Summary of this branch...\n'
+                    b'";     printf "%s\n'
+                    b'" $(git rev-parse --abbrev-ref HEAD);     printf "\n'
+                    b"Most-active files, with churn count\n"
+                    b'"; git churn | head -7;   }; f\n'
                     b'alias.topic-base-branch-name=!f(){     printf "master\n'
                     b'";   };f\n'
                     b'alias.topic-start=!f(){     topic_branch="$1";     git topic-create "$topic_branch";     git topic-push;   };f',
@@ -132,8 +145,12 @@ def test_git_get_config_accepted_multiline(self, popen):
         assert payload == {
             "code": 0,
             "options": {
-                "user.name": "John Snow",
-                "alias.topic-base-branch-name": '!f(){     printf "master";   };f',
+                "alias.summary": '!f() {     printf "Summary of this branch...\n'
+                '";     printf "%s\n'
+                '" $(git rev-parse --abbrev-ref HEAD);     printf "\n'
+                "Most-active files, with churn count\n"
+                '"; git churn | head -7;   }; f',
+                "alias.topic-base-branch-name": '!f(){     printf "master\n";   };f',
             },
         }