automateit 0.71021 → 0.71030

data/CHANGES.txt

@@ -1,3 +1,13 @@
+0.71030:
+    Date: Tue, 30 Oct 2007 01:43:02 -0700
+    Desc:
+    - (%) Fixed bug in AddressManager#add_user when called with multiple groups. Improved AddressManager spec. 
+    - (+) Added documentation to Project explaining how to partition recipes, and run recipes from other recipes.
+    - (+) Added AddressManager::POSIX which provides support for Linux and SunOS, and eliminated the OS-specific drivers for these. 
+    - Added AddressManager::NSCD by extracting methods from old OS-specific drivers. 
+    - Added AddressManager::PasswdExpect which uses Expect for much more reliable password changes. 
+    - Improved AddressManager::PasswdPty by adding retry capability.
+
 0.71021:
     Date: Sun, 21 Oct 2007 04:58:01 -0700
     Desc:

data/Hoe.rake

@@ -18,17 +18,19 @@ task :manifest do
 end
 
 Hoe.new("AutomateIt", AutomateIt::VERSION.to_s) do |s|
+  slogan = "AutomateIt is an open source tool for automating the setup and maintenance of servers, applications and their dependencies."
+  title = "AutomateIt: Open source server automation"
   s.author = "Igal Koshevoy"
   s.changes = s.paragraphs_of('CHANGES.txt', 0).join("\n")
-  s.description = "AutomateIt is an open-source tool for automating the setup and maintenance of UNIX-like systems" 
+  s.description = slogan
   s.email = "igal@pragmaticraft.com"
   s.extra_deps = [["activesupport", ">= 1.4"], ["open4", ">= 0.9"]]
   s.name = "automateit"
-  s.summary = "AutomateIt is an open-source tool for automating the setup and maintenance of UNIX-like systems" 
+  s.summary = slogan
   s.url = "http://automateit.org/"
   s.spec_extras = {
     :platform => Gem::Platform::RUBY,
-    :rdoc_options => %w(--main README.txt --promiscuous --accessor class_inheritable_accessor=R --title) << 'AutomateIt is an open-source tool for automating the setup and maintenance of UNIX-like systems.' << %w(lib docs),
+    :rdoc_options => %w(--main README.txt --promiscuous --accessor class_inheritable_accessor=R --title) << title << %w(lib docs),
     :extra_rdoc_files => FileList[%w(README.txt TUTORIAL.txt TESTING.txt), "docs/*.txt"],
   }
   s.spec_extras.merge!(HoeInclude)

data/README.txt

@@ -1,6 +1,6 @@
 == AutomateIt
 
-<em>AutomateIt is an open-source tool for automating the setup and maintenance of servers.</em>
+<em>AutomateIt is an open source tool for automating the setup and maintenance of servers, applications and their dependencies.</em>
 
 Information about AutomateIt is best read in the following order:
 1. http://AutomateIt.org -- website explaining what it is and why it's useful

data/Rakefile

@@ -159,6 +159,13 @@ task :now do
   puts time.to_s(:rfc822)
 end
 
+desc "RFC-822 time for yesterday"
+task :yesterday do
+  require 'active_support'
+  time = Time.now - 1.day
+  puts time.to_s(:rfc822)
+end
+
 namespace :gem do
   desc "View Gem metadata"
   task :metadata do
@@ -226,7 +233,7 @@ namespace :rdoc do
   desc "Generate documentation"
   task :make do
     # Uses Jamis Buck's RDoc template from http://weblog.jamisbuck.org/2005/4/8/rdoc-template
-    sh "rdoc --template=jamis --main README.txt --promiscuous --accessor class_inheritable_accessor=R --title 'AutomateIt is an open-source tool for automating the setup and maintenance of UNIX-like systems.' lib docs/*.txt README.txt TUTORIAL.txt TESTING.txt"
+    sh "rdoc --template=jamis --main README.txt --promiscuous --accessor class_inheritable_accessor=R --title 'AutomateIt: Open source server automation' lib docs/*.txt README.txt TUTORIAL.txt TESTING.txt"
     # Create a tutorial index
     File.open("doc/tutorial.html", "w+") do |writer|
       writer.write(File.read("doc/index.html").sub(/README_txt.html/, 'TUTORIAL_txt.html'))
@@ -274,7 +281,7 @@ namespace :rdoc do
       puts "checking %s" % File.mtime(target)
       puts "different" if different
 
-      sh "rdoc --template=jamis --promiscuous --accessor class_inheritable_accessor=R --title 'AutomateIt is an open-source tool for automating the setup and maintenance of UNIX-like systems.' %s" % sources_and_targets.values.join(" ") if different
+      sh "rdoc --template=jamis --promiscuous --accessor class_inheritable_accessor=R --title 'AutomateIt: Open source server automation' %s" % sources_and_targets.values.join(" ") if different
       sleep 1
     end
   end
@@ -304,8 +311,11 @@ task :chown do
   end
 end
 
+desc "Link to local rdoc stash"
 task :rdoclink do
   automateit.ln_s("/home/lagi/stash/automateit_rdoc", "doc")
 end
 
+task :after => [:rdoclink, :rdoc, :regem]
+
 #===[ fin ]=============================================================

data/TODO.txt

@@ -2,22 +2,27 @@ KEY: Important? Urgent? Easy? 1=yes, 0=no
 
 #===[ App ]=============================================================
 
-Solaris 10
-- Create AccountManager::SunOS
-- Create ServiceManager::SMF
-- Create PackageManager::Blastwave
-- Create PackageManager::SunPkg
+BUGS
+- does service_manager.start_and_enable work as expected?
 
-111 Shell -- Write #su(user, *command)
-100 Shell -- Expand glob patterns, e.g. chown_R(500, 500, "*")
+111 aissh or aion -- Write command for running stuff against servers with ssh, e.g., "aissh rails_servers ls", which is basically a wrapper over "for t in aitag -w rails_servers; do echo $t; ssh $t "ls"; done"
+111 Shell -- Write #su(user, *command) as a wrapper around #sh
+101 Shell -- Expand glob patterns, e.g. chown_R(500, 500, "*")
 
 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
 
+001 CPAN -- Write driver for PackageManager::CPAN
+001 FreeBSD -- Write driver for PackageManager::FreeBSD_Ports (or generic ::Ports?) and FreeBSD_Pkg
+000 Darwin -- Write drivers, e.g. PackageManager for Fink and MacPorts (or generic ::Ports?)
 000 Shell#chperm -- With symbolic mode, wrap `chmod -v` as temporary workaround?
-000 FreeBSD -- Write driver for PackageManager::Ports
-000 Darwin -- Write drivers, e.g. PackageManager for Fink, MacPorts, Pkgsrc
+000 PackageManager -- Provide a way to specify desired versions and upgrade via recipes
+
+Solaris 10
+000 Create ServiceManager::SMF
+000 Create PackageManager::Blastwave
+000 Create PackageManager::SunOS_Pkg
 
 ??? Shell -- Return false or list, never single item?
 ??? 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.

data/TUTORIAL.txt

@@ -1,6 +1,6 @@
 == A hands-on tutorial for learning AutomateIt
 
-<em>AutomateIt is an open-source tool for automating the setup and maintenance of servers.</em>
+<em>AutomateIt is an open source tool for automating the setup and maintenance of servers, applications and their dependencies.</em>
 
 This hands-on guide will teach you to use AutomateIt and explain where to find more detailed instructions.
 

data/lib/automateit.rb.orig

@@ -0,0 +1,65 @@
+# == Dependencies
+
+# Standard libraries
+require 'etc'
+require 'fileutils'
+require 'find'
+require 'logger'
+require 'open3'
+require 'pp'
+require 'pathname'
+require 'resolv'
+require 'set'
+require 'socket'
+require 'yaml'
+require 'erb'
+
+# Load ActiveSupport pieces individually to save ~0.5s
+### require 'active_support'
+gem 'activesupport'
+require 'active_support/core_ext/array' # [].extract_options, new in AS 1.4.4
+require 'active_support/core_ext/blank' # foo.blank?
+require 'active_support/core_ext/class/attribute_accessors' # cattr_accessor
+require 'active_support/core_ext/class/inheritable_attributes' # inheritable_cattr_accessor
+require 'active_support/core_ext/module/aliasing' # alias_method_chain
+require 'active_support/core_ext/string' # "asdf".demodulize.underscore
+require 'active_support/clean_logger' # cleans up Logger output
+require 'active_support/core_ext/symbol' # [:foo, :bar].map(&:to_s)
+
+# Handle ActiveSupport includes
+require 'active_support/core_ext/hash/keys' # {:foo => :bar}.stringify_keys
+Hash.module_eval{include ActiveSupport::CoreExtensions::Hash::Keys}
+
+# Extensions
+require 'ext/object.rb'
+require 'ext/metaclass.rb'
+
+# Helpers
+require 'hashcache'
+require 'queued_logger'
+require 'tempster'
+require 'helpful_erb'
+require 'nested_error'
+
+# Core
+require 'automateit/root'
+require 'automateit/constants'
+require 'automateit/error'
+require 'automateit/common'
+require 'automateit/interpreter'
+require 'automateit/plugin'
+require 'automateit/cli'
+require 'automateit/project'
+
+# Plugins which must be loaded early
+require 'automateit/shell_manager'
+require 'automateit/platform_manager' # requires shell
+require 'automateit/address_manager' # requires shell
+require 'automateit/tag_manager' # requires address, platform
+require 'automateit/field_manager' # requires shell
+require 'automateit/service_manager' # requires shell
+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/account_manager.rb

@@ -3,6 +3,17 @@
 # The AccountManager provides a way of managing system accounts, such as Unix
 # users and groups.
 class AutomateIt::AccountManager < AutomateIt::Plugin::Manager
+  # Invalidate system cache for +database+. The +database+ can be either :users
+  # or :groups. This is necessary on operating systems that lack logic to
+  # notify their caching system that an entry changed. If the OS doesn't need
+  # invalidation, will do nothing and return false.
+  #
+  # This method is primarily for the sake of driver authors, recipe authors
+  # will probably never need to use this.
+  def invalidate(database) dispatch_safely(database) end
+
+  #-----------------------------------------------------------------------
+
   # Find a user account. Method returns a query helper which takes a
   # +username+ as an index argument and returns a Struct::Passwd entry as
   # described in Etc::getpwent if the user exists or a nil if not.
@@ -50,7 +61,7 @@ class AutomateIt::AccountManager < AutomateIt::Plugin::Manager
   def remove_groups_from_user(groups, user) dispatch(groups, user) end
 
   # Change the +password+ for the +user+.
-  def passwd(user, password) dispatch(user, password) end
+  def passwd(user, password, opts={}) dispatch(user, password, opts) end
 
   #.......................................................................
 
@@ -94,13 +105,10 @@ class AutomateIt::AccountManager < AutomateIt::Plugin::Manager
   def users_to_groups() dispatch() end
 end # class AccountManager
 
-# == AccountManager::BaseDriver
-#
-# Base class for all AccountManager drivers.
-class ::AutomateIt::AccountManager::BaseDriver < AutomateIt::Plugin::Driver
-end
-
 # Drivers
-require 'automateit/account_manager/portable'
-require 'automateit/account_manager/linux'
-require 'automateit/account_manager/passwd'
+require 'automateit/account_manager/base'
+require 'automateit/account_manager/passwd_pty'
+require 'automateit/account_manager/passwd_expect'
+require 'automateit/account_manager/nscd'
+require 'automateit/account_manager/etc'
+require 'automateit/account_manager/posix'

data/lib/automateit/account_manager/base.rb

@@ -0,0 +1,133 @@
+# == AccountManager::BaseDriver
+#
+# Base class for all AccountManager drivers.
+class ::AutomateIt::AccountManager::BaseDriver < ::AutomateIt::Plugin::Driver
+  protected
+
+  def _passwd_helper(user, password, opts={}, &block)
+    users = manager.users
+
+    unless users[user]
+      if preview?
+        log.info(PNOTE+"Setting password for user: #{user}")
+        return true
+      else
+        raise ArgumentError.new("No such user: #{user}")
+      end
+    end
+
+    case user
+    when Symbol: user = user.to_s
+    when Integer: user = users[user]
+    when String: # leave it alone
+    else raise TypeError.new("Unknown user type: #{user.class}")
+    end
+
+    return block.call(user, password, opts)
+  end
+
+  def _add_user_helper(username, opts={}, &block)
+    return false if has_user?(username)
+
+    # Create group first, then the user. Necessary because some OSes can't add users with non-existent groups.
+
+    if opts[:personal_group].nil? and not opts[:group] and not opts[:gid]
+      opts[:personal_group] = true
+    end
+
+    # FIXME how to default personal_group to false?
+    # FIXME what if want to add user to a specific group, rather than creating?
+    # FIXME what if want or not want to crease user group?
+    # FIXME how to find an unused gid/uid combo?
+
+    unless opts[:group] == false
+      groupname = opts[:group] || username
+      unless has_group?(groupname)
+        if not opts[:uid] and not opts[:gid] and group = add_group(groupname, opts)
+          opts[:uid] = opts[:gid] = group.gid
+        end
+      end
+    end
+
+    block.call(username, opts)
+
+    passwd_opts = {:quiet => opts[:quiet]}
+    manager.passwd(username, opts[:passwd], passwd_opts) if opts[:passwd]
+
+    manager.invalidate(:passwd)
+    return users[username]
+  end
+
+  def _remove_user_helper(username, opts={}, &block)
+    return false unless has_user?(username)
+
+    block.call(username, opts)
+    manager.invalidate(:passwd)
+    remove_group(username) if has_group?(username)
+
+    return true
+  end
+
+  def _add_groups_to_user_helper(groups, username, &block)
+    groups = [groups].flatten
+    present = groups_for_user(username)
+    missing = groups - present
+    return false if missing.empty?
+
+    block.call(missing, username)
+    manager.invalidate(:group)
+
+    return missing
+  end
+
+  def _remove_groups_from_user_helper(groups, username, &block)
+    groups = [groups].flatten
+    matched = groups_for_user(username)
+    present = groups & matched
+    return false if present.empty?
+
+    block.call(present, username)
+    manager.invalidate(:group)
+
+    return present
+  end
+
+  def _add_users_to_group_helper(users, groupname, &block)
+    users = [users].flatten
+    # XXX Include pwent.gid?
+    grent = groups[groupname]
+    missing = \
+      if writing? and not grent
+        raise ArgumentError.new("no such group: #{groupname}")
+      elsif writing? or grent
+        users - grent.mem
+      else
+        users
+      end
+    return false if missing.empty?
+
+    block.call(missing, groupname)
+    manager.invalidate(:groups)
+
+    return missing
+  end
+
+  def _remove_users_from_group_helper(users, groupname, &block)
+    users = [users].flatten
+    grent = groups[groupname]
+    present = \
+      if writing? and not grent
+        raise ArgumentError.new("no such group: #{groupname}")
+      elsif writing? or grent
+        grent.mem & users
+      else
+        users
+      end
+    return false if present.empty?
+
+    block.call(present, groupname)
+    manager.invalidate(:groups)
+
+    return present
+  end
+end

data/lib/automateit/account_manager/{portable.rb → etc.rb}

@@ -1,10 +1,11 @@
-# == AccountManager::Portable
+# == AccountManager::Etc
 #
-# A pure-Ruby, portable driver for the AccountManager. It is only suitable
-# for doing queries and lacks methods such as +add_user+. Platform-specific
-# drivers inherit from this class and provide these methods.
-class ::AutomateIt::AccountManager::Portable < ::AutomateIt::AccountManager::BaseDriver
-  depends_on :callbacks => [lambda{AutomateIt::AccountManager::Portable.has_etc?}]
+# An AccountManager driver for Unix-like OSes that have the Ruby Etc module. It
+# is only suitable for doing queries and lacks methods that perform
+# modifications, such as +add_user+. Platform-specific drivers inherit from
+# this class and provide methods that perform modifications.
+class ::AutomateIt::AccountManager::Etc< ::AutomateIt::AccountManager::BaseDriver
+  depends_on :callbacks => [lambda{AutomateIt::AccountManager::Etc.has_etc?}]
 
   def suitability(method, *args) # :nodoc:
     return 1
@@ -14,14 +15,14 @@ class ::AutomateIt::AccountManager::Portable < ::AutomateIt::AccountManager::Bas
   # the 'etc' module?
   def self.has_etc?
     begin
-      require 'etc'
+      require './spec/integration/account_manager_spec.rb:1etc'
       return defined?(Etc)
     rescue LoadError
       return false
     end
   end
   
-  # Alias for AccountManager::Portable.has_etc?
+  # Alias for AccountManager::Etc.has_etc?
   def has_etc?
     self.has_etc?
   end

data/lib/automateit/account_manager/nscd.rb

@@ -0,0 +1,28 @@
+# == AccountManager::NSCD
+#
+# AccountManager driver for invalidating records stored in the NSCD, Name
+# Service Cache Daemon, found on Unix-like systems.
+class ::AutomateIt::AccountManager::NSCD < ::AutomateIt::AccountManager::BaseDriver
+  depends_on :programs => %w(nscd ps), 
+    :callbacks => [lambda{`ps -ef`.match(%r{/usr/sbin/nscd$})}]
+
+  def suitability(method, *args) # :nodoc:
+    # Level must be higher than Portable
+    return available? ? 5 : 0
+  end
+
+  def invalidate(database)
+    return false unless available?
+
+    name = \
+      case database.to_sym
+      when :user, :users, :passwd
+        :passwd
+      when :group, :groups
+        :group
+      else
+        raise ArgumentError.new("Unknown cache database: #{database}")
+      end
+    interpreter.sh("nscd -i #{name}")
+  end
+end