Fix oppia#5938: Lint checks will run only for the files changed by th…

…e user (oppia#6033) * Test against upstream * Removed hard-coded upstream * Only checks with upstream/develop * Deleted log file * Added gitpython to third party * Test1 * Removed remote_sha1 * Removed test print statements * Curl instead of pip * Fixed import of git * Fixed import error * Install gitpython requirements * Add gitpython path to system path * Change order of install * Changed order * Add new line * Add gitpython's requirements path in pre_push
quantumferret · Jan 3, 2019 · 52a859f · 52a859f
1 parent abaed1f
commit 52a859f
Show file tree

Hide file tree

Showing 3 changed files with 89 additions and 21 deletions.
diff --git a/scripts/install_third_party.sh b/scripts/install_third_party.sh
@@ -148,6 +148,36 @@ if [ ! -d "$TOOLS_DIR/isort-4.2.15" ]; then
   rm isort-4.2.15.tar.gz
 fi
 
+# Install smmap.
+echo Checking if smmap is installed in third_party
+if [ ! -d "$TOOLS_DIR/smmap-0.9.0" ]; then
+  echo Installing smmap
+  # Note that the URL redirects, so we pass in -L to tell curl to follow the redirect.
+  curl -o smmap-0.9.0.tar.gz -L https://files.pythonhosted.org/packages/bc/aa/b744b3761fff1b10579df996a2d2e87f124ae07b8336e37edc89cc502f86/smmap-0.9.0.tar.gz
+  tar xzf smmap-0.9.0.tar.gz -C $TOOLS_DIR
+  rm smmap-0.9.0.tar.gz
+fi
+
+# Install gitdb.
+echo Checking if gitdb is installed in third_party
+if [ ! -d "$TOOLS_DIR/gitdb-0.6.4" ]; then
+  echo Installing gitdb
+  # Note that the URL redirects, so we pass in -L to tell curl to follow the redirect.
+  curl -o gitdb-0.6.4.tar.gz -L https://files.pythonhosted.org/packages/e3/95/7e5d7261feb46c0539ac5e451be340ddd64d78c5118f2d893b052c76fe8c/gitdb-0.6.4.tar.gz
+  tar xzf gitdb-0.6.4.tar.gz -C $TOOLS_DIR
+  rm gitdb-0.6.4.tar.gz
+fi
+
+# Install GitPython.
+echo Checking if GitPython is installed in third_party
+if [ ! -d "$TOOLS_DIR/GitPython-2.1.11" ]; then
+  echo Installing GitPython
+  # Note that the URL redirects, so we pass in -L to tell curl to follow the redirect.
+  curl -o GitPython-2.1.11.tar.gz -L https://files.pythonhosted.org/packages/4d/e8/98e06d3bc954e3c5b34e2a579ddf26255e762d21eb24fede458eff654c51/GitPython-2.1.11.tar.gz
+  tar xzf GitPython-2.1.11.tar.gz -C $TOOLS_DIR
+  rm GitPython-2.1.11.tar.gz
+fi
+
 # Install pycodestyle.
 echo Checking if pycodestyle is installed in third_party
 if [ ! -d "$TOOLS_DIR/pycodestyle-2.3.1" ]; then

diff --git a/scripts/pre_commit_linter.py b/scripts/pre_commit_linter.py
@@ -293,6 +293,9 @@
     os.path.join(_PARENT_DIR, 'oppia_tools', 'pylint-quotes-0.1.9'),
     os.path.join(_PARENT_DIR, 'oppia_tools', 'selenium-2.53.2'),
     os.path.join(_PARENT_DIR, 'oppia_tools', 'PIL-1.1.7'),
+    os.path.join(_PARENT_DIR, 'oppia_tools', 'smmap-0.9.0'),
+    os.path.join(_PARENT_DIR, 'oppia_tools', 'gitdb-0.6.4'),
+    os.path.join(_PARENT_DIR, 'oppia_tools', 'GitPython-2.1.11'),
     os.path.join('third_party', 'gae-pipeline-1.9.17.0'),
     os.path.join('third_party', 'bleach-1.2.2'),
     os.path.join('third_party', 'beautifulsoup4-4.6.0'),

diff --git a/scripts/pre_push_hook.py b/scripts/pre_push_hook.py
@@ -37,8 +37,24 @@
 import subprocess
 import sys
 
-# pylint: enable=wrong-import-order
 
+# Insert GitPython and its requirements to sys.path so that it can be imported.
+_PARENT_DIR = os.path.abspath(os.path.join(os.getcwd(), os.pardir))
+_PATHS = [
+    os.path.join(_PARENT_DIR, 'oppia_tools', 'smmap-0.9.0'),
+    os.path.join(_PARENT_DIR, 'oppia_tools', 'gitdb-0.6.4'),
+    os.path.join(_PARENT_DIR, 'oppia_tools', 'GitPython-2.1.11'),
+]
+
+for path in _PATHS:
+    sys.path.insert(0, path)
+
+# pylint: disable=wrong-import-position
+
+import git # isort:skip
+
+# pylint: enable=wrong-import-position
+# pylint: enable=wrong-import-order
 
 GitRef = collections.namedtuple(
     'GitRef', ['local_ref', 'local_sha1', 'remote_ref', 'remote_sha1'])
@@ -94,6 +110,34 @@ def _start_subprocess_for_result(cmd):
     return out, err
 
 
+def _get_remote_name():
+    """Get the remote name of the local repository.
+
+    Returns:
+        str. The remote name of the local repository.
+    """
+    remote_name = ''
+    remote_num = 0
+    # Get the current repository.
+    repo = git.Repo(os.getcwd())
+    for remote in repo.remotes:
+        remote_url = list(remote.urls)[0]
+        if remote_url.endswith('oppia/oppia.git'):
+            remote_num += 1
+            remote_name = remote.name
+
+    if not remote_num:
+        print ('Warning: Please set upstream for the lint checks to run '
+               'efficiently. You can learn more about it here -> '
+               'https://git-scm.com/book/en/v2/Git-Branching-Remote-Branches\n')
+        return
+    elif remote_num > 1:
+        print ('Warning: Please keep only one remote branch for oppia:develop '
+               'to run the lint checks efficiently.\n')
+        return
+    return remote_name
+
+
 def _git_diff_name_status(left, right, diff_filter=''):
     """Compare two branches/commits etc with git.
     Parameter:
@@ -174,32 +218,22 @@ def _collect_files_being_pushed(ref_list, remote):
     # Get branch name from e.g. local_ref='refs/heads/lint_hook'.
     branches = [ref.local_ref.split('/')[-1] for ref in ref_heads_only]
     hashes = [ref.local_sha1 for ref in ref_heads_only]
-    remote_hashes = [ref.remote_sha1 for ref in ref_heads_only]
     collected_files = {}
     # Git allows that multiple branches get pushed simultaneously with the "all"
     # flag. Therefore we need to loop over the ref_list provided.
-    for branch, sha1, remote_sha1 in zip(branches, hashes, remote_hashes):
-        # Git reports the following for an empty / non existing branch
-        # sha1: '0000000000000000000000000000000000000000'.
-        if set(remote_sha1) != {'0'}:
+    for branch, sha1 in zip(branches, hashes):
+        # Get the difference to remote/develop.
+        try:
+            modified_files = _compare_to_remote(
+                remote, branch, remote_branch='develop')
+        except ValueError:
+            # Give up, return all files in repo.
             try:
-                modified_files = _compare_to_remote(remote, branch)
+                modified_files = _git_diff_name_status(
+                    GIT_NULL_COMMIT, sha1)
             except ValueError as e:
                 print e.message
                 sys.exit(1)
-        else:
-            # Get the difference to origin/develop instead.
-            try:
-                modified_files = _compare_to_remote(
-                    remote, branch, remote_branch='develop')
-            except ValueError:
-                # Give up, return all files in repo.
-                try:
-                    modified_files = _git_diff_name_status(
-                        GIT_NULL_COMMIT, sha1)
-                except ValueError as e:
-                    print e.message
-                    sys.exit(1)
         files_to_lint = _extract_files_to_lint(modified_files)
         collected_files[branch] = (modified_files, files_to_lint)
 
@@ -274,7 +308,8 @@ def main():
     parser.add_argument('--install', action='store_true', default=False,
                         help='Install pre_push_hook to the .git/hooks dir')
     args = parser.parse_args()
-    remote = args.remote
+    remote = _get_remote_name()
+    remote = remote if remote else args.remote
     if args.install:
         _install_hook()
         sys.exit(0)