BackupMan 0.1.4 → 0.1.5

data/BackupMan.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{BackupMan}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Markus Strauss"]

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.5

data/features/dsl_parameters.feature

@@ -13,23 +13,21 @@ 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,8 +7,7 @@ def defaults
     "user"   => "'user'",
     "host"   => "'host'",
     "filename" => "'filename'",
-    "options"  => "'options'",
-    "directory" => "'directory'"
+    "options"  => "'options'"
   }
 end
 

data/lib/backup_man/backup.rb

@@ -45,32 +45,78 @@ module BackupMan
     # because the default values are not available at that time;
     def set_defaults
       @data_sources = [] unless @data_sources
-      @backup_directory = Backup.make_default_backup_directory(@name) unless @backup_directory
+      @backup_directory = "#{BackupMan.instance.destdir}/#{@name}" unless @backup_directory
       @onlyif = "true" if @onlyif.nil?
       @user = 'root' unless @user
       @host = @name unless @host
     end
-    
-    # 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}"
+
+    # 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
 
+    # 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
-      # 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
+      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?
       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,14 +16,6 @@ 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|
@@ -31,61 +23,6 @@ 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
@@ -93,7 +30,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} = true )
+          def #{name}( #{var} )
             @#{var} = #{var}
           end
           })
@@ -122,7 +59,7 @@ module BackupMan
         @dsl_methods
       end
 
+
     end # ClassMethods
-      
   end #DSL
 end #BackupMan

data/lib/backup_man/mysql.rb

@@ -14,15 +14,13 @@ module BackupMan
 
     def set_defaults
       super
-      @filename = "#{Date.today}-mysqlfull.sql.gz"
-      @options  = '--all-databases -u root'
+      @filename = "#{Date.today}-mysqlfull.sql.gz" unless @filename
+      @options  = '--all-databases -u root' unless @options
     end
 
     def _run
-      if super
-        remote_cmd = "mysqldump #{@options}"
-        Command.new("#{ssh_connect_cmd} '#{remote_cmd} | gzip' > '#{@backup_directory}/#{@filename}'").run
-      end
+      remote_cmd = "mysqldump #{@options}"
+      Command.new("#{ssh_connect_cmd} '#{remote_cmd} | gzip' > '#{@backup_directory}/#{@filename}'").run
     end
 
     # returns true if the backup already exists

data/lib/backup_man/rsync.rb

@@ -13,14 +13,12 @@ module BackupMan
     def set_defaults
       @backup_directory = "#{BackupMan.instance.destdir}/#{@name}/rsync" unless @backup_directory
       super
-      @options  = "-azR --delete"
+      @options  = "-azR --delete" unless @options
     end
 
     def _run
-      if super
-        @data_sources.each do |dir|
-          Command.new("rsync #{@options} -e '#{BackupMan.instance.ssh_app}' '#{@user}@#{@host}:#{dir}' '#{@backup_directory}'").run
-        end
+      @data_sources.each do |dir|
+        Command.new("rsync #{@options} -e '#{BackupMan.instance.ssh_app}' '#{@user}@#{@host}:#{dir}' '#{@backup_directory}'").run
       end
     end
 

data/lib/backup_man/tar.rb

@@ -15,15 +15,13 @@ module BackupMan
     
     def set_defaults
       super
-      @filename = "#{Date.today}-files.tgz"
-      @options  = "zP"
+      @filename = "#{Date.today}-files.tgz" unless @filename
+      @options  = "zP" unless @options
     end
     
     def _run
-      if super
-        remote_cmd = "tar -c#{@options}f - ", @data_sources.join(" ")
-        Command.new("#{ssh_connect_cmd} #{remote_cmd} > '#{@backup_directory}/#{@filename}'").run
-      end
+      remote_cmd = "tar -c#{@options}f - ", @data_sources.join(" ")
+      Command.new("#{ssh_connect_cmd} #{remote_cmd} > '#{@backup_directory}/#{@filename}'").run
     end
     
     # returns true if the backup already exists

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Markus Strauss