Add basic support for customizing windows images

[snf-image-creator] / image_creator / rsync.py

diff --git a/image_creator/rsync.py b/image_creator/rsync.py
index 0c6b639..833d0be 100644 (file)
--- a/image_creator/rsync.py
+++ b/image_creator/rsync.py
@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+#
 # Copyright 2012 GRNET S.A. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or
@@ -31,6 +33,8 @@
 # interpreted as representing official policies, either expressed
 # or implied, of GRNET S.A.
 
+"""This module provides an interface for the rsync utility"""
+
 import subprocess
 import time
 import signal
@@ -41,50 +45,79 @@ from image_creator.util import FatalError
 class Rsync:
     """Wrapper class for the rsync command"""
 
-    def __init__(self, src, dest, exclude=[]):
-        """Create an instance by defining a source, a destinationa and a number
-        of exclude patterns.
-        """
-        self.src = src
-        self.dest = dest
-        self.exclude = exclude
-        self.options = ['-v']
+    def __init__(self, output):
+        """Create an instance """
+        self._out = output
+        self._exclude = []
+        self._options = ['-v']
 
     def archive(self):
         """Enable the archive option"""
-        self.options.append('-a')
+        self._options.append('-a')
+        return self
+
+    def xattrs(self):
+        """Preserve extended attributes"""
+        self._options.append('-X')
+        return self
+
+    def hard_links(self):
+        """Preserve hard links"""
+        self._options.append('-H')
+        return self
+
+    def acls(self):
+        """Preserve ACLs"""
+        self._options.append('-A')
         return self
 
-    def run(self, out):
+    def sparse(self):
+        """Handle sparse files efficiently"""
+        self._options.append('-S')
+        return self
+
+    def exclude(self, pattern):
+        """Add an exclude pattern"""
+        self._exclude.append(pattern)
+        return self
+
+    def reset(self):
+        """Reset all rsync options"""
+        self._exclude = []
+        self._options = ['-v']
+
+    def run(self, src, dest, slabel='source', dlabel='destination'):
         """Run the actual command"""
         cmd = []
         cmd.append('rsync')
-        cmd.extend(self.options)
-        for i in self.exclude:
+        cmd.extend(self._options)
+        for i in self._exclude:
             cmd.extend(['--exclude', i])
 
-        out.output("Calculating total number of host files ...", False)
-        dry_run = subprocess.Popen(cmd + ['-n', self.src, self.dest],
-                                   shell=False, stdout=subprocess.PIPE,
-                                   bufsize=0)
+        self._out.output("Calculating total number of %s files ..." % slabel,
+                         False)
+
+        # If you don't specify a destination, rsync will list the source files.
+        dry_run = subprocess.Popen(cmd + [src], shell=False,
+                                   stdout=subprocess.PIPE, bufsize=0)
         try:
             total = 0
-            for line in iter(dry_run.stdout.readline, b''):
+            for _ in iter(dry_run.stdout.readline, b''):
                 total += 1
         finally:
             dry_run.communicate()
             if dry_run.returncode != 0:
                 raise FatalError("rsync failed")
 
-        out.success("%d" % total)
+        self._out.success("%d" % total)
 
-        progress = out.Progress(total, "Copying files into the image ... ")
-        run = subprocess.Popen(cmd + [self.src, self.dest], shell=False,
+        progress = self._out.Progress(total, "Copying files to %s" % dlabel)
+        run = subprocess.Popen(cmd + [src, dest], shell=False,
                                stdout=subprocess.PIPE, bufsize=0)
         try:
             t = time.time()
             i = 0
-            for line in iter(run.stdout.readline, b''):
+            for _ in iter(run.stdout.readline, b''):
                 i += 1
                 current = time.time()
                 if current - t > 0.1:
@@ -94,12 +127,19 @@ class Rsync:
             progress.success('done')
 
         finally:
-            run.poll()
-            if run.returncode is None:
-                run.send_signal(signal.SIGHUP)
+            def handler(signum, frame):
+                run.terminate()
+                time.sleep(1)
+                run.poll()
+                if run.returncode is None:
+                    run.kill()
+                run.wait()
+
+            signal.signal(signal.SIGALRM, handler)
+            signal.alarm(2)
             run.communicate()
+            signal.alarm(0)
             if run.returncode != 0:
                 raise FatalError("rsync failed")
 
-
 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :