backup 4.4.1 → 5.0.0.beta.1

data/lib/backup/syncer/rsync/local.rb

@@ -1,15 +1,12 @@
-# encoding: utf-8
-
 module Backup
   module Syncer
     module RSync
       class Local < Base
-
         def perform!
           log!(:started)
 
           create_dest_path!
-          run("#{ rsync_command } #{ paths_to_push } '#{ dest_path }'")
+          run("#{rsync_command} #{paths_to_push} '#{dest_path}'")
 
           log!(:finished)
         end
@@ -24,7 +21,6 @@ module Backup
         def create_dest_path!
           FileUtils.mkdir_p dest_path
         end
-
       end
     end
   end

data/lib/backup/syncer/rsync/pull.rb

@@ -1,17 +1,14 @@
-# encoding: utf-8
-
 module Backup
   module Syncer
     module RSync
       class Pull < Push
-
         def perform!
           log!(:started)
           write_password_file!
 
           create_dest_path!
-          run("#{ rsync_command } #{ host_options }#{ paths_to_pull } " +
-              "'#{ dest_path }'")
+          run("#{rsync_command} #{host_options}#{paths_to_pull} " \
+              "'#{dest_path}'")
 
           log!(:finished)
         ensure
@@ -30,10 +27,10 @@ module Backup
         # Also remove any trailing `/`, since we don't want rsync's
         # "trailing / on source directories" behavior.
         def paths_to_pull
-          sep = mode == :ssh ? ':' : '::'
-          directories.map {|dir|
-            "#{ sep }'#{ dir.sub(/^~\//, '').sub(/\/$/, '') }'"
-          }.join(' ').sub(/^#{ sep }/, '')
+          sep = mode == :ssh ? ":" : "::"
+          directories.map do |dir|
+            "#{sep}'#{dir.sub(/^~\//, "").sub(/\/$/, "")}'"
+          end.join(" ").sub(/^#{ sep }/, "")
         end
 
         # Expand path, since this is local and shell-quoted.
@@ -44,7 +41,6 @@ module Backup
         def create_dest_path!
           FileUtils.mkdir_p dest_path
         end
-
       end
     end
   end

data/lib/backup/syncer/rsync/push.rb

@@ -1,10 +1,7 @@
-# encoding: utf-8
-
 module Backup
   module Syncer
     module RSync
       class Push < Base
-
         ##
         # Mode of operation
         #
@@ -114,8 +111,8 @@ module Backup
           write_password_file!
 
           create_dest_path!
-          run("#{ rsync_command } #{ paths_to_push } " +
-              "#{ host_options }'#{ dest_path }'")
+          run("#{rsync_command} #{paths_to_push} " \
+              "#{host_options}'#{dest_path}'")
 
           log!(:finished)
         ensure
@@ -128,7 +125,7 @@ module Backup
         # Remove any preceeding '~/', since this is on the remote,
         # and remove any trailing `/`.
         def dest_path
-          @dest_path ||= path.sub(/^~\//, '').sub(/\/$/, '')
+          @dest_path ||= path.sub(/^~\//, "").sub(/\/$/, "")
         end
 
         ##
@@ -137,10 +134,10 @@ module Backup
         # call 'mkdir' without the '-p' option. This is only applicable in :ssh
         # mode, and only used if the path would require this.
         def create_dest_path!
-          return unless mode == :ssh && dest_path.index('/').to_i > 0
+          return unless mode == :ssh && dest_path.index("/").to_i > 0
 
-          run "#{ utility(:ssh) } #{ ssh_transport_args } #{ host } " +
-                 %Q["mkdir -p '#{ dest_path }'"]
+          run "#{utility(:ssh)} #{ssh_transport_args} #{host} " +
+            %("mkdir -p '#{dest_path}'")
         end
 
         ##
@@ -148,10 +145,10 @@ module Backup
         # For Pull, this will prepend the first path in #paths_to_pull.
         def host_options
           if mode == :ssh
-            "#{ host }:"
+            "#{host}:"
           else
-            user = "#{ rsync_user }@" if rsync_user
-            "#{ user }#{ host }::"
+            user = "#{rsync_user}@" if rsync_user
+            "#{user}#{host}::"
           end
         end
 
@@ -162,35 +159,35 @@ module Backup
         end
 
         def compress_option
-          compress ? ' --compress' : ''
+          compress ? " --compress" : ""
         end
 
         def password_option
-          return '' if mode == :ssh
+          return "" if mode == :ssh
 
           path = @password_file ? @password_file.path : rsync_password_file
-          path ? " --password-file='#{ File.expand_path(path) }'" : ''
+          path ? " --password-file='#{File.expand_path(path)}'" : ""
         end
 
         def transport_options
           if mode == :rsync_daemon
-            " --port #{ port }"
+            " --port #{port}"
           else
-            %Q[ -e "#{ utility(:ssh) } #{ ssh_transport_args }"]
+            %( -e "#{utility(:ssh)} #{ssh_transport_args}")
           end
         end
 
         def ssh_transport_args
-          args = "-p #{ port } "
-          args << "-l #{ ssh_user } " if ssh_user
-          args << Array(additional_ssh_options).join(' ')
+          args = "-p #{port} "
+          args << "-l #{ssh_user} " if ssh_user
+          args << Array(additional_ssh_options).join(" ")
           args.rstrip
         end
 
         def write_password_file!
           return unless rsync_password && mode != :ssh
 
-          @password_file = Tempfile.new('backup-rsync-password')
+          @password_file = Tempfile.new("backup-rsync-password")
           @password_file.write(rsync_password)
           @password_file.close
         end
@@ -198,7 +195,6 @@ module Backup
         def remove_password_file!
           @password_file.delete if @password_file
         end
-
       end
     end
   end

data/lib/backup/template.rb

@@ -1,10 +1,7 @@
-# encoding: utf-8
-
-require 'erb'
+require "erb"
 
 module Backup
   class Template
-
     # Holds a binding object. Nil if not provided.
     attr_accessor :binding
 
@@ -12,13 +9,12 @@ module Backup
     # 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
+      @binding =
+        if object.is_a?(Binding)
+          object
+        elsif object.is_a?(Hash)
+          Backup::Binder.new(object).get_binding
+        end
     end
 
     ##
@@ -30,10 +26,10 @@ module Backup
     ##
     # 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)
+      ERB.new(file_contents(file), nil, "<>").result(binding)
     end
 
-  private
+    private
 
     ##
     # Reads and returns the contents of the provided file path,
@@ -41,6 +37,5 @@ module Backup
     def file_contents(file)
       File.read(File.join(Backup::TEMPLATE_PATH, file))
     end
-
   end
 end

data/lib/backup/utilities.rb

@@ -1,11 +1,8 @@
-# encoding: utf-8
-
 module Backup
   module Utilities
     class Error < Backup::Error; end
 
-    UTILITY = {}
-    NAMES = %w{
+    UTILITIES_NAMES = %w[
       tar cat split sudo chown hostname
       gzip bzip2
       mongo mongodump mysqldump innobackupex
@@ -15,34 +12,38 @@ module Backup
       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
+    ].freeze
+
+    # @api private
+    class DSL
+      def initialize(utils)
+        @utilities = utils
+      end
+
+      # Helper methods to 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`).
+      UTILITIES_NAMES.each do |util_name|
+        define_method util_name.tr("-", "_") do |raw_path|
+          path = File.expand_path(raw_path)
+
+          unless File.executable?(path)
+            raise Utilities::Error, <<-EOS
+              The path given for '#{util_name}' was not found or not executable.
+              Path was: #{path}
+            EOS
+          end
 
-        ##
-        # Allow users to set the +tar+ distribution if needed. (:gnu or :bsd)
-        def tar_dist(val)
-          Utilities.tar_dist(val)
+          @utilities.utilities[util_name] = path
         end
       end
+
+      # Allow users to set the +tar+ distribution if needed. (:gnu or :bsd)
+      def tar_dist(val)
+        Utilities.tar_dist(val)
+      end
     end
 
     class << self
@@ -102,7 +103,7 @@ module Backup
       # 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)
+        DSL.new(self).instance_eval(&block)
       end
 
       def tar_dist(val)
@@ -112,7 +113,11 @@ module Backup
 
       def gnu_tar?
         return @gnu_tar unless @gnu_tar.nil?
-        @gnu_tar = !!run("#{ utility(:tar) } --version").match(/GNU/)
+        @gnu_tar = !!run("#{utility(:tar)} --version").match(/GNU/)
+      end
+
+      def utilities
+        @utilities ||= {}
       end
 
       private
@@ -122,17 +127,17 @@ module Backup
       # 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?
+        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 }'.
+        utilities[name] ||= `which '#{name}' 2>/dev/null`.chomp
+        raise Error, <<-EOS if utilities[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
+        utilities[name].dup
       end
 
       ##
@@ -140,21 +145,25 @@ module Backup
       # 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'
+        command = command.split(" ")
+        command.shift while command[0].to_s.include?("=")
+        parts << command.shift.split("/")[-1]
+        if parts[0] == "sudo"
+          Logger.warn "The Backup option \"sudo\" is " \
+            "scheduled to be deprecated. If you're using this feature, " \
+            "please see: https://github.com/backup/backup/issues/851"
+
           until command.empty?
             part = command.shift
-            if part.include?('/')
-              parts << part.split('/')[-1]
+            if part.include?("/")
+              parts << part.split("/")[-1]
               break
             else
               parts << part
             end
           end
         end
-        parts.join(' ')
+        parts.join(" ")
       end
 
       ##
@@ -169,43 +178,41 @@ module Backup
       # Returns STDOUT
       def run(command)
         name = command_name(command)
-        Logger.info "Running system utility '#{ name }'..."
+        Logger.info "Running system utility '#{name}'..."
 
         begin
-          out, err = '', ''
-          ps = Open4.popen4(command) do |pid, stdin, stdout, stderr|
+          out = ""
+          err = ""
+          ps = Open4.popen4(command) do |_pid, stdin, stdout, stderr|
             stdin.close
-            out, err = stdout.read.strip, stderr.read.strip
+            out = stdout.read.strip
+            err = stderr.read.strip
           end
         rescue Exception => e
-          raise Error.wrap(e, "Failed to execute '#{ name }'")
+          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
+        unless ps.success?
           raise Error, <<-EOS
-            '#{ name }' failed with exit status: #{ ps.exitstatus }
-            STDOUT Messages: #{ out.empty? ? 'None' : "\n#{ out }" }
-            STDERR Messages: #{ err.empty? ? 'None' : "\n#{ err }" }
+            '#{name}' failed with exit status: #{ps.exitstatus}
+            STDOUT Messages: #{out.empty? ? "None" : "\n#{out}"}
+            STDERR Messages: #{err.empty? ? "None" : "\n#{err}"}
           EOS
         end
+
+        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
+
+        out
       end
 
       def reset!
-        UTILITY.clear
+        utilities.clear
         @gnu_tar = nil
       end
     end
@@ -214,11 +221,17 @@ module Backup
     # 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) }
+        define_method name do |arg|
+          Utilities.send(name, arg)
+        end
         private name
       end
+
       private
-      def gnu_tar?; Utilities.gnu_tar?; end
+
+      def gnu_tar?
+        Utilities.gnu_tar?
+      end
     end
   end
 end