vaguerent/test/unit/vagrant/plugin/v2/command_test.rb

require File.expand_path("../../../../base", __FILE__)
require 'optparse'

describe Vagrant::Plugin::V2::Command do
  describe "parsing options" do
    let(:klass) do
      Class.new(described_class) do
        # Make the method public since it is normally protected
        public :parse_options
      end
    end

    it "returns the remaining arguments" do
      options = {}
      opts = OptionParser.new do |o|
        o.on("-f") do |f|
          options[:f] = f
        end
      end

      result = klass.new(["-f", "foo"], nil).parse_options(opts)

      # Check the results
      options[:f].should be
      result.should == ["foo"]
    end

    it "creates an option parser if none is given" do
      result = klass.new(["foo"], nil).parse_options(nil)
      result.should == ["foo"]
    end

    ["-h", "--help"].each do |help_string|
      it "returns nil and prints the help if '#{help_string}' is given" do
        instance = klass.new([help_string], nil)
        instance.should_receive(:safe_puts)
        instance.parse_options(OptionParser.new).should be_nil
      end
    end

    it "raises an error if invalid options are given" do
      instance = klass.new(["-f"], nil)
      expect { instance.parse_options(OptionParser.new) }.
        to raise_error(Vagrant::Errors::CLIInvalidOptions)
    end
  end

  describe "target VMs" do
    let(:klass) do
      Class.new(described_class) do
        # Make the method public since it is normally protected
        public :with_target_vms
      end
    end

    let(:default_provider) { :virtualbox }

    let(:environment) do
      env = double("environment")
      env.stub(:active_machines => [])
      env.stub(:default_provider => default_provider)
      env.stub(:root_path => "foo")
      env
    end

    let(:instance)    { klass.new([], environment) }

    it "should raise an exception if a root_path is not available" do
      environment.stub(:root_path => nil)

      expect { instance.with_target_vms }.
        to raise_error(Vagrant::Errors::NoEnvironmentError)
    end

    it "should yield every VM in order is no name is given" do
      foo_vm = double("foo")
      foo_vm.stub(:name => "foo", :provider => :foobarbaz)

      bar_vm = double("bar")
      bar_vm.stub(:name => "bar", :provider => :foobarbaz)

      environment.stub(:machine_names => [:foo, :bar])
      environment.stub(:machine).with(:foo, default_provider).and_return(foo_vm)
      environment.stub(:machine).with(:bar, default_provider).and_return(bar_vm)

      vms = []
      instance.with_target_vms do |vm|
        vms << vm
      end

      vms.should == [foo_vm, bar_vm]
    end

    it "raises an exception if the named VM doesn't exist" do
      environment.stub(:machine_names => [:default])
      environment.stub(:machine).with(:foo, anything).and_return(nil)

      expect { instance.with_target_vms("foo") }.
        to raise_error(Vagrant::Errors::VMNotFoundError)
    end

    it "yields the given VM if a name is given" do
      foo_vm = double("foo")
      foo_vm.stub(:name => "foo", :provider => :foobarbaz)

      environment.stub(:machine).with(:foo, default_provider).and_return(foo_vm)

      vms = []
      instance.with_target_vms("foo") { |vm| vms << vm }
      vms.should == [foo_vm]
    end

    it "yields the given VM with proper provider if given" do
      foo_vm = double("foo")
      provider = :foobarbaz

      foo_vm.stub(:name => "foo", :provider => provider)
      environment.stub(:machine).with(:foo, provider).and_return(foo_vm)

      vms = []
      instance.with_target_vms("foo", :provider => provider) { |vm| vms << vm }
      vms.should == [foo_vm]
    end

    it "should raise an exception if an active machine exists with a different provider" do
      name = :foo

      environment.stub(:active_machines => [[name, :vmware]])
      expect { instance.with_target_vms(name, :provider => :foo) }.
        to raise_error Vagrant::Errors::ActiveMachineWithDifferentProvider
    end

    it "should default to the active machine provider if no explicit provider requested" do
      name = :foo
      provider = :vmware
      vmware_vm = double("vmware_vm")

      environment.stub(:active_machines => [[name, provider]])
      environment.stub(:machine).with(name, provider).and_return(vmware_vm)
      vmware_vm.stub(:name => name, :provider => provider)

      vms = []
      instance.with_target_vms(name) { |vm| vms << vm }
      vms.should == [vmware_vm]
    end

    it "should use the explicit provider if it maches the active machine" do
      name = :foo
      provider = :vmware
      vmware_vm = double("vmware_vm")

      environment.stub(:active_machines => [[name, provider]])
      environment.stub(:machine).with(name, provider).and_return(vmware_vm)
      vmware_vm.stub(:name => name, :provider => provider)

      vms = []
      instance.with_target_vms(name, :provider => provider) { |vm| vms << vm }
      vms.should == [vmware_vm]
    end

    it "should use the default provider if none is given and none are active" do
      name = :foo
      machine = double("machine")

      environment.stub(:machine).with(name, default_provider).and_return(machine)
      machine.stub(:name => name, :provider => default_provider)

      results = []
      instance.with_target_vms(name) { |m| results << m }
      results.should == [machine]
    end

    it "should use the primary machine with the active provider" do
      pending
    end

    it "should use the primary machine with the default provider" do
      pending
    end
  end

  describe "splitting the main and subcommand args" do
    let(:instance) do
      Class.new(described_class) do
        # Make the method public since it is normally protected
        public :split_main_and_subcommand
      end.new(nil, nil)
    end

    it "should work when given all 3 parts" do
      result = instance.split_main_and_subcommand(["-v", "status", "-h", "-v"])
      result.should == [["-v"], "status", ["-h", "-v"]]
    end

    it "should work when given only a subcommand and args" do
      result = instance.split_main_and_subcommand(["status", "-h"])
      result.should == [[], "status", ["-h"]]
    end

    it "should work when given only main flags" do
      result = instance.split_main_and_subcommand(["-v", "-h"])
      result.should == [["-v", "-h"], nil, []]
    end

    it "should work when given only a subcommand" do
      result = instance.split_main_and_subcommand(["status"])
      result.should == [[], "status", []]
    end

    it "works when there are other non-flag args after the subcommand" do
      result = instance.split_main_and_subcommand(["-v", "box", "add", "-h"])
      result.should == [["-v"], "box", ["add", "-h"]]
    end
  end
end