vagrant-config_builder 0.15.1 → 1.0.0.rc1

data/lib/config_builder/model/winrm.rb

@@ -36,21 +36,41 @@ class ConfigBuilder::Model::WinRM < ConfigBuilder::Model::Base
   #   @return [Fixnum] Maximum number of retry attempts.  By default this is 20.
   def_model_attribute :max_tries
 
+  # @!attribute [rw] retry_delay
+  #   @return [Fixnum]
+  def_model_attribute :retry_delay
+
   # @!attribute [rw] timeout
   #   @return [Fixnum] The timeout in seconds.  By default this is 1800 seconds.
   def_model_attribute :timeout
 
+  # @!attribute [rw] transport
+  #   @return [String, Symbol]
+  def_model_attribute :transport
+  
+  # @!attribute [rw] ssl_peer_verification
+  #   @return [Boolean]
+  def_model_attribute :ssl_peer_verification
+
+  # @!attribute [rw] execution_time_limit
+  #   @return [String]
+  def_model_attribute :execution_time_limit
+
   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 }
+      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(:retry_delay)           { |val| winrm.retry_delay           = val }
+      with_attr(:timeout)               { |val| winrm.timeout               = val }
+      with_attr(:transport)             { |val| winrm.transport             = val.to_sym }
+      with_attr(:ssl_peer_verification) { |val| winrm.ssl_peer_verification = val }
+      with_attr(:execution_time_limit)  { |val| winrm.execution_time_limit  = val }
     end
   end
 end

data/lib/config_builder/model.rb

@@ -1,6 +1,5 @@
 require 'vagrant/errors'
 require 'config_builder/class_registry'
-require 'config_builder/model_delegator'
 
 module ConfigBuilder
 
@@ -10,6 +9,7 @@ module ConfigBuilder
 
     require 'config_builder/model/root'
 
+    require 'config_builder/model/nfs'
     require 'config_builder/model/ssh'
     require 'config_builder/model/winrm'
     #require 'config_builder/model/host'
@@ -24,6 +24,7 @@ module ConfigBuilder
     module Network
       require 'config_builder/model/network/forwarded_port'
       require 'config_builder/model/network/private_network'
+      require 'config_builder/model/network/public_network'
     end
 
     module Provider
@@ -38,6 +39,8 @@ module ConfigBuilder
         @registry.register(name, klass)
       end
 
+      require 'config_builder/model/provider/base'
+
       require 'config_builder/model/provider/virtualbox'
       require 'config_builder/model/provider/vmware'
       require 'config_builder/model/provider/vmware_fusion'
@@ -46,6 +49,9 @@ module ConfigBuilder
       require 'config_builder/model/provider/vsphere'
       require 'config_builder/model/provider/azure'
       require 'config_builder/model/provider/aws'
+      require 'config_builder/model/provider/openstack'
+      require 'config_builder/model/provider/openstack_plugin'
+      require 'config_builder/model/provider/softlayer'
     end
 
     module Provisioner
@@ -60,6 +66,8 @@ module ConfigBuilder
         @registry.register(name, klass)
       end
 
+      require 'config_builder/model/provisioner/base'
+
       require 'config_builder/model/provisioner/file'
       require 'config_builder/model/provisioner/shell'
       require 'config_builder/model/provisioner/puppet'

data/lib/config_builder/model_delegator.rb

@@ -1,30 +1,11 @@
+require 'config_builder' # For logging.
+
 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
+      ConfigBuilder.logger.warn {
+        I18n.t('config_builder.model_delegator.is_deprecated', :name => klass.inspect)
+      }
     end
   end
 end

data/lib/config_builder/version.rb

@@ -1,3 +1,3 @@
 module ConfigBuilder
-  VERSION = '0.15.1'
+  VERSION = '1.0.0.rc1'
 end

data/spec/integration/vagrant/root_config_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe 'Vagrant Integration: ConfigBuilder::Model::Root' do
+  include_context 'vagrant-unit'
+
+  # Set inside test contexts to generate Vagrant configuration.
+  let(:config_data) { Hash.new }
+
+  let(:test_env)    { isolated_environment }
+  let(:env)         { test_env.create_vagrant_env }
+  let(:root_config) { env.vagrantfile.config }
+
+  before(:each) do
+    model = ConfigBuilder::Model::Root.new_from_hash(config_data)
+
+    model.call(root_config)
+  end
+
+  context 'when configured with ssh data' do
+    let(:config_data) {
+      {'ssh' =>
+        {
+          'insert_key' => false,
+          'username'   => 'AzureDiamond',
+          'password'   => 'hunter2',
+        }
+      }
+    }
+
+    subject { root_config.ssh }
+
+    it 'sets Vagrant config.ssh parameters' do
+      expect(subject.insert_key).to be_false
+      expect(subject.username).to eq 'AzureDiamond'
+      expect(subject.password).to eq 'hunter2'
+    end
+  end
+
+  context 'when configured with WinRM data' do
+    let(:config_data) {
+      {'winrm' =>
+        {
+          'username'   => 'AzureDiamond',
+          'password'   => 'hunter2',
+        }
+      }
+    }
+
+    subject { root_config.winrm }
+
+    it 'sets Vagrant config.winrm parameters' do
+      expect(subject.username).to eq 'AzureDiamond'
+      expect(subject.password).to eq 'hunter2'
+    end
+  end
+
+  context 'when configured with NFS data' do
+    let(:config_data) {
+      {'nfs' =>
+        {
+          'map_uid'  => 42,
+        }
+      }
+    }
+
+    subject { root_config.nfs }
+
+    it 'sets Vagrant config.nfs parameters' do
+      expect(subject.map_uid).to eq 42
+    end
+  end
+
+  context 'when configured with VM defaults' do
+    let(:config_data) {
+      {'vm_defaults' =>
+        {
+          'box'  => 'somebox',
+        }
+      }
+    }
+
+    subject { root_config.vm }
+
+    it 'sets Vagrant config.vm parameters' do
+      expect(subject.box).to eq 'somebox'
+    end
+  end
+
+end

data/spec/integration/vagrant/vm_config_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe 'Vagrant Integration: ConfigBuilder::Model::VM' do
+  include_context 'vagrant-unit'
+
+  # Set inside test contexts to generate Vagrant configuration.
+  let(:config_data) { Hash.new }
+
+  let(:test_env)    { isolated_environment }
+  let(:env)         {
+    test_env.create_vagrant_env(local_data_path: "#{test_env.workdir}/.vagrant")
+  }
+  let(:root_config) { env.vagrantfile.config }
+
+  before(:each) do
+    model = ConfigBuilder::Model::Root.new_from_hash(config_data)
+
+    model.call(root_config)
+  end
+
+  context 'when building vms' do
+    let(:config_data) {
+      {'vms' =>
+        [
+          {'name' => 'machine1'},
+          {'name' => 'machine2', 'autostart' => false},
+        ]
+      }
+    }
+
+    subject { root_config.vm }
+
+    it 'defines named machines under Vagrant config.vm' do
+      expect(subject.defined_vm_keys).to include(:machine1, :machine2)
+    end
+
+    it 'sets the autostart option when defining machines' do
+      test_vm = subject.defined_vms[:machine2]
+
+      expect(test_vm.options[:autostart]).to be_false
+    end
+  end
+
+  context 'when configuring vms' do
+    let(:config_data) {
+      {'vms' =>
+        [
+          {
+            'name'             => 'test',
+            'hostname'         => 'test-vm',
+            'box'              => 'testbox',
+            'communicator'     => 'winrm',
+            'forwarded_ports'  => [
+              {'id' => 'winrm', 'host' => 666}
+            ],
+            'synced_folders'   => [
+              {'host_path' => '.', 'guest_path' => '/vagrant', 'disabled' => true}
+            ],
+            'private_networks' => [
+              {'type' => 'dhcp'}
+            ],
+            'public_networks' => [
+              {'bridge' => 'some_interface:'}
+            ],
+          },
+        ]
+      }
+    }
+
+    subject { env.machine(:test, :dummy).config.vm }
+
+    it 'sets Vagrant VM attributes' do
+      expect(subject.box).to eq 'testbox'
+      expect(subject.communicator).to eq :winrm
+      expect(subject.hostname).to eq 'test-vm'
+    end
+
+    it 'configures Vagrant forwarded ports' do
+      winrm_port = subject.networks.find {|t, o| t == :forwarded_port && o[:id] == 'winrm'}
+
+      expect(winrm_port.last[:host]).to eq 666
+    end
+
+    it 'configures Vagrant synced folders' do
+      expect(subject.synced_folders['/vagrant'][:disabled]).to be_true
+    end
+
+    it 'configures Vagrant private networks' do
+      private_networks = subject.networks.select {|t, o| t == :private_network}
+
+      expect(private_networks).to_not be_empty
+    end
+
+    it 'configures Vagrant public networks' do
+      private_networks = subject.networks.select {|t, o| t == :public_network}
+
+      expect(private_networks).to_not be_empty
+    end
+  end
+
+end

data/spec/integration/vagrant/vm_provider_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+class DummyModel < ConfigBuilder::Model::Provider::Base
+  def instance_id
+    'dummy'
+  end
+
+  ConfigBuilder::Model::Provider.register('dummy', self)
+end
+
+describe 'Vagrant Integration: ConfigBuilder::Model::Provider' do
+  include_context 'vagrant-unit'
+
+  # Set inside test contexts to generate Vagrant configuration.
+  let(:config_data) { Hash.new }
+
+  let(:test_env)    { isolated_environment }
+  let(:env)         {
+    test_env.create_vagrant_env(local_data_path: "#{test_env.workdir}/.vagrant")
+  }
+  let(:root_config) { env.vagrantfile.config }
+
+  before(:each) do
+    model = ConfigBuilder::Model::Root.new_from_hash(config_data)
+
+    model.call(root_config)
+  end
+
+  context 'when configuring providers' do
+    let(:config_data) {
+      {'vms' =>
+        [
+          {
+            'name'             => 'test',
+            'providers'        => [
+              {
+                'type' => 'dummy',
+                'overrides' => {
+                  'ssh' => {'username' => 'AzureDiamond'},
+                  'vm_defaults' => {'box' => 'testbox'},
+                },
+              },
+            ],
+          },
+        ]
+      }
+    }
+
+    subject { env.machine(:test, :dummy) }
+
+    it 'sets configuration overrides' do #YAAARP.
+      expect(subject.config.ssh.username).to eq 'AzureDiamond'
+      expect(subject.config.vm.box).to eq 'testbox'
+    end
+  end
+
+end

data/spec/integration/vagrant/vm_provisioner_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe 'Vagrant Integration: ConfigBuilder::Model::Provisioner' do
+  include_context 'vagrant-unit'
+
+  # Set inside test contexts to generate Vagrant configuration.
+  let(:config_data) { Hash.new }
+
+  let(:test_env)    { isolated_environment }
+  let(:env)         {
+    test_env.create_vagrant_env(local_data_path: "#{test_env.workdir}/.vagrant")
+  }
+  let(:root_config) { env.vagrantfile.config }
+
+  before(:each) do
+    model = ConfigBuilder::Model::Root.new_from_hash(config_data)
+
+    model.call(root_config)
+  end
+
+  context 'when building provisioners' do
+    let(:config_data) {
+      {'vms' =>
+        [
+          {
+            'name'             => 'test',
+            'provisioners'     => [
+              {'type' => 'shell', 'run' => 'once'},
+              {'type' => 'file', 'name' => 'supercoolfile'},
+            ],
+          },
+        ]
+      }
+    }
+
+    subject { env.machine(:test, :dummy).config.vm }
+
+    it 'defines provisioners' do
+      expect(subject.provisioners).to have(2).items
+    end
+
+    it 'sets provisioner names' do
+      if Vagrant::VERSION < '1.7'
+        provisioner = subject.provisioners.find {|p| p.name == :file}
+
+        expect(provisioner.id).to eq 'supercoolfile'
+      else
+        provisioner = subject.provisioners.find {|p| p.type == :file}
+
+        expect(provisioner.name).to eq :supercoolfile
+      end
+    end
+
+    it 'sets provisioner options' do
+      if Vagrant::VERSION < '1.7'
+        provisioner = subject.provisioners.find {|p| p.name == :shell}
+
+        expect(provisioner.run).to eq :once
+      else
+        provisioner = subject.provisioners.find {|p| p.type == :shell}
+
+        expect(provisioner.run).to eq :once
+      end
+    end
+  end
+
+  context 'when configuring provisioners' do
+    let(:config_data) {
+      {'vms' =>
+        [
+          {
+            'name'             => 'test',
+            'provisioners'     => [
+              {'type' => 'shell', 'inline' => 'hello world'},
+            ],
+          },
+        ]
+      }
+    }
+
+    subject { env.machine(:test, :dummy).config.vm }
+
+    it 'sets provisioner attributes' do
+      shell_config = subject.provisioners.first.config
+
+      expect(shell_config.inline).to eq 'hello world'
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,4 +1,8 @@
 $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
-require 'config_builder'
 
-require 'rspec'
+# Disable Vagrant autoloading so that other plugins defined in the Gemfile for
+# Acceptance tests are not loaded.
+ENV['VAGRANT_NO_PLUGINS'] = '1'
+
+require 'vagrant-spec/unit'
+require 'config_builder'

data/spec/unit/model/base_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe ConfigBuilder::Model::Base do
+  context 'when initialized with attributes' do
+    subject do
+      described_class.new_from_hash({'attr_1' => 'val_1', 'attr_2' => 'val_2'})
+    end
+
+    it 'provides access via #attr' do
+      expect(subject.attr(:attr_1)).to eq 'val_1'
+    end
+
+    it 'provides conditional access via #with_attr' do
+      test_val_2 = nil
+      test_val_3 = nil
+
+      subject.with_attr(:attr_2) { |value| test_val_2 = value }
+      subject.with_attr(:non_existent) { |value| test_val_3 = value }
+
+      expect(test_val_2).to eq 'val_2'
+      expect(test_val_3).to be_nil
+    end
+  end
+
+  context 'when subclassed' do
+    let (:subclass_a) do
+      Class.new(described_class) do
+        def_model_id :id_key
+
+        def_model_attribute :attr_1
+        def_model_attribute :attr_2
+
+        def_model_option :opt_1
+        def_model_option :opt_2
+
+        def_model_delegator :delegator_1
+
+        def configure_attr_2(config, value)
+          config.custom_setter(value)
+        end
+      end
+    end
+
+    subject { subclass_a }
+
+    it 'responds to .model_id' do
+      expect(subject.model_id).to eq :id_key
+    end
+
+    it 'lists attributes via .model_attributes' do
+      expect(subject.model_attributes).to include(:attr_1, :attr_2)
+    end
+
+    it 'lists options via .model_options' do
+      expect(subject.model_options).to include(:opt_1, :opt_2)
+    end
+
+    it 'lists delegators via .model_delegators' do
+      expect(subject.model_delegators).to include(:delegator_1)
+    end
+
+    it 'returns #instance_id by using .model_id' do
+      instance = subject.new_from_hash({'id_key' => 'id_value'})
+
+      expect(instance.instance_id).to eq 'id_value'
+    end
+
+    it 'returns all set options via #instance_options' do
+      instance = subject.new_from_hash({'opt_1' => 'option_value'})
+
+      expect(instance.instance_options).to eq({:opt_1 => 'option_value'})
+    end
+
+    it 'copies attributes to config objects with #configure!' do
+      config = double('vagrant config')
+      instance = subject.new_from_hash({'attr_1' => 'attr_value'})
+
+      expect(config).to receive("attr_1=").with('attr_value')
+
+      instance.configure!(config)
+    end
+
+    it 'uses custom setters to copy attributes with #configure!' do
+      config = double('vagrant config')
+      instance = subject.new_from_hash({'attr_2' => 'custom_value'})
+
+      expect(config).to receive("custom_setter").with('custom_value')
+
+      instance.configure!(config)
+    end
+
+    context 'when subclassed further' do
+      let (:subclass_b) do
+        Class.new(subclass_a) do
+          def_model_attribute :attr_3
+
+          def_model_delegator :delegator_2
+
+          def_model_option :opt_3
+        end
+      end
+
+      subject { subclass_b }
+
+      it 'lists inherited attributes via .model_attributes' do
+        expect(subject.model_attributes).to include(:attr_1, :attr_2, :attr_3)
+      end
+
+      it 'lists inherited options via .model_options' do
+        expect(subject.model_options).to include(:opt_1, :opt_2, :opt_3)
+      end
+
+      it 'lists inherited delegators via .model_delegators' do
+        expect(subject.model_delegators).to include(:delegator_1, :delegator_2)
+      end
+
+      it 'does not inherit model_id' do
+        expect(subject.model_id).to be_nil
+      end
+    end
+  end
+end

data/spec/{config_builder → unit}/model/provider/vmware_fusion_spec.rb

@@ -5,23 +5,24 @@ describe ConfigBuilder::Model::Provider::VMwareFusion do
   describe "converting to a proc" do
 
     let(:vmx) { Hash.new }
-    let(:fusion_config) { double('fusion provider config', :vmx => vmx) }
-    let(:vm_config) { double('vagrant VM config', :provider => fusion_config) }
+    let(:vm_config) { double('vagrant VM config', :provider => provider_config) }
+    let(:provider_config) { double('fusion provider config', :vmx => vmx) }
+    let(:override_config) { double('fusion override config') }
 
     before do
-      allow(vm_config).to receive(:provider).and_yield(fusion_config)
+      allow(vm_config).to receive(:provider).and_yield(provider_config, override_config)
     end
 
     it "assigns the gui value to the fusion provider object" do
       subject.attrs = {:gui => 'guivalue'}
-      expect(fusion_config).to receive(:gui=).with('guivalue')
+      expect(provider_config).to receive(:gui=).with('guivalue')
       p = subject.to_proc
       p.call(vm_config)
     end
 
     it "assigns the vmx value to the fusion provider object" do
       subject.attrs = {:vmx => {:hello => 'world'}}
-      allow(fusion_config).to receive(:gui=)
+      allow(provider_config).to receive(:gui=)
       subject.call(vm_config)
       expect(vmx).to eq({:hello => 'world'})
     end

data/templates/locales/en.yml

@@ -13,3 +13,7 @@ en:
       vm:
         provider_is_deprecated: |-
           The provider attribute, set on vm %{name}, is deprecated and will be removed in an upcoming release. Use the providers attribute instead.
+    model_delegator:
+      is_deprecated: |-
+        The functionality provided by ConfigBuilder::ModelDelegator has been folded into Config::Builder::Model::Base.
+        The ModelDelegator module will be removed in an upcoming release (included by %{name}).