backup 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97b183cb0d0c210153909788775e95a6a686a4cc
-  data.tar.gz: 4eb3b105dcdea08f667c8e94625ec9bdf174dc49
+  metadata.gz: 8030ea8ce771bafd23266be65ddac30e62d9954b
+  data.tar.gz: bc53925b9956147157e9200d4cfb9d8c7886d343
 SHA512:
-  metadata.gz: d5c1cd997c5e0823022b323b639c7977b7d3f573468c860f0fab496ed619b3b44baae8c56ab8dbe13e9ab0643844dac72be9ac6e79c19ef5859faf2fd05760c5
-  data.tar.gz: 07af01b103adf78549d1296145403dded6e8e6d4cea9dbd5b750839ca26f585c32e0c42a0359f46f9ac0bcc57a412e6b6fdb3e8ab5b8b0936f8496109af7ce09
+  metadata.gz: b9631215669b56c92b1694d5a1005d5292ae9d3e25dd2da717cfbe40e30af80d6163b38e6662b7c309c2b480d4d69fe953458171c7dcd5fa908a51314d1ab584
+  data.tar.gz: 799f65d322c49d396d9301163412db25369ced068c6260a66fb54444cbd234da73fa07d92c3f6b8e8a58f6bfc241d763c1261d475dc2d3580f6acee02e295cce

data/README.md

@@ -68,10 +68,8 @@ $ tar -tvf my_backup.tar
   my_backup/archives/user_avatars.tar.gz
   my_backup/archives/log_files.tar.gz
   my_backup/databases/
-  my_backup/databases/PostgreSQL/
-  my_backup/databases/PostgreSQL/pg_db_name.sql.gz
-  my_backup/databases/Redis/
-  my_backup/databases/Redis/redis_db_name.rdb.gz
+  my_backup/databases/PostgreSQL.sql.gz
+  my_backup/databases/Redis.rdb.gz
 ```
 
 ### Storages
@@ -200,7 +198,7 @@ Backup::Model.new(:my_backup, 'Description for my_backup') do
     mail.user_name            = "sender@email.com"
     mail.password             = "my_password"
     mail.authentication       = "plain"
-    mail.enable_starttls_auto = true
+    mail.encryption           = :starttls
   end
 
   notify_by Twitter do |tweet|

data/lib/backup/archive.rb

@@ -53,6 +53,7 @@ module Backup
       @model   = model
       @name    = name.to_s
       @options = {
+        :sudo        => false,
         :root        => false,
         :paths       => [],
         :excludes    => [],
@@ -69,7 +70,7 @@ module Backup
 
       pipeline = Pipeline.new
       pipeline.add(
-        "#{ utility(:tar) } #{ tar_options } -cPf -#{ tar_root } " +
+        "#{ tar_command } #{ tar_options } -cPf -#{ tar_root } " +
         "#{ paths_to_exclude } #{ paths_to_package }",
         tar_success_codes
       )
@@ -95,6 +96,11 @@ module Backup
 
     private
 
+    def tar_command
+      tar = utility(:tar)
+      options[:sudo] ? "#{ utility(:sudo) } -n #{ tar }" : tar
+    end
+
     def tar_root
       options[:root] ? " -C '#{ File.expand_path(options[:root]) }'" : ''
     end
@@ -129,6 +135,10 @@ module Backup
         @options = options
       end
 
+      def use_sudo(val = true)
+        @options[:sudo] = val
+      end
+
       def root(path)
         @options[:root] = path
       end

data/lib/backup/cli.rb

@@ -4,25 +4,17 @@
 # Build the Backup Command Line Interface using Thor
 module Backup
   class CLI < Thor
-    include Thor::Actions
 
     ##
     # [Perform]
-    # Performs the backup process. The only required option is the --trigger [-t].
-    # If the other options (--config-file, --data-path, --cache-path, --tmp-path)
-    # aren't specified they will fallback to the (good) defaults.
     #
+    # The only required option is the --trigger [-t].
+    # If --config-file, --data-path, --cache-path, --tmp-path aren't specified
+    # they will fallback to defaults defined in Backup::Config.
     # If --root-path is given, it will be used as the base path for our defaults,
     # as well as the base path for any option specified as a relative path.
     # Any option given as an absolute path will be used "as-is".
     #
-    # If the --check option is given, the config.rb and all model files will be
-    # loaded, but no triggers will be run. If the check fails, errors will be
-    # reported to the console. If the check passes, a success message will be
-    # reported to the console unless --quiet is set. Use --no-quiet to ensure
-    # these messages are output. The command will exit with status 0 if
-    # successful, or status 1 if there were problems.
-    #
     # This command will exit with one of the following status codes:
     #
     #   0: All triggers were successful and no warnings were issued.
@@ -30,128 +22,201 @@ module Backup
     #   2: All triggers were processed, but some failed.
     #   3: A fatal error caused Backup to exit.
     #      Some triggers may not have been processed.
+    #
+    # If the --check option is given, `backup check` will be run
+    # and no triggers will be performed.
     desc 'perform', "Performs the backup for the specified trigger(s)."
-    long_desc "Performs the backup for the specified trigger(s).\n\n" +
-              "You may perform multiple backups by providing multiple triggers, separated by commas.\n\n" +
-              "Example:\n\s\s$ backup perform --triggers backup1,backup2,backup3,backup4\n\n" +
-              "This will invoke 4 backups, and they will run in the order specified (not asynchronous).\n\n" +
-              "\n\n" +
-              "--root-path may be an absolute path or relative to the current working directory.\n\n" +
-              "To use the current directory, you can use: `--root-path .` (i.e. a period for the argument)"
-
-    method_option :trigger,         :type => :string,  :required => true, :aliases => ['-t', '--triggers'],
-                                    :desc => "Triggers to perform. e.g. 'trigger_a,trigger_b'"
-    method_option :config_file,     :type => :string,  :default => '',    :aliases => '-c',
-                                    :desc => "Path to your config.rb file. " +
-                                              "Absolute, or relative to --root-path."
-    method_option :root_path,       :type => :string,  :default => '',    :aliases => '-r',
-                                    :desc => "Root path to base all relative path on. " +
-                                              "Absolute or relative to current directory (#{Dir.pwd})."
-    method_option :data_path,       :type => :string,  :default => '',    :aliases => '-d',
-                                    :desc => "Path to store persisted data (storage 'keep' data). " +
-                                              "Absolute, or relative to --root-path."
-    method_option :log_path,        :type => :string,  :default => '',    :aliases => '-l',
-                                    :desc => "Path to store Backup's log file. " +
-                                              "Absolute, or relative to --root-path."
-    method_option :cache_path,      :type => :string,  :default => '',
-                                    :desc => "Path to store Dropbox's cached authorization. " +
-                                              "Absolute, or relative to --root-path."
-    method_option :tmp_path,        :type => :string,  :default => '',
-                                    :desc => "Path to store temporary data during the backup process. " +
-                                              "Absolute, or relative to --root-path."
+
+    long_desc <<-EOS.gsub(/^ +/, '')
+      Performs the backup for the specified trigger(s).
+
+      You may perform multiple backups by providing multiple triggers,
+      separated by commas. Each will run in the order specified.
+
+      $ backup perform --triggers backup1,backup2,backup3,backup4
+
+      --root-path may be an absolute path or relative to the current directory.
+
+      To use the current directory, use: `--root-path .`
+
+      Relative paths given for --config-file, --data-path, --log-path,
+      --cache-path and --tmp-path will be relative to --root-path.
+
+      Console log output may be forced using --no-quiet.
+
+      Logging to file or syslog may be disabled using --no-logfile or --no-syslog
+      respectively. This will override logging options set in `config.rb`.
+    EOS
+
+    method_option :trigger,
+                  :aliases  => ['-t', '--triggers'],
+                  :required => true,
+                  :type     => :string,
+                  :desc     => "Triggers to perform. e.g. 'trigger_a,trigger_b'"
+
+    method_option :config_file,
+                  :aliases  => '-c',
+                  :type     => :string,
+                  :default  => '',
+                  :desc     => 'Path to your config.rb file.'
+
+    method_option :root_path,
+                  :aliases  => '-r',
+                  :type     => :string,
+                  :default  => '',
+                  :desc     => 'Root path to base all relative path on.'
+
+    method_option :data_path,
+                  :aliases  => '-d',
+                  :type     => :string,
+                  :default  => '',
+                  :desc     => 'Path to store storage cycling data.'
+
+    method_option :log_path,
+                  :aliases  => '-l',
+                  :type     => :string,
+                  :default  => '',
+                  :desc     => "Path to store Backup's log file."
+
+    method_option :cache_path,
+                  :type     => :string,
+                  :default  => '',
+                  :desc     => "Path to store Dropbox's cached authorization."
+
+    method_option :tmp_path,
+                  :type     => :string,
+                  :default  => '',
+                  :desc     => 'Path to store temporary data during the backup.'
+
     # Note that :quiet, :syslog and :logfile are specified as :string types,
     # so the --no-<option> usage will set the value to nil instead of false.
-    method_option :quiet,           :type => :string,  :default => false, :aliases => '-q', :banner => '',
-                                    :desc => "Disable console log output. " +
-                                              "May be force enabled using --no-quiet."
-    method_option :syslog,          :type => :string,  :default => false, :banner => '',
-                                    :desc => "Enable logging to syslog. " +
-                                              "May be forced disabled using --no-syslog."
-    method_option :logfile,         :type => :string,  :default => true, :banner => '',
-                                    :desc => "Enable Backup's log file. " +
-                                              "May be forced disabled using --no-logfile."
-    method_option :check,           :type => :boolean,  :default => false,
-                                    :desc => "Check `config.rb` and all Model configuration for errors or warnings."
+    method_option :quiet,
+                  :aliases  => '-q',
+                  :type     => :string,
+                  :default  => false,
+                  :banner   => '',
+                  :desc     => 'Disable console log output.'
+
+    method_option :syslog,
+                  :type     => :string,
+                  :default  => false,
+                  :banner   => '',
+                  :desc     => 'Enable logging to syslog.'
+
+    method_option :logfile,
+                  :type     => :string,
+                  :default  => true,
+                  :banner   => '',
+                  :desc     => "Enable Backup's log file."
+
+    method_option :check,
+                  :type     => :boolean,
+                  :default  => false,
+                  :desc     => 'Check configuration for errors or warnings.'
 
     def perform
-      ##
-      # Prepare to perform requested backup jobs.
+      check if options[:check] # this will exit()
+
       models = nil
       begin
-        ##
         # Set logger options
         opts = options
         Logger.configure do
-          console.quiet = opts[:quiet]
-          logfile.enabled = opts[:logfile]
-          logfile.log_path = opts[:log_path]
-          syslog.enabled = opts[:syslog]
+          console.quiet     = opts[:quiet]
+          logfile.enabled   = opts[:logfile]
+          logfile.log_path  = opts[:log_path]
+          syslog.enabled    = opts[:syslog]
         end
 
-        ##
         # Update Config variables
         # (config_file, root_path, data_path, cache_path, tmp_path)
         Config.update(options)
 
-        ##
-        # Ensure the :cache_path and :tmp_path are created
-        # if they do not yet exist
-        [Config.cache_path, Config.tmp_path].each do |path|
-          FileUtils.mkdir_p(path)
-        end
-
-        ##
         # Load the user's +config.rb+ file (and all their Models).
-        # May update Logger options.
+        # May update Logger (and Config) options.
         Config.load_config!
 
-        ##
         # Identify all Models to be run for the given +triggers+.
         triggers = options[:trigger].split(',').map(&:strip)
         models = triggers.map {|trigger|
           Model.find_by_trigger(trigger)
         }.flatten.uniq
 
-        if models.empty?
-          raise Errors::CLIError,
-              "No Models found for trigger(s) '#{triggers.join(',')}'."
-        end
+        raise Errors::CLIError, "No Models found for trigger(s) " +
+            "'#{ triggers.join(',') }'." if models.empty?
 
-        if options[:check] && Logger.has_warnings?
-          raise Errors::CLIError, 'Configuration Check has warnings.'
-        end
-
-        ##
-        # Finalize Logger configuration and begin real-time logging.
+        # Finalize Logger and begin real-time logging.
         Logger.start!
 
       rescue Exception => err
         Logger.error Errors::CLIError.wrap(err)
-        Logger.error 'Configuration Check Failed.' if options[:check]
         # Logger configuration will be ignored
         # and messages will be output to the console only.
         Logger.abort!
-        exit(options[:check] ? 1 : 3)
+        exit(3)
       end
 
-      if options[:check]
-        Logger.info 'Configuration Check Succeeded.'
+      # Model#perform! handles all exceptions from this point,
+      # as each model may fail and return here to allow others to run.
+      warnings = errors = false
+      models.each do |model|
+        model.perform!
+        warnings ||= Logger.has_warnings?
+        errors   ||= Logger.has_errors?
+        Logger.clear!
+      end
+      exit(errors ? 2 : 1) if errors || warnings
+    end
+
+    ##
+    # [Check]
+    #
+    # Loads the user's `config.rb` (and all Model files) and reports any Errors
+    # or Warnings. This is primarily for checking for syntax errors, missing
+    # dependencies and deprecation warnings.
+    #
+    # This may also be invoked using the `--check` option to `backup perform`.
+    #
+    # This command only requires `Config.config_file` to be correct.
+    # All other Config paths are irrelevant.
+    #
+    # All output will be sent to the console only.
+    # Logger options will be ignored.
+    #
+    # If successful, this method with exit(0).
+    # If there are Errors or Warnings, it will exit(1).
+    desc 'check', 'Check for configuration errors or warnings'
+
+    long_desc <<-EOS.gsub(/^ +/, '')
+      Loads your 'config.rb' file and all models and reports any
+      errors or warnings with your configuration, including missing
+      dependencies and the use of any deprecated settings.
+    EOS
+
+    method_option :config_file,
+                  :aliases  => '-c',
+                  :type     => :string,
+                  :default  => '',
+                  :desc     => "Path to your config.rb file."
+
+    def check
+      begin
+        Config.update(options)
+        Config.load_config!
+      rescue Exception => err
+        Logger.error Errors::CLIError.wrap(err)
+      end
+
+      if Logger.has_warnings? || Logger.has_errors?
+        Logger.error 'Configuration Check Failed.'
+        exit_code = 1
       else
-        ##
-        # Perform the backup job for each Model found for the given triggers,
-        # clearing the Logger after each job.
-        #
-        # Model#perform! handles all exceptions from this point,
-        # as each model may fail and return here to allow others to run.
-        warnings = errors = false
-        models.each do |model|
-          model.perform!
-          warnings ||= Logger.has_warnings?
-          errors   ||= Logger.has_errors?
-          Logger.clear!
-        end
-        exit(errors ? 2 : 1) if errors || warnings
+        Logger.info 'Configuration Check Succeeded.'
+        exit_code = 0
       end
+
+      Logger.abort!
+      exit(exit_code)
     end
 
     ##
@@ -161,14 +226,28 @@ module Backup
     #   $ backup generate:model --trigger my_backup --databases='mongodb'
     # will generate a pre-populated model with a base MongoDB setup
     desc 'generate:model', "Generates a Backup model file."
-    long_desc "Generates a Backup model file.\n\n" +
-              "\s\sNote: '--config-path' is the path to the directory where 'config.rb' is located.\n\n" +
-              "\s\sThe model file will be created as '<config_path>/models/<trigger>.rb'\n\n" +
-              "\s\sDefault: #{Config.root_path}\n\n"
 
-    method_option :trigger,     :type => :string, :required => true, :aliases => '-t'
-    method_option :config_path, :type => :string,
-                                :desc => 'Path to your Backup configuration directory'
+    long_desc <<-EOS.gsub(/^ +/, '')
+      Generates a Backup model file.
+
+      '--config-path' is the path to the *directory* where 'config.rb' is located.
+
+      The model file will be created as '<config_path>/models/<trigger>.rb'
+
+      The default location would be:
+
+      #{ Config.root_path }/models/
+    EOS
+
+    method_option :trigger,
+                  :aliases  => '-t',
+                  :required => true,
+                  :type     => :string,
+                  :desc     => 'Trigger name for the Backup model'
+
+    method_option :config_path,
+                  :type     => :string,
+                  :desc     => 'Path to your Backup configuration directory'
 
     # options with their available values
     %w{ databases storages syncers
@@ -178,9 +257,13 @@ module Backup
           "(#{Dir[path + '/*'].sort.map {|p| File.basename(p) }.join(', ')})"
     end
 
-    method_option :archives,    :type => :boolean
-    method_option :splitter,    :type => :boolean, :default => true,
-                                :desc => "use `--no-splitter` to disable"
+    method_option :archives,
+                  :type     => :boolean,
+                  :desc     => 'Model will include tar archives.'
+    method_option :splitter,
+                  :type     => :boolean,
+                  :default  => true,
+                  :desc     => "Use `--no-splitter` to disable"
 
     define_method "generate:model" do
       opts = options.merge(
@@ -193,8 +276,12 @@ module Backup
       config         = File.join(config_path, "config.rb")
       model          = File.join(models_path, "#{opts[:trigger]}.rb")
 
+      if File.file?(config_path)
+        abort('--config-path should be a directory, not a file.')
+      end
+
       FileUtils.mkdir_p(models_path)
-      if overwrite?(model)
+      if Helpers.overwrite?(model)
         File.open(model, 'w') do |file|
           file.write(
             Backup::Template.new({:options => opts}).result("cli/model.erb")
@@ -203,7 +290,7 @@ module Backup
         puts "Generated model file: '#{ model }'."
       end
 
-      if not File.exist?(config)
+      unless File.exist?(config)
         File.open(config, "w") do |file|
           file.write(Backup::Template.new.result("cli/config"))
         end
@@ -215,8 +302,18 @@ module Backup
     # [Generate:Config]
     # Generates the main configuration file
     desc 'generate:config', 'Generates the main Backup bootstrap/configuration file'
-    method_option :config_path, :type => :string,
-                                :desc => "Path to your Backup configuration directory. Default: #{Config.root_path}"
+
+    long_desc <<-EOS.gsub(/^ +/, '')
+      Path to your Backup configuration directory.
+
+      Default path would be:
+
+      #{ Config.root_path }
+    EOS
+
+    method_option :config_path,
+                  :type => :string,
+                  :desc => 'Path to your Backup configuration directory.'
 
     define_method 'generate:config' do
       config_path = options[:config_path] ?
@@ -224,7 +321,7 @@ module Backup
       config = File.join(config_path, "config.rb")
 
       FileUtils.mkdir_p(config_path)
-      if overwrite?(config)
+      if Helpers.overwrite?(config)
         File.open(config, "w") do |file|
           file.write(Backup::Template.new.result("cli/config"))
         end
@@ -247,13 +344,20 @@ module Backup
       case options[:encryptor].downcase
       when 'openssl'
         base64   = options[:base64] ? '-base64' : ''
-        password = options[:password_file].empty? ? '' : "-pass file:#{options[:password_file]}"
+        password = options[:password_file].empty? ? '' :
+            "-pass file:#{ options[:password_file] }"
         salt     = options[:salt] ? '-salt' : ''
-        %x[openssl aes-256-cbc -d #{base64} #{password} #{salt} -in '#{options[:in]}' -out '#{options[:out]}']
+
+        Helpers.exec!(
+          "openssl aes-256-cbc -d #{ base64 } #{ password } #{ salt } " +
+          "-in '#{ options[:in] }' -out '#{ options[:out] }'"
+        )
       when 'gpg'
-        %x[gpg -o '#{options[:out]}' -d '#{options[:in]}']
+        Helpers.exec!(
+          "gpg -o '#{ options[:out] }' -d '#{ options[:in] }'"
+        )
       else
-        puts "Unknown encryptor: #{options[:encryptor]}"
+        puts "Unknown encryptor: #{ options[:encryptor] }"
         puts "Use either 'openssl' or 'gpg'."
       end
     end
@@ -262,24 +366,27 @@ module Backup
     # [Dependencies]
     # Returns a list of Backup's dependencies
     desc 'dependencies', 'Display, Check or Install Dependencies for Backup.'
-    long_desc 'Display the list of dependencies for Backup, check the installation status, or install them through Backup.'
-    method_option :install, :type => :string
+
+    long_desc <<-EOS.gsub(/^ +/, '')
+        To display a list of available dependencies, run:
+
+        $ backup dependencies --list
+
+        To install one of these dependencies, run:
+
+        $ backup dependencies --install <name>
+
+        To check if a dependency is already installed, run:
+
+        $ backup dependencies --installed <name>
+    EOS
+
+    method_option :install, :type => :string, :banner => 'NAME'
     method_option :list,    :type => :boolean
-    method_option :installed, :type => :string
+    method_option :installed, :type => :string, :banner => 'NAME'
 
     def dependencies
-      unless options.any?
-        puts
-        puts "To display a list of available dependencies, run:\n\n"
-        puts "  backup dependencies --list"
-        puts
-        puts "To install one of these dependencies (with the correct version), run:\n\n"
-        puts "  backup dependencies --install <name>"
-        puts
-        puts "To check if a dependency is already installed, run:\n\n"
-        puts "  backup dependencies --installed <name>"
-        exit
-      end
+      Helpers.exec!("#{ $0 } help dependencies") unless options.any?
 
       if options[:list]
         deps = Dependency.all
@@ -361,23 +468,27 @@ module Backup
       puts "Backup #{Backup::Version.current}"
     end
 
-    private
-
-    ##
-    # Helper method for asking the user if he/she wants to overwrite the file
-    def overwrite?(path)
-      if File.exist?(path)
-        return yes? "A file already exists at '#{ path }'. Do you want to overwrite? [y/n]"
-      end
-      true
-    end
-
     # This is to avoid Thor's warnings when stubbing methods on the Thor class.
     module Helpers
       class << self
+
+        def overwrite?(path)
+          return true unless File.exist?(path)
+
+          $stderr.print "A file already exists at '#{ path }'.\n" +
+                        "Do you want to overwrite? [y/n] "
+          /^[Yy]/ =~ $stdin.gets
+        end
+
+        def exec!(cmd)
+          puts "Lauching: #{ cmd }"
+          exec(cmd)
+        end
+
         def bundler_loaded?
           !ENV['BUNDLE_GEMFILE'].to_s.empty?
         end
+
       end
     end