fission 0.4.0 → 0.5.0.beta.1

data/lib/fission/action/snapshot/reverter.rb

@@ -0,0 +1,81 @@
+module Fission
+  module Action
+    module Snapshot
+
+      class Reverter
+
+        # Internal: Creates a new SnapshotReverter object.  This accepts a VM
+        # object.
+        #
+        # vm - An instance of VM
+        #
+        # Examples:
+        #
+        #   Fission::Action::SnapshotReverter.new @my_vm
+        #
+        # Returns a new SnapshotReverter object
+        def initialize(vm)
+          @vm = vm
+        end
+
+        # Public: Reverts the VM to the specified snapshot.  The snapshot to
+        # revert to must exist and the Fusion GUI must not be running.
+        #
+        # name - The snapshot name to revert to.
+        #
+        # Examples
+        #
+        #   @reverter.revert_to_snapshot('foo_snap_1')
+        #
+        # Returns a Response with the result.
+        # If successful, the Response's data attribute will be nil.
+        # If there is an error, an unsuccessful Response will be returned.
+        def revert_to_snapshot(name)
+          unless @vm.exists?
+            return Response.new :code => 1, :message => 'VM does not exist'
+          end
+
+          if Fusion.running?
+            message = 'It looks like the Fusion GUI is currently running.  '
+            message << 'A VM cannot be reverted to a snapshot when the Fusion GUI is running.  '
+            message << 'Exit the Fusion GUI and try again.'
+            return Response.new :code => 1, :message => message
+          end
+
+          conf_file_response = @vm.conf_file
+          return conf_file_response unless conf_file_response.successful?
+
+          snapshots_response = @vm.snapshots
+          return snapshots_response unless snapshots_response.successful?
+
+          unless snapshots_response.data.include? name
+            message = "Unable to find a snapshot named '#{name}'."
+            return Response.new :code => 1, :message => message
+          end
+
+          command = "#{vmrun_cmd} revertToSnapshot "
+          command << "'#{conf_file_response.data}' \"#{name}\" 2>&1"
+
+          command_exec = Fission::Action::ShellExecutor.new command
+          Response.from_shell_executor command_exec.execute
+        end
+
+        private
+        # Internal: Helper for getting the configured vmrun_cmd value.
+        #
+        # Examples
+        #
+        #   @reverter.vmrun_cmd
+        #   # => "/foo/bar/vmrun -T fusion"
+        #
+        # Returns a String for the configured value of
+        # Fission.config['vmrun_cmd'].
+        def vmrun_cmd
+          Fission.config['vmrun_cmd']
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fission/action/vm/cloner.rb

@@ -0,0 +1,191 @@
+module Fission
+  module Action
+    module VM
+
+      class Cloner
+
+        # Internal: Creates a new VMCloner object.  This accepts a source and
+        # target VM object.
+        #
+        # source_vm - An instance of VM
+        # target_vm - An instance of VM
+        #
+        # Examples:
+        #
+        #   Fission::Action::VMCloner.new @my_source_vm, @my_target_vm
+        #
+        # Returns a new VMCloner object.
+        def initialize(source_vm, target_vm)
+          @source_vm = source_vm
+          @target_vm = target_vm
+        end
+
+        # Public: Creates a new VM which is a clone of an existing VM. As
+        # Fusion doesn't provide a native cloning mechanism, this is a best
+        # effort. This essentially is a directory copy with updates to relevant
+        # files. It's recommended to clone VMs which are not running.
+        #
+        # Examples
+        #
+        #   @cloner.clone
+        #
+        # Returns a Response with the result.
+        # If successful, the Response's data attribute will be nil.
+        # If there is an error, an unsuccessful Response will be returned.
+        def clone
+          unless @source_vm.exists?
+            return Response.new :code => 1, :message => 'VM does not exist'
+          end
+
+          if @target_vm.exists?
+            return Response.new :code => 1, :message => 'VM already exists'
+          end
+
+          FileUtils.cp_r @source_vm.path, @target_vm.path
+
+          rename_vm_files @source_vm.name, @target_vm.name
+          update_config @source_vm.name, @target_vm.name
+
+          Response.new :code => 0
+        end
+
+        private
+        # Internal: Renames the files of a newly cloned VM.
+        #
+        # from - The VM name that was used as the source of the clone.
+        # to   - The name of the newly cloned VM.
+        #
+        # Examples
+        #
+        #   @cloner.rename_vm_files 'foo', 'bar'
+        #
+        # Returns nothing.
+        def rename_vm_files(from, to)
+          files_to_rename(from, to).each do |file|
+            text_to_replace = File.basename(file, File.extname(file))
+
+            if File.extname(file) == '.vmdk'
+              if file.match /\-s\d+\.vmdk/
+                text_to_replace = file.partition(/\-s\d+.vmdk/).first
+              end
+            end
+
+            unless File.exists?(File.join(@target_vm.path, file.gsub(text_to_replace, to)))
+              FileUtils.mv File.join(@target_vm.path, file),
+                File.join(@target_vm.path, file.gsub(text_to_replace, to))
+            end
+          end
+        end
+
+        # Internal: Provides the list of files which need to be renamed in a
+        # newly cloned VM directory.
+        #
+        # from - The VM name that was used as the source of the clone.
+        # to   - The name of the newly cloned VM.
+        #
+        # Examples
+        #
+        #   @cloner.files_to_rename 'foo', 'bar'
+        #   # => ['/vms/vm1/foo.vmdk', '/vms/vm1/foo.vmx', 'vms/vm1/blah.other']
+        #
+        # Returns an Array containing the paths (String) to the files to rename.
+        # The paths which match the from name will preceed any other files
+        # found in the newly cloned VM directory.
+        def files_to_rename(from, to)
+          files_which_match_source_vm = []
+          other_files = []
+
+          Dir.entries(@target_vm.path).each do |f|
+            unless f == '.' || f == '..'
+              f.include?(from) ? files_which_match_source_vm << f : other_files << f
+            end
+          end
+
+          files_which_match_source_vm + other_files
+        end
+
+        # Internal: Provides the list of file extensions for VM related files.
+        #
+        # Examples
+        #
+        #   @cloner.vm_file_extension
+        #   # => ['.nvram', '.vmdk', '.vmem']
+        #
+        # Returns an Array containing the file extensions of VM realted files.
+        # The file extensions returned are Strings and include a '.'.
+        def vm_file_extensions
+          ['.nvram', '.vmdk', '.vmem', '.vmsd', '.vmss', '.vmx', '.vmxf']
+        end
+
+        # Internal: Updates config files for a newly cloned VM.  This will
+        # update any files with the extension of '.vmx', '.vmxf', and '.vmdk'.
+        # Any binary '.vmdk' files will be skipped.
+        #
+        # from - The VM name that was used as the source of the clone.
+        # to   - The name of the newly cloned VM.
+        #
+        # Examples
+        #
+        #   @cloner.update_config 'foo', 'bar'
+        #
+        # Returns nothing.
+        def update_config(from, to)
+          ['.vmx', '.vmxf', '.vmdk'].each do |ext|
+            file = File.join @target_vm.path, "#{to}#{ext}"
+
+            unless File.binary?(file)
+              text = (File.read file).gsub from, to
+              File.open(file, 'w'){ |f| f.print text }
+            end
+
+            clean_up_conf_file(file) if ext == '.vmx'
+          end
+        end
+
+        # Internal: Cleans up the conf file (*.vmx) for a newly cloned VM. This
+        # includes removing generated MAC addresses, setting up for a new UUID,
+        # and disable VMware tools warning.
+        #
+        # conf_file_path - Aboslute path to the VM's conf file (.vmx).
+        #
+        # Examples
+        #
+        #   @cloner.clean_up_conf_file '/vms/foo/foo.vmx'
+        #
+        # Returns nothing.
+        def clean_up_conf_file(conf_file_path)
+          conf_items_patterns = { /^tools\.remindInstall.*\n/ => "tools.remindInstall = \"FALSE\"",
+            /^uuid\.action.*\n/ => "uuid.action = \"create\"",
+            /^ethernet\.+generatedAddress.*\n/ => '' }
+
+          content = File.read conf_file_path
+          content << "\n"
+
+          conf_items_patterns.each_pair do |pattern, new_item|
+            unless content.include? new_item
+              content.gsub(pattern, '').strip
+              content << "#{new_item}\n"
+            end
+          end
+
+          File.open(conf_file_path, 'w') { |f| f.print content }
+        end
+
+        # Internal: Helper for getting the configured vmrun_cmd value.
+        #
+        # Examples
+        #
+        #   @cloner.vmrun_cmd
+        #   # => "/foo/bar/vmrun -T fusion"
+        #
+        # Returns a String for the configured value of
+        # Fission.config['vmrun_cmd'].
+        def vmrun_cmd
+          Fission.config['vmrun_cmd']
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fission/action/vm/deleter.rb

@@ -0,0 +1,73 @@
+module Fission
+  module Action
+    module VM
+
+      class Deleter
+
+        # Internal: Creates a new VMDeleter object.  This accepts a VM object.
+        #
+        # vm - An instance of VM
+        #
+        # Examples:
+        #
+        #   Fission::Action::VMDeleter.new @my_vm
+        #
+        # Returns a new VMDeleter object
+        def initialize(vm)
+          @vm = vm
+        end
+
+        # Public: Deletes a VM.  The VM must not be running in order to delete
+        # it. As there are a number issues with the Fusion command line tool for
+        # deleting VMs, this is a best effort.  The VM must not be running when
+        # this method is called.  This essentially deletes the VM directory and
+        # attempts to remove the relevant entries from the Fusion plist file.
+        # It's highly recommended to delete VMs without the Fusion GUI running.
+        # If the Fusion GUI is running this method should succeed, but it's
+        # been observed that Fusion will recreate the plist data which is
+        # deleted. This leads to 'missing' VMs in the Fusion GUI.
+        #
+        # Examples
+        #
+        #   @deleter.delete
+        #
+        # Returns a Response with the result.
+        # If successful, the Response's data attribute will be nil.
+        # If there is an error, an unsuccessful Response will be returned.
+        def delete
+          unless @vm.exists?
+            return Response.new :code => 1, :message => 'VM does not exist'
+          end
+
+          running_response = @vm.running?
+          return running_response unless running_response.successful?
+
+          if running_response.data
+            message = 'The VM must not be running in order to delete it.'
+            return Response.new :code => 1, :message => message
+          end
+
+          FileUtils.rm_rf @vm.path
+          Metadata.delete_vm_info @vm.path
+
+          Response.new :code => 0
+        end
+
+        private
+        # Internal: Helper for getting the configured vmrun_cmd value.
+        #
+        # Examples
+        #
+        #   @deleter.vmrun_cmd
+        #   # => "/foo/bar/vmrun -T fusion"
+        #
+        # Returns a String for the configured value of
+        # Fission.config['vmrun_cmd'].
+        def vmrun_cmd
+          Fission.config['vmrun_cmd']
+        end
+      end
+
+    end
+  end
+end

data/lib/fission/action/vm/lister.rb

@@ -0,0 +1,138 @@
+module Fission
+  module Action
+    module VM
+
+      class Lister
+
+        # Public: Provides all of the VMs which are located in the VM directory.
+        #
+        # Examples
+        #
+        #   Fission::VM.all.data
+        #   # => [<Fission::VM:0x007fd6fa24c5d8 @name="foo">,
+        #         <Fission::VM:0x007fd6fa23c5e8 @name="bar">]
+        #
+        # Returns a Response with the result.
+        # If successful, the Response's data attribute will be an Array of VM
+        # objects.  If no VMs are found, the Response's data attribute will be an
+        # empty Array.
+        # If there is an error, an unsuccessful Response will be returned.
+        def all
+          vm_dirs = Dir[File.join Fission.config['vm_dir'], '*.vmwarevm'].select do |d|
+            File.directory? d
+          end
+
+          response = Response.new :code => 0
+          response.data = vm_dirs.collect do |dir|
+            Fission::VM.new(File.basename dir, '.vmwarevm')
+          end
+
+          response
+        end
+
+        # Public: Provides all of the VMs which are currently running.
+        #
+        # Examples
+        #
+        #   Fission::VM.all_running.data
+        #   # => [<Fission::VM:0x007fd6fa24c5d8 @name="foo">,
+        #         <Fission::VM:0x007fd6fa23c5e8 @name="bar">]
+        #
+        # Returns a Response with the result.
+        # If successful, the Response's data attribute will be an Array of VM
+        # objects which are running.  If no VMs are running, the Response's data
+        # attribute will be an empty Array.
+        # If there is an error, an unsuccessful Response will be returned.
+        def all_running
+          command = "#{Fission.config['vmrun_cmd']} list"
+          command_executor = Fission::Action::ShellExecutor.new command
+          result = command_executor.execute
+
+          response = Response.new :code => result['process_status'].exitstatus
+
+          if response.successful?
+            response.data = get_vm_objects_from_list_output result['output']
+          else
+            response.message = result['output']
+          end
+
+          response
+        end
+
+        # Public: Provides a list of all of the VMs and their associated status
+        #
+        # Examples
+        #
+        #   Fission::VM.all_with_status.data
+        #   # => { 'vm1' => 'running', 'vm2' => 'suspended', 'vm3' => 'not running'}
+        #
+        # Returns a Response with the result.
+        # If successful, the Response's data attribute will be a Hash of with the VM
+        # names as keys and their status as the values.
+        # If there is an error, an unsuccessful Repsonse will be returned.
+        def all_with_status
+          all_response = all
+          return all_response unless all_response.successful?
+
+          all_vms = all_response.data
+
+          running_response = all_running
+          return running_response unless running_response.successful?
+
+          response = Response.new :code => 0
+
+          @all_running_vm_names = running_response.data.collect { |v| v.name }
+
+          response.data = all_vms.inject({}) do |result, vm|
+            result[vm.name] = determine_status vm
+            result
+          end
+
+          response
+        end
+
+        private
+        # Internal: Helper to determines the status of a VM.
+        #
+        # vm - The VM object.
+        #
+        # Examples:
+        #
+        #   @lister.determine_status my_vm
+        #   # => 'suspended'
+        #
+        # Returns a String of the status.
+        def determine_status(vm)
+          return 'running' if @all_running_vm_names.include? vm.name
+          return 'suspended' if vm.suspend_file_exists?
+          return 'not running'
+        end
+
+        # Internal: Helper to get VM objects from the output of running VMs.
+        #
+        # output - output from the list command.
+        #
+        # Examples:
+        #
+        #   @lister.get_vm_objects_from_list_output my_output
+        #   # => [<Fission::VM:0x007fd6fa24c5d8 @name="foo">,
+        #         <Fission::VM:0x007fd6fa23c5e8 @name="bar">]
+        #
+        # Returns an Array of VM objects.
+        def get_vm_objects_from_list_output(output)
+          vms = output.split("\n").select do |vm|
+            vm.include?('.vmx') &&
+            File.exists?(vm) &&
+            File.extname(vm) == '.vmx'
+          end
+
+          vms.collect do |vm|
+            Fission::VM.new File.basename(File.dirname(vm), '.vmwarevm')
+          end
+        end
+
+      end
+
+    end
+  end
+end