automate-it 0.9.0

data/lib/automateit/address_manager/base.rb

@@ -0,0 +1,171 @@
+# == AddressManager::BaseDriver
+#
+# Base class for all AddressManager drivers.
+class AutomateIt::AddressManager::BaseDriver< AutomateIt::Plugin::Driver
+  public
+
+  # See AddressManager#hostnames
+  def hostnames()
+    # NOTE: depends on driver's implementation of addresses
+    names = manager.addresses.inject(Set.new) do |sum, address|
+      # Some addresses can't be resolved, bummer.
+      sum.merge(Resolv.getnames(address)) rescue Resolv::ResolvError; sum
+    end
+    names << Socket.gethostname
+    names.merge(Socket.gethostbyname(Socket.gethostname)[1]) rescue SocketError
+
+    names.each{|name| names.merge(hostnames_for(name))}
+    names << "localhost"
+    return names.to_a.sort
+  end
+
+  # See AddressManager#hostname_for
+  def hostnames_for(hostname)
+    results = []
+    elements = hostname.split(".")
+    for i in 1..elements.size
+      results << elements[0..i-1].join(".")
+    end
+    return results.to_a.sort
+  end
+
+  # See AddressManager#has?
+  def has?(opts)
+    raise ArgumentError.new(":device or :address must be specified") unless opts[:device] or opts[:address]
+    result = true
+    result &= manager.interfaces.include?(opts[:device]) if opts[:device] and not opts[:label]
+    result &= manager.interfaces.include?(opts[:device]+":"+opts[:label]) if opts[:device] and opts[:label]
+    result &= manager.addresses.include?(opts[:address]) if opts[:address]
+    return result
+  end
+
+  #-----------------------------------------------------------------------
+
+  protected
+
+  # Convert a mask to a CIDR.
+  #
+  # Example:
+  #  mask_to_cidr("255.255.255.0") # => 24
+  def mask_to_cidr(mask)
+    # TODO Find less horrible solution which can handle IPv6.
+    result = ''
+    for chunk in mask.split(".")
+      result += dec2bin(chunk.to_i)
+    end
+    return result.scan(/1/).size
+  end
+
+  # Convert CIDR to mask.
+  #
+  # Example:
+  #  cidr_to_mask(24) # => "255.255.255.0"
+  def cidr_to_mask(cidr)
+    # TODO Find less horrible solution which can handle IPv6.
+    require 'ipaddr'
+    IPAddr.new("0.0.0.0/#{cidr}").inspect.match(%r{/([\d\.]+)>})[1]
+  end
+
+  # Convert a decimal number to binary notation.
+  #
+  # Example:
+  #  dec2bin(255) # => "11111111"
+  def dec2bin(n)
+    # dec2bin(255)
+    return "%b" % n
+  end
+
+  # Convert a binary number to decimal.
+  #
+  # Example:
+  #  bin2dec("11111111") # => 255
+  def bin2dec(s)
+    return s.to_i(2)
+  end
+
+  # Helper for #add method.
+  def _add_helper(opts, &block)
+    opts[:announcements] = opts[:announcements].to_i || AutomateIt::AddressManager::DEFAULT_ANNOUNCEMENTS
+    raise SecurityError.new("you must be root") unless superuser?
+    raise ArgumentError.new(":device and :address must be specified") unless opts[:device] and opts[:address]
+    return false if manager.has?(opts)
+    block.call(opts)
+    return true
+  end
+
+  # Helper for #remove method.
+  def _remove_helper(opts, &block)
+    return false unless manager.has?(opts)
+    raise SecurityError.new("you must be root") unless superuser?
+    raise ArgumentError.new(":device and :address must be specified") unless opts[:device] and opts[:address]
+    return block.call(opts)
+  end
+
+  # Alter +opts+ hash to add alternative names for various options.
+  def _normalize_opts(opts)
+    # Accept common alternative names
+    opts[:mask] ||= opts[:netmask] if opts[:netmask]
+    opts[:alias] ||= opts[:alias] if opts[:alias]
+    opts[:device] ||= opts[:interface] if opts[:interface]
+
+    if opts[:mask] and not opts[:mask].match(/\./)
+      opts[:mask] = cidr_to_mask(opts[:mask])
+    end
+
+    return opts
+  end
+
+  # Return the interface and label specified in +opts+ hash, e.g., "eth0:1".
+  def _interface_and_label(opts)
+    return(
+      if opts[:device] and not opts[:label]
+        opts[:device]
+      elsif opts[:device] and opts[:label]
+        "%s:%s" % [opts[:device], opts[:label]]
+      else
+        raise ArgumentError.new("Can't derive interface and label for: #{opts.inspect}")
+      end
+    )
+  end
+
+  # Returns a string used to construct an ifconfig command, e.g.
+  #   ifconfig hme0 192.9.2.106 netmask 255.255.255.0 up
+  #   ifconfig hme0:1 172.40.30.4 netmask 255.255.0.0 up
+  #
+  # Options:
+  # * :device -- Interface, e.g., "eth0". String.
+  # * :label -- Alias label, e.g., "1". String.
+  # * :address -- IP address, e.g., "127.0.0.1". String.
+  # * :mask -- Netmask, e.g., "255.255.255.0" or 24. String or Fixnum.
+  #
+  # Helper options:
+  # * :append -- Array of strings to append to end of command, e.g., ["-alias"].
+  # * :prepend -- Array of strings to prepend to string, adding them after after "ifconfig", e.g., ["inet"].
+  # * :state -- Whether to list "up" and "down" in command. Defaults to true.
+  def _ifconfig_helper(action, opts, helper_opts={})
+    _raise_unless_available
+
+    # Translate common names
+    action = :del if action.to_sym == :remove
+
+    # Defaults
+    _normalize_opts(opts)
+    helper_opts[:state] = true unless helper_opts[:state] == false
+
+    ipcmd = "ifconfig"
+    ipcmd << " " << _interface_and_label(opts)
+    if helper_opts[:prepend]
+      ipcmd << " " << [helper_opts[:prepend]].flatten.join(" ")
+    end
+    ipcmd << " %s" % opts[:address]
+    ipcmd << " netmask %s" % opts[:mask] if opts[:mask]
+    if helper_opts[:state]
+      ipcmd << " up" if action == :add
+      ipcmd << " down" if action == :del
+    end
+    if helper_opts[:append]
+      ipcmd << " " << [helper_opts[:append]].flatten.join(" ")
+    end
+    return ipcmd
+  end
+end

data/lib/automateit/address_manager/bsd.rb

@@ -0,0 +1,28 @@
+# == AddressManager::BSD
+#
+# An AddressManager driver for operating systems using a BSD-like ifconfig.
+# Driver provides querying addresses and interfaces.
+class AutomateIt::AddressManager::BSD < AutomateIt::AddressManager::BaseDriver
+  def self.token
+    :bsd
+  end
+
+  depends_on :programs => %w(ifconfig uname),
+    :callbacks => lambda{`uname -s 2>&1`.match(/openbsd|freebsd|sunos/i)}
+
+  def suitability(method, *args) # :nodoc:
+    available? ? 2 : 0
+  end
+
+  # See AddressManager#interfaces
+  def interfaces()
+    _raise_unless_available
+    return `ifconfig -a`.scan(/^([^\s]+):\s+/s).flatten
+  end
+
+  # See AddressManager#addresses
+  def addresses()
+    _raise_unless_available
+    return `ifconfig -a`.scan(/\s+inet\s+([^\s]+)\s+/).flatten
+  end
+end

data/lib/automateit/address_manager/freebsd.rb

@@ -0,0 +1,59 @@
+# == AddressManager::FreeBSD
+#
+# A FreeBSD-specific driver for the AddressManager provides complete support for
+# querying, adding and removing addresses.
+class AutomateIt::AddressManager::FreeBSD < AutomateIt::AddressManager::BaseDriver
+  def self.token
+    :freebsd
+  end
+
+  depends_on :programs => %w(ifconfig uname),
+    :callbacks => lambda{`uname -s 2>&1`.match(/freebsd/i)}
+
+  def suitability(method, *args) # :nodoc:
+    # Must be higher than AddressManager::BSD
+    available? ? 3 : 0
+  end
+
+  # See AddressManager#add
+  def add(opts)
+    _add_helper(opts) do |opts|
+      interpreter.sh(_freebsd_ifconfig_helper(:add, opts))
+    end
+  end
+
+  # See AddressManager#remove
+  def remove(opts)
+    _remove_helper(opts) do |opts|
+      interpreter.sh(_freebsd_ifconfig_helper(:remove, opts))
+      true
+    end
+  end
+  
+  # See AddressManager#has?
+  def has?(opts)
+    opts2 = opts.clone
+    is_alias = opts2.delete(:label)
+    return super(opts2)
+  end
+  
+protected
+
+  # ifconfig fxp0 inet 172.16.1.3 netmask 255.255.255.255 alias
+  def _freebsd_ifconfig_helper(action, opts)    
+    helper_opts = {:state => false, :prepend => %w(inet)}
+    opts2 = opts.clone
+    if opts2.delete(:label)
+      helper_opts[:append] = \
+        case action
+        when :add
+          %w(alias)
+        when :remove, :del
+          %w(-alias)
+        else 
+          ArgumentError.new("Unknown action: #{action}")
+        end
+    end
+    return _ifconfig_helper(action, opts2, helper_opts)
+  end
+end

data/lib/automateit/address_manager/linux.rb

@@ -0,0 +1,42 @@
+# == AddressManager::Linux
+#
+# A Linux-specific driver for the AddressManager provides complete support for
+# querying, adding and removing addresses on platforms that feature Linux-like
+# tools.
+class AutomateIt::AddressManager::Linux < AutomateIt::AddressManager::BaseDriver
+  depends_on :programs => "ifconfig",
+    :callbacks => lambda{`ifconfig --version 2>&1`.match(/net-tools/)}
+
+  def suitability(method, *args) # :nodoc:
+    available? ? 2 : 0
+  end
+
+  # See AddressManager#add
+  def add(opts)
+    _add_helper(opts) do |opts|
+      interpreter.sh(_ifconfig_helper(:add, opts))
+      if interpreter.which("arping")
+        interpreter.sh("arping -q -c #{opts[:announcements]} -w #{opts[:announcements]} -I #{opts[:device]} #{opts[:address]}")
+      end
+    end
+  end
+
+  # See AddressManager#remove
+  def remove(opts)
+    _remove_helper(opts) do |opts|
+      interpreter.sh(_ifconfig_helper(:remove, opts))
+    end
+  end
+
+  # See AddressManager#interfaces
+  def interfaces()
+    _raise_unless_available
+    return `ifconfig`.scan(/^(\w+?(?::\w+)?)\b\s+Link/).flatten
+  end
+
+  # See AddressManager#addresses
+  def addresses()
+    _raise_unless_available
+    return `ifconfig`.scan(/inet6? addr:\s*(.+?)\s+/).flatten
+  end
+end

data/lib/automateit/address_manager/openbsd.rb

@@ -0,0 +1,66 @@
+# == AddressManager::OpenBSD
+#
+# A OpenBSD-specific driver for the AddressManager provides complete support for
+# querying, adding and removing addresses.
+class AutomateIt::AddressManager::OpenBSD < AutomateIt::AddressManager::BaseDriver
+  def self.token
+    :openbsd
+  end
+
+  depends_on :programs => %w(ifconfig uname),
+    :callbacks => lambda{`uname -s 2>&1`.match(/openbsd/i)}
+
+  def suitability(method, *args) # :nodoc:
+    # Must be higher than AddressManager::BSD
+    available? ? 3 : 0
+  end
+
+  # See AddressManager#add
+  def add(opts)
+    _add_helper(opts) do |opts|
+      interpreter.sh(_openbsd_ifconfig_helper(:add, opts))
+    end
+  end
+
+  # See AddressManager#remove
+  def remove(opts)
+    _remove_helper(opts) do |opts|
+      interpreter.sh(_openbsd_ifconfig_helper(:remove, opts))
+      true
+    end
+  end
+  
+  # See AddressManager#addresses
+  def addresses()
+    _raise_unless_available
+    # OpenBSD requires an "-A" to display aliases, not the usual "-a"
+    return `ifconfig -A`.scan(/\s+inet\s+([^\s]+)\s+/).flatten
+  end
+  
+  # See AddressManager#has?
+  def has?(opts)
+    opts2 = opts.clone
+    is_alias = opts2.delete(:label)
+    return super(opts2)
+  end
+  
+protected
+
+  # ifconfig dc0 inet alias 192.168.0.3 netmask 255.255.255.255
+  def _openbsd_ifconfig_helper(action, opts)
+    helper_opts = {:state => false, :prepend => %w(inet)}
+    opts2 = opts.clone
+    if opts2.delete(:label)
+      helper_opts[:prepend] << \
+        case action
+        when :add
+          "alias"
+        when :remove, :del
+          "delete"
+        else 
+          ArgumentError.new("Unknown action: #{action}")
+        end
+    end
+    return _ifconfig_helper(action, opts2, helper_opts)
+  end
+end

data/lib/automateit/address_manager/portable.rb

@@ -0,0 +1,37 @@
+# == AddressManager::Portable
+#
+# A pure-Ruby, portable driver for the AddressManager which provides
+# minimal support for querying the hostname using sockets. Although it
+# lacks advanced features found in other drivers, it will work on all
+# platforms.
+class AutomateIt::AddressManager::Portable < AutomateIt::AddressManager::BaseDriver
+  def suitability(method, *args) # :nodoc:
+    return 1
+  end
+
+  # See AddressManager#has?
+  def has?(opts)
+    raise NotImplementedError.new("this driver doesn't support queries for devices or labels") if opts[:device] or opts[:label]
+    result = true
+    result &= addresses.include?(opts[:address]) if opts[:address]
+    return result
+  end
+
+  # See AddressManager#hostnames
+  def hostnames
+    results = Set.new
+    results << Socket.gethostname
+    results.merge(Socket.gethostbyname(Socket.gethostname)[1]) rescue SocketError
+
+    results.each{|name| results.merge(hostnames_for(name))}
+    results << "localhost"
+    return results.to_a.sort
+  end
+
+  # See AddressManager#addresses
+  def addresses
+    results = Set.new("127.0.0.1")
+    results.merge(TCPSocket.gethostbyname(Socket.gethostname)[3]) rescue SocketError
+    return results.flatten
+  end
+end

data/lib/automateit/address_manager/sunos.rb

@@ -0,0 +1,34 @@
+# == AddressManager::SunOS
+#
+# A SunOS-specific driver for the AddressManager provides complete support for
+# querying, adding and removing addresses.
+class AutomateIt::AddressManager::SunOS < AutomateIt::AddressManager::BaseDriver
+  def self.token
+    :sunos
+  end
+
+  depends_on :programs => %w(ifconfig uname),
+    :callbacks => lambda{`uname -s 2>&1`.match(/sunos/i)}
+
+  def suitability(method, *args) # :nodoc:
+    # Must be higher than AddressManager::BSD 
+    available? ? 3 : 0
+  end
+
+  # See AddressManager#add
+  def add(opts)
+    _add_helper(opts) do |opts|
+      interpreter.sh("ifconfig %s plumb" % _interface_and_label(opts))
+      interpreter.sh(_ifconfig_helper(:add, opts))
+    end
+  end
+
+  # See AddressManager#remove
+  def remove(opts)
+    _remove_helper(opts) do |opts|
+      interpreter.sh(_ifconfig_helper(:remove, opts))
+      interpreter.sh("ifconfig %s unplumb" % _interface_and_label(opts))
+      true
+    end
+  end
+end

data/lib/automateit/cli.rb

@@ -0,0 +1,85 @@
+module AutomateIt
+  # == CLI
+  #
+  # The CLI class provides AutomateIt's command-line interface. It's
+  # responsible for invoking recipes from the command line, starting the
+  # interactive shell and creating projects. It's run from
+  # <tt>bin/automate</tt>.
+  class CLI < Common
+    # Create a new CLI interpreter. If no :recipe or :eval option is provided,
+    # it starts an interactive IRB session for the Interpreter.
+    # 
+    # Examples:
+    #   AutomateIt::CLI.run("myrecipe.rb")
+    #   AutomateIt::CLI.run(:recipe => "myrecipe.rb")
+    #   AutomateIt::CLI.run(:eval => "42")
+    #
+    # Options:
+    # * :tags -- Array of tags to add for this run.
+    # * :project -- Project directory to load.
+    # * :recipe -- Recipe file to execute.
+    # * :eval -- Evaluate this string.
+    # * :quiet -- Don't print shell header.
+    def self.run(*a)
+      args, opts = args_and_opts(*a)
+      recipe = args.first || opts[:recipe]
+      if recipe and not opts[:project]
+        opts[:project] = File.join(File.dirname(recipe), "..")
+        opts[:guessed_project] = true
+      end
+
+      opts[:verbosity] ||= Logger::INFO
+
+      if opts[:create]
+        Project::create(opts)
+      elsif code = opts.delete(:eval)
+        interpreter = AutomateIt.new(opts)
+        interpreter.instance_eval(code)
+      elsif recipe
+        AutomateIt.invoke(recipe, opts)
+      else
+        # Welcome messages
+        display = lambda{|msg| puts msg if opts[:verbosity] <= Logger::INFO}
+        display.call PNOTE+"AutomateIt Shell v#{AutomateIt::VERSION} #{$0}"
+
+        # Create and connect instances
+        require "irb"
+        IRB.setup(__FILE__)
+        # XXX irb: warn: can't alias context from irb_context.
+        irb = IRB::Irb.new
+        opts[:irb] = irb
+        IRB.conf[:MAIN_CONTEXT] = irb.context
+        interpreter = AutomateIt.new(opts)
+        irb.context.workspace.instance_variable_set(:@binding, interpreter.send(:binding))
+
+        # Tab completion
+        message = "<CTRL-D> to quit"
+        begin
+          require 'irb/completion'
+          irb.context.auto_indent_mode = true
+          irb.context.load_modules << 'irb/completion' unless irb.context.load_modules.include?('irb/completion')
+          irb.context.instance_eval{ @use_readline = true }
+          message << ", <Tab> to auto-complete"
+        rescue LoadError
+          # Ignore
+        end
+        display.call PNOTE+message
+
+        # Set prompt
+        unless opts[:custom_prompt] == false
+          irb.context.prompt_i = "ai> "
+          irb.context.prompt_s = "ai%l "
+          irb.context.prompt_c = "ai* "
+          begin
+            irb.context.prompt_n = "ai%i " 
+          rescue NoMethodError
+            # Not available on Ruby 1.8.2 bundled with Mac OS X 10.4 Tiger
+          end
+        end
+
+        # Run loop to read user input
+        irb.eval_input
+      end
+    end
+  end
+end