cm-backup 1.0.0

data/lib/backup/template.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'erb'
+
+module Backup
+  class Template
+
+    # Holds a binding object. Nil if not provided.
+    attr_accessor :binding
+
+    ##
+    # Creates a new instance of the Backup::Template class
+    # and optionally takes an argument that can be either a binding object, a Hash or nil
+    def initialize(object = nil)
+      if object.is_a?(Binding)
+        @binding = object
+      elsif object.is_a?(Hash)
+        @binding = Backup::Binder.new(object).get_binding
+      else
+        @binding = nil
+      end
+    end
+
+    ##
+    # Renders the provided file (in the context of the binding if any) to the console
+    def render(file)
+      puts result(file)
+    end
+
+    ##
+    # Returns a String object containing the contents of the file (in the context of the binding if any)
+    def result(file)
+      ERB.new(file_contents(file), nil, '<>').result(binding)
+    end
+
+  private
+
+    ##
+    # Reads and returns the contents of the provided file path,
+    # relative from the Backup::TEMPLATE_PATH
+    def file_contents(file)
+      File.read(File.join(Backup::TEMPLATE_PATH, file))
+    end
+
+  end
+end

data/lib/backup/utilities.rb

@@ -0,0 +1,224 @@
+# encoding: utf-8
+
+module Backup
+  module Utilities
+    class Error < Backup::Error; end
+
+    UTILITY = {}
+    NAMES = %w{
+      tar cat split sudo chown hostname
+      gzip bzip2
+      mongo mongodump mysqldump innobackupex
+      pg_dump pg_dumpall redis-cli riak-admin
+      gpg openssl
+      rsync ssh
+      sendmail exim
+      send_nsca
+      zabbix_sender
+    }
+
+    module DSL
+      class << self
+        ##
+        # Allow users to set the path for all utilities in the .configure block.
+        #
+        # Utility names with dashes ('redis-cli') will be set using method calls
+        # with an underscore ('redis_cli').
+        NAMES.each do |name|
+          define_method name.gsub('-', '_'), lambda {|val|
+            path = File.expand_path(val)
+            unless File.executable?(path)
+              raise Utilities::Error, <<-EOS
+                The path given for '#{ name }' was not found or not executable.
+                Path was: #{ path }
+              EOS
+            end
+            UTILITY[name] = path
+          }
+        end
+
+        ##
+        # Allow users to set the +tar+ distribution if needed. (:gnu or :bsd)
+        def tar_dist(val)
+          Utilities.tar_dist(val)
+        end
+      end
+    end
+
+    class << self
+      ##
+      # Configure the path to system utilities used by Backup.
+      #
+      # Backup will attempt to locate any required system utilities using a
+      # +which+ command call. If a utility can not be found, or you need to
+      # specify an alternate path for a utility, you may do so in your
+      # +config.rb+ file using this method.
+      #
+      # Backup supports both GNU and BSD utilities.
+      # While Backup uses these utilities in a manner compatible with either
+      # version, the +tar+ utility requires some special handling with respect
+      # to +Archive+s. Backup will attempt to detect if the +tar+ command
+      # found (or set here) is GNU or BSD. If for some reason this fails,
+      # this may be set using the +tar_dist+ command shown below.
+      #
+      #   Backup::Utilities.configure do
+      #     # General Utilites
+      #     tar      '/path/to/tar'
+      #     tar_dist :gnu   # or :bsd
+      #     cat      '/path/to/cat'
+      #     split    '/path/to/split'
+      #     sudo     '/path/to/sudo'
+      #     chown    '/path/to/chown'
+      #     hostname '/path/to/hostname'
+      #
+      #     # Compressors
+      #     gzip    '/path/to/gzip'
+      #     bzip2   '/path/to/bzip2'
+      #
+      #     # Database Utilities
+      #     mongo       '/path/to/mongo'
+      #     mongodump   '/path/to/mongodump'
+      #     mysqldump   '/path/to/mysqldump'
+      #     pg_dump     '/path/to/pg_dump'
+      #     pg_dumpall  '/path/to/pg_dumpall'
+      #     redis_cli   '/path/to/redis-cli'
+      #     riak_admin  '/path/to/riak-admin'
+      #
+      #     # Encryptors
+      #     gpg     '/path/to/gpg'
+      #     openssl '/path/to/openssl'
+      #
+      #     # Syncer and Storage
+      #     rsync   '/path/to/rsync'
+      #     ssh     '/path/to/ssh'
+      #
+      #     # Notifiers
+      #     sendmail  '/path/to/sendmail'
+      #     exim      '/path/to/exim'
+      #     send_nsca '/path/to/send_nsca'
+      #     zabbix_sender '/path/to/zabbix_sender'
+      #   end
+      #
+      # These paths may be set using absolute paths, or relative to the
+      # working directory when Backup is run.
+      def configure(&block)
+        DSL.instance_eval(&block)
+      end
+
+      def tar_dist(val)
+        # the acceptance tests need to be able to reset this to nil
+        @gnu_tar = val.nil? ? nil : val == :gnu
+      end
+
+      def gnu_tar?
+        return @gnu_tar unless @gnu_tar.nil?
+        @gnu_tar = !!run("#{ utility(:tar) } --version").match(/GNU/)
+      end
+
+      private
+
+      ##
+      # Returns the full path to the specified utility.
+      # Raises an error if utility can not be found in the system's $PATH
+      def utility(name)
+        name = name.to_s.strip
+        raise Error, 'Utility Name Empty' if name.empty?
+
+        UTILITY[name] ||= %x[which '#{ name }' 2>/dev/null].chomp
+        raise Error, <<-EOS if UTILITY[name].empty?
+          Could not locate '#{ name }'.
+          Make sure the specified utility is installed
+          and available in your system's $PATH, or specify it's location
+          in your 'config.rb' file using Backup::Utilities.configure
+        EOS
+
+        UTILITY[name].dup
+      end
+
+      ##
+      # Returns the name of the command name from the given command line.
+      # This is only used to simplify log messages.
+      def command_name(command)
+        parts = []
+        command = command.split(' ')
+        command.shift while command[0].to_s.include?('=')
+        parts << command.shift.split('/')[-1]
+        if parts[0] == 'sudo'
+          until command.empty?
+            part = command.shift
+            if part.include?('/')
+              parts << part.split('/')[-1]
+              break
+            else
+              parts << part
+            end
+          end
+        end
+        parts.join(' ')
+      end
+
+      ##
+      # Runs a system command
+      #
+      # All messages generated by the command will be logged.
+      # Messages on STDERR will be logged as warnings.
+      #
+      # If the command fails to execute, or returns a non-zero exit status
+      # an Error will be raised.
+      #
+      # Returns STDOUT
+      def run(command)
+        name = command_name(command)
+        Logger.info "Running system utility '#{ name }'..."
+
+        begin
+          out, err = '', ''
+          ps = Open4.popen4(command) do |pid, stdin, stdout, stderr|
+            stdin.close
+            out, err = stdout.read.strip, stderr.read.strip
+          end
+        rescue Exception => e
+          raise Error.wrap(e, "Failed to execute '#{ name }'")
+        end
+
+        if ps.success?
+          unless out.empty?
+            Logger.info(
+              out.lines.map {|line| "#{ name }:STDOUT: #{ line }" }.join
+            )
+          end
+
+          unless err.empty?
+            Logger.warn(
+              err.lines.map {|line| "#{ name }:STDERR: #{ line }" }.join
+            )
+          end
+
+          return out
+        else
+          raise Error, <<-EOS
+            '#{ name }' failed with exit status: #{ ps.exitstatus }
+            STDOUT Messages: #{ out.empty? ? 'None' : "\n#{ out }" }
+            STDERR Messages: #{ err.empty? ? 'None' : "\n#{ err }" }
+          EOS
+        end
+      end
+
+      def reset!
+        UTILITY.clear
+        @gnu_tar = nil
+      end
+    end
+
+    # Allows these utility methods to be included in other classes,
+    # while allowing them to be stubbed in spec_helper for all specs.
+    module Helpers
+      [:utility, :command_name, :run].each do |name|
+        define_method name, lambda {|arg| Utilities.send(name, arg) }
+        private name
+      end
+      private
+      def gnu_tar?; Utilities.gnu_tar?; end
+    end
+  end
+end

data/lib/backup/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module Backup
+  VERSION = '4.4.1'
+end

data/templates/cli/archive

@@ -0,0 +1,28 @@
+  ##
+  # Archive [Archive]
+  #
+  # Adding a file or directory (including sub-directories):
+  #   archive.add "/path/to/a/file.rb"
+  #   archive.add "/path/to/a/directory/"
+  #
+  # Excluding a file or directory (including sub-directories):
+  #   archive.exclude "/path/to/an/excluded_file.rb"
+  #   archive.exclude "/path/to/an/excluded_directory
+  #
+  # By default, relative paths will be relative to the directory
+  # where `backup perform` is executed, and they will be expanded
+  # to the root of the filesystem when added to the archive.
+  #
+  # If a `root` path is set, relative paths will be relative to the
+  # given `root` path and will not be expanded when added to the archive.
+  #
+  #   archive.root '/path/to/archive/root'
+  #
+  archive :my_archive do |archive|
+    # Run the `tar` command using `sudo`
+    # archive.use_sudo
+    archive.add "/path/to/a/file.rb"
+    archive.add "/path/to/a/folder/"
+    archive.exclude "/path/to/a/excluded_file.rb"
+    archive.exclude "/path/to/a/excluded_folder"
+  end

data/templates/cli/compressor/bzip2

@@ -0,0 +1,4 @@
+  ##
+  # Bzip2 [Compressor]
+  #
+  compress_with Bzip2

data/templates/cli/compressor/custom

@@ -0,0 +1,7 @@
+  ##
+  # Custom [Compressor]
+  #
+  compress_with Custom do |compressor|
+    compressor.command   = 'gzip'
+    compressor.extension = '.gz'
+  end

data/templates/cli/compressor/gzip

@@ -0,0 +1,4 @@
+  ##
+  # Gzip [Compressor]
+  #
+  compress_with Gzip

data/templates/cli/config

@@ -0,0 +1,123 @@
+# encoding: utf-8
+
+##
+# Backup v<%= Backup::VERSION.split('.').first %>.x Configuration
+#
+# Documentation: http://backup.github.io/backup
+# Issue Tracker: https://github.com/backup/backup/issues
+
+##
+# Config Options
+#
+# The options here may be overridden on the command line, but the result
+# will depend on the use of --root-path on the command line.
+#
+# If --root-path is used on the command line, then all paths set here
+# will be overridden. If a path (like --tmp-path) is not given along with
+# --root-path, that path will use it's default location _relative to --root-path_.
+#
+# If --root-path is not used on the command line, a path option (like --tmp-path)
+# given on the command line will override the tmp_path set here, but all other
+# paths set here will be used.
+#
+# Note that relative paths given on the command line without --root-path
+# are relative to the current directory. The root_path set here only applies
+# to relative paths set here.
+#
+# ---
+#
+# Sets the root path for all relative paths, including default paths.
+# May be an absolute path, or relative to the current working directory.
+#
+# root_path 'my/root'
+#
+# Sets the path where backups are processed until they're stored.
+# This must have enough free space to hold apx. 2 backups.
+# May be an absolute path, or relative to the current directory or +root_path+.
+#
+# tmp_path  'my/tmp'
+#
+# Sets the path where backup stores persistent information.
+# When Backup's Cycler is used, small YAML files are stored here.
+# May be an absolute path, or relative to the current directory or +root_path+.
+#
+# data_path 'my/data'
+
+##
+# Utilities
+#
+# If you need to use a utility other than the one Backup detects,
+# or a utility can not be found in your $PATH.
+#
+#   Utilities.configure do
+#     tar       '/usr/bin/gnutar'
+#     redis_cli '/opt/redis/redis-cli'
+#   end
+
+##
+# Logging
+#
+# Logging options may be set on the command line, but certain settings
+# may only be configured here.
+#
+#   Logger.configure do
+#     console.quiet     = true            # Same as command line: --quiet
+#     logfile.max_bytes = 2_000_000       # Default: 500_000
+#     syslog.enabled    = true            # Same as command line: --syslog
+#     syslog.ident      = 'my_app_backup' # Default: 'backup'
+#   end
+#
+# Command line options will override those set here.
+# For example, the following would override the example settings above
+# to disable syslog and enable console output.
+#   backup perform --trigger my_backup --no-syslog --no-quiet
+
+##
+# Component Defaults
+#
+# Set default options to be applied to components in all models.
+# Options set within a model will override those set here.
+#
+#   Storage::S3.defaults do |s3|
+#     s3.access_key_id     = "my_access_key_id"
+#     s3.secret_access_key = "my_secret_access_key"
+#   end
+#
+#   Notifier::Mail.defaults do |mail|
+#     mail.from                 = 'sender@email.com'
+#     mail.to                   = 'receiver@email.com'
+#     mail.address              = 'smtp.gmail.com'
+#     mail.port                 = 587
+#     mail.domain               = 'your.host.name'
+#     mail.user_name            = 'sender@email.com'
+#     mail.password             = 'my_password'
+#     mail.authentication       = 'plain'
+#     mail.encryption           = :starttls
+#   end
+
+##
+# Preconfigured Models
+#
+# Create custom models with preconfigured components.
+# Components added within the model definition will
+# +add to+ the preconfigured components.
+#
+#   preconfigure 'MyModel' do
+#     archive :user_pictures do |archive|
+#       archive.add '~/pictures'
+#     end
+#
+#     notify_by Mail do |mail|
+#       mail.to = 'admin@email.com'
+#     end
+#   end
+#
+#   MyModel.new(:john_smith, 'John Smith Backup') do
+#     archive :user_music do |archive|
+#       archive.add '~/music'
+#     end
+#
+#     notify_by Mail do |mail|
+#       mail.to = 'john.smith@email.com'
+#     end
+#   end