vagrant-mongodb 0.0.3 → 0.1.0

data/README.md

@@ -1,29 +1,33 @@
 Vagrant MongoDb
 ===============
-`vagrant-mongodb` is a Vagrant 1.1+ plugin that supports the configuration
+`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.
+The plugin communicates with the replica set members over SSH using the
+`mongo` command.
 
-Installation
-------------
+The plugin has been tested with Vagrant 1.1.5 and a Ubuntu 12.04 guest.
+
+Install
+-------
 Install the plugin following the typical Vagrant 1.1 procedure:
 
-    vagrant plugin install vagrant-mongodb
+    $ vagrant plugin install vagrant-mongodb
 
-Usage
------
+Configure
+---------
 The MongoDb replica set must be configured within the project's `Vagrantfile`:
 
 ```ruby
+config.mongodb.auto_initiate = false
+
 config.mongodb.replset :rs0 do |rs|
+  rs.ignore_private_ip = false
   rs.member :server1, :priority => 1
   rs.member :server2, :priority => 2
   rs.member :server3, :priority => 1
@@ -31,21 +35,43 @@ 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
+configuration. The second argument is optional accepting 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.
+By default, the plugin will lookup and use a static IP address for a
+member machine if a private network is specified. To disable this, set
+the replica set attribute, `ignore_private_ip`, to false.
+
+To disable the plugin hooks and initiate a replica set manually, set the
+`auto_initiate` attribute to false.
+
+*NOTE*: The plugin does not support configuration defined within a
+multi-machine `define` block.
+
+Run
+---
+By default, the plugin hooks into the `vagrant up` and `vagrant provision`
+commands. It will detect when a replica set's members are available and
+and call initiate.
+
+To manually initiate a replica set, invoke the following sub-command:
+
+    $ vagrant mongodb initiate db0 --provider <provider>
+
+`db0` is a machine defined within the `Vagrantfile` belonging to a
+replica set that will be initiated. The provider may be specified to
+initiate a replica set not backed by VirtualBox.
 
 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
+1. Fork the project
+1. Clone the forked repository
+1. Install project dependencies (`bundle install`)
+1. Confirm tests pass (`bundle exec rake test`)
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create new Pull Request

data/lib/vagrant-mongodb.rb

@@ -1,4 +1,3 @@
-require 'vagrant'
 require 'vagrant-mongodb/version'
 require 'vagrant-mongodb/plugin'
 require 'vagrant-mongodb/errors'
@@ -8,5 +7,8 @@ module VagrantPlugins
     def self.source_root
       @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
     end
+
+    I18n.load_path << File.expand_path('locales/en.yml', source_root)
+    I18n.reload!
   end
 end

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

@@ -0,0 +1,134 @@
+module VagrantPlugins
+  module MongoDb
+    module Actions
+      class Initiate
+        include Vagrant::Util::Retryable
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @rs = replica_set
+          @logger = Log4r::Logger.new('vagrant::mongodb::initiate')
+        end
+
+        def call(env)
+          @app.call(env)
+
+          # check if machine belongs to a configured replica set
+          return unless @rs
+
+          # check if auto initiate is enabled
+          return unless @machine.config.mongodb.auto_initiate
+
+          # check if the replica set is already initiated
+          if initiated?
+            env[:ui].info I18n.t('vagrant_mongodb.info.initiated', {
+              :name => @rs.name
+            })
+            return
+          end
+            
+          env[:ui].info I18n.t('vagrant_mongodb.info.checking', {
+            :name => @rs.name
+          })
+
+          if all_members_available?
+            env[:ui].info I18n.t('vagrant_mongodb.info.initiating', {
+              :name => @rs.name
+            })
+
+            # execute rs.initiate() on first replica set member
+            command = "mongo --eval 'printjson(rs.initiate(#{generate_json}))'"
+            @machine.communicate.execute(command) do |type, data|
+              raise Errors::InitiateError if data =~ /"ok" : 0/
+            end
+
+            # wait until the replica set is initiated
+            retryable(:tries => 6, :sleep => 30) do
+              raise 'not ready' if !initiated?
+            end
+          end
+        end
+
+        private
+
+        # return the replset the machine is a member of
+        def replica_set
+          return nil if @machine.config.mongodb.nil?
+
+          @machine.config.mongodb.replsets.find do |rs|
+            rs.members.find do |member|
+              member[:host] == @machine.name
+            end
+          end
+        end
+
+        # check if the replica set has already been initiated
+        def initiated?
+          @logger.info "Checking if '#{@rs.name}' has already been initiated"
+          command = "mongo --eval 'printjson(rs.status())'"
+          @machine.communicate.execute(command) do |type, data|
+            return true if data =~ /"ok" : 1/
+          end
+
+          false
+        rescue Vagrant::Errors::VagrantError
+          false
+        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.members.each do |member|
+            machine = @machine.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
+          members = []
+          @rs.members.each do |member|
+            machine = @machine.env.machine(member[:host], @machine.provider_name)
+            copy = member.dup
+            copy[:host] = get_ip_address(machine)
+            members << copy
+          end
+
+          { :_id => @rs.name, :members => members }.to_json
+        end
+
+        # return the ip address of the given machine
+        def get_ip_address(machine)
+          ip = nil
+          unless @rs.ignore_private_ip
+            machine.config.vm.networks.each do |network|
+              key, options = network[0], network[1]
+              ip = options[:ip] if key == :private_network
+              next if ip
+            end
+          end
+
+          ip || machine.ssh_info[:host]
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-mongodb/commands.rb

@@ -0,0 +1,21 @@
+module VagrantPlugins
+  module MongoDb
+    module Commands
+      class Commands < Vagrant.plugin('2', :command)
+        def initialize(argv, env)
+          super
+          @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)
+        end
+
+        # TODO refactor to lookup generic commands
+        # TODO display help if no sub command is provided
+        def execute
+          return if @sub_command.downcase != 'initiate'
+
+          require_relative 'commands/initiate'
+          Initiate.new(@sub_args, @env).execute
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-mongodb/commands/initiate.rb

@@ -0,0 +1,42 @@
+module VagrantPlugins
+  module MongoDb
+    module Commands
+      class Initiate < Vagrant.plugin('2', :command)
+
+        def execute
+          options = {}
+          opts = OptionParser.new do |o|
+            o.banner = 'Usage: vagrant mongodb initiate [vm-name]'
+            o.separator ''
+
+            o.on('--provider provider', String,
+              'Initiates replica set with the specific provider.') do |provider|
+              options[:provider] = provider
+            end
+          end
+
+          argv = parse_options(opts)
+          options[:provider] ||= @env.default_provider
+          options[:single_target] = true
+
+          with_target_vms(argv, options) do |machine|
+
+            if machine.config.mongodb
+              machine.config.mongodb.auto_initiate = true
+
+              env = { :machine => machine, :ui => @env.ui }
+              callable = Vagrant::Action::Builder.new.tap do |b|
+                b.use Vagrant::Action::Builtin::ConfigValidate
+                b.use Actions::Initiate
+              end
+
+              @env.action_runner.run(callable, env)
+            end
+          end
+
+          0
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-mongodb/config.rb

@@ -2,27 +2,46 @@ module VagrantPlugins
   module MongoDb
     class Config < Vagrant.plugin('2', :config)
       attr_reader :replsets
+      attr_accessor :auto_initiate
 
       def initialize
         @replsets = []
-        @translator = Helpers::Translator.new('config')
+        @auto_initiate = UNSET_VALUE
       end
 
-      # override default merge behavior
-      # TODO look into merge strategy
+      # TODO look into appropriate merge strategy
       def merge(other)
-        return self
+        # other.replsets.each do |o|
+        #   rs = @replsets.find { |r| r.name == o.name }
+        #   if rs
+        #     o.members.each do |member|
+        #       rs.member member[:host], member
+        #     end
+        #   else
+        #     @replsets << other
+        #   end
+        # end
+
+        # self
+      end
+
+      def finalize!
+        @auto_initiate = true if @auto_initiate == UNSET_VALUE
       end
 
       def validate(machine)
         errors = []
         @replsets.each do |rs|
           if rs.members.size < 3
-            errors << @translator.t('replset_size', { :name => rs.name })
+            errors << I18n.t('vagrant_mongodb.config.replica_set_size', {
+              :name => rs.name
+            })
           end
           rs.members.each do |m|
             if !machine.env.machine_names.find { |name| name == m[:host] }
-              errors << @translator.t('unknown_member', { :member => m[:host] })
+              errors << I18n.t('vagrant_mongodb.config.unknown_member', {
+                :member => m[:host]
+              })
             end
           end
         end
@@ -33,27 +52,33 @@ module VagrantPlugins
       def replset(name, &block)
         rs = @replsets.find { |r| r.name == name.to_sym }
         if !rs
-          rs = ReplSet.new(name)
+          rs = ReplicaSet.new(name)
           @replsets << rs
         end
         block.call(rs)
       end
 
-      class ReplSet
+      class ReplicaSet
         attr_reader :name
         attr_reader :members
+        attr_accessor :ignore_private_ip
 
         def initialize(name)
           @name = name.to_sym
           @members = []
+          @ignore_private_ip = false
         end
 
         def member(name, options = {})
           member = @members.find { |m| m[:host] == name.to_sym }
           if member
+            options.delete(:_id)
             member.merge!(options)
           else
-            @members << options.merge({ :_id => @members.size, :host => name.to_sym })
+            @members << options.merge({
+              :_id => @members.size,
+              :host => name.to_sym
+            })
           end
         end
       end

data/lib/vagrant-mongodb/errors.rb

@@ -5,7 +5,7 @@ module VagrantPlugins
         error_namespace("vagrant_mongodb.errors")
       end
 
-      class ReplSetInitiateError < MongoDbError
+      class InitiateError < MongoDbError
         error_key(:initiate)
       end
     end

data/lib/vagrant-mongodb/plugin.rb

@@ -1,18 +1,16 @@
-require 'vagrant-mongodb/helpers/translator'
-require 'vagrant-mongodb/actions/replset_initiate'
+require 'vagrant-mongodb/actions/initiate'
 
 module VagrantPlugins
   module MongoDb
     class Plugin < Vagrant.plugin('2')
       name 'MongoDb'
       description <<-DESC
-        This plugin manages a MongoDb replica set.
+        A Vagrant plugin that supports the configuration and initation
+        of a MongoDb replica set.
       DESC
 
-      def self.replset_initiate(hook)
-        setup_logging
-        setup_i18n
-        hook.before(Vagrant::Action::Builtin::Provision, Actions::ReplSetInitiate)
+      def self.initiate(hook)
+        hook.prepend(Actions::Initiate)
       end
 
       config(:mongodb) do
@@ -20,44 +18,14 @@ module VagrantPlugins
         Config
       end
 
-      # initiate replica set after machine provisioning
-      action_hook(:replset_initiate, :machine_action_provision, &method(:replset_initiate))
-      action_hook(:replset_initiate, :machine_action_up, &method(:replset_initiate))
-
-      def self.setup_i18n
-        I18n.load_path << File.expand_path(
-          'locales/en.yml',
-          MongoDb.source_root)
-        I18n.reload!
-
-        Helpers::Translator.plugin_namespace = 'vagrant_mongodb'
+      command(:mongodb) do
+        require_relative 'commands'
+        Commands::Commands
       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
+      # initiate replica set after machine provisioning
+      action_hook(:mongodb, :machine_action_provision, &method(:initiate))
+      action_hook(:mongodb, :machine_action_up, &method(:initiate))
     end
   end
 end

data/lib/vagrant-mongodb/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module MongoDb
-    VERSION = '0.0.3'
+    VERSION = '0.1.0'
   end
 end

data/locales/en.yml

@@ -3,8 +3,9 @@ en:
     errors:
       initiate: "Failed to initiate replica set"
     config:
-      replset_size: "'%{name}' replica set requires a minimum of 3 members" 
+      replica_set_size: "'%{name}' replica set requires a minimum of 3 members" 
       unknown_member: "'%{member}' member is not defined"
-    actions:
-      replset_initiate:
-        initiate: "Initiating replica set '%{name}'"
+    info:
+      checking: "Checking if replica set '%{name}' is ready..."
+      initiating: "Initiating replica set '%{name}'..."
+      initiated: "Replica set '%{name}' already initiated."    

data/test/test.sh

@@ -1,9 +1,7 @@
 cd test
 
 vagrant up
-sleep 30
 vagrant ssh server1 -c 'mongo --eval "printjson(rs.status())"'
-vagrant provision
 vagrant destroy -f
 
 cd ..

data/vagrant-mongodb.gemspec

@@ -8,7 +8,10 @@ Gem::Specification.new do |gem|
   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.description   = <<-DESC
+                        A Vagrant plugin that supports the configuration
+                        and initation of a MongoDb replica set.
+                      DESC
   gem.homepage      = 'https://github.com/smdahlen/vagrant-mongodb'
   gem.summary       = gem.description
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-mongodb
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-04 00:00:00.000000000 Z
+date: 2013-04-12 00:00:00.000000000 Z
 dependencies: []
-description: A Vagrant plugin that manages a MongoDb replicaset
+description: ! "                        A Vagrant plugin that supports the configuration\n
+  \                       and initation of a MongoDb replica set.\n"
 email:
 - shawn@dahlen.me
 executables: []
@@ -24,10 +25,11 @@ files:
 - README.md
 - Rakefile
 - lib/vagrant-mongodb.rb
-- lib/vagrant-mongodb/actions/replset_initiate.rb
+- lib/vagrant-mongodb/actions/initiate.rb
+- lib/vagrant-mongodb/commands.rb
+- lib/vagrant-mongodb/commands/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
@@ -57,7 +59,9 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: A Vagrant plugin that manages a MongoDb replicaset
+summary: A Vagrant plugin that supports the configuration and initation of a MongoDb
+  replica set.
 test_files:
 - test/Vagrantfile
 - test/test.sh
+has_rdoc: 

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

@@ -1,112 +0,0 @@
-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 and the
-          # replica set has not already been initiated
-          @logger.info "Checking if '#{@machine.name}' is part of a replica set..."
-          rs = get_replset(@machine.name) if @config
-          return if !rs or already_initiated?(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)}))'"
-            @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
-
-        # check if the replica set has already been initiated
-        def already_initiated?(rs)
-          @logger.info "Checking if '#{rs.name}' has already been initiated..."
-          command = "mongo --eval 'printjson(rs.status())'"
-          begin
-            @machine.communicate.execute(command) do |type, data|
-              return true if data =~ /"ok" : 1/
-            end
-          rescue Vagrant::Errors::VagrantError
-          end
-          false
-        end
-      end
-    end
-  end
-end

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

@@ -1,20 +0,0 @@
-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