ubsafe 0.5

data/lib/ubsafe/ubsafe_commands/ubsafe_command_backup_mysql.rb

@@ -0,0 +1,54 @@
+require 'fileutils'
+
+module UBSafe
+
+  module Commands
+    
+    class MySqlBackup < UBSafe::Commands::Backup
+   
+      ##
+      # Hook to allow customization before creating source backup
+      #
+      # @return [Symbol] :success or :failure
+      #
+      def before_source_backup
+        tmp_dir = File.expand_path(@backup_options[:temporary_directory])
+        mysql_tmp_dir = File.join(tmp_dir,'mysql')
+        FileUtils.mkdir_p(mysql_tmp_dir)
+        cmd = " mysqldump -u#{@backup_options[:mysql_username]} -p#{@backup_options[:mysql_password]} -h#{@backup_options[:mysql_host]} #{@backup_options[:mysql_database]} >#{mysql_tmp_dir}/#{@backup_options[:mysql_database]}.sql"
+        @log.info("Backup #{@backup_name} \"mysqldump -u#{@backup_options[:mysql_username]} -p[PASSWORD] -h#{@backup_options[:mysql_host]} #{@backup_options[:mysql_database]} >#{mysql_tmp_dir}/#{@backup_options[:mysql_database]}.sql\"")
+        cmd_output = `#{cmd}`
+        cmd_status = $?
+        cmd_status = cmd_status == 0 ? :success : :failure
+        if cmd_status == :failure
+          # cleanup
+          cmd_output = `rm -rf #{mysql_tmp_dir}`
+          @log.error("Backup #{@backup_name} before_source_backup failed during mysqldump. Output #{cmd_output}")
+        end
+        # Point source to directory with dump file in it so rest of the world works
+        @backup_options[:source_tree] =  mysql_tmp_dir
+        return cmd_status
+      end
+      
+      ##
+      # Hook to allow customization after cleaning source
+      #
+      # @return [Symbol] :success or :failure
+      #
+      def after_clean_source
+        tmp_dir = File.expand_path(@backup_options[:temporary_directory])
+        mysql_tmp_dir = File.join(tmp_dir,'mysql')
+        cmd_output = `rm -rf #{mysql_tmp_dir}`
+        cmd_status = $?
+        cmd_status == 0 ? :success : :failure
+        if cmd_status == :failure
+          @log.error("Backup #{@backup_name} after_clean_source failed. Output #{cmd_output}")
+        end
+        return cmd_status
+      end
+      
+      
+    end
+    
+  end
+end

data/lib/ubsafe/ubsafe_commands/ubsafe_command_backup_postgres.rb

@@ -0,0 +1,54 @@
+require 'fileutils'
+
+module UBSafe
+
+  module Commands
+    
+    class PostgresBackup < UBSafe::Commands::Backup
+   
+      ##
+      # Hook to allow customization before creating source backup
+      #
+      # @return [Symbol] :success or :failure
+      #
+      def before_source_backup
+        tmp_dir = File.expand_path(@backup_options[:temporary_directory])
+        postgres_tmp_dir = File.join(tmp_dir,'postgres')
+        FileUtils.mkdir_p(postgres_tmp_dir)
+        cmd = "#{@backup_options[:postgres_bin_dir]}/pg_dump -U#{@backup_options[:postgres_username]} -h#{@backup_options[:postgres_host]} -p#{@backup_options[:postgres_port]} #{@backup_options[:postgres_database]} >#{postgres_tmp_dir}/#{@backup_options[:postgres_database]}.sql"
+        @log.info("Backup #{@backup_name} \"pg_dump -U#{@backup_options[:postgres_username]} -h#{@backup_options[:postgres_host]} -p#{@backup_options[:postgres_port]} #{@backup_options[:postgres_database]} >#{postgres_tmp_dir}/#{@backup_options[:postgres_database]}.sql\"")
+        cmd_output = `#{cmd}`
+        cmd_status = $?
+        cmd_status = cmd_status == 0 ? :success : :failure
+        if cmd_status == :failure
+          # cleanup
+          cmd_output = `rm -rf #{postgres_tmp_dir}`
+          @log.error("Backup #{@backup_name} before_source_backup failed during pg_dump. Output #{cmd_output}")
+        end
+        # Point source to directory with dump file in it so rest of the world works
+        @backup_options[:source_tree] =  postgres_tmp_dir
+        return cmd_status
+      end
+      
+      ##
+      # Hook to allow customization after cleaning source
+      #
+      # @return [Symbol] :success or :failure
+      #
+      def after_clean_source
+        tmp_dir = File.expand_path(@backup_options[:temporary_directory])
+        postgres_tmp_dir = File.join(tmp_dir,'postgres')
+        cmd_output = `rm -rf #{postgres_tmp_dir}`
+        cmd_status = $?
+        cmd_status == 0 ? :success : :failure
+        if cmd_status == :failure
+          @log.error("Backup #{@backup_name} after_clean_source failed. Output #{cmd_output}")
+        end
+        return cmd_status
+      end
+      
+      
+    end
+    
+  end
+end

data/lib/ubsafe/ubsafe_commands/ubsafe_command_backup_svn.rb

@@ -0,0 +1,53 @@
+require 'fileutils'
+
+module UBSafe
+
+  module Commands
+    
+    class SVNBackup < UBSafe::Commands::Backup
+   
+      ##
+      # Hook to allow customization before creating source backup
+      #
+      # @return [Symbol] :success or :failure
+      #
+      def before_source_backup
+        source_tree = File.expand_path(@backup_options[:source_tree])
+        tmp_dir = File.expand_path(@backup_options[:temporary_directory])
+        svn_tmp_dir = File.join(tmp_dir,'svn')
+        FileUtils.mkdir_p(svn_tmp_dir)
+        cmd = "svnadmin hotcopy #{source_tree} #{svn_tmp_dir}"
+        cmd_output = `#{cmd}`
+        cmd_status = $?
+        cmd_status = cmd_status == 0 ? :success : :failure
+        if cmd_status == :failure
+          # cleanup
+          cmd_output = `rm -rf #{svn_tmp_dir}`
+          @log.error("Backup #{@backup_name} before_source_backup failed during hotcopy. Output #{cmd_output}")
+        end
+        # Point source to hotcopy so rest of the world works
+        @backup_options[:source_tree] = svn_tmp_dir
+        return cmd_status
+      end
+      
+      ##
+      # Hook to allow customization after cleaning source
+      #
+      # @return [Symbol] :success or :failure
+      #
+      def after_clean_source
+        tmp_dir = File.expand_path(@backup_options[:temporary_directory])
+        svn_tmp_dir = File.join(tmp_dir,'svn')
+        cmd_output = `rm -rf #{svn_tmp_dir}`
+        cmd_status = $?
+        cmd_status == 0 ? :success : :failure
+        if cmd_status == :failure
+          @log.error("Backup #{@backup_name} after_clean_source failed. Output #{cmd_output}")
+        end
+        return cmd_status
+      end
+      
+    end
+    
+  end
+end

data/lib/ubsafe/ubsafe_commands/ubsafe_commands.rb

@@ -0,0 +1,12 @@
+module UBSafe
+  module Commands
+  end
+end
+
+require File.join_from_here('ubsafe_command_backup')
+require File.join_from_here('ubsafe_command_backup_svn')
+require File.join_from_here('ubsafe_command_backup_mysql')
+require File.join_from_here('ubsafe_command_backup_postgres')
+
+
+

data/lib/ubsafe/ubsafe_config.rb

@@ -0,0 +1,166 @@
+require 'optparse'
+require 'yaml'
+require 'erb'
+require 'fileutils'
+
+module UBSafe
+  
+  class Config
+    
+    attr_reader :options
+    
+    class << self
+    
+      ##
+      # Get configuration settings
+      #
+      # @return [UBSafe::Config] Singleton instance of UBSafe::Config
+      #
+      def config
+        if (not defined?(@@config_instance)) or @@config_instance.nil?
+          @@config_instance = UBSafe::Config.new
+        end
+        return @@config_instance
+      end
+      
+      ##
+      # Reset the configuration settings
+      #
+      def reset
+        @@config_instance = nil
+      end
+      
+    end
+    
+    private 
+
+    ##
+    # Create a new Config instance
+    #
+    # @return [UBSafe::Config] Instance of UBSafe::Config
+    #
+    def initialize
+      @options = {}
+    end
+
+    public
+    
+    ##
+    # Load a Config instance
+    #
+    # @param [Array] args Command-line arguments
+    #
+    def load(args = nil)
+      @options[:config_file] = ENV['UBSAFE_CONFIG_FILE'] unless ENV['UBSAFE_CONFIG_FILE'].nil?
+      #puts "UBConfig.load After env check @options #{@options.inspect}"
+      @options.merge!(parse_args(args))
+      #puts "UBConfig.load After merge @options #{@options.inspect}"
+      if @options[:config_file]
+        @options.merge!(load_config_file(@options[:config_file]))
+      end
+      configure_logging
+    end
+      
+    ## 
+    # Get the full set of configuration options for the specified backup
+    #
+    # @param [Symbol] backup_name
+    # @return [Hash] (Flattened?) hash with all the options for this backup. Nil if this backup is not present or enabled.
+    #
+    def full_options(backup_name)
+      backup_options = {}
+      # Get backup defaults
+      backup_options.merge!(@options[:backup_defaults].dup_contents_1_level)
+      # Get the specific backup definition
+      unless @options[:backups].has_key?(backup_name.to_sym)
+        @logger.fatal("The backup name specified '#{backup_name}' has no configuration defined in #{@options[:config_file]}") 
+        raise Exception.new("Non-existent backup specified '#{backup_name}'")
+      end
+      backup_options.merge!(@options[:backups][backup_name.to_sym].dup_contents_1_level)
+      return nil unless backup_options[:enabled]
+      backup_options[:backup_name] = backup_name.to_s unless backup_options[:backup_name]
+      # Expand the backup host reference
+      selected_host = backup_options[:backup_host]
+      backup_options.merge!(@options[:backup_hosts][selected_host].dup_contents_1_level)
+      # Expand the backup type reference
+      selected_backup_type = backup_options[:backup_type]
+      backup_options.merge!(@options[:backup_types][selected_backup_type].dup_contents_1_level)
+      return backup_options
+    end
+      
+    ## Get logger
+    #
+    # @return [Logging::Logger] Common logger instance
+    #
+    def log
+      return defined?(@logger) ? @logger : nil
+    end
+    
+    
+    private
+    
+    ##
+    # Parse command-line arguments
+    #
+    # @param [Array] args Command-line arguments
+    # @return [Hash] Parsed options. :remainder contains any options not part
+    #
+    def parse_args(args = nil)
+      parsed_options = {:remainder => []}
+      if args and args.kind_of?(Array)
+        options = OptionParser.new
+        options.on("-c","--config CONFIG_FILE", String, "Name of configuration file") {|val| parsed_options[:config_file] = val }
+        options.on("-n","--name BACKUP_NAME", String, 'Backup Name') {|val| parsed_options[:backup_name] = val.downcase.to_sym}
+        parsed_options[:remainder] = options.parse(*args)
+        parsed_options[:options_help_text] = options.to_s
+      end
+      return parsed_options
+    end
+      
+    ##
+    # Load config file
+    #
+    # @param [String] config_file_name Configuration file name
+    # @return [Object] all the settings in the associated configuration file
+    #
+    def load_config_file(config_file_name)
+      contents = nil
+      begin
+        template = ERB.new(File.open(config_file_name).read)
+        contents = YAML.load(template.result)
+      rescue Exception => ex
+        puts "FATAL - Unable to find or load configuration file '#{config_file_name}'"
+        raise ex
+        #exit 1
+      end
+      return contents
+    end
+    
+    ##
+    # Initialize logging
+    #
+    def configure_logging
+      @logger_configuration = @options[:logging]
+      @logger = Logging::Logger[@logger_configuration[:log_identifier]]
+      logger_layout = Logging::Layouts::UBSafeLoggerLayout.new(@logger_configuration)
+      FileUtils.mkdir_p(File.expand_path(@logger_configuration[:log_directory]))
+      env = ENV['UBSAFE_ENV'] ? "_#{ENV['UBSAFE_ENV'].downcase}" : '' 
+      log_file_name = @logger_configuration[:log_filename_pattern].gsub(/\%env\%/,env)
+      qualified_logger_file_name = File.expand_path(File.join(@logger_configuration[:log_directory],log_file_name))
+      @logger.add_appenders(
+          Logging::Appenders::RollingFile.new(@logger_configuration[:log_identifier],
+            { :filename => qualified_logger_file_name, 
+              :age => @logger_configuration[:log_rolling_frequency],
+              :keep => @logger_configuration[:logs_to_retain],
+              :safe => true,
+              :layout => logger_layout
+            }
+            
+          )
+      )
+      @logger.level = @logger_configuration[:log_level]
+    end
+      
+  end
+  
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: ubsafe
+version: !ruby/object:Gem::Version 
+  version: "0.5"
+platform: ruby
+authors: 
+- Tracy Flynn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-24 00:00:00 -04:00
+default_executable: ubsafe
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fastthread
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.0.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: logging
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+description: "ubsafe was developed by: Tracy Flynn"
+email: gems@olioinfo.net
+executables: 
+- ubsafe
+- ubsafe_file_exists
+- ubsafe_file_mtime
+- ubsafe_scp_cmd.expect
+- ubsafe_ssh_cmd.expect
+- ubsafer
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/ubsafe
+- bin/ubsafe_cmd_with_password.expect
+- bin/ubsafe_file_exists
+- bin/ubsafe_file_mtime
+- bin/ubsafe_scp_cmd.expect
+- bin/ubsafe_ssh_cmd.expect
+- bin/ubsafer
+- lib/ubsafe/extensions/ubsafe_extensions.rb
+- lib/ubsafe/extensions/ubsafe_file_extensions.rb
+- lib/ubsafe/extensions/ubsafe_hash_extensions.rb
+- lib/ubsafe/extensions/ubsafe_integer_extensions.rb
+- lib/ubsafe/extensions/ubsafe_kernel_extensions.rb
+- lib/ubsafe/extensions/ubsafe_logging_extensions.rb
+- lib/ubsafe/ubsafe_commands/ubsafe_command_backup.rb
+- lib/ubsafe/ubsafe_commands/ubsafe_command_backup_mysql.rb
+- lib/ubsafe/ubsafe_commands/ubsafe_command_backup_postgres.rb
+- lib/ubsafe/ubsafe_commands/ubsafe_command_backup_svn.rb
+- lib/ubsafe/ubsafe_commands/ubsafe_commands.rb
+- lib/ubsafe/ubsafe_config.rb
+- lib/ubsafe.rb
+- README
+has_rdoc: true
+homepage: http://www.olioinfo.net/projects
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: ubsafe simplify and automate backup tasks
+test_files: []
+