tnargav 1.2.2

data/test/unit/vagrant/config/loader_test.rb

@@ -0,0 +1,184 @@
+require File.expand_path("../../../base", __FILE__)
+
+require "vagrant/registry"
+
+describe Vagrant::Config::Loader do
+  include_context "unit"
+
+  # This is the current version of configuration for the tests.
+  let(:current_version) { version_order.last }
+
+  # This is just a dummy implementation of a configuraiton loader which
+  # simply acts on hashes.
+  let(:test_loader) do
+    Class.new(Vagrant::Config::VersionBase) do
+      def self.init
+        {}
+      end
+
+      def self.load(proc)
+        init.tap do |obj|
+          proc.call(obj)
+        end
+      end
+
+      def self.merge(old, new)
+        old.merge(new)
+      end
+    end
+  end
+
+  let(:versions) do
+    Vagrant::Registry.new.tap do |r|
+      r.register("1") { test_loader }
+    end
+  end
+
+  let(:version_order) { ["1"] }
+
+  let(:instance) { described_class.new(versions, version_order) }
+
+  describe "basic loading" do
+    it "should ignore non-existent load order keys" do
+      instance.load([:foo])
+    end
+
+    it "should load and return the configuration" do
+      proc = Proc.new do |config|
+        config[:foo] = "yep"
+      end
+
+      instance.set(:proc, [[current_version, proc]])
+      config, warnings, errors = instance.load([:proc])
+
+      config[:foo].should == "yep"
+      warnings.should == []
+      errors.should == []
+    end
+  end
+
+  describe "finalization" do
+    it "should finalize the configuration" do
+      # Create the finalize method on our loader
+      def test_loader.finalize(obj)
+        obj[:finalized] = true
+        obj
+      end
+
+      # Basic configuration proc
+      proc = lambda do |config|
+        config[:foo] = "yep"
+      end
+
+      # Run the actual configuration and assert that we get the proper result
+      instance.set(:proc, [[current_version, proc]])
+      config, _ = instance.load([:proc])
+      config[:foo].should == "yep"
+      config[:finalized].should == true
+    end
+  end
+
+  describe "upgrading" do
+    it "should do an upgrade to the latest version" do
+      test_loader_v2 = Class.new(test_loader) do
+        def self.upgrade(old)
+          new = old.dup
+          new[:v2] = true
+
+          [new, [], []]
+        end
+      end
+
+      versions.register("2") { test_loader_v2 }
+      version_order << "2"
+
+      # Load a version 1 proc, and verify it is upgraded to version 2
+      proc = lambda { |config| config[:foo] = "yep" }
+      instance.set(:proc, [["1", proc]])
+      config, _ = instance.load([:proc])
+      config[:foo].should == "yep"
+      config[:v2].should == true
+    end
+
+    it "should keep track of warnings and errors" do
+      test_loader_v2 = Class.new(test_loader) do
+        def self.upgrade(old)
+          new = old.dup
+          new[:v2] = true
+
+          [new, ["foo!"], ["bar!"]]
+        end
+      end
+
+      versions.register("2") { test_loader_v2 }
+      version_order << "2"
+
+      # Load a version 1 proc, and verify it is upgraded to version 2
+      proc = lambda { |config| config[:foo] = "yep" }
+      instance.set(:proc, [["1", proc]])
+      config, warnings, errors = instance.load([:proc])
+      config[:foo].should == "yep"
+      config[:v2].should == true
+      warnings.should == ["foo!"]
+      errors.should == ["bar!"]
+    end
+  end
+
+  describe "loading edge cases" do
+    it "should only run the same proc once" do
+      count = 0
+      proc = Proc.new do |config|
+        config[:foo] = "yep"
+        count += 1
+      end
+
+      instance.set(:proc, [[current_version, proc]])
+
+      5.times do
+        result, _ = instance.load([:proc])
+
+        # Verify the config result
+        result[:foo].should == "yep"
+
+        # Verify the count is only one
+        count.should == 1
+      end
+    end
+
+    it "should only load configuration files once" do
+      $_config_data = 0
+
+      # We test both setting a file multiple times as well as multiple
+      # loads, since both should not cache the data.
+      file = temporary_file("$_config_data += 1")
+      5.times { instance.set(:file, file) }
+      5.times { instance.load([:file]) }
+
+      $_config_data.should == 1
+    end
+
+    it "should not clear the cache if setting to the same value multiple times" do
+      $_config_data = 0
+
+      file = temporary_file("$_config_data += 1")
+
+      instance.set(:proc, file)
+      5.times { instance.load([:proc]) }
+
+      instance.set(:proc, file)
+      5.times { instance.load([:proc]) }
+
+      $_config_data.should == 1
+    end
+
+    it "should raise proper error if there is a syntax error in a Vagrantfile" do
+      expect { instance.set(:file, temporary_file("Vagrant:^Config")) }.
+        to raise_exception(Vagrant::Errors::VagrantfileSyntaxError)
+    end
+
+    it "should raise a proper error if there is a problem with the Vagrantfile" do
+      expect { instance.set(:file, temporary_file("foo")) }.
+        to raise_exception(Vagrant::Errors::VagrantfileLoadError)
+    end
+  end
+end

data/test/unit/vagrant/config/v1/dummy_config_test.rb

@@ -0,0 +1,24 @@
+require File.expand_path("../../../../base", __FILE__)
+
+describe Vagrant::Config::V1::DummyConfig do
+  it "should allow attribute setting" do
+    expect { subject.foo = :bar }.
+      to_not raise_error
+  end
+
+  it "should allow method calls that return more DummyConfigs" do
+    subject.foo.should be_kind_of(described_class)
+  end
+
+  it "should allow hash access" do
+    expect { subject[:foo] }.
+      to_not raise_error
+
+    subject[:foo].should be_kind_of(described_class)
+  end
+
+  it "should allow setting hash values" do
+    expect { subject[:foo] = :bar }.
+      to_not raise_error
+  end
+end

data/test/unit/vagrant/config/v1/loader_test.rb

@@ -0,0 +1,145 @@
+require "ostruct"
+
+require File.expand_path("../../../../base", __FILE__)
+
+describe Vagrant::Config::V1::Loader do
+  include_context "unit"
+
+  before(:each) do
+    # Force the V1 loader to believe that we are in V1
+    stub_const("Vagrant::Config::CURRENT_VERSION", "1")
+  end
+
+  describe "empty" do
+    it "returns an empty configuration object" do
+      result = described_class.init
+      result.should be_kind_of(Vagrant::Config::V1::Root)
+    end
+
+    it "returns an object with all configuration keys loaded if V1" do
+      # Make sure we're version 1
+      stub_const("Vagrant::Config::CURRENT_VERSION", "1")
+
+      # Register some config classes.
+      register_plugin("1") do |p|
+        p.config("foo") { OpenStruct }
+        p.config("bar", true) { OpenStruct }
+      end
+
+      # Test that we have all keys
+      result = described_class.init
+      result.foo.should be_kind_of(OpenStruct)
+      result.bar.should be_kind_of(OpenStruct)
+    end
+
+    it "returns only upgradable config objects if not V1" do
+      # Make sure we're NOT version 1
+      stub_const("Vagrant::Config::CURRENT_VERSION", "2")
+
+      # Register some config classes.
+      register_plugin("1") do |p|
+        p.config("foo") { OpenStruct }
+        p.config("bar", true) { OpenStruct }
+      end
+
+      # Test that we have all keys
+      result = described_class.init
+      result.bar.should be_kind_of(OpenStruct)
+    end
+  end
+
+  describe "finalizing" do
+    it "should call `#finalize` on the configuration object" do
+      # Register a plugin for our test
+      register_plugin("1") do |plugin|
+        plugin.config "foo" do
+          Class.new do
+            attr_accessor :bar
+
+            def finalize!
+              @bar = "finalized"
+            end
+          end
+        end
+      end
+
+      # Create the proc we're testing
+      config_proc = Proc.new do |config|
+        config.foo.bar = "value"
+      end
+
+      # Test that it works properly
+      config = described_class.load(config_proc)
+      config.foo.bar.should == "value"
+
+      # Finalize it
+      described_class.finalize(config)
+      config.foo.bar.should == "finalized"
+    end
+  end
+
+  describe "loading" do
+    it "should configure with all plugin config keys loaded" do
+      # Register a plugin for our test
+      register_plugin("1") do |plugin|
+        plugin.config("foo") { OpenStruct }
+      end
+
+      # Create the proc we're testing
+      config_proc = Proc.new do |config|
+        config.foo.bar = "value"
+      end
+
+      # Test that it works properly
+      config = described_class.load(config_proc)
+      config.foo.bar.should == "value"
+    end
+  end
+
+  describe "merging" do
+    it "should merge available configuration keys" do
+      old = Vagrant::Config::V1::Root.new({ :foo => Object })
+      new = Vagrant::Config::V1::Root.new({ :bar => Object })
+      result = described_class.merge(old, new)
+      result.foo.should be_kind_of(Object)
+      result.bar.should be_kind_of(Object)
+    end
+
+    it "should merge instantiated objects" do
+      config_class = Class.new do
+        attr_accessor :value
+      end
+
+      old = Vagrant::Config::V1::Root.new({ :foo => config_class })
+      old.foo.value = "old"
+
+      new = Vagrant::Config::V1::Root.new({ :bar => config_class })
+      new.bar.value = "new"
+
+      result = described_class.merge(old, new)
+      result.foo.value.should == "old"
+      result.bar.value.should == "new"
+    end
+
+    it "should merge conflicting classes by calling `merge`" do
+      config_class = Class.new do
+        attr_accessor :value
+
+        def merge(new)
+          result       = self.class.new
+          result.value = @value + new.value
+          result
+        end
+      end
+
+      old = Vagrant::Config::V1::Root.new({ :foo => config_class })
+      old.foo.value = 10
+
+      new = Vagrant::Config::V1::Root.new({ :foo => config_class })
+      new.foo.value = 15
+
+      result = described_class.merge(old, new)
+      result.foo.value.should == 25
+    end
+  end
+end

data/test/unit/vagrant/config/v1/root_test.rb

@@ -0,0 +1,40 @@
+require File.expand_path("../../../../base", __FILE__)
+
+describe Vagrant::Config::V1::Root do
+  include_context "unit"
+
+  it "should provide access to config objects" do
+    foo_class = Class.new
+    map       = { :foo => foo_class }
+
+    instance  = described_class.new(map)
+    foo       = instance.foo
+    foo.should be_kind_of(foo_class)
+    instance.foo.should eql(foo)
+  end
+
+  it "can be created with initial state" do
+    instance = described_class.new({}, { :foo => "bar" })
+    instance.foo.should == "bar"
+  end
+
+  it "should return internal state" do
+    map      = { "foo" => Object, "bar" => Object }
+    instance = described_class.new(map)
+    instance.__internal_state.should == {
+      "config_map" => map,
+      "keys"       => {},
+      "missing_key_calls" => Set.new
+    }
+  end
+
+  it "should record missing key calls" do
+    instance = described_class.new({})
+    instance.foo.bar = false
+
+    keys = instance.__internal_state["missing_key_calls"]
+    keys.should be_kind_of(Set)
+    keys.length.should == 1
+    keys.include?("foo").should be
+  end
+end

data/test/unit/vagrant/config/v2/dummy_config_test.rb

@@ -0,0 +1,24 @@
+require File.expand_path("../../../../base", __FILE__)
+
+describe Vagrant::Config::V2::DummyConfig do
+  it "should allow attribute setting" do
+    expect { subject.foo = :bar }.
+      to_not raise_error
+  end
+
+  it "should allow method calls that return more DummyConfigs" do
+    subject.foo.should be_kind_of(described_class)
+  end
+
+  it "should allow hash access" do
+    expect { subject[:foo] }.
+      to_not raise_error
+
+    subject[:foo].should be_kind_of(described_class)
+  end
+
+  it "should allow setting hash values" do
+    expect { subject[:foo] = :bar }.
+      to_not raise_error
+  end
+end

data/test/unit/vagrant/config/v2/loader_test.rb

@@ -0,0 +1,151 @@
+require "ostruct"
+
+require File.expand_path("../../../../base", __FILE__)
+
+describe Vagrant::Config::V2::Loader do
+  include_context "unit"
+
+  before(:each) do
+    # Force the V2 loader to believe that we are in V2
+    stub_const("Vagrant::Config::CURRENT_VERSION", "2")
+  end
+
+  describe "empty" do
+    it "returns an empty configuration object" do
+      result = described_class.init
+      result.should be_kind_of(Vagrant::Config::V2::Root)
+    end
+  end
+
+  describe "finalizing" do
+    it "should call `#finalize` on the configuration object" do
+      # Register a plugin for our test
+      register_plugin("2") do |plugin|
+        plugin.config "foo" do
+          Class.new do
+            attr_accessor :bar
+
+            def finalize!
+              @bar = "finalized"
+            end
+          end
+        end
+      end
+
+      # Create the proc we're testing
+      config_proc = Proc.new do |config|
+        config.foo.bar = "value"
+      end
+
+      # Test that it works properly
+      config = described_class.load(config_proc)
+      config.foo.bar.should == "value"
+
+      # Finalize it
+      described_class.finalize(config)
+      config.foo.bar.should == "finalized"
+    end
+  end
+
+  describe "loading" do
+    it "should configure with all plugin config keys loaded" do
+      # Register a plugin for our test
+      register_plugin("2") do |plugin|
+        plugin.config("foo") { OpenStruct }
+      end
+
+      # Create the proc we're testing
+      config_proc = Proc.new do |config|
+        config.foo.bar = "value"
+      end
+
+      # Test that it works properly
+      config = described_class.load(config_proc)
+      config.foo.bar.should == "value"
+    end
+  end
+
+  describe "merging" do
+    it "should merge available configuration keys" do
+      old = Vagrant::Config::V2::Root.new({ :foo => Object })
+      new = Vagrant::Config::V2::Root.new({ :bar => Object })
+      result = described_class.merge(old, new)
+      result.foo.should be_kind_of(Object)
+      result.bar.should be_kind_of(Object)
+    end
+
+    it "should merge instantiated objects" do
+      config_class = Class.new do
+        attr_accessor :value
+      end
+
+      old = Vagrant::Config::V2::Root.new({ :foo => config_class })
+      old.foo.value = "old"
+
+      new = Vagrant::Config::V2::Root.new({ :bar => config_class })
+      new.bar.value = "new"
+
+      result = described_class.merge(old, new)
+      result.foo.value.should == "old"
+      result.bar.value.should == "new"
+    end
+
+    it "should merge conflicting classes by calling `merge`" do
+      config_class = Class.new do
+        attr_accessor :value
+
+        def merge(new)
+          result       = self.class.new
+          result.value = @value + new.value
+          result
+        end
+      end
+
+      old = Vagrant::Config::V2::Root.new({ :foo => config_class })
+      old.foo.value = 10
+
+      new = Vagrant::Config::V2::Root.new({ :foo => config_class })
+      new.foo.value = 15
+
+      result = described_class.merge(old, new)
+      result.foo.value.should == 25
+    end
+  end
+
+  describe "upgrading" do
+    it "should continue fine if the key doesn't implement upgrade" do
+      # Make an old V1 root object
+      old = Vagrant::Config::V1::Root.new({ :foo => Class.new })
+
+      # It should work fine
+      expect { result = described_class.upgrade(old) }.to_not raise_error
+    end
+
+    it "should upgrade the config if it implements the upgrade method" do
+      # Create the old V1 class that will be upgraded
+      config_class = Class.new do
+        attr_accessor :value
+
+        def upgrade(new)
+          new.foo.value = value * 2
+
+          [["foo"], ["bar"]]
+        end
+      end
+
+      # Create the new V2 plugin it is writing to
+      register_plugin("2") do |p|
+        p.config("foo") { OpenStruct }
+      end
+
+      # Test it out!
+      old = Vagrant::Config::V1::Root.new({ :foo => config_class })
+      old.foo.value = 5
+
+      data = described_class.upgrade(old)
+      data[0].foo.value.should == 10
+      data[1].should == ["foo"]
+      data[2].should == ["bar"]
+    end
+  end
+end

data/test/unit/vagrant/config/v2/root_test.rb

@@ -0,0 +1,97 @@
+require "set"
+
+require File.expand_path("../../../../base", __FILE__)
+
+describe Vagrant::Config::V2::Root do
+  include_context "unit"
+
+  it "should provide access to config objects" do
+    foo_class = Class.new
+    map       = { :foo => foo_class }
+
+    instance  = described_class.new(map)
+    foo       = instance.foo
+    foo.should be_kind_of(foo_class)
+    instance.foo.should eql(foo)
+  end
+
+  it "record a missing key call if invalid key used" do
+    instance = described_class.new({})
+    expect { instance.foo }.to_not raise_error
+    instance.__internal_state["missing_key_calls"].include?("foo").should be
+  end
+
+  it "returns a dummy config for a missing key" do
+    instance = described_class.new({})
+    expect { instance.foo.foo = "bar" }.to_not raise_error
+  end
+
+  it "can be created with initial state" do
+    instance = described_class.new({}, { :foo => "bar" })
+    instance.foo.should == "bar"
+  end
+
+  it "should return internal state" do
+    map      = { "foo" => Object, "bar" => Object }
+    instance = described_class.new(map)
+    instance.__internal_state.should == {
+      "config_map"        => map,
+      "keys"              => {},
+      "missing_key_calls" => Set.new
+    }
+  end
+
+  describe "validation" do
+    let(:instance) do
+      map = { :foo => Object, :bar => Object }
+      described_class.new(map)
+    end
+
+    it "should return nil if valid" do
+      instance.validate({}).should == {}
+    end
+
+    it "should return errors if invalid" do
+      errors = { "foo" => ["errors!"] }
+      env    = { "errors" => errors }
+      foo    = instance.foo
+      def foo.validate(env)
+        env["errors"]
+      end
+
+      instance.validate(env).should == errors
+    end
+
+    it "should merge errors via array concat if matching keys" do
+      errors = { "foo" => ["errors!"] }
+      env    = { "errors" => errors }
+      foo    = instance.foo
+      bar    = instance.bar
+      def foo.validate(env)
+        env["errors"]
+      end
+
+      def bar.validate(env)
+        env["errors"].merge({ "bar" => ["bar"] })
+      end
+
+      expected_errors = {
+        "foo" => ["errors!", "errors!"],
+        "bar" => ["bar"]
+      }
+
+      instance.validate(env).should == expected_errors
+    end
+
+    it "shouldn't count empty keys" do
+      errors = { "foo" => [] }
+      env    = { "errors" => errors }
+      foo    = instance.foo
+      def foo.validate(env)
+        env["errors"]
+      end
+
+      instance.validate(env).should == {}
+    end
+  end
+end

data/test/unit/vagrant/config/v2/util_test.rb

@@ -0,0 +1,21 @@
+require File.expand_path("../../../../base", __FILE__)
+
+require "vagrant/config/v2/util"
+
+describe Vagrant::Config::V2::Util do
+  describe "merging errors" do
+    it "should merge matching keys and leave the rest alone" do
+      first  = { "one" => ["foo"], "two" => ["two"] }
+      second = { "one" => ["bar"], "three" => ["three"] }
+
+      expected = {
+        "one" => ["foo", "bar"],
+        "two" => ["two"],
+        "three" => ["three"]
+      }
+
+      result = described_class.merge_errors(first, second)
+      result.should == expected
+    end
+  end
+end