Merge pull request #3600 from mitchellh/f-default-provider

Default Provider By Priority

lib/vagrant/action/builtin/mixin_synced_folders.rb

@@ -22,7 +22,7 @@ module Vagrant
             ordered << [priority, key, impl]
           end
 
-          # Order the plugins by priority. Higher is tries before lower.
+          # Order the plugins by priority. Higher is tried before lower.
           ordered = ordered.sort { |a, b| b[0] <=> a[0] }
 
           # Find the proper implementation

lib/vagrant/environment.rb

@@ -249,13 +249,48 @@ module Vagrant
     end
 
     # This returns the provider name for the default provider for this
-    # environment. The provider returned is currently hardcoded to "virtualbox"
-    # but one day should be a detected valid, best-case provider for this
     # environment.
     #
     # @return [Symbol] Name of the default provider.
-    def default_provider
+    def default_provider(**opts)
-      (ENV['VAGRANT_DEFAULT_PROVIDER'] || :virtualbox).to_sym
+      opts[:exclude]       = Set.new(opts[:exclude]) if opts[:exclude]
+      opts[:force_default] = true if !opts.has_key?(:force_default)
+
+      default = ENV["VAGRANT_DEFAULT_PROVIDER"]
+      default = nil if default == ""
+      default = default.to_sym if default
+
+      # If we're forcing the default, just short-circuit and return
+      # that (the default behavior)
+      return default if default && opts[:force_default]
+
+      ordered = []
+      Vagrant.plugin("2").manager.providers.each do |key, data|
+        impl  = data[0]
+        popts = data[1]
+
+        # Skip excluded providers
+        next if opts[:exclude] && opts[:exclude].include?(key)
+
+        ordered << [popts[:priority], key, impl, popts]
+      end
+
+      # Order the providers by priority. Higher values are tried first.
+      ordered = ordered.sort do |a, b|
+        # If we see the default, then that one always wins
+        next -1 if a[1] == default
+        next 1  if b[1] == default
+
+        b[0] <=> a[0]
+      end
+
+      # Find the matching implementation
+      ordered.each do |_, key, impl, _|
+        return key if impl.usable?(false)
+      end
+
+      # If all else fails, return VirtualBox
+      return :virtualbox
     end
 
     # Returns the collection of boxes for the environment.

lib/vagrant/plugin/v2/plugin.rb

@@ -186,8 +186,11 @@ module Vagrant
         #
         # @param [Symbol] name Name of the provider.
         def self.provider(name=UNSET_VALUE, options=nil, &block)
+          options ||= {}
+          options[:priority] ||= 5
+
           components.providers.register(name.to_sym) do
-            [block.call, options || {}]
+            [block.call, options]
           end
 
           nil

lib/vagrant/vagrantfile.rb

@@ -192,7 +192,7 @@ module Vagrant
       return {
         box: box,
         provider_cls: provider_cls,
-        provider_options: provider_options,
+        provider_options: provider_options.dup,
         config: config,
         config_warnings: config_warnings,
         config_errors: config_errors,

plugins/providers/docker/plugin.rb

@@ -16,7 +16,7 @@ module VagrantPlugins
       Docker containers.
       EOF
 
-      provider(:docker, box_optional: true, parallel: true) do
+      provider(:docker, box_optional: true, parallel: true, priority: 3) do
         require_relative 'provider'
         init!
         Provider

test/unit/support/shared/capability_helpers_context.rb

@@ -7,6 +7,14 @@ shared_context "capability_helpers" do
     end
   end
 
+  def provider_usable_class(result)
+    Class.new do
+      define_singleton_method(:usable?) do |*args|
+        result
+      end
+    end
+  end
+
   def cap_instance(name, options=nil)
     options ||= {}
 

test/unit/vagrant/environment_test.rb

@@ -699,15 +699,73 @@ VF
   end
 
   describe "default provider" do
-    it "is virtualbox without any environmental variable" do
+    let(:plugin_providers) { {} }
+
+    before do
+      m = Vagrant.plugin("2").manager
+      m.stub(providers: plugin_providers)
+    end
+
+    it "is the highest matching usable provider" do
+      plugin_providers[:foo] = [provider_usable_class(true), { priority: 5 }]
+      plugin_providers[:bar] = [provider_usable_class(true), { priority: 7 }]
+      plugin_providers[:baz] = [provider_usable_class(true), { priority: 2 }]
+      plugin_providers[:boom] = [provider_usable_class(true), { priority: 3 }]
+
       with_temp_env("VAGRANT_DEFAULT_PROVIDER" => nil) do
-        expect(subject.default_provider).to eq(:virtualbox)
+        expect(subject.default_provider).to eq(:bar)
       end
     end
 
-    it "is whatever the environmental variable is if set" do
+    it "is the highest matching usable provider that isn't excluded" do
-      with_temp_env("VAGRANT_DEFAULT_PROVIDER" => "foo") do
+      plugin_providers[:foo] = [provider_usable_class(true), { priority: 5 }]
-        expect(subject.default_provider).to eq(:foo)
+      plugin_providers[:bar] = [provider_usable_class(true), { priority: 7 }]
+      plugin_providers[:baz] = [provider_usable_class(true), { priority: 2 }]
+      plugin_providers[:boom] = [provider_usable_class(true), { priority: 3 }]
+
+      with_temp_env("VAGRANT_DEFAULT_PROVIDER" => nil) do
+        expect(subject.default_provider(exclude: [:bar, :foo])).to eq(:boom)
+      end
+    end
+
+    it "is the default provider set if usable" do
+      plugin_providers[:foo] = [provider_usable_class(true), { priority: 5 }]
+      plugin_providers[:bar] = [provider_usable_class(true), { priority: 7 }]
+      plugin_providers[:baz] = [provider_usable_class(true), { priority: 2 }]
+      plugin_providers[:boom] = [provider_usable_class(true), { priority: 3 }]
+
+      with_temp_env("VAGRANT_DEFAULT_PROVIDER" => "baz") do
+        expect(subject.default_provider).to eq(:baz)
+      end
+    end
+
+    it "is the default provider set even if unusable" do
+      plugin_providers[:baz] = [provider_usable_class(false), { priority: 5 }]
+      plugin_providers[:foo] = [provider_usable_class(true), { priority: 5 }]
+      plugin_providers[:bar] = [provider_usable_class(true), { priority: 7 }]
+
+      with_temp_env("VAGRANT_DEFAULT_PROVIDER" => "baz") do
+        expect(subject.default_provider).to eq(:baz)
+      end
+    end
+
+    it "is the usable despite default if not forced" do
+      plugin_providers[:baz] = [provider_usable_class(false), { priority: 5 }]
+      plugin_providers[:foo] = [provider_usable_class(true), { priority: 5 }]
+      plugin_providers[:bar] = [provider_usable_class(true), { priority: 7 }]
+
+      with_temp_env("VAGRANT_DEFAULT_PROVIDER" => "baz") do
+        expect(subject.default_provider(force_default: false)).to eq(:bar)
+      end
+    end
+
+    it "is VirtualBox if nothing else is usable" do
+      plugin_providers[:foo] = [provider_usable_class(false), { priority: 5 }]
+      plugin_providers[:bar] = [provider_usable_class(false), { priority: 5 }]
+      plugin_providers[:baz] = [provider_usable_class(false), { priority: 5 }]
+
+      with_temp_env("VAGRANT_DEFAULT_PROVIDER" => nil) do
+        expect(subject.default_provider).to eq(:virtualbox)
       end
     end
   end

test/unit/vagrant/plugin/v2/manager_test.rb

@@ -167,8 +167,8 @@ describe Vagrant::Plugin::V2::Manager do
     instance.register(pB)
 
     expect(instance.providers.to_hash.length).to eq(2)
-    expect(instance.providers[:foo]).to eq(["bar", {}])
+    expect(instance.providers[:foo]).to eq(["bar", { priority: 5 }])
-    expect(instance.providers[:bar]).to eq(["baz", { foo: "bar" }])
+    expect(instance.providers[:bar]).to eq(["baz", { foo: "bar", priority: 5 }])
   end
 
   it "provides the collection of registered provider configs" do

test/unit/vagrant/plugin/v2/plugin_test.rb

@@ -249,7 +249,9 @@ describe Vagrant::Plugin::V2::Plugin do
         provider("foo") { "bar" }
       end
 
-      expect(plugin.components.providers[:foo]).to eq(["bar", {}])
+      result = plugin.components.providers[:foo]
+      expect(result[0]).to eq("bar")
+      expect(result[1][:priority]).to eq(5)
     end
 
     it "should register provider classes with options" do
@@ -257,7 +259,10 @@ describe Vagrant::Plugin::V2::Plugin do
         provider("foo", foo: "yep") { "bar" }
       end
 
-      expect(plugin.components.providers[:foo]).to eq(["bar", { foo: "yep" }])
+      result = plugin.components.providers[:foo]
+      expect(result[0]).to eq("bar")
+      expect(result[1][:priority]).to eq(5)
+      expect(result[1][:foo]).to eq("yep")
     end
 
     it "should lazily register provider classes" do