automateit 0.70923 → 0.70928

data/lib/automateit/interpreter.rb

@@ -27,6 +27,7 @@ module AutomateIt
   # * cp -- AutomateIt::ShellManager#cp
   # * cp_r -- AutomateIt::ShellManager#cp_r
   # * edit -- AutomateIt::EditManager#edit
+  # * download -- AutomateIt::DownloadManager#download
   # * hosts_tagged_with -- AutomateIt::TagManager#hosts_tagged_with
   # * install -- AutomateIt::ShellManager#install
   # * ln -- AutomateIt::ShellManager#ln
@@ -124,9 +125,8 @@ module AutomateIt
     # * :verbosity -- Alias for :log_level
     # * :log_level -- Log level to use, defaults to Logger::INFO.
     # * :preview -- Turn on preview mode, defaults to false.
-    # * :project -- Set project path.
-    # * :friendly_exceptions -- Throw user-friendly exceptions that make it
-    #   easier to see errors in recipes, defaults to true.
+    # * :project -- Project directory to use.
+    # * :tags -- Array of tags to add to this run.
     #
     # Options for internal use:
     # * :parent -- Parent plugin instance.
@@ -135,6 +135,8 @@ module AutomateIt
     #   guessed, won't throw exceptions if project wasn't found at the
     #   specified path. If not guessed, will throw exception in such a
     #   situation.
+    # * :friendly_exceptions -- Throw user-friendly exceptions that make it
+    #   easier to see errors in recipes, defaults to true.
     def setup(opts={})
       super(opts.merge(:interpreter => self))
 
@@ -210,6 +212,8 @@ module AutomateIt
           raise ArgumentError.new("Couldn't find project at: #{project_path}")
         end
       end
+
+      tags.merge(opts[:tags]) if opts[:tags]
     end
 
     # Hash of plugin tokens to plugin instances for this Interpreter.

data/lib/automateit/plugin/manager.rb

@@ -38,12 +38,8 @@ module AutomateIt
 
       # Methods to alias into the Interpreter, specified as an array of symbols.
       def self.alias_methods(*methods)
-        if methods.empty?
-          self.aliased_methods
-        else
-          self.aliased_methods ||= Set.new
-          self.aliased_methods.merge(methods.flatten)
-        end
+        self.aliased_methods ||= Set.new
+        self.aliased_methods.merge(methods.flatten)
       end
 
       # Drivers for this manager as a hash of driver tokens to driver

data/lib/automateit/root.rb

@@ -1,5 +1,8 @@
 # See AutomateIt::Interpreter for usage information.
 module AutomateIt # :nodoc:
+  # AutomateIt version
+  VERSION=Gem::Version.new("0.70928")
+
   # Instantiates a new Interpreter. See documentation for
   # Interpreter#setup.
   def self.new(opts={})

data/lib/automateit/shell_manager.rb

@@ -7,7 +7,7 @@
 # previews.txt[link:files/docs/previews_txt.html] for instructions on how to
 # write code that can be safely previewed.
 class AutomateIt::ShellManager < AutomateIt::Plugin::Manager
-  alias_methods :sh, :which, :which!, :mktemp, :mktempdir, :mktempdircd, :chperm, :umask
+  alias_methods :backup, :sh, :which, :which!, :mktemp, :mktempdir, :mktempdircd, :chperm, :umask
   alias_methods :cd, :pwd, :mkdir, :mkdir_p, :rmdir, :ln, :ln_s, :ln_sf, :cp, :cp_r, :cp_R, :mv, :rm, :rm_r, :rm_rf, :install, :chmod, :chmod_R, :chown, :chown_R, :touch
 
   #...[ Detection commands ]..............................................
@@ -26,6 +26,27 @@ class AutomateIt::ShellManager < AutomateIt::Plugin::Manager
 
   #...[ Custom commands ].................................................
 
+  # Backup +sources+ if they exist. Returns the names of the backups created.
+  #
+  # 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
+  # sources.
+  #
+  # *WARNING*: This method is not conditional. It will make a backup every time
+  # it's called if the sources exist. Therefore, only execute this method when
+  # its needed.
+  #
+  # For example, backup a file:
+  #
+  #   backup("/tmp/myfile") # => "/tmp/myfile.1190994237_M2xhLrC6Sj.bak
+  #
+  # In the above example, the backup's name contains two special strings. The
+  # "1190994237" is the time the backup was made in seconds since the Epoch.
+  # The "M2xhLrC6Sj" is a random string used to guarantee the uniqueness of
+  # this backup in case two are made at exactly the same time.
+  def backup(*sources) dispatch(*sources) end
+
   # Execute a shell command.
   def sh(*commands) dispatch(*commands) end
 
@@ -250,7 +271,29 @@ class AutomateIt::ShellManager::BaseDriver < AutomateIt::Plugin::Driver
     opts[:noop] = true if preview?
     return opts
   end
-  private :_fileutils_opts
+  protected :_fileutils_opts
+
+  # Return array of all the directory's top-level contents, including hidden
+  # files with "." prefix on UNIX. Directories are returned just as a name,
+  # you'll need to expand those separately if needed.
+  def _directory_contents(directory)
+    return Dir[directory+"/{,.}*"].reject{|t| t =~ /(^|#{File::SEPARATOR})\.{1,2}$/}
+  end
+  protected :_directory_contents
+
+  # Returns derived filename to use as a peer given the +source+ and +target+.
+  # This is necessary for differentiating between directory and file targets.
+  #
+  # For example:
+  #
+  #   # Get the peer for an extant target directory:
+  #   peer_for("foo", "/tmp") # => "/tmp/foo"
+  #
+  #   # Get the peer for anything else:
+  #   peer_for("foo", "/bar") # => "/bar"
+  def peer_for(source, target)
+    return FileUtils.send(:fu_each_src_dest0, source, target){|a, b| b}
+  end
 end
 
 # Drivers

data/lib/automateit/shell_manager/base_link.rb

@@ -24,7 +24,7 @@ class AutomateIt::ShellManager::BaseLink < AutomateIt::ShellManager::BaseDriver
     end
 
     for source in sources
-      peer = File.directory?(target) ? File.join(target, File.basename(source)) : target
+      peer = peer_for(source, target)
       begin
         peer_stat = File.stat(peer)
         source_stat = File.stat(source)

data/lib/automateit/shell_manager/portable.rb

@@ -28,6 +28,42 @@ class AutomateIt::ShellManager::Portable < AutomateIt::ShellManager::BaseDriver
 
   #...[ Custom commands ].................................................
 
+  # See ShellManager#backup
+  def backup(*sources)
+    targets = []
+    for source in sources
+      is_dir = File.directory?(source)
+
+      tempster_opts = {
+        :verbose => false,
+        :noop => noop?,
+        :delete => false,
+        :dir => File.dirname(source),
+        :prefix => "%s.%s" % [File.basename(source), Time.now.to_i],
+        :suffix => ".bak",
+        :kind => is_dir ? :directory : :file,
+      }
+
+      target = ::Tempster.tempster(tempster_opts)
+
+      if is_dir
+        cp_opts = {}
+        cp_opts[:recursive] = true if is_dir
+        cp_opts[:preserve] = true if superuser?
+
+        source_children = _directory_contents(source)
+        #puts "sc: %s" % source_children.inspect
+
+        interpreter.cp_r(source_children, target, cp_opts)
+      else
+        interpreter.cp(source, target)
+      end
+
+      targets << target
+    end
+    return sources.size == 1 ? targets.first : targets
+  end
+
   # See ShellManager#sh
   def sh(*commands)
     args, opts = args_and_opts(*commands)
@@ -88,11 +124,7 @@ class AutomateIt::ShellManager::Portable < AutomateIt::ShellManager::BaseDriver
         if writing? or File.directory?(dir)
           FileUtils.cd(dir, &block)
         else
-          begin
-            block.call(true)
-          rescue Exception => e
-            raise e
-          end
+          block.call(true)
         end
       rescue Exception => e
         raise e
@@ -124,6 +156,7 @@ class AutomateIt::ShellManager::Portable < AutomateIt::ShellManager::BaseDriver
       cmd = kind.to_s.gsub(/_/, ' -')
       log.info(PEXEC+"#{cmd} #{missing.join(" ")}")
       result = [FileUtils.send(kind, missing, _fileutils_opts)].flatten
+      result = result.first if [dirs].flatten.size == 1
     end
     if block
       if missing.size > 1
@@ -159,7 +192,7 @@ class AutomateIt::ShellManager::Portable < AutomateIt::ShellManager::BaseDriver
     chmod_rv = nil
     log.silence(Logger::WARN) do
       cp_rv = cp(source, target)
-      chmod_rv = chmod(mode, target) if mode
+      chmod_rv = chmod(mode, peer_for(source, target)) if mode
     end
 
     return false unless cp_rv or chmod_rv
@@ -186,13 +219,8 @@ class AutomateIt::ShellManager::Portable < AutomateIt::ShellManager::BaseDriver
       Find.find(parent) do |child|
         source_fn = File.directory?(child) ? child+"/" : child
         target_dir = File.directory?(target)
-        target_fn = \
-          if target_dir
-            #File.join(target, source_fn.match(/#{parent}\/?(.*)$/)[1])
-            File.join(target, source_fn)
-          else
-            target
-          end
+        target_fn = peer_for(source_fn, target)
+
         log.debug(PNOTE+"comparing %s => %s" % [source_fn, target_fn])
         source_st = File.stat(source_fn)
         is_copy = false

data/lib/automateit/tag_manager.rb

@@ -2,10 +2,13 @@
 #
 # The TagManager provides a way of querying tags. Tags are keywords
 # associated with a specific hostname or group. These are useful for grouping
-# together hosts and defining common behavior for them. The tags are
-# typically stored in a Project's <tt>config/tags.yml</tt> file.
+# together hosts and defining common behavior for them.
 #
-# For example, consider a <tt>tags.yml</tt> file that contains YAML like:
+# === Basics
+#
+# The tags are typically stored in a Project's <tt>config/tags.yml</tt> file.
+#
+# For example, consider this <tt>config/tags.yml</tt> file:
 #   desktops:
 #     - satori
 #     - sunyata
@@ -24,6 +27,67 @@
 #   tagged?("satori") # => true
 #   tagged?("satori || desktops") # => true
 #   tagged?("(satori || desktops) && !notebooks") # => true
+#
+# === Traits
+#
+# Your system may also automatically add tags that describe your system's
+# traits, such as the name of the operating system, distribution release,
+# hardware architecture, hostnames, IP addresses, etc.
+#
+# For example, here is a full set of tags for a system:
+#
+#  ai> pp tags.sort                # Pretty print the tags in sorted order
+#  ["10.0.0.6",                    # IPv4 addresses
+#   "127.0.0.1",                   # ...
+#   "192.168.130.1",               # ...
+#   "::1/128",                     # IPv6 addresses
+#   "fe80::250:56ff:fec0:8/64",    # ...
+#   "fe80::250:8dff:fe95:8fe9/64", # ...
+#   "i686",                        # Hardware architecture
+#   "linux",                       # OS
+#   "linux_i686",                  # OS and architecture
+#   "localhost",                   # Variants of hostname
+#   "localhost.localdomain",       # ...
+#   "michiru",                     # ...
+#   "michiru.koshevoy",            # ...
+#   "michiru.koshevoy.net",        # ...
+#   "myapp_servers",               # User defined tags
+#   "rails_servers",               # ...
+#   "ubuntu",                      # OS distribution name
+#   "ubuntu_6.06"]                 # OS distribution name and release version
+#
+# To execute code only on an Ubuntu system:
+#
+#   if tagged?("ubuntu")
+#     # Code will only be run on Ubuntu systems
+#   end
+#
+# These additional tags are retrieved from the PlatformManager and
+# AddressManager. If your platform does not provide drivers for these, you will
+# not get these tags. If you're on an unsupported platform and do not want to
+# write drivers, you can work around this by manually declaring the missing
+# tags in <tt>config/tags.yml</tt> on a host-by-host basis.
+#
+# === Inclusion and negation
+#
+# You can include and negate tags declaratively by giving "@" and "!" prefixes
+# to arguments.
+#
+# For example, consider this <tt>config/tags.yml</tt> file:
+#
+#   apache_servers:
+#     - kurou
+#     - shirou
+#   apache_servers_except_kurou:
+#     - @apache_servers
+#     - !kurou
+#
+# This will produce the following results:
+#
+#   ai> hosts_tagged_with("apache_servers")
+#   => ["kurou", "shirou"]
+#   ai> hosts_tagged_with("apache_servers_except_kurou")
+#   => ["shirou"]
 class AutomateIt::TagManager < AutomateIt::Plugin::Manager
   alias_methods :hosts_tagged_with, :tags, :tagged?, :tags_for
 

data/lib/tempster.rb

@@ -32,27 +32,35 @@ require 'fileutils'
 # * Random string generator taken from
 #   http://pleac.sourceforge.net/pleac_ruby/numbers.html
 class Tempster
-  DEFAULT_NAME = "tempster"
+  DEFAULT_PREFIX = "tempster"
   DEFAULT_FILE_MODE = 0600
   DEFAULT_DIRECTORY_MODE = 0700
   DEFAULT_ARMOR_LENGTH = 10
   ARMOR_CHARACTERS = ["A".."Z","a".."z","0".."9"].collect{|r| r.to_a}.join
 
+  # Alias for ::tempster.
+  def self._tempster(opts={}, &block) # :nodoc:
+    tempster(opts, &block)
+  end
+
   # Options:
-  # * :name -- Name prefix to usse, defaults to "tempster".
   # * :kind -- Create a :file or :directory, required.
+  # * :prefix -- String to prefix the temporary name with, defaults to "tempster".
+  # * :suffix -- String to suffix the temporary name with, defaults is no suffix.
+  # * :name -- Same as :prefix
   # * :dir -- Base directory to create temporary entries in, uses system-wide temporary directory (e.g., <tt>/tmp</tt>) by default.
   # * :cd -- Change into the newly directory created using +ch+ within the block, and then switch back to the previous directory. Only used when a block is given and the :kind is :directory. Default is false. See WARNING at the top of this class's documentation!
   # * :noop -- no-operation mode, pretends to do actions without actually creating or deleting temporary entries. Default is false. WARNING: See WARNING at the top of this class's documentation!
   # * :verbose -- Print status messages about creating and deleting the temporary entries. Default is false.
   # * :delete -- Delete the temporary entries when exiting block. Default is true when given a block, false otherwise. If you don't use a block, you're responsible for deleting the entries yourself.
   # * :tries -- Number of tries to create a temporary entry, usually it'll succeed on the first try. Default is 10.
-  # * :armor -- Length of armor to add to the name. These are random characters padding out the temporary entry names to prevent them from using existing files. If you have a very short armor, you're likely to get a collision and the algorithm will have to try again for the specified number of +tries+.
+  # * :armor -- Length of armor to append to the prefix. These are random characters padding out the temporary entry names to prevent them from using existing files. If you have a very short armor, you're likely to get a collision and the algorithm will have to try again for the specified number of +tries+.
   # * :message_callback -- +lambda+ called when there's a message, e.g., <tt>lambda{|message| puts message}</tt>, regardless of :verbose state. By default :messaging is nil and messages are printed to STDOUT only when :verbose is true.
   # * :message_prefix -- String to put in front of messages, e.g., "# "
-  def self._tempster(opts={}, &block)
-    name = opts.delete(:name) || DEFAULT_NAME
+  def self.tempster(opts={}, &block)
     kind = opts.delete(:kind) or raise ArgumentError.new("'kind' option not specified")
+    prefix = opts.delete(:prefix) || opts.delete(:name) || DEFAULT_PREFIX
+    suffix = opts.delete(:suffix) || nil
     dir = opts.delete(:dir) || Dir.tmpdir
     cd = opts.delete(:cd) || false
     noop =  opts.delete(:noop) || false
@@ -82,7 +90,10 @@ class Tempster
     success = false
     for i in 1..tries
       begin
-        path = File.join(dir, name+"_"+_armor_string(armor))
+        name = prefix+"_"+_armor_string(armor)
+        name << suffix if suffix
+        path = File.join(dir, name)
+
         unless noop
           case kind
           when :file
@@ -94,13 +105,9 @@ class Tempster
             raise ArgumentError.new("unknown kind: #{kind}")
           end
         end
-        # XXX Should we pretend that it's mktemp? Or give users something more useful?
-        # messager.puts("mktemp -m 0%o%s -p %s %s # => %s" % [mode, kind == :directory ? ' -d' : '', dir, name, path])
-        if block
-          messager.puts("mktempster --mode=0%o --kind=%s --dir=%s --name=%s" % [mode, kind, dir, name])
-        else
-          messager.puts("mktempster --mode=0%o --kind=%s --dir=%s --name=%s # => %s" % [mode, kind, dir, name, path])
-        end
+        message = "mktempster --mode=0%o --kind=%s --dir=%s --prefix=%s" % [mode, kind, dir, prefix]
+        message << (" --suffix=%s" % suffix) if suffix
+        message << (" # => %s" % path) if block
         success = true
         break
       rescue Errno::EEXIST
@@ -142,14 +149,14 @@ class Tempster
 
   # Creates a temporary file.
   def self.mktemp(opts={}, &block)
-    _tempster({:kind => :file}.merge(opts), &block)
+    tempster({:kind => :file}.merge(opts), &block)
   end
 
   # Creates a temporary directory.
   #
   # *WARNING*: See WARNING text at the top of this class's documentation!
   def self.mktempdir(opts={}, &block)
-    _tempster({:kind => :directory}.merge(opts), &block)
+    tempster({:kind => :directory}.merge(opts), &block)
 
   end
 
@@ -158,7 +165,7 @@ class Tempster
   #
   # *WARNING*: See WARNING text at the top of this class's documentation!
   def self.mktempdircd(opts={}, &block)
-    _tempster({:kind => :directory, :cd => true}.merge(opts), &block)
+    tempster({:kind => :directory, :cd => true}.merge(opts), &block)
   end
 
   class Messager
@@ -180,6 +187,9 @@ class Tempster
   end
 end
 
+=begin
+# Mostly recreated this in spec/integration/tempster_spec.rb
+
 if __FILE__ == $0
   # TODO Tempster -- write a spec
 
@@ -237,3 +247,4 @@ if __FILE__ == $0
   puts "after dir exists?: %s" % File.directory?(path)
   puts "after pwd: "+Dir.pwd
 end
+=end

data/spec/integration/download_spec.rb

@@ -0,0 +1,44 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), "/../spec_helper.rb")
+
+describe "AutomateIt::DownloadManager" do
+  before :all do
+    @a = AutomateIt.new(:verbosity => Logger::WARN)
+  end
+
+  it "should download a web page to a file" do
+    @a.mktempdircd do
+      source = "http://www.google.com/"
+      target = "google.html"
+
+      @a.download(source, :to => target).should be_true
+
+      File.exists?(target).should be_true
+      File.read(target).should =~ /<html>.*Google/im
+    end
+  end
+
+  it "should download a web page to a directory" do
+    @a.mktempdircd do
+      source = "http://www.google.com/"
+      intermediate = "."
+      target = "www.google.com"
+
+      @a.download(source, :to => intermediate).should be_true
+
+      File.exists?(target).should be_true
+      File.read(target).should =~ /<html>.*Google/im
+    end
+  end
+
+  it "should download a web page to current directory" do
+    @a.mktempdircd do
+      source = "http://www.google.com/"
+      target = "www.google.com"
+
+      @a.download(source).should be_true
+
+      File.exists?(target).should be_true
+      File.read(target).should =~ /<html>.*Google/im
+    end
+  end
+end