fission 0.4.0 → 0.5.0.beta.1

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

@@ -0,0 +1,88 @@
+module Fission
+  module Action
+    module VM
+
+      class Starter
+
+        # Internal: Creates a new VMStarter object.  This accepts a VM object.
+        #
+        # vm - An instance of VM
+        #
+        # Examples:
+        #
+        #   Fission::Action::VMStarter.new @my_vm
+        #
+        # Returns a new VMStarter object
+        def initialize(vm)
+          @vm = vm
+        end
+
+        # Public: Starts a VM.  The VM must not be running in order to start it.
+        #
+        # options - Hash of options:
+        #           :headless - Boolean which specifies to start the VM without
+        #                       a GUI console.  The Fusion GUI must not be
+        #                       running in order to start the VM headless.
+        #                       (default: false)
+        #
+        # Examples
+        #
+        #   @vm_starter.start
+        #
+        #   @vm_starter.start :headless => true
+        #
+        # 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 start(options={})
+          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
+            return Response.new :code => 1, :message => 'VM is already running'
+          end
+
+          conf_file_response = @vm.conf_file
+          return conf_file_response unless conf_file_response.successful?
+
+          unless options[:headless].blank?
+            if Fusion.running?
+              message = 'It looks like the Fusion GUI is currently running.  '
+              message << 'A VM cannot be started in headless mode when the Fusion GUI is running.  '
+              message << 'Exit the Fusion GUI and try again.'
+              return Response.new :code => 1, :message => message
+            end
+          end
+
+          command = "#{vmrun_cmd} start "
+          command << "'#{conf_file_response.data}' "
+
+          command << (options[:headless].blank? ? 'gui ' : 'nogui ')
+          command << '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
+        #
+        #   @vm_starter.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/stopper.rb

@@ -0,0 +1,79 @@
+module Fission
+  module Action
+    module VM
+
+      class Stopper
+
+        # Internal: Creates a new VMStopper object.  This accepts a VM object.
+        #
+        # vm - An instance of VM
+        #
+        # Examples:
+        #
+        #   Fission::Action::VMStopper.new @my_vm
+        #
+        # Returns a new VMStopper object
+        def initialize(vm)
+          @vm = vm
+        end
+
+        # Public: Stops a VM.  The VM must be running in order to stop it.
+        #
+        # options - Hash of options:
+        #           :hard - Boolean which specifies to power off the VM (instead
+        #                   of attempting to initiate a graceful shutdown). This
+        #                   is the equivalent of passing 'hard' to the vmrun
+        #                   stop command.
+        #                   (default: false)
+        #
+        # Examples
+        #
+        #   @stopper.stop
+        #
+        #   @stopper.stop :hard => true
+        #
+        # 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 stop(options={})
+          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
+            return Response.new :code => 1, :message => 'VM is not running'
+          end
+
+          conf_file_response = @vm.conf_file
+          return conf_file_response unless conf_file_response.successful?
+
+          command = "#{vmrun_cmd} stop "
+          command << "'#{conf_file_response.data}' "
+          command << 'hard ' unless options[:hard].blank?
+          command << '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
+        #
+        #   @vm_stopper.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/suspender.rb

@@ -0,0 +1,68 @@
+module Fission
+  module Action
+    module VM
+
+      class Suspender
+
+        # Internal: Creates a new VMSuspender object.  This accepts a VM object.
+        #
+        # vm - An instance of VM
+        #
+        # Examples:
+        #
+        #   Fission::Action::VMSuspender.new @my_vm
+        #
+        # Returns a new VMSuspender object
+        def initialize(vm)
+          @vm = vm
+        end
+
+        # Public: Suspends a VM.  The VM must be running in order to suspend it.
+        #
+        # Examples
+        #
+        #   @suspender.suspend
+        #
+        # 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 suspend
+          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
+            return Response.new :code => 1, :message => 'VM is not running'
+          end
+
+          conf_file_response = @vm.conf_file
+          return conf_file_response unless conf_file_response.successful?
+
+          command = "#{vmrun_cmd} suspend "
+          command << "'#{conf_file_response.data}' 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
+        #
+        #   @suspender.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/cli.rb

@@ -1,141 +1,45 @@
 module Fission
   class CLI
 
-    # Internal: Starts the command line parsing logic and hands off to the
-    # requested commands.  If there are invalid arguments or errors then the
-    # help text will be displayed.
-    #
-    # args - The list of arguments for the Fission command line app.  This
-    #        should be the raw command line arguments.
+    # Internal: Creates a new Fission::CLI object.  This automatically parses
+    # the arguments in ARGV.  This will also automatically display the usage
+    # and exit if applicable.
     #
     # Examples
     #
-    #   Fission::CLI.execute
+    #   Fission::CLI.new
     #
-    # Returns nothing.
-    def self.execute(args=ARGV)
-      optparse = OptionParser.new do |opts|
-        opts.banner = "\nUsage: fission [options] COMMAND [arguments]"
-
-        opts.on_head('-v', '--version', 'Output the version of fission') do
-          ui.output VERSION
-          exit(0)
-        end
-
-        opts.on_head('-h', '--help', 'Displays this message') do
-          show_all_help(optparse)
-          exit(0)
-        end
-
-        opts.define_tail do
-          commands_banner
-        end
+    # Returns a Fission::CLI object.
+    def initialize(args=ARGV, parser=CommandLineParser)
+      @args = args ||= ARGV
 
-      end
+      @parser = parser.new @args
 
-      begin
-        optparse.order! args
-      rescue OptionParser::InvalidOption => e
-        ui.output e
-        show_all_help(optparse)
-        exit(1)
-      end
-
-      if commands.include?(args.first)
-        @cmd = Command.const_get(args.first.capitalize).new args.drop 1
-      elsif is_snapshot_command?(args)
-        klass = args.take(2).map {|c| c.capitalize}.join('')
-        @cmd = Command.const_get(klass).new args.drop 2
-      else
-        show_all_help(optparse)
-        exit(1)
-      end
-
-      @cmd.execute
+      parse_arguments
     end
 
-    # Internal: Provides the list of Fission commands based on the files in the
-    # command directory.
+    # Internal: Execute the determined command.
     #
-    # Examples
+    # Examples:
     #
-    #   Fission::CLI.commands
-    #   # => ['clone', 'delete', 'snapshot create', 'snapshot list']
+    #   Fission::CLI.new(ARGV).execute
     #
-    # Returns an Array of the commands (String).  Commands with underscores will
-    # have them replaced with spaces.
-    def self.commands
-      cmds = Dir.entries(File.join(File.dirname(__FILE__), 'command')).select do |file|
-        !File.directory? file
-      end
-
-      cmds.map { |cmd| File.basename(cmd, '.rb').gsub '_', ' ' }
+    # Returns nothing.
+    def execute
+      @cmd.execute
     end
 
     private
-    # Internal: Determines if the provided command is a snapshot related
-    # command.
+    # Internal: Parses the arguments using the parser.
     #
-    # args - The arguments (Array) to interrogate.  This should be the command
-    #        line arguments.  Only the first two items in the Array will be
-    #        used.
-    #
-    # Examples
+    # Examples:
     #
-    #   Fission::CLI.is_snapshot_command? ['foo', 'bar']
-    #   # => false
-    #
-    #   Fission::CLI.is_snapshot_command? ['snapshot', 'list']
-    #   # => true
-    #
-    # Returns a Boolean of whether a snapshot command was given or not.
-    def self.is_snapshot_command?(args)
-      args.first == 'snapshot' && args.count > 1 && commands.include?(args.take(2).join(' '))
-    end
-
-    # Internal: Provides the help of all of the known commands.
-    #
-    # Examples
-    #
-    #   Fission::CLI.commands_banner
-    #
-    # Returns a String which is a concatenation of the help text for all known
-    # commands.
-    def self.commands_banner
-      text = "\nCommands:\n"
-      Command.descendants.each do |command_klass|
-        text << (command_klass.send :help)
-      end
-
-      text
-    end
-
-    # Internal: Helper method to output the command line options and the help
-    # for all known commands to the terminal.
-    #
-    # options - The options to display as a part of the output.  This can (and
-    #           in almost all cases) should be the optparse object.
-    #
-    # Examples
-    #
-    #   Fission::CLI.show_all_help my_opt_parse
-    #   # => 'fission options command arguments ....' (concatenated)
+    #   @cli.parse_arguments
     #
     # Returns nothing.
-    def self.show_all_help(options)
-      ui.output options
-      ui.output commands_banner
-    end
-
-    # Internal: Helper method for outputting text to the ui
-    #
-    # Examples
-    #
-    #   CLI.ui.output 'foo'
-    #
-    # Returns a UI instance.
-    def self.ui
-      @ui ||= UI.new
+    def parse_arguments
+      @parser.parse
+      @cmd = @parser.command
     end
 
   end

data/lib/fission/command.rb

@@ -1,7 +1,9 @@
 require 'forwardable'
+require 'fission/command_helpers'
 
 module Fission
   class Command
+    include Fission::CommandHelpers
     extend Forwardable
 
     def_delegators :@ui, :output, :output_and_exit, :output_printf
@@ -28,6 +30,17 @@ module Fission
       @args = args
     end
 
+    # Internal: Primary method for performing an action within a command.
+    #
+    # Examples
+    #
+    #   command.execute
+    #
+    # Returns nothing
+    def execute
+      parse_arguments
+    end
+
     # Internal: Helper method used to delegate UI related methods through.
     #
     # Examples
@@ -39,6 +52,32 @@ module Fission
       @ui ||= UI.new
     end
 
+    # Internal: Helper method to determine the command name of command class.
+    # This should only be called against descendants of this class.
+    #
+    # #xamples:
+    #   Fission::Command::SnapshotList.new.command_name
+    #   # => 'snapshot list'
+    #
+    # Returns the command name as a String.
+    def command_name(klass=self)
+      klass.class.name.split('::')[2].
+                       gsub(/([a-z\d])([A-Z])/,'\1_\2').
+                       gsub('_', ' ').downcase
+    end
+
+    # Internal: Summmary of the command.  This is to be implemented by any
+    # class which inherits from this class.
+    #
+    # Examples
+    #   command.summary
+    #   # => 'This command does x and y'
+    #
+    # Returns a String summary of the command.
+    def summary
+      raise NotImplementedError
+    end
+
     # Internal: Helper method to return the help text of a command.  This is
     # intended to be used by a command class which inherits from this class.
     # This method will call the 'option_parser' method which must be defined in