fission 0.2.0 → 0.3.0.beta.1

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## head
 
+## 0.3.0 (09/08/2011)
+* add ability to suspend all running VMs ('--all')
+* add 'delete' command
+* add 'snapshot create' command
+* add 'snapshot list' command
+* add 'snapshot revert' command
+* add '--headless' option to start
+* fix issue #2
+
 ## 0.2.0 (07/13/2011)
 * add 'status' command
 * add 'start' command

data/README.md

@@ -14,11 +14,36 @@ Fission is a simple command line tool for managing VMware Fusion VMs.
 
 If you provide '--start', then the new VM will be powered on after cloning
 
+### Snapshot Create
+    fission snapshot create my_vm snapshot_name
+
+Creates a snapshot for the VM
+
+In order to create the snapshot:
+* The VM must be running
+* The snapshot name must be unique
+
+### Snapshot List
+    fission snapshot list my_vm
+
+Lists the snapshots for the VM
+
+### Snapshot Revert
+    fission snapshot revert my_vm existing_snapshot
+
+Reverts a VM to an existing snapshot
+
+In order to revert to the snapshot:
+* The Fusion GUI cannot be running
+
 ### Start
-    fission start my_vm
+    fission start my_vm [--headless]
 
 Starts the VM
 
+Providng '--headless' will start the VM without a Fusion GUI console
+Note that the Fusion GUI cannot be running to start a VM with '--headless'
+
 ### Status
     fission status
 
@@ -30,9 +55,22 @@ Displays the status (running or not) of all of the VMs found
 Stops the VM
 
 ### Suspend
-    fission suspend my_vm
+    fission suspend [my_vm | --all]
+
+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)
 
-Suspends the VM
+Providing '--force' will:
+* Stop the VM if it's running
+* Delete the VM even if the Fusion GUI is running
 
 ### Help
     fission -h
@@ -69,6 +107,9 @@ the desired install method (ideally with easy install) and settings, but do not
 power on the VM.  You can then create clones from this VM 'template'.  When you 
 power on the clone, it will start the OS install process (and assign a new ip, etc.).
 
+## Fission with RVM
+Please see the following gist for a walkthrough of making fission available 
+regardless of ruby environment when using RVM https://gist.github.com/1203167
 
 ## Contribute
 * Fork the project

data/fission.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ['Tommy Bishop']
   s.email       = ['bishop.thomas@gmail.com']
   s.homepage    = "https://github.com/thbishop/fission"
-  s.summary     = %q{Tool to clone VMware fusion VMs}
-  s.description = %q{A simple utility to create VMware Fusion VM clones}
+  s.summary     = %q{Command line tool to manage VMware Fusion VMs}
+  s.description = %q{A simple utility to manage VMware Fusion VMs from the command line}
 
   s.rubyforge_project = "fission"
 
@@ -18,6 +18,7 @@ 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_development_dependency 'fakefs', '~> 0.3.2'
 end

data/lib/fission.rb

@@ -8,14 +8,20 @@ $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 require 'fission/cli'
 require 'fission/command'
 require 'fission/command/clone'
+require 'fission/command/snapshot_create'
+require 'fission/command/snapshot_list'
+require 'fission/command/snapshot_revert'
 require 'fission/command/start'
 require 'fission/command/status'
 require 'fission/command/stop'
 require 'fission/command/suspend'
+require 'fission/command/delete'
 require 'fission/config'
 require 'fission/core_ext/class'
 require 'fission/core_ext/file'
 require 'fission/core_ext/object'
+require 'fission/fusion'
+require 'fission/metadata'
 require 'fission/ui'
 require 'fission/vm'
 require 'fission/version'

data/lib/fission/cli.rb

@@ -30,28 +30,34 @@ module Fission
 
       if commands.include?(args.first)
         @cmd = Fission::Command.const_get(args.first.capitalize).new args.drop 1
-        @cmd.execute
+      elsif is_snapshot_command?(args)
+        klass = args.take(2).map {|c| c.capitalize}.join('')
+        @cmd = Fission::Command.const_get(klass).new args.drop 2
       else
         show_all_help(optparse)
         exit(1)
       end
+
+      @cmd.execute
     end
 
     def self.commands
-      cmds = []
-      Dir.entries(File.join(File.dirname(__FILE__), 'command')).select do |file|
-        cmds << File.basename(file, '.rb') unless File.directory? file
+      cmds = Dir.entries(File.join(File.dirname(__FILE__), 'command')).select do |file|
+        !File.directory? file
       end
 
-      cmds
+      cmds.map { |cmd| File.basename(cmd, '.rb').gsub '_', ' ' }
     end
 
     private
+    def self.is_snapshot_command?(args)
+      args.first == 'snapshot' && args.count > 1 && commands.include?(args.take(2).join(' '))
+    end
+
     def self.commands_banner
       text = "\nCommands:\n"
       Fission::Command.descendants.each do |command_klass|
         text << (command_klass.send :help)
-        text << "\n\n"
       end
 
       text

data/lib/fission/command/clone.rb

@@ -8,7 +8,9 @@ module Fission
       end
 
       def execute
-        unless args.count > 1
+        option_parser.parse! @args
+
+        unless @args.count > 1
           Fission.ui.output self.class.help
           Fission.ui.output ""
           Fission.ui.output_and_exit "Incorrect arguments for clone command", 1
@@ -25,9 +27,6 @@ module Fission
           Fission::ui.output_and_exit "The target vm #{target_vm} already exists", 1
         end
 
-        clone_options = option_parser
-        clone_options.parse! @args
-
         Fission::VM.clone source_vm, target_vm
 
         Fission.ui.output ''

data/lib/fission/command/delete.rb

@@ -0,0 +1,65 @@
+module Fission
+  class Command
+    class Delete < Command
+
+      def initialize(args=[])
+        super
+        @options.force = false
+      end
+
+      def execute
+        option_parser.parse! @args
+
+        if @args.count < 1
+          Fission.ui.output self.class.help
+          Fission.ui.output ""
+          Fission.ui.output_and_exit "Incorrect arguments for delete command", 1
+        end
+
+        target_vm = @args.first
+
+        unless Fission::VM.exists? target_vm
+          Fission.ui.output_and_exit "Unable to find target vm #{target_vm} (#{Fission::VM.path(target_vm)})", 1
+        end
+
+        if Fission::VM.all_running.include? target_vm
+          Fission.ui.output 'VM is currently running'
+          if @options.force
+            Fission.ui.output 'Going to stop it'
+            Fission::Command::Stop.new([target_vm]).execute
+          else
+            Fission.ui.output_and_exit "Either stop/suspend the VM or use '--force' and try again.", 1
+          end
+        end
+
+        if Fission::Fusion.is_running?
+          Fission.ui.output 'It looks like the Fusion GUI is currently running'
+          if @options.force
+            Fission.ui.output 'The Fusion metadata for the VM may not be removed completely'
+          else
+            Fission.ui.output "Either exit the Fusion GUI or use '--force' and try again"
+            Fission.ui.output_and_exit "NOTE: Forcing a VM deletion with the Fusion GUI running may not clean up all of the VM metadata", 1
+          end
+        end
+
+        Fission::VM.delete target_vm
+
+        Fission.ui.output ''
+        Fission.ui.output "Deletion complete!"
+      end
+
+      def option_parser
+        optparse = OptionParser.new do |opts|
+          opts.banner = "\ndelete usage: fission delete target_vm [--force]"
+
+          opts.on '--force', "Stop the VM if it's running and then delete it" do
+            @options.force = true
+          end
+        end
+
+        optparse
+      end
+
+    end
+  end
+end

data/lib/fission/command/snapshot_create.rb

@@ -0,0 +1,47 @@
+module Fission
+  class Command
+    class SnapshotCreate < Command
+
+      def initialize(args=[])
+        super
+      end
+
+      def execute
+        unless @args.count == 2
+          Fission.ui.output self.class.help
+          Fission.ui.output ""
+          Fission.ui.output_and_exit "Incorrect arguments for snapshot create command", 1
+        end
+
+        vm_name, snap_name = @args.take 2
+
+        unless Fission::VM.exists? vm_name
+          Fission.ui.output_and_exit "Unable to find the VM #{vm_name} (#{Fission::VM.path(vm_name)})", 1 
+        end
+
+        unless Fission::VM.all_running.include? vm_name
+          Fission.ui.output "VM '#{vm_name}' is not running"
+          Fission.ui.output_and_exit 'A snapshot cannot be created unless the VM is running', 1
+        end
+
+        @vm = Fission::VM.new vm_name
+
+        if @vm.snapshots.include? snap_name
+          Fission.ui.output_and_exit "VM '#{vm_name}' already has a snapshot named '#{snap_name}'", 1
+        end
+
+        Fission.ui.output "Creating snapshot"
+        @vm.create_snapshot(snap_name)
+      end
+
+      def option_parser
+        optparse = OptionParser.new do |opts|
+          opts.banner = "\nsnapshot create: fission snapshot create my_vm snapshot_1"
+        end
+
+        optparse
+      end
+
+    end
+  end
+end

data/lib/fission/command/snapshot_list.rb

@@ -0,0 +1,42 @@
+module Fission
+  class Command
+    class SnapshotList < Command
+
+      def initialize(args=[])
+        super
+      end
+
+      def execute
+        unless @args.count == 1
+          Fission.ui.output self.class.help
+          Fission.ui.output ""
+          Fission.ui.output_and_exit "Incorrect arguments for snapshot list command", 1
+        end
+
+        vm_name = @args.first
+
+        unless Fission::VM.exists? vm_name
+          Fission.ui.output_and_exit "Unable to find the VM #{vm_name} (#{Fission::VM.path(vm_name)})", 1 
+        end
+
+        @vm = Fission::VM.new vm_name
+        snaps = @vm.snapshots
+
+        if snaps.any?
+          Fission.ui.output snaps.join("\n")
+        else
+          Fission.ui.output "No snapshots found for VM '#{vm_name}'"
+        end
+      end
+
+      def option_parser
+        optparse = OptionParser.new do |opts|
+          opts.banner = "\nsnapshot list: fission snapshot list my_vm"
+        end
+
+        optparse
+      end
+
+    end
+  end
+end

data/lib/fission/command/snapshot_revert.rb

@@ -0,0 +1,47 @@
+module Fission
+  class Command
+    class SnapshotRevert < Command
+
+      def initialize(args=[])
+        super
+      end
+
+      def execute
+        unless @args.count == 2
+          Fission.ui.output self.class.help
+          Fission.ui.output ''
+          Fission.ui.output_and_exit 'Incorrect arguments for snapshot revert command', 1
+        end
+
+        vm_name, snap_name = @args.take 2
+
+        unless Fission::VM.exists? vm_name
+          Fission.ui.output_and_exit "Unable to find the VM #{vm_name} (#{Fission::VM.path(vm_name)})", 1 
+        end
+
+        if Fission::Fusion.is_running?
+          Fission.ui.output 'It looks like the Fusion GUI is currently running'
+          Fission.ui.output_and_exit 'Please exit the Fusion GUI and try again', 1
+        end
+
+        @vm = Fission::VM.new vm_name
+
+        unless @vm.snapshots.include? snap_name
+          Fission.ui.output_and_exit "Unable to find the snapshot '#{snap_name}'", 1
+        end
+
+        Fission.ui.output "Reverting to snapshot '#{snap_name}'"
+        @vm.revert_to_snapshot(snap_name)
+      end
+
+      def option_parser
+        optparse = OptionParser.new do |opts|
+          opts.banner = "\nsnapshot revert: fission snapshot revert my_vm snapshot_1"
+        end
+
+        optparse
+      end
+
+    end
+  end
+end

data/lib/fission/command/start.rb

@@ -4,16 +4,19 @@ module Fission
 
       def initialize(args=[])
         super
+        @options.headless = false
       end
 
       def execute
-        unless args.count == 1
+        option_parser.parse! @args
+
+        if @args.empty?
           Fission.ui.output self.class.help
           Fission.ui.output ""
           Fission.ui.output_and_exit "Incorrect arguments for start command", 1
         end
 
-        vm_name = args.first
+        vm_name = @args.first
 
         unless Fission::VM.exists? vm_name
           Fission.ui.output_and_exit "Unable to find the VM #{vm_name} (#{Fission::VM.path(vm_name)})", 1 
@@ -26,12 +29,27 @@ module Fission
 
         Fission.ui.output "Starting '#{vm_name}'"
         @vm = Fission::VM.new vm_name
-        @vm.start
+
+        if @options.headless
+          if Fission::Fusion.is_running?
+            Fission.ui.output 'It looks like the Fusion GUI is currently running'
+            Fission.ui.output 'A VM cannot be started in headless mode when the Fusion GUI is running'
+            Fission.ui.output_and_exit "Exit the Fusion GUI and try again", 1
+          else
+            @vm.start :headless => true
+          end
+        else
+          @vm.start
+        end
       end
 
       def option_parser
         optparse = OptionParser.new do |opts|
-          opts.banner = "\nstart usage: fission start vm"
+          opts.banner = "\nstart usage: fission start vm [options]"
+
+          opts.on '--headless', 'Start the VM in headless mode (i.e. no Fusion GUI console)' do
+            @options.headless = true
+          end
         end
 
         optparse