automateit 0.71006 → 0.71012

data/lib/automateit/platform_manager.rb

@@ -45,3 +45,4 @@ 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'

data/lib/automateit/platform_manager/darwin.rb

@@ -2,10 +2,10 @@
 #
 # A PlatformManager driver for Apple's Darwin.
 class AutomateIt::PlatformManager::Darwin < AutomateIt::PlatformManager::Struct
-  depends_on :files => ["/usr/sbin/scutil"], :programs => ["which"]
+  depends_on :files => ["/usr/sbin/scutil"], :programs => ["which", "uname"]
 
   def suitability(method, *args) # :nodoc:
-    # Must be higher than PlatformManager::Struct
+    # Must be higher than PlatformManager::Uname
     return available? ? 3 : 0
   end
 

data/lib/automateit/platform_manager/freebsd.rb

@@ -2,6 +2,10 @@
 #
 # 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:

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/plugin/driver.rb

@@ -45,6 +45,18 @@ module AutomateIt
       cattr_accessor :classes
       self.classes = {}
 
+      # Returns the Plugin::Manager instance for this Driver.
+      attr_accessor :manager
+
+      # Setup a Driver.
+      #
+      # Options:
+      # * :manager -- The Plugin::Manager instance controlling this driver.
+      def setup(opts={})
+        self.manager = opts[:manager] if opts[:manager]
+        super(opts)
+      end
+
       # Retrieve the manager token for this driver
       def self.manager_token
         fragments = base_driver.to_s.split(/::/)
@@ -70,10 +82,14 @@ module AutomateIt
         if subclass.base_driver?
           # Ignore, base drivers should never be registered
         elsif base_driver
-          manager = subclass.manager_token
-          classes[manager] ||= []
-          classes[manager] << subclass unless classes[manager].include?(subclass)
-          ### puts "manager %s / driver %s" % [manager, subclass]
+          manager_token = subclass.manager_token
+          classes[manager_token] ||= []
+
+          unless classes[manager_token].include?(subclass)
+            classes[manager_token] << subclass
+          end
+
+          ### puts "manager_token %s / driver %s" % [manager_token, subclass]
         else
           # XXX Should this really raise an exception?
           raise TypeError.new("Can't determine manager for driver: #{subclass}")
@@ -197,6 +213,7 @@ module AutomateIt
           raise NotImplementedError.new("Missing dependencies -- %s" % msg)
         end
       end
+      protected :_raise_unless_available
 
       # What is this driver's suitability for automatic detection? The Manager
       # queries its drivers when there isn't a driver specified with a

data/lib/automateit/plugin/manager.rb

@@ -80,7 +80,8 @@ module AutomateIt
         end
         self.class.driver_classes.each do |driver_class|
           driver_token = driver_class.token
-          @drivers[driver_token].setup(:interpreter => @interpreter)
+          @drivers[driver_token].setup(
+            :interpreter => @interpreter, :manager => self)
         end
       end
 

data/lib/automateit/root.rb

@@ -1,7 +1,7 @@
 # See AutomateIt::Interpreter for usage information.
 module AutomateIt # :nodoc:
   # AutomateIt version
-  VERSION=Gem::Version.new("0.71006")
+  VERSION=Gem::Version.new("0.71012")
 
   # Instantiates a new Interpreter. See documentation for
   # Interpreter#setup.

data/lib/automateit/service_manager/sysv.rb

@@ -60,7 +60,7 @@ class AutomateIt::ServiceManager::SYSV < AutomateIt::ServiceManager::BaseDriver
       end
 
     result = tell(service, :status, :check => true)
-    ### puts "k %s r %s e %s" % [kind, result, expected]
+    nitpick("_sash top: k=%s r=%s e=%s" % [kind, result, expected])
     return result if expected == result
     if opts[:wait]
       timeout = Time.now + opts[:wait]
@@ -69,6 +69,7 @@ class AutomateIt::ServiceManager::SYSV < AutomateIt::ServiceManager::BaseDriver
           [kind, service, timeout - Time.now])
         sleep 0.5
         result = tell(service, :status, :check => true)
+        nitpick("_sash rep: k=%s r=%s e=%s" % [kind, result, expected])
         break if expected == result
       end
       log.info(PNOTE+" ServiceManager#%s finished waiting for '%s', got: %s" %

data/lib/automateit/shell_manager.rb

@@ -28,6 +28,9 @@ class AutomateIt::ShellManager < AutomateIt::Plugin::Manager
 
   # Backup +sources+ if they exist. Returns the names of the backups created.
   #
+  # Options:
+  # * :quiet -- Don't display output? Default is false.
+  #
   # These backups are copies of the original sources saved into the same
   # directories as the originals. The pathnames of these copies are timestamped
   # and guaranteed to be unique, so you can have multiple backups of the same

data/lib/automateit/shell_manager/portable.rb

@@ -30,6 +30,8 @@ class AutomateIt::ShellManager::Portable < AutomateIt::ShellManager::BaseDriver
 
   # See ShellManager#backup
   def backup(*sources)
+    sources, opts = args_and_opts(*sources)
+
     targets = []
     for source in sources
       is_dir = File.directory?(source)
@@ -46,17 +48,19 @@ class AutomateIt::ShellManager::Portable < AutomateIt::ShellManager::BaseDriver
 
       target = ::Tempster.tempster(tempster_opts)
 
-      if is_dir
-        cp_opts = {}
-        cp_opts[:recursive] = true if is_dir
-        cp_opts[:preserve] = :try
+      log.silence(opts[:quiet] ? Logger::WARN : log.level) do
+        if is_dir
+          cp_opts = {}
+          cp_opts[:recursive] = true if is_dir
+          cp_opts[:preserve] = :try
 
-        source_children = _directory_contents(source)
-        #puts "sc: %s" % source_children.inspect
+          source_children = _directory_contents(source)
+          #puts "sc: %s" % source_children.inspect
 
-        interpreter.cp_r(source_children, target, cp_opts)
-      else
-        interpreter.cp(source, target)
+          interpreter.cp_r(source_children, target, cp_opts)
+        else
+          interpreter.cp(source, target)
+        end
       end
 
       targets << target
@@ -393,6 +397,8 @@ class AutomateIt::ShellManager::Portable < AutomateIt::ShellManager::BaseDriver
       end
 
     modified_entries = []
+    modified_ownership = false
+    modified_permission = false
     Find.find(*targets) do |path|
       modified = false
       stat = writing? || File.exists?(path) ? File.stat(path) : nil
@@ -401,15 +407,18 @@ class AutomateIt::ShellManager::Portable < AutomateIt::ShellManager::BaseDriver
         mode = opts[:mode] | (stat.directory? ? DIRECTORY_MASK : FILE_MASK) if stat
         unless stat and (mode ^ stat.mode).zero?
           modified = true
+          modified_permission = true
           File.chmod(mode, path) if writing?
         end
       end
       if user and (not stat or user != stat.uid)
         modified = true
+        modified_ownership = true
         File.chown(user, nil, path) if writing?
       end
       if group and (not stat or group != stat.gid)
         modified = true
+        modified_ownership = true
         File.chown(nil, group, path) if writing?
       end
       modified_entries << path if modified
@@ -421,19 +430,18 @@ class AutomateIt::ShellManager::Portable < AutomateIt::ShellManager::BaseDriver
     display_entries = opts[:details] ? modified_entries : targets
     display_entries = [display_entries].flatten
 
-    if opts[:mode]
+    if modified_permission
       msg = "chmod"
       msg << " -R" if opts[:recursive]
       msg << " 0%o" % opts[:mode] if opts[:mode]
       msg << " " << display_entries.join(' ')
       log.info(PEXEC+msg)
     end
-    if opts[:user] or opts[:group]
+    if modified_ownership
       msg = "chown"
       msg << " -R" if opts[:recursive]
       msg << " %s" % opts[:user] if opts[:user]
       msg << ":" if opts[:user] and opts[:group]
-      msg << " " unless opts[:user] and opts[:group]
       msg << "%s" % opts[:group] if opts[:group]
       msg << " " << display_entries.join(' ')
       log.info(PEXEC+msg)
@@ -484,11 +492,11 @@ class AutomateIt::ShellManager::Portable < AutomateIt::ShellManager::BaseDriver
       end
 
     unless quiet
-      msg = PEXEC << "touch"
+      msg = "touch"
       msg << " --reference %s" % like if like
       msg << " --stamp %s" % stamp if stamp
       msg << " " << [targets].flatten.join(" ")
-      log.info(msg)
+      log.info(PEXEC+msg)
     end
 
     results = []

data/lib/automateit/template_manager.rb

@@ -17,9 +17,10 @@ class AutomateIt::TemplateManager < AutomateIt::Plugin::Manager
   # * :text -- Read the template from this string.
   # * :to -- Render to a file, otherwise returns the rendered string.
   # * :locals -- Hash of variables passed to template as local variables.
-  # * :dependencies -- When checking timestamps, include this Array of
-  #   filenames when checking timestamps.
-  # * :force -- Boolean to force rendering without checking timestamps.
+  # * :dependencies -- Array of filenames to check timestamps on, only used
+  #   when :check is :timestamp.
+  # * :backup -- Make a backup? Default is true.
+  # * :force -- Render without making a check. Default is false.
   # * :check -- Determines when to render, otherwise uses value of
   #   +default_check+, possible values:
   #   * :compare -- Only render if rendered template is different than the

data/lib/automateit/template_manager/base.rb

@@ -16,6 +16,10 @@ class AutomateIt::TemplateManager::BaseDriver < AutomateIt::Plugin::Driver
     end
   end
 
+  #.......................................................................
+
+  protected
+
   # Return Array of +dependencies+ newer than +filename+. Will be empty if
   # +filename+ is newer than all of the +dependencies+.
   def _newer(filename, *dependencies)
@@ -26,13 +30,11 @@ class AutomateIt::TemplateManager::BaseDriver < AutomateIt::Plugin::Driver
     end
     return updated
   end
-  protected :_newer
 
   # Does +filename+ exist?
   def _exists?(filename)
     return File.exists?(filename)
   end
-  protected :_exists?
 
   # Return the contents of +filename+.
   def _read(filename)
@@ -47,20 +49,22 @@ class AutomateIt::TemplateManager::BaseDriver < AutomateIt::Plugin::Driver
       end
     end
   end
-  protected :_read
 
   # Write +contents+ to +filename+.
   def _write(filename, contents)
     File.open(filename, "w+"){|writer| writer.write(contents)} if writing?
     return true
   end
-  protected :_write
+
+  # Backup +filename+.
+  def _backup(filename)
+    interpreter.backup(filename)
+  end
 
   # Return the modification date for +filename+.
   def _mtime(filename)
     return _exists? ? File.mtime(filename) : nil
   end
-  protected :_mtime
 
   # Render a template specified in the block. It takes the same arguments and
   # returns the same results as the #render call.
@@ -84,6 +88,7 @@ class AutomateIt::TemplateManager::BaseDriver < AutomateIt::Plugin::Driver
     source_filename = args[0] || opts[:file]
     target_filename = args[1] || opts[:to]
     source_text = opts[:text]
+    opts[:backup] = true if opts[:backup].nil?
 
     raise ArgumentError.new("No source specified with :file or :text") if not source_filename and not source_text
     raise Errno::ENOENT.new(source_filename) if writing? and source_filename and not _exists?(source_filename)
@@ -155,11 +160,13 @@ class AutomateIt::TemplateManager::BaseDriver < AutomateIt::Plugin::Driver
           log.debug(PNOTE+"Rendering for '#{target_filename}' skipped because contents are the same")
           return false
         else
-          log.info(PNOTE+"Rendering '#{target_filename} because its contents changed")
+          log.info(PNOTE+"Rendering '#{target_filename}' because its contents changed")
         end
       when :timestamp
         log.info(PNOTE+"Rendering '#{target_filename}' because of updated: #{updates.join(' ')}")
       end
+
+      _backup(target_filename) if target_exists and opts[:backup]
       result = _write(target_filename, output)
       return result
     ensure
@@ -168,5 +175,4 @@ class AutomateIt::TemplateManager::BaseDriver < AutomateIt::Plugin::Driver
       end
     end
   end
-  protected :_render_helper
 end

data/spec/breaker.rb

@@ -0,0 +1,8 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), "/spec_helper.rb")
+
+describe "Breaker" do
+  it "should breakpoint within the RSpec environment" do
+    require "breakpoint"
+    breakpoint
+  end
+end

data/spec/integration/{address_manager_linux_spec.rb → address_manager_spec.rb}

@@ -4,34 +4,26 @@ if not INTERPRETER.euid?
   puts "NOTE: Can't check 'euid' on this platform, #{__FILE__}"
 elsif not INTERPRETER.superuser?
   puts "NOTE: Must be root to check #{__FILE__}"
-elsif not INTERPRETER.address_manager[:linux].available?
-  puts "NOTE: Can't check AddressManager::Linux on this platform, #{__FILE__}"
 else
-  describe "AutomateIt::AddressManager::Linux" do
+  describe AutomateIt::AddressManager, :shared => true do
     before(:all) do
+      # Should examples be independent? True is correct and lets you run a
+      # single example. False is evil and requires you to run the entire suite,
+      # but it's much faster. On Linux false yields a 5x speed-up.
+      @independent = false
+
       @a = AutomateIt.new(:verbosity => Logger::WARN)
       @m = @a.address_manager
-
-      @properties = {
-        :device => "eth0",
-        :label => "xxxx",
-        :address => "10.0.0.249",
-        :mask => "24",
-        :announcements => 1,
-      }
-
-      @device_and_label = @properties[:device]+":"+@properties[:label]
-
-      if @m.interfaces.include?(@device_and_label) \
-          or @m.addresses.include?(@properties[:address])
-        raise "ERROR: This computer already has the device/address used for testing! Either disable #{@device_and_label} and #{@properties[:address]}, or change the spec to test using different properties."
-      end
     end
 
     after(:all) do
       @m.remove(@properties)
     end
 
+    after(:each) do
+      @m.remove(@properties) if @independent
+    end
+
     it "should find interfaces for top-level device" do
       @m.interfaces.should include(@properties[:device])
     end
@@ -50,36 +42,41 @@ else
 
     it "should add an address" do
       @m.add(@properties).should be_true
-      # Leaves active interface behind for other tests
     end
 
     it "should find added interface" do
-      # Depends on active interface being created by earlier test
+      @m.add(@properties).should be_true if @independent
+
       @m.interfaces.should include(@device_and_label)
     end
 
     it "should find added IP address" do
-      # Depends on active interface being created by earlier test
+      @m.add(@properties).should be_true if @independent
+
       @m.addresses.should include(@properties[:address])
     end
 
     it "should find added address using a properties bundle" do
-      # Depends on user to be created by previous tests
+      @m.add(@properties).should be_true if @independent
+
       @m.has?(@properties).should be_true
     end
 
     it "should find added address using the IP address" do
-      # Depends on user to be created by previous tests
+      @m.add(@properties).should be_true if @independent
+
       @m.has?(:address => @properties[:address]).should be_true
     end
 
     it "should find added address using device and label" do
-      # Depends on user to be created by previous tests
+      @m.add(@properties).should be_true if @independent
+
       @m.has?(:device => @properties[:device], :label => @properties[:label]).should be_true
     end
 
     it "should remove an address" do
-      # Depends on active interface being created by earlier test
+      @m.add(@properties).should be_true if @independent
+
       @m.remove(@properties).should be_true
     end
 
@@ -116,4 +113,47 @@ else
       @m.hostnames_for("kagami").should == ["kagami"]
     end
   end
+
+  #---[ Targets ]---------------------------------------------------------
+
+  %w(linux sunos).each do |driver_name|
+    driver_token = driver_name.to_sym
+    driver = INTERPRETER.address_manager[driver_token]
+    if driver.available?
+      describe driver.class.to_s do
+        it_should_behave_like "AutomateIt::AddressManager"
+
+        before(:all) do
+
+          @properties = {
+            :device => @m.interfaces.reject{|t| t =~ /^lo\d+$/}.first,
+            :label => "1",
+            :address => "10.0.0.249",
+            :mask => "24",
+          }
+
+          case driver_token
+          when :sunos
+            # Accept defaults
+          when :linux
+            @properties[:label] = "atst"
+            @properties[:announcements] = 1
+          else
+            raise ArgumentError.new("Unknown AddressManager driver: #{driver_token}")
+          end
+
+          @device_and_label = @properties[:device]+":"+@properties[:label]
+
+          if @m.interfaces.include?(@device_and_label) \
+              or @m.addresses.include?(@properties[:address])
+            raise "ERROR: This computer already has the device/address used for testing! Either disable #{@device_and_label} and #{@properties[:address]}, or change the spec to test using different properties."
+          end
+
+          @d = @m[driver_token]
+        end
+      end
+    else
+      puts %{NOTE: Can't check %s on this platform, #{__FILE__}} % driver.class
+    end
+  end
 end