vagrant-config_builder 0.1.0 → 0.2.0

data/CHANGELOG

@@ -0,0 +1,26 @@
+CHANGELOG
+=========
+
+0.2.0
+-----
+
+2013-08-16
+
+This is a backwards compatible bugfix and feature release.
+
+### User notes
+
+#### Enhancements
+
+  * (GH-10) Add support to vm model for hostname.
+
+#### Bugfixes
+
+  * (GH-9) Correctly merge VM attributes by concatentating arrays.
+
+0.1.0
+-----
+
+2013-08-08
+
+Initial release.

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+end

data/README.markdown

@@ -51,6 +51,7 @@ for clarity.
         name: db
         private_networks: [ {ip: '10.20.1.2'} ]
         box: centos-5-i386
+        hostname: db.puppetlabs.vm
         roles: bigvm
       -
         name: web
@@ -60,6 +61,16 @@ for clarity.
 Installation
 ------------
 
-Installation into the Vagrant internal gems:
+### Installation into the Vagrant internal gems:
 
   * `vagrant plugin install vagrant-config_builder`
+
+### Installation from source
+
+Build the gem:
+
+  * `gem build vagrant-config_builder.gemspec`
+
+Install the gem:
+
+  * `gem install vagrant-config_builder-<version>.gem`

data/lib/config_builder/class_registry.rb

@@ -7,7 +7,13 @@ module ConfigBuilder
   # @api private
   class ClassRegistry
 
-    class UnknownEntryError < Vagrant::Errors::VagrantError; end
+    class UnknownEntry < Vagrant::Errors::VagrantError
+      error_key('unknown_entry', 'config_builder.class_registry')
+    end
+
+    class DuplicateEntry < Vagrant::Errors::VagrantError
+      error_key('duplicate_entry', 'config_builder.class_registry')
+    end
 
     def initialize(name)
       @name    = name
@@ -21,7 +27,12 @@ module ConfigBuilder
     #
     # @return [void]
     def register(identifier, klass)
-      @klasses[identifier] = klass
+      if @klasses[identifier]
+        raise DuplicateEntry, :registry => @name,
+                              :identifiers => @klasses.keys
+      else
+        @klasses[identifier] = klass
+      end
     end
 
     # Retrieve a class associated with the specified identifier
@@ -33,7 +44,9 @@ module ConfigBuilder
       if (klass = @klasses[identifier])
         klass
       else
-        raise UnknownEntryError, "#{self.inspect} doesn't have an entry registered with key #{identifier.inspect}"
+        raise UnknownEntry, :registry  => @name,
+                            :identifier => identifier.inspect,
+                            :identifiers => @klasses.keys
       end
     end
 
@@ -44,7 +57,8 @@ module ConfigBuilder
     #
     # @return [Object] The generated object
     def generate(hash)
-      identifier = hash.delete('type')
+      config = hash.dup
+      identifier = config.delete('type')
 
       klass = retrieve(identifier)
 
@@ -52,7 +66,7 @@ module ConfigBuilder
     end
 
     def inspect
-      "<#{self.class}: (#{@name})>"
+      "<#{self.class}: (#{@name}) keys: #{@klasses.keys.inspect}>"
     end
   end
 end

data/lib/config_builder/extension_handler.rb

@@ -0,0 +1,22 @@
+module ConfigBuilder
+  # Welcome to hell.
+  # @api private
+  class ExtensionHandler
+    def initialize
+      @logger = Log4r::Logger.new('vagrant::config_builder::extension_handler')
+    end
+
+    def load_from_plugins
+      Vagrant.plugin('2').manager.registered.each do |plugin|
+        load_plugin(plugin)
+      end
+    end
+
+    def load_plugin(plugin)
+      if plugin.respond_to? :config_builder_hook
+        @logger.info "Loading config_builder extension #{plugin.inspect}"
+        plugin.config_builder_hook
+      end
+    end
+  end
+end

data/lib/config_builder/filter/roles.rb

@@ -1,64 +1,75 @@
+# The 'roles' filter adds a mechanism for defining generic VM roles and
+# applying them to VMs.
+#
+# Defining roles
+# --------------
+#
+# This filter adds support for a top level `roles` key. It contains a hash of
+# role names that define a hash containing the role behavior.
+#
+# @note: The 'vms' field is of type Array, while the 'roles' field is of type
+# Hash. This is because order of declaration matters for the actual VMs, while
+# the order of declaration of roles does not matter.
+#
+# @example
+#   >> hash_config
+#   =>  {
+#         'roles' => {
+#           'webserver' => {
+#             'synced_folders' => [
+#               {'host_path' => './www',                'guest_path' => '/var/www'},
+#               {'host_path' => './webserver-binaries', 'guest_path' => '/opt/webserver-binaries'},
+#             ]
+#           },
+#           'database' => {
+#             'provisioners' => [
+#               {'type' => 'puppet', 'manifest' => 'dbserver.pp'},
+#               {'type' => 'shell',  'path'     => 'scripts/initialize-db.sh'},
+#             ],
+#           }
+#         },
+#         'vms' => [
+#           {'name' => 'web',        'roles' => 'webserver'},
+#           {'name' => 'db',         'roles' => 'database'},
+#           {'name' => 'standalone', 'roles' => ['webserver', 'database']},
+#         ],
+#       }
+#
 class ConfigBuilder::Filter::Roles
 
-  def run(input)
-    strip_filter_data(input)
+  def run(hash_config)
+    @roles = hash_config.delete('roles')
 
-    vms = @vms.map { |vm_hash| filter_vm(vm_hash) }
+    hash_config['vms'].map! { |vm_hash| filter_vm(vm_hash) }
 
-    add_filtered_data(input, vms)
-
-    input
+    hash_config
   end
 
   private
 
-  def strip_filter_data(input)
-    @roles = input.delete('roles')
-    @vms   = input.delete('vms')
-  end
-
-  def add_filtered_data(input, vms)
-    input['vms'] = vms
-  end
-
-  def filter_vm(vm_hash)
-    role_names = roles_for_vm(vm_hash.delete('roles'))
-
-    new_vm_hash = merge_role_definitions(role_names)
-    new_vm_hash.merge!(vm_hash)
+  def filter_vm(old_vm)
+    role_list  = old_vm.delete('roles')
+    node_stack = roles_for_vm(role_list)
 
-    new_vm_hash
-  end
-
-  # Generate a hash of all the merged roles. Roles specified later in the hash
-  # overwrite earlier roles.
-  #
-  # @param names [Hash]
-  #
-  # @return [Hash]
-  def merge_role_definitions(role_names)
-    vm_template = {}
+    node_stack << old_vm
 
-    role_names.each do |name|
-      role_definition = @roles[name]
-      vm_template.merge!(role_definition)
+    new_vm = node_stack.inject({}) do |accumulator, role|
+      merge_nodes(accumulator, role)
     end
 
-    vm_template
+    new_vm
   end
 
   # @return [Array]
   def roles_for_vm(role_field)
+
     case role_field
-    when Array
-      rval = role_field
-    when String
-      rval = [role_field]
-    when NilClass
-      rval = []
+    when Array    then names = role_field
+    when String   then names = [role_field]
+    when NilClass then names = []
     end
 
-    rval
+    names.map { |name| role_definition(name) }
   end
 
   def role_definition(name)
@@ -68,4 +79,39 @@ class ConfigBuilder::Filter::Roles
       raise "Couldn't find role named #{name.inspect} in roles #{@roles.keys.inspect}"
     end
   end
+
+  # Merge two node hash structures, with values in `right` overwriting values
+  # in `left`.
+  #
+  # @param left  [Hash]
+  # @param right [Hash]
+  #
+  # @return [Hash]
+  def merge_nodes(left, right)
+    retval = right.clone
+
+    array_keys = %w[
+      provisioners
+      synced_folders
+      forwarded_ports
+      private_networks
+      public_networks
+    ]
+
+    array_keys.each do |key|
+      if (left[key] and right[key])
+        retval[key] += left[key]
+      elsif left[key]
+        retval[key] = left[key]
+      end
+    end
+
+    single_keys = %w[provider box name]
+
+    single_keys.each do |key|
+      retval[key] = left[key] if left[key]
+    end
+
+    retval
+  end
 end

data/lib/config_builder/model/network/private_network.rb

@@ -9,7 +9,7 @@ class ConfigBuilder::Model::Network::PrivateNetwork < ConfigBuilder::Model::Base
 
   def to_proc
     Proc.new do |vm_config|
-      vm_config.network(:private_network, :ip => attr(:ip))
+      vm_config.network(:private_network, @attrs)
     end
   end
 end

data/lib/config_builder/model/vm.rb

@@ -70,6 +70,10 @@ class ConfigBuilder::Model::VM < ConfigBuilder::Model::Base
   #   @return [String] The name of the instantiated box in this environment
   def_model_attribute :name
 
+  # @!attribute [rw] hostname
+  #   @return [String] The hostname the machine should have.
+  def_model_attribute :hostname
+
   def initialize
     @defaults = {
       :provisioners     => [],
@@ -85,6 +89,7 @@ class ConfigBuilder::Model::VM < ConfigBuilder::Model::Base
         vm_config = config.vm
 
         vm_config.box = attr(:box) if defined? attr(:box)
+        vm_config.hostname = attr(:hostname) if defined? attr(:hostname)
 
         eval_models(vm_config)
       end

data/lib/config_builder/model.rb

@@ -6,8 +6,6 @@ module ConfigBuilder
 
   module Model
 
-    class UnknownAttributeError < Vagrant::Errors::VagrantError; end
-
     require 'config_builder/model/base'
 
     require 'config_builder/model/root'

data/lib/config_builder/runner.rb

@@ -1,11 +1,14 @@
 require 'config_builder/loader'
 require 'config_builder/filter_stack'
 require 'config_builder/model'
+require 'config_builder/extension_handler'
 
 module ConfigBuilder
   class Runner
 
     def run(identifier, method, value)
+      load_extensions
+
       data = ConfigBuilder::Loader.generate(identifier, method, value)
       filtered_data = run_filters(data)
       model = generate_model(filtered_data)
@@ -13,6 +16,11 @@ module ConfigBuilder
 
     private
 
+    def load_extensions
+      ext = ConfigBuilder::ExtensionHandler.new
+      ext.load_from_plugins
+    end
+
     def run_filters(data)
       stack = ConfigBuilder::FilterStack.new
       stack.filter(data)

data/lib/config_builder/version.rb

@@ -1,3 +1,3 @@
 module ConfigBuilder
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/config_builder.rb

@@ -11,4 +11,14 @@ module ConfigBuilder
     runner = ConfigBuilder::Runner.new
     runner.run(identifier, method, value)
   end
+
+  def self.source_root
+    @source_root ||= File.expand_path('..', __FILE__)
+  end
+
+  def self.template_root
+    @template_root ||= File.expand_path('../templates', source_root)
+  end
 end
+
+I18n.load_path << File.join(ConfigBuilder.template_root, 'locales/en.yml')

data/spec/config_builder/filter/roles_spec.rb

@@ -0,0 +1,245 @@
+require 'spec_helper'
+
+describe ConfigBuilder::Filter::Roles do
+
+  def dup(o)
+    Marshal.load(Marshal.dump(o))
+  end
+
+  let(:roles) do
+    {
+      'shell-provisioner' => {
+        'provisioners' => [
+          {'type' => 'shell', 'inline' => '/usr/bin/sl'},
+        ],
+      },
+      'puppet-provisioner' => {
+        'provisioners' => [
+          {'type' => 'puppet', 'manifest' => 'sl.pp'},
+          {'type' => 'puppet', 'manifest' => 'starwars.pp'},
+        ],
+      },
+      'potato-provisioner' => {
+        'provisioners' => [
+          {'type' => 'potato', 'potato' => 'POHTAHTO.pp'},
+        ],
+      },
+      'folders-12' => {
+        'synced_folders' => [
+          {'guest_path' => '/guest-1', 'host_path' => './host-1'},
+          {'guest_path' => '/guest-2', 'host_path' => './host-2'},
+        ],
+      },
+      'folders-34' => {
+        'synced_folders' => [
+          {'guest_path' => '/guest-3', 'host_path' => './host-3'},
+          {'guest_path' => '/guest-4', 'host_path' => './host-4'},
+        ],
+      }
+    }
+  end
+
+  let(:vms) do
+    [
+      {'name'  => 'master'},
+      {'name'  => 'debian-6-agent'},
+    ]
+  end
+
+
+  describe "without a top level roles key" do
+
+    let(:config) do
+      {'vms' => vms}
+    end
+
+    it "doesn't alter the structure" do
+      input  = dup(config)
+      output = subject.run(input)
+
+      expect(output).to eq config
+    end
+  end
+
+  describe 'removing the role' do
+    let(:config) do
+      {
+        'vms' => [{'name' => 'master'}],
+        'roles' => roles,
+      }
+    end
+
+    it 'strips out the roles key' do
+      output = subject.run(config)
+      expect(output).to_not have_key 'roles'
+    end
+  end
+
+  describe 'and a vm with no roles' do
+    let(:vms) { [{'name' => 'master'}] }
+
+    let(:config) do
+      {
+        'vms'   => vms,
+        'roles' => roles,
+      }
+    end
+
+    it "doesn't alter the vm" do
+      input  = dup(config)
+      output = subject.run(input)
+      expect(output['vms']).to eq vms
+    end
+  end
+
+  describe 'and one vm' do
+    describe 'with one role' do
+      let(:vms) { [{'name' => 'master', 'roles' => 'shell-provisioner'}] }
+
+      let(:config) do
+        {
+          'vms'   => vms,
+          'roles' => roles,
+        }
+      end
+
+      let(:filtered_vm) do
+        output = subject.run(config)
+        output['vms'][0]
+      end
+
+      it "removes the 'roles' key" do
+        expect(filtered_vm).to_not have_key 'roles'
+      end
+
+      it 'applies the role' do
+        expected = [{
+          'type'   => 'shell',
+          'inline' => '/usr/bin/sl',
+        }]
+
+        expect(filtered_vm['provisioners']).to eq expected
+      end
+    end
+
+    describe 'with two roles' do
+      let(:vms) do
+        [{
+          'name'  => 'master',
+          'roles' => ['shell-provisioner', 'folders-12'],
+        }]
+      end
+
+      let(:config) do
+        {
+          'vms'   => vms,
+          'roles' => roles,
+        }
+      end
+
+      let(:filtered_vm) do
+        output = subject.run(config)
+        output['vms'][0]
+      end
+
+      it 'applies all of the roles' do
+        expected_prov = [{
+          'type'   => 'shell',
+          'inline' => '/usr/bin/sl',
+        }]
+
+        expected_folder = [
+          {'guest_path' => '/guest-1', 'host_path' => './host-1'},
+          {'guest_path' => '/guest-2', 'host_path' => './host-2'},
+        ]
+
+        expect(filtered_vm['provisioners']).to eq expected_prov
+        expect(filtered_vm['synced_folders']).to eq expected_folder
+      end
+    end
+  end
+
+  describe "with multiple VMs and shared roles" do
+    let(:vms) do
+      [
+        {
+          'name'  => 'master',
+          'roles' => ['shell-provisioner', 'potato-provisioner', 'folders-12', 'folders-34'],
+        },
+        {
+          'name' => 'agent',
+          'roles' => ['shell-provisioner', 'puppet-provisioner', 'folders-34'],
+        }
+      ]
+    end
+
+    let(:config) do
+      {
+        'vms'   => vms,
+        'roles' => roles,
+      }
+    end
+
+    let(:filtered_vms) do
+      output = subject.run(config)
+      output['vms']
+    end
+
+    describe 'the first node' do
+      let(:vm) { filtered_vms[0] }
+      it 'has the provisioners set in the right order' do
+        expected = [
+          {'type' => 'potato', 'potato' => 'POHTAHTO.pp'},
+          {'type' => 'shell', 'inline' => '/usr/bin/sl'},
+        ]
+        expect(vm['provisioners']).to eq expected
+      end
+
+      it 'has the synced folders set in the right order' do
+        expected = [
+          {'guest_path' => '/guest-3', 'host_path' => './host-3'},
+          {'guest_path' => '/guest-4', 'host_path' => './host-4'},
+          {'guest_path' => '/guest-1', 'host_path' => './host-1'},
+          {'guest_path' => '/guest-2', 'host_path' => './host-2'},
+        ]
+
+        expect(vm['synced_folders']).to eq expected
+      end
+    end
+
+    describe 'the second node' do
+      let(:vm) { filtered_vms[1] }
+
+      it 'has the provisioners set in the right order' do
+        expected = [
+          {'type' => 'puppet', 'manifest' => 'sl.pp'},
+          {'type' => 'puppet', 'manifest' => 'starwars.pp'},
+          {'type' => 'shell', 'inline' => '/usr/bin/sl'},
+        ]
+        expect(vm['provisioners']).to eq expected
+      end
+
+      it 'has the synced folders set in the right order' do
+        expected = [
+          {'guest_path' => '/guest-3', 'host_path' => './host-3'},
+          {'guest_path' => '/guest-4', 'host_path' => './host-4'},
+        ]
+
+        expect(vm['synced_folders']).to eq expected
+      end
+    end
+  end
+
+  describe 'when a class references a non-existent role' do
+    let(:config) do
+      {
+        'vms' => [{'name' => 'master', 'roles' => 'nope'}],
+        'roles' => {'yep' => {'box' => 'moxxi'}}
+      }
+
+      it 'raises an error' do
+        expect { subject.run(config) }.to raise_error, /Couldn't find role named .*nope.*/
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'config_builder'
+
+require 'rspec'

data/templates/locales/en.yml

@@ -0,0 +1,11 @@
+---
+en:
+  config_builder:
+    class_registry:
+      unknown_entry: |-
+        Unable to locate a class associated with the identifier %{identifier} in the registry
+        %{registry}. The relevant plugin may have not loaded the config_builder extension.
+        The identifiers registered with %{registry} are %{identifiers}.
+      duplicate_entry: |-
+        The class registry %{registry} already has a class registered with identifier %{identifer}
+        and cannot replace the existing entry.

data/vagrant-config_builder.gemspec

@@ -16,4 +16,6 @@ Gem::Specification.new do |gem|
 
   gem.files        = %x{git ls-files -z}.split("\0")
   gem.require_path = 'lib'
+
+  gem.add_development_dependency 'rspec', '~> 2.14.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-config_builder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,32 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-08 00:00:00.000000000 Z
-dependencies: []
+date: 2013-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
 description: 
 email: adrien@somethingsinistral.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG
+- Gemfile
 - LICENSE
 - README.markdown
 - examples/roles.yaml
@@ -24,6 +42,7 @@ files:
 - lib/config_builder.rb
 - lib/config_builder/action/load_extensions.rb
 - lib/config_builder/class_registry.rb
+- lib/config_builder/extension_handler.rb
 - lib/config_builder/filter.rb
 - lib/config_builder/filter/roles.rb
 - lib/config_builder/filter_stack.rb
@@ -46,6 +65,9 @@ files:
 - lib/config_builder/runner.rb
 - lib/config_builder/version.rb
 - lib/vagrant-config_builder.rb
+- spec/config_builder/filter/roles_spec.rb
+- spec/spec_helper.rb
+- templates/locales/en.yml
 - vagrant-config_builder.gemspec
 homepage: https://github.com/adrienthebo/vagrant-config_builder
 licenses: