siba 0.4.3

data/scaffolds/project/test/helper/require_unit.rb

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+
+require 'siba/helpers/test/require'
+SibaTest.init_unit

data/scaffolds/project/test/integration/i9n_init.rb

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+
+require 'helper/require_integration'
+require 'siba-c6y-demo/init'
+
+# Integration test example
+# 'rake test:i9n' command runs integration tests
+describe Siba::C6y::Demo::Init do
+  it "should run integration test" do
+    # All file operations will work normally in integration tests
+    # You can use the following helper methods 
+    
+    # Get path to test tmp dir (will be cleaned automatically after each test)
+    SibaTest.tmp_dir
+    
+    # Make a sub dir with a random name in a test tmp dir
+    tmp_sub_dir = mkdir_in_tmp_dir "prefix"
+
+    # Copy the test file to tmp dir (siba/lib/siba/test_files/a_file)
+    path_to_test_file = prepare_test_file "prefix"
+
+    # Copy the test dir to tmp dir (siba/lib/siba/test_files/files_and_dirs)
+    path_to_test_dir = prepare_test_dir "prefix"
+    path_to_test_dir2 = prepare_test_dir "prefix"
+
+    # Compare dirs recursively
+    dirs_same? path_to_test_dir, path_to_test_dir2
+
+    # Read test yml and replace values (see siba/test/integration/yml/valid.yml)
+    # path_to_options = prepare_options path_to_yml, 
+    #                       { src_dir: path_to_test_dir,
+    #                         src_file: path_to_test_file,
+    #                         dest_dir: path_to_test_dir2 }
+  end
+end

data/scaffolds/project/test/unit/test_init.rb

@@ -0,0 +1,43 @@
+# encoding: UTF-8
+
+require 'helper/require_unit'
+require 'siba-c6y-demo/init'
+
+# Unit test example
+# 'rake' command runs unit tests
+# 'guard' command will run unit tests automatically
+describe Siba::C6y::Demo do
+  before do                    
+    @yml_path = File.expand_path('../yml', __FILE__)
+  end
+
+  it "should load plugin" do
+    # helper to load options from YAML from @yml_path dir
+    options_hash = load_options "valid" 
+
+    plugin = Siba::C6y::Demo::Init.new options_hash
+    plugin.must_be_instance_of Siba::C6y::Demo::Init
+  end
+
+  it "siba should load plugin" do 
+    # helper to load the plugin by siba (build and install demo gem to make it work)
+    # @plugin_category = "c6y"      
+    # @plugin_type = "demo"         
+    # plugin = create_plugin "valid" 
+  end
+      
+  it "should check log" do
+    # ... code
+    # must_log "info"
+    # wont_log "warn"
+    # wont_log_from "warn"
+    # show_log 
+  end
+
+  it "should verify file operations" do
+    # fmock = mock_file(:file_directory?, true, ["Path"])
+    # fmock.expect(:file_utils_cd, nil, ["/dir"])
+    # ... code
+    # fmock.verify
+  end
+end

data/scaffolds/project/test/unit/yml/valid.yml

@@ -0,0 +1,8 @@
+type: demo
+key: some value
+array:
+- One
+- Two
+- 3
+bool: true
+

data/scaffolds/shared/examples.rb

@@ -0,0 +1,47 @@
+        # Examples:
+        #
+        # -- Logging --
+        # "logger" object is available after including Siba::LoggerPlug
+        logger.debug "Detailed information shown in 'verbose' mode and in log file"
+        logger.info "Useful information about current operation"
+        logger.warn "A warning"
+        logger.error "A handleable error message"
+        raise Siba::Error, "An unhandleable error. It will be caught at the upper level and logged." if false
+
+        # -- File operations --
+        # "siba_file" object is available after including Siba::FilePlug
+        # You can use it for file operations 
+        # instead of calling Dir, File, FileUtils directly.
+        # It mocks all methods of these classes in unit tests
+        # but runs them normally and in integration tests.
+        current_dir = siba_file.dir_pwd # for Dir.pwd
+        dir = siba_file.file_directory? current_dir #for File.directory?
+        siba_file.file_utils_cd dir #for FileUtils.cd
+        siba_file.run_this do
+          # The block will not be run during unit tests
+        end
+
+        # These methods can be used directly as they do not access file system
+        File.join "a","b"
+        File.basename "a"
+        File.dirname "a"
+
+        # Helpers to run shell commands (wont be run in unit tests)
+        siba_file.shell_ok? "cd ."
+        output = siba_file.run_shell "git help"
+
+        # -- Temporary dirs and files --
+        # Use Siba.tmp_dir to store temporary files
+        tmp_dir = Siba.tmp_dir
+
+        # Create a sub-dir with a random name in the temp dir
+        path_to_tmp_dir = Siba::TestFiles.mkdir_in_tmp_dir "you_dir_prefix" 
+
+        # Note: Siba.tmp_dir will be removed automatically, 
+        # so there is no need to clean anything.
+        
+        # Some Siba::FileHelper methods
+        files_and_dirs = Siba::FileHelper.entries current_dir
+        my_file = File.join tmp_dir, "myfile"
+        Siba::FileHelper.write my_file, "Write UTF-8 text"
+        Siba::FileHelper.read my_file

data/scaffolds/shared/init_example.rb

@@ -0,0 +1,13 @@
+        # The backup is started after all plugins are initialized
+        # Therefore, this is a good place to do some checking (access, shell commands etc.)
+        # to make sure everything works before backup is started
+
+        # Examples:
+        #
+        # Load and validate options
+        key = Siba::SibaCheck.options_string options, "key"
+        key2 = Siba::SibaCheck.options_string options, "missing", true, "default value"
+        array = Siba::SibaCheck.options_string_array options, "array"
+        bool = Siba::SibaCheck.options_bool options, "bool"
+        Siba.settings # Gets the global app settings (value of "settings" key in YAML file)
+        raise Siba::Error, "Something wrong" if false

data/scaffolds/source.rb

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+
+module Siba::C6y
+  module Demo                 
+    class Init                 
+      include Siba::FilePlug
+      include Siba::LoggerPlug
+
+      def initialize(options)
+## init_example.rb ##
+      end                      
+
+      # Collect source files and put them into dest_dir
+      # No return value is expected
+      def backup(dest_dir)
+## examples.rb ##
+      end
+
+      # Restore source files from_dir 
+      # No return value is expected
+      def restore(from_dir)
+      end
+    end
+  end
+end

data/siba.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "siba/version"
+
+Gem::Specification.new do |s|
+  s.name        = "siba"
+  s.version     = Siba::VERSION
+  s.authors     = ["Evgeny Neumerzhitskiy"]
+  s.email       = ["sausageskin@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Simple backup and restore utility.}
+  s.description = %q{This is a backup and restore utility. SIBA implements backup rotation scheme. It retains a one year history of backups by keeping up to 23 files: 6 daily, 5 weekly and 12 monthly backups. Backups are compressed and encrypted. Various backup sources and destinations can be added through extension gems.}
+
+  s.rubyforge_project = "siba"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.required_rubygems_version = '~>1.8'
+
+  s.add_development_dependency 'minitest', '~>2.10'
+  s.add_development_dependency 'rake', '~>0.9'
+  s.add_development_dependency 'guard-minitest', '~>0.4'
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/test/helper/require_integration.rb

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+
+require 'siba/helpers/test/require'
+SibaTest.init_integration

data/test/helper/require_unit.rb

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+
+require 'siba/helpers/test/require'
+SibaTest.init_unit

data/test/integration/helpers/i9n_file_helper.rb

@@ -0,0 +1,50 @@
+# encoding: UTF-8
+
+require 'helper/require_integration'
+
+describe Siba::FileHelper do
+  before do
+    @obj = Siba::FileHelper
+  end
+
+  it "should call dir_empty?" do
+    test_dir = prepare_test_dir "dir-not-empty"
+    @obj.dir_empty?(test_dir).must_equal false
+
+    empty_test_dir = mkdir_in_tmp_dir "dir-empty"
+    @obj.dir_empty?(empty_test_dir).must_equal true
+  end
+
+  it "should call entries" do
+    test_dir = prepare_test_dir "dir-not-empty"
+    entries_to_compare = siba_file.dir_entries(test_dir) - %w{ . .. }
+    entries = @obj.entries test_dir
+    entries.wont_be_empty
+    entries.must_equal entries_to_compare
+  end
+
+  it "should call dirs_count" do
+    test_dir = prepare_test_dir "dir-not-empty"
+    dirs_count = @obj.dirs_count test_dir
+    dirs_count.must_equal 2
+  end
+
+  it "should call dirs_same?" do
+    test_dir1 = prepare_test_dir "dirs-same-1"
+    test_dir2 = prepare_test_dir "dirs-same-2"
+    @obj.dirs_same? test_dir1, test_dir2
+
+    # add a file to one dir
+    new_file1 = prepare_test_file "unexpected", test_dir2
+    ->{@obj.dirs_same? test_dir1, test_dir2}.must_raise Siba::Error
+
+    # add the file to the other dir
+    siba_file.file_utils_cp new_file1, test_dir1
+    new_file2 = File.join test_dir1, File.basename(new_file1)
+    @obj.dirs_same? test_dir1, test_dir2
+
+    # change a file in one dir
+    siba_file.file_open(new_file2,"a") {|a| a.write("new text")}
+    ->{@obj.dirs_same? test_dir1, test_dir2}.must_raise Siba::Error
+  end
+end

data/test/integration/i9n_backup.rb

@@ -0,0 +1,53 @@
+# encoding: UTF-8
+
+require 'helper/require_integration'
+
+describe Siba::Backup do
+  before do
+    @yml_path = File.expand_path '../yml', __FILE__
+    @path_to_src_yml = File.join @yml_path, "valid.yml"
+  end
+
+  it "should run backup and restore" do
+    Siba::LoggerPlug.close
+    Siba::SibaLogger.quiet = true
+
+    src_dir = prepare_test_dir "bf-src-dir"
+    src_file = prepare_test_file "bf-src-file"
+    dest_dir = mkdir_in_tmp_dir "bf-dest-dir"
+
+    test_yml_path = prepare_yml @path_to_src_yml, 
+      { src_dir: src_dir,
+        src_file: src_file,
+        dest_dir: dest_dir }
+
+    log_file = File.join File.dirname(test_yml_path), "testlog.log"
+
+    # Test backup
+    Siba::Backup.new.backup test_yml_path, log_file
+    Siba::FileHelper.entries(dest_dir).find{|a| a =~ /\.gpg$/}.wont_be_nil
+    siba_file.file_file?(log_file).must_equal true, "Must create log file"
+    Siba.tmp_dir_clean?.must_equal true, "Tmp dir must be cleaned"
+    Siba::LoggerPlug.opened?.must_equal false, "Logger must be closed"
+
+
+    # Test restore
+    sources_copy_dir = mkdir_in_tmp_dir "source-copy"
+    FileUtils.mv src_dir, sources_copy_dir
+    path_to_dir_copy = File.join sources_copy_dir, File.basename(src_dir)
+    FileUtils.mv src_file, sources_copy_dir
+    path_to_file_copy = File.join sources_copy_dir, File.basename(src_file)
+    File.directory?(src_dir).must_equal false
+    File.file?(src_file).must_equal false
+
+    Siba::SibaLogger.quiet = true
+    SibaTest::KernelMock.gets_return_value = "yes"
+    Siba::Restore.new.restore test_yml_path
+    
+    File.directory?(src_dir).must_equal true
+    File.file?(src_file).must_equal true
+    dirs_same? src_dir, path_to_dir_copy
+    FileUtils.compare_file(src_file, path_to_file_copy).must_equal true
+    wont_log_from "warn"
+  end
+end

data/test/integration/i9n_console.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+require 'helper/require_integration'
+
+describe Siba::Console do
+  before do
+    @console = Siba::Console.new true
+  end
+
+  it "should call generate command" do
+    SibaTest::KernelMock.gets_return_value = "1"
+    path_to_yml = generate_path("gen") + ".yml"
+    @console.parse ["generate", path_to_yml]
+    Siba::FileHelper.read(path_to_yml).wont_be_empty
+  end
+end

data/test/integration/i9n_generator.rb

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+
+require 'helper/require_integration'
+
+describe Siba::Generator do
+  before do
+    SibaTest::KernelMock.gets_return_value = "1"
+  end
+
+  it "should create generator" do
+    test_file = generate_path "gen"
+    @obj = Siba::Generator.new test_file
+    path_to_yml = @obj.generate
+    Siba::FileHelper.read(path_to_yml).wont_be_empty
+  end
+
+  it "generator should fail if file exists" do
+    path = generate_path "gen"
+    path = "#{path}.yml"
+    FileUtils.touch path
+    File.file?(path).must_equal true
+    @obj = Siba::Generator.new path
+    ->{@obj.generate}.must_raise Siba::Error
+  end
+
+  it "should call get_plugin_yaml_path" do
+    Siba::Generator.get_plugin_yaml_path("source", "files").wont_be_empty
+  end
+end

data/test/integration/i9n_options_backup.rb

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+
+require 'helper/require_integration'
+
+describe Siba::OptionsBackup do
+  before do
+    @cls = Siba::OptionsBackup
+  end
+
+  it "should save options backup" do
+    new_curret_dir = "change_current_dir"
+    Siba.current_dir = new_curret_dir
+    yml_path = File.expand_path "../yml", __FILE__
+    options_path = File.join yml_path, "valid.yml"
+    source_dir = mkdir_in_tmp_dir "sob"
+    @cls.save_options_backup options_path, source_dir
+    options_backup_path = File.join source_dir, Siba::OptionsBackup::OPTIONS_BACKUP_FILE_NAME
+    @yml_path = source_dir
+    options = load_options Siba::OptionsBackup::OPTIONS_BACKUP_FILE_NAME
+    options["current_dir"].must_equal new_curret_dir
+  end
+end

data/test/integration/i9n_scaffold.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+require 'helper/require_integration'
+
+describe Siba::Scaffold do
+  before do
+    @gem_name = "myname"
+    @obj = Siba::Scaffold.new "destination", @gem_name 
+  end
+
+  it "should run scaffold" do
+    Siba::LoggerPlug.close
+    Siba::SibaLogger.quiet = true
+
+    dest_dir = mkdir_in_tmp_dir "scf-d"
+    Siba::FileHelper.dir_empty?(dest_dir).must_equal true
+    @obj.scaffold dest_dir
+    Siba::FileHelper.dir_empty?(dest_dir).must_equal false
+    dest_dir = File.join dest_dir, @gem_name
+    File.directory?(dest_dir).must_equal true
+    Siba::FileHelper.dirs_count(dest_dir).must_be :>, 1
+    git_dir = File.join dest_dir, ".git"
+    File.directory?(git_dir).must_equal true, "Must create git repository"
+    wont_log_from "warn"
+  end
+end
+

data/test/integration/i9n_siba_file.rb

@@ -0,0 +1,30 @@
+# encoding: UTF-8
+
+require 'helper/require_integration'
+
+describe Siba::Backup do
+  before do
+    @siba_file = Siba::SibaFile.new
+  end
+
+  it "should fail if incorrect" do
+    ->{@siba_file.unknown}.must_raise NoMethodError
+    ->{@siba_file.file_unknown}.must_raise NoMethodError
+  end
+
+  it "should run file_expand_path" do
+    dirname = "dir/ep"
+    one = @siba_file.file_expand_path(dirname)
+    two = @siba_file.file_expand_path(dirname)
+    three = @siba_file.file_expand_path(dirname)
+    one.must_equal File.expand_path(dirname), "Should show absolute path"
+    two.must_equal File.expand_path(dirname), "Should show absolute path"
+    three.must_equal File.expand_path(dirname), "Should show absolute path"
+    @siba_file.file_expand_path("~/#{dirname}").must_equal File.expand_path("~/#{dirname}"), "Path relative to home folder"
+    tmp_dir = mkdir_in_tmp_dir "f-e-p"
+    Siba.current_dir = tmp_dir
+    tmp_dir2 = mkdir_in_tmp_dir "f-e-p2"
+    siba_file.file_utils_cd tmp_dir2
+    @siba_file.file_expand_path("#{dirname}").must_equal File.join(tmp_dir,dirname), "Path relative to Siba.current_dir"
+  end
+end