jamie 0.1.0.beta1 → 0.1.0.beta2

data/lib/jamie.rb

@@ -65,6 +65,38 @@ module Jamie
     end
   end
 
+  module Error ; end
+
+  # Base exception class from which all Jamie exceptions derive. This class
+  # nests an exception when this class is re-raised from a rescue block.
+  class StandardError < ::StandardError
+
+    include Error
+
+    attr_reader :original
+
+    def initialize(msg, original = $!)
+      super(msg)
+      @original = original
+    end
+  end
+
+  # Base exception class for all exceptions that are caused by user input
+  # errors.
+  class UserError < StandardError ; end
+
+  # Base exception class for all exceptions that are caused by incorrect use
+  # of an API.
+  class ClientError < StandardError ; end
+
+  # Base exception class for exceptions that are caused by external library
+  # failures which may be temporary.
+  class TransientFailure < StandardError ; end
+
+  # Exception class for any exceptions raised when performing an instance
+  # action.
+  class ActionFailed < TransientFailure ; end
+
   # Base configuration class for Jamie. This class exposes configuration such
   # as the location of the Jamie YAML file, instances, log_levels, etc.
   #
@@ -75,6 +107,7 @@ module Jamie
     attr_writer :platforms
     attr_writer :suites
     attr_writer :log_level
+    attr_writer :supervised
     attr_writer :test_base_path
 
     # Default path to the Jamie YAML file
@@ -126,6 +159,10 @@ module Jamie
       end
     end
 
+    def supervised
+      @supervised.nil? ? @supervised = true : @supervised
+    end
+
     # @return [String] base path that may contain a common `data_bags/`
     #   directory or an instance's `data_bags/` directory
     def test_base_path
@@ -210,17 +247,28 @@ module Jamie
     def new_instance(suite, platform, index)
       platform_hash = platform_driver_hash(platform.name)
       driver = new_driver(merge_driver_hash(platform_hash))
-      FileUtils.mkdir_p(log_root)
-
-      supervisor = Instance.supervise_as(
-        "instance_#{index}".to_sym,
+      actor_name = "instance_#{index}".to_sym
+      opts = {
         :suite    => suite,
         :platform => platform,
         :driver   => driver,
         :jr       => Jr.new(suite.name),
         :logger   => new_instance_logger(index)
-      )
-      supervisor.actors.first
+      }
+
+      FileUtils.mkdir_p(log_root)
+      new_instance_supervised_or_not(actor_name, opts)
+    end
+
+    def new_instance_supervised_or_not(actor_name, opts)
+      if supervised
+        supervisor = Instance.supervise_as(actor_name, opts)
+        actor = supervisor.actors.first
+        Jamie.logger.debug("Supervising #{actor.to_str} with #{supervisor}")
+        actor
+      else
+        Celluloid::Actor[actor_name] = Instance.new(opts)
+      end
     end
 
     def log_root
@@ -505,7 +553,7 @@ module Jamie
 
     def validate_options(opts)
       [ :name, :run_list ].each do |k|
-        raise ArgumentError, "Attribute '#{k}' is required." if opts[k].nil?
+        raise ClientError, "Suite#new requires option :#{k}" if opts[k].nil?
       end
     end
   end
@@ -546,7 +594,7 @@ module Jamie
 
     def validate_options(opts)
       [ :name ].each do |k|
-        raise ArgumentError, "Attribute '#{k}' is required." if opts[k].nil?
+        raise ClientError, "Platform#new requires option :#{k}" if opts[k].nil?
       end
     end
   end
@@ -726,11 +774,15 @@ module Jamie
       Kernel.exec(command, *args)
     end
 
+    def last_action
+      load_state[:last_action]
+    end
+
     private
 
     def validate_options(opts)
       [ :suite, :platform, :driver, :jr, :logger ].each do |k|
-        raise ArgumentError, "Attribute '#{k}' is required." if opts[k].nil?
+        raise ClientError, "Instance#new requires option :#{k}" if opts[k].nil?
       end
     end
 
@@ -785,8 +837,12 @@ module Jamie
       elapsed = Benchmark.measure do
         synchronize_or_call(what, state, &block)
       end
-      state[:last_action] = what.to_s
+      state[:last_action] = what
       elapsed
+    rescue ActionFailed
+      raise
+    rescue Exception => e
+      raise ActionFailed, "Failed to complete ##{what} action: [#{e.message}]"
     ensure
       dump_state(state)
     end
@@ -828,10 +884,6 @@ module Jamie
       ))
     end
 
-    def last_action
-      load_state[:last_action]
-    end
-
     # The simplest finite state machine pseudo-implementation needed to manage
     # an Instance.
     #
@@ -952,7 +1004,7 @@ module Jamie
     DEFAULT_TEST_ROOT = File.join(Dir.pwd, "test/integration").freeze
 
     def validate_options(suite_name)
-      raise ArgumentError, "'suite_name' is required." if suite_name.nil?
+      raise ClientError, "Jr#new requires a suite_name" if suite_name.nil?
     end
 
     def install_script
@@ -1063,7 +1115,7 @@ module Jamie
   module ShellOut
 
     # Wrapped exception for any interally raised shell out commands.
-    class ShellCommandFailed < StandardError ; end
+    class ShellCommandFailed < TransientFailure ; end
 
     # Executes a command in a subshell on the local running system.
     #
@@ -1071,6 +1123,8 @@ module Jamie
     # @param use_sudo [TrueClass, FalseClass] whether or not to use sudo
     # @param log_subject [String] used in the output or log header for clarity
     #   and context
+    # @raise [ShellCommandFailed] if the command fails
+    # @raise [Error] for all other unexpected exceptions
     def run_command(cmd, use_sudo = false, log_subject = "local")
       cmd = "sudo #{cmd}" if use_sudo
       subject = "[#{log_subject} command]"
@@ -1082,6 +1136,9 @@ module Jamie
       sh.error!
     rescue Mixlib::ShellOut::ShellCommandFailed => ex
       raise ShellCommandFailed, ex.message
+    rescue Exception => error
+      error.extend(Jamie::Error)
+      raise
     end
 
     private
@@ -1096,18 +1153,23 @@ module Jamie
 
   module Driver
 
-    # Wrapped exception for any internally raised driver exceptions.
-    class ActionFailed < StandardError ; end
-
     # Returns an instance of a driver given a plugin type string.
     #
     # @param plugin [String] a driver plugin type, which will be constantized
     # @return [Driver::Base] a driver instance
+    # @raise [ClientError] if a driver instance could not be created
     def self.for_plugin(plugin, config)
       require "jamie/driver/#{plugin}"
 
-      klass = self.const_get(Util.to_camel_case(plugin))
+      str_const = Util.to_camel_case(plugin)
+      klass = self.const_get(str_const)
       klass.new(config)
+    rescue LoadError
+      raise ClientError, "Could not require '#{plugin}' plugin from load path"
+    rescue NameError
+      raise ClientError, "No class 'Jamie::Driver::#{str_const}' could be found"
+    rescue
+      raise ClientError, "Failed to create a driver for '#{plugin}' plugin"
     end
 
     # Base class for a driver. A driver is responsible for carrying out the
@@ -1218,7 +1280,7 @@ module Jamie
       def self.no_parallel_for(*methods)
         Array(methods).each do |meth|
           if ! ACTION_METHODS.include?(meth)
-            raise ArgumentError, "##{meth} is not a whitelisted method."
+            raise ClientError, "##{meth} is not a valid no_parallel_for method"
           end
         end
 
@@ -1236,7 +1298,7 @@ module Jamie
     class SSHBase < Base
 
       def create(state)
-        raise NotImplementedError, "#create must be implemented by subclass."
+        raise ClientError, "#{self.class}#create must be implemented"
       end
 
       def converge(state)
@@ -1266,7 +1328,7 @@ module Jamie
       end
 
       def destroy(state)
-        raise NotImplementedError, "#destroy must be implemented by subclass."
+        raise ClientError, "#{self.class}#destroy must be implemented"
       end
 
       def login_command(state)
@@ -1295,9 +1357,9 @@ module Jamie
       end
 
       def install_omnibus(ssh_args)
-        ssh(ssh_args, <<-INSTALL)
+        ssh(ssh_args, <<-INSTALL.gsub(/^ {10}/, ''))
           if [ ! -d "/opt/chef" ] ; then
-            curl -L https://www.opscode.com/chef/install.sh | sudo bash
+            curl -sSL https://www.opscode.com/chef/install.sh | sudo bash
           fi
         INSTALL
       end
@@ -1320,6 +1382,7 @@ module Jamie
       end
 
       def ssh(ssh_args, cmd)
+        debug("[SSH] #{ssh_args[1]}@#{ssh_args[0]} (#{cmd})")
         Net::SSH.start(*ssh_args) do |ssh|
           exit_code = ssh_exec_with_exit!(ssh, cmd)
 
@@ -1336,6 +1399,9 @@ module Jamie
       def ssh_exec_with_exit!(ssh, cmd)
         exit_code = nil
         ssh.open_channel do |channel|
+
+          channel.request_pty
+
           channel.exec(cmd) do |ch, success|
 
             channel.on_data do |ch, data|
@@ -1462,44 +1528,40 @@ module Jamie
 
     def prepare_tmpdir(tmpdir)
       if File.exists?(File.join(jamie_root, "Berksfile"))
-        run_berks(tmpdir)
+        run_resolver("Berkshelf", "berks", tmpdir)
       elsif File.exists?(File.join(jamie_root, "Cheffile"))
-        run_librarian(tmpdir)
+        run_resolver("Librarian", "librarian-chef", tmpdir)
       elsif File.directory?(File.join(jamie_root, "cookbooks"))
         cp_cookbooks(tmpdir)
       else
         FileUtils.rmtree(tmpdir)
-        abort "Berksfile, Cheffile or cookbooks/ must exist in #{jamie_root}"
+        fatal("Berksfile, Cheffile or cookbooks/ must exist in #{jamie_root}")
+        raise UserError, "Cookbooks could not be found"
       end
     end
 
-    def run_berks(tmpdir)
+    def run_resolver(name, bin, tmpdir)
       begin
-        run_command "if ! command -v berks >/dev/null; then exit 1; fi"
+        run_command "if ! command -v #{bin} >/dev/null; then exit 1; fi"
       rescue Jamie::ShellOut::ShellCommandFailed
-        abort ">>>>>> Berkshelf must be installed, add it to your Gemfile."
+        fatal("#{name} must be installed, add it to your Gemfile.")
+        raise UserError, "#{bin} command not found"
       end
-      run_command "berks install --path #{tmpdir}"
+      run_command "#{bin} install --path #{tmpdir}"
     end
 
-    def run_librarian(tmpdir)
-      begin
-        run_command "if ! command -v librarian-chef >/dev/null; then exit 1; fi"
-      rescue Jamie::ShellOut::ShellCommandFailed
-        abort ">>>>>> Librarian must be installed, add it to your Gemfile."
-      end
-      run_command "librarian-chef install --path #{tmpdir}"
+    def cp_cookbooks(tmpdir)
+      FileUtils.cp_r(File.join(jamie_root, "cookbooks", "."), tmpdir)
+      cp_this_cookbook(tmpdir) if File.exists?(File.expand_path('metadata.rb'))
     end
 
-    def cp_cookbooks(tmpdir)
+    def cp_this_cookbook(tmpdir)
       metadata_rb = File.join(jamie_root, "metadata.rb")
       cb_name = MetadataChopper.extract(metadata_rb).first
-      abort ">>>>>> name attribute must be set in metadata.rb." if cb_name.nil?
       cb_path = File.join(tmpdir, cb_name)
       glob = Dir.glob("#{jamie_root}/{metadata.rb,README.*," +
         "attributes,files,libraries,providers,recipes,resources,templates}")
 
-      FileUtils.cp_r(File.join(jamie_root, "cookbooks", "."), tmpdir)
       FileUtils.mkdir_p(cb_path)
       FileUtils.cp_r(glob, cb_path)
     end

data/lib/jamie/cli.rb

@@ -37,12 +37,23 @@ module Jamie
       super
       $stdout.sync = true
       @config = Jamie::Config.new(ENV['JAMIE_YAML'])
+      @config.supervised = false
     end
 
     desc "list [(all|<REGEX>)]", "List all instances"
+    method_option :bare, :aliases => "-b", :type => :boolean,
+      :desc => "List the name of each instance only, one per line"
     def list(*args)
       result = parse_subcommand(args.first)
-      say Array(result).map{ |i| i.name }.join("\n")
+      if options[:bare]
+        say Array(result).map{ |i| i.name }.join("\n")
+      else
+        table = [
+          [ set_color("Instance", :green), set_color("Last Action", :green) ]
+        ]
+        table += Array(result).map { |i| display_instance(i) }
+        print_table(table)
+      end
     end
 
     [:create, :converge, :setup, :verify, :destroy].each do |action|
@@ -189,6 +200,18 @@ module Jamie
       result
     end
 
+    def display_instance(instance)
+      action = case instance.last_action
+      when :create then set_color("Created", :cyan)
+      when :converge then set_color("Converged", :magenta)
+      when :setup then set_color("Set Up", :blue)
+      when :verify then set_color("Verified", :yellow)
+      when nil then set_color("<Not Created>", :red)
+      else set_color("<Unknown>", :white)
+      end
+      [ set_color(instance.name, :white), action ]
+    end
+
     def die(task, msg)
       error "\n#{msg}\n\n"
       help(task)
@@ -266,7 +289,11 @@ module Jamie
           }
         end
       end.flatten
-      cookbook_name = MetadataChopper.extract('metadata.rb').first
+      cookbook_name = if File.exists?(File.expand_path('metadata.rb'))
+        MetadataChopper.extract('metadata.rb').first
+      else
+        nil
+      end
       run_list = cookbook_name ? "recipe[#{cookbook_name}]" : nil
       attributes = cookbook_name ? { cookbook_name => nil } : nil
 

data/lib/jamie/rake_tasks.rb

@@ -32,6 +32,7 @@ module Jamie
     # @yield [self] gives itself to the block
     def initialize
       @config = Jamie::Config.new
+      @config.supervised = false
       yield self if block_given?
       define
     end

data/lib/jamie/thor_tasks.rb

@@ -35,6 +35,7 @@ module Jamie
     def initialize(*args)
       super
       @config = Jamie::Config.new
+      @config.supervised = false
       yield self if block_given?
       define
     end

data/lib/jamie/version.rb

@@ -18,5 +18,5 @@
 
 module Jamie
 
-  VERSION = "0.1.0.beta1"
+  VERSION = "0.1.0.beta2"
 end

data/spec/jamie_spec.rb

@@ -314,12 +314,12 @@ describe Jamie::Suite do
 
   it "raises an ArgumentError if name is missing" do
     opts.delete(:name)
-    proc { Jamie::Suite.new(opts) }.must_raise ArgumentError
+    proc { Jamie::Suite.new(opts) }.must_raise Jamie::ClientError
   end
 
   it "raises an ArgumentError if run_list is missing" do
     opts.delete(:run_list)
-    proc { Jamie::Suite.new(opts) }.must_raise ArgumentError
+    proc { Jamie::Suite.new(opts) }.must_raise Jamie::ClientError
   end
 
   it "returns an empty Hash given no attributes" do
@@ -352,7 +352,7 @@ describe Jamie::Platform do
 
   it "raises an ArgumentError if name is missing" do
     opts.delete(:name)
-    proc { Jamie::Platform.new(opts) }.must_raise ArgumentError
+    proc { Jamie::Platform.new(opts) }.must_raise Jamie::ClientError
   end
 
   it "returns an empty Array given no run_list" do
@@ -399,12 +399,12 @@ describe Jamie::Instance do
 
   it "raises an ArgumentError if suite is missing" do
     opts.delete(:suite)
-    proc { Jamie::Instance.new(opts) }.must_raise ArgumentError
+    proc { Jamie::Instance.new(opts) }.must_raise Jamie::ClientError
   end
 
   it "raises an ArgumentError if platform is missing" do
     opts.delete(:platform)
-    proc { Jamie::Instance.new(opts) }.must_raise ArgumentError
+    proc { Jamie::Instance.new(opts) }.must_raise Jamie::ClientError
   end
 
   it "returns suite" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jamie
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta1
+  version: 0.1.0.beta2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-12 00:00:00.000000000 Z
+date: 2013-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid