vagrant/test/vagrant/vm_test.rb

require File.join(File.dirname(__FILE__), '..', 'test_helper')

class VMTest < Test::Unit::TestCase
  setup do
    @mock_vm = mock("vm")
    mock_config

    @persisted_vm = mock("persisted_vm")
    Vagrant::Env.stubs(:persisted_vm).returns(@persisted_vm)

    Net::SSH.stubs(:start)
  end

  context "vagrant ssh" do
    setup do
      Vagrant::SSH.stubs(:connect)
    end

    should "require a persisted VM" do
      Vagrant::Env.expects(:require_persisted_vm).once
      Vagrant::VM.ssh
    end

    should "connect to SSH" do
      Vagrant::SSH.expects(:connect).once
      Vagrant::VM.ssh
    end
  end

  context "vagrant down" do
    setup do
      @persisted_vm.stubs(:destroy)
    end

    should "require a persisted VM" do
      Vagrant::Env.expects(:require_persisted_vm).once
      Vagrant::VM.down
    end

    should "destroy the persisted VM and the VM image" do
      @persisted_vm.expects(:destroy).once
      Vagrant::VM.down
    end
  end

  context "vagrant up" do
    should "create a Vagrant::VM instance and call create" do
      inst = mock("instance")
      inst.expects(:create).once
      Vagrant::VM.expects(:new).returns(inst)
      Vagrant::VM.up
    end
  end

  context "finding a VM" do
    should "return nil if the VM is not found" do
      VirtualBox::VM.expects(:find).returns(nil)
      assert_nil Vagrant::VM.find("foo")
    end

    should "return a Vagrant::VM object for that VM otherwise" do
      VirtualBox::VM.expects(:find).with("foo").returns("bar")
      result = Vagrant::VM.find("foo")
      assert result.is_a?(Vagrant::VM)
      assert_equal "bar", result.vm
    end
  end

  context "vagrant VM instance" do
    setup do
      @vm = Vagrant::VM.new(@mock_vm)
    end

    context "creating" do
      should "create the VM in the proper order" do
        prov = mock("prov")
        create_seq = sequence("create_seq")
        Vagrant::Provisioning.expects(:new).with(@vm).in_sequence(create_seq).returns(prov)
        @vm.expects(:import).in_sequence(create_seq)
        @vm.expects(:persist).in_sequence(create_seq)
        @vm.expects(:setup_mac_address).in_sequence(create_seq)
        @vm.expects(:forward_ports).in_sequence(create_seq)
        @vm.expects(:setup_shared_folders).in_sequence(create_seq)
        @vm.expects(:start).in_sequence(create_seq)
        @vm.expects(:mount_shared_folders).in_sequence(create_seq)
        prov.expects(:run).in_sequence(create_seq)
        @vm.create
      end
    end

    context "destroying" do
      setup do
        @mock_vm.stubs(:running?).returns(false)
      end

      should "destoy the VM along with images" do
        @mock_vm.expects(:destroy).with(:destroy_image => true).once
        @vm.destroy
      end

      should "stop the VM if its running" do
        @mock_vm.expects(:running?).returns(true)
        @mock_vm.expects(:stop).with(true)
        @mock_vm.expects(:destroy).with(:destroy_image => true).once
        @vm.destroy
      end
    end

    context "starting" do
      setup do
        @mock_vm.stubs(:start)
      end

      should "start the VM in headless mode" do
        @mock_vm.expects(:start).with(:headless, true).once
        Vagrant::SSH.expects(:up?).once.returns(true)
        @vm.start
      end

      should "repeatedly ping the SSH port and return false with no response" do
        seq = sequence('pings')
        Vagrant::SSH.expects(:up?).times(Vagrant.config[:ssh][:max_tries].to_i - 1).returns(false).in_sequence(seq)
        Vagrant::SSH.expects(:up?).once.returns(true).in_sequence(seq)
        assert @vm.start
      end

      should "ping the max number of times then just return" do
        Vagrant::SSH.expects(:up?).times(Vagrant.config[:ssh][:max_tries].to_i).returns(false)
        assert !@vm.start
      end
    end

    context "importing" do
      should "call import on VirtualBox::VM with the proper base" do
        VirtualBox::VM.expects(:import).once
        @vm.import
      end

      should "return the VM object" do
        VirtualBox::VM.expects(:import).returns(@mock_vm).once
        assert_equal @mock_vm, @vm.import
      end
    end

    context "persisting" do
      should "persist the VM with Env" do
        @mock_vm.stubs(:uuid)
        Vagrant::Env.expects(:persist_vm).with(@mock_vm).once
        @vm.persist
      end
    end

    context "setting up MAC address" do
      should "match the mac address with the base" do
        nic = mock("nic")
        nic.expects(:macaddress=).once

        @mock_vm.expects(:nics).returns([nic]).once
        @mock_vm.expects(:save).with(true).once

        @vm.setup_mac_address
      end
    end

    context "forwarding ports" do
      should "create a port forwarding for the VM" do
        # TODO: Test the actual port value to make sure it has the
        # correct attributes
        forwarded_ports = mock("forwarded_ports")
        forwarded_ports.expects(:<<)
        @mock_vm.expects(:forwarded_ports).returns(forwarded_ports)
        @mock_vm.expects(:save).with(true).once
        @vm.forward_ports
      end
    end

    context "suspending and resuming a vm" do
      should "put the vm in a suspended state" do
        saved_state_expectation(false)
        save_expectation
        Vagrant::VM.suspend
      end

      should "results in an error and exit if the vm is already in a saved state" do
        saved_state_expectation(true)
        save_expectation
        Vagrant::VM.expects(:error_and_exit)
        Vagrant::VM.suspend
      end

      should "start a vm in a suspended state" do
        saved_state_expectation(true)
        start_expectation
        Vagrant::VM.resume
      end

      should "results in an error and exit if the vm is not in a saved state" do
        saved_state_expectation(false)
        start_expectation
        # TODO research the matter of mocking exit
        Vagrant::VM.expects(:error_and_exit)
        Vagrant::VM.resume
      end

      def saved_state_expectation(saved)
        @persisted_vm.expects(:saved?).returns(saved)
      end

      def save_expectation
        @persisted_vm.expects(:save_state).with(true)
      end

      def start_expectation
        Vagrant::Env.persisted_vm.expects(:start).once.returns(true)
      end
    end

    context "shared folders" do
      setup do
        @mock_vm = mock("mock_vm")
        @vm = Vagrant::VM.new(@mock_vm)
      end

      should "not have any shared folders initially" do
        assert @vm.shared_folders.empty?
      end

      should "be able to add shared folders" do
        @vm.share_folder("foo", "from", "to")
        assert_equal 1, @vm.shared_folders.length
      end

      should "be able to clear shared folders" do
        @vm.share_folder("foo", "from", "to")
        assert !@vm.shared_folders.empty?
        @vm.shared_folders(true)
        assert @vm.shared_folders.empty?
      end

      should "add all shared folders to the VM with 'setup_shared_folders'" do
        @vm.share_folder("foo", "from", "to")
        @vm.share_folder("bar", "bfrom", "bto")

        share_seq = sequence("share_seq")
        shared_folders = mock("shared_folders")
        shared_folders.expects(:<<).in_sequence(share_seq).with() { |sf| sf.name == "foo" && sf.hostpath == "from" }
        shared_folders.expects(:<<).in_sequence(share_seq).with() { |sf| sf.name == "bar" && sf.hostpath == "bfrom" }
        @mock_vm.stubs(:shared_folders).returns(shared_folders)
        @mock_vm.expects(:save).with(true).once

        @vm.setup_shared_folders
      end

      should "mount all shared folders to the VM with `mount_shared_folders`" do
        @vm.share_folder("foo", "from", "to")
        @vm.share_folder("bar", "bfrom", "bto")

        mount_seq = sequence("mount_seq")
        ssh = mock("ssh")
        @vm.shared_folders.each do |name, hostpath, guestpath|
          ssh.expects(:exec!).with("sudo mkdir -p #{guestpath}").in_sequence(mount_seq)
          ssh.expects(:exec!).with("sudo mount -t vboxsf #{name} #{guestpath}").in_sequence(mount_seq)
          ssh.expects(:exec!).with("sudo chown #{Vagrant.config.ssh.username} #{guestpath}").in_sequence(mount_seq)
        end
        Vagrant::SSH.expects(:execute).yields(ssh)

        @vm.mount_shared_folders
      end
    end

    context "creating a new vm with a specified disk storage location" do
      should "error and exit of the vm is not powered off" do
        # Exit does not prevent method from proceeding in test, so we must set expectations
        vm = move_hd_expectations
        @mock_vm.expects(:powered_off?).returns(false)
        vm.expects(:error_and_exit)
        vm.move_hd
      end

      should "create assign a new disk image, and delete the old one" do
        vm = move_hd_expectations
        @mock_vm.expects(:powered_off?).returns(true)
        vm.move_hd
      end

      def move_hd_expectations
        image, hd = mock('image'), mock('hd')

        Vagrant.config[:vm].expects(:hd_location).at_least_once.returns('/locations/')
        image.expects(:clone).with(Vagrant.config[:vm][:hd_location] + 'foo', Vagrant::VM::HD_EXT_DEFAULT, true).returns(image)
        image.expects(:filename).twice.returns('foo')

        hd.expects(:image).twice.returns(image)
        hd.expects(:image=).with(image)

        image.expects(:destroy)

        @mock_vm.expects(:save)

        vm = Vagrant::VM.new(@mock_vm)
        vm.expects(:hd).times(3).returns(hd)
        vm
      end
    end
  end
end