siba-source-mongo-db 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in siba-destination-mongo-db.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile           
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest', :notify=>false do
+  watch(%r|^test/unit/(.*\/)*test_(.*)\.rb|)
+  watch(%r|^lib/siba-source-mongo-db/(.*\/)*([^/]+)\.rb|) do |m| 
+    "test/unit/#{m[1]}test_#{m[2]}.rb" unless m[2][0] == '.' 
+  end
+end

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2012 Evgeny Neumerzhitskiy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+This is a plugin for [SIBA backup and restore utility](https://github.com/evgenyneu/siba). It allows to back and restore MongoDB.
+
+## Installation
+
+        $ gem install siba-sourcen-mongo-db
+
+## Usage
+
+Run `siba generate FILE` command to generate options file and select mongo-db as a source plugin. Edit the generated file and set your backup options.

data/Rakefile

@@ -0,0 +1,28 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'        
+
+namespace "test" do
+  desc "Run all unit tests"    
+  Rake::TestTask.new("unit") do |t|     
+    t.pattern = "test/unit/**/test*.rb"
+    t.libs << 'test'           
+  end
+
+  desc "Run all integration tests"
+  Rake::TestTask.new("integration") do |t|     
+    t.pattern = "test/integration/**/i9n_*.rb"
+    t.libs << 'test'           
+  end
+
+  desc "Run all integration tests"
+  task :i9n => ["test:integration"] do 
+  end
+end
+
+desc "Run all unit tests"
+task :test => ["test:unit"] do
+end
+
+desc "Run tests"               
+task :default => "test:unit"
+

data/lib/siba-source-mongo-db/db.rb

@@ -0,0 +1,100 @@
+# encoding: UTF-8
+
+module Siba::Source
+  module MongoDb                 
+    class Db
+      HIDE_PASSWORD_TEXT = "****p7d****"
+      include Siba::FilePlug
+      include Siba::LoggerPlug
+      attr_accessor :settings
+
+      def initialize(settings)
+        @settings = settings
+        check_installed
+      end
+
+      def check_installed
+        siba_file.run_this do
+          raise Siba::Error, "'mongodump' utility is not found. Please install mongodb." unless siba_file.shell_ok? "mongodump --help"
+          raise Siba::Error, "'mongorestore' utility is not found. Please install mongodb." unless siba_file.shell_ok? "mongorestore --help"
+          logger.info "Mongo backup utilities verified"
+        end
+      end
+
+      def backup(dest_dir)
+        siba_file.run_this do
+          unless Siba::FileHelper.dir_empty? dest_dir
+            raise Siba::Error, "Failed to backup MongoDB: output directory is not empty: #{dest_dir}"
+          end
+
+          command_without_password = %(mongodump -o "#{dest_dir}" #{get_shell_parameters})
+          command = command_without_password
+          unless settings[:password].nil?
+            command = command_without_password.gsub HIDE_PASSWORD_TEXT, settings[:password]
+          end
+          output = siba_file.run_shell command, "failed to backup MongoDb: #{command_without_password}"
+          raise Siba::Error, "failed to backup MongoDb: #{output}" if output =~ /ERROR:/
+
+          if Siba::FileHelper.dir_empty?(dest_dir)
+            raise Siba::Error, "Failed to backup MongoDB: dump directory is empty"
+          end
+
+          Siba::FileHelper.entries(dest_dir).each do |entry|
+            path_to_collection = File.join dest_dir, entry
+            next unless File.directory? path_to_collection
+            if Siba::FileHelper.dir_empty? path_to_collection
+              logger.warn "MongoDB collection/database name '#{entry}' is incorrect or it has no data."
+            end
+          end
+        end
+      end
+
+      def restore(from_dir)
+        siba_file.run_this do
+          if Siba::FileHelper.dirs_count(from_dir) == 0
+            raise Siba::Error, "Failed to restore MongoDB: backup directory is empty: #{from_dir}"
+          end
+
+          unless settings[:database].nil?
+            dirs = Siba::FileHelper.dirs from_dir
+            if dirs.size != 1
+              raise Siba::Error, "Dump should contain exactly one directory when restoring a single database"
+            end
+            from_dir = File.join from_dir, dirs[0]
+          end
+
+          command_without_password = %(mongorestore --drop #{get_shell_parameters} "#{from_dir}")
+          command = command_without_password
+          unless settings[:password].nil?
+            command = command_without_password.gsub HIDE_PASSWORD_TEXT, settings[:password]
+          end
+          output = siba_file.run_shell command, "failed to restore MongoDb: #{command_without_password}"
+          raise Siba::Error, "failed to restore MongoDb: #{output}" if output =~ /ERROR:/
+        end
+      end
+
+      def get_shell_parameters
+        params = []
+        params << "-h \"#{escape_for_shell settings[:host]}\"" unless settings[:host].nil?
+        params << "-u \"#{escape_for_shell settings[:username]}\"" unless settings[:username].nil?
+        params << "-p \"#{HIDE_PASSWORD_TEXT}\"" unless settings[:password].nil?
+        params << "-d \"#{escape_for_shell settings[:database]}\"" unless settings[:database].nil?
+        params << "-c \"#{escape_for_shell settings[:collection]}\"" unless settings[:collection].nil?
+        params.join " "
+      end
+
+      def escape_for_shell(str)
+        str.gsub "\"", "\\\""
+      end
+
+      def db_and_collection_names
+        names = []
+        names << "db: #{settings[:database]}" unless settings[:database].nil?
+        names << "collection: #{settings[:collection]}" unless settings[:collection].nil?
+        out = names.join(", ")
+        out = " > " + out unless out.empty?
+        out
+      end
+    end
+  end
+end  

data/lib/siba-source-mongo-db/init.rb

@@ -0,0 +1,40 @@
+# encoding: UTF-8
+
+require 'siba-source-mongo-db/db'
+
+module Siba::Source
+  module MongoDb                 
+    class Init                 
+      include Siba::LoggerPlug
+      attr_accessor :db
+      
+      def initialize(options)
+        host = Siba::SibaCheck.options_string options, "host", true
+        username = Siba::SibaCheck.options_string options, "username", true
+        password = Siba::SibaCheck.options_string options, "password", true
+        database = Siba::SibaCheck.options_string options, "database", true
+        collection = Siba::SibaCheck.options_string options, "collection", true
+        @db = Siba::Source::MongoDb::Db.new({
+          host: host, 
+          username: username, 
+          password: password, 
+          database: database, 
+          collection: collection})
+      end                      
+
+      # Collect source files and put them into dest_dir
+      # No return value is expected
+      def backup(dest_dir)
+        logger.info "Dumping MongoDb#{db.db_and_collection_names}"
+        @db.backup dest_dir
+      end
+
+      # Restore source files from_dir 
+      # No return value is expected
+      def restore(from_dir)
+        logger.info "Restoring MongoDb#{db.db_and_collection_names}"
+        @db.restore from_dir
+      end      
+    end
+  end
+end

data/lib/siba-source-mongo-db/options.yml

@@ -0,0 +1,6 @@
+host: "hostname:port" # port is optional
+username:
+password:
+database: # all databases if missing
+collection: # all collections if missing
+# Note: all above MongoDB settings are optional

data/lib/siba-source-mongo-db/version.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+
+module Siba
+  module Source
+    module MongoDb
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/siba-source-mongo-db.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+require "siba-source-mongo-db/version"
+require "siba-source-mongo-db/init"
+
+module Siba
+  module Source
+    module MongoDb
+    end
+  end
+end

data/siba-source-mongo-db.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "siba-source-mongo-db/version"
+
+Gem::Specification.new do |s|
+  s.name        = "siba-source-mongo-db"
+  s.version     = Siba::Source::MongoDb::VERSION
+  s.authors     = ["Evgeny Neumerzhitskiy"]
+  s.email       = ["sausageskin@gmail.com"]
+  s.homepage    = "https://github.com/evgenyneu/siba-source-mongo-db"
+  s.license     = "MIT"
+  s.summary     = %q{MongoDB backup and restore extention for SIBA utility}
+  s.description = %q{An extension for SIBA backup and restore utility. It allows to backup and restore MongoDB database.}
+
+  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.add_runtime_dependency     'siba', '~>0.5'
+
+  s.add_development_dependency  'minitest', '~>2.10'
+  s.add_development_dependency  'rake', '~>0.9'
+  s.add_development_dependency  'guard-minitest', '~>0.4'
+end

data/test/helper/require_integration.rb

@@ -0,0 +1,5 @@
+# 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/i9n_db.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+
+require 'helper/require_integration'
+require 'siba-source-mongo-db/init'
+
+# Integration test example
+# 'rake test:i9n' command runs integration tests
+describe Siba::Source::MongoDb::Db do
+  before do
+    @cls = Siba::Source::MongoDb::Db
+  end
+
+  it "should init" do
+    @cls.new({})  
+  end
+
+  it "should backup and restore" do
+    out_dir = mkdir_in_tmp_dir "mongob"
+    @cls.new({database: "sibatest"}).backup out_dir
+    Siba::FileHelper.dir_empty?(out_dir).must_equal false
+
+    @cls.new({database: "sibatest"}).restore out_dir
+  end
+end

data/test/unit/test_db.rb

@@ -0,0 +1,54 @@
+# encoding: UTF-8
+
+require 'helper/require_unit'
+require 'siba-source-mongo-db/init'
+
+describe Siba::Source::MongoDb::Db do
+  before do                    
+    @cls = Siba::Source::MongoDb::Db
+  end
+
+  it "should init" do 
+    settings= {one: "two"}
+    @obj = @cls.new settings
+    @obj.settings.must_equal settings
+  end
+
+  it "should backup" do 
+    @obj = @cls.new({})
+    @obj.backup("/dest_dir")
+  end
+
+  it "should restore" do 
+    @obj = @cls.new({})
+    @obj.restore("/from_dir")
+  end
+
+  it "should call get_shell_parameters" do
+    settings = {
+      host: "host:port",
+      username: "uname",
+      password: "my password",
+      database: "dbname",
+      collection: "db collection"}
+    @obj = @cls.new(settings)
+    params = @obj.get_shell_parameters
+    settings.each do |key,value|
+      params.must_include %("#{value}") if key != :password
+      params.must_include %("#{@cls::HIDE_PASSWORD_TEXT}") if key == :password
+    end
+  end
+
+  it "should espace for shell" do
+    @obj = @cls.new({})
+    @obj.escape_for_shell("hi\"").must_equal "hi\\\""
+  end
+
+  it "should call db_and_collection_names" do
+    @obj = @cls.new({})
+    @obj.db_and_collection_names.must_be_empty
+
+    @obj = @cls.new({database:"mydb"})
+    @obj.db_and_collection_names.must_include "mydb"
+  end
+end

data/test/unit/test_init.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+
+require 'helper/require_unit'
+require 'siba-source-mongo-db/init'
+
+describe Siba::Source::MongoDb::Init do
+  before do                    
+    @yml_path = File.expand_path('../yml', __FILE__)
+    @plugin_category = "source"      
+    @plugin_type = "mongo-db"         
+  end
+
+  it "siba should load plugin" do 
+    options = load_options "valid"
+    plugin = create_plugin "empty" 
+    plugin = Siba::Source::MongoDb::Init.new({})
+    plugin = create_plugin "valid"
+    plugin.db.must_be_instance_of Siba::Source::MongoDb::Db
+    plugin.db.settings[:host].must_equal options["host"]
+    plugin.db.settings[:username].must_equal options["username"]
+    plugin.db.settings[:password].must_equal options["password"]
+    plugin.db.settings[:database].must_equal options["database"]
+    plugin.db.settings[:collection].must_equal options["collection"]
+  end
+
+  it "should call backup" do
+    create_plugin("valid").backup "/dest_dir"
+  end
+
+  it "should call restore" do
+    create_plugin("valid").restore "/from_dir"
+  end
+
+end

data/test/unit/yml/empty.yml

@@ -0,0 +1 @@
+name: value

data/test/unit/yml/valid.yml

@@ -0,0 +1,5 @@
+host: "host:post"
+username: user
+password: password
+database: database
+collection: collection

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: siba-source-mongo-db
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Evgeny Neumerzhitskiy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: siba
+  requirement: &75282640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: *75282640
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &75297850 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: *75297850
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &75296690 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *75296690
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: &75295580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: *75295580
+description: An extension for SIBA backup and restore utility. It allows to backup
+  and restore MongoDB database.
+email:
+- sausageskin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/siba-source-mongo-db.rb
+- lib/siba-source-mongo-db/db.rb
+- lib/siba-source-mongo-db/init.rb
+- lib/siba-source-mongo-db/options.yml
+- lib/siba-source-mongo-db/version.rb
+- siba-source-mongo-db.gemspec
+- test/helper/require_integration.rb
+- test/helper/require_unit.rb
+- test/integration/i9n_db.rb
+- test/unit/test_db.rb
+- test/unit/test_init.rb
+- test/unit/yml/empty.yml
+- test/unit/yml/valid.yml
+homepage: https://github.com/evgenyneu/siba-source-mongo-db
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: MongoDB backup and restore extention for SIBA utility
+test_files: []