fission 0.4.0 → 0.5.0.beta.1

data/lib/fission/vm_configuration.rb

@@ -0,0 +1,79 @@
+module Fission
+
+  class VMConfiguration
+
+    # Internal: Creates a new VMConfiguration object.  This accepts a VM object
+    #
+    # vm - An instance of VM
+    #
+    # Examples:
+    #
+    #   Fission::VMConfiguration.new @my_vm
+    #
+    # Returns a new VMConfiguration object
+    def initialize(vm)
+      @vm = vm
+    end
+
+    # Internal: Gathers the the configuration data for the VM.  This essentially
+    # parses the key/value pairs from the configuration file (.vmx) into a Hash.
+    #
+    # Exaples:
+    #
+    #   @vm_config.config_data.data
+    #   # => { 'memsize' => '384', 'ethernet0.present' => 'TRUE',... }
+    #
+    # Returns a Response object with the result.
+    # If successful, the Response's data attribute will be a Hash.  All keys and
+    # values are represented as a String (even when the value in the
+    # configuration file is 'TRUE').  If a value is an empty string in the
+    # configuration file, it will be represented in the Hash as an empty String.
+    # If there is an error, an unsuccessful Response will be returned.
+    def config_data
+      return Response.new :code => 1, :message => 'VM does not exist' unless @vm.exists?
+
+      conf_file_response = @vm.conf_file
+      return conf_file_response unless conf_file_response.successful?
+
+      @conf_file_location = conf_file_response.data
+
+      Response.new :code => 0, :data => parse_vm_config_file
+    end
+
+    private
+    # Internal: Parses the configuration file (i.e. '.vmx')
+    #
+    # Examples:
+    #
+    #   @vm_config.parse_vm_config_file
+    #   # => { 'memsize' => '384', 'ethernet0.present' => 'TRUE',... }
+    #
+    # Returns a Hash.
+    # All keys and values are represented as a String (even when the value in
+    # the conf file is 'TRUE').  If a value is an empty string in the
+    # configuration file, it will be represented in the Hash as an empty String.
+    def parse_vm_config_file
+      File.readlines(@conf_file_location).inject({}) do |result, line|
+        data = parse_line_data(line)
+        result[data[0]] = (data[1].nil? ? '' : data[1])
+        result
+      end
+    end
+
+    # Internal: Splits and formats a single line from a VM configuration file
+    # into an Array.
+    #
+    # Examples:
+    #
+    #   @vm_config.parse_line_data('foo = "bar"')
+    #
+    # Returns an Array.  The first item will be the left side of the '=' and the
+    # second item will be the right side.  This will also strip any whitespace
+    # characters from the beginning or end of the provided line.
+    def parse_line_data(line)
+      line.strip.gsub('"', '').split ' = '
+    end
+
+  end
+
+end

data/spec/fission/action/execute_shell_command_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Fission::Action::ShellExecutor do
+
+  describe 'execute' do
+    before do
+      @cmd = 'ls /var/log'
+      @executor = Fission::Action::ShellExecutor.new @cmd
+    end
+
+    it 'should execute the shell command' do
+      @executor.should_receive(:`).with(@cmd)
+      @executor.execute
+    end
+
+    it 'should return a hash of the output and Process::Status object' do
+      result = @executor.execute
+      result['output'].should be_a String
+      result['output'].empty?.should be_false
+      result['process_status'].should be_a Process::Status
+    end
+
+  end
+
+end

data/spec/fission/action/snapshot/creator_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Fission::Action::Snapshot::Creator do
+  describe 'create_snapshot' do
+    before do
+      @vm                      = Fission::VM.new 'foo'
+      @conf_file_path          = File.join @vm.path, 'foo.vmx'
+      @vmrun_cmd               = Fission.config['vmrun_cmd']
+      @conf_file_response_mock = mock 'conf_file_response'
+      @snapshots_response_mock = mock 'snapshots'
+      @running_response_mock   = mock 'running?'
+
+      @running_response_mock.stub_as_successful true
+      @conf_file_response_mock.stub_as_successful @conf_file_path
+      @snapshots_response_mock.stub_as_successful []
+
+      @vm.stub(:exists?).and_return(true)
+      @vm.stub(:snapshots).and_return(@snapshots_response_mock)
+      @vm.stub(:running?).and_return(@running_response_mock)
+      @vm.stub(:conf_file).and_return(@conf_file_response_mock)
+      @creator = Fission::Action::Snapshot::Creator.new @vm
+    end
+
+    it "should return an unsuccessful response if the vm doesn't exist" do
+      @vm.stub(:exists?).and_return(false)
+      @creator.create_snapshot('snap_1').should be_an_unsuccessful_response 'VM does not exist'
+    end
+
+    it 'should return an unsuccessful response if the vm is not running' do
+      @running_response_mock.stub_as_successful false
+
+      response = @creator.create_snapshot 'snap_1'
+      error_message = 'The VM must be running in order to take a snapshot.'
+      response.should be_an_unsuccessful_response error_message
+    end
+
+    it 'should return an unsuccessful response if unable to determine if running' do
+      @running_response_mock.stub_as_unsuccessful
+      @creator.create_snapshot('snap_1').should be_an_unsuccessful_response
+    end
+
+    it 'should return an unsuccessful response if unable to figure out the conf file' do
+      @conf_file_response_mock.stub_as_unsuccessful
+      @creator.create_snapshot('snap_1').should be_an_unsuccessful_response
+    end
+
+    it 'should return a response when creating the snapshot' do
+      executor_mock = mock 'executor'
+      response      = stub
+      cmd           = "#{@vmrun_cmd} snapshot "
+      cmd           << "'#{@conf_file_path}' \"bar\" 2>&1"
+
+      executor_mock.should_receive(:execute).and_return(executor_mock)
+      Fission::Action::ShellExecutor.should_receive(:new).
+                                     with(cmd).
+                                     and_return(executor_mock)
+      Fission::Response.should_receive(:from_shell_executor).
+                        with(executor_mock).
+                        and_return(response)
+
+      @creator.create_snapshot('bar').should == response
+    end
+
+    it 'should return an unsuccessful response if the snapshot name is a duplicate' do
+      @snapshots_response_mock.stub_as_successful ['snap_1']
+      response = @creator.create_snapshot 'snap_1'
+      response.should be_an_unsuccessful_response "There is already a snapshot named 'snap_1'."
+    end
+
+    it 'should return an unsuccessful response if there was a problem listing the existing snapshots' do
+      @snapshots_response_mock.stub_as_unsuccessful
+      @creator.create_snapshot('snap_1').should be_an_unsuccessful_response
+    end
+
+  end
+
+end

data/spec/fission/action/snapshot/deleter_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Fission::Action::Snapshot::Deleter do
+
+  describe 'delete_snapshot' do
+    before do
+      @vm                      = Fission::VM.new 'foo'
+      @conf_file_path          = File.join @vm.path, 'foo.vmx'
+      @vmrun_cmd               = Fission.config['vmrun_cmd']
+      @conf_file_response_mock = mock 'conf_file_response'
+      @snapshots_response_mock = mock 'snapshots'
+      @running_response_mock   = mock 'running?'
+
+      @running_response_mock.stub_as_successful true
+      @conf_file_response_mock.stub_as_successful @conf_file_path
+      @snapshots_response_mock.stub_as_successful ['snap_1']
+
+      @vm.stub(:exists?).and_return(true)
+      @vm.stub(:snapshots).and_return(@snapshots_response_mock)
+      @vm.stub(:running?).and_return(@running_response_mock)
+      @vm.stub(:conf_file).and_return(@conf_file_response_mock)
+      Fission::Fusion.stub(:running?).and_return(false)
+      @deleter = Fission::Action::Snapshot::Deleter.new @vm
+    end
+
+    it "should return an unsuccessful response if the vm doesn't exist" do
+      @vm.stub(:exists?).and_return(false)
+      @deleter.delete_snapshot('snap_1').should be_an_unsuccessful_response 'VM does not exist'
+    end
+
+    it 'should return an unsuccessful response if unable to figure out the conf file' do
+      @conf_file_response_mock.stub_as_unsuccessful
+      @deleter.delete_snapshot('snap_1').should be_an_unsuccessful_response
+    end
+
+    it 'should return an unsuccessful response if the snapshot does not exist' do
+      @snapshots_response_mock.stub_as_successful []
+      response = @deleter.delete_snapshot 'snap_1'
+      response.should be_an_unsuccessful_response "Unable to find a snapshot named 'snap_1'."
+    end
+
+    it 'should return an unsuccessful response if there was a problem listing the existing snapshots' do
+      @snapshots_response_mock.stub_as_unsuccessful
+      @deleter.delete_snapshot('snap_1').should be_an_unsuccessful_response
+    end
+
+    it 'should return a response when deleting the snapshot' do
+      executor_mock = mock 'executor'
+      response      = stub
+      cmd           = "#{@vmrun_cmd} deleteSnapshot "
+      cmd           << "'#{@conf_file_path}' \"snap_1\" 2>&1"
+
+      executor_mock.should_receive(:execute).and_return(executor_mock)
+      Fission::Action::ShellExecutor.should_receive(:new).
+                                     with(cmd).
+                                     and_return(executor_mock)
+      Fission::Response.should_receive(:from_shell_executor).
+                        with(executor_mock).
+                        and_return(response)
+
+      @deleter.delete_snapshot('snap_1').should == response
+    end
+
+    context 'when the gui is running' do
+      before do
+        Fission::Fusion.stub(:running?).and_return(true)
+      end
+
+      it 'should return an unsuccessful response if the vm is not running' do
+        @running_response_mock.stub_as_successful false
+        response = @deleter.delete_snapshot 'snap_1'
+        error_message = 'A snapshot cannot be deleted when the GUI is running and the VM is not running.'
+        response.should be_an_unsuccessful_response error_message
+      end
+
+      it 'should return an unsuccessful response if unable to determine if running' do
+        @running_response_mock.stub_as_unsuccessful
+        @deleter.delete_snapshot('snap_1').should be_an_unsuccessful_response
+      end
+    end
+
+  end
+
+end

data/spec/fission/action/snapshot/lister_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Fission::Action::Snapshot::Lister do
+  before do
+    @vm                      = Fission::VM.new 'foo'
+    @conf_file_path          = File.join @vm.path, 'foo.vmx'
+    @vmrun_cmd               = Fission.config['vmrun_cmd']
+    @conf_file_response_mock = mock 'conf_file_response'
+    @vm.stub(:conf_file).and_return(@conf_file_response_mock)
+  end
+
+  describe 'snapshots' do
+    before do
+      @vm.stub(:exists?).and_return(true)
+      @conf_file_response_mock.stub_as_successful @conf_file_path
+      @lister = Fission::Action::Snapshot::Lister.new @vm
+    end
+
+    it "should return an unsuccessful repsonse when the vm doesn't exist" do
+      @vm.stub(:exists?).and_return(false)
+      @lister.snapshots.should be_an_unsuccessful_response 'VM does not exist'
+    end
+
+    it 'should return an unsuccessful response if unable to figure out the conf file' do
+      @conf_file_response_mock.stub_as_unsuccessful
+      @lister.snapshots.should be_an_unsuccessful_response
+    end
+
+    it 'should return a response when listing the snapshots' do
+      executor_mock = mock 'executor'
+      process_mock  = stub :exitstatus => 0
+      cmd           = "#{@vmrun_cmd} listSnapshots "
+      cmd           << "'#{@conf_file_path}' 2>&1"
+
+      output_text = "Total snapshots: 3\nsnap foo\nsnap bar\nsnap baz\n"
+      executor_mock.should_receive(:execute).
+                    and_return({'output'         => output_text,
+                                'process_status' => process_mock})
+
+      Fission::Action::ShellExecutor.should_receive(:new).
+                                     with(cmd).
+                                     and_return(executor_mock)
+
+      response = @lister.snapshots
+      response.should be_a_successful_response
+      response.data.should == ['snap foo', 'snap bar', 'snap baz']
+    end
+
+    it 'should return an unsuccessful response if there was a problem listing the snapshots' do
+      executor_mock = mock 'executor'
+      process_mock  = stub :exitstatus => 1
+      cmd           = "#{@vmrun_cmd} listSnapshots "
+      cmd           << "'#{@conf_file_path}' 2>&1"
+
+      executor_mock.should_receive(:execute).
+                    and_return({'output'         => 'it blew up',
+                                'process_status' => process_mock})
+
+      Fission::Action::ShellExecutor.should_receive(:new).
+                                     with(cmd).
+                                     and_return(executor_mock)
+
+      @lister.snapshots.should be_an_unsuccessful_response
+    end
+  end
+
+end

data/spec/fission/action/snapshot/reverter_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Fission::Action::Snapshot::Reverter do
+
+  describe 'revert_snapshot' do
+    before do
+      @vm                      = Fission::VM.new 'foo'
+      @conf_file_path          = File.join @vm.path, 'foo.vmx'
+      @vmrun_cmd               = Fission.config['vmrun_cmd']
+      @conf_file_response_mock = mock 'conf_file_response'
+      @snapshots_response_mock = mock 'snapshots'
+
+      @conf_file_response_mock.stub_as_successful @conf_file_path
+      @snapshots_response_mock.stub_as_successful []
+
+      @vm.stub(:exists?).and_return(true)
+      @vm.stub(:snapshots).and_return(@snapshots_response_mock)
+      @vm.stub(:conf_file).and_return(@conf_file_response_mock)
+      @snapshots_response_mock.stub_as_successful ['snap_1']
+      Fission::Fusion.stub(:running?).and_return(false)
+      @reverter = Fission::Action::Snapshot::Reverter.new @vm
+    end
+
+    it "should return an unsuccessful response if the vm doesn't exist" do
+      @vm.stub(:exists?).and_return(false)
+      @reverter.revert_to_snapshot('snap_1').should be_an_unsuccessful_response 'VM does not exist'
+    end
+
+    it 'should return an unsuccessful response if the Fusion GUI is running' do
+      Fission::Fusion.stub(:running?).and_return(true)
+
+      response = @reverter.revert_to_snapshot 'snap_1'
+
+      error_string = 'It looks like the Fusion GUI is currently running.  '
+      error_string << 'A VM cannot be reverted to a snapshot when the Fusion GUI is running.'
+      error_string << '  Exit the Fusion GUI and try again.'
+
+      response.should be_an_unsuccessful_response error_string
+    end
+
+    it 'should return an unsuccessful response if unable to figure out the conf file' do
+      @conf_file_response_mock.stub_as_unsuccessful
+      @reverter.revert_to_snapshot('snap_1').should be_an_unsuccessful_response
+    end
+
+    it 'should return a response when reverting to the snapshot' do
+      executor_mock = mock 'executor'
+      response      = stub
+      cmd           = "#{@vmrun_cmd} revertToSnapshot "
+      cmd           << "'#{@conf_file_path}' \"snap_1\" 2>&1"
+
+      executor_mock.should_receive(:execute).and_return(executor_mock)
+      Fission::Action::ShellExecutor.should_receive(:new).
+                                     with(cmd).
+                                     and_return(executor_mock)
+      Fission::Response.should_receive(:from_shell_executor).
+                        with(executor_mock).
+                        and_return(response)
+
+      @reverter.revert_to_snapshot('snap_1').should == response
+    end
+
+    it 'should return an unsuccessful response if the snapshot cannot be found' do
+      @snapshots_response_mock.stub_as_successful []
+      response = @reverter.revert_to_snapshot 'snap_1'
+      response.should be_an_unsuccessful_response "Unable to find a snapshot named 'snap_1'."
+    end
+
+    it 'should return an unsuccessful response if unable to list the existing snapshots' do
+      @snapshots_response_mock.stub_as_unsuccessful
+      @reverter.revert_to_snapshot('snap_1').should be_an_unsuccessful_response
+    end
+
+  end
+
+end

data/spec/fission/action/vm/cloner_spec.rb

@@ -0,0 +1,198 @@
+require 'spec_helper'
+
+describe Fission::Action::VM::Cloner do
+
+  describe 'clone' do
+    before do
+      @source_vm   = Fission::VM.new 'foo'
+      @target_vm   = Fission::VM.new 'bar'
+      @source_path = @source_vm.path
+      @target_path = @target_vm.path
+
+      @clone_response_mock = mock('clone_response')
+      @vm_files = ['.vmx', '.vmxf', '.vmdk', '-s001.vmdk', '-s002.vmdk', '.vmsd']
+
+      FakeFS.activate!
+
+      FileUtils.mkdir_p @source_path
+
+      @vm_files.each do |file|
+        FileUtils.touch "#{@source_path}/#{@source_vm.name}#{file}"
+      end
+
+      ['.vmx', '.vmxf', '.vmdk'].each do |ext|
+        File.open("#{@source_path}/foo#{ext}", 'w') { |f| f.write 'foo.vmdk'}
+      end
+
+      @source_vm.stub(:exists?).and_return(true)
+      @target_vm.stub(:exists?).and_return(false)
+
+      Fission::VM.stub(:new).with(@source_vm.name).
+                             and_return(@source_vm)
+      Fission::VM.stub(:new).with(@target_vm.name).
+                             and_return(@target_vm)
+
+      vmx_content = 'ide1:0.deviceType = "cdrom-image"
+nvram = "foo.nvram"
+ethernet0.present = "TRUE"
+ethernet1.address = "00:0c:29:1d:6a:75"
+ethernet0.connectionType = "nat"
+ethernet0.generatedAddress = "00:0c:29:1d:6a:64"
+ethernet0.virtualDev = "e1000"
+tools.remindInstall = "TRUE"
+ethernet0.wakeOnPcktRcv = "FALSE"
+ethernet0.addressType = "generated"
+uuid.action = "keep"
+ethernet0.linkStatePropagation.enable = "TRUE"
+ethernet0.generatedAddressenable = "TRUE"
+ethernet1.generatedAddressenable = "TRUE"'
+
+      File.open("#{@source_path}/#{@source_vm.name}.vmx", 'w') do |f|
+        f.write vmx_content
+      end
+
+      ['.vmx', '.vmxf'].each do |ext|
+        File.stub(:binary?).
+             with("#{@target_path}/#{@target_vm.name}#{ext}").
+             and_return(false)
+      end
+
+      File.stub(:binary?).
+           with("#{@target_path}/#{@target_vm.name}.vmdk").
+           and_return(true)
+      @cloner = Fission::Action::VM::Cloner.new @source_vm, @target_vm
+    end
+
+    after do
+      FakeFS.deactivate!
+      FakeFS::FileSystem.clear
+    end
+
+    it "should return an unsuccessful response if the source vm doesn't exist" do
+      @source_vm.stub(:exists?).and_return(false)
+      response = @cloner.clone
+      response.should be_an_unsuccessful_response 'VM does not exist'
+    end
+
+    it "should return an unsuccessful response if the target vm exists" do
+      @target_vm.stub(:exists?).and_return(true)
+      response = @cloner.clone
+      response.should be_an_unsuccessful_response 'VM already exists'
+    end
+
+    it 'should copy the vm files to the target' do
+      @cloner.clone
+
+      File.directory?(@target_path).should == true
+
+      @vm_files.each do |file|
+        File.file?("#{@target_path}/bar#{file}").should == true
+      end
+    end
+
+    it "should copy the vm files to the target if a file name doesn't match the directory" do
+      FileUtils.touch "#{@source_path}/other_name.nvram"
+
+      @cloner.clone
+
+      File.directory?(@target_path).should == true
+
+      @vm_files.each do |file|
+        File.file?("#{@target_path}/#{@target_vm.name}#{file}").should == true
+      end
+
+      File.file?("#{@target_path}/bar.nvram").should == true
+    end
+
+    it "should copy the vm files to the target if a sparse disk file name doesn't match the directory" do
+      FileUtils.touch "#{@source_path}/other_name-s003.vmdk"
+
+      @cloner.clone
+
+      File.directory?(@target_path).should == true
+
+      @vm_files.each do |file|
+        File.file?("#{@target_path}/#{@target_vm.name}#{file}").should == true
+      end
+
+      File.file?("#{@target_path}/bar-s003.vmdk").should == true
+    end
+
+    it 'should update the target vm config files' do
+      @cloner.clone
+
+      ['.vmx', '.vmxf'].each do |ext|
+        File.read("#{@target_path}/bar#{ext}").should_not match /foo/
+        File.read("#{@target_path}/bar#{ext}").should match /bar/
+      end
+    end
+
+    it 'should disable VMware tools warning in the conf file' do
+      @cloner.clone
+      pattern = /^tools\.remindInstall = "FALSE"/
+      File.read("#{@target_path}/bar.vmx").should match pattern
+    end
+
+    it 'should remove auto generated MAC addresses from the conf file' do
+      @cloner.clone
+      pattern = /^ethernet\.+generatedAddress.+/
+      File.read("#{@target_path}/bar.vmx").should_not match pattern
+    end
+
+    it 'should setup the conf file to generate a new uuid' do
+      @cloner.clone
+      pattern = /^uuid\.action = "create"/
+      File.read("#{@target_path}/bar.vmx").scan(pattern).count.should == 1
+    end
+
+    context 'when uuid.action already exists in the source conf file' do
+      before do
+        File.open("#{@source_path}/#{@source_vm.name}.vmx", 'a') do |f|
+          f.write "\nuuid.action = \"create\""
+        end
+      end
+
+      it 'should not add another entry for uuid.action' do
+        @cloner.clone
+        pattern = /^uuid\.action = "create"/
+        File.read("#{@target_path}/bar.vmx").scan(pattern).count.should == 1
+      end
+    end
+
+    context 'when tools.remindInstall already exists in the source conf file' do
+      before do
+        File.open("#{@source_path}/#{@source_vm.name}.vmx", 'w') do |f|
+          f.write "\ntools.remindInstall = \"FALSE\""
+        end
+      end
+
+      it 'should not add another entry for tools.remindInstall' do
+        @cloner.clone
+        pattern = /^tools\.remindInstall = "FALSE"/
+        File.read("#{@target_path}/bar.vmx").scan(pattern).count.should == 1
+      end
+    end
+
+    it "should not try to update the vmdk file if it's not a sparse disk" do
+      @cloner.clone
+      File.read("#{@target_path}/bar.vmdk").should match /foo/
+    end
+
+    it 'should return a successful response if clone was successful' do
+      @cloner.clone.should be_a_successful_response
+    end
+
+    context 'when a sparse disk is found' do
+      it "should update the vmdk" do
+        File.rspec_reset
+        File.stub(:binary?).and_return(false)
+
+        @cloner.clone
+
+        File.read("#{@target_path}/bar.vmdk").should match /bar/
+      end
+    end
+
+  end
+
+end