From 6478da983e9d7b5d6c5a14025813122cd8867408 Mon Sep 17 00:00:00 2001 From: Luke Faraone Date: Thu, 5 Dec 2013 14:54:17 -0500 Subject: [PATCH] Perforce integration. This is designed to be run as a "change-commit" trigger. See [Perforce's documentation][1] on how to set up a trigger for your platform. [1]: http://www.perforce.com/perforce/r12.1/manuals/cmdref/triggers.html Closes trac #1034. (imported from commit d94fa4e50637ade2847a96eab8c5514de3811c24) --- integrations/perforce/zulip_change-commit.py | 85 +++++++++++++++++++ .../perforce/zulip_perforce_config.py | 63 ++++++++++++++ 2 files changed, 148 insertions(+) create mode 100755 integrations/perforce/zulip_change-commit.py create mode 100644 integrations/perforce/zulip_perforce_config.py diff --git a/integrations/perforce/zulip_change-commit.py b/integrations/perforce/zulip_change-commit.py new file mode 100755 index 0000000..5874645 --- /dev/null +++ b/integrations/perforce/zulip_change-commit.py @@ -0,0 +1,85 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# Copyright © 2012-2013 Zulip, Inc. +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +'''Zulip notification change-commit hook. + +In Perforce, The "change-commit" trigger is fired after a metadata has been +created, files have been transferred, and the changelist comitted to the depot +database. + +This specific trigger expects command-line arguments in the form: + %change% %changeroot% + +For example: + 1234 //depot/security/src/ + +''' + +import os +import sys +import os.path + +import git_p4 + +sys.path.insert(0, os.path.dirname(__file__)) +import zulip_perforce_config as config + +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) + +try: + changelist = int(sys.argv[1]) + changeroot = sys.argv[2] +except IndexError: + print >> sys.stderr, "Wrong number of arguments.\n\n", + print >> sys.stderr, __doc__ + sys.exit(-1) +except ValueError: + print >> sys.stderr, "First argument must be an integer.\n\n", + print >> sys.stderr, __doc__ + sys.exit(-1) + +metadata = git_p4.p4_describe(changelist) + +destination = config.commit_notice_destination(changeroot, changelist) +if destination is None: + # Don't forward the notice anywhere + sys.exit(0) + +message = """**{0}** committed revision @{1} to `{2}`. + +> {3} +""".format(metadata["user"], metadata["change"], changeroot, metadata["desc"]) + +message_data = { + "type": "stream", + "to": destination["stream"], + "subject": destination["subject"], + "content": message, +} +client.send_message(message_data) diff --git a/integrations/perforce/zulip_perforce_config.py b/integrations/perforce/zulip_perforce_config.py new file mode 100644 index 0000000..83e3d02 --- /dev/null +++ b/integrations/perforce/zulip_perforce_config.py @@ -0,0 +1,63 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# Copyright © 2013 Zulip, Inc. +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. + + +# Change these values to configure authentication for the plugin +ZULIP_USER = "p4-bot@example.com" +ZULIP_API_KEY = "0123456789abcdef0123456789abcdef" + +# commit_notice_destination() lets you customize where commit notices +# are sent to with the full power of a Python function. +# +# It takes the following arguments: +# * path = the path to the Perforce depot on the server +# * changelist = the changelist id +# +# Returns a dictionary encoding the stream and topic to send the +# notification to (or None to send no notification). +# +# The default code below will send every commit except for ones in the +# "master-plan" and "secret" subdirectories of //depot/ to: +# * stream "depot_subdirectory-commits" +# * subject "change_root" +def commit_notice_destination(path, changelist): + dirs = path.split('/') + if len(dirs) >= 4 and dirs[3] not in ("*", "..."): + directory = dirs[3] + else: + # No subdirectory, so just use "depot" + directory = dirs[2] + + if directory not in ["evil-master-plan", "my-super-secret-repository"]: + return dict(stream = "%s-commits" % (directory,), + subject = path) + + # Return None for cases where you don't want a notice sent + return None + +## If properly installed, the Zulip API should be in your import +## path, but if not, set a custom path below +ZULIP_API_PATH = None + +# This should not need to change unless you have a custom Zulip subdomain. +ZULIP_SITE = "https://api.zulip.com"