fission 0.4.0 → 0.5.0.beta.1

data/.ruby-gemset

@@ -0,0 +1 @@
+fission

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p429

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+script: rake spec

data/CHANGELOG.md

@@ -1,10 +1,19 @@
-# changes
-
 ## head
 
+## 0.5.0.beta.1 (06/22/2013)
+* add 'info' command
+* add 'snapshot delete' command
+* add ability to get all VM config values (related to #14)
+* fix issue #16 (returning incorrect mac address)
+* fix issue #18 (1.8.7 compatibility)
+* fix issue #19 (duplicate config entires when cloning)
+* internal cleanup of how command strings are handled (props to @patdowney)
+* bump dependency on CFproperList to avoid libxml-ruby dependency (#24)
+
 ## 0.4.0 (01/17/2012)
 * major internal refactoring for usage as a lib
-* add fix for loading a custom vmrun_bin in ~/.fissionrc (issue #8 )
+* add fix for loading a custom vmrun_bin in ~/.fissionrc (issue #8)
+* add guestos and uuid methods to VM (@ody)
 
 ## 0.3.0 (09/16/2011)
 * add ability to suspend all running VMs ('--all')

data/README.md

@@ -1,7 +1,10 @@
 # Fission
 
+[![Build Status](https://secure.travis-ci.org/thbishop/fission.png)](http://travis-ci.org/thbishop/fission)
+
 ## Intro
-Fission is a simple command line tool for managing VMware Fusion VMs.  Only Fusion 3.x is currently supported.
+Fission is a simple command line tool for managing VMware Fusion VMs.  Only Fusion 3.x is currently
+supported.  See [Fusion Version Support](#fusion-version-support) for more info.
 
 
 ## Install
@@ -15,6 +18,28 @@ Fission is a simple command line tool for managing VMware Fusion VMs.  Only Fusi
 If you provide '--start', then the new VM will be powered on after cloning
 
 
+### Delete
+    fission delete my_vm [--force]
+
+Deletes the VM.  This will delete the files from disk and remove the related metadata in Fusion.
+
+By default, the VM will not be deleted if:
+
+* The VM is running
+* The Fusion GUI is running (as the metadata cannot be cleanly removed)
+
+Providing '--force' will:
+
+* Stop the VM if it's running
+* Delete the VM even if the Fusion GUI is running
+
+
+### Info
+    fission info my_vm
+
+Outputs information about the VM
+
+
 ### Snapshot Create
     fission snapshot create my_vm snapshot_name
 
@@ -26,6 +51,14 @@ In order to create the snapshot:
 * The snapshot name must be unique
 
 
+### Snapshot Delete
+    fission snapshot delete my_vm snapshot_name
+
+Deletes a snapshot for the VM
+
+If you have the Fusion GUI running, the VM must be running in order to delete the snapshot.
+
+
 ### Snapshot List
     fission snapshot list my_vm
 
@@ -70,22 +103,6 @@ Stops the VM
 Suspends the VM or all running VMs
 
 
-### Delete
-    fission delete my_vm [--force]
-
-Deletes the VM.  This will delete the files from disk and remove the related metadata in Fusion.
-
-By default, the VM will not be deleted if:
-
-* The VM is running
-* The Fusion GUI is running (as the metadata cannot be cleanly removed)
-
-Providing '--force' will:
-
-* Stop the VM if it's running
-* Delete the VM even if the Fusion GUI is running
-
-
 ### Help
     fission -h
 
@@ -94,17 +111,26 @@ or just
     fission
 
 
-## Config
+## Configuration
 By default, fission will use the default VMware Fusion VM directory
 (~/Documents/Virtual Machines.localized/) when cloning.  If you want to use a
 different directory, you can set this in a config file.
 
-The config file needs to be in yaml format and live at '~/.fissionrc'
+The config file needs to be in YAML format and live at '~/.fissionrc'
 
     $cat ~/.fissionrc
     ---
     vm_dir: "/vm"
 
+## Fusion Version Support
+As of now, only Fusion 3.x is supported (that's what I have available to test).
+It's my understanding that some folks are currently using fission with Fusion
+4.x as well.  In order to have fission work with Fusion 4.x, you will need to
+tell fission where the Fusion 4.x vmrun file is.  You can do so with the
+following item placed in your ~/.fissionrc (remember, YAML format):
+
+    vmrun_bin: /Applications/VMware Fusion.app/Contents/Library/vmrun
+
 
 ## Other Notable Info
 The name of the VM used in the previous examples should be the directory name 

data/bin/fission

@@ -4,4 +4,4 @@ $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
 require 'fission'
 
-Fission::CLI.execute
+Fission::CLI.new.execute

data/fission.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.add_dependency 'CFPropertyList', '~> 2.0.17'
-  s.add_development_dependency 'rspec', '~> 2.6.0'
+  s.add_dependency 'CFPropertyList', '~> 2.1.1'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 2.8.0'
   s.add_development_dependency 'fakefs', '~> 0.3.2'
 end

data/lib/fission.rb

@@ -5,12 +5,26 @@ require 'yaml'
 
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
+require 'fission/action/shell_executor'
+require 'fission/action/snapshot/creator'
+require 'fission/action/snapshot/deleter'
+require 'fission/action/snapshot/lister'
+require 'fission/action/snapshot/reverter'
+require 'fission/action/vm/cloner'
+require 'fission/action/vm/deleter'
+require 'fission/action/vm/lister'
+require 'fission/action/vm/starter'
+require 'fission/action/vm/stopper'
+require 'fission/action/vm/suspender'
 require 'fission/cli'
 require 'fission/command'
 require 'fission/command_helpers'
+require 'fission/command_line_parser'
 require 'fission/command/clone'
 require 'fission/command/delete'
+require 'fission/command/info'
 require 'fission/command/snapshot_create'
+require 'fission/command/snapshot_delete'
 require 'fission/command/snapshot_list'
 require 'fission/command/snapshot_revert'
 require 'fission/command/start'
@@ -27,6 +41,7 @@ require 'fission/metadata'
 require 'fission/response'
 require 'fission/ui'
 require 'fission/vm'
+require 'fission/vm_configuration'
 require 'fission/version'
 
 module Fission

data/lib/fission/action/shell_executor.rb

@@ -0,0 +1,37 @@
+module Fission
+  module Action
+
+    class ShellExecutor
+
+      # Internal: Create a new ShellExecutor object.
+      #
+      # cmd - Command to execute as a String
+      #
+      # Examples:
+      #
+      #   Fission::Action::ShellExecutor.new 'ls /var/log'
+      #
+      # Returns a new Fission::Action::ShellExecutor object.
+      def initialize(cmd)
+        @cmd = cmd
+      end
+
+      # Internal: Executes the command in the shell.  The command will be
+      # executed using the ruby '`' method.
+      #
+      # Examples:
+      #
+      #   @executor.execute
+      #
+      # Returns a Hash with two keys.
+      # The key 'output' will contain the output from the command.
+      # The key 'process_status' will conatian a standard ruby Process::Status
+      # object.
+      def execute
+        { 'output' => `#{@cmd}`, 'process_status' => $? }
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,81 @@
+module Fission
+  module Action
+    module Snapshot
+
+      class Creator
+
+        # Internal: Creates a new SnapshotCreator object.  This accepts a VM
+        # object.
+        #
+        # vm - An instance of VM
+        #
+        # Examples:
+        #
+        #   Fission::Action::SnapshotCreator.new @my_vm
+        #
+        # Returns a new SnapshotCreator object
+        def initialize(vm)
+          @vm = vm
+        end
+
+        # Public: Creates a snapshot for a VM.  The VM must be running in order
+        # to create a snapshot.  Snapshot names must be unique.
+        #
+        # name - The desired name of the snapshot.  The name must be unique.
+        #
+        # Examples
+        #
+        #   @creator.create_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 create_snapshot(name)
+          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?
+
+          unless running_response.data
+            message = 'The VM must be running in order to take a snapshot.'
+            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?
+
+          if snapshots_response.data.include? name
+            message = "There is already a snapshot named '#{name}'."
+            return Response.new :code => 1, :message => message
+          end
+
+          command = "#{vmrun_cmd} snapshot "
+          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
+        #
+        #   @creator.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/snapshot/deleter.rb

@@ -0,0 +1,85 @@
+module Fission
+  module Action
+    module Snapshot
+
+      class Deleter
+
+        # Internal: Creates a new SnapshotDeleter object.  This accepts a VM
+        # object.
+        #
+        # vm - An instance of VM
+        #
+        # Examples:
+        #
+        #   Fission::Action::SnapshotDeleter.new @my_vm
+        #
+        # Returns a new SnapshotDeleter object
+        def initialize(vm)
+          @vm = vm
+        end
+
+        # Public: Deletes a snapshot for a VM.  The snapshot to delete must
+        # exist. If the Fusion GUI is running, then the VM must also be running.
+        #
+        # name - The name of the snapshot to delete.
+        #
+        # Examples
+        #
+        #   @deleter.delete_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 delete_snapshot(name)
+          unless @vm.exists?
+            return Response.new :code => 1, :message => 'VM does not exist'
+          end
+
+          if Fusion.running?
+            running_response = @vm.running?
+            return running_response unless running_response.successful?
+
+            unless running_response.data
+              message = 'A snapshot cannot be deleted when the GUI is running '
+              message << 'and the VM is not running.'
+              return Response.new :code => 1, :message => message
+            end
+          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} deleteSnapshot "
+          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
+        #
+        #   @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/snapshot/lister.rb

@@ -0,0 +1,90 @@
+module Fission
+  module Action
+    module Snapshot
+
+      class Lister
+
+        # Internal: Creates a new SnapshotLister object.  This accepts a VM
+        # object.
+        #
+        # vm - An instance of VM
+        #
+        # Examples:
+        #
+        #   Fission::Action::SnapshotLister.new @my_vm
+        #
+        # Returns a new SnapshotLister object
+        def initialize(vm)
+          @vm = vm
+        end
+
+        # Internal: List the snapshots for a VM.
+        #
+        # Examples
+        #
+        #   @lister.snapshots.data
+        #   # => ['snap 1', 'snap 2']
+        #
+        # Returns a Response with the result.
+        # If successful, the Repsonse's data attribute will be an Array of the
+        # snapshot names (String).
+        # If there is an error, an unsuccessful Response will be returned.
+        def snapshots
+          unless @vm.exists?
+            return Response.new :code => 1, :message => 'VM does not exist'
+          end
+
+          conf_file_response = @vm.conf_file
+          return conf_file_response unless conf_file_response.successful?
+
+          command = "#{vmrun_cmd} listSnapshots "
+          command << "'#{conf_file_response.data}' 2>&1"
+
+          command_exec = Fission::Action::ShellExecutor.new command
+          result = command_exec.execute
+
+          response = Response.new :code => result['process_status'].exitstatus
+
+          if response.successful?
+            response.data = parse_snapshot_names_from_output result['output']
+          else
+            response.message = result['output']
+          end
+
+          response
+        end
+
+        private
+        # Internal: Helper for getting the configured vmrun_cmd value.
+        #
+        # Examples
+        #
+        #   @lister.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
+
+        # Internal: Parses the output of the listSnapshot command.
+        #
+        # output - The output of the vmrun listSnapshot command.
+        #
+        # Examples:
+        #   @lister.parse_snapshot_names_from_output cmd_output
+        #   # => ['snap_1', 'snap_2']
+        #
+        # Returns an Array with the list of snapshot names.
+        def parse_snapshot_names_from_output(cmd_output)
+          header_text = 'Total snapshots:'
+          snaps = cmd_output.split("\n").select { |s| !s.include? header_text }
+          snaps.map { |s| s.strip }
+        end
+
+      end
+
+    end
+  end
+end