fission 0.3.0 → 0.4.0.beta.1

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
 .bundle
 Gemfile.lock
+doc/*
 pkg/*

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## head
 
+## 0.4.0
+* major internal refactoring for usage as a lib
+
 ## 0.3.0 (09/16/2011)
 * add ability to suspend all running VMs ('--all')
 * add 'delete' command

data/README.md

@@ -127,7 +127,7 @@ regardless of ruby environment when using RVM https://gist.github.com/1203167
 
 ## Contribute
 * Fork the project
-* Make your feature addition or bug fix (with tests) in a topic branch
+* Make your feature addition or bug fix (with tests and docs) in a topic branch
 * Bonus points for not mucking with the gemspec or version
 * Send a pull request and I'll get it integrated
 

data/lib/fission.rb

@@ -7,7 +7,9 @@ $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
 require 'fission/cli'
 require 'fission/command'
+require 'fission/command_helpers'
 require 'fission/command/clone'
+require 'fission/command/delete'
 require 'fission/command/snapshot_create'
 require 'fission/command/snapshot_list'
 require 'fission/command/snapshot_revert'
@@ -15,13 +17,14 @@ 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/lease'
 require 'fission/metadata'
+require 'fission/response'
 require 'fission/ui'
 require 'fission/vm'
 require 'fission/version'
@@ -30,10 +33,6 @@ module Fission
   extend self
 
   def config
-    @config ||= Fission::Config.new
-  end
-
-  def ui
-    @ui ||= Fission::UI.new
+    @config ||= Config.new
   end
 end

data/lib/fission/cli.rb

@@ -1,11 +1,24 @@
 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.
+    #
+    # Examples
+    #
+    #   Fission::CLI.execute
+    #
+    # 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
-          Fission.ui.output Fission::VERSION
+          ui.output VERSION
           exit(0)
         end
 
@@ -23,16 +36,16 @@ module Fission
       begin
         optparse.order! args
       rescue OptionParser::InvalidOption => e
-        Fission.ui.output e
+        ui.output e
         show_all_help(optparse)
         exit(1)
       end
 
       if commands.include?(args.first)
-        @cmd = Fission::Command.const_get(args.first.capitalize).new args.drop 1
+        @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 = Fission::Command.const_get(klass).new args.drop 2
+        @cmd = Command.const_get(klass).new args.drop 2
       else
         show_all_help(optparse)
         exit(1)
@@ -41,6 +54,16 @@ module Fission
       @cmd.execute
     end
 
+    # Internal: Provides the list of Fission commands based on the files in the
+    # command directory.
+    #
+    # Examples
+    #
+    #   Fission::CLI.commands
+    #   # => ['clone', 'delete', 'snapshot create', 'snapshot list']
+    #
+    # 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
@@ -50,22 +73,69 @@ module Fission
     end
 
     private
+    # Internal: Determines if the provided command is a snapshot related
+    # command.
+    #
+    # 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
+    #
+    #   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"
-      Fission::Command.descendants.each do |command_klass|
+      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)
+    #
+    # Returns nothing.
     def self.show_all_help(options)
-      Fission.ui.output options
-      Fission.ui.output commands_banner
+      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
     end
 
   end

data/lib/fission/command.rb

@@ -1,12 +1,54 @@
+require 'forwardable'
+
 module Fission
   class Command
-    attr_reader :options, :args
+    extend Forwardable
+
+    def_delegators :@ui, :output, :output_and_exit, :output_printf
+
+    # Internal: Returns the OpenStruct options of the command.
+    attr_reader :options
 
+    # Internal: Returns the Array arguments of the command.
+    attr_reader :args
+
+    # Internal: Initializes a new Command with some basic setup.  This is
+    # intended to be used as a base class for other command classes to inherit
+    # from.
+    #
+    # args - Array of arguments which will be assigned to the args instance
+    #        variable.
+    #
+    # Examples
+    #
+    #   Fission::Command.new ['foo', 'bar']
     def initialize(args=[])
+      ui
       @options = OpenStruct.new
       @args = args
     end
 
+    # Internal: Helper method used to delegate UI related methods through.
+    #
+    # Examples
+    #
+    #   command.ui.output 'foo'
+    #
+    # Returns a UI instance.
+    def ui
+      @ui ||= UI.new
+    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
+    # any class which inherits from this class.
+    #
+    # Examples
+    #
+    #   Fission::Command::Suspend.help
+    #
+    # Returns a String of the output parser text.
     def self.help
       self.new.option_parser.to_s
     end

data/lib/fission/command/clone.rb

@@ -1,6 +1,7 @@
 module Fission
   class Command
     class Clone < Command
+      include Fission::CommandHelpers
 
       def initialize(args=[])
         super
@@ -10,32 +11,30 @@ module Fission
       def execute
         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
-        end
+        incorrect_arguments 'clone' unless @args.count > 1
 
-        source_vm = @args.first
-        target_vm = @args[1]
+        source_vm = Fission::VM.new @args.first
+        target_vm = Fission::VM.new @args[1]
 
-        unless Fission::VM.exists? source_vm
-          Fission.ui.output_and_exit "Unable to find the source vm #{source_vm} (#{Fission::VM.path(source_vm)})", 1 
-        end
+        clone_response = VM.clone source_vm.name, target_vm.name
 
-        if Fission::VM.exists? target_vm
-          Fission::ui.output_and_exit "The target vm #{target_vm} already exists", 1
-        end
+        if clone_response.successful?
+          output ''
+          output 'Clone complete!'
 
-        Fission::VM.clone source_vm, target_vm
+          if @options.start
+            output "Starting '#{target_vm.name}'"
 
-        Fission.ui.output ''
-        Fission.ui.output 'Clone complete!'
+            start_response = target_vm.start
 
-        if @options.start
-          Fission.ui.output "Starting '#{target_vm}'"
-          @vm = Fission::VM.new target_vm
-          @vm.start
+            if start_response.successful?
+              output "VM '#{target_vm.name}' started"
+            else
+              output_and_exit "There was an error starting the VM.  The error was:\n#{start_response.message}", start_response.code
+            end
+          end
+        else
+          output_and_exit "There was an error cloning the VM.  The error was:\n#{clone_response.message}", clone_response.code
         end
       end
 

data/lib/fission/command/delete.rb

@@ -1,6 +1,7 @@
 module Fission
   class Command
     class Delete < Command
+      include Fission::CommandHelpers
 
       def initialize(args=[])
         super
@@ -10,47 +11,50 @@ module Fission
       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
+        incorrect_arguments 'delete' if @args.count < 1
 
-        target_vm = @args.first
+        vm = VM.new @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
+        running_response = vm.running?
 
-        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
+        if running_response.successful?
+          if running_response.data
+            output 'VM is currently running'
+            if @options.force
+              output 'Going to stop it'
+              Command::Stop.new([vm.name]).execute
+            else
+              output_and_exit "Either stop/suspend the VM or use '--force' and try again.", 1
+            end
           end
+        else
+          output_and_exit "There was an error determining if the VM is running.  The error was:\n#{running_response.message}", running_response.code
         end
 
-        if Fission::Fusion.is_running?
-          Fission.ui.output 'It looks like the Fusion GUI is currently running'
+        if Fusion.running?
+          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'
+            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
+            output "Either exit the Fusion GUI or use '--force' and try again"
+            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
+        delete_response = vm.delete
 
-        Fission.ui.output ''
-        Fission.ui.output "Deletion complete!"
+        if delete_response.successful?
+          output ''
+          output "Deletion complete!"
+        else
+          output_and_exit "There was an error deleting the VM.  The error was:\n#{delete_response.message}", delete_response.code
+        end
       end
 
       def option_parser
         optparse = OptionParser.new do |opts|
-          opts.banner = "\ndelete usage: fission delete target_vm [--force]"
+          opts.banner = "\ndelete usage: fission delete vm_name [--force]"
 
           opts.on '--force', "Stop the VM if it's running and then delete it" do
             @options.force = true

data/lib/fission/command/snapshot_create.rb

@@ -1,42 +1,27 @@
 module Fission
   class Command
     class SnapshotCreate < 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 create command", 1
-        end
-
-        vm_name, snap_name = @args.take 2
+        incorrect_arguments 'snapshot create' 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
-
-        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 = VM.new @args[0]
+        snap_name = @args[1]
 
-        @vm = Fission::VM.new vm_name
+        output "Creating snapshot"
+        response = vm.create_snapshot snap_name
 
-        if @vm.snapshots.include? snap_name
-          Fission.ui.output_and_exit "VM '#{vm_name}' already has a snapshot named '#{snap_name}'", 1
+        if response.successful?
+          output "Snapshot '#{snap_name}' created"
+        else
+          output_and_exit "There was an error creating the snapshot.  The error was:\n#{response.message}", response.code
         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"
+          opts.banner = "\nsnapshot create: fission snapshot create vm_name snapshot_1"
         end
 
         optparse