automateit 0.71006 → 0.71012

data/CHANGES.txt

@@ -1,3 +1,15 @@
+0.71012:
+    Date: Fri, 12 Oct 2007 03:54:30 -0700
+    Desc:
+    - (%) Fixed #touch, it worked fine but was corrupting log output
+    - (%) Fixed AccountManager::Linux, it now only runs when the OS detected is Linux.
+    - Added PlatformManager::SunOS.
+    - Added AddressManager::SunOS.
+    - Improved #render, added default :backup option to save files before overwriting them.
+    - Improved #backup, added :quiet option to prevent output.
+    - Improved #chperm, it now displays the exact changes made rather than approximations.
+    - Improved ServiceManager::SysV spec to validate :wait and :pause options with safe mocks.
+
 0.71006:
     Date: Sat, 06 Oct 2007 17:55:37 -0700
     Desc:

data/Rakefile

@@ -97,13 +97,18 @@ task :loclines do
     if path.match(/(\bbin\b|.*\.(env|pl|py|rb|rake|java|sql|ftl|jsp|xml|properties|css|rcss|html|rhtml|erb|po|haml|sass)$)/)
       data = File.read(path)
       bytes += data.size
-      lines += data.scan(/^.+$/).size
+      ### lines += data.scan(/^.*\w.*$/).size # Skip spaces
+      lines += data.scan(/^\s*(?!#)\w.*$/).size # Skip blanks and comments
     end
   end
   puts "Lines: "+lines.commify
   puts "Bytes: "+bytes.commify
 end
 
+task :loccount do
+  sh ""
+end
+
 desc "Display the lines of code changed in the repository"
 task :locdiff do
   if File.directory?(".hg")

data/TODO.txt

@@ -2,6 +2,16 @@ KEY: Important? Urgent? Easy? 1=yes, 0=no
 
 #===[ App ]=============================================================
 
+f=finished
+d=disabled
+
+Solaris 10
+f Create PlatformManager::SunOS
+d Create AccountManager::SunOS and prevent ::Linux from being used because it has the same commands but with different args
+- Create ServiceManager::SMF 
+- Create PackageManager::Blastwave
+- Create PackageManager::SunPkg
+
 100 Shell -- Expand glob patterns, e.g. chown_R(500, 500, "*")
 
 100 Edit -- Display summary of edits, return with :details as [rv, list]
@@ -9,12 +19,10 @@ KEY: Important? Urgent? Easy? 1=yes, 0=no
 100 Interpreter#invoke and HelpfulERB -- Extract error context code into class
 
 000 Shell#chperm -- With symbolic mode, wrap `chmod -v` as temporary workaround?
-000 Changes -- Write parser and new format so I can use "#" symbol
 000 FreeBSD -- Write driver for PackageManager::Ports
 000 Darwin -- Write drivers, e.g. PackageManager for Fink, MacPorts, Pkgsrc
 
 ??? Shell -- Return false or list, never single item?
-??? Shell -- Extract FileManager? change docs
 ??? Driver -- How to determine if a manager or driver method is available? Manager#available?, Manager#available and Driver#suitable? only say if it should be a default.
 
 #===[ Web ]=============================================================

data/lib/automateit/account_manager/linux.rb

@@ -3,8 +3,10 @@
 # A Linux-specific driver for the AccountManager.
 class ::AutomateIt::AccountManager::Linux < ::AutomateIt::AccountManager::Portable
   depends_on \
-    :programs => %w(useradd usermod userdel groupadd groupmod groupdel),
-    :callbacks => [lambda{AutomateIt::AccountManager::Portable.has_etc?}]
+    :programs => %w(uname useradd usermod userdel groupadd groupmod groupdel),
+    :callbacks => [lambda{
+      `uname -s`.match(/linux/i) && AutomateIt::AccountManager::Portable.has_etc?
+    }]
 
   def suitability(method, *args) # :nodoc:
     # Level must be higher than Portable

data/lib/automateit/address_manager.rb

@@ -76,90 +76,10 @@ class AutomateIt::AddressManager < AutomateIt::Plugin::Manager
   #   hostnames_for("kagami")
   #   => ["kagami"]
   def hostnames_for(hostname) dispatch(hostname) end
-
-  # Convert a mask to a CIDR.
-  #
-  # Example:
-  #  mask_to_cidr("255.255.255.0") # => 24
-  def mask_to_cidr(mask) dispatch(mask) end
-
-  # Convert CIDR to mask.
-  #
-  # Example:
-  #  cidr_to_mask(24) # => "255.255.255.0"
-  def cidr_to_mask(cidr) dispatch(cidr) end
-
-  # Convert a decimal number to binary notation.
-  #
-  # Example:
-  #  dec2bin(255) # => "11111111"
-  def dec2bin(n) dispatch(n) end
-
-  # Convert a binary number to decimal.
-  #
-  # Example:
-  #  bin2dec("11111111") # => 255
-  def bin2dec(s) dispatch(s) end
-end
-
-# == AddressManager::BaseDriver
-#
-# Base class for all AddressManager drivers.
-class AutomateIt::AddressManager::BaseDriver< AutomateIt::Plugin::Driver
-  # See AddressManager#hostnames
-  def hostnames()
-    # NOTE: depends on driver's implementation of addresses
-    names = 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#mask_to_cidr
-  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
-
-  # See AddressManager#cidr_to_mask
-  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
-
-  # See AddressManager#dec2bin
-  def dec2bin(n)
-    # dec2bin(255)
-    return "%b" % n
-  end
-
-  # See AddressManager#bin2dec
-  def bin2dec(s)
-    return s.to_i(2)
-  end
 end
 
 # Drivers
+require 'automateit/address_manager/base'
 require 'automateit/address_manager/portable'
 require 'automateit/address_manager/linux'
+require 'automateit/address_manager/sunos'

data/lib/automateit/address_manager/base.rb

@@ -0,0 +1,148 @@
+# == 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 = 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 &= interfaces.include?(opts[:device]) if opts[:device] and not opts[:label]
+    result &= interfaces.include?(opts[:device]+":"+opts[:label]) if opts[:device] and opts[:label]
+    result &= 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 has?(opts)
+    block.call(opts)
+    return true
+  end
+
+  # Helper for #remove method.
+  def _remove_helper(opts, &block)
+    return false unless 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
+
+  def _ifconfig_helper(action, opts)
+    _raise_unless_available
+    action = :del if action.to_sym == :remove
+
+    _normalize_opts(opts)
+
+    ### 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
+
+    ipcmd = "ifconfig"
+    ipcmd << " " << _interface_and_label(opts)
+    ipcmd << " %s" % opts[:address]
+    ipcmd << " netmask %s" % opts[:mask] if opts[:mask]
+    ipcmd << " up" if action == :add
+    ipcmd << " down" if action == :del
+    return ipcmd
+  end
+end

data/lib/automateit/address_manager/linux.rb

@@ -4,67 +4,29 @@
 # querying, adding and removing addresses on platforms that feature Linux-like
 # tools.
 class AutomateIt::AddressManager::Linux < AutomateIt::AddressManager::BaseDriver
-  depends_on :programs => "ifconfig", 
+  depends_on :programs => "ifconfig",
     :callbacks => lambda{`ifconfig --version 2>&1`.match(/net-tools/)}
 
   def suitability(method, *args) # :nodoc:
     available? ? 2 : 0
   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 &= interfaces.include?(opts[:device]) if opts[:device] and not opts[:label]
-    result &= interfaces.include?(opts[:device]+":"+opts[:label]) if opts[:device] and opts[:label]
-    result &= addresses.include?(opts[:address]) if opts[:address]
-    return result
-  end
-
   # See AddressManager#add
   def add(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 has?(opts)
-    interpreter.sh(_add_or_remove_command(:add, opts))
-    if interpreter.which("arping")
-      interpreter.sh("arping -q -c #{announcements} -w #{announcements} -I #{opts[:device]} #{opts[:address]}")
+    _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
-    return true
   end
 
   # See AddressManager#remove
   def remove(opts)
-    return false unless 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 interpreter.sh(_add_or_remove_command(:remove, opts))
-  end
-
-  def _add_or_remove_command(action, opts)
-    _raise_unless_available
-    action = :del if action.to_sym == :remove
-
-    # 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])
+    _remove_helper(opts) do |opts|
+      interpreter.sh(_ifconfig_helper(:remove, opts))
     end
-
-    ipcmd = "ifconfig"
-    ipcmd << " %s" % opts[:device] if opts[:device] and not opts[:label]
-    ipcmd << " %s:%s" % [opts[:device], opts[:label]] if opts[:device] and opts[:label]
-    ipcmd << " %s" % opts[:address]
-    ipcmd << " netmask %s" % opts[:mask] if opts[:mask]
-    ipcmd << " up" if action == :add
-    ipcmd << " down" if action == :del
-    return ipcmd
   end
-  private :_add_or_remove_command
 
   # See AddressManager#interfaces
   def interfaces()

data/lib/automateit/address_manager/sunos.rb

@@ -0,0 +1,46 @@
+# == 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`.match(/sunos/i)}
+
+  def suitability(method, *args) # :nodoc:
+    available? ? 2 : 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
+
+  # See AddressManager#interfaces
+  def interfaces()
+    _raise_unless_available
+    return `ifconfig -a`.scan(/^([^ ]+):\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/interpreter.rb

@@ -633,6 +633,10 @@ module AutomateIt
     # * nil -- Returns boolean of whether nitpick messages will be displayed.
     # * Boolean -- Sets nitpick state.
     # * String or Symbol -- Displays nitpick message if state is on.
+    #
+    # Example:
+    #   nitpick true
+    #   nitpick "I'm nitpicking"
     def nitpick(value=nil)
       case value
       when NilClass: @nitpick