solutious-rudy 0.5.1 → 0.6.0

data/lib/rudy.rb

@@ -26,22 +26,18 @@ require 'net/ssh/multi'
 require 'net/ssh/gateway'
 
 
+require 'logger'
 
 # = Rudy
 #
 # == About
 #
 # Rudy is a development and deployment tool for the Amazon Elastic Compute Cloud
-# (EC2). There are two interfaces: a command-line executable and a Ruby library.
-# You can use Rudy as a development tool to simply the management of instances, 
-# security groups, etc... on an ad-hoc basic. You can also define complex machine 
-# environments using a simple domain specific language (DSL) and use Rudy to build
-# and deploy these environments. 
-#
+# (EC2). See README.rdoc for more information. 
 #
 # == Status: Alpha
 # 
-# The current release (0.5) is not ready for general production use. Use it for 
+# The current release (0.6) is not ready for general production use. Use it for 
 # exploring EC2 and operating your development / ad-hoc instances. We've put in 
 # a lot of effort to make sure Rudy plays safe, but it's possible we missed
 # something. That's why we consider it alpha code. 
@@ -51,42 +47,59 @@ require 'net/ssh/gateway'
 #     $ rudy -h
 #     $ rudy show-commands
 #
+# Also:
+#
+#     $ rudy-ec2 -h
+#     $ rudy-ec2 show-commands
+#
 # And if you're feeling particularly saucey, try Rudy's REPL interface:
 #
 #     $ ird
 # 
-# == Next Release (0.6): May 2009.
-#
-#     $ rudy slogan
-#     Rudy: Not your grandparent's deployment tool! 
 #
 #
 module Rudy
   extend self
   
-  unless defined?(RUDY_DOMAIN) # We can assume all constants are defined
+  module VERSION #:nodoc:
+    unless defined?(MAJOR)
+      MAJOR = 0.freeze
+      MINOR = 6.freeze
+      TINY  = 0.freeze
+    end
+    def self.to_s; [MAJOR, MINOR, TINY].join('.'); end
+    def self.to_f; self.to_s.to_f; end
+  end
+  
+  unless defined?(Rudy::DOMAIN) # We can assume all constants are defined
     # SimpleDB accepts dashes in the domain name on creation and with the query syntax. 
     # However, with select syntax it says: "The specified query expression syntax is not valid"
-    RUDY_DOMAIN = "rudy_state".freeze
-    RUDY_DELIM  = '-'.freeze
-  
-    RUDY_CONFIG_DIR = File.join(ENV['HOME'] || ENV['USERPROFILE'], '.rudy').freeze
-    RUDY_CONFIG_FILE = File.join(RUDY_CONFIG_DIR, 'config').freeze
+    DOMAIN = "rudy_state".freeze
+    DELIM  = '-'.freeze
   
+    CONFIG_DIR = File.join(ENV['HOME'] || ENV['USERPROFILE'], '.rudy').freeze
+    CONFIG_FILE = File.join(Rudy::CONFIG_DIR, 'config').freeze
+    
     DEFAULT_REGION = 'us-east-1'.freeze 
     DEFAULT_ZONE = 'us-east-1b'.freeze 
     DEFAULT_ENVIRONMENT = 'stage'.freeze
     DEFAULT_ROLE = 'app'.freeze
     DEFAULT_POSITION = '01'.freeze
-                                 
+    
     DEFAULT_USER = 'rudy'.freeze
-  
+    
+    DEFAULT_EC2_HOST = "ec2.amazonaws.com"
+    DEFAULT_EC2_PORT = 443
+    
+    MAX_INSTANCES = 3.freeze
+    
     SUPPORTED_SCM_NAMES = [:svn, :git].freeze
   
     ID_MAP = {
       :instance => 'i',
       :disk => 'disk',
       :backup => 'back',
+      :machine => 'm',
       :volume => 'vol',
       :snapshot => 'snap',
       :kernel => 'aki',
@@ -94,257 +107,72 @@ module Rudy
       :ram => 'ari',
       :log => 'log',
       :key => 'key',
-      :pk => 'pk',
-      :cert => 'cert',
-      :reservation => 'r'
+      :awspk => 'pk',
+      :awscert => 'cert',
+      :reservation => 'r',
+      :dns_public => 'ec2',
+      :dns_private => 'domU',
     }.freeze
     
+    @@quiet = false
+    @@debug = false
     @@sysinfo = SystemInfo.new.freeze
+    
   end
   
-  module VERSION #:nodoc:
-    unless defined?(MAJOR)
-      MAJOR = 0.freeze
-      MINOR = 5.freeze
-      TINY  = 1.freeze
-    end
-    def self.to_s; [MAJOR, MINOR, TINY].join('.'); end
-    def self.to_f; self.to_s.to_f; end
-  end
-
-  @@quiet = false
+  def Rudy.debug?; @@debug == true; end
+  def Rudy.quiet?; @@quiet == true; end
+  def Rudy.enable_debug; @@debug = true; end
   def Rudy.enable_quiet; @@quiet = true; end
+  def Rudy.disable_debug; @@debug = false; end
   def Rudy.disable_quiet; @@quiet = false; end
-    
+  
   def Rudy.sysinfo; @@sysinfo; end
   def sysinfo; @@sysinfo;  end
   
-  # Determine if we're running directly on EC2 or
-  # "some other machine". We do this by checking if
-  # the file /etc/ec2/instance-id exists. This
-  # file is written by /etc/init.d/rudy-ec2-startup. 
-  # NOTE: Is there a way to know definitively that this is EC2?
-  # We could make a request to the metadata IP addresses. 
-  def Rudy.in_situ?
-    File.exists?('/etc/ec2/instance-id')
+  class Error < RuntimeError
+    def initialize(obj); @obj = obj; end
+    def message; "#{self.class}: #{@obj}"; end
   end
-  
-  
-  # Wait for something to happen. 
-  # * +duration+ seconds to wait between tries (default: 2).
-  # * +max+ maximum time to wait (default: 120). Throws an exception when exceeded.
-  # * +logger+ IO object to print +dot+ to.
-  # * +dot+ the character to print after each attempt (default: .). 
-  # Set to nil or false to keep the waiter silent.
-  # The block must return false while waiting. Once it returns true
-  # the waiter will return true too.
-  def Rudy.waiter(duration=2, max=120, logger=STDOUT, dot='.', &check)
-    # TODO: Move to Drydock
-    raise "The waiter needs a block!" unless check
-    duration = 1 if duration < 1
-    max = duration*2 if max < duration
-    success = false
-    begin
-      success = Timeout::timeout(max) do
-        while !check.call
-          logger.print dot if dot && logger.respond_to?(:print)
-          logger.flush if logger.respond_to?(:flush)
-          sleep duration
-        end
-      end
-    rescue Timeout::Error => ex
-      retry if Annoy.pose_question(" Keep waiting?\a ", /yes|y|ya|sure|you bet!/i, logger)
-      raise ex # We won't get here unless the question fails
+  class InsecureKeyPermissions < Rudy::Error
+    def message
+      lines = ["Insecure file permissions for #{@obj}"]
+      lines << "Try: chmod 600 #{@obj}"
+      lines.join($/)
     end
-    success
   end
-  
-  # Make a terminal bell chime
-  def Rudy.bell(chimes=1, logger=nil)
-    return if @@quiet
-    chimed = chimes.to_i
-    logger.print "\a"*chimes if logger
-    true # be like Rudy.bug()
+  class NoConfig < Rudy::Error
+    def message; "No AWS credentials. Check your configs!"; end
   end
-  
-  # Have you seen that episode of The Cosby Show where Dizzy Gillespie... ah nevermind.
-  def Rudy.bug(bugid, logger=STDERR)
-    logger.puts "You have found a bug! If you want, you can email".color(:red)
-    logger.puts 'rudy@solutious.com'.color(:red).bright << " about it. It's bug ##{bugid}.".color(:red)          
-    logger.puts "Continuing...".color(:red)
-    true # so we can string it together like: bug('1') && next if ...
+  class ServiceUnavailable < Rudy::Error
+    def message; "#{@obj} is not available. Check your internets!"; end
   end
-
-  # Is the given string +str+ an ID of type +identifier+? 
-  # * +identifier+ is expected to be a key from ID_MAP
-  # * +str+ is a string you're investigating
-  def Rudy.is_id?(identifier, str)
-    return false unless identifier && str && Rudy.known_type?(identifier)
-    identifier &&= identifier.to_sym
-    str &&= str.to_s.strip
-    str.split('-').first == Rudy::ID_MAP[identifier].to_s
+  class MachineGroupAlreadyRunning < Rudy::Error
+    def message; "Machine group #{@obj} is already running."; end
   end
-  
-  # Returns the object type associated to +str+ or nil if unknown. 
-  # * +str+ is a string you're investigating
-  def Rudy.id_type(str)
-    return false unless str
-    str &&= str.to_s.strip
-    (Rudy::ID_MAP.detect { |n,v| v == str.split('-').first } || []).first
+  class MachineGroupNotRunning < Rudy::Error
+    def message; "Machine group #{@obj} is not running."; end
   end
-  
-  # Is the given +key+ a known type of object?
-  def Rudy.known_type?(key)
-    return false unless key
-    key &&= key.to_s.to_sym
-    Rudy::ID_MAP.has_key?(key)
-  end
-  
-  # Returns the string identifier associated to this +key+
-  def Rudy.identifier(key)
-    key &&= key.to_sym
-    return unless Rudy::ID_MAP.has_key?(key)
-    Rudy::ID_MAP[key]
-  end
-  
-  # Return a string ID without the identifier. i.e. key-stage-app-root => stage-app-root
-  def Rudy.strip_identifier(str)
-    el = str.split('-')
-    el.shift
-    el.join('-')
-  end
-    
-  # +msg+ The message to return as a banner
-  # +size+ One of: :normal (default), :huge
-  # +colour+ a valid 
-  # Returns a string with styling applying
-  def Rudy.banner(msg, size = :normal, colour = :black)
-    return unless msg
-    banners = {
-      :huge => Rudy::Utils.without_indent(%Q(
-      =======================================================
-      =======================================================
-      !!!!!!!!!   %s   !!!!!!!!!
-      =======================================================
-      =======================================================)),
-      :normal => %Q(============  %s  ============)
-    }
-    size = :normal unless banners.has_key?(size)
-    colour = :black unless Console.valid_colour?(colour)
-    size, colour = size.to_sym, colour.to_sym
-    sprintf(banners[size], msg).colour(colour).bgcolour(:white).bright
-  end
-  
-  # Run a block and trap common, known errors. 
-  # * +default+ A default response value
-  # * +request+ A block which contains the AWS request
-  # Returns the return value from the request is returned untouched
-  # or the default value on error or if the request returned nil. 
-  def trap_known_errors(default=nil, &request)
-    raise "No block provided" unless request
-    response = nil
-    begin
-      response = request.call
-    rescue => ex
-      STDERR.puts ex.message
-    ensure
-      response ||= default
-    end
-    response
+  class MachineGroupNotDefined < Rudy::Error 
+    def message; "#{@obj} is not defined in machines config."; end
   end
-  
-  
-  class NoConfig < RuntimeError
-    def message
-      "No AWS credentials. Check your configs!"
-    end
-  end
-  class NoMachineImage < RuntimeError
-    def initialize(group)
-      @group = group
-    end
-    def message
-      "There is no AMI configured for #{@group}"
-    end
+  class PrivateKeyFileExists < Rudy::Error
+    def message; "Private key #{@obj} already exists."; end
   end
-end
-
-require 'rudy/aws'
-require 'rudy/utils'               # The
-require 'rudy/config'              # order
-require 'rudy/huxtable'            # of
-require 'rudy/command/addresses'   # require
-require 'rudy/command/keypairs'
-require 'rudy/command/instances'   # statements
-require 'rudy/command/manager'     # is
-require 'rudy/command/domains'
-require 'rudy/command/backups'     # important.
-require 'rudy/command/volumes'
-require 'rudy/command/groups'
-require 'rudy/command/disks'
-require 'rudy/routines'    
-
-
-# Require MetaData, Routines, and SCM classes
-begin
-  # TODO: Use autoload
-  Dir.glob(File.join(RUDY_LIB, 'rudy', '{metadata,routines,scm}', "*.rb")).each do |path|
-    require path
+  class PrivateKeyNotFound < Rudy::Error
+    def message; "Private key file #{@obj} not found."; end
   end
-rescue LoadError => ex
-  puts "Error: #{ex.message}"
-  exit 1
-end
-
-
-
-# ---
-# TODO: Find a home for these poor guys:
-# +++
-
-def sh(command, chdir=false, verbose=false)
-  prevdir = Dir.pwd
-  Dir.chdir chdir if chdir
-  puts command if verbose
-  system(command)
-  Dir.chdir prevdir if chdir
 end
 
+require 'rudy/utils'      # The
+require 'rudy/global'     # order    
+require 'rudy/config'     # of 
+require 'rudy/huxtable'   # requires
+require 'rudy/aws'        # is
+require 'rudy/metadata'   # important
 
-def ssh_command(host, keypair, user, command=false, printonly=false, verbose=false)
-  #puts "CONNECTING TO #{host}..."
-  cmd = "ssh -i #{keypair} #{user}@#{host} "
-  cmd += " '#{command}'" if command
-  puts cmd if verbose
-  return cmd if printonly
-  # backticks returns STDOUT
-  # exec replaces current process (it's just like running ssh)
-  # -- UPDATE -- Some problem with exec. "Operation not supported"
-  # using system (http://www.mail-archive.com/mongrel-users@rubyforge.org/msg02018.html)
-  (command) ? `#{cmd}` : Kernel.system(cmd)
-end
-
+require 'rudy/machines'
+require 'rudy/disks'
+require 'rudy/routines'
 
-def scp_command(host, keypair, user, paths, to_path, to_local=false, verbose=false, printonly=false)
-  
-  paths = [paths] unless paths.is_a?(Array)
-  from_paths = ""
-  if to_local
-    paths.each do |path|
-      from_paths << "#{user}@#{host}:#{path} "
-    end  
-    puts "Copying FROM remote TO this machine", $/
-    
-  else
-    to_path = "#{user}@#{host}:#{to_path}"
-    from_paths = paths.join(' ')
-    puts "Copying FROM this machine TO remote", $/
-  end
-  
-  
-  cmd = "scp -r -i #{keypair} #{from_paths} #{to_path}"
-
-  puts cmd if verbose
-  printonly ? (puts cmd) : system(cmd)
-end
 

data/lib/storable.rb

@@ -13,10 +13,10 @@ require 'fileutils'
 # Storable.field method which tells Storable the order and 
 # name.
 class Storable
-  unless defined?(VERSION) # We can assume all are defined
-    VERSION = 2
+  unless defined?(SUPPORTED_FORMATS) # We can assume all are defined
+    VERSION = 5
     NICE_TIME_FORMAT  = "%Y-%m-%d@%H:%M:%S".freeze 
-    SUPPORTED_FORMATS = %w{tsv csv yaml json}.freeze 
+    SUPPORTED_FORMATS = %w{tsv csv yaml json s string}.freeze 
   end
   
   # This value will be used as a default unless provided on-the-fly.
@@ -29,14 +29,11 @@ class Storable
     @format = v
   end
   
-  # TODO: from_args([HASH or ordered params])
-  
-  def init
-    # NOTE: I think this can be removed
-    self.class.send(:class_variable_set, :@@field_names, []) unless class_variable_defined?(:@@field_names)
-    self.class.send(:class_variable_set, :@@field_types, []) unless class_variable_defined?(:@@field_types)
+  def postprocess
   end
   
+  # TODO: from_args([HASH or ordered params])
+  
   # Accepts field definitions in the one of the follow formats:
   #
   #     field :product
@@ -70,7 +67,7 @@ class Storable
   def self.field_names
     class_variable_get(:@@field_names)
   end
-  # Ditto.
+  # Returns an array of field names defined by self.field
   def field_names
     self.class.send(:class_variable_get, :@@field_names)
   end
@@ -79,18 +76,23 @@ class Storable
   def self.field_types
     class_variable_get(:@@field_types)
   end
-  # Ditto.
+  # Returns an array of field types defined by self.field. Fields that did 
+  # not receive a type are set to nil.
   def field_types
     self.class.send(:class_variable_get, :@@field_types)
   end
 
   # Dump the object data to the given format. 
-  def dump(format=nil, with_titles=true)
-    format ||= @format
+  def dump(format=nil, with_titles=false)
+    format ||= 's' # as in, to_s
     raise "Format not defined (#{format})" unless SUPPORTED_FORMATS.member?(format)
     send("to_#{format}", with_titles) 
   end
   
+  def to_string(*args)
+    to_s(*args)
+  end
+  
   # Create a new instance of the object using data from file. 
   def self.from_file(file_path, format='yaml')
     raise "Cannot read file (#{file_path})" unless File.exists?(file_path)
@@ -110,10 +112,9 @@ class Storable
 
   # Create a new instance of the object from a hash.
   def self.from_hash(from={})
+    return nil if !from || from.empty?
     me = self.new
-    
-    return me if !from || from.empty?
-    
+        
     fnames = field_names
     fnames.each_with_index do |key,index|
       
@@ -151,6 +152,8 @@ class Storable
       me.send("#{key}=", value) if self.method_defined?("#{key}=")  
     end
     
+    me.postprocess
+    
     me
   end
   # Return the object data as a hash

data/lib/sysinfo.rb

@@ -6,7 +6,7 @@ require 'socket'
 # A container for the system platform information. 
 # Portions of this code is from Amazon's EC2 AMI tools, lib/platform.rb. 
 class SystemInfo < Storable
-  unless defined?(VERSION)
+  unless defined?(IMPLEMENTATIONS)
     VERSION = 2.freeze
     IMPLEMENTATIONS = [