etch 3.16.0 → 3.17.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.16.0'
+  s.version = '3.17.0'
   s.author = 'Jason Heiss'
   s.email = 'etch-users@lists.sourceforge.net'
   s.homepage = 'http://etch.sourceforge.net'

data/bin/etch

@@ -16,6 +16,9 @@ require 'etchclient'
 options = {}
 @generateall = nil
 
+# Extra options to OptionParser reduce the amount of whitespace it introduces
+# into the help message, making it easier to make the help message fit in a
+# 80x24 window.
 opts = OptionParser.new(nil, 24, '  ')
 opts.banner = 'Usage: etch [options] [/path/to/config/file | command] [otherfile ...]'
 opts.on('--generate-all', 'Request all configuration.') do |opt|
@@ -59,8 +62,8 @@ end
 opts.on('--key PRIVATE_KEY', 'Use this private key for signing messages to server.') do |opt|
   options[:key] = opt
 end
-opts.on('--test-base TESTDIR', 'Use an alternate local working directory.') do |opt|
-  options[:varbase] = opt
+opts.on('--test-root TESTDIR', 'For use by the test suite only.') do |opt|
+  options[:file_system_root] = opt
 end
 opts.on('--debug', 'Print lots of messages about what etch is doing.') do |opt|
   options[:debug] = opt

data/bin/etch_to_trunk

@@ -1,21 +1,45 @@
 #!/usr/bin/ruby -w
 
 require 'nventory'
+require 'time'
+require 'optparse'
 
-@username = ENV['LOGNAME']
+ETCH_SERVER_TZ = 'UTC'    # The etch servers run in UTC
+
+options = {}
+opts = OptionParser.new
+opts.banner = 'Usage: etch_to_trunk [options] <server1> [<server2> <server3>]'
+opts.on('-u', '--username USERNAME', 'Username for connecting to nventory server.') do |opt|
+  options[:username] = opt
+end 
+opts.on('-t', '--timezone TIMEZONE', 'Time zone of etch server.') do |opt|
+  options[:timezone] = opt
+end 
+opts.on_tail('-h', '--help', 'Show this message.') do
+  puts opts
+  exit
+end
+
+nodes = opts.parse(ARGV)
 
 if ARGV.length == 0
-  abort "Usage: #{File.basename($0)} <server1> [<server2> <server3>]"
+  puts opts
+  exit
 end
 
-# The etch servers run in UTC
-ENV['TZ'] = 'UTC'
-currentheadtag = Time.now.strftime('trunk-%Y%m%d-%H00')
+@username = options[:username] || ENV['LOGNAME']
+etch_server_tz = options[:timezone] || ETCH_SERVER_TZ
+
+if etch_server_tz
+  currentheadtag = Time.at(Time.now.utc + Time.zone_offset(etch_server_tz)).strftime('trunk-%Y%m%d-%H00')
+else  # if no timezone is specified then just use local time for the tag 
+  currentheadtag = Time.now.strftime('trunk-%Y%m%d-%H00')
+end
 
 # Find the requested clients
 nvclient = NVentory::Client.new
-results = nvclient.get_objects('nodes', {}, { 'name' => ARGV }, {}, {})
-ARGV.each do |name|
+results = nvclient.get_objects('nodes', {}, { 'name' => nodes }, {}, {})
+nodes.each do |name|
   if results.empty? && results[name].nil?
     abort "No entry found for #{name}"
   else

data/lib/etchclient.rb

@@ -35,13 +35,14 @@ require 'logger'
 require 'etch'
 
 class Etch::Client
-  VERSION = '3.16.0'
+  VERSION = '3.17.0'
   
   CONFIRM_PROCEED = 1
   CONFIRM_SKIP = 2
   CONFIRM_QUIT = 3
   PRIVATE_KEY_PATHS = ["/etc/ssh/ssh_host_rsa_key", "/etc/ssh_host_rsa_key"]
-  CONFIGDIR = '/etc'
+  DEFAULT_CONFIGDIR = '/etc'
+  DEFAULT_VARBASE = '/var/etch'
   
   # We need these in relation to the output capturing
   ORIG_STDOUT = STDOUT.dup
@@ -52,7 +53,6 @@ class Etch::Client
   def initialize(options)
     @server = options[:server] ? options[:server] : 'https://etch'
     @tag = options[:tag]
-    @varbase = options[:varbase] ? options[:varbase] : '/var/etch'
     @local = options[:local] ? File.expand_path(options[:local]) : nil
     @debug = options[:debug]
     @dryrun = options[:dryrun]
@@ -63,10 +63,72 @@ class Etch::Client
     @disableforce = options[:disableforce]
     @lockforce = options[:lockforce]
     
-    # Ensure we have a sane path, particularly since we are often run from
-    # cron.
-    # FIXME: Read from config file
-    ENV['PATH'] = '/bin:/usr/bin:/sbin:/usr/sbin:/opt/csw/bin:/opt/csw/sbin'
+    @configdir = DEFAULT_CONFIGDIR
+    @varbase = DEFAULT_VARBASE
+    
+    @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)
+      @configdir = File.join(@file_system_root, @configdir)
+    end
+    
+    @configfile = File.join(@configdir, 'etch.conf')
+    
+    if File.exist?(@configfile)
+      IO.foreach(@configfile) do |line|
+        line.chomp!
+        next if (line =~ /^\s*$/);  # Skip blank lines
+        next if (line =~ /^\s*#/);  # Skip comments
+        line.strip!  # Remove leading/trailing whitespace
+        key, value = line.split(/\s*=\s*/, 2)
+        if key == 'server'
+          # A setting for the server to use which comes from upstream
+          # (generally from a command line option) takes precedence
+          # over the config file
+          if !options[:server]
+            @server = value
+            # Warn the user, as this could potentially be confusing
+            # if they don't realize there's a config file lying
+            # around
+            warn "Using server #{@server} from #{@configfile}" if @debug
+          else
+            # "command line override" isn't necessarily accurate, we don't
+            # know why the caller passed us an option to override the config
+            # file, but most of the time it will be due to a command line
+            # option and I want the message to be easily understood by users. 
+            # If someone can come up with some better wording without turning
+            # the message into something as long as this comment that would be
+            # welcome.
+            warn "Ignoring 'server' option in #{@configfile} due to command line override" if @debug
+          end
+        elsif key == 'local'
+          if !options[:local] && !options[:server]
+            @local = value
+            warn "Using local directory #{@local} from #{@configfile}" if @debug
+          else
+            warn "Ignoring 'local' option in #{@configfile} due to command line override" if @debug
+          end
+        elsif key == 'key'
+          if !options[:key]
+            @key = value
+            warn "Using key #{@key} from #{@configfile}" if @debug
+          else
+            warn "Ignoring 'key' option in #{@configfile} due to command line override" if @debug
+          end
+        elsif key == 'path'
+          ENV['PATH'] = value
+        end
+      end
+    end
+    
+    if @key && !File.readable?(@key)
+      @key = nil
+    end
+    if !@key
+      warn "No readable private key found, messages to server will not be signed and may be rejected depending on server configuration"
+    end
     
     @origbase    = File.join(@varbase, 'orig')
     @historybase = File.join(@varbase, 'history')
@@ -141,17 +203,17 @@ class Etch::Client
       http = Net::HTTP.new(@filesuri.host, @filesuri.port)
       if @filesuri.scheme == "https"
         # Eliminate the OpenSSL "using default DH parameters" warning
-        if File.exist?(File.join(CONFIGDIR, 'etch', 'dhparams'))
-          dh = OpenSSL::PKey::DH.new(IO.read(File.join(CONFIGDIR, 'etch', 'dhparams')))
+        if File.exist?(File.join(@configdir, 'etch', 'dhparams'))
+          dh = OpenSSL::PKey::DH.new(IO.read(File.join(@configdir, 'etch', 'dhparams')))
           Net::HTTP.ssl_context_accessor(:tmp_dh_callback)
           http.tmp_dh_callback = proc { dh }
         end
         http.use_ssl = true
-        if File.exist?(File.join(CONFIGDIR, 'etch', 'ca.pem'))
-          http.ca_file = File.join(CONFIGDIR, 'etch', 'ca.pem')
+        if File.exist?(File.join(@configdir, 'etch', 'ca.pem'))
+          http.ca_file = File.join(@configdir, 'etch', 'ca.pem')
           http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-        elsif File.directory?(File.join(CONFIGDIR, 'etch', 'ca'))
-          http.ca_path = File.join(CONFIGDIR, 'etch', 'ca')
+        elsif File.directory?(File.join(@configdir, 'etch', 'ca'))
+          http.ca_path = File.join(@configdir, 'etch', 'ca')
           http.verify_mode = OpenSSL::SSL::VERIFY_PEER
         end
       end
@@ -2409,9 +2471,6 @@ class Etch::Client
         break
       end
     end
-    if !key
-      warn "No readable private key found, messages to server will not be signed and may be rejected depending on server configuration"
-    end
     key
   end
   

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: etch
 version: !ruby/object:Gem::Version 
-  version: 3.16.0
+  hash: 67
+  prerelease: false
+  segments: 
+  - 3
+  - 17
+  - 0
+  version: 3.17.0
 platform: ruby
 authors: 
 - Jason Heiss
@@ -9,19 +15,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-12 00:00:00 -07:00
+date: 2010-12-22 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: facter
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: 
 email: etch-users@lists.sourceforge.net
 executables: 
@@ -50,21 +60,28 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 31
+      segments: 
+      - 1
+      - 8
       version: "1.8"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: etchsyscm
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Etch system configuration management client