automateit 0.70923 → 0.70928

data/CHANGES.txt

@@ -1,3 +1,12 @@
+0.70928:
+    Date: Fri, 28 Sep 2007 23:18:37 -0700
+    Desc:
+    - (%) Fixed #cp, #ln and #install when called with relative path source and directory target. These tried to create items which included the relative path, rather than discarding it.
+    - (+) Added an "--add TAGS" feature to executables: automateit, aifield, aitag. This makes it easy to define tag(s) for a specific run.
+    - (+) Added #backup command to save copies of files, it's now used by default when using #edit to modify a file.
+    - (+) Added #download command to retrieve data via HTTP and FTP to a file or directory.
+    - Improved specs and provided coverage for more exception handling.
+
 0.70923:
     Date: Sun, 23 Sep 2007 16:01:03 -0700
     Desc:

data/Rakefile

@@ -165,6 +165,11 @@ task :gem do
   hoe(:gem)
 end
 
+task :publish do
+  automateit
+  hoe("release VERSION=#{AutomateIt::VERSION}")
+end
+
 #---[ Install and uninstall ]-------------------------------------------
 
 =begin
@@ -184,12 +189,25 @@ namespace :install do
     puts automateit.package_manager.install({"automateit" => Dir["pkg/*.gem"].first}, :with => :gem, :docs => false)
   end
 
+  desc "Install Gem from RubyForge without docs, removing existing Gem first"
+  task :rf do
+    install_wrapper "http://gems.rubyforge.org"
+  end
+
   desc "Install Gem from website without docs, removing existing Gem first"
-  task :remote do
+  task :site do
+    install_wrapper "http://automateit.org/pub", :source => "http://automateit.org/pub", :reset => true
+  end
+
+  # Options:
+  # * :url -- URL to clear
+  # * :opts -- Hash to pass to PackageManager#install
+  def install_wrapper(url, opts={})
     Rake::Task[:uninstall].invoke
-    #sh "sudo gem install -y -r -s http://automateit.org/pub automateit --no-ri --no-rdoc"
-    sh "gem sources -r http://automateit.org/pub" rescue nil
-    automateit.package_manager.install("automateit", :source => "http://automateit.org/pub", :with => :gem, :docs => false)
+    sh "gem sources -r #{url}" rescue nil if opts.delete(:reset)
+    opts[:with] ||= :gem
+    opts[:docs] ||= false
+    automateit.package_manager.install("automateit", opts)
   end
 end
 

data/TODO.txt

@@ -2,10 +2,8 @@ KEY: Important? Urgent? Easy? 1=yes, 0=no
 
 #===[ App ]=============================================================
 
-101 Download -- Add OpenURI wrapper from gTag
 100 Shell -- Expand glob patterns, e.g. chown_R(500, 500, "*")
 
-101 CLI -- Add tags via command-line
 100 Edit -- Display summary of edits, return with :details as [rv, list]
 100 Shell -- Incorporate which.cmd so #which can work on Windows
 100 Interpreter#invoke and HelpfulERB -- Extract error context code into class

data/TUTORIAL.txt

@@ -128,6 +128,7 @@ AutomateIt uses an extensible plugin architecture to group together related comm
 
 * AutomateIt::AccountManager -- Manipulates users and groups.
 * AutomateIt::AddressManager -- Manipulates host's network addresses.
+* AutomateIt::DownloadManager -- Downloads files.
 * AutomateIt::EditManager -- Edits files and strings.
 * AutomateIt::FieldManager -- Queries configuration variables.
 * AutomateIt::PackageManager -- Manipulates software packages.

data/bin/aifield

@@ -46,9 +46,8 @@ EOB
     opts[:xml] = v
   end
 
-  parser.on("-h", "--help", "Display this help message") do |v|
-    puts parser
-    exit
+  parser.on("-a", "--add TAGS", "Add list of space separated tags") do |v|
+    opts[:tags] = [v.split].flatten
   end
 
   parser.on("-v", "--version", "Display version") do |v|
@@ -56,6 +55,11 @@ EOB
     exit 0
   end
 
+  parser.on("-h", "--help", "Display this help message") do |v|
+    puts parser
+    exit
+  end
+
   args = parser.parse!.dup
 
   # Clear ARGV so that IRB doesn't try to parse our options

data/bin/aitag

@@ -64,9 +64,8 @@ EOB
     opts[:xml] = v
   end
 
-  parser.on("-h", "--help", "Display this help message") do |v|
-    puts parser
-    exit
+  parser.on("-a", "--add TAGS", "Add list of space separated tags") do |v|
+    opts[:tags] = [v.split].flatten
   end
 
   parser.on("-v", "--version", "Display version") do |v|
@@ -74,13 +73,21 @@ EOB
     exit 0
   end
 
+  parser.on("-h", "--help", "Display this help message") do |v|
+    puts parser
+    exit
+  end
+
   args = parser.parse!.dup
 
   # Clear ARGV so that IRB doesn't try to parse our options
   opts[:args] = args
   ARGV.clear
 
-  interpreter = AutomateIt.new(:project => opts[:project])
+  interpreter = AutomateIt.new(
+    :project => opts[:project],
+    :tags => opts[:tags]
+  )
   result = nil
 
   unless opts[:tags] or opts[:tags_for] or opts[:tagged?] or opts[:hosts_tagged_with]
@@ -125,4 +132,3 @@ EOB
 
   exit 0
 end
-

data/bin/automateit

@@ -33,6 +33,12 @@ Examples:
 
   # Eval a string
   #{PROG} -e "puts tags.to_a.inspect"
+  
+  # Add a tag
+  #{PROG} -a mytag -e "puts tags.to_a.inspect"
+  
+  # Add tags
+  #{PROG} -a 'mytag othertag' -e "puts tags.to_a.inspect"
 
 Options:
 EOB
@@ -52,6 +58,10 @@ EOB
     opts[:eval] = v
   end
 
+  parser.on("-a", "--add TAGS", "Add list of space separated tags") do |v|
+    opts[:tags] = [v.split].flatten
+  end
+
   parser.on("-q", "--quiet", "Print only errors") do |v|
     opts[:verbosity] = Logger::ERROR
   end
@@ -64,16 +74,16 @@ EOB
     opts[:friendly_exceptions] = ! v
   end
 
-  parser.on("-h", "--help", "Display this help message") do |v|
-    puts parser
-    exit
-  end
-
   parser.on("-v", "--version", "Display version") do |v|
     puts AutomateIt::VERSION
     exit 0
   end
 
+  parser.on("-h", "--help", "Display this help message") do |v|
+    puts parser
+    exit
+  end
+
   args = parser.parse!.dup
 
   # Clear ARGV so that IRB doesn't try to parse our options

data/examples/basic/recipes/install.rb

@@ -1,31 +1,38 @@
-# Install packages on hosts tagged 'rails_servers' or 'myapp_servers'
+# Install dependencies on hosts with 'rails_servers' or 'myapp_servers' roles
 if tagged?("rails_servers | myapp_servers")
-  # Install platform-specific packages, queries system-provided tags
+  # Install platform-specific packages
   if tagged?("ubuntu | debian")
-    package_manager.install(%w(build-essential ruby1.8-dev libsqlite3-dev))
+    # Install the 'build-essential' package and others on Ubuntu or Debian
+    package_manager.install("build-essential", "ruby1.8-dev", "libsqlite3-dev")
   elsif tagged?("fedoracore | fedora | centos")
-    package_manager.install(%w(gcc ruby-devel sqlite-devel))
+    # Install equivalent packages on Fedora and similar OSes
+    package_manager.install("gcc", "'ruby-devel", "sqlite-devel")
   else
+    # Fail if running on another platform
     raise NotImplementedError.new("no packages specified for this platform")
   end
 
-  # Install Gems
-  package_manager.install(%w(rails sqlite3-ruby mongrel),
+  # Install Rails and supporting libraries with RubyGems
+  package_manager.install("rails", "sqlite3-ruby", "mongrel",
     :with => :gem, :docs => false)
-end
+end # ENDS: if tagged?("rails_servers | myapp_servers")
 
-# Setup the myapp server
+# Setup the myapp server, a simple Rails server instance
 if tagged?(:myapp_servers)
   # Create user for the application
   account_manager.add_user(lookup(:user))
 
-  # Create a directory for the application
+  # Create a directory for the application and 'cd' into it
   mkdir_p(lookup(:path)) do
     # Run shell commands to create the app and database
-    sh("rails --database=sqlite3 . > /dev/null") \
-      unless File.exists?("config/routes.rb")
+    unless File.exists?("config/routes.rb")
+      sh("rails --database=sqlite3 . > /dev/null")
+    end
 
-    sh("rake db:migrate") if Dir["db/*.sqlite3"].empty?
+    # Create the database if it doesn't exist.
+    if Dir["db/*.sqlite3"].empty?
+      sh("rake db:migrate")
+    end
 
     # Edit the homepage
     edit(:file => "public/index.html") do
@@ -33,21 +40,22 @@ if tagged?(:myapp_servers)
       replace("Welcome aboard", "This is MyAppServer")
     end
 
-    # Change the ownership for the files
-    chown_R(lookup(:user), nil, ".")
-
-    # Generate a service startup file from a template
-    render(:file => dist+"myapp_server.erb",
-           :to => "/etc/init.d/myapp_server",
-           :mode => 0555,
-           :locals => {
-              :path => lookup(:path),
-              :user => lookup(:user),
-              :port => lookup(:port),
-           }
+    # Set the ownership of the created files
+    chperm(".", :user => lookup(:user), :recurse => true)
+
+    # Generate a service startup file using a template
+    render(
+      :file => dist+"myapp_server.erb",
+      :to => "/etc/init.d/myapp_server",
+      :mode => 0555,
+      :locals => {
+        :path => lookup(:path),
+        :user => lookup(:user),
+        :port => lookup(:port),
+      }
     )
 
-    # Start the service
+    # Start the server
     service_manager.start("myapp_server")
-  end
-end
+  end # ENDS: mkdir_p(lookup(:path)) do
+end # ENDS: if tagged?(:myapp_servers)

data/lib/automateit.rb

@@ -64,3 +64,4 @@ require 'automateit/package_manager' # requires shell
 require 'automateit/template_manager'
 require 'automateit/edit_manager'
 require 'automateit/account_manager'
+require 'automateit/download_manager'

data/lib/automateit/cli.rb

@@ -15,6 +15,7 @@ module AutomateIt
     #   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.
@@ -26,7 +27,9 @@ module AutomateIt
         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)
@@ -50,15 +53,17 @@ module AutomateIt
         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 }
-          display.call PNOTE+"<CTRL-D> to quit, <Tab> to auto-complete"
+          message << ", <Tab> to auto-complete"
         rescue LoadError
-          display.call PNOTE+"<CTRL-D> to quit"
+          # Ignore
         end
+        display.call PNOTE+message
 
         # Set prompt
         unless opts[:custom_prompt] == false

data/lib/automateit/constants.rb

@@ -3,9 +3,6 @@ module AutomateIt # :nodoc:
   #
   # Various constants.
   module AutomateIt::Constants
-    # AutomateIt version
-    VERSION=Gem::Version.new("0.70923")
-
     # Output prefix for command execution, e.g., "** ls -la"
     PEXEC = "** "
 

data/lib/automateit/download_manager.rb

@@ -0,0 +1,46 @@
+# == DownloadManager
+#
+# The DownloadManager provides a way of downloading files.
+module AutomateIt
+  class DownloadManager < Plugin::Manager
+    alias_methods :download
+
+    # Downloads the +source+ document.
+    #
+    # Options:
+    # * :to -- Saves source to this filename or directory. Defaults to current directory.
+    def download(source, opts={}) dispatch(source, opts) end
+
+    # == DownloadManager::BaseDriver
+    #
+    # Base class for all DownloadManager drivers.
+    class BaseDriver < Plugin::Driver
+    end
+
+    # == DownloadManager::OpenURI
+    #
+    # A DownloadManager driver using the OpenURI module for handling HTTP and FTP transfers.
+    class OpenURI < BaseDriver
+      depends_on :libraries => %w(open-uri)
+
+      def suitability(method, *args) # :nodoc:
+        return available? ? 1 : 0
+      end
+
+      # See DownloadManager#download
+      def download(source, opts={})
+        target = opts[:to] || File.basename(source)
+        target = File.join(target, File.basename(source)) if File.directory?(target)
+        log.info(PNOTE+"Downloading #{target}")
+        if writing?
+          open(target, "w+") do |writer|
+            open(source) do |reader|
+              writer.write(reader.read)
+            end
+          end
+        end
+        return writing?
+      end
+    end
+  end
+end

data/lib/automateit/edit_manager.rb

@@ -84,6 +84,7 @@ class AutomateIt::EditManager::EditSession < AutomateIt::Common
   # * :params -- Hash to make available to editor session.
   # * :create -- Create the file if it doesn't exist? Defaults to false.
   # * :mode, :user, :group -- Set permissions on generated file, see ShellManager#chperm
+  # * :backup -- Make a backup of original file? Defaults to true.
   #
   # Edit a string:
   #
@@ -110,10 +111,11 @@ class AutomateIt::EditManager::EditSession < AutomateIt::Common
       @filename = args.first
     else
       raise ArgumentError.new("no file or text specified for editing") unless opts[:file] or opts[:text]
-      @filename = opts.delete(:file)
-      @contents = opts.delete(:text)
+      @filename = opts[:file]
+      @contents = opts[:text]
     end
-    @params = opts.delete(:params) || {}
+    @params = opts[:params] || {}
+    @is_backup = opts[:backup].nil? ? true : opts[:backup]
     @comment_prefix = "# "
     @comment_suffix = ""
     begin
@@ -130,7 +132,10 @@ class AutomateIt::EditManager::EditSession < AutomateIt::Common
     raise ArgumentError.new("no block given") unless block
     instance_eval(&block)
     if @filename
-      _write if different?
+      if different?
+        _backup if @is_backup
+        _write
+      end
 
       chperm_opts = {}
       for key in [:owner, :user, :group, :mode]
@@ -270,17 +275,18 @@ class AutomateIt::EditManager::EditSession < AutomateIt::Common
   # into the buffer.
   def _read
     @contents = \
-    if writing? or (preview? and @filename and File.exists?(@filename))
-      File.read(@filename)
-    else
-      nil
-    end
+      if writing? or (preview? and @filename and _exists?)
+        File.read(@filename)
+      else
+        nil
+      end
   end
   protected :_read
 
   # Write contents to #filename. Used by the #edit command to write the buffer
   # to a file.
   def _write
+    return false unless @filename
     log.info(PNOTE+"Edited '#{@filename}'")
     if preview?
       true
@@ -289,4 +295,21 @@ class AutomateIt::EditManager::EditSession < AutomateIt::Common
     end
   end
   protected :_write
+
+  # Backup the original file.
+  def _backup
+    return false unless @filename and File.exists?(@filename)
+    result = nil
+    log.silence(Logger::WARN) do
+      result = backup(@filename)
+    end
+    log.info(PNOTE+"Saved '#{@filename}' to '#{result}'")
+  end
+  protected :_backup
+
+  # Does the file exist?
+  def _exists?
+    File.exists?(@filename)
+  end
+  protected :_exists?
 end # class EditSession