add support for setting the SSH identity per-repo

[git-mirror.git] / git_mirror.py

diff --git a/git_mirror.py b/git_mirror.py
index 9b5b528ce560c307bc0dd46d31713c01272315e9..af963dfe6cd7f19b50df863c5306a83322df1557 100644 (file)
--- a/git_mirror.py
+++ b/git_mirror.py
@@ -1,7 +1,32 @@
-import sys, os, subprocess
+# Copyright (c) 2015, Ralf Jung <post@ralfj.de>
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer. 
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#==============================================================================
+import sys, os, os.path, subprocess
 import configparser, itertools, json, re
 import email.mime.text, email.utils, smtplib
 
+mail_sender = "null@localhost"
+
 class GitCommand:
     def __getattr__(self, name):
         def call(*args, capture_stderr = False, check = True):
@@ -35,20 +60,20 @@ def read_config(fname, defSection = 'DEFAULT'):
         config.read_file(stream)
     return config
 
-def send_mail(subject, text, receivers, sender='post+webhook@ralfj.de', replyTo=None):
-    assert isinstance(receivers, list)
-    if not len(receivers): return # nothing to do
+def send_mail(subject, text, recipients, sender, replyTo = None):
+    assert isinstance(recipients, list)
+    if not len(recipients): return # nothing to do
     # construct content
     msg = email.mime.text.MIMEText(text.encode('UTF-8'), 'plain', 'UTF-8')
     msg['Subject'] = subject
     msg['Date'] = email.utils.formatdate(localtime=True)
     msg['From'] = sender
-    msg['To'] = ', '.join(receivers)
+    msg['To'] = ', '.join(recipients)
     if replyTo is not None:
         msg['Reply-To'] = replyTo
     # put into envelope and send
     s = smtplib.SMTP('localhost')
-    s.sendmail(sender, receivers, msg.as_string())
+    s.sendmail(sender, recipients, msg.as_string())
     s.quit()
 
 def get_github_payload():
@@ -66,6 +91,7 @@ class Repo:
         self.name = name
         self.local = conf['local']
         self.owner = conf['owner'] # email address to notify in case of problems
+        self.deploy_key = conf['deploy-key'] # the SSH ky used for authenticating against remote hosts
         self.mirrors = {} # maps mirrors to their URLs
         mirror_prefix = 'mirror-'
         for name in filter(lambda s: s.startswith(mirror_prefix), conf.keys()):
@@ -73,7 +99,8 @@ class Repo:
             self.mirrors[mirror] = conf[name]
     
     def mail_owner(self, msg):
-        send_mail("git-mirror {0}".format(self.name), msg, [self.owner])
+        global mail_sender
+        send_mail("git-mirror {0}".format(self.name), msg, recipients = [self.owner], sender = mail_sender)
     
     def find_mirror_by_url(self, match_urls):
         for mirror, url in self.mirrors.items():
@@ -81,10 +108,18 @@ class Repo:
                 return mirror
         return None
     
+    def setup_env(self):
+        '''Setup the environment to work with this repository'''
+        os.chdir(self.local)
+        ssh_set_ident = os.path.join(os.path.dirname(__file__), 'ssh-set-ident.conf')
+        os.setenv('GIT_SSH', ssh_set_ident)
+        ssh_ident = os.path.join(os.path.expanduser('~/.ssh'), self.deploy_key)
+        os.setenv('SSH_IDENT', ssh_ident)
+    
     def update_mirrors(self, ref, oldsha, newsha, except_mirrors = [], suppress_stderr = False):
         '''Update the <ref> from <oldsha> to <newsha> on all mirrors. The update must already have happened locally.'''
         assert len(oldsha) == 40 and len(newsha) == 40, "These are not valid SHAs."
-        os.chdir(self.local)
+        self.setup_env()
         # check for a forced update
         is_forced = newsha != git_nullsha and oldsha != git_nullsha and git_is_forced_update(oldsha, newsha)
         # tell all the mirrors
@@ -101,7 +136,7 @@ class Repo:
     
     def update_ref_from_mirror(self, ref, oldsha, newsha, mirror, suppress_stderr = False):
         '''Update the local version of this <ref> to what's currently on the given <mirror>. <oldsha> and <newsha> are checked. Then update all the other mirrors.'''
-        os.chdir(self.local)
+        self.setup_env()
         url = self.mirrors[mirror]
         # first check whether the remote really is at newsha
         remote_state, code = git.ls_remote(url, ref)
@@ -146,8 +181,11 @@ def find_repo_by_directory(repos, dir):
     return None
 
 def load_repos():
+    global mail_sender
     conffile = os.path.join(os.path.dirname(__file__), 'git-mirror.conf')
     conf = read_config(conffile)
+    mail_sender = conf['mail-sender']
+    
     repos = {}
     for name, section in conf.items():
         if name != 'DEFAULT':