support for git submodules

README.rst

@@ -80,6 +80,8 @@ format. An example config file with all available options::
     [projectmap]
     projects/foo = new project name
     ^/home/user/projects/bar(\d+)/ = project{0}
+    [git]
+    disable_submodules = false
 
 For commonly used configuration options, see examples in the `FAQ <https://wakatime.com/faq>`_.
 

tests/samples/configs/git-submodules-disabled-using-regex.cfg

@@ -0,0 +1,8 @@
+[settings]
+debug = false
+api_key = 1090a6ae-855f-4be7-b8fb-3edbaf1aa3ec
+[git]
+submodules_disabled =
+  this/path/does/not/exist
+  git/asubmodule
+  that/other/path

tests/samples/configs/git-submodules-disabled.cfg

@@ -0,0 +1,5 @@
+[settings]
+debug = false
+api_key = 1090a6ae-855f-4be7-b8fb-3edbaf1aa3ec
+[git]
+submodules_disabled = true

tests/samples/configs/git-submodules-enabled-using-regex.cfg

@@ -0,0 +1,7 @@
+[settings]
+debug = false
+api_key = 1090a6ae-855f-4be7-b8fb-3edbaf1aa3ec
+[git]
+submodules_disabled =
+  this/path/does/not/exist
+  that/other/path

tests/samples/configs/git-submodules-enabled.cfg

@@ -0,0 +1,5 @@
+[settings]
+debug = false
+api_key = 1090a6ae-855f-4be7-b8fb-3edbaf1aa3ec
+[git]
+submodules_disabled = false

tests/samples/projects/git-with-submodule/asubmodule/dot_git

@@ -0,0 +1 @@
+gitdir: ../.git/modules/asubmodule

tests/samples/projects/git-with-submodule/dot_git/HEAD

@@ -0,0 +1 @@
+ref: refs/heads/master

tests/samples/projects/git-with-submodule/dot_git/config

@@ -0,0 +1,7 @@
+[core]
+	repositoryformatversion = 0
+	filemode = true
+	bare = false
+	logallrefupdates = true
+	ignorecase = true
+	precomposeunicode = true

tests/samples/projects/git-with-submodule/dot_git/modules/asubmodule/HEAD

@@ -0,0 +1 @@
+ref: refs/heads/asubbranch

tests/samples/projects/git-with-submodule/dot_git/modules/asubmodule/config

@@ -0,0 +1,7 @@
+[core]
+	repositoryformatversion = 0
+	filemode = true
+	bare = false
+	logallrefupdates = true
+	ignorecase = true
+	precomposeunicode = true

tests/test_project.py

@@ -291,16 +291,20 @@ class ProjectTestCase(utils.TestCase):
                 with utils.mock.patch('wakatime.projects.subversion.Popen') as mock_popen:
                     stdout = open('tests/samples/output/svn').read()
                     stderr = ''
+
                     class Dynamic(object):
                         def __init__(self):
                             self.called = 0
+
                         def communicate(self):
                             self.called += 1
                             if self.called == 2:
                                 return (stdout, stderr)
+
                         def wait(self):
                             if self.called == 1:
                                 return 0
+
                     mock_popen.return_value = Dynamic()
 
                     execute(args)
@@ -347,6 +351,111 @@ class ProjectTestCase(utils.TestCase):
             self.assertEquals('hg', self.patched['wakatime.offlinequeue.Queue.push'].call_args[0][0]['project'])
             self.assertEquals('default', self.patched['wakatime.offlinequeue.Queue.push'].call_args[0][0]['branch'])
 
+    def test_git_submodule_detected(self):
+        response = Response()
+        response.status_code = 0
+        self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response
+
+        tempdir = tempfile.mkdtemp()
+        shutil.copytree('tests/samples/projects/git-with-submodule', os.path.join(tempdir, 'git'))
+        shutil.move(os.path.join(tempdir, 'git', 'dot_git'), os.path.join(tempdir, 'git', '.git'))
+        shutil.move(os.path.join(tempdir, 'git', 'asubmodule', 'dot_git'), os.path.join(tempdir, 'git', 'asubmodule', '.git'))
+
+        now = u(int(time.time()))
+        entity = os.path.join(tempdir, 'git', 'asubmodule', 'emptyfile.txt')
+        config = 'tests/samples/configs/good_config.cfg'
+
+        args = ['--file', entity, '--config', config, '--time', now]
+
+        execute(args)
+
+        self.assertEquals('asubmodule', self.patched['wakatime.offlinequeue.Queue.push'].call_args[0][0]['project'])
+        self.assertNotIn('asubbranch', self.patched['wakatime.offlinequeue.Queue.push'].call_args[0][0])
+
+    def test_git_submodule_detected_and_enabled_globally(self):
+        response = Response()
+        response.status_code = 0
+        self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response
+
+        tempdir = tempfile.mkdtemp()
+        shutil.copytree('tests/samples/projects/git-with-submodule', os.path.join(tempdir, 'git'))
+        shutil.move(os.path.join(tempdir, 'git', 'dot_git'), os.path.join(tempdir, 'git', '.git'))
+        shutil.move(os.path.join(tempdir, 'git', 'asubmodule', 'dot_git'), os.path.join(tempdir, 'git', 'asubmodule', '.git'))
+
+        now = u(int(time.time()))
+        entity = os.path.join(tempdir, 'git', 'asubmodule', 'emptyfile.txt')
+        config = 'tests/samples/configs/git-submodules-enabled.cfg'
+
+        args = ['--file', entity, '--config', config, '--time', now]
+
+        execute(args)
+
+        self.assertEquals('asubmodule', self.patched['wakatime.offlinequeue.Queue.push'].call_args[0][0]['project'])
+        self.assertNotIn('asubbranch', self.patched['wakatime.offlinequeue.Queue.push'].call_args[0][0])
+
+    def test_git_submodule_detected_but_disabled_globally(self):
+        response = Response()
+        response.status_code = 0
+        self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response
+
+        tempdir = tempfile.mkdtemp()
+        shutil.copytree('tests/samples/projects/git-with-submodule', os.path.join(tempdir, 'git'))
+        shutil.move(os.path.join(tempdir, 'git', 'dot_git'), os.path.join(tempdir, 'git', '.git'))
+        shutil.move(os.path.join(tempdir, 'git', 'asubmodule', 'dot_git'), os.path.join(tempdir, 'git', 'asubmodule', '.git'))
+
+        now = u(int(time.time()))
+        entity = os.path.join(tempdir, 'git', 'asubmodule', 'emptyfile.txt')
+        config = 'tests/samples/configs/git-submodules-disabled.cfg'
+
+        args = ['--file', entity, '--config', config, '--time', now]
+
+        execute(args)
+
+        self.assertEquals('git', self.patched['wakatime.offlinequeue.Queue.push'].call_args[0][0]['project'])
+        self.assertNotIn('master', self.patched['wakatime.offlinequeue.Queue.push'].call_args[0][0])
+
+    def test_git_submodule_detected_but_disabled_using_regex(self):
+        response = Response()
+        response.status_code = 0
+        self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response
+
+        tempdir = tempfile.mkdtemp()
+        shutil.copytree('tests/samples/projects/git-with-submodule', os.path.join(tempdir, 'git'))
+        shutil.move(os.path.join(tempdir, 'git', 'dot_git'), os.path.join(tempdir, 'git', '.git'))
+        shutil.move(os.path.join(tempdir, 'git', 'asubmodule', 'dot_git'), os.path.join(tempdir, 'git', 'asubmodule', '.git'))
+
+        now = u(int(time.time()))
+        entity = os.path.join(tempdir, 'git', 'asubmodule', 'emptyfile.txt')
+        config = 'tests/samples/configs/git-submodules-disabled-using-regex.cfg'
+
+        args = ['--file', entity, '--config', config, '--time', now]
+
+        execute(args)
+
+        self.assertEquals('git', self.patched['wakatime.offlinequeue.Queue.push'].call_args[0][0]['project'])
+        self.assertNotIn('master', self.patched['wakatime.offlinequeue.Queue.push'].call_args[0][0])
+
+    def test_git_submodule_detected_but_enabled_using_regex(self):
+        response = Response()
+        response.status_code = 0
+        self.patched['wakatime.packages.requests.adapters.HTTPAdapter.send'].return_value = response
+
+        tempdir = tempfile.mkdtemp()
+        shutil.copytree('tests/samples/projects/git-with-submodule', os.path.join(tempdir, 'git'))
+        shutil.move(os.path.join(tempdir, 'git', 'dot_git'), os.path.join(tempdir, 'git', '.git'))
+        shutil.move(os.path.join(tempdir, 'git', 'asubmodule', 'dot_git'), os.path.join(tempdir, 'git', 'asubmodule', '.git'))
+
+        now = u(int(time.time()))
+        entity = os.path.join(tempdir, 'git', 'asubmodule', 'emptyfile.txt')
+        config = 'tests/samples/configs/git-submodules-enabled-using-regex.cfg'
+
+        args = ['--file', entity, '--config', config, '--time', now]
+
+        execute(args)
+
+        self.assertEquals('asubmodule', self.patched['wakatime.offlinequeue.Queue.push'].call_args[0][0]['project'])
+        self.assertNotIn('asubbranch', self.patched['wakatime.offlinequeue.Queue.push'].call_args[0][0])
+
     @log_capture()
     def test_project_map(self, logs):
         logging.disable(logging.NOTSET)

wakatime/projects/git.py

@@ -11,6 +11,7 @@
 
 import logging
 import os
+import re
 import sys
 
 from .base import BaseProject
@@ -21,21 +22,19 @@ log = logging.getLogger('WakaTime')
 
 
 class Git(BaseProject):
+    _submodule = None
+    _project_name = None
+    _head_file = None
 
     def process(self):
-        self.configFile = self._find_git_config_file(self.path)
+        return self._find_git_config_file(self.path)
-        return self.configFile is not None
 
     def name(self):
-        base = self._project_base()
+        return u(self._project_name) if self._project_name else None
-        if base:
-            return u(os.path.basename(base))
-        return None  # pragma: nocover
 
     def branch(self):
-        base = self._project_base()
+        head = self._head_file
-        if base:
+        if head:
-            head = os.path.join(self._project_base(), '.git', 'HEAD')
             try:
                 with open(head, 'r', encoding='utf-8') as fh:
                     return self._get_branch_from_head_file(fh.readline())
@@ -49,23 +48,81 @@ class Git(BaseProject):
                 log.traceback(logging.WARNING)
         return u('master')
 
-    def _project_base(self):
-        if self.configFile:
-            return os.path.dirname(os.path.dirname(self.configFile))
-        return None  # pragma: nocover
-
     def _find_git_config_file(self, path):
         path = os.path.realpath(path)
         if os.path.isfile(path):
             path = os.path.split(path)[0]
         if os.path.isfile(os.path.join(path, '.git', 'config')):
-            return os.path.join(path, '.git', 'config')
+            self._project_name = os.path.basename(path)
+            self._head_file = os.path.join(path, '.git', 'HEAD')
+            return True
+        if self._submodules_supported_for_path(path):
+            submodule_path = self._find_path_from_submodule(path)
+            if submodule_path:
+                self._project_name = os.path.basename(path)
+                self._head_file = os.path.join(submodule_path, 'HEAD')
+                return True
         split_path = os.path.split(path)
         if split_path[1] == '':
-            return None
+            return False
         return self._find_git_config_file(split_path[0])
 
     def _get_branch_from_head_file(self, line):
         if u(line.strip()).startswith('ref: '):
             return u(line.strip().rsplit('/', 1)[-1])
         return None
+
+    def _submodules_supported_for_path(self, path):
+        if not self._configs:
+            return True
+
+        disabled = self._configs.get('submodules_disabled')
+        if not disabled:
+            return True
+
+        if disabled.strip().lower() == 'true':
+            return False
+        if disabled.strip().lower() == 'false':
+            return True
+
+        for pattern in disabled.split("\n"):
+            if pattern.strip():
+                try:
+                    compiled = re.compile(pattern, re.IGNORECASE)
+                    if compiled.search(path):
+                        return False
+                except re.error as ex:
+                    log.warning(u('Regex error ({msg}) for disable git submodules pattern: {pattern}').format(
+                        msg=u(ex),
+                        pattern=u(pattern),
+                    ))
+
+        return True
+
+    def _find_path_from_submodule(self, path):
+        link = os.path.join(path, '.git')
+        if not os.path.isfile(link):
+            return None
+
+        try:
+            with open(link, 'r', encoding='utf-8') as fh:
+                return self._get_path_from_submodule_link(path, fh.readline())
+        except UnicodeDecodeError:
+            try:
+                with open(link, 'r', encoding=sys.getfilesystemencoding()) as fh:
+                    return self._get_path_from_submodule_link(path, fh.readline())
+            except:
+                log.traceback(logging.WARNING)
+        except IOError:
+            log.traceback(logging.WARNING)
+
+        return None
+
+    def _get_path_from_submodule_link(self, path, line):
+        if line.startswith('gitdir: '):
+            subpath = line[len('gitdir: '):].strip()
+            if os.path.isfile(os.path.join(path, subpath, 'config')) and \
+                    os.path.isfile(os.path.join(path, subpath, 'HEAD')):
+                return os.path.join(path, subpath)
+
+        return None