siba 0.4.3

data/lib/siba/helpers/test/file_mock.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+
+module SibaTest
+  # mocks all Siba::SibaFile methods
+  class FileMock
+    def method_missing(meth, *args, &block)
+      if FileMock.method_defined? meth
+        # do nothing
+      else
+        super
+      end
+    end
+
+    def respond_to?(meth)
+      if FileMock.method_defined? meth
+        true
+      else
+        super
+      end
+    end
+
+    def self.mock_all_methods
+      Siba::FilePlug.siba_file = SibaTest::FileMock.new
+    end
+
+    def file_expand_path(file_name)
+      file_name
+    end
+
+    private
+
+    def self.method_defined?(method_name)
+      file_class, method = Siba::SibaFile.get_file_class(method_name)
+      return true if !file_class.nil? && file_class.respond_to?(method)
+      Siba::SibaFile.instance_methods(false).include? method_name.to_sym
+    end
+  end
+end

data/lib/siba/helpers/test/helper.rb

@@ -0,0 +1,55 @@
+# encoding: UTF-8
+
+module SibaTest
+  IS_WINDOWS = !(RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/).nil?
+  UNICODE_FILE_NAME = "алиен学"
+  TmpDirMocked = "/tmp"
+
+  class << self
+    include Siba::TmpDirPlug
+
+    def init
+      require 'minitest/pride' unless SibaTest::IS_WINDOWS
+
+      @loaded_options = {}
+      @current_dir = siba_file.file_utils_pwd
+
+      MiniTest::Unit::TestCase.add_setup_hook do
+        Siba::SibaLogger.quiet = true
+        Siba::SibaLogger.no_log = true
+        Siba::LoggerPlug.create "Test", nil
+        Siba::SibaLogger.messages = []
+        Siba.settings = {}
+        Siba.current_dir = @current_dir 
+        Siba.backup_name = "siba"
+        SibaTest::KernelMock.mock_all_methods # prevents tests from accessing Kernel methods
+      end
+
+      MiniTest::Unit::TestCase.add_teardown_hook do
+        Siba::LoggerPlug.close
+      end
+    end
+
+    def init_unit
+      init
+      MiniTest::Unit::TestCase.add_setup_hook do
+        SibaTest::FileMock.mock_all_methods # prevents tests from doing file operations 
+        Siba.class_eval {@tmp_dir = SibaTest::TmpDirMocked}
+      end
+    end
+
+    def init_integration
+      init
+      MiniTest::Unit::TestCase.add_teardown_hook do
+        # cleanup after each integration test
+        Siba.current_dir = @current_dir 
+        Siba.cleanup_tmp_dir
+        SibaTest.cleanup_tmp_dir
+      end
+    end
+
+    def load_options(path_to_yml)
+      @loaded_options[path_to_yml] ||= Siba::OptionsLoader.load_yml(path_to_yml)
+    end
+  end
+end

data/lib/siba/helpers/test/kernel_mock.rb

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+
+module SibaTest
+  # mocks all Siba::SibaKernel methods
+  class KernelMock
+    undef_method :puts
+    def method_missing(meth, *args, &block)
+      if KernelMock.method_defined? meth
+        # do nothing
+      else
+        super
+      end
+    end
+
+    def respond_to?(meth)
+      if KernelMock.method_defined? meth
+        true
+      else
+        super
+      end
+    end
+
+
+    class << self
+      # the valud 'siba_kernel.gets' method will return
+      attr_accessor :gets_return_value
+
+      def mock_all_methods
+        Siba::KernelPlug.siba_kernel = SibaTest::KernelMock.new
+        SibaTest::KernelMock.gets_return_value = nil
+      end
+    end
+
+    def gets(*args)
+      SibaTest::KernelMock.gets_return_value
+    end
+
+    private
+
+    def self.method_defined?(method_name)
+      return Kernel.respond_to? method_name
+    end
+  end
+end

data/lib/siba/helpers/test/removable_constants.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+# Helper used to re-init constants
+# Based on http://stackoverflow.com/questions/3375360/how-to-redefine-a-ruby-constant-without-warning
+module SibaTest
+  module RemovableConstants
+    class << self
+      def def_if_not_defined(cls, const, value)
+        cls.const_set(const, value) unless cls.const_defined?(const)
+      end
+
+      def redef_without_warning(cls, const, value)
+        cls.send(:remove_const, const) if cls.const_defined?(const)
+        cls.const_set(const, value)
+      end
+    end
+  end
+end

data/lib/siba/helpers/test/require.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+
+require 'rubygems'
+gem 'minitest' # loads minitest from gem, not the included one
+require 'minitest/autorun'
+
+require 'siba'
+require 'siba/helpers/test/file_mock'
+require 'siba/helpers/test/kernel_mock'
+require 'siba/helpers/test/extend_test'
+require 'siba/helpers/test/removable_constants'
+require 'siba/helpers/test/helper'

data/lib/siba/logger_plug.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+
+require 'siba/siba_logger'
+
+module Siba
+  # Used to inject "logger" to classes that include this module
+  module LoggerPlug
+    def logger
+      LoggerPlug.logger
+    end
+
+    class << self
+      def logger
+        raise Siba::Error, "Log is not created" unless LoggerPlug.opened?
+        @logger
+      end    
+
+      def create(name, path_to_log_file, show_start_message = true)
+        raise Siba::Error, "Log is already created" if LoggerPlug.opened?
+        @logger = SibaLogger.new name, path_to_log_file, show_start_message
+      end
+
+      def close
+        @logger.close if LoggerPlug.opened?
+        @logger = nil
+        SibaLogger.quiet = false
+        SibaLogger.verbose = false
+        SibaLogger.no_log = false
+      end
+
+      def opened?
+        !@logger.nil?
+      end
+    end
+  end
+end

data/lib/siba/options_backup.rb

@@ -0,0 +1,37 @@
+# encoding: UTF-8
+
+module Siba
+  class OptionsBackup
+    OPTIONS_BACKUP_FILE_NAME = "siba_options_backup.yml"
+
+    class << self
+      include Siba::FilePlug
+      include Siba::LoggerPlug
+
+      def save_options_backup(path_to_options, to_dir)
+        data = Siba::FileHelper.read path_to_options
+        data << "\n\ncurrent_dir: \"#{Siba::StringHelper.escape_for_yaml(Siba.current_dir)}\""
+        options_backup_path = File.join to_dir, OPTIONS_BACKUP_FILE_NAME
+        siba_file.run_this do
+          Siba::FileHelper.write options_backup_path, data
+        end
+      end
+
+      def load_source_from_backup(dir)
+        path_to_options_backup = File.join dir, OPTIONS_BACKUP_FILE_NAME
+        options_backup = Siba::OptionsLoader.load_yml path_to_options_backup
+        Siba.current_dir = SibaCheck.options_string options_backup, "current_dir"
+        unless siba_file.file_directory? Siba.current_dir
+          begin
+            siba_file.file_utils_mkpath Siba.current_dir
+          rescue Exception
+            logger.error "Can not access the backup current directory #{Siba.current_dir}"
+            raise
+          end
+        end
+        SibaTask.new options_backup, "source"
+      end
+    end
+  end
+end
+

data/lib/siba/options_loader.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+
+require 'erb'
+require 'yaml'
+
+module Siba
+  module OptionsLoader
+    class << self
+      include Siba::LoggerPlug
+      def load_yml(path_to_yml)
+        logger.debug "Loading options from #{path_to_yml}"
+        raise Siba::Error, "Options file must have .yml extension: #{path_to_yml}" unless path_to_yml =~ /\.yml$/
+
+        unless File.exists? path_to_yml
+          raise Siba::Error, "Could not read the options file #{path_to_yml}.
+  Make sure the file exists and you have read access to it." 
+        end
+
+        begin
+          hash = load_hash_from_yml path_to_yml
+          raise Siba::Error, "invalid format" unless hash.is_a? Hash
+          return hash
+        rescue Exception => e
+          raise Siba::Error, "Error loading options file #{path_to_yml}: " + e.message
+        end
+      end
+
+      def load_hash_from_yml(path_to_yml)
+        YAML.load(load_erb path_to_yml)
+      end
+
+      def load_erb(path_to_file)
+        data = Siba::FileHelper.read path_to_file
+        ERB.new(data).result
+      end
+    end
+  end
+end

data/lib/siba/plugins/archive/tar/archive.rb

@@ -0,0 +1,117 @@
+# encoding: UTF-8
+
+module Siba::Archive
+  module Tar
+    class Archive
+      include Siba::FilePlug
+      include Siba::LoggerPlug
+      attr_accessor :compression 
+
+      def initialize(compression)
+        @compression = compression
+        check_installed
+      end
+
+      # Returns the archive name
+      def archive(sources_dir, dest_dir, dest_file_name)
+        Siba::Archive::Tar::Archive.check_compression_type compression
+
+        options = get_tar_option
+        extension = Archive.get_tar_extension compression
+
+        archive_name = "#{dest_file_name}.tar#{extension}"
+        archive_path = File.join(dest_dir, archive_name)
+        siba_file.run_this do
+          raise Siba::Error, "Archive file already exists: #{archive_path}" if siba_file.file_file?(archive_path) || siba_file.file_directory?(archive_path)  
+
+          siba_file.file_utils_cd dest_dir
+          command_text = %(tar c#{options}f #{archive_name} -C "#{sources_dir}" .)
+          # Using -C 'change directory' option to make it work on Windows
+          # because Windows will not understand absolute path to tar: "tar cf c:\dir\file.tar ."
+          siba_file.run_shell command_text, "Failed to archive: #{command_text}"
+          raise Siba::Error, "Failed to create archive: #{command_text}" unless siba_file.file_file?(archive_path)
+        end
+        archive_name
+      end
+
+      def extract(archive_path, destination_dir)
+        options = get_tar_option
+        archive_name = File.basename archive_path
+        archive_dir = File.dirname archive_path
+        siba_file.file_utils_cd archive_dir 
+        command_text = %(tar x#{options}f #{archive_name} -C "#{destination_dir}")
+        # Using -C 'change directory' option to make it work on Windows
+        # because Windows will not understand absolute path to tar: "tar xf c:\dir\file.tar"
+
+        siba_file.run_this do
+          unless siba_file.shell_ok? command_text
+            raise Siba::Error, "Failed to extract archive: #{command_text}"
+          end
+        end
+      end
+
+      # Making sure tar is installed and works: tars and un-tars a test file
+      def check_installed
+        siba_file.run_this("test installed") do
+          siba_file.run_shell("tar --help", "'tar' utility is not found. Please install it.")
+
+          begin
+            test_archive_and_extract
+          rescue Exception
+            logger.error "'tar' utility does not work correctly. Try reinstalling it."
+            raise
+          end
+          logger.debug "TAR archiver is verified"
+        end
+      end
+
+      def test_archive_and_extract        
+        # archive
+        src_dir = Siba::TestFiles.prepare_test_dir "tar-archive-src"
+        dest_dir = Siba::TestFiles.mkdir_in_tmp_dir "tar-archive-dest"
+        file_name = "myname"
+        archive src_dir, dest_dir, file_name
+        path_to_file = File.join(dest_dir,"#{file_name}.tar#{Archive.get_tar_extension(compression)}")
+        raise unless siba_file.file_file? path_to_file
+
+        # extract
+        extracted_dir = Siba::TestFiles.mkdir_in_tmp_dir "tar-archive-extracted"
+        extract path_to_file, extracted_dir
+
+        # compare
+        Siba::FileHelper.dirs_same? src_dir, extracted_dir
+      end
+
+      def self.check_compression_type(compression)
+        raise Siba::CheckError, "'Compression' should be one of the following: #{CompressionTypes.join(', ')}" unless CompressionTypes.include?(compression)
+      end
+
+    protected
+      def self.get_tar_extension(compression)
+        case compression
+        when "none" 
+          ""
+        when "gzip"
+          ".gz"
+        when "bzip2"
+          ".bz2"
+        else
+          raise 
+        end
+      end
+
+      def get_tar_option
+        case compression
+        when "none" 
+          ""
+        when "gzip"
+          "z"
+        when "bzip2"
+          "j"
+        else
+          raise 
+        end
+      end
+    end
+  end
+end

data/lib/siba/plugins/archive/tar/init.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+
+require 'siba/plugins/archive/tar/archive'
+
+module Siba::Archive
+  module Tar
+    DefaultCompression = "gzip"
+    CompressionTypes = ["gzip", "bzip2", "none"]
+
+    class Init 
+      include Siba::LoggerPlug
+
+      attr_accessor :archive 
+
+      def initialize(options)
+        options = options
+        compression = Siba::SibaCheck.options_string options, "compression", true, DefaultCompression
+        Archive.check_compression_type compression
+        @archive = Archive.new compression
+      end
+
+      # Archive the contents of sources_dir and put it to dest_dir.
+      # Return the archive file name. It must start with dest_file_name
+      # and its ending must not vary with time.
+      def backup(sources_dir, dest_dir, dest_file_name)
+        logger.info "Archiving with 'tar', compression: '#{archive.compression}'"
+        @archive.archive sources_dir, dest_dir, dest_file_name
+      end
+
+      # Extract archive file (path_to_archive) to_dir
+      # No return value is expected.
+      def restore(path_to_archive, to_dir)
+        logger.info "Extracting 'tar' archive, compression: '#{archive.compression}'"
+        @archive.extract path_to_archive, to_dir 
+      end
+    end
+  end
+end

data/lib/siba/plugins/archive/tar/options.yml

@@ -0,0 +1 @@
+compression: gzip # bgip2 or none