integrations: Change Git commit url format.

Author: anssakthi

zulip/integrations/git/post-receive

@@ -7,53 +7,64 @@
 # stdin in the form
 #  <oldrev> <newrev> <refname>
 # For example:
-#  aa453216d1b3e49e7f6f98441fa56946ddcd6a20 68f7abf4e6f922807889f52bc043ecd31b79f814 refs/heads/main
+#  aa453216d1b3e49e7f6f98441fa56946ddcd6a20 68f7abf4e6f922807889f52bc043ecd31b79f814 refs/heads/master
 
+from typing import Text
 import os
-import os.path
-import subprocess
 import sys
+import subprocess
+import os.path
 
 sys.path.insert(0, os.path.dirname(__file__))
 import zulip_git_config as config
 
 VERSION = "0.9"
+EMPTY_SHA = "0000000000000000000000000000000000000000"
+COMMIT_ROW_TEMPLATE = '* {author_name} commited {subject} ([{commit_short_hash}]({commit_url}))\n'
 
 if config.ZULIP_API_PATH is not None:
     sys.path.append(config.ZULIP_API_PATH)
 
 import zulip
-
 client = zulip.Client(
     email=config.ZULIP_USER,
     site=config.ZULIP_SITE,
     api_key=config.ZULIP_API_KEY,
-    client="ZulipGit/" + VERSION,
-)
-
-
-def git_repository_name() -> str:
-    path, name = os.path.split(os.getcwd())
-    if name == ".git":
-        name = os.path.basename(path)
-    return name[: -len(".git")] if name.endswith(".git") else name
+    client="ZulipGit/" + VERSION)
 
+def git_repository_name() -> Text:
+    output = subprocess.check_output(["git", "rev-parse", "--is-bare-repository"])
+    if output.strip() == "true":
+        return os.path.basename(os.getcwd())[:-len(".git")]
+    else:
+        return os.path.basename(os.path.dirname(os.getcwd()))
 
 def git_commit_range(oldrev: str, newrev: str) -> str:
-    log_cmd = ["git", "log", "--reverse", "--pretty=%aE %H %s", f"{oldrev}..{newrev}"]
-    commits = ""
-    for ln in subprocess.check_output(log_cmd, universal_newlines=True).splitlines():
-        author_email, commit_id, subject = ln.split(None, 2)
-        if hasattr(config, "format_commit_message"):
-            commits += config.format_commit_message(author_email, subject, commit_id)
-        else:
-            commits += f"!avatar({author_email}) {subject}\n"
-    return commits
+    remote_repo_cmd = ["git", "config", "--get", "remote.origin.url"]
+    remote_repo_url = subprocess.check_output(remote_repo_cmd).strip().decode("utf-8")
+
+    log_cmd = ["git", "log", "--reverse",
+               "--pretty=%aN%n%H%n%h%n%s", "%s..%s" % (oldrev, newrev)]
+    commits = ''
+    output = subprocess.check_output(log_cmd, universal_newlines=True).splitlines()
+    it = iter(output)
+    for _ in range(len(output)//4):
+        author_name = next(iter(it))
+        commit_hash = next(iter(it))
+        commit_short_hash = next(iter(it))
+        subject = next(iter(it))
+        commits += COMMIT_ROW_TEMPLATE.format(
+            author_name=author_name,
+            commit_short_hash=commit_short_hash,
+            subject=subject,
+            commit_url="{}/commit/{}".format(remote_repo_url, commit_hash)
+        )
 
+    return commits
 
 def send_bot_message(oldrev: str, newrev: str, refname: str) -> None:
-    repo_name = git_repository_name()
-    branch = refname.replace("refs/heads/", "")
+    repo_name   = git_repository_name()
+    branch      = refname.replace('refs/heads/', '')
     destination = config.commit_notice_destination(repo_name, branch, newrev)
     if destination is None:
         # Don't forward the notice anywhere
@@ -62,31 +73,28 @@ def send_bot_message(oldrev: str, newrev: str, refname: str) -> None:
     new_head = newrev[:12]
     old_head = oldrev[:12]
 
-    if (
-        oldrev == "0000000000000000000000000000000000000000"
-        or newrev == "0000000000000000000000000000000000000000"
-    ):
+    if oldrev == EMPTY_SHA or newrev == EMPTY_SHA:
         # New branch pushed or old branch removed
-        added = ""
-        removed = ""
+        added = ''
+        removed = ''
     else:
-        added = git_commit_range(oldrev, newrev)
+        added   = git_commit_range(oldrev, newrev)
         removed = git_commit_range(newrev, oldrev)
 
-    if oldrev == "0000000000000000000000000000000000000000":
-        message = f"`{new_head}` was pushed to new branch `{branch}`"
-    elif newrev == "0000000000000000000000000000000000000000":
-        message = f"branch `{branch}` was removed (was `{old_head}`)"
+    if oldrev == EMPTY_SHA:
+        message = '`%s` was pushed to new branch `%s`' % (new_head, branch)
+    elif newrev == EMPTY_SHA:
+        message = 'branch `%s` was removed (was `%s`)' % (branch, old_head)
     elif removed:
-        message = f"`{new_head}` was pushed to `{branch}`, **REMOVING**:\n\n{removed}"
+        message = '`%s` was pushed to `%s`, **REMOVING**:\n\n%s' % (new_head, branch, removed)
         if added:
-            message += "\n**and adding**:\n\n" + added
-        message += "\n**A HISTORY REWRITE HAS OCCURRED!**"
-        message += "\n@everyone: Please check your local branches to deal with this."
+            message += '\n**and adding**:\n\n' + added
+        message += '\n**A HISTORY REWRITE HAS OCCURRED!**'
+        message += '\n@everyone: Please check your local branches to deal with this.'
     elif added:
-        message = f"`{new_head}` was deployed to `{branch}` with:\n\n{added}"
+        message = '`%s` was deployed to `%s` with:\n\n%s' % (new_head, branch, added)
     else:
-        message = f"`{new_head}` was pushed to `{branch}`... but nothing changed?"
+        message = '`%s` was pushed to `%s`... but nothing changed?' % (new_head, branch)
 
     message_data = {
         "type": "stream",
@@ -96,7 +104,6 @@ def send_bot_message(oldrev: str, newrev: str, refname: str) -> None:
     }
     client.send_message(message_data)
 
-
 for ln in sys.stdin:
     oldrev, newrev, refname = ln.strip().split()
-    send_bot_message(oldrev, newrev, refname)
+    send_bot_message(oldrev, newrev, refname)

zulip/integrations/git/zulip_git_config.py

@@ -1,14 +1,13 @@
 #
-from typing import Dict, Optional
+from typing import Dict, Text, Optional
 
 # Name of the stream to send notifications to, default is "commits"
-STREAM_NAME = "commits"
+STREAM_NAME = 'commits'
 
 # Change these values to configure authentication for the plugin
 ZULIP_USER = "[email protected]"
 ZULIP_API_KEY = "0123456789abcdef0123456789abcdef"
 
-
 # commit_notice_destination() lets you customize where commit notices
 # are sent to with the full power of a Python function.
 #
@@ -20,30 +19,21 @@
 # Returns a dictionary encoding the stream and subject to send the
 # notification to (or None to send no notification).
 #
-# The default code below will send every commit pushed to "main" to
+# The default code below will send every commit pushed to "master" to
 # * stream "commits"
-# * topic "main"
+# * topic "master"
 # And similarly for branch "test-post-receive" (for use when testing).
-def commit_notice_destination(repo: str, branch: str, commit: str) -> Optional[Dict[str, str]]:
-    if branch in ["main", "master", "test-post-receive"]:
-        return dict(stream=STREAM_NAME, subject=f"{branch}")
+def commit_notice_destination(repo: Text, branch: Text, commit: Text) -> Optional[Dict[Text, Text]]:
+    if branch in ["master", "test-post-receive"]:
+        return dict(stream  = STREAM_NAME,
+                    subject = "%s" % (branch,))
 
     # Return None for cases where you don't want a notice sent
     return None
 
-
-# Modify this function to change how commits are displayed; the most
-# common customization is to include a link to the commit in your
-# graphical repository viewer, e.g.
-#
-# return '!avatar(%s) [%s](https://example.com/commits/%s)\n' % (author, subject, commit_id)
-def format_commit_message(author: str, subject: str, commit_id: str) -> str:
-    return f"!avatar({author}) {subject}\n"
-
-
 ## If properly installed, the Zulip API should be in your import
 ## path, but if not, set a custom path below
-ZULIP_API_PATH: Optional[str] = None
+ZULIP_API_PATH = None
 
 # Set this to your Zulip server's API URI
-ZULIP_SITE = "https://zulip.example.com"
+ZULIP_SITE = "https://zulip.example.com"