etch 3.19.0 → 3.20.0

data/Rakefile

@@ -3,7 +3,7 @@ spec = Gem::Specification.new do |s|
   s.name	= 'etch'
   s.summary	= 'Etch system configuration management client'
   s.add_dependency('facter')
-  s.version = '3.19.0'
+  s.version = '3.20.0'
   s.author = 'Jason Heiss'
   s.email = 'etch-users@lists.sourceforge.net'
   s.homepage = 'http://etch.sourceforge.net'

data/bin/etch

@@ -1,13 +1,13 @@
-#!/usr/bin/ruby -w
+#!/usr/bin/ruby
 ##############################################################################
 # Etch configuration file management tool
 ##############################################################################
 
-# Ensure we can find etchclient.rb
-$:.unshift(File.dirname(__FILE__))
+# Ensure we can find etch/client.rb when run within the development repository
+$:.unshift(File.join(File.dirname(File.dirname(__FILE__)), 'lib'))
 
 require 'optparse'
-require 'etchclient'
+require 'etch/client'
 
 #
 # Parse the command line options
@@ -69,6 +69,12 @@ end
 opts.on('--key PRIVATE_KEY', 'Use this private key for signing messages to server.') do |opt|
   options[:key] = opt
 end
+opts.on('--configdir DIR', 'Directory containing etch.conf, defaults to /etc') do |opt|
+  options[:configdir] = opt
+end
+opts.on('--vardir DIR', 'Directory for etch state, defaults to /var/etch') do |opt|
+  options[:vardir] = opt
+end
 opts.on('--test-root TESTDIR', 'For use by the test suite only.') do |opt|
   options[:file_system_root] = opt
 end

data/bin/etch_cron_wrapper

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby -w
+#!/usr/bin/ruby
 
 require 'socket'
 require 'digest/sha1'

data/bin/etch_to_trunk

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby -w
+#!/usr/bin/ruby
 
 require 'nventory'
 require 'time'

data/lib/etch.rb

@@ -1,11 +1,17 @@
-require 'find'        # Find.find
-require 'pathname'    # absolute?
-require 'digest/sha1' # hexdigest
-require 'base64'      # decode64, encode64
-require 'fileutils'   # mkdir_p
-require 'erb'
+# Exclude standard libraries and gems from the warnings induced by
+# running ruby with the -w flag.  Several of these have warnings under
+# ruby 1.9 and there's nothing we can do to fix that.
+require 'silently'
+Silently.silently do
+  require 'find'        # Find.find
+  require 'pathname'    # absolute?
+  require 'digest/sha1' # hexdigest
+  require 'base64'      # decode64, encode64
+  require 'fileutils'   # mkdir_p
+  require 'erb'
+  require 'logger'
+end
 require 'versiontype' # Version
-require 'logger'
 
 class Etch
   def self.xmllib
@@ -16,27 +22,29 @@ class Etch
   end
 end
 
-# By default we try to use libxml, falling back to rexml if it is not
-# available.  The xmllib environment variable can be used to force one library
-# or the other, mostly for testing purposes.
-begin
-  if !ENV['xmllib'] || ENV['xmllib'] == 'libxml'
-    require 'rubygems'  # libxml is a gem
-    require 'libxml'
-    Etch.xmllib = :libxml
-  elsif ENV['xmllib'] == 'nokogiri'
-    require 'rubygems'  # nokogiri is a gem
-    require 'nokogiri'
-    Etch.xmllib = :nokogiri
-  else
-    raise LoadError
-  end
-rescue LoadError
-  if !ENV['xmllib'] || ENV['xmllib'] == 'rexml'
-    require 'rexml/document'
-    Etch.xmllib = :rexml
-  else
-    raise
+# By default we try to use nokogiri, falling back to rexml if it is not
+# available.  The xmllib environment variable can be used to force a specific
+# library, mostly for testing purposes.
+Silently.silently do
+  begin
+    if !ENV['xmllib'] || ENV['xmllib'] == 'nokogiri'
+      require 'rubygems'  # nokogiri is a gem
+      require 'nokogiri'
+      Etch.xmllib = :nokogiri
+    elsif ENV['xmllib'] == 'libxml'
+      require 'rubygems'  # libxml is a gem
+      require 'libxml'
+      Etch.xmllib = :libxml
+    else
+      raise LoadError
+    end
+  rescue LoadError
+    if !ENV['xmllib'] || ENV['xmllib'] == 'rexml'
+      require 'rexml/document'
+      Etch.xmllib = :rexml
+    else
+      raise
+    end
   end
 end
 
@@ -170,10 +178,12 @@ class Etch
     filelist = []
     if request.empty?
       @dlogger.debug "Building complete file list for request from #{@fqdn}"
-      Find.find(@sourcebase) do |path|
-        if File.directory?(path) && File.exist?(File.join(path, 'config.xml'))
-          # Strip @sourcebase from start of path
-          filelist << path.sub(Regexp.new('^' + Regexp.escape(@sourcebase)), '')
+      if File.exist?(@sourcebase)
+        Find.find(@sourcebase) do |path|
+          if File.directory?(path) && File.exist?(File.join(path, 'config.xml'))
+            # Strip @sourcebase from start of path
+            filelist << path.sub(Regexp.new('^' + Regexp.escape(@sourcebase)), '')
+          end
         end
       end
     elsif request[:files]
@@ -206,9 +216,11 @@ class Etch
     commandnames = []
     if request.empty?
       @dlogger.debug "Building complete configuration commands for request from #{@fqdn}"
-      Find.find(@commandsbase) do |path|
-        if File.directory?(path) && File.exist?(File.join(path, 'commands.xml'))
-          commandnames << File.basename(path)
+      if File.exist?(@commandsbase)
+        Find.find(@commandsbase) do |path|
+          if File.directory?(path) && File.exist?(File.join(path, 'commands.xml'))
+            commandnames << File.basename(path)
+          end
         end
       end
     elsif request[:commands]
@@ -363,7 +375,7 @@ class Etch
       
       # Change into the corresponding directory so that the user can
       # refer to source files and scripts by their relative pathnames.
-      Dir::chdir "#{@sourcebase}/#{file}"
+      Dir.chdir "#{@sourcebase}/#{file}"
 
       # See what type of action the user has requested
 
@@ -414,7 +426,7 @@ class Etch
         
           # Just slurp the file in
           plain_file = Etch.xmltext(plain_elements.first)
-          newcontents = IO::read(plain_file)
+          newcontents = IO.read(plain_file)
         elsif Etch.xmlfindfirst(config_xml, '/config/file/source/template')
           template_elements = Etch.xmlarray(config_xml, '/config/file/source/template')
           if check_for_inconsistency(template_elements)
@@ -913,7 +925,7 @@ class Etch
       
       # Change into the corresponding directory so that the user can
       # refer to source files and scripts by their relative pathnames.
-      Dir::chdir "#{@commandsbase}/#{command}"
+      Dir.chdir "#{@commandsbase}/#{command}"
       
       # Check that the resulting document is consistent after filtering
       remove = []
@@ -1360,7 +1372,7 @@ class Etch
     when :nokogiri
       destelem << elem.dup
     when :rexml
-      destelem.add_element(elem.clone)
+      destelem.add_element(elem.deep_clone)
     else
       raise "Unknown XML library #{Etch.xmllib}"
     end

data/lib/{etchclient.rb → etch/client.rb}

@@ -3,46 +3,53 @@
 ##############################################################################
 
 # Ensure we can find etch.rb if run within the development directory structure
-#   This is roughly equivalent to "../server/lib"
-serverlibdir = File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'server', 'lib')
+#   This is roughly equivalent to "../../../server/lib"
+serverlibdir = File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'server', 'lib')
 if File.exist?(serverlibdir)
   $:.unshift(serverlibdir)
 end
 
-begin
-  # Try loading facter w/o gems first so that we don't introduce a
-  # dependency on gems if it is not needed.
-  require 'facter'    # Facter
-rescue LoadError
-  require 'rubygems'
-  require 'facter'
+# Exclude standard libraries and gems from the warnings induced by
+# running ruby with the -w flag.  Several of these have warnings under
+# ruby 1.9 and there's nothing we can do to fix that.
+require 'silently'
+Silently.silently do
+  begin
+    # Try loading facter w/o gems first so that we don't introduce a
+    # dependency on gems if it is not needed.
+    require 'facter'    # Facter
+  rescue LoadError
+    require 'rubygems'
+    require 'facter'
+  end
+  require 'find'
+  require 'digest/sha1' # hexdigest
+  require 'openssl'     # OpenSSL
+  require 'base64'      # decode64, encode64
+  require 'uri'
+  require 'net/http'
+  require 'net/https'
+  require 'rexml/document'
+  require 'fileutils'   # copy, mkpath, rmtree
+  require 'fcntl'       # Fcntl::O_*
+  require 'etc'         # getpwnam, getgrnam
+  require 'tempfile'    # Tempfile
+  require 'find'        # Find.find
+  require 'cgi'
+  require 'timeout'
+  require 'logger'
 end
-require 'find'
-require 'digest/sha1' # hexdigest
-require 'openssl'     # OpenSSL
-require 'base64'      # decode64, encode64
-require 'uri'
-require 'net/http'
-require 'net/https'
-require 'rexml/document'
-require 'fileutils'   # copy, mkpath, rmtree
-require 'fcntl'       # Fcntl::O_*
-require 'etc'         # getpwnam, getgrnam
-require 'tempfile'    # Tempfile
-require 'cgi'
-require 'timeout'
-require 'logger'
 require 'etch'
 
 class Etch::Client
-  VERSION = '3.19.0'
+  VERSION = '3.20.0'
   
   CONFIRM_PROCEED = 1
   CONFIRM_SKIP = 2
   CONFIRM_QUIT = 3
   PRIVATE_KEY_PATHS = ["/etc/ssh/ssh_host_rsa_key", "/etc/ssh_host_rsa_key"]
   DEFAULT_CONFIGDIR = '/etc'
-  DEFAULT_VARBASE = '/var/etch'
+  DEFAULT_VARDIR = '/var/etch'
   DEFAULT_DETAILED_RESULTS = ['SERVER']
   
   # We need these in relation to the output capturing
@@ -53,6 +60,8 @@ class Etch::Client
   
   def initialize(options)
     @server = options[:server] ? options[:server] : 'https://etch'
+    @configdir = options[:configdir] ? options[:configdir] : DEFAULT_CONFIGDIR
+    @vardir = options[:vardir] ? options[:vardir] : DEFAULT_VARDIR
     @tag = options[:tag]
     @local = options[:local] ? File.expand_path(options[:local]) : nil
     @debug = options[:debug]
@@ -64,17 +73,14 @@ class Etch::Client
     @key = options[:key] ? options[:key] : get_private_key_path
     @disableforce = options[:disableforce]
     @lockforce = options[:lockforce]
-
-    @last_response = ""
     
-    @configdir = DEFAULT_CONFIGDIR
-    @varbase = DEFAULT_VARBASE
+    @last_response = ""
     
     @file_system_root = '/'  # Not sure if this needs to be more portable
     # This option is only intended for use by the test suite
     if options[:file_system_root]
       @file_system_root = options[:file_system_root]
-      @varbase = File.join(@file_system_root, @varbase)
+      @vardir = File.join(@file_system_root, @vardir)
       @configdir = File.join(@file_system_root, @configdir)
     end
     
@@ -142,10 +148,10 @@ class Etch::Client
       @detailed_results = DEFAULT_DETAILED_RESULTS
     end
     
-    @origbase    = File.join(@varbase, 'orig')
-    @historybase = File.join(@varbase, 'history')
-    @lockbase    = File.join(@varbase, 'locks')
-    @requestbase = File.join(@varbase, 'requests')
+    @origbase    = File.join(@vardir, 'orig')
+    @historybase = File.join(@vardir, 'history')
+    @lockbase    = File.join(@vardir, 'locks')
+    @requestbase = File.join(@vardir, 'requests')
     
     @facts = Facter.to_hash
     if @facts['operatingsystemrelease']
@@ -163,6 +169,10 @@ class Etch::Client
       else
         dlogger.level = Logger::INFO
       end
+      blankrequest = {}
+      @facts.each_pair { |key, value| blankrequest[key] = value.to_s }
+      blankrequest['fqdn'] = @facts['fqdn']
+      @facts = blankrequest
       @etch = Etch.new(logger, dlogger)
     else
       # Make sure the server URL ends in a / so that we can append paths
@@ -215,6 +225,7 @@ class Etch::Client
     # Prep http instance
     http = nil
     if !@local
+      puts "Connecting to #{@filesuri}" if (@debug)
       http = Net::HTTP.new(@filesuri.host, @filesuri.port)
       if @filesuri.scheme == "https"
         # Eliminate the OpenSSL "using default DH parameters" warning
@@ -565,7 +576,7 @@ class Etch::Client
   end
 
   def check_for_disable_etch_file
-    disable_etch = File.join(@varbase, 'disable_etch')
+    disable_etch = File.join(@vardir, 'disable_etch')
     message = ''
     if File.exist?(disable_etch)
       if !@disableforce
@@ -1803,7 +1814,7 @@ class Etch::Client
           puts "Original file #{file} doesn't exist, saving that state permanently as #{origpath}"
         end
         if proceed
-          File.open(origpath, 'w') { |file| } if (!@dryrun)
+          File.open(origpath, 'w') { |origfile| } if (!@dryrun)
         end
       end
 
@@ -2014,7 +2025,7 @@ class Etch::Client
       else
         # If there's no file to back up then leave a marker file so
         # that restore_backup does the right thing
-        File.open("#{backuppath}.NOORIG", "w") { |file| }
+        File.open("#{backuppath}.NOORIG", "w") { |markerfile| }
       end
     end
 
@@ -2375,7 +2386,7 @@ class Etch::Client
       begin
         fd = IO::sysopen(lockpath, Fcntl::O_WRONLY|Fcntl::O_CREAT|Fcntl::O_EXCL)
         puts "Lock acquired for #{file}" if (@debug)
-        f = IO.open(fd) { |f| f.puts $$ }
+        f = IO.open(fd) { |lockfile| lockfile.puts $$ }
         @locked_files[file] = true
         return
       rescue Errno::EEXIST
@@ -2420,13 +2431,15 @@ class Etch::Client
   # and can be removed.  If told to force we remove all lockfiles.
   def remove_stale_lock_files
     twohoursago = Time.at(Time.now - 60 * 60 * 2)
-    Find.find(@lockbase) do |file|
-      next unless file =~ /\.LOCK$/
-      next unless File.file?(file)
-
-      if @lockforce || File.mtime(file) < twohoursago
-        puts "Removing stale lock file #{file}"
-        File.delete(file)
+    if File.exist?(@lockbase)
+      Find.find(@lockbase) do |file|
+        next unless file =~ /\.LOCK$/
+        next unless File.file?(file)
+        
+        if @lockforce || File.mtime(file) < twohoursago
+          puts "Removing stale lock file #{file}"
+          File.delete(file)
+        end
       end
     end
   end
@@ -2439,6 +2452,8 @@ class Etch::Client
   # for etch to handle any given file, including running any
   # setup/pre/post commands.
   OUTPUT_CAPTURE_TIMEOUT = 5 * 60
+  # In interactive mode bump the timeout up to something absurdly large
+  OUTPUT_CAPTURE_INTERACTIVE_TIMEOUT = 14 * 24 * 60 * 60
   def start_output_capture
     # Establish a pipe, spawn a child process, and redirect stdout/stderr
     # to the pipe.  The child gathers up anything sent over the pipe and
@@ -2490,7 +2505,13 @@ class Etch::Client
           # capturing feature this results in etch hanging around forever
           # waiting for the pipes to close. We time out after a suitable
           # period of time so that etch processes don't hang around forever.
-          Timeout.timeout(OUTPUT_CAPTURE_TIMEOUT) do
+          timeout = nil
+          if @interactive
+            timeout = OUTPUT_CAPTURE_INTERACTIVE_TIMEOUT
+          else
+            timeout = OUTPUT_CAPTURE_TIMEOUT
+          end
+          Timeout.timeout(timeout) do
             while char = pread.getc
               putc(char)
               output << char.chr

data/lib/silently.rb

@@ -0,0 +1,11 @@
+# http://www.caliban.org/ruby/rubyguide.shtml#warnings
+class Silently
+  def self.silently(&block)
+    warn_level = $VERBOSE
+    $VERBOSE = nil
+    result = block.call
+    $VERBOSE = warn_level
+    result
+  end
+end
+

metadata

@@ -1,72 +1,66 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: etch
-version: !ruby/object:Gem::Version 
-  version: 3.19.0
+version: !ruby/object:Gem::Version
+  version: 3.20.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Jason Heiss
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-12 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: facter
+  requirement: &70362060167060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+  prerelease: false
+  version_requirements: *70362060167060
 description: 
 email: etch-users@lists.sourceforge.net
-executables: 
+executables:
 - etch
 - etch_to_trunk
 - etch_cron_wrapper
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - bin/etch
 - bin/etch_cron_wrapper
 - bin/etch_to_trunk
+- lib/etch/client.rb
 - lib/etch.rb
-- lib/etchclient.rb
+- lib/silently.rb
 - lib/versiontype.rb
 - Rakefile
-has_rdoc: true
 homepage: http://etch.sourceforge.net
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "1.8"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.8'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: etchsyscm
-rubygems_version: 1.3.5
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Etch system configuration management client
 test_files: []
-