interu-backup 3.0.16

data/lib/backup/archive.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+module Backup
+  class Archive
+    include Backup::CLI
+
+    ##
+    # Stores the name of the archive
+    attr_accessor :name
+
+    ##
+    # Stores an array of different paths/files to store
+    attr_accessor :paths
+
+    ##
+    # Stores an array of different paths/files to exclude
+    attr_accessor :excludes
+
+    ##
+    # Stores the path to the archive directory
+    attr_accessor :archive_path
+
+    ##
+    # Takes the name of the archive and the configuration block
+    def initialize(name, &block)
+      @name         = name.to_sym
+      @paths        = Array.new
+      @excludes     = Array.new
+      @archive_path = File.join(TMP_PATH, TRIGGER, 'archive')
+
+      instance_eval(&block)
+    end
+
+    ##
+    # Adds new paths to the @paths instance variable array
+    def add(path)
+      @paths << path
+    end
+
+    ##
+    # Adds new paths to the @excludes instance variable array
+    def exclude(path)
+      @excludes << path
+    end
+
+    ##
+    # Archives all the provided paths in to a single .tar file
+    # and places that .tar file in the folder which later will be packaged
+    def perform!
+      mkdir(archive_path)
+      Logger.message("#{ self.class } started packaging and archiving #{ paths.map { |path| "\"#{path}\""}.join(", ") }.")
+      run("#{ utility(:tar) } -c -f '#{ File.join(archive_path, "#{name}.tar") }' #{ paths_to_exclude } #{ paths_to_package } 2> /dev/null")
+    end
+
+  private
+
+    ##
+    # Returns a "tar-ready" string of all the specified paths combined
+    def paths_to_package
+      paths.map do |path|
+        "'#{path}'"
+      end.join("\s")
+    end
+
+    ##
+    # Returns a "tar-ready" string of all the specified excludes combined
+    def paths_to_exclude
+      if excludes.any?
+        excludes.map{ |e| "--exclude='#{e}'" }.join(" ")
+      end
+    end
+  end
+end

data/lib/backup/cli.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+
+module Backup
+  module CLI
+
+    ##
+    # Wrapper method for %x[] to run CL commands
+    # through a ruby method. This helps with test coverage and
+    # improves readability.
+    #
+    # It'll first remove all prefixing slashes ( / ) by using .gsub(/^\s+/, '')
+    # This allows for the EOS blocks to be indented without actually using any
+    # prefixing spaces. This cleans up the implementation code.
+    #
+    # Every time the Backup::CLI#run method is invoked, it'll invoke
+    # the Backup::CLI#raise_if_command_not_found method after running the
+    # requested command on the OS.
+    #
+    # Backup::CLI#raise_if_command_not_found takes a single argument, the utility name.
+    # the command.slice(0, command.index(/\s/)).split('/')[-1] line will extract only the utility
+    # name (e.g. mongodump, pgdump, etc) from a command like "/usr/local/bin/mongodump <options>"
+    # and pass that in to the Backup::CLI#raise_if_command_not_found
+    def run(command)
+      command.gsub!(/^\s+/, '')
+      raise_if_command_not_found!(
+        command.slice(0, command.index(/\s/)).split('/')[-1]
+      )
+      %x[#{command}]
+    end
+
+    ##
+    # Wrapper method for FileUtils.mkdir_p to create directories
+    # through a ruby method. This helps with test coverage and
+    # improves readability
+    def mkdir(path)
+      FileUtils.mkdir_p(path)
+    end
+
+    ##
+    # Wrapper for the FileUtils.rm_rf to remove files and folders
+    # through a ruby method. This helps with test coverage and
+    # improves readability
+    def rm(path)
+      FileUtils.rm_rf(path)
+    end
+
+    ##
+    # Tries to find the full path of the specified utility. If the full
+    # path is found, it'll return that. Otherwise it'll just return the
+    # name of the utility. If the 'utility_path' is defined, it'll check
+    # to see if it isn't an empty string, and if it isn't, it'll go ahead and
+    # always use that path rather than auto-detecting it
+    def utility(name)
+      if respond_to?(:utility_path)
+        if utility_path.is_a?(String) and not utility_path.empty?
+          return utility_path
+        end
+      end
+
+      if path = %x[which #{name}].chomp and not path.empty?
+        return path
+      end
+      name
+    end
+
+    ##
+    # If the command that was previously run via this Ruby process returned
+    # error code "32512", the invoked utility (e.g. mysqldump, pgdump, etc) could not be found.
+    # If this is the case then this method will throw an exception, informing the user of this problem.
+    #
+    # Since this raises an exception, it'll stop the entire backup process, clean up the temp files
+    # and notify the user via the built-in notifiers if these are set.
+    def raise_if_command_not_found!(utility)
+      if $?.to_i.eql?(32512)
+        raise Exception::CommandNotFound , "Could not find the utility \"#{utility}\" on \"#{RUBY_PLATFORM}\".\n" +
+                                           "If this is a database utility, try defining the 'utility_path' option in the configuration file.\n" +
+                                           "See the Database Wiki for more information about the Utility Path option."
+      end
+    end
+
+  end
+end

data/lib/backup/compressor/base.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Backup
+  module Compressor
+    class Base
+      include Backup::CLI
+      include Backup::Configuration::Helpers
+
+      ##
+      # Logs a message to the console and log file to inform
+      # the client that Backup is compressing the archive
+      def log!
+        Backup::Logger.message "#{ self.class } started compressing the archive."
+      end
+    end
+  end
+end

data/lib/backup/compressor/bzip2.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+module Backup
+  module Compressor
+    class Bzip2 < Base
+
+      ##
+      # Tells Backup::Compressor::Bzip2 to compress
+      # better (-9) rather than faster when set to true
+      attr_writer :best
+
+      ##
+      # Tells Backup::Compressor::Bzip2 to compress
+      # faster (-1) rather than better when set to true
+      attr_writer :fast
+
+      ##
+      # Creates a new instance of Backup::Compressor::Bzip2 and
+      # configures it to either compress faster or better
+      # bzip2 compresses by default with -9 (best compression)
+      # and lower block sizes don't make things significantly faster
+      # (according to official bzip2 docs)
+      def initialize(&block)
+        load_defaults!
+
+        @best ||= false
+        @fast ||= false
+
+        instance_eval(&block) if block_given?
+      end
+
+      ##
+      # Performs the compression of the packages backup file
+      def perform!
+        log!
+        run("#{ utility(:bzip2) } #{ options } '#{ Backup::Model.file }'")
+        Backup::Model.extension += '.bz2'
+      end
+
+    private
+
+      ##
+      # Combines the provided options and returns a bzip2 options string
+      def options
+        (best + fast).join("\s")
+      end
+
+      ##
+      # Returns the bzip2 option syntax for compressing
+      # setting @best to true is redundant, as bzip2 compresses best by default
+      def best
+        return ['--best'] if @best; []
+      end
+
+      ##
+      # Returns the bzip2 option syntax for compressing
+      # (not significantly) faster when @fast is set to true
+      def fast
+        return ['--fast'] if @fast; []
+      end
+
+    end
+  end
+end

data/lib/backup/compressor/gzip.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+module Backup
+  module Compressor
+    class Gzip < Base
+
+      ##
+      # Tells Backup::Compressor::Gzip to compress
+      # better rather than faster when set to true
+      attr_writer :best
+
+      ##
+      # Tells Backup::Compressor::Gzip to compress
+      # faster rather than better when set to true
+      attr_writer :fast
+
+      ##
+      # Creates a new instance of Backup::Compressor::Gzip and
+      # configures it to either compress faster or better
+      def initialize(&block)
+        load_defaults!
+
+        @best ||= false
+        @fast ||= false
+
+        instance_eval(&block) if block_given?
+      end
+
+      ##
+      # Performs the compression of the packages backup file
+      def perform!
+        log!
+        run("#{ utility(:gzip) } #{ options } '#{ Backup::Model.file }'")
+        Backup::Model.extension += '.gz'
+      end
+
+    private
+
+      ##
+      # Combines the provided options and returns a gzip options string
+      def options
+        (best + fast).join("\s")
+      end
+
+      ##
+      # Returns the gzip option syntax for compressing
+      # better when @best is set to true
+      def best
+        return ['--best'] if @best; []
+      end
+
+      ##
+      # Returns the gzip option syntax for compressing
+      # faster when @fast is set to true
+      def fast
+        return ['--fast'] if @fast; []
+      end
+
+    end
+  end
+end

data/lib/backup/configuration/base.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    class Base
+      extend Backup::Configuration::Helpers
+
+      ##
+      # Allows for global configuration through block-notation
+      def self.defaults
+        yield self
+      end
+    end
+  end
+end

data/lib/backup/configuration/compressor/base.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Compressor
+      class Base < Backup::Configuration::Base
+      end
+    end
+  end
+end

data/lib/backup/configuration/compressor/bzip2.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Compressor
+      class Bzip2 < Base
+        class << self
+
+          ##
+          # Tells Backup::Compressor::Bzip2 to compress
+          # better (-9) which is bzip2 default anyway
+          attr_accessor :best
+
+          ##
+          # Tells Backup::Compressor::Bzip2 to compress
+          # faster (-1) (but not significantly faster)
+          attr_accessor :fast
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/compressor/gzip.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Compressor
+      class Gzip < Base
+        class << self
+
+          ##
+          # Tells Backup::Compressor::Gzip to compress
+          # better rather than faster when set to true
+          attr_accessor :best
+
+          ##
+          # Tells Backup::Compressor::Gzip to compress
+          # faster rather than better when set to true
+          attr_accessor :fast
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/database/base.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Database
+      class Base < Backup::Configuration::Base
+        class << self
+
+          ##
+          # Allows the user to specify the path to a "dump" utility
+          # in case it cannot be auto-detected by Backup
+          attr_accessor :utility_path
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/database/mongodb.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Database
+      class MongoDB < Base
+        class << self
+
+          ##
+          # Name of the database that needs to get dumped
+          attr_accessor :name
+
+          ##
+          # Credentials for the specified database
+          attr_accessor :username, :password
+
+          ##
+          # Connectivity options
+          attr_accessor :host, :port
+
+          ##
+          # IPv6 support (disabled by default)
+          attr_accessor :ipv6
+
+          ##
+          # Collections to dump, collections that aren't specified won't get dumped
+          attr_accessor :only_collections
+
+          ##
+          # Additional "mongodump" options
+          attr_accessor :additional_options
+
+          ##
+          # 'lock' dump meaning wrapping mongodump with fsync & lock
+          attr_accessor :lock
+
+        end
+      end
+    end
+  end
+end

data/lib/backup/configuration/database/mysql.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+module Backup
+  module Configuration
+    module Database
+      class MySQL < Base
+        class << self
+
+          ##
+          # Name of the database that needs to get dumped
+          attr_accessor :name
+
+          ##
+          # Credentials for the specified database
+          attr_accessor :username, :password
+
+          ##
+          # Connectivity options
+          attr_accessor :host, :port, :socket
+
+          ##
+          # Tables to skip while dumping the database
+          attr_accessor :skip_tables
+
+          ##
+          # Tables to dump, tables that aren't specified won't get dumped
+          attr_accessor :only_tables
+
+          ##
+          # Additional "mysqldump" options
+          attr_accessor :additional_options
+
+        end
+      end
+    end
+  end
+end