BackupMan 0.1.3 → 0.1.4

data/BackupMan.gemspec

@@ -0,0 +1,89 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{BackupMan}
+  s.version = "0.1.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Markus Strauss"]
+  s.date = %q{2010-03-01}
+  s.default_executable = %q{backup_man}
+  s.description = %q{A tool for system administrators to easily configure pull-over-SSH backups. Install this gem on your backup server. Configure your backups definitions in /etc/backup_man and run backup_man from cron to securely pull your data over SSH.}
+  s.email = %q{Markus@ITstrauss.eu}
+  s.executables = ["backup_man"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".yardopts",
+     "BackupMan.gemspec",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/backup_man",
+     "examples/example-host-config",
+     "features/development.feature",
+     "features/dsl_parameters.feature",
+     "features/logfile.feature",
+     "features/overview.feature",
+     "features/step_definitions/common_steps.rb",
+     "features/step_definitions/dsl_parameters_steps.rb",
+     "features/step_definitions/logfile_steps.rb",
+     "features/support/common.rb",
+     "features/support/env.rb",
+     "features/support/matchers.rb",
+     "lib/backup_man.rb",
+     "lib/backup_man/backup.rb",
+     "lib/backup_man/backup_man.rb",
+     "lib/backup_man/cli.rb",
+     "lib/backup_man/command.rb",
+     "lib/backup_man/dsl.rb",
+     "lib/backup_man/log.rb",
+     "lib/backup_man/mysql.rb",
+     "lib/backup_man/rsync.rb",
+     "lib/backup_man/tar.rb",
+     "spec/BackupMan_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/oowoo/BackupMan}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{backupman}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A tool for system administrators to easily configure pull-over-SSH backups.}
+  s.test_files = [
+    "spec/BackupMan_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0.4.0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0.4.4"])
+      s.add_runtime_dependency(%q<log4r>, [">= 1.1.2"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0.4.0"])
+      s.add_dependency(%q<cucumber>, [">= 0.4.4"])
+      s.add_dependency(%q<log4r>, [">= 1.1.2"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0.4.0"])
+    s.add_dependency(%q<cucumber>, [">= 0.4.4"])
+    s.add_dependency(%q<log4r>, [">= 1.1.2"])
+  end
+end
+

data/features/dsl_parameters.feature

@@ -13,21 +13,23 @@ Feature: The DSL supports various parameters
       | Tar   | onlyif, backup, to, user, host, filename, options | ok     |
       | Mysql | onlyif, backup, to, user, host, filename, options | ok     |
       | Rsync | onlyif, backup, to, user, host,           options | ok     |
+      | Tidy  | onlyif, directory                                 | ok     |
     
     Scenarios: full set, but invalid parameters are present
       | task  | parameters                                                           | result                                       |
       | Tar   | onlyif, backup, to, user, host, filename, options, invalid_parameter | fatal "undefined method `invalid_parameter'" |
       | Mysql | onlyif, backup, to, user, host, filename, options, invalid_parameter | fatal "undefined method `invalid_parameter'" |
       | Rsync | onlyif, backup, to, user, host,           options, invalid_parameter | fatal "undefined method `invalid_parameter'" |
+      | Tidy  | onlyif, directory, invalid_parameter | fatal "undefined method `invalid_parameter'" |
    
     Scenarios: minimal set, all required parameters are provided
       | task  | parameters  | result |
       | Tar   | backup      | ok     |
       | Mysql |             | ok     |
       | Rsync | backup      | ok     |
+      | Tidy  |             | ok     |
   
     Scenarios: one required parameter is missing
       | task  | parameters                                | result                                          |
       | Tar   | onlyif, to, user, host, filename, options | error "A required parameter is missing: backup" |
       | Rsync | onlyif, to, user, host, options           | error "A required parameter is missing: backup" |
-  

data/features/step_definitions/dsl_parameters_steps.rb

@@ -7,7 +7,8 @@ def defaults
     "user"   => "'user'",
     "host"   => "'host'",
     "filename" => "'filename'",
-    "options"  => "'options'"
+    "options"  => "'options'",
+    "directory" => "'directory'"
   }
 end
 

data/lib/backup_man/backup.rb

@@ -45,78 +45,32 @@ module BackupMan
     # because the default values are not available at that time;
     def set_defaults
       @data_sources = [] unless @data_sources
-      @backup_directory = "#{BackupMan.instance.destdir}/#{@name}" unless @backup_directory
+      @backup_directory = Backup.make_default_backup_directory(@name) unless @backup_directory
       @onlyif = "true" if @onlyif.nil?
       @user = 'root' unless @user
       @host = @name unless @host
     end
-
-    # yields the block which comes from the DSL configuration file; also
-    # registers the new backup configuration with {BackupMan}
-    def initialize( name )
-      @name = name      
-      yield(self) if block_given?
-      BackupMan.instance.register_backup( self )
+    
+    # DRY method for creating the default backup directory. Also used for
+    # creating the default tidy directory.
+    def self.make_default_backup_directory( name )
+      "#{BackupMan.instance.destdir}/#{name}"
     end
 
-    # calling this actually runs the backup; DO NOT override this; override
-    # _run instead
-    def run
-      log_begin_of_run
-      set_defaults
-      debug_log_dsl_info
-      unless missing_required_parameters.empty?
-        Log.error( "#{self}: A required parameter is missing: #{missing_required_parameters.join ' '}")
-        return
-      end
-      onlyif = eval( @onlyif )
-      Log.debug( "onlyif = { #{@onlyif} } evaluates #{onlyif}" )
-      if onlyif
-        unless @backup_directory
-          Log.error( "#{self}: No backup directory. Don't know where to store all this stuff.")
-        else
-          FileUtils.mkdir_p @backup_directory
-          _run
-        end
-      else
-        Log.info( "#{self}: Preconditions for backup run not fulfilled.")
-      end
-      log_end_of_run
-    end
-
-    # @return [String]
-    def to_s
-      "#{self.class} #{self.name}"
-    end
-
-
 
     private
-
-    # @abstract override this to implement the actual backup commands
+    
     def _run
-      throw "Hey. Cannot run just 'Backup'."
-    end
-
-    # @return [Array of Strings] of missing parameters
-    def missing_required_parameters
-      missing = []
-      self.class.dsl_methods.each do |name, var, mandatory|      
-        missing << name if mandatory && self.instance_variable_get("@#{var}").empty?
+      # checking if we have the backup_directory      
+      unless @backup_directory
+        Log.error( "#{self}: No backup directory. Don't know where to store all this stuff.")
+        return false
+      else
+        FileUtils.mkdir_p @backup_directory
+        return true
       end
-      missing
     end
-
-    # not used acutally
-    def log_begin_of_run
-      Log.info( "Starting #{self.class} run for #{@name}." )
-    end
-
-    # simply logs that the program terminates
-    def log_end_of_run
-      Log.info( "Finished #{self.class} run for #{@name}." )
-    end
-
+    
     # @return [String] the ssh command string including user@host
     def ssh_connect_cmd
       "#{BackupMan.instance.ssh_app} #{@user}@#{@host}"  

data/lib/backup_man/cli.rb

@@ -6,7 +6,7 @@ require_relative 'log'
 require_relative 'tar'
 require_relative 'rsync'
 require_relative 'mysql'
-
+require_relative 'tidy'
 
 module BackupMan
   class CLI

data/lib/backup_man/dsl.rb

@@ -16,6 +16,14 @@ module BackupMan
       host_class.extend(ClassMethods)
     end
     
+    # yields the block which comes from the DSL configuration file; also
+    # registers the new backup configuration with {BackupMan}
+    def initialize( name )
+      @name = name      
+      yield(self) if block_given?
+      BackupMan.instance.register_backup( self )
+    end
+    
     def debug_log_dsl_info
       Log.debug( "Job settings:")
       self.class.dsl_methods.each do |method, var|
@@ -23,6 +31,61 @@ module BackupMan
       end
     end
     
+    # calling this actually runs the backup/task; DO NOT override this; override
+    # _run instead
+    def run
+      log_begin_of_run
+      set_defaults
+      debug_log_dsl_info
+      unless missing_required_parameters.empty?
+        Log.error( "#{self}: A required parameter is missing: #{missing_required_parameters.join ' '}")
+        return
+      end
+      onlyif = eval( @onlyif )
+      Log.debug( "onlyif = { #{@onlyif} } evaluates #{onlyif}" )
+      if onlyif
+        _run
+      else
+        Log.info( "#{self}: Preconditions for backup run not fulfilled.")
+      end
+      log_end_of_run
+    end
+
+    # @return [String]
+    def to_s
+      "#{self.class} #{self.name}"
+    end
+
+
+    # @abstract override this to implement the actual backup commands
+    def _run
+      throw "Hey. Cannot run just 'Backup'."
+    end
+    private :_run
+
+    # @return [Array of Strings] of missing parameters
+    def missing_required_parameters
+      missing = []
+      self.class.dsl_methods.each do |name, var, mandatory|      
+        missing << name if mandatory && self.instance_variable_get("@#{var}").empty?
+      end
+      missing
+    end
+    private :missing_required_parameters
+
+    # not used acutally
+    def log_begin_of_run
+      Log.info( "Starting #{self.class} run for #{@name}." )
+    end
+    private :log_begin_of_run
+
+    # simply logs that the program terminates
+    def log_end_of_run
+      Log.info( "Finished #{self.class} run for #{@name}." )
+    end
+    private :log_end_of_run
+
+
     module ClassMethods
       
       # @param [String] name
@@ -30,7 +93,7 @@ module BackupMan
       # @param [Boolean] mandatory, true if this var is a required parameter
       def def_dsl( name, var = name, mandatory = false )
         class_eval( %Q{
-          def #{name}( #{var} )
+          def #{name}( #{var} = true )
             @#{var} = #{var}
           end
           })
@@ -59,7 +122,7 @@ module BackupMan
         @dsl_methods
       end
 
-
     end # ClassMethods
+      
   end #DSL
 end #BackupMan

data/lib/backup_man/mysql.rb

@@ -19,8 +19,10 @@ module BackupMan
     end
 
     def _run
-      remote_cmd = "mysqldump #{@options}"
-      Command.new("#{ssh_connect_cmd} '#{remote_cmd} | gzip' > '#{@backup_directory}/#{@filename}'").run
+      if super
+        remote_cmd = "mysqldump #{@options}"
+        Command.new("#{ssh_connect_cmd} '#{remote_cmd} | gzip' > '#{@backup_directory}/#{@filename}'").run
+      end
     end
 
     # returns true if the backup already exists

data/lib/backup_man/rsync.rb

@@ -17,8 +17,10 @@ module BackupMan
     end
 
     def _run
-      @data_sources.each do |dir|
-        Command.new("rsync #{@options} -e '#{BackupMan.instance.ssh_app}' '#{@user}@#{@host}:#{dir}' '#{@backup_directory}'").run
+      if super
+        @data_sources.each do |dir|
+          Command.new("rsync #{@options} -e '#{BackupMan.instance.ssh_app}' '#{@user}@#{@host}:#{dir}' '#{@backup_directory}'").run
+        end
       end
     end
 

data/lib/backup_man/tar.rb

@@ -20,8 +20,10 @@ module BackupMan
     end
     
     def _run
-      remote_cmd = "tar -c#{@options}f - ", @data_sources.join(" ")
-      Command.new("#{ssh_connect_cmd} #{remote_cmd} > '#{@backup_directory}/#{@filename}'").run
+      if super
+        remote_cmd = "tar -c#{@options}f - ", @data_sources.join(" ")
+        Command.new("#{ssh_connect_cmd} #{remote_cmd} > '#{@backup_directory}/#{@filename}'").run
+      end
     end
     
     # returns true if the backup already exists

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Markus Strauss
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-26 00:00:00 +01:00
+date: 2010-03-01 00:00:00 +01:00
 default_executable: backup_man
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -86,6 +86,7 @@ files:
 - .document
 - .gitignore
 - .yardopts
+- BackupMan.gemspec
 - LICENSE
 - README.rdoc
 - Rakefile