fission 0.3.0 → 0.4.0.beta.1

data/lib/fission/command/snapshot_list.rb

@@ -1,37 +1,31 @@
 module Fission
   class Command
     class SnapshotList < Command
-
-      def initialize(args=[])
-        super
-      end
+      include Fission::CommandHelpers
 
       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
+        incorrect_arguments 'snapshot list' unless @args.count == 1
 
-        vm_name = @args.first
+        vm = VM.new @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
+        response = vm.snapshots
 
-        @vm = Fission::VM.new vm_name
-        snaps = @vm.snapshots
+        if response.successful?
+          snaps = response.data
 
-        if snaps.any?
-          Fission.ui.output snaps.join("\n")
+          if snaps.any?
+            output snaps.join("\n")
+          else
+            output "No snapshots found for VM '#{vm.name}'"
+          end
         else
-          Fission.ui.output "No snapshots found for VM '#{vm_name}'"
+          output_and_exit "There was an error listing the snapshots.  The error was:\n#{response.message}", response.code
         end
       end
 
       def option_parser
         optparse = OptionParser.new do |opts|
-          opts.banner = "\nsnapshot list: fission snapshot list my_vm"
+          opts.banner = "\nsnapshot list: fission snapshot list vm_name"
         end
 
         optparse

data/lib/fission/command/snapshot_revert.rb

@@ -1,42 +1,27 @@
 module Fission
   class Command
     class SnapshotRevert < Command
-
-      def initialize(args=[])
-        super
-      end
+      include Fission::CommandHelpers
 
       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
+        incorrect_arguments 'snapshot revert' unless @args.count == 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 = VM.new @args[0]
+        snap_name = @args[1]
 
-        @vm = Fission::VM.new vm_name
+        output "Reverting to snapshot '#{snap_name}'"
+        response = vm.revert_to_snapshot snap_name
 
-        unless @vm.snapshots.include? snap_name
-          Fission.ui.output_and_exit "Unable to find the snapshot '#{snap_name}'", 1
+        if response.successful?
+          output "Reverted to snapshot '#{snap_name}'"
+        else
+          output_and_exit "There was an error reverting to the snapshot.  The error was:\n#{response.message}", response.code
         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"
+          opts.banner = "\nsnapshot revert: fission snapshot revert vm_name snapshot_1"
         end
 
         optparse

data/lib/fission/command/start.rb

@@ -1,6 +1,7 @@
 module Fission
   class Command
     class Start < Command
+      include CommandHelpers
 
       def initialize(args=[])
         super
@@ -10,42 +11,27 @@ module Fission
       def execute
         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
+        incorrect_arguments 'start' if @args.empty?
 
-        vm_name = @args.first
+        vm = VM.new @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
+        output "Starting '#{vm.name}'"
+        start_args = {}
 
-        if VM.all_running.include?(vm_name)
-          Fission.ui.output ''
-          Fission.ui.output_and_exit "VM '#{vm_name}' is already running", 0
-        end
+        start_args[:headless] = true if @options.headless
 
-        Fission.ui.output "Starting '#{vm_name}'"
-        @vm = Fission::VM.new vm_name
+        response = vm.start start_args
 
-        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
+        if response.successful?
+          output "VM '#{vm.name}' started"
         else
-          @vm.start
+          output_and_exit "There was a problem starting the VM.  The error was:\n#{response.message}", response.code
         end
       end
 
       def option_parser
         optparse = OptionParser.new do |opts|
-          opts.banner = "\nstart usage: fission start vm [options]"
+          opts.banner = "\nstart usage: fission start vm_name [options]"
 
           opts.on '--headless', 'Start the VM in headless mode (i.e. no Fusion GUI console)' do
             @options.headless = true

data/lib/fission/command/status.rb

@@ -2,19 +2,35 @@ module Fission
   class Command
     class Status < Command
 
-      def initialize(args=[])
-        super
-      end
-
       def execute
-        all_vms = VM.all
-        all_running_vms = VM.all_running
+        response = VM.all
+        if response.successful?
+          all_vms = response.data
+        end
+
+        response = VM.all_running
+        if response.successful?
+          all_running_vm_names = response.data.collect { |v| v.name }
+        else
+          output_and_exit "There was an error getting the list of running VMs.  The error was:\n#{response.message}", response.code
+        end
+
+        vm_names = all_vms.collect { |v| v.name }
+
+        longest_vm_name = vm_names.max { |a,b| a.length <=> b.length }
 
-        longest_vm_name = all_vms.max { |a,b| a.length <=> b.length }
+        all_vms.each do |vm|
+          if all_running_vm_names.include? vm.name
+            status = '[running]'
+          else
+            if vm.suspend_file_exists?
+              status = '[suspended]'
+            else
+              status = '[not running]'
+            end
+          end
 
-        VM.all.each do |vm|
-          status = all_running_vms.include?(vm) ? '[running]' : '[not running]'
-          Fission.ui.output_printf "%-#{longest_vm_name.length}s   %s\n", vm, status
+          output_printf "%-#{longest_vm_name.length}s   %s\n", vm.name, status
         end
       end
 

data/lib/fission/command/stop.rb

@@ -1,37 +1,26 @@
 module Fission
   class Command
     class Stop < Command
-
-      def initialize(args=[])
-        super
-      end
+      include Fission::CommandHelpers
 
       def execute
-        unless @args.count == 1
-          Fission.ui.output self.class.help
-          Fission.ui.output ""
-          Fission.ui.output_and_exit "Incorrect arguments for stop command", 1
-        end
+        incorrect_arguments 'stop' unless @args.count == 1
 
-        vm_name = @args.first
+        vm = VM.new @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
+        output "Stopping '#{vm.name}'"
+        response = vm.stop
 
-        unless VM.all_running.include?(vm_name)
-          Fission.ui.output ''
-          Fission.ui.output_and_exit "VM '#{vm_name}' is not running", 0
+        if response.successful?
+          output "VM '#{vm.name}' stopped"
+        else
+          output_and_exit "There was an error stopping the VM.  The error was:\n#{response.message}", response.code
         end
-
-        Fission.ui.output "Stopping '#{vm_name}'"
-        @vm = Fission::VM.new vm_name
-        @vm.stop
       end
 
       def option_parser
         optparse = OptionParser.new do |opts|
-          opts.banner = "\nstop usage: fission stop vm"
+          opts.banner = "\nstop usage: fission stop vm_name"
         end
 
         optparse

data/lib/fission/command/suspend.rb

@@ -1,6 +1,7 @@
 module Fission
   class Command
     class Suspend < Command
+      include Fission::CommandHelpers
 
       def initialize(args=[])
         super
@@ -10,40 +11,39 @@ module Fission
       def execute
         option_parser.parse! @args
 
-        if @args.count != 1 && !@options.all
-          Fission.ui.output self.class.help
-          Fission.ui.output ""
-          Fission.ui.output_and_exit "Incorrect arguments for suspend command", 1
-        end
+        incorrect_arguments 'suspend' if @args.count != 1 && !@options.all
+
+        vms_to_suspend.each do |vm|
+          output "Suspending '#{vm.name}'"
+          response = vm.suspend
 
-        vms_to_suspend.each do |vm_name|
-          Fission.ui.output "Suspending '#{vm_name}'"
-          Fission::VM.new(vm_name).suspend
+          if response.successful?
+            output "VM '#{vm.name}' suspended"
+          else
+            output_and_exit "There was an error suspending the VM.  The error was:\n#{response.message}", response.code
+          end
         end
       end
 
       def vms_to_suspend
         if @options.all
-          vms_to_suspend = VM.all_running
-        else
-          vm_name = @args.first
-          unless Fission::VM.exists? vm_name
-            Fission.ui.output ''
-            Fission.ui.output_and_exit "Unable to find the VM #{vm_name} (#{Fission::VM.path(vm_name)})", 1
-          end
+          response = VM.all_running
 
-          unless VM.all_running.include?(vm_name)
-            Fission.ui.output ''
-            Fission.ui.output_and_exit "VM '#{vm_name}' is not running", 1
+          if response.successful?
+            vms = response.data
+          else
+            output_and_exit "There was an error getting the list of running VMs.  The error was:\n#{response.message}", response.code
           end
-
-          vms_to_suspend = [vm_name]
+        else
+          vms = [ VM.new(@args.first) ]
         end
+
+        vms
       end
 
       def option_parser
         optparse = OptionParser.new do |opts|
-          opts.banner = "\nsuspend usage: fission suspend [vm | --all]"
+          opts.banner = "\nsuspend usage: fission suspend [vm_name | --all]"
 
           opts.on '--all', 'Suspend all running VMs' do
             @options.all = true

data/lib/fission/command_helpers.rb

@@ -0,0 +1,21 @@
+module Fission
+  module CommandHelpers
+
+    # 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'
+    #
+    # 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)
+      output "#{self.class.help}\n"
+      output_and_exit "Incorrect arguments for #{command_name} command", 1
+    end
+
+  end
+end

data/lib/fission/config.rb

@@ -1,9 +1,21 @@
 module Fission
   class Config
+
+    # Public: Gets/Sets the Hash of attributes.
     attr_accessor :attributes
 
+    # Public: Path to the Fission conf file (default: ~/.fissionrc).
     CONF_FILE = File.expand_path '~/.fissionrc'
 
+    # Public: Initializes a Config object.  This also sets the default config
+    # attributes for 'vmrun_bin', 'vmrun_cmd', 'vm_dir', 'plist_file', and
+    # 'gui_bin'.
+    #
+    # Examples
+    #
+    #   Fission::Config.new
+    #
+    # Returns a new Config instance.
     def initialize
       @attributes = {}
       load_from_file
@@ -12,13 +24,36 @@ module Fission
         @attributes['vm_dir'] = File.expand_path('~/Documents/Virtual Machines.localized/')
       end
 
+      @attributes['lease_file'] = '/var/db/vmware/vmnet-dhcpd-vmnet8.leases'
       @attributes['vmrun_bin'] = '/Library/Application Support/VMware Fusion/vmrun'
       @attributes['vmrun_cmd'] = "#{@attributes['vmrun_bin'].gsub(' ', '\ ')} -T fusion"
       @attributes['plist_file'] = File.expand_path('~/Library/Preferences/com.vmware.fusion.plist')
       @attributes['gui_bin'] = File.expand_path('/Applications/VMware Fusion.app/Contents/MacOS/vmware')
     end
 
+    # Public: Helper method to access config atributes.  This is a shortcut for
+    # querying the config attributes.
+    #
+    # item - The config item to query.
+    #
+    # Examples
+    #
+    #   Fission.config['vmrun_bin']
+    #   # => '/foo/bar/vmrun'
+    #
+    # Returns the value of the specified config item.
+    def [](item)
+      @attributes[item]
+    end
+
     private
+    # Internal: Loads config values from the Fission conf file into attributes.
+    #
+    # Examples
+    #
+    #   load_from_file
+    #
+    # Returns nothing.
     def load_from_file
       if File.file?(CONF_FILE)
         @attributes.merge!(YAML.load_file(CONF_FILE))

data/lib/fission/fusion.rb

@@ -1,12 +1,20 @@
 module Fission
   class Fusion
 
-    def self.is_running?
+    # Public: Determines if the VMware Fusion GUI application is running.
+    #
+    # Examples
+    #
+    #   Fission::Fusion.running?
+    #   # => true
+    #
+    # Returns a Boolean.
+    def self.running?
       command = "ps -ef | grep -v grep | grep -c "
-      command << "#{Fission.config.attributes['gui_bin'].gsub(' ', '\ ')} 2>&1"
+      command << "#{Fission.config['gui_bin'].gsub(' ', '\ ')} 2>&1"
       output = `#{command}`
 
-      output.strip.to_i > 0 ? true : false
+      output.strip.to_i > 0
     end
 
   end

data/lib/fission/lease.rb

@@ -0,0 +1,148 @@
+module Fission
+  class Lease
+
+    # Public: Get/set the IP address for the lease.
+    attr_accessor :ip_address
+
+    # Public: Get/set the MAC address for the lease.
+    attr_accessor :mac_address
+
+    # Public: Get/set the start DateTime for the lease.
+    attr_accessor :start
+
+    # Public: Get/set the end DateTime for the lease.
+    attr_accessor :end
+
+    # Public: Initialize a Lease object.
+    #
+    # args - Hash of arguments:
+    #        :ip_address  - String which denotes the IP address of the lease.
+    #        :mac_address - String which denotes the MAC address of the lease.
+    #        :start       - DateTime which denotes the start of the lease.
+    #        :end         - DateTime which denotes the end of the lease.
+    #
+    # Examples
+    #
+    # Returns a new Lease instance.
+    def initialize(args={})
+      @ip_address = args[:ip_address]
+      @mac_address = args[:mac_address]
+      @start = args[:start]
+      @end = args[:end]
+    end
+
+    # Public: Determine if the lease has expired or not.
+    #
+    # Examples:
+    #
+    #   @lease.expired?
+    #   # => true
+    #
+    # Returns a Boolean.  The Boolean is determined by comparing the end
+    # attribute to the current date/time.
+    def expired?
+      @end < DateTime.now
+    end
+
+    # Public: Provides all of the known leases.
+    #
+    # Examples:
+    #
+    #   Fission::Lease.all
+    #   # => [#<Fission::Lease:0x000001008b6d88...>,
+    #         #<Fission::Lease:0x000001008522c0...>]
+    #
+    # Returns a Response with the result.
+    # If successful, the Response's data attribute will be an Array of Lease
+    # objects.  If no leases are found, then the Response's data attribute will
+    # be an empty Array.
+    # If there is an error, an unsuccessful Response will be returned.
+    def self.all
+      response = Response.new
+
+      if File.file? Fission.config['lease_file']
+        content = File.read Fission.config['lease_file']
+
+        response.data = content.split('}').collect do |entry|
+          parse entry
+        end
+
+        content = nil
+
+        response.code = 0
+      else
+        response.code = 1
+        response.message = "Unable to find the lease file '#{Fission.config['lease_file']}'"
+      end
+
+      response
+    end
+
+    # Public: Get lease information for a specific MAC address.
+    #
+    # mac_address - MAC address (String) to search for.
+    #
+    # Examples
+    #
+    #   Fission::Lease.find_by_mac '00:11:AA:bb:cc:22'
+    #   # => #<Fission::Lease:0x000001008522c0...>
+    #
+    # Returns a Response with the result.
+    # If successful, the Response's data attribute will be a Lease object if the
+    # MAC address was found.  The Response's data attribute will be nil if the
+    # MAC address was not found.
+    # If there is an error, an unsuccessful Response will be returned.
+    def self.find_by_mac_address(mac_address)
+      all_response = all
+
+      if all_response.successful?
+        response = Response.new :code => 0
+        response.data = all_response.data.find { |l| l.mac_address == mac_address }
+      else
+        response = all_response
+      end
+
+      response
+    end
+
+    private
+    # Internal: Parses information out of a DHCP lease entry.
+    #
+    # entry - String of lease entry text.
+    #
+    # Examples
+    #
+    #   Lease.parse my_lease_entry
+    #   # => #<Fission::Lease:0x000001008522c0...>
+    #
+    #
+    # Returns a Lease object which is populated with the attribute that were
+    # found.
+    def self.parse(lease_entry)
+      lease = Lease.new
+
+      lease_entry.gsub! ';', ''
+
+      lease_entry.split("\n").each do |line|
+        next if line =~ /^#/
+
+        line.strip!
+
+        case line.strip
+        when /^lease/
+          lease.ip_address = line.split(' ')[1]
+        when /^starts/
+          lease.start = DateTime.parse(line.split(' ')[2..3].join(' '))
+        when /^end/
+          lease.end = DateTime.parse(line.split(' ')[2..3].join(' '))
+        when /^hardware/
+          lease.mac_address = line.split(' ')[2]
+        end
+      end
+
+      lease
+
+    end
+
+  end
+end