vagrant-masonry 0.13.0

data/lib/config_builder/model/winrm.rb

@@ -0,0 +1,56 @@
+# Vagrant WinRM credential model.
+#
+# @see http://docs.vagrantup.com/v2/vagrantfile
+class ConfigBuilder::Model::WinRM < ConfigBuilder::Model::Base
+  # @!attribute [rw] username
+  #   @return [String] This sets the username that Vagrant will WinRM as by
+  #     default. Providers are free to override this if they detect a more
+  #     appropriate user. By default this is "vagrant," since that is what most
+  #     public boxes are made as.
+  def_model_attribute :username
+
+  # @!attribute [rw] password
+  #   @return [String] This sets a password that Vagrant will use to
+  #     authenticate the WinRM user.
+  def_model_attribute :password
+
+  # @!attribute [rw] host
+  #   @return [String] The hostname or IP to WinRM into. By default this is
+  #     empty, because the provider usually figures this out for you.
+  def_model_attribute :host
+
+  # @!attribute [rw] port
+  #   @return [Fixnum] The port to WinRM into. By default this is port 5985.
+  def_model_attribute :port
+
+  # @!attribute [rw] guest_port
+  #   @return [Fixnum] The port on the guest that WinRM is running on.
+  #     This is used by some providers to detect forwarded ports for WinRM.
+  #     For example, if this is set to 5985 (the default), and Vagrant detects
+  #     a forwarded port to port 5985 on the guest from port 4567 on the host,
+  #     Vagrant will attempt to use port 4567 to talk to the guest if there is
+  #     no other option.
+  def_model_attribute :guest_port
+
+  # @!attribute [rw] max_tries
+  #   @return [Fixnum] Maximum number of retry attempts.  By default this is 20.
+  def_model_attribute :max_tries
+
+  # @!attribute [rw] timeout
+  #   @return [Fixnum] The timeout in seconds.  By default this is 1800 seconds.
+  def_model_attribute :timeout
+
+  def to_proc
+    Proc.new do |global_config|
+      winrm = global_config.winrm
+
+      with_attr(:username)   { |val| winrm.username = val }
+      with_attr(:password)   { |val| winrm.password = val }
+      with_attr(:host)       { |val| winrm.host = val }
+      with_attr(:guest)      { |val| winrm.guest = val }
+      with_attr(:guest_port) { |val| winrm.guest_port = val }
+      with_attr(:max_tries)  { |val| winrm.max_tries = val }
+      with_attr(:timeout)    { |val| winrm.timeout = val }
+    end
+  end
+end

data/lib/config_builder/model_delegator.rb

@@ -0,0 +1,30 @@
+module ConfigBuilder
+  module ModelDelegator
+
+    def model_delegators
+      self.class.model_delegators
+    end
+
+    def eval_models(config)
+      model_delegators.each do |model|
+        meth = "eval_#{model}"
+        send(meth, config)
+      end
+    end
+
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      def def_model_delegator(identifier)
+        def_model_attribute(identifier)
+        model_delegators << identifier
+      end
+
+      def model_delegators
+        (@models ||= [])
+      end
+    end
+  end
+end

data/lib/config_builder/plugin.rb

@@ -0,0 +1,15 @@
+require 'vagrant'
+
+require 'config_builder/action/load_extensions'
+
+module VagrantPlugins
+  module ConfigBuilder
+    class Plugin < Vagrant.plugin('2')
+      name "Generate Vagrant configuration from logic-less data sources"
+
+      action_hook('ConfigBuilder: load extensions', :environment_load) do |hook|
+        hook.prepend(::ConfigBuilder::Action::LoadExtensions)
+      end
+    end
+  end
+end

data/lib/config_builder/runner.rb

@@ -0,0 +1,33 @@
+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)
+    end
+
+    private
+
+    def load_extensions
+      ext = ConfigBuilder::ExtensionHandler.new
+      ext.load_from_plugins
+    end
+
+    def run_filters(data)
+      stack = ConfigBuilder::FilterStack.new
+      stack.filter(data)
+    end
+
+    def generate_model(filtered_hash)
+      ConfigBuilder::Model.generate(filtered_hash)
+    end
+  end
+end

data/lib/config_builder/version.rb

@@ -0,0 +1,3 @@
+module ConfigBuilder
+  VERSION = '0.13.0'
+end

data/lib/vagrant-masonry.rb

@@ -0,0 +1 @@
+require 'config_builder'

data/spec/config_builder/filter/boxes_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe ConfigBuilder::Filter::Boxes do
+
+  def dup(o)
+    Marshal.load(Marshal.dump(o))
+  end
+
+  let(:boxes) do
+    {
+      'first_box'  => 'http://box_host/first_box.box',
+      'second_box' => 'http://box_host/second_box.box',
+      'third_box'  => 'http://box_host/third_box.box',
+    }
+  end
+
+  let(:vms) do
+    [
+      {'name' => 'one',  'box'  => 'first_box'},
+      {'name' => 'two',  'box'  => 'second_box'},
+      {'name' => 'four', 'box'  => 'fourth_box'},
+      {
+        'name'    => 'five',
+        'box'     => 'fifth_box',
+        'box_url' => 'https://another_box_host/fifth_box.box',
+      },
+    ]
+  end
+
+  describe 'without a boxes key' do
+    let(:config) do
+      {
+        'vms' => vms,
+      }
+    end
+
+    before { subject.set_config(config) }
+
+    it "doesn't modify any boxes" do
+      input = dup(config)
+      output = subject.run
+      expect(output).to eq config
+    end
+  end
+
+  describe 'when the boxes key is given' do
+    let(:config) do
+      {
+        'boxes' => boxes,
+        'vms'   => vms,
+      }
+    end
+
+    before { subject.set_config(config) }
+
+    it "removes the 'boxes' key" do
+      output = subject.run
+      expect(output).to_not have_key 'boxes'
+    end
+
+    it "adds the 'box_url' to VMs whose 'box' value is in the 'boxes' list" do
+      output = subject.run
+      vms    = output['vms']
+
+      expect(vms[0]['box_url']).to eq 'http://box_host/first_box.box'
+      expect(vms[1]['box_url']).to eq 'http://box_host/second_box.box'
+    end
+
+    describe "if the VM 'box' value doesn't have a match in the box list" do
+      it "doesn't modify the 'box_url'" do
+        output = subject.run
+        vms    = output['vms']
+
+        expect(vms[2]['box_url']).to be_nil
+      end
+    end
+
+    describe "if the VM 'box_url' is already set" do
+      it "doesn't modify the 'box_url'" do
+        output = subject.run
+        vms    = output['vms']
+
+        expect(vms[3]['box_url']).to eq 'https://another_box_host/fifth_box.box'
+      end
+    end
+  end
+end

data/spec/config_builder/filter/roles_spec.rb

@@ -0,0 +1,287 @@
+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'},
+        ],
+      },
+      'shared-networks' => {
+        'private_networks' => [
+          {'ip' => '1.2.3.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
+
+    before do
+      subject.set_config(dup(config))
+    end
+
+    it "doesn't alter the structure" do
+      input  = dup(config)
+      output = subject.run
+
+      expect(output).to eq config
+    end
+  end
+
+  describe 'removing the role' do
+    let(:config) do
+      {
+        'vms' => [{'name' => 'master'}],
+        'roles' => roles,
+      }
+    end
+
+    before do
+      subject.set_config(dup(config))
+    end
+
+    it 'strips out the roles key' do
+      output = subject.run
+      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
+
+    before do
+      subject.set_config(dup(config))
+    end
+
+    it "doesn't alter the vm" do
+      output = subject.run
+      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
+
+      before do
+        subject.set_config(dup(config))
+      end
+
+      let(:filtered_vm) do
+        output = subject.run
+        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
+
+      before do
+        subject.set_config(dup(config))
+      end
+
+      let(:filtered_vm) do
+        output = subject.run
+        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', 'shared-networks'],
+        },
+        {
+          'name' => 'agent',
+          'roles' => ['shell-provisioner', 'puppet-provisioner', 'folders-34', 'shared-networks'],
+        }
+      ]
+    end
+
+    let(:config) do
+      {
+        'vms'   => vms,
+        'roles' => roles,
+      }
+    end
+
+    before do
+      subject.set_config(dup(config))
+      end
+
+    let(:filtered_vms) do
+      output = subject.run
+      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
+
+    context 'when modifying an array inherited from a role' do
+      before :each do
+        filtered_vms[0]['private_networks'].push 'ip' => '5.6.7.8'
+      end
+
+      it 'other VMs using that role are not affected' do
+        expect(filtered_vms[1]['private_networks']).to eq roles['shared-networks']['private_networks']
+      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'}}
+      }
+    end
+
+    before do
+      subject.set_config(dup(config))
+    end
+
+    it 'raises an error' do
+      expect { subject.run }.to raise_error(/^Requested role "nope" is not defined/)
+    end
+  end
+end