fission 0.4.0 → 0.5.0.beta.1

data/lib/fission/command/clone.rb

@@ -1,7 +1,6 @@
 module Fission
   class Command
     class Clone < Command
-      include Fission::CommandHelpers
 
       def initialize(args=[])
         super
@@ -9,9 +8,8 @@ module Fission
       end
 
       def execute
-        option_parser.parse! @args
-
-        incorrect_arguments 'clone' unless @args.count > 1
+        super
+        incorrect_arguments unless @args.count > 1
 
         source_vm = Fission::VM.new @args.first
         target_vm = Fission::VM.new @args[1]
@@ -40,8 +38,11 @@ module Fission
 
       def option_parser
         optparse = OptionParser.new do |opts|
-          opts.banner = "\nclone usage: fission clone source_vm target_vm [options]"
-
+          opts.banner = "Usage: fission clone SOURCE_VM TARGET_VM [OPTIONS]"
+          opts.separator ''
+          opts.separator 'Clones SOURCE_VM to a new VM (TARGET_VM).'
+          opts.separator ''
+          opts.separator 'OPTIONS:'
           opts.on '--start', 'Start the VM after cloning' do
             @options.start = true
           end
@@ -50,6 +51,10 @@ module Fission
         optparse
       end
 
+      def summary
+        'Clone a VM'
+      end
+
     end
   end
 end

data/lib/fission/command/delete.rb

@@ -1,7 +1,6 @@
 module Fission
   class Command
     class Delete < Command
-      include Fission::CommandHelpers
 
       def initialize(args=[])
         super
@@ -9,9 +8,8 @@ module Fission
       end
 
       def execute
-        option_parser.parse! @args
-
-        incorrect_arguments 'delete' if @args.count < 1
+        super
+        incorrect_arguments if @args.count < 1
 
         vm = VM.new @args.first
 
@@ -54,8 +52,11 @@ module Fission
 
       def option_parser
         optparse = OptionParser.new do |opts|
-          opts.banner = "\ndelete usage: fission delete vm_name [--force]"
-
+          opts.banner = "Usage: fission delete TARGET_VM [OPTIONS]"
+          opts.separator ''
+          opts.separator 'Deletes TARGET_VM.'
+          opts.separator ''
+          opts.separator 'OPTIONS:'
           opts.on '--force', "Stop the VM if it's running and then delete it" do
             @options.force = true
           end
@@ -64,6 +65,10 @@ module Fission
         optparse
       end
 
+      def summary
+        'Delete a VM'
+      end
+
     end
   end
 end

data/lib/fission/command/info.rb

@@ -0,0 +1,62 @@
+module Fission
+  class Command
+    class Info < Command
+
+      def execute
+        super
+        incorrect_arguments unless @args.count == 1
+
+        vm = VM.new @args.first
+
+        output "name: #{vm.name}"
+
+        guest_os_response = vm.guestos
+
+        if guest_os_response.successful?
+          os = guest_os_response.data.empty? ? 'unknown' : guest_os_response.data
+          output "os: #{os}"
+        else
+          output_and_exit "There was an error getting the OS info.  The error was:\n#{guest_os_response.message}", guest_os_response.code
+        end
+
+        hardware_response = vm.hardware_info
+
+        if hardware_response.successful?
+          hardware_response.data.each_pair do |k, v|
+            output "#{k}: #{v}"
+          end
+        else
+          output_and_exit "There was an error getting the hardware info.  The error was:\n#{hardware_response.message}", hardware_response.code
+        end
+
+        network_response = vm.network_info
+
+        if network_response.successful?
+          network_response.data.each_pair do |int, data|
+            data.each_pair do |k, v|
+              output "#{int} #{k.gsub(/[-_]/, ' ')}: #{v}"
+            end
+            output ""
+          end
+        else
+          output_and_exit "There was an error getting the network info.  The error was:\n#{network_response.message}", network_response.code
+        end
+      end
+
+      def option_parser
+        optparse = OptionParser.new do |opts|
+          opts.banner = 'Usage: fission info TARGET_VM'
+          opts.separator ''
+          opts.separator 'Lists known information about TARGET_VM'
+        end
+
+        optparse
+      end
+
+      def summary
+        'Show information for a VM'
+      end
+
+    end
+  end
+end

data/lib/fission/command/snapshot_create.rb

@@ -1,10 +1,10 @@
 module Fission
   class Command
     class SnapshotCreate < Command
-      include Fission::CommandHelpers
 
       def execute
-        incorrect_arguments 'snapshot create' unless @args.count == 2
+        super
+        incorrect_arguments unless @args.count == 2
 
         vm = VM.new @args[0]
         snap_name = @args[1]
@@ -21,12 +21,18 @@ module Fission
 
       def option_parser
         optparse = OptionParser.new do |opts|
-          opts.banner = "\nsnapshot create: fission snapshot create vm_name snapshot_1"
+          opts.banner = "Usage: fission snapshot create TARGET_VM SNAPSHOT_NAME"
+          opts.separator ''
+          opts.separator 'Creates a snapshot of TARGET_VM named SNAPSHOT_NAME'
         end
 
         optparse
       end
 
+      def summary
+        'Create a snapshot of a VM'
+      end
+
     end
   end
 end

data/lib/fission/command/snapshot_delete.rb

@@ -0,0 +1,38 @@
+module Fission
+  class Command
+    class SnapshotDelete < Command
+
+      def execute
+        super
+        incorrect_arguments unless @args.count == 2
+
+        vm = VM.new @args[0]
+        snap_name = @args[1]
+
+        output "Deleting snapshot"
+        response = vm.delete_snapshot snap_name
+
+        if response.successful?
+          output "Snapshot '#{snap_name}' deleted"
+        else
+          output_and_exit "There was an error deleting the snapshot.  The error was:\n#{response.message}", response.code
+        end
+      end
+
+      def option_parser
+        optparse = OptionParser.new do |opts|
+          opts.banner = "Usage: fission snapshot delete TARGET_VM SNAPSHOT_NAME"
+          opts.separator ''
+          opts.separator 'Deletes the snapshot SNAPSHOT_NAME of TARGET_VM'
+        end
+
+        optparse
+      end
+
+      def summary
+        'Delete a snapshot of a VM'
+      end
+
+    end
+  end
+end

data/lib/fission/command/snapshot_list.rb

@@ -1,10 +1,10 @@
 module Fission
   class Command
     class SnapshotList < Command
-      include Fission::CommandHelpers
 
       def execute
-        incorrect_arguments 'snapshot list' unless @args.count == 1
+        super
+        incorrect_arguments unless @args.count == 1
 
         vm = VM.new @args.first
 
@@ -25,12 +25,18 @@ module Fission
 
       def option_parser
         optparse = OptionParser.new do |opts|
-          opts.banner = "\nsnapshot list: fission snapshot list vm_name"
+          opts.banner = "Usage: fission snapshot list TARGET_VM"
+          opts.separator ''
+          opts.separator 'Lists all of the snapshots for TARGET_VM'
         end
 
         optparse
       end
 
+      def summary
+        'List the snapshots of a VM'
+      end
+
     end
   end
 end

data/lib/fission/command/snapshot_revert.rb

@@ -1,10 +1,10 @@
 module Fission
   class Command
     class SnapshotRevert < Command
-      include Fission::CommandHelpers
 
       def execute
-        incorrect_arguments 'snapshot revert' unless @args.count == 2
+        super
+        incorrect_arguments unless @args.count == 2
 
         vm = VM.new @args[0]
         snap_name = @args[1]
@@ -21,12 +21,18 @@ module Fission
 
       def option_parser
         optparse = OptionParser.new do |opts|
-          opts.banner = "\nsnapshot revert: fission snapshot revert vm_name snapshot_1"
+          opts.banner = "Usage: fission snapshot revert TARGET_VM TARGET_SNAPSHOT"
+          opts.separator ''
+          opts.separator 'Reverts TARGET_VM to TARGET_SNAPSHOT'
         end
 
         optparse
       end
 
+      def summary
+        'Revert a VM to a snapshot'
+      end
+
     end
   end
 end

data/lib/fission/command/start.rb

@@ -1,7 +1,6 @@
 module Fission
   class Command
     class Start < Command
-      include CommandHelpers
 
       def initialize(args=[])
         super
@@ -9,9 +8,8 @@ module Fission
       end
 
       def execute
-        option_parser.parse! @args
-
-        incorrect_arguments 'start' if @args.empty?
+        super
+        incorrect_arguments if @args.empty?
 
         vm = VM.new @args.first
 
@@ -31,8 +29,11 @@ module Fission
 
       def option_parser
         optparse = OptionParser.new do |opts|
-          opts.banner = "\nstart usage: fission start vm_name [options]"
-
+          opts.banner = "Usage: fission start TARGET_VM [OPTIONS]"
+          opts.separator ''
+          opts.separator 'Starts TARGET_VM.'
+          opts.separator ''
+          opts.separator 'OPTIONS:'
           opts.on '--headless', 'Start the VM in headless mode (i.e. no Fusion GUI console)' do
             @options.headless = true
           end
@@ -41,6 +42,10 @@ module Fission
         optparse
       end
 
+      def summary
+        'Start a VM'
+      end
+
     end
   end
 end

data/lib/fission/command/status.rb

@@ -3,6 +3,8 @@ module Fission
     class Status < Command
 
       def execute
+        super
+
         response = VM.all_with_status
         unless response.successful?
           output_and_exit "There was an error getting the status of the VMs.  The error was:\n#{response.message}", response.code
@@ -18,12 +20,18 @@ module Fission
 
       def option_parser
         optparse = OptionParser.new do |opts|
-          opts.banner = "\nstatus usage: fission status"
+          opts.banner = "Usage: fission status"
+          opts.separator ''
+          opts.separator 'Lists the status for all known VMs.'
         end
 
         optparse
       end
 
+      def summary
+        'Show the status of all VMs'
+      end
+
     end
   end
 end

data/lib/fission/command/stop.rb

@@ -1,10 +1,10 @@
 module Fission
   class Command
     class Stop < Command
-      include Fission::CommandHelpers
 
       def execute
-        incorrect_arguments 'stop' unless @args.count == 1
+        super
+        incorrect_arguments unless @args.count == 1
 
         vm = VM.new @args.first
 
@@ -20,12 +20,18 @@ module Fission
 
       def option_parser
         optparse = OptionParser.new do |opts|
-          opts.banner = "\nstop usage: fission stop vm_name"
+          opts.banner = "Usage: fission stop TARGET_VM"
+          opts.separator ''
+          opts.separator 'Stop TARGET_VM.'
         end
 
         optparse
       end
 
+      def summary
+        'Stop a VM'
+      end
+
     end
   end
 end

data/lib/fission/command/suspend.rb

@@ -1,7 +1,6 @@
 module Fission
   class Command
     class Suspend < Command
-      include Fission::CommandHelpers
 
       def initialize(args=[])
         super
@@ -9,9 +8,8 @@ module Fission
       end
 
       def execute
-        option_parser.parse! @args
-
-        incorrect_arguments 'suspend' if @args.count != 1 && !@options.all
+        super
+        incorrect_arguments if @args.count != 1 && !@options.all
 
         vms_to_suspend.each do |vm|
           output "Suspending '#{vm.name}'"
@@ -43,8 +41,11 @@ module Fission
 
       def option_parser
         optparse = OptionParser.new do |opts|
-          opts.banner = "\nsuspend usage: fission suspend [vm_name | --all]"
-
+          opts.banner = "Usage: fission suspend [TARGET_VM | --all]"
+          opts.separator ''
+          opts.separator 'Suspend TARGET_VM or all VMs.'
+          opts.separator ''
+          opts.separator 'OPTIONS:'
           opts.on '--all', 'Suspend all running VMs' do
             @options.all = true
           end
@@ -53,6 +54,10 @@ module Fission
         optparse
       end
 
+      def summary
+        'Suspend a VM'
+      end
+
     end
   end
 end

data/lib/fission/command_helpers.rb

@@ -3,19 +3,33 @@ module Fission
 
     # Internal: Outputs the help text for a command and exits.
     #
-    # command_name - The name of the command to use in the output text.
-    #
     # Examples
     #
-    #   incorrect_arguments 'delete'
+    #   incorrect_arguments
     #
     # Returns nothing.
     # This will call the help class method for the help text.  This will exit
     # with the exit code 1.
-    def incorrect_arguments(command_name)
+    def incorrect_arguments
       output "#{self.class.help}\n"
       output_and_exit "Incorrect arguments for #{command_name} command", 1
     end
 
+    # Internal: Parses the command line arguments.
+    #
+    # Examples:
+    #
+    #   parse_arguments
+    #
+    # Returns nothing.
+    # If there is an invalid argument, an error will be output and this will
+    # exit with exit code 1.
+    def parse_arguments
+      option_parser.parse! @args
+    rescue OptionParser::InvalidOption => e
+      output e
+      output_and_exit "\n#{self.class.help}", 1
+    end
+
   end
 end