automate-it 0.9.0

data/lib/automateit/package_manager/yum.rb

@@ -0,0 +1,65 @@
+# == PackageManager::YUM
+#
+# The YUM driver for the PackageManager provides a way to manage software
+# packages on Red Hat-style systems using +yum+ and +rpm+.
+class AutomateIt::PackageManager::YUM < AutomateIt::PackageManager::BaseDriver
+  depends_on :programs => %w(yum rpm)
+
+  def suitability(method, *args) # :nodoc:
+    return available? ? 1 : 0
+  end
+
+  # See AutomateIt::PackageManager#installed?
+  def installed?(*packages)
+    return _installed_helper?(*packages) do |list, opts|
+      ### rpm -q --nosignature --nodigest --qf "%{NAME} # %{VERSION} # %{RELEASE}\n" httpd nomarch foo
+      cmd = 'rpm -q --nosignature --nodigest --qf "%{NAME} # %{VERSION} # %{RELEASE}\n"'
+      list.each{|package| cmd << " "+package}
+      cmd << " 2>&1" # missing packages are listed on STDERR
+
+      log.debug(PEXEC+cmd)
+      data = `#{cmd}`
+      matches = data.scan(/^(.+) # (.+) # .+$/)
+      available = matches.inject([]) do |sum, match|
+        package, status = match
+        sum << package
+        sum
+      end
+      available
+    end
+  end
+
+  # See AutomateIt::PackageManager#not_installed?
+  def not_installed?(*packages)
+    _not_installed_helper?(*packages)
+  end
+
+  # See AutomateIt::PackageManager#install
+  def install(*packages)
+    return _install_helper(*packages) do |list, opts|
+      # yum options:
+      # -y : yes to queries
+      # -d 0 : no debugging info
+      # -e 0 : show only fatal errors
+      # -C : don't download headers
+      cmd = "yum -y -d 0 -e 0"
+      cmd << " -C" if opts[:cache] == true
+      cmd << " install "+list.join(" ")+" < /dev/null"
+      cmd << " > /dev/null" if opts[:quiet]
+      cmd << " 2>&1"
+
+      interpreter.sh(cmd)
+    end
+  end
+
+  # See AutomateIt::PackageManager#uninstall
+  def uninstall(*packages)
+    return _uninstall_helper(*packages) do |list, opts|
+      cmd = "rpm --erase --quiet "+list.join(" ")+" < /dev/null"
+      cmd << " > /dev/null" if opts[:quiet]
+      cmd << " 2>&1"
+
+      interpreter.sh(cmd)
+    end
+  end
+end

data/lib/automateit/platform_manager.rb

@@ -0,0 +1,49 @@
+# == PlatformManager
+#
+# The PlatformManager provides a way to query platform identifiers, such as
+# the operating system distribution's version.
+class AutomateIt::PlatformManager < AutomateIt::Plugin::Manager
+  # Query the +search+ field. The +search+ can either be a key or a set of
+  # keys separated by "#" signs.
+  #
+  # Examples:
+  #   query(:os) # => "linux"
+  #   query("arch") # => "i686"
+  #   query("os#arch") # => "linux_i686"
+  #   query("os#arch#distro#release") # => "linux_i686_ubuntu_6.06"
+  #
+  # Fields that may be provided by drivers:
+  # * :arch -- Hardware architecture, e.g., "i686"
+  # * :os -- Operating system, e.g., "linux"
+  # * :distro -- Operating system distribution, e.g., "ubuntu"
+  # * :release -- Operating system distribution release, e.g., "6.06"
+  def query(search) dispatch(search) end
+
+  # Is this a single-vendor operating system? E.g., Windows is, while Linux
+  # isn't. This method helps the TagManager determine how to name tags. A
+  # single-vendor product uses the "os#release" format (e.g., "windows_xp"),
+  # while a multi-vendor product uses a "distro#release" format
+  # ("ubuntu_6.06").
+  def single_vendor?() dispatch() end
+
+  # Return an array of tags for this platform.
+  def tags() dispatch() end
+end
+
+# == PlatformManager::BaseDriver
+#
+# Base class for all PlatformManager drivers.
+class AutomateIt::PlatformManager::BaseDriver < AutomateIt::Plugin::Driver
+end
+
+# Drivers
+require 'automateit/platform_manager/struct'
+require 'automateit/platform_manager/uname'
+require 'automateit/platform_manager/lsb'
+require 'automateit/platform_manager/debian'
+require 'automateit/platform_manager/gentoo'
+require 'automateit/platform_manager/darwin'
+require 'automateit/platform_manager/windows'
+require 'automateit/platform_manager/freebsd'
+require 'automateit/platform_manager/sunos'
+require 'automateit/platform_manager/openbsd'

data/lib/automateit/platform_manager/darwin.rb

@@ -0,0 +1,30 @@
+# == PlatformManager::Darwin
+#
+# A PlatformManager driver for Apple's Darwin.
+class AutomateIt::PlatformManager::Darwin < AutomateIt::PlatformManager::Struct
+  depends_on :files => ["/usr/sbin/scutil"], :programs => ["which", "uname"]
+
+  def suitability(method, *args) # :nodoc:
+    # Must be higher than PlatformManager::Uname
+    return available? ? 3 : 0
+  end
+
+  def _prepare
+    return if @struct[:release]
+    @struct[:os] = "darwin"
+    @struct[:arch] = `uname -p`.strip.downcase
+    @struct[:distro] = "apple"
+    @struct[:release] = `uname -r`.strip.downcase
+    @struct
+  end
+  private :_prepare
+
+  def query(search)
+    _prepare
+    super(search)
+  end
+
+  def single_vendor?
+    return true
+  end
+end

data/lib/automateit/platform_manager/debian.rb

@@ -0,0 +1,26 @@
+# == PlatformManager::Debian
+#
+# A PlatformManager driver for Debian Linux.
+class AutomateIt::PlatformManager::Debian < AutomateIt::PlatformManager::Uname
+  VERSION_FILE = "/etc/debian_version"
+
+  depends_on :files => [VERSION_FILE]
+
+  def suitability(method, *args) # :nodoc:
+    # Must be higher than PlatformManager::Struct
+    return available? ? 3 : 0
+  end
+
+  def _prepare
+    return if @struct[:distro]
+    @struct[:distro] = "debian"
+    @struct[:release] = File.read(VERSION_FILE).strip
+    @struct
+  end
+  private :_prepare
+
+  def query(search)
+    _prepare
+    super(search)
+  end
+end

data/lib/automateit/platform_manager/freebsd.rb

@@ -0,0 +1,29 @@
+# == PlatformManager::FreeBSD
+#
+# A PlatformManager driver for FreeBSD.
+class AutomateIt::PlatformManager::FreeBSD < AutomateIt::PlatformManager::Uname
+  def self.token
+    :freebsd
+  end
+
+  depends_on :files => %w(/etc/portsnap.conf /etc/rc.conf)
+
+  def suitability(method, *args) # :nodoc:
+    # Must be higher than PlatformManager::Struct
+    return available? ? 3 : 0
+  end
+
+  def _prepare
+    return if @struct[:distro]
+    @struct[:distro] = "freebsd"
+    @struct[:release] = `uname -r`.strip.match(/^([\d\.]+)-/)[1]
+    @struct
+  end
+  private :_prepare
+
+  def query(search)
+    _prepare
+    super(search)
+  end
+end
+

data/lib/automateit/platform_manager/gentoo.rb

@@ -0,0 +1,26 @@
+# == PlatformManager::Gentoo
+#
+# A PlatformManager driver for Gentoo Linux.
+class AutomateIt::PlatformManager::Gentoo < AutomateIt::PlatformManager::Uname
+  GENTOO_RELEASE = "/etc/gentoo-release"
+
+  depends_on :files => [GENTOO_RELEASE]
+
+  def suitability(method, *args) # :nodoc:
+    # Must be higher than PlatformManager::Struct
+    return available? ? 3 : 0
+  end
+
+  def _prepare
+    return if @struct[:distro]
+    @struct[:distro] = "gentoo"
+    @struct[:release] = File.read(GENTOO_RELEASE).strip.match(/\s([\d\.]+)$/)[1]
+    @struct
+  end
+  private :_prepare
+
+  def query(search)
+    _prepare
+    super(search)
+  end
+end

data/lib/automateit/platform_manager/lsb.rb

@@ -0,0 +1,44 @@
+# == PlatformManager::LSB
+#
+# A PlatformManager driver for LSB (Linux Standards Base) systems. The
+# platform doesn't actually need to be Linux, but simply has to provide an
+# <tt>lsb_release</tt> command.
+class AutomateIt::PlatformManager::LSB < AutomateIt::PlatformManager::Uname
+  LSB_RELEASE = "lsb_release"
+
+  depends_on :programs => [LSB_RELEASE]
+
+  def suitability(method, *args) # :nodoc:
+    # Level must be greater than Uname and Debian
+    return available? ? 4 : 0
+  end
+
+  def setup(opts={}) # :nodoc:
+    super(opts) # Rely on Uname to set :os and :arch
+    @struct[:distro]  ||= @@struct_cache[:distro]
+    @struct[:release] ||= @@struct_cache[:release]
+    if available?
+      unless @struct[:distro] and @struct[:release]
+        hash = _parse_lsb_release_data(_read_lsb_release_data)
+        @struct[:distro]  ||= @@struct_cache[:distro]  ||= hash["Distributor ID"].to_s.downcase
+        @struct[:release] ||= @@struct_cache[:release] ||= hash["Release"].to_s.downcase
+      end
+    end
+  end
+
+protected
+
+  # Returns the LSB data for this platform's Distributor and ID
+  def _read_lsb_release_data
+    # TODO Consider parsing files directly to avoid the overhead of this command.
+    #
+    # Do NOT use 'lsb_release -a' because this takes a few seconds. Telling
+    # 'lsb_release' which fields we want makes it much faster.
+    `"#{LSB_RELEASE}" --release --id`
+  end
+
+  # Parses LSB data into a hash.
+  def _parse_lsb_release_data(data)
+    data.scan(/^([^:]+):\s+([^\n]+)/).inject({}){|s,v| s[v.first] = v.last; s}
+  end
+end

data/lib/automateit/platform_manager/openbsd.rb

@@ -0,0 +1,28 @@
+# == PlatformManager::OpenBSD
+#
+# A PlatformManager driver for OpenBSD.
+class AutomateIt::PlatformManager::OpenBSD < AutomateIt::PlatformManager::Uname
+  def self.token
+    :openbsd
+  end
+
+  depends_on :files => %w(/obsd /bsd /bsd.rd), :directories => %w(/altroot /stand)
+
+  def suitability(method, *args) # :nodoc:
+    # Must be higher than PlatformManager::Struct
+    return available? ? 3 : 0
+  end
+
+  def _prepare
+    return if @struct[:distro]
+    @struct[:distro] = `uname -s`.strip.downcase
+    @struct[:release] = `uname -r`.strip.downcase
+    @struct
+  end
+  private :_prepare
+
+  def query(search)
+    _prepare
+    super(search)
+  end
+end

data/lib/automateit/platform_manager/struct.rb

@@ -0,0 +1,80 @@
+# == PlatformManager::Struct
+#
+# A simple PlatformManager driver that queries a hash for results. Although
+# not useful on its own, it's inherited by other drivers that provide
+# platform-specific methods to query the system.
+class AutomateIt::PlatformManager::Struct < AutomateIt::PlatformManager::BaseDriver
+  depends_on :nothing
+
+  # Hash mapping of keys that have many common names, e.g., "release" and "version"
+  attr_accessor :key_aliases
+
+  def suitability(method, *args) # :nodoc:
+    return 1
+  end
+
+  # Options:
+  # * :struct -- The hash to use for queries.
+  def setup(opts={})
+    super(opts)
+
+    @@struct_cache ||= {}
+
+    if opts[:struct]
+      @struct = opts[:struct]
+    else
+      @struct ||= {}
+    end
+
+    # Generate bi-directional map
+    @key_aliases ||= @@key_aliases ||= {
+      :version => :release,
+    }.inject({}){|s,v| s[v[0]] = v[1]; s[v[1]] = v[0]; s}
+  end
+
+  # See PlatformManager#query
+  def query(search)
+    result = ""
+    for key in search.to_s.split(/#/)
+      result << "_" unless result.empty?
+      result << _query_key(key)
+    end
+    result
+  end
+
+  def _query_key(key)
+    key = key.to_sym
+    unless @struct.has_key?(key)
+      key_alias = key_aliases[key]
+      if @struct.has_key?(key_alias)
+        key = key_alias
+      else
+        raise IndexError.new("platform doesn't provide key: #{key}")
+      end
+    end
+    return @struct[key]
+  end
+  private :_query_key
+
+  # See PlatformManager#single_vendor?
+  def single_vendor?
+    return false
+  end
+
+  # See PlatformManager#tags
+  def tags
+    results = []
+    for key in %w(os arch distro os#arch)
+      results << query(key) rescue IndexError
+    end
+
+    release_query = \
+      if single_vendor?
+        "os#release"     # E.g. windows_xp
+      else
+        "distro#release" # E.g. ubuntu_6.06
+      end
+    results << query(release_query) rescue IndexError
+    return results
+  end
+end

data/lib/automateit/platform_manager/sunos.rb

@@ -0,0 +1,39 @@
+# == PlatformManager::SunOS
+#
+# A PlatformManager driver for SunOS.
+class AutomateIt::PlatformManager::SunOS < AutomateIt::PlatformManager::Uname
+  def self.token
+    :sunos
+  end
+
+  depends_on \
+    :programs => %w(uname),
+    :callbacks => [lambda {
+      begin
+        not `uname -s`.match(/SunOS/i).nil?
+      rescue
+        false
+      end
+    }]
+
+  def suitability(method, *args) # :nodoc:
+    # Must be higher than PlatformManager::Struct and Uname
+    return available? ? 3 : 0
+  end
+
+  def _prepare
+    return if @struct[:release]
+    @struct[:distro] = "sun"
+    @struct[:release] = `uname -r`.strip.downcase
+    @struct
+  end
+
+  def query(search)
+    _prepare
+    super(search)
+  end
+
+  def single_vendor?
+    return true
+  end
+end

data/lib/automateit/platform_manager/uname.rb

@@ -0,0 +1,29 @@
+# == PlatformManager::Uname
+#
+# A PlatformManager driver that uses the Unix +uname+ command to provide
+# basic information about the platform.
+class AutomateIt::PlatformManager::Uname < AutomateIt::PlatformManager::Struct
+  depends_on :programs => %w(uname)
+
+  def suitability(method, *args) # :nodoc:
+    # Level must be greater than Struct's
+    return available? ? 2 : 0
+  end
+
+  def setup(opts={}) # :nodoc:
+    super(opts)
+    if available?
+      @struct[:os]   ||= @@struct_cache[:os]   ||= `uname -s`.chomp.downcase
+      @struct[:arch] ||= @@struct_cache[:arch] ||= `uname -m`.chomp.downcase
+=begin
+      # This method is 20% faster, but is it less portable because of the combined calls?
+      @struct[:os] and @struct[:arch] or begin
+        output = `uname -s -m`.chomp.downcase
+        os, arch = output.split(/\s+/)
+        @struct[:os]   = @@struct_cache[:os]   = os
+        @struct[:arch] = @@struct_cache[:arch] = arch
+      end
+=end
+    end
+  end
+end