[cedar-backup-svn] SF.net SVN: cedar-backup:[1083] cedar-backup2/trunk

[<pro...@us...>]

Revision: 1083
          http://sourceforge.net/p/cedar-backup/code/1083
Author:   pronovic
Date:     2014-10-07 19:17:12 +0000 (Tue, 07 Oct 2014)
Log Message:
-----------
Start implementing new tool cback-amazons3-sync

Modified Paths:
--------------
    cedar-backup2/trunk/CedarBackup2/tools/__init__.py
    cedar-backup2/trunk/Changelog
    cedar-backup2/trunk/MANIFEST.in
    cedar-backup2/trunk/util/test.py

Added Paths:
-----------
    cedar-backup2/trunk/CedarBackup2/tools/amazons3.py
    cedar-backup2/trunk/doc/cback-amazons3-sync.1
    cedar-backup2/trunk/testcase/synctests.py
    cedar-backup2/trunk/util/cback-amazons3-sync

Modified: cedar-backup2/trunk/CedarBackup2/tools/__init__.py
===================================================================
--- cedar-backup2/trunk/CedarBackup2/tools/__init__.py	2014-10-07 19:15:10 UTC (rev 1082)
+++ cedar-backup2/trunk/CedarBackup2/tools/__init__.py	2014-10-07 19:17:12 UTC (rev 1083)
@@ -45,5 +45,5 @@
 # Using 'from CedarBackup2.tools import *' will just import the modules listed
 # in the __all__ variable.
 
-__all__ = [ 'span', ]
+__all__ = [ 'span', 'amazons3', ]
 

Added: cedar-backup2/trunk/CedarBackup2/tools/amazons3.py
===================================================================
--- cedar-backup2/trunk/CedarBackup2/tools/amazons3.py	                        (rev 0)
+++ cedar-backup2/trunk/CedarBackup2/tools/amazons3.py	2014-10-07 19:17:12 UTC (rev 1083)
@@ -0,0 +1,978 @@
+# -*- coding: iso-8859-1 -*-
+# vim: set ft=python ts=3 sw=3 expandtab:
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#
+#              C E D A R
+#          S O L U T I O N S       "Software done right."
+#           S O F T W A R E
+#
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#
+# Copyright (c) 2014 Kenneth J. Pronovici.
+# All rights reserved.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License,
+# Version 2, as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+#
+# Copies of the GNU General Public License are available from
+# the Free Software Foundation website, http://www.gnu.org/.
+#
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#
+# Author   : Kenneth J. Pronovici <pro...@ie...>
+# Language : Python (>= 2.5)
+# Project  : Cedar Backup, release 2
+# Revision : $Id$
+# Purpose  : Cedar Backup tool to synchronize an Amazon S3 bucket.
+#
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+########################################################################
+# Notes
+########################################################################
+
+"""
+Synchonizes a local directory with an Amazon S3 bucket.
+
+No configuration is required; all necessary information is taken from the
+command-line.  The only thing configuration would help with is the path
+resolver interface, and it doesn't seem worth it to require configuration just
+to get that.
+
+@author: Kenneth J. Pronovici <pro...@ie...>
+"""
+
+########################################################################
+# Imported modules and constants
+########################################################################
+
+# System modules
+import sys
+import os
+import logging
+import getopt
+
+# Cedar Backup modules 
+from CedarBackup2.release import AUTHOR, EMAIL, VERSION, DATE, COPYRIGHT
+from CedarBackup2.cli import setupLogging, DEFAULT_LOGFILE, DEFAULT_OWNERSHIP, DEFAULT_MODE
+from CedarBackup2.util import Diagnostics, splitCommandLine, encodePath
+
+
+########################################################################
+# Module-wide constants and variables
+########################################################################
+
+logger = logging.getLogger("CedarBackup2.log.tools.amazons3")
+
+SHORT_SWITCHES     = "hVbql:o:m:OdsDv"
+LONG_SWITCHES      = [ 'help', 'version', 'verbose', 'quiet', 
+                       'logfile=', 'owner=', 'mode=', 
+                       'output', 'debug', 'stack', 'diagnostics', "verifyOnly", ]
+
+
+#######################################################################
+# Options class
+#######################################################################
+
+class Options(object):
+
+   ######################
+   # Class documentation
+   ######################
+
+   """
+   Class representing command-line options for the cback-amazons3-sync script.
+
+   The C{Options} class is a Python object representation of the command-line
+   options of the cback script.  
+
+   The object representation is two-way: a command line string or a list of
+   command line arguments can be used to create an C{Options} object, and then
+   changes to the object can be propogated back to a list of command-line
+   arguments or to a command-line string.  An C{Options} object can even be
+   created from scratch programmatically (if you have a need for that).
+
+   There are two main levels of validation in the C{Options} class.  The first
+   is field-level validation.  Field-level validation comes into play when a
+   given field in an object is assigned to or updated.  We use Python's
+   C{property} functionality to enforce specific validations on field values,
+   and in some places we even use customized list classes to enforce
+   validations on list members.  You should expect to catch a C{ValueError}
+   exception when making assignments to fields if you are programmatically
+   filling an object.
+
+   The second level of validation is post-completion validation.  Certain
+   validations don't make sense until an object representation of options is
+   fully "complete".  We don't want these validations to apply all of the time,
+   because it would make building up a valid object from scratch a real pain.
+   For instance, we might have to do things in the right order to keep from
+   throwing exceptions, etc.
+
+   All of these post-completion validations are encapsulated in the
+   L{Options.validate} method.  This method can be called at any time by a
+   client, and will always be called immediately after creating a C{Options}
+   object from a command line and before exporting a C{Options} object back to
+   a command line.  This way, we get acceptable ease-of-use but we also don't
+   accept or emit invalid command lines.
+
+   @note: Lists within this class are "unordered" for equality comparisons.
+
+   @sort: __init__, __repr__, __str__, __cmp__
+   """
+
+   ##############
+   # Constructor
+   ##############
+
+   def __init__(self, argumentList=None, argumentString=None, validate=True):
+      """
+      Initializes an options object.
+
+      If you initialize the object without passing either C{argumentList} or
+      C{argumentString}, the object will be empty and will be invalid until it
+      is filled in properly.
+
+      No reference to the original arguments is saved off by this class.  Once
+      the data has been parsed (successfully or not) this original information
+      is discarded.
+
+      The argument list is assumed to be a list of arguments, not including the
+      name of the command, something like C{sys.argv[1:]}.  If you pass
+      C{sys.argv} instead, things are not going to work.
+
+      The argument string will be parsed into an argument list by the
+      L{util.splitCommandLine} function (see the documentation for that
+      function for some important notes about its limitations).  There is an
+      assumption that the resulting list will be equivalent to C{sys.argv[1:]},
+      just like C{argumentList}.
+
+      Unless the C{validate} argument is C{False}, the L{Options.validate}
+      method will be called (with its default arguments) after successfully
+      parsing any passed-in command line.  This validation ensures that
+      appropriate actions, etc. have been specified.  Keep in mind that even if
+      C{validate} is C{False}, it might not be possible to parse the passed-in
+      command line, so an exception might still be raised.
+
+      @note: The command line format is specified by the L{_usage} function.
+      Call L{_usage} to see a usage statement for the cback script.
+
+      @note: It is strongly suggested that the C{validate} option always be set
+      to C{True} (the default) unless there is a specific need to read in
+      invalid command line arguments.
+
+      @param argumentList: Command line for a program.
+      @type argumentList: List of arguments, i.e. C{sys.argv}
+
+      @param argumentString: Command line for a program.
+      @type argumentString: String, i.e. "cback --verbose stage store"
+
+      @param validate: Validate the command line after parsing it.
+      @type validate: Boolean true/false.
+
+      @raise getopt.GetoptError: If the command-line arguments could not be parsed.
+      @raise ValueError: If the command-line arguments are invalid.
+      """
+      self._help = False
+      self._version = False
+      self._verbose = False
+      self._quiet = False
+      self._logfile = None
+      self._owner = None
+      self._mode = None
+      self._output = False
+      self._debug = False
+      self._stacktrace = False
+      self._diagnostics = False
+      self._verifyOnly = False
+      self._sourceDir = None
+      self._s3BucketUrl = None
+      if argumentList is not None and argumentString is not None:
+         raise ValueError("Use either argumentList or argumentString, but not both.")
+      if argumentString is not None:
+         argumentList = splitCommandLine(argumentString)
+      if argumentList is not None:
+         self._parseArgumentList(argumentList)
+         if validate:
+            self.validate()
+
+
+   #########################
+   # String representations
+   #########################
+
+   def __repr__(self):
+      """
+      Official string representation for class instance.
+      """
+      return self.buildArgumentString(validate=False)
+
+   def __str__(self):
+      """
+      Informal string representation for class instance.
+      """
+      return self.__repr__()
+
+
+   #############################
+   # Standard comparison method
+   #############################
+
+   def __cmp__(self, other):
+      """
+      Definition of equals operator for this class.
+      Lists within this class are "unordered" for equality comparisons.
+      @param other: Other object to compare to.
+      @return: -1/0/1 depending on whether self is C{<}, C{=} or C{>} other.
+      """
+      if other is None:
+         return 1
+      if self.help != other.help:
+         if self.help < other.help:
+            return -1
+         else:
+            return 1
+      if self.version != other.version:
+         if self.version < other.version:
+            return -1
+         else:
+            return 1
+      if self.verbose != other.verbose:
+         if self.verbose < other.verbose:
+            return -1
+         else:
+            return 1
+      if self.quiet != other.quiet:
+         if self.quiet < other.quiet:
+            return -1
+         else:
+            return 1
+      if self.logfile != other.logfile:
+         if self.logfile < other.logfile:
+            return -1
+         else:
+            return 1
+      if self.owner != other.owner:
+         if self.owner < other.owner:
+            return -1
+         else:
+            return 1
+      if self.mode != other.mode:
+         if self.mode < other.mode:
+            return -1
+         else:
+            return 1
+      if self.output != other.output:
+         if self.output < other.output:
+            return -1
+         else:
+            return 1
+      if self.debug != other.debug:
+         if self.debug < other.debug:
+            return -1
+         else:
+            return 1
+      if self.stacktrace != other.stacktrace:
+         if self.stacktrace < other.stacktrace:
+            return -1
+         else:
+            return 1
+      if self.diagnostics != other.diagnostics:
+         if self.diagnostics < other.diagnostics:
+            return -1
+         else:
+            return 1
+      if self.verifyOnly != other.verifyOnly:
+         if self.verifyOnly < other.verifyOnly:
+            return -1
+         else:
+            return 1
+      if self.sourceDir != other.sourceDir:
+         if self.sourceDir < other.sourceDir:
+            return -1
+         else:
+            return 1
+      if self.s3BucketUrl != other.s3BucketUrl:
+         if self.s3BucketUrl < other.s3BucketUrl:
+            return -1
+         else:
+            return 1
+      return 0
+
+
+   #############
+   # Properties
+   #############
+
+   def _setHelp(self, value):
+      """
+      Property target used to set the help flag.
+      No validations, but we normalize the value to C{True} or C{False}.
+      """
+      if value:
+         self._help = True
+      else:
+         self._help = False
+
+   def _getHelp(self):
+      """
+      Property target used to get the help flag.
+      """
+      return self._help
+
+   def _setVersion(self, value):
+      """
+      Property target used to set the version flag.
+      No validations, but we normalize the value to C{True} or C{False}.
+      """
+      if value:
+         self._version = True
+      else:
+         self._version = False
+
+   def _getVersion(self):
+      """
+      Property target used to get the version flag.
+      """
+      return self._version
+
+   def _setVerbose(self, value):
+      """
+      Property target used to set the verbose flag.
+      No validations, but we normalize the value to C{True} or C{False}.
+      """
+      if value:
+         self._verbose = True
+      else:
+         self._verbose = False
+
+   def _getVerbose(self):
+      """
+      Property target used to get the verbose flag.
+      """
+      return self._verbose
+
+   def _setQuiet(self, value):
+      """
+      Property target used to set the quiet flag.
+      No validations, but we normalize the value to C{True} or C{False}.
+      """
+      if value:
+         self._quiet = True
+      else:
+         self._quiet = False
+
+   def _getQuiet(self):
+      """
+      Property target used to get the quiet flag.
+      """
+      return self._quiet
+
+   def _setLogfile(self, value):
+      """
+      Property target used to set the logfile parameter.
+      @raise ValueError: If the value cannot be encoded properly.
+      """
+      if value is not None:
+         if len(value) < 1:
+            raise ValueError("The logfile parameter must be a non-empty string.") 
+      self._logfile = encodePath(value)
+
+   def _getLogfile(self):
+      """
+      Property target used to get the logfile parameter.
+      """
+      return self._logfile
+
+   def _setOwner(self, value):
+      """
+      Property target used to set the owner parameter.
+      If not C{None}, the owner must be a C{(user,group)} tuple or list.
+      Strings (and inherited children of strings) are explicitly disallowed.
+      The value will be normalized to a tuple.
+      @raise ValueError: If the value is not valid.
+      """
+      if value is None:
+         self._owner = None
+      else:
+         if isinstance(value, str):
+            raise ValueError("Must specify user and group tuple for owner parameter.")
+         if len(value) != 2:
+            raise ValueError("Must specify user and group tuple for owner parameter.")
+         if len(value[0]) < 1 or len(value[1]) < 1:
+            raise ValueError("User and group tuple values must be non-empty strings.")
+         self._owner = (value[0], value[1])
+
+   def _getOwner(self):
+      """
+      Property target used to get the owner parameter.
+      The parameter is a tuple of C{(user, group)}.
+      """
+      return self._owner
+
+   def _setMode(self, value):
+      """
+      Property target used to set the mode parameter.
+      """
+      if value is None:
+         self._mode = None
+      else:
+         try:
+            if isinstance(value, str):
+               value = int(value, 8)
+            else:
+               value = int(value)
+         except TypeError:
+            raise ValueError("Mode must be an octal integer >= 0, i.e. 644.")
+         if value < 0:
+            raise ValueError("Mode must be an octal integer >= 0. i.e. 644.")
+         self._mode = value
+
+   def _getMode(self):
+      """
+      Property target used to get the mode parameter.
+      """
+      return self._mode
+
+   def _setOutput(self, value):
+      """
+      Property target used to set the output flag.
+      No validations, but we normalize the value to C{True} or C{False}.
+      """
+      if value:
+         self._output = True
+      else:
+         self._output = False
+
+   def _getOutput(self):
+      """
+      Property target used to get the output flag.
+      """
+      return self._output
+
+   def _setDebug(self, value):
+      """
+      Property target used to set the debug flag.
+      No validations, but we normalize the value to C{True} or C{False}.
+      """
+      if value:
+         self._debug = True
+      else:
+         self._debug = False
+
+   def _getDebug(self):
+      """
+      Property target used to get the debug flag.
+      """
+      return self._debug
+
+   def _setStacktrace(self, value):
+      """
+      Property target used to set the stacktrace flag.
+      No validations, but we normalize the value to C{True} or C{False}.
+      """
+      if value:
+         self._stacktrace = True
+      else:
+         self._stacktrace = False
+
+   def _getStacktrace(self):
+      """
+      Property target used to get the stacktrace flag.
+      """
+      return self._stacktrace
+
+   def _setDiagnostics(self, value):
+      """
+      Property target used to set the diagnostics flag.
+      No validations, but we normalize the value to C{True} or C{False}.
+      """
+      if value:
+         self._diagnostics = True
+      else:
+         self._diagnostics = False
+
+   def _getDiagnostics(self):
+      """
+      Property target used to get the diagnostics flag.
+      """
+      return self._diagnostics
+
+   def _setVerifyOnly(self, value):
+      """
+      Property target used to set the verifyOnly flag.
+      No validations, but we normalize the value to C{True} or C{False}.
+      """
+      if value:
+         self._verifyOnly = True
+      else:
+         self._verifyOnly = False
+
+   def _getVerifyOnly(self):
+      """
+      Property target used to get the verifyOnly flag.
+      """
+      return self._verifyOnly
+
+   def _setSourceDir(self, value):
+      """
+      Property target used to set the sourceDir parameter.
+      """
+      if value is not None:
+         if len(value) < 1:
+            raise ValueError("The sourceDir parameter must be a non-empty string.")
+      self._sourceDir = value
+
+   def _getSourceDir(self):
+      """
+      Property target used to get the sourceDir parameter.
+      """
+      return self._sourceDir
+
+   def _setS3BucketUrl(self, value):
+      """
+      Property target used to set the s3BucketUrl parameter.
+      """
+      if value is not None:
+         if len(value) < 1:
+            raise ValueError("The s3BucketUrl parameter must be a non-empty string.")
+      self._s3BucketUrl = value
+
+   def _getS3BucketUrl(self):
+      """
+      Property target used to get the s3BucketUrl parameter.
+      """
+      return self._s3BucketUrl
+
+   help = property(_getHelp, _setHelp, None, "Command-line help (C{-h,--help}) flag.")
+   version = property(_getVersion, _setVersion, None, "Command-line version (C{-V,--version}) flag.")
+   verbose = property(_getVerbose, _setVerbose, None, "Command-line verbose (C{-b,--verbose}) flag.")
+   quiet = property(_getQuiet, _setQuiet, None, "Command-line quiet (C{-q,--quiet}) flag.")
+   logfile = property(_getLogfile, _setLogfile, None, "Command-line logfile (C{-l,--logfile}) parameter.")
+   owner = property(_getOwner, _setOwner, None, "Command-line owner (C{-o,--owner}) parameter, as tuple C{(user,group)}.")
+   mode = property(_getMode, _setMode, None, "Command-line mode (C{-m,--mode}) parameter.")
+   output = property(_getOutput, _setOutput, None, "Command-line output (C{-O,--output}) flag.")
+   debug = property(_getDebug, _setDebug, None, "Command-line debug (C{-d,--debug}) flag.")
+   stacktrace = property(_getStacktrace, _setStacktrace, None, "Command-line stacktrace (C{-s,--stack}) flag.")
+   diagnostics = property(_getDiagnostics, _setDiagnostics, None, "Command-line diagnostics (C{-D,--diagnostics}) flag.")
+   verifyOnly = property(_getVerifyOnly, _setVerifyOnly, None, "Command-line verifyOnly (C{-v,--verifyOnly}) flag.")
+   sourceDir = property(_getSourceDir, _setSourceDir, None, "Command-line sourceDir, source of sync.")
+   s3BucketUrl = property(_getS3BucketUrl, _setS3BucketUrl, None, "Command-line s3BucketUrl, target of sync.")
+
+
+   ##################
+   # Utility methods
+   ##################
+
+   def validate(self):
+      """
+      Validates command-line options represented by the object.
+
+      Unless C{--help} or C{--version} are supplied, at least one action must
+      be specified.  Other validations (as for allowed values for particular
+      options) will be taken care of at assignment time by the properties
+      functionality.
+
+      @note: The command line format is specified by the L{_usage} function.
+      Call L{_usage} to see a usage statement for the cback script.
+
+      @raise ValueError: If one of the validations fails.
+      """
+      if not self.help and not self.version and not self.diagnostics:
+         if self.sourceDir is None or self.s3BucketUrl is None:
+            raise ValueError("Source directory and S3 bucket URL are both required.")
+
+   def buildArgumentList(self, validate=True):
+      """
+      Extracts options into a list of command line arguments.
+
+      The original order of the various arguments (if, indeed, the object was
+      initialized with a command-line) is not preserved in this generated
+      argument list.   Besides that, the argument list is normalized to use the
+      long option names (i.e. --version rather than -V).  The resulting list
+      will be suitable for passing back to the constructor in the
+      C{argumentList} parameter.  Unlike L{buildArgumentString}, string
+      arguments are not quoted here, because there is no need for it.  
+
+      Unless the C{validate} parameter is C{False}, the L{Options.validate}
+      method will be called (with its default arguments) against the
+      options before extracting the command line.  If the options are not valid,
+      then an argument list will not be extracted.
+
+      @note: It is strongly suggested that the C{validate} option always be set
+      to C{True} (the default) unless there is a specific need to extract an
+      invalid command line.
+
+      @param validate: Validate the options before extracting the command line.
+      @type validate: Boolean true/false.
+
+      @return: List representation of command-line arguments.
+      @raise ValueError: If options within the object are invalid.
+      """
+      if validate:
+         self.validate()
+      argumentList = []
+      if self._help:
+         argumentList.append("--help")
+      if self.version:
+         argumentList.append("--version")
+      if self.verbose:
+         argumentList.append("--verbose")
+      if self.quiet:
+         argumentList.append("--quiet")
+      if self.logfile is not None:
+         argumentList.append("--logfile")
+         argumentList.append(self.logfile)
+      if self.owner is not None:
+         argumentList.append("--owner")
+         argumentList.append("%s:%s" % (self.owner[0], self.owner[1]))
+      if self.mode is not None:
+         argumentList.append("--mode")
+         argumentList.append("%o" % self.mode)
+      if self.output:
+         argumentList.append("--output")
+      if self.debug:
+         argumentList.append("--debug")
+      if self.stacktrace:
+         argumentList.append("--stack")
+      if self.diagnostics:
+         argumentList.append("--diagnostics")
+      if self.verifyOnly:
+         argumentList.append("--verifyOnly")
+      if self.sourceDir is not None:
+         argumentList.append(self.sourceDir)
+      if self.s3BucketUrl is not None:
+         argumentList.append(self.s3BucketUrl)
+      return argumentList
+
+   def buildArgumentString(self, validate=True):
+      """
+      Extracts options into a string of command-line arguments.
+
+      The original order of the various arguments (if, indeed, the object was
+      initialized with a command-line) is not preserved in this generated
+      argument string.   Besides that, the argument string is normalized to use
+      the long option names (i.e. --version rather than -V) and to quote all
+      string arguments with double quotes (C{"}).  The resulting string will be
+      suitable for passing back to the constructor in the C{argumentString}
+      parameter.
+
+      Unless the C{validate} parameter is C{False}, the L{Options.validate}
+      method will be called (with its default arguments) against the options
+      before extracting the command line.  If the options are not valid, then
+      an argument string will not be extracted.
+
+      @note: It is strongly suggested that the C{validate} option always be set
+      to C{True} (the default) unless there is a specific need to extract an
+      invalid command line.
+
+      @param validate: Validate the options before extracting the command line.
+      @type validate: Boolean true/false.
+
+      @return: String representation of command-line arguments.
+      @raise ValueError: If options within the object are invalid.
+      """
+      if validate:
+         self.validate()
+      argumentString = ""
+      if self._help:
+         argumentString += "--help "
+      if self.version:
+         argumentString += "--version "
+      if self.verbose:
+         argumentString += "--verbose "
+      if self.quiet:
+         argumentString += "--quiet "
+      if self.logfile is not None:
+         argumentString += "--logfile \"%s\" " % self.logfile
+      if self.owner is not None:
+         argumentString += "--owner \"%s:%s\" " % (self.owner[0], self.owner[1])
+      if self.mode is not None:
+         argumentString += "--mode %o " % self.mode
+      if self.output:
+         argumentString += "--output "
+      if self.debug:
+         argumentString += "--debug "
+      if self.stacktrace:
+         argumentString += "--stack "
+      if self.diagnostics:
+         argumentString += "--diagnostics "
+      if self.verifyOnly:
+         argumentString += "--verifyOnly "
+      if self.sourceDir is not None:
+         argumentString +=  "\"%s\" " % self.sourceDir
+      if self.s3BucketUrl is not None:
+         argumentString +=  "\"%s\" " % self.s3BucketUrl
+      return argumentString
+
+   def _parseArgumentList(self, argumentList):
+      """
+      Internal method to parse a list of command-line arguments.
+
+      Most of the validation we do here has to do with whether the arguments
+      can be parsed and whether any values which exist are valid.  We don't do
+      any validation as to whether required elements exist or whether elements
+      exist in the proper combination (instead, that's the job of the
+      L{validate} method).
+   
+      For any of the options which supply parameters, if the option is
+      duplicated with long and short switches (i.e. C{-l} and a C{--logfile})
+      then the long switch is used.  If the same option is duplicated with the
+      same switch (long or short), then the last entry on the command line is
+      used.
+
+      @param argumentList: List of arguments to a command.
+      @type argumentList: List of arguments to a command, i.e. C{sys.argv[1:]}
+
+      @raise ValueError: If the argument list cannot be successfully parsed.
+      """
+      switches = { }
+      opts, remaining = getopt.getopt(argumentList, SHORT_SWITCHES, LONG_SWITCHES)
+      for o, a in opts:  # push the switches into a hash
+         switches[o] = a
+      if switches.has_key("-h") or switches.has_key("--help"):
+         self.help = True
+      if switches.has_key("-V") or switches.has_key("--version"):
+         self.version = True
+      if switches.has_key("-b") or switches.has_key("--verbose"):
+         self.verbose = True
+      if switches.has_key("-q") or switches.has_key("--quiet"):
+         self.quiet = True
+      if switches.has_key("-l"):
+         self.logfile = switches["-l"]
+      if switches.has_key("--logfile"):
+         self.logfile = switches["--logfile"]
+      if switches.has_key("-o"):
+         self.owner = switches["-o"].split(":", 1)
+      if switches.has_key("--owner"):
+         self.owner = switches["--owner"].split(":", 1)
+      if switches.has_key("-m"):
+         self.mode = switches["-m"]
+      if switches.has_key("--mode"):
+         self.mode = switches["--mode"]
+      if switches.has_key("-O") or switches.has_key("--output"):
+         self.output = True
+      if switches.has_key("-d") or switches.has_key("--debug"):
+         self.debug = True
+      if switches.has_key("-s") or switches.has_key("--stack"):
+         self.stacktrace = True
+      if switches.has_key("-D") or switches.has_key("--diagnostics"):
+         self.diagnostics = True
+      if switches.has_key("-v") or switches.has_key("--verifyOnly"):
+         self.verifyOnly = True
+      try:
+         (self.sourceDir, self.s3BucketUrl) = remaining
+      except ValueError:
+         pass
+
+
+#######################################################################
+# Public functions
+#######################################################################
+
+#################
+# cli() function
+#################
+
+def cli():
+   """
+   Implements the command-line interface for the C{cback-amazons3-sync} script.
+
+   Essentially, this is the "main routine" for the cback-amazons3-sync script.  It does
+   all of the argument processing for the script, and then also implements the
+   tool functionality.
+
+   This function looks pretty similiar to C{CedarBackup2.cli.cli()}.  It's not
+   easy to refactor this code to make it reusable and also readable, so I've
+   decided to just live with the duplication.
+
+   A different error code is returned for each type of failure:
+
+      - C{1}: The Python interpreter version is < 2.5
+      - C{2}: Error processing command-line arguments
+      - C{3}: Error configuring logging
+      - C{5}: Backup was interrupted with a CTRL-C or similar
+      - C{6}: Error executing other parts of the script
+
+   @note: This script uses print rather than logging to the INFO level, because
+   it is interactive.  Underlying Cedar Backup functionality uses the logging
+   mechanism exclusively.
+
+   @return: Error code as described above.
+   """
+   try:
+      if map(int, [sys.version_info[0], sys.version_info[1]]) < [2, 5]:
+         sys.stderr.write("Python version 2.5 or greater required.\n")
+         return 1
+   except:
+      # sys.version_info isn't available before 2.0
+      sys.stderr.write("Python version 2.5 or greater required.\n")
+      return 1
+
+   try:
+      options = Options(argumentList=sys.argv[1:])
+   except Exception, e:
+      _usage()
+      sys.stderr.write(" *** Error: %s\n" % e)
+      return 2
+
+   if options.help:
+      _usage()
+      return 0
+   if options.version:
+      _version()
+      return 0
+   if options.diagnostics:
+      _diagnostics()
+      return 0
+
+   try:
+      logfile = setupLogging(options)
+   except Exception, e:
+      sys.stderr.write("Error setting up logging: %s\n" % e)
+      return 3
+
+   logger.info("Cedar Backup Amazon S3 sync run started.")
+   logger.info("Options were [%s]" % options)
+   logger.info("Logfile is [%s]" % logfile)
+
+   if options.stacktrace:
+      _executeAction(options)
+   else:
+      try:
+         _executeAction(options)
+      except KeyboardInterrupt:
+         logger.error("Backup interrupted.")
+         logger.info("Cedar Backup Amazon S3 sync run completed with status 5.")
+         return 5
+      except Exception, e:
+         logger.error("Error executing backup: %s" % e)
+         logger.info("Cedar Backup Amazon S3 sync run completed with status 6.")
+         return 6
+
+   logger.info("Cedar Backup Amazon S3 sync run completed with status 0.")
+   return 0
+
+
+#######################################################################
+# Utility functions
+#######################################################################
+
+####################
+# _usage() function
+####################
+
+def _usage(fd=sys.stderr):
+   """
+   Prints usage information for the cback-amazons3-sync script.
+   @param fd: File descriptor used to print information.
+   @note: The C{fd} is used rather than C{print} to facilitate unit testing.
+   """
+   fd.write("\n")
+   fd.write(" Usage: cback-amazons3-sync [switches] sourceDir s3bucketUrl\n")
+   fd.write("\n")
+   fd.write(" Cedar Backup Amazon S3 sync tool.\n")
+   fd.write("\n")
+   fd.write(" This Cedar Backup utility synchronizes a local directory to an Amazon S3\n")
+   fd.write(" bucket.  After the sync is complete, a validation step is takane.  An\n")
+   fd.write("  error is reported if the contents of the bucket do not match \n")
+   fd.write(" the source directory, or if the indicated size for any file differs.\n")
+   fd.write(" This tool is a wrapper over the AWS CLI command-line tool.\n")
+   fd.write("\n")
+   fd.write(" The following arguments are required:\n")
+   fd.write("\n")
+   fd.write("   sourceDir          The local source directory on disk (must exist)\n")
+   fd.write("   s3BucketUrl        The URL to the target Amazon S3 bucket\n")
+   fd.write("\n")
+   fd.write(" The following switches are accepted:\n")
+   fd.write("\n")
+   fd.write("   -h, --help         Display this usage/help listing\n")
+   fd.write("   -V, --version      Display version information\n")
+   fd.write("   -b, --verbose      Print verbose output as well as logging to disk\n")
+   fd.write("   -q, --quiet        Run quietly (display no output to the screen)\n")
+   fd.write("   -l, --logfile      Path to logfile (default: %s)\n" % DEFAULT_LOGFILE)
+   fd.write("   -o, --owner        Logfile ownership, user:group (default: %s:%s)\n" % (DEFAULT_OWNERSHIP[0], DEFAULT_OWNERSHIP[1]))
+   fd.write("   -m, --mode         Octal logfile permissions mode (default: %o)\n" % DEFAULT_MODE)
+   fd.write("   -O, --output       Record some sub-command (i.e. aws) output to the log\n")
+   fd.write("   -d, --debug        Write debugging information to the log (implies --output)\n")
+   fd.write("   -s, --stack        Dump a Python stack trace instead of swallowing exceptions\n") # exactly 80 characters in width!
+   fd.write("   -D, --diagnostics  Print runtime diagnostics to the screen and exit\n")
+   fd.write("   -v, --verifyOnly   Only verify the S3 bucket contents, do not make changes\n")
+   fd.write("\n")
+   fd.write(" Typical usage would be something like:\n")
+   fd.write("\n")
+   fd.write("   cback-amazons3-sync /home/myuser/subdir s3://example.com-backup/myuser\n")
+   fd.write("\n")
+   fd.write(" This will sync the contents of /home/myuser/subdir into the indiated bucket.\n")
+   fd.write("\n")
+
+
+######################
+# _version() function
+######################
+
+def _version(fd=sys.stdout):
+   """
+   Prints version information for the cback script.
+   @param fd: File descriptor used to print information.
+   @note: The C{fd} is used rather than C{print} to facilitate unit testing.
+   """
+   fd.write("\n")
+   fd.write(" Cedar Backup Amazon S3 sync tool.\n")
+   fd.write(" Included with Cedar Backup version %s, released %s.\n" % (VERSION, DATE))
+   fd.write("\n")
+   fd.write(" Copyright (c) %s %s <%s>.\n" % (COPYRIGHT, AUTHOR, EMAIL))
+   fd.write(" See CREDITS for a list of included code and other contributors.\n")
+   fd.write(" This is free software; there is NO warranty.  See the\n")
+   fd.write(" GNU General Public License version 2 for copying conditions.\n")
+   fd.write("\n")
+   fd.write(" Use the --help option for usage information.\n")
+   fd.write("\n")
+
+
+##########################
+# _diagnostics() function
+##########################
+
+def _diagnostics(fd=sys.stdout):
+   """
+   Prints runtime diagnostics information.
+   @param fd: File descriptor used to print information.
+   @note: The C{fd} is used rather than C{print} to facilitate unit testing.
+   """
+   fd.write("\n")
+   fd.write("Diagnostics:\n")
+   fd.write("\n")
+   Diagnostics().printDiagnostics(fd=fd, prefix="   ")
+   fd.write("\n")
+
+
+############################
+# _executeAction() function
+############################
+
+def _executeAction(options):
+   """
+   Implements the guts of the cback-amazons3-sync tool.
+
+   @param options: Program command-line options.
+   @type options: Options object.
+
+   @raise Exception: Under many generic error conditions
+   """
+   if not os.path.isdir(options.sourceDir):
+      raise Exception("Source directory does not exist on disk.")
+
+
+#########################################################################
+# Main routine
+########################################################################
+
+if __name__ == "__main__":
+   result = cli()
+   sys.exit(result)
+


Property changes on: cedar-backup2/trunk/CedarBackup2/tools/amazons3.py
___________________________________________________________________
Added: svn:executable
## -0,0 +1 ##
+*
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+Id
\ No newline at end of property
Modified: cedar-backup2/trunk/Changelog
===================================================================
--- cedar-backup2/trunk/Changelog	2014-10-07 19:15:10 UTC (rev 1082)
+++ cedar-backup2/trunk/Changelog	2014-10-07 19:17:12 UTC (rev 1083)
@@ -1,5 +1,6 @@
 Version 2.23.4    unreleased
 
+	* Implement a new tool called cback-amazons3-sync.
 	* Add support for missing --diagnostics flag in cback-span script.
 
 Version 2.23.3    03 Oct 2014

Modified: cedar-backup2/trunk/MANIFEST.in
===================================================================
--- cedar-backup2/trunk/MANIFEST.in	2014-10-07 19:15:10 UTC (rev 1082)
+++ cedar-backup2/trunk/MANIFEST.in	2014-10-07 19:17:12 UTC (rev 1083)
@@ -11,6 +11,7 @@
 include CedarBackup2/tools/*.py
 include CedarBackup2/writers/*.py
 include util/cback-span
+include util/cback-amazons3-sync
 include util/test.py
 include util/knapsackdemo.py
 include util/docbook/*
@@ -21,6 +22,7 @@
 include manual/src/images/html/*.png
 include doc/cback.1
 include doc/cback-span.1
+include doc/cback-amazons3-sync.1
 include doc/cback.conf.sample
 include doc/docbook.txt
 include doc/release.txt

Added: cedar-backup2/trunk/doc/cback-amazons3-sync.1
===================================================================
--- cedar-backup2/trunk/doc/cback-amazons3-sync.1	                        (rev 0)
+++ cedar-backup2/trunk/doc/cback-amazons3-sync.1	2014-10-07 19:17:12 UTC (rev 1083)
@@ -0,0 +1,141 @@
+.\" vim: set ft=nroff .\"
+.\" # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+.\" #
+.\" #              C E D A R
+.\" #          S O L U T I O N S       "Software done right."
+.\" #           S O F T W A R E
+.\" #
+.\" # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+.\" #
+.\" # Author   : Kenneth J. Pronovici <pro...@ie...>
+.\" # Language : nroff
+.\" # Project  : Cedar Backup, release 2
+.\" # Revision : $Id: cback-span.1 1011 2010-07-10 23:58:29Z pronovic $
+.\" # Purpose  : Manpage for cback-span script
+.\" #
+.\" # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+.\"
+.TH cback\-amazons3-sync "1" "Oct 2014" "Cedar Backup" "Kenneth J. Pronovici"
+.SH NAME
+cback\-amazons3-sync \- Synchronize a local directory with an Amazon S3 bucket
+.SH SYNOPSIS
+.B cback\-amazons3-sync
+[\fIswitches\fR]
+sourceDir s3BucketUrl
+.SH DESCRIPTION
+.PP
+This is the Cedar Backup Amazon S3 sync tool.  It synchronizes a local
+directory to an Amazon S3 cloud storage bucket.  After the sync is complete, a
+validation step is taken.  An error is reported if the contents of the bucket
+do not match the source directory, or if the indicated size for any file
+differs.
+.PP
+Generally, one can run the cback\-amazons3-sync command with no special
+switches.  This will start it using the default Cedar Backup log file, etc.
+You only need to use the switches if you need to change the default behavior.
+.SH ARGUMENTS
+.TP
+\fBsourceDir\fR
+The source directory on a local disk.
+.TP
+\fBs3BucketUrl\fR
+The URL specifying the location of the Amazon S3 cloud storage bucket
+to synchronize with, like s3://example.com-backup/subdir.
+.SH SWITCHES
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display usage/help listing.
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+Display version information.
+.TP
+\fB\-b\fR, \fB\-\-verbose\fR
+Print verbose output to the screen as well writing to the logfile. When this
+option is enabled, most information that would normally be written to the
+logfile will also be written to the screen.
+.TP
+\fB\-l\fR, \fB\-\-logfile\fR
+Specify the path to an alternate logfile.  The default logfile file is
+/var/log/cback.log.
+.TP
+\fB\-o\fR, \fB\-\-owner\fR
+Specify the ownership of the logfile, in the form user:group.  The default
+ownership is root:adm, to match the Debian standard for most logfiles.  This
+value will only be used when creating a new logfile.  If the logfile already
+exists when the cback script is executed, it will retain its existing ownership
+and mode.  Only user and group names may be used, not numeric uid and gid
+values.
+.TP
+\fB\-m\fR, \fB\-\-mode\fR
+Specify the permissions for the logfile, using the numeric mode as in chmod(1).
+The default mode is 640 (\-rw\-r\-\-\-\-\-).  This value will only be used when
+creating a new logfile.  If the logfile already exists when the cback script is
+executed, it will retain its existing ownership and mode.
+.TP
+\fB\-O\fR, \fB\-\-output\fR
+Record some sub-command output to the logfile. When this option is enabled, all
+output from system commands will be logged. This might be useful for debugging
+or just for reference. 
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+Write debugging information to the logfile. This option produces a high volume
+of output, and would generally only be needed when debugging a problem. This
+option implies the \-\-output option, as well.
+.TP
+\fB\-s\fR, \fB\-\-stack\fR
+Dump a Python stack trace instead of swallowing exceptions.  This forces Cedar
+Backup to dump the entire Python stack trace associated with an error, rather
+than just progating last message it received back up to the user interface.
+Under some circumstances, this is useful information to include along with a
+bug report.
+.TP
+\fB\-D\fR, \fB\-\-diagnostics\fR
+Display runtime diagnostic information and then exit.  This diagnostic
+information is often useful when filing a bug report.
+.SH RETURN VALUES
+.PP
+This command returns 0 (zero) upon normal completion, and several other error
+codes related to particular errors. 
+.TP
+\fB1\fR
+The Python interpreter version is < 2.5.
+.TP
+\fB2\fR
+Error processing command\-line arguments.
+.TP
+\fB3\fR
+Error configuring logging.
+.TP
+\fB5\fR
+Backup was interrupted with a CTRL\-C or similar.
+.TP
+\fB6\fR
+Other error during processing.
+.SH NOTES
+.PP
+This tool is a wrapper over the Amazon AWS CLI interface found in the aws(1)
+command.  
+.PP
+Cedar Backup itself is designed to run as root.  However, this command can be
+run safely as any user that is configured to use the Amazon AWS CLI interface.
+The aws(1) command will be executed by the same user which is executing the
+cback-amazons3-sync.
+.PP
+You must configure the AWS CLI interface to have a valid connection to Amazon
+S3 infrastructure before using this command. For more information about how to
+accomplish this, see the Cedar Backup user guide.
+.SH SEE ALSO
+cback(1)
+.SH FILES
+.TP
+\fI/var/log/cback.log\fR - Default log file
+.SH BUGS
+Report bugs to <support@cedar\-solutions.com>.
+.SH AUTHOR
+Written by Kenneth J. Pronovici <pro...@ie...>.
+.SH COPYRIGHT
+Copyright (c) 2014 Kenneth J. Pronovici.
+.br
+This is free software; see the source for copying conditions.  There is
+NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
+PURPOSE.

Added: cedar-backup2/trunk/testcase/synctests.py
===================================================================
--- cedar-backup2/trunk/testcase/synctests.py	                        (rev 0)
+++ cedar-backup2/trunk/testcase/synctests.py	2014-10-07 19:17:12 UTC (rev 1083)
@@ -0,0 +1,3304 @@
+#!/usr/bin/env python
+# -*- coding: iso-8859-1 -*-
+# vim: set ft=python ts=3 sw=3 expandtab:
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#
+#              C E D A R
+#          S O L U T I O N S       "Software done right."
+#           S O F T W A R E
+#
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#
+# Copyright (c) 2007,2010 Kenneth J. Pronovici.
+# All rights reserved.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License,
+# Version 2, as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+#
+# Copies of the GNU General Public License are available from
+# the Free Software Foundation website, http://www.gnu.org/.
+#
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#
+# Author   : Kenneth J. Pronovici <pro...@ie...>
+# Language : Python (>= 2.5)
+# Project  : Cedar Backup, release 2
+# Revision : $Id$
+# Purpose  : Tests Amazon S3 sync tool functionality.
+#
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+########################################################################
+# Module documentation
+########################################################################
+
+"""
+Unit tests for CedarBackup2/tools/amazons3.py.
+
+Code Coverage
+=============
+
+   This module contains individual tests for the many of the public functions
+   and classes implemented in tools/amazons3.py.  Where possible, we test
+   functions that print output by passing a custom file descriptor.  Sometimes,
+   we only ensure that a function or method runs without failure, and we don't
+   validate what its result is or what it prints out.
+
+Naming Conventions
+==================
+
+   I prefer to avoid large unit tests which validate more than one piece of
+   functionality, and I prefer to avoid using overly descriptive (read: long)
+   test names, as well.  Instead, I use lots of very small tests that each
+   validate one specific thing.  These small tests are then named with an index
+   number, yielding something like C{testAddDir_001} or C{testValidate_010}.
+   Each method has a docstring describing what it's supposed to accomplish.  I
+   feel that this makes it easier to judge how important a given failure is,
+   and also makes it somewhat easier to diagnose and fix individual problems.
+
+Full vs. Reduced Tests
+======================
+
+   All of the tests in this module are considered safe to be run in an average
+   build environment.  There is a no need to use a SYNCTESTS_FULL environment
+   variable to provide a "reduced feature set" test suite as for some of the
+   other test modules.
+
+@author Kenneth J. Pronovici <pro...@ie...>
+"""
+
+
+########################################################################
+# Import modules and do runtime validations
+########################################################################
+
+import unittest
+from getopt import GetoptError
+from CedarBackup2.testutil import failUnlessAssignRaises, captureOutput
+from CedarBackup2.tools.amazons3 import _usage, _version
+from CedarBackup2.tools.amazons3 import Options
+
+
+#######################################################################
+# Test Case Classes
+#######################################################################
+
+######################
+# TestFunctions class
+######################
+
+class TestFunctions(unittest.TestCase):
+
+   """Tests for the public functions."""
+
+   ################
+   # Setup methods
+   ################
+
+   def setUp(self):
+      pass
+
+   def tearDown(self):
+      pass
+
+
+   ########################
+   # Test simple functions
+   ########################
+
+   def testSimpleFuncs_001(self):
+      """
+      Test that the _usage() function runs without errors.
+      We don't care what the output is, and we don't check.
+      """
+      captureOutput(_usage)
+
+   def testSimpleFuncs_002(self):
+      """
+      Test that the _version() function runs without errors.
+      We don't care what the output is, and we don't check.
+      """
+      captureOutput(_version)
+
+
+####################
+# TestOptions class
+####################
+
+class TestOptions(unittest.TestCase):
+
+   """Tests for the Options class."""
+
+   ################
+   # Setup methods
+   ################
+
+   def setUp(self):
+      pass
+
+   def tearDown(self):
+      pass
+
+
+   ##################
+   # Utility methods
+   ##################
+
+   def failUnlessAssignRaises(self, exception, obj, prop, value):
+      """Equivalent of L{failUnlessRaises}, but used for property assignments instead."""
+      failUnlessAssignRaises(self, exception, obj, prop, value)
+
+
+   ############################
+   # Test __repr__ and __str__
+   ############################
+
+   def testStringFuncs_001(self):
+      """
+      Just make sure that the string functions don't have errors (i.e. bad variable names).
+      """
+      obj = Options()
+      obj.__repr__()
+      obj.__str__()
+
+
+   ##################################
+   # Test constructor and attributes
+   ##################################
+
+   def testConstructor_001(self):
+      """
+      Test constructor with no arguments.
+      """
+      options = Options()
+      self.failUnlessEqual(False, options.help)
+      self.failUnlessEqual(False, options.version)
+      self.failUnlessEqual(False, options.verbose)
+      self.failUnlessEqual(False, options.quiet)
+      self.failUnlessEqual(None, options.logfile)
+      self.failUnlessEqual(None, options.owner)
+      self.failUnlessEqual(None, options.mode)
+      self.failUnlessEqual(False, options.output)
+      self.failUnlessEqual(False, options.debug)
+      self.failUnlessEqual(False, options.stacktrace)
+      self.failUnlessEqual(False, options.diagnostics)
+      self.failUnlessEqual(False, options.verifyOnly)
+      self.failUnlessEqual(None, options.sourceDir)
+      self.failUnlessEqual(None, options.s3BucketUrl)
+
+   def testConstructor_002(self):
+      """
+      Test constructor with validate=False, no other arguments.
+      """
+      options = Options(validate=False)
+      self.failUnlessEqual(False, options.help)
+      self.failUnlessEqual(False, options.version)
+      self.failUnlessEqual(False, options.verbose)
+      self.failUnlessEqual(False, options.quiet)
+      self.failUnlessEqual(None, options.logfile)
+      self.failUnlessEqual(None, options.owner)
+      self.failUnlessEqual(None, options.mode)
+      self.failUnlessEqual(False, options.output)
+      self.failUnlessEqual(False, options.debug)
+      self.failUnlessEqual(False, options.stacktrace)
+      self.failUnlessEqual(False, options.diagnostics)
+      self.failUnlessEqual(False, options.verifyOnly)
+      self.failUnlessEqual(None, options.sourceDir)
+      self.failUnlessEqual(None, options.s3BucketUrl)
+
+   def testConstructor_003(self):
+      """
+      Test constructor with argumentList=[], validate=False.
+      """
+      options = Options(argumentList=[], validate=False)
+      self.failUnlessEqual(False, options.help)
+      self.failUnlessEqual(False, options.version)
+      self.failUnlessEqual(False, options.verbose)
+      self.failUnlessEqual(False, options.quiet)
+      self.failUnlessEqual(None, options.logfile)
+      self.failUnlessEqual(None, options.owner)
+      self.failUnlessEqual(None, options.mode)
+      self.failUnlessEqual(False, options.output)
+      self.failUnlessEqual(False, options.debug)
+      self.failUnlessEqual(False, options.stacktrace)
+      self.failUnlessEqual(False, options.diagnostics)
+      self.failUnlessEqual(False, options.verifyOnly)
+      self.failUnlessEqual(None, options.sourceDir)
+      self.failUnlessEqual(None, options.s3BucketUrl)
+
+   def testConstructor_004(self):
+      """
+      Test constructor with argumentString="", validate=False.
+      """
+      options = Options(argumentString="", validate=False)
+      self.failUnlessEqual(False, options.help)
+      self.failUnlessEqual(False, options.version)
+      self.failUnlessEqual(False, options.verbose)
+      self.failUnlessEqual(False, options.quiet)
+      self.failUnlessEqual(None, options.logfile)
+      self.failUnlessEqual(None, options.owner)
+      self.failUnlessEqual(None, options.mode)
+      self.failUnlessEqual(False, options.output)
+      self.failUnlessEqual(False, options.debug)
+      self.failUnlessEqual(False, options.stacktrace)
+      self.failUnlessEqual(False, options.diagnostics)
+      self.failUnlessEqual(False, options.verifyOnly)
+      self.failUnlessEqual(None, options.sourceDir)
+      self.failUnlessEqual(None, options.s3BucketUrl)
+
+   def testConstructor_005(self):
+      """
+      Test constructor with argumentList=["--help", ], validate=False.
+      """
+      options = Options(argumentList=["--help", ], validate=False)
+      self.failUnlessEqual(True, options.help)
+      self.failUnlessEqual(False, options.version)
+      self.failUnlessEqual(False, options.verbose)
+      self.failUnlessEqual(False, options.quiet)
+      self.failUnlessEqual(None, options.logfile)
+      self.failUnlessEqual(None, options.owner)
+      self.failUnlessEqual(None, options.mode)
+      self.failUnlessEqual(False, options.output)
+      self.failUnlessEqual(False, options.debug)
+      self.failUnlessEqual(False, options.stacktrace)
+      self.failUnlessEqual(False, options.diagnostics)
+      self.failUnlessEqual(False, options.verifyOnly)
+      self.failUnlessEqual(None, options.sourceDir)
+      self.failUnlessEqual(None, options.s3BucketUrl)
+
+   def testConstructor_006(self):
+      """
+      Test constructor with argumentString="--help", validate=False.
+      """
+      options = Options(argumentString="--help", validate=False)
+      self.failUnlessEqual(True, options.help)
+      self.failUnlessEqual(False, options.version)
+      self.failUnlessEqual(False, options.verbose)
+      self.failUnlessEqual(False, options.quiet)
+      self.failUnlessEqual(None, options.logfile)
+      self.failUnlessEqual(None, options.owner)
+      self.failUnlessEqual(None, options.mode)
+      self.failUnlessEqual(False, options.output)
+      self.failUnlessEqual(False, options.debug)
+      self.failUnlessEqual(False, options.stacktrace)
+      self.failUnlessEqual(False, options.diagnostics)
+      self.failUnlessEqual(False, options.verifyOnly)
+      self.failUnlessEqual(None, options.sourceDir)
+      self.failUnlessEqual(None, options.s3BucketUrl)
+
+   def testConstructor_007(self):
+      """
+      Test constructor with argumentList=["-h", ], validate=False.
+      """
+      options = Options(argumentList=["-h", ], validate=False)
+      self.failUnlessEqual(True, options.help)
+      self.failUnlessEqual(False, options.version)
+      self.failUnlessEqual(False, options.verbose)
+      self.failUnlessEqual(False, options.quiet)
+      self.failUnlessEqual(None, options.logfile)
+      self.failUnlessEqual(None, options.owner)
+      self.failUnlessEqual(None, options.mode)
+      self.failUnlessEqual(False, options.output)
+      self.failUnlessEqual(False, options.debug)
+      self.failUnlessEqual(False, options.stacktrace)
+      self.failUnlessEqual(False, options.diagnostics)
+      self.failUnlessEqual(False, options.verifyOnly)
+      self.failUnlessEqual(None, options.sourceDir)
+      self.failUnlessEqual(None, options.s3BucketUrl)
+
+   def testConstructor_008(self):
+      """
+      Test constructor with argumentString="-h", validate=False.
+      """
+      options = Options(argumentString="-h", validate=False)
+      self.failUnlessEqual(True, options.help)
+      self.failUnlessEqual(False, options.version)
+      self.failUnlessEqual(False, options.verbose)
+      self.failUnlessEqual(False, options.quiet)
+      self.failUnlessEqual(None, options.logfile)
+      self.failUnlessEqual(None, options.owner)
+      self.failUnlessEqual(None, options.mode)
+      self.failUnlessEqual(False, options.output)
+      self.failUnlessEqual(False, options.debug)
+      self.failUnlessEqual(False, options.stacktrace)
+      self.failUnlessEqual(False, options.diagnostics)
+      self.failUnlessEqual(False, options.verifyOnly)
+      self.failUnlessEqual(None, options.sourceDir)
+      self.failUnlessEqual(None, options.s3BucketUrl)
+
+   def testConstructor_009(self):
+      """
+      Test constructor with argumentList=["--version", ], validate=False.
+      """
+      options = Options(argumentList=["--version", ], validate=False)
+      self.failUnlessEqual(False, options.help)
+      self.failUnlessEqual(True, options.version)
+      self.failUnlessEqual(False, options.verbose)
+      self.failUnlessEqual(False, options.quiet)
+      self.failUnlessEqual(None, options.logfile)
+      self.failUnlessEqual(None, options.owner)
+      self.failUnlessEqual(None, options.mode)
+      self.failUnlessEqual(False, options.output)
+      self.failUnlessEqual(False, options.debug)
+      self.failUnlessEqual(False, options.stacktrace)
+      self.failUnlessEqual(False, options.diagnostics)
+      self.failUnlessEqual(False, options.verifyOnly)
+      self.failUnlessEqual(None, options.sourceDir)
+      self.failUnlessEqual(None, options.s3BucketUrl)
+
+   def testConstructor_010(self):
+      """
+      Test constructor with argumentString="--version", validate=False.
+      """
+      options = Options(argumentString="--version", validate=False)
+      self.failUnlessEqual(False, options.help)
+      self.failUnlessEqual(True, options.version)
+      self.failUnlessEqual(False, options.verbose)
+      self.failUnlessEqual(False, options.quiet)
+      self.failUnlessEqual(None, options.logfile)
+      self.failUnlessEqual(None, options.owner)
+      self.failUnlessEqual(None, options.mode)
+      self.failUnlessEqual(False, options.output)
+      self.failUnlessEqual(False, options.debug)
+      self.failUnlessEqual(False, options.stacktrace)
+      self.failUnlessEqual(False, options.diagnostics)
+      self.failUnlessEqual(False, options.verifyOnly)
+      self.failUnlessEqual(None, options.sourceDir)
+      self.failUnlessEqual(None, options.s3BucketUrl)
+
+   def testConstructor_011(self):
+      """
+      Test constructor with argumentList=["-V", ], validate=False.
+      """
+      options = Options(argumentList=["-V", ], validate=False)
+      self.failUnlessEqual(False, options.help)
+      self.failUnlessEqual(True, options.version)
+      self.failUnlessEqual(False, options.verbose)
+      self.failUnlessEqual(False, options.quiet)
+      self.failUnlessEqual(None, options.logfile)
+      self.failUnlessEqual(None, options.owner)
+      self.failUnlessEqual(None, options.mode)
+      self.failUnlessEqual(False, options.output)
+      self.failUnlessEqual(False, options.debug)
+      self.failUnlessEqual(False, options.stacktrace)
+      self.failUnlessEqual(False, options.diagnostics)
+      self.failUnlessEqual(False, options.verifyOnly)
+      self.failUnlessEqual(None, options.sourceDir)
+      self.failUnlessEqual(None, options.s3BucketUrl)
+
+   def testConstructor_012(self):
+      """
+      Test constructor with argumentStri...
 
[truncated message content]