vagrant-mongodb 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+pkg
+Gemfile.lock
+test/.vagrant

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Shawn Dahlen
+
+MIT License
+
+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,51 @@
+Vagrant MongoDb
+===============
+`vagrant-mongodb` is a Vagrant 1.1+ plugin that supports the configuration
+and initiation of a MongoDb replica set. The longer-term goal is to support
+various MongoDb administrative tasks.
+
+Status
+------
+The current implementation is a proof-of-concept supporting the larger
+objective of using Vagrant as a cloud management interface for development
+and production environments.
+
+The plugin has been tested with Vagrant 1.1.4 and Ubuntu 12.04 guest.
+
+Installation
+------------
+Install the plugin following the typical Vagrant 1.1 procedure:
+
+    vagrant plugin install vagrant-mongodb
+
+Usage
+-----
+The MongoDb replica set must be configured within the project's `Vagrantfile`:
+
+```ruby
+config.mongodb.replset :rs0 do |rs|
+  rs.member :server1, :priority => 1
+  rs.member :server2, :priority => 2
+  rs.member :server3, :priority => 1
+end
+```
+
+The first argument to `rs.member` is the machine name defined within the
+configuration. The second argument is optional taking a hash of options
+for the replica set member. These options are defined within MongoDb's
+[replica set configuration reference][1].
+
+The plugin hooks into the `vagrant up` command automatically. It detects
+when all members of the replica set are available before calling 
+`rs.initiate()`. Communication with the replica set occurs over SSH using
+the `mongo` shell command.
+
+Contribute
+----------
+Contributions are welcome.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_helper'
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path("../", __FILE__))
+
+namespace :gem do
+  Bundler::GemHelper.install_tasks
+end
+
+task :test do
+  sh 'bash test/test.sh'
+end

data/lib/vagrant-mongodb.rb

@@ -0,0 +1,12 @@
+require 'vagrant'
+require 'vagrant-mongodb/version'
+require 'vagrant-mongodb/plugin'
+require 'vagrant-mongodb/errors'
+
+module VagrantPlugins
+  module MongoDb
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+  end
+end

data/lib/vagrant-mongodb/actions/replset_initiate.rb

@@ -0,0 +1,98 @@
+module VagrantPlugins
+  module MongoDb
+    module Actions
+      class ReplSetInitiate
+        include Vagrant::Util::Retryable
+
+        def initialize(app, env)
+          @app = app
+          @config = env[:global_config].mongodb
+          @machine = env[:machine]
+          @translator = Helpers::Translator.new('actions.replset_initiate')
+          @logger = Log4r::Logger.new('vagrant_mongodb::actions::replset_initiate')
+        end
+
+        def call(env)
+          @app.call(env)
+
+          # check if the current machine is a member of a replica set
+          @logger.info "Checking if '#{@machine.name}' is part of a replica set..."
+          rs = get_replset(@machine.name) if @config
+          return if !rs
+
+          # ensure all members are available before initiating replica set
+          if all_members_available?(rs)
+            env[:ui].info @translator.t('initiate', { :name => rs.name })
+            command = "mongo --eval 'printjson(rs.initiate(#{generate_json(rs)}))'"
+            env[:machine].communicate.execute(command) do |type, data|
+              raise Errors::ReplSetInitiateError if data =~ /"ok" : 0/
+            end
+          end
+        end
+
+        private
+
+        # return the replset containing the machine name
+        def get_replset(name)
+          @config.replsets.find do |rs|
+            rs.members.find do |member|
+              member[:host] == name
+            end
+          end
+        end
+
+        # check if the given machine has mongod running
+        def member_available?(machine)
+          @logger.info "Checking if '#{machine.name}' mongod is available..."
+          return false if !machine.communicate.ready?
+
+          # try executing the mongo command on the machine several times
+          # to allow for a process to start after provisioning
+          command = 'mongo --eval "db.runCommand({ ping: 1 })"'
+          retryable(:tries => 3, :sleep => 10) do
+            machine.communicate.execute(command)
+            @logger.info "'#{machine.name}' mongod is available..."
+          end
+          true
+        rescue
+          false
+        end
+
+        # check if all members of the replica set have mongod running
+        def all_members_available?(rs)
+          global_env = @machine.env
+          rs.members.each do |member|
+            machine = global_env.machine(member[:host], @machine.provider_name)
+            return false if !member_available?(machine)
+          end
+          true
+        end
+
+        # generate replica set JSON document replacing host name with ip
+        def generate_json(rs)
+          global_env = @machine.env
+          members = rs.members.dup
+          members.each do |member|
+            machine = global_env.machine(member[:host], @machine.provider_name)
+            member[:host] = get_ip_address(machine)
+            @logger.info "Using ip address '#{member[:host]}' for '#{@machine.name}'..."
+          end
+
+          { :_id => rs.name, :members => members }.to_json
+        end
+
+        # return the ip address of the given machine
+        def get_ip_address(machine)
+          ip = nil
+          machine.config.vm.networks.each do |network|
+            key, options = network[0], network[1]
+            ip = options[:ip] if key == :private_network
+            next if ip
+          end
+
+          ip || machine.ssh_info[:host]
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-mongodb/config.rb

@@ -0,0 +1,43 @@
+module VagrantPlugins
+  module MongoDb
+    class Config < Vagrant.plugin('2', :config)
+      attr_reader :replsets
+
+      def initialize
+        @replsets = []
+      end
+
+      # Override default merge behavior
+      # TODO look into merge strategy
+      def merge(other)
+        return self
+      end
+
+      def validate(machine)
+        # TODO check that member names have a matching vm definition
+        # TODO check that each replica set has 3+ members
+        # TODO warn if replica set has even number of members
+      end
+
+      def replset(name, &block)
+        rs = ReplSet.new(name)
+        block.call(rs)
+        @replsets << rs
+      end
+
+      class ReplSet
+        attr_reader :name
+        attr_reader :members
+
+        def initialize(name)
+          @name = name
+          @members = []
+        end
+
+        def member(name, options = {})
+          @members << options.merge({ :_id => @members.size, :host => name})
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-mongodb/errors.rb

@@ -0,0 +1,13 @@
+module VagrantPlugins
+  module MongoDb
+    module Errors
+      class MongoDbError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant_mongodb.errors")
+      end
+
+      class ReplSetInitiateError < MongoDbError
+        error_key(:initiate)
+      end
+    end
+  end
+end

data/lib/vagrant-mongodb/helpers/translator.rb

@@ -0,0 +1,20 @@
+module VagrantPlugins
+  module MongoDb
+    module Helpers
+      class Translator
+        def self.plugin_namespace=(val)
+          @@plugin_namespace = val
+        end
+
+        def initialize(namespace)
+          @namespace = namespace
+        end
+
+        def t(keys, opts = {})
+          value = I18n.t("#{@@plugin_namespace}.#{@namespace}.#{keys}", opts)
+          opts[:progress] == false ? value : value + "..."
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-mongodb/plugin.rb

@@ -0,0 +1,60 @@
+require 'vagrant-mongodb/helpers/translator'
+require 'vagrant-mongodb/actions/replset_initiate'
+
+module VagrantPlugins
+  module MongoDb
+    class Plugin < Vagrant.plugin('2')
+      name 'MongoDb'
+      description <<-DESC
+        This plugin manages a MongoDb replica set.
+      DESC
+
+      config(:mongodb) do
+        require_relative 'config'
+        Config
+      end
+
+      # initiate replica set after machine provisioning
+      action_hook(:replset_initiate, :machine_action_up) do |hook|
+        setup_logging
+        setup_i18n
+        hook.before(Vagrant::Action::Builtin::Provision, Actions::ReplSetInitiate)
+      end
+
+      def self.setup_i18n
+        I18n.load_path << File.expand_path(
+          'locales/en.yml',
+          MongoDb.source_root)
+        I18n.reload!
+
+        Helpers::Translator.plugin_namespace = 'vagrant_mongodb'
+      end
+
+      def self.setup_logging
+        level = nil
+        begin
+          level = Log4r.const_get(ENV['VAGRANT_LOG'].upcase)
+        rescue NameError
+          # This means that the logging constant wasn't found,
+          # which is fine. We just keep `level` as `nil`. But
+          # we tell the user.
+          level = nil
+        end
+
+        # Some constants, such as "true" resolve to booleans, so the
+        # above error checking doesn't catch it. This will check to make
+        # sure that the log level is an integer, as Log4r requires.
+        level = nil if !level.is_a?(Integer)
+
+        # Set the logging level on all "vagrant" namespaced
+        # logs as long as we have a valid level.
+        if level
+          logger = Log4r::Logger.new('vagrant_mongodb')
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          logger = nil
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-mongodb/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module MongoDb
+    VERSION = '0.0.1'
+  end
+end

data/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  vagrant_mongodb:
+    errors:
+      initiate: "Failed to initiate replica set"
+    actions:
+      replset_initiate:
+        initiate: "Initiating replica set '%{name}'"

data/test/Vagrantfile

@@ -0,0 +1,33 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure('2') do |config|
+  config.vm.box = 'precise64'
+  config.vm.box_url = 'http://files.vagrantup.com/precise64.box'
+
+  config.mongodb.replset :rs0 do |rs|
+    rs.member :server1, :priority => 1
+    rs.member :server2, :priority => 2
+    rs.member :server3, :priority => 1
+  end
+
+  script = <<-SCRIPT
+    apt-get -y install mongodb
+    echo 'replSet=rs0' >> /etc/mongodb.conf
+    sed -in '/^bind_ip/d' /etc/mongodb.conf
+    service mongodb restart
+  SCRIPT
+  config.vm.provision :shell, :inline => script
+
+  config.vm.define :server1 do |server|
+    server.vm.network :private_network, :ip => '10.0.5.2'
+  end
+
+  config.vm.define :server2 do |server|
+    server.vm.network :private_network, :ip => '10.0.5.3'
+  end
+
+  config.vm.define :server3 do |server|
+    server.vm.network :private_network, :ip => '10.0.5.4'
+  end
+end

data/test/test.sh

@@ -0,0 +1,11 @@
+gem build *.gemspec
+vagrant plugin install vagrant-mongodb
+
+cd test
+
+vagrant up
+sleep 30
+vagrant ssh server1 -c 'mongo --eval "printjson(rs.status())"'
+vagrant destroy -f
+
+cd ..

data/vagrant-mongodb.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-mongodb/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'vagrant-mongodb'
+  gem.version       = VagrantPlugins::MongoDb::VERSION
+  gem.authors       = ['Shawn Dahlen']
+  gem.email         = ['shawn@dahlen.me']
+  gem.description   = %q{A Vagrant plugin that manages a MongoDb replicaset}
+  gem.homepage      = 'https://github.com/smdahlen/vagrant-mongodb'
+  gem.summary       = gem.description
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-mongodb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Shawn Dahlen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-29 00:00:00.000000000 Z
+dependencies: []
+description: A Vagrant plugin that manages a MongoDb replicaset
+email:
+- shawn@dahlen.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vagrant-mongodb.rb
+- lib/vagrant-mongodb/actions/replset_initiate.rb
+- lib/vagrant-mongodb/config.rb
+- lib/vagrant-mongodb/errors.rb
+- lib/vagrant-mongodb/helpers/translator.rb
+- lib/vagrant-mongodb/plugin.rb
+- lib/vagrant-mongodb/version.rb
+- locales/en.yml
+- test/Vagrantfile
+- test/test.sh
+- vagrant-mongodb.gemspec
+homepage: https://github.com/smdahlen/vagrant-mongodb
+licenses: []
+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.23
+signing_key: 
+specification_version: 3
+summary: A Vagrant plugin that manages a MongoDb replicaset
+test_files:
+- test/Vagrantfile
+- test/test.sh