rv 2.9 → 2.99

data/CHANGELOG

@@ -1,5 +1,5 @@
 
-v2.9. Gem'd; RDoc documentation; automated setup scripts; cluster support.
+v2.99. Gem'd; RDoc documentation; automated setup scripts; cluster support. Incompatible changes. Pre-release. 
 
 v2. Mongrel static directory handler.
 

data/Manifest

@@ -1,6 +1,7 @@
 lib/rv_harness.rb
 lib/rv.rb
 bin/rv
+TODO
 Rakefile
 README
 Manifest

data/README

@@ -22,10 +22,10 @@ First, run:
   sudo gem install rv
   sudo rv install
   
-Now you have a file <tt>/etc/init.d/rv</tt>. Open it and change the <tt>'user'</tt> keypair in the file if your app user is not <tt>httpd</tt>. There are a few other options you can set; see the Rv class for details.
+This copies a very small script to <tt>/etc/init.d/rv</tt>. <b>Edit it and change the <tt>'user'</tt> keypair in the file if your app user is not <tt>httpd</tt>.</b> There are a few other options you can set; see the Rv class for details.
 
 Now, install it as a boot service. On Ubuntu, run:
-  sudo /usr/sbin/update-rc.d /etc/init.d/rv defaults
+  sudo /usr/sbin/update-rc.d rv defaults
 
 On Gentoo, run:
   sudo rc-update add rv default
@@ -37,8 +37,15 @@ Each Camping app should live in its own directory. Traverse to this directory an
 
 It will now start at boot. You can start it manually (along with your other Rv apps) by running:
   sudo /etc/init.d/rv start
+  
+The script also responds to <tt>status</tt>, <tt>restart</tt>, and <tt>stop</tt>.
+
+== Troubleshooting
 
-Check <tt>/var/log/rv.log</tt> as well as the application log if you're having problems.
+If you're having problems, run:
+  RV_DEBUG=true sudo /etc/init.d/rv start
+  
+Copy out the inner command (between the '<tt>nohup su -c "</tt>' and the first '<tt>< /dev/null...</tt>') and try running it by hand. Make sure you're using the correct user. You can also check <tt>/var/log/rv.log</tt> as well as the application log.
 
 == Apache configuration
 

data/TODO

@@ -0,0 +1,4 @@
+
+* Move database and app-specific configuration into YAML settings, and use a global rv_handler (?)
+* Move initial install task into an extconf.rb gem install hook (?)
+* Verify Gentoo support 

data/bin/rv

@@ -1,8 +1,11 @@
 #!/usr/bin/env ruby
 
 =begin rdoc
-Executable for running Rv. Accepts <tt>start</tt>, <tt>restart</tt>, <tt>stop</tt>, <tt>status</tt>, <tt>setup</tt> and 
-<tt>install</tt> as valid action parameters.
+Executable for running Rv. 
+
+Accepts <tt>start</tt>, <tt>restart</tt>, <tt>stop</tt>, <tt>status</tt>, <tt>setup</tt> and <tt>install</tt> as command-line parameters.
+
+See the Rv class for a list options which can be passed to Rv.new, below.
 =end
 
 require 'rubygems'

data/lib/rv.rb

@@ -3,14 +3,25 @@ require 'yaml'
 require 'ftools'
 require 'highline/import'
 
-# This class implements all the functionality of Rv. You shouldn't need to use this class directly, rather, use the <tt>rv</tt> executable.
+=begin rdoc
+This class implements all the functionality of Rv. You shouldn't need to use this class directly, rather, use the <tt>rv</tt> executable. However, you may want to override some of the keys in the DEFAULT hash by passing them to Rv.new in the executable. 
+
+Available keys are:
+* <tt>'conf_dir'</tt> - the directory of the YAML configuration files.
+* <tt>'user'</tt> - the system user used to start the apps.
+* <tt>'max_tries'</tt> - the number of retries before giving up on an app (each try takes a half second).
+* <tt>'log'</tt> - the path to Rv's own logfile.
+* <tt>'ruby'</tt> - a string used to start the Ruby interpreter.
+
+=end
+
 class Rv
 
   class << self
   
     # Get an Rv parameter from the process environment variables.
-    def env(key)
-      value = ENV["#{RV}_#{key.upcase}"]
+    def env(key) #:nodoc:
+      value = ENV["RV_#{key.upcase}"]
       raise "Rv key #{key} not found" unless value
       
       if value == value.to_i.to_s 
@@ -21,14 +32,14 @@ class Rv
     end
     
     # Turn an underscored name into a class reference.
-    def classify(string)
+    def classify(string) #:nodoc:
       eval("::" + string.split("_").map do |word| 
         word.capitalize
       end.join)
     end
     
     # Get the canonical pid_file name.
-    def pid_file(app = nil, port = nil)
+    def pid_file(app = nil, port = nil) #:nodoc:
       "#{app || env('app')}.#{port || env('port')}.pid"
     end
     
@@ -37,12 +48,11 @@ class Rv
   DEFAULTS = {
     'user' => 'httpd',
     'ruby' => '/usr/bin/env ruby',
-    'pidfile' => 'application.pid',
     'conf_dir' => '/etc/rv', 
-    'harness' => 'rv_harness.rb',
     'log' => '/var/log/rv.log',
-    'null_stream' => "< /dev/null > /dev/null 2>&1",
-    'log_stream' => "< /dev/null >> 'log' 2>&1"
+    'null_stream' => '< /dev/null > /dev/null 2>&1',
+    'log_stream' => '< /dev/null >> #{LOG} 2>&1',
+    'max_tries' => 10
   }
   
   VALID_ACTIONS = ['start', 'restart', 'stop', 'status', 'setup', 'install']
@@ -55,7 +65,7 @@ class Rv
     raise "Invalid options #{extra_keys.join(', ')}" if extra_keys.any?    
 
     @options = DEFAULTS.merge(opts)
-    options['log_stream'].sub!("log", options['log'])
+    options['log_stream'].sub!('#{LOG}', options['log'])
     
     # make sure the log exists
     begin 
@@ -89,6 +99,8 @@ class Rv
     
   end
   
+  private
+  
   # Runs a daemon action. Only called from <tt>perform</tt>.
   def daemon(action, match)
     filenames = Dir["#{options['conf_dir']}/#{match}.yml"]
@@ -107,8 +119,8 @@ class Rv
           config = real_config.dup
           @port = config['port'] += cluster_index
 
-          pidfile = Rv.pid_file(config['app'], config['port'])  
-          pid = File.open(pidfile).readlines.first.chomp rescue nil
+          pid_file = Rv.pid_file(config['app'], config['port'])  
+          pid = File.open(pid_file).readlines.first.chomp rescue nil
           running = pid ? `ps -p #{pid}`.split("\n")[1] : nil
          
           case action         
@@ -127,20 +139,27 @@ class Rv
                 note "stopped"
               elsif pid
                 note "not running"
-                File.delete pidfile            
+                File.delete pid_file            
               else
-                note "pid file #{pidfile.inspect} not found. Application was probably not running."
+                note "pid file #{pid_file.inspect} not found. Application was probably not running."
               end
             when "start"
               unless running 
                 env_variables = config.map {|key, value| "RV_#{key.upcase}=#{value}"}.join(" ")
                 system %[nohup su -c "#{env_variables} #{options['ruby']} #{options['harness']} #{options['null_stream']}" #{options['user']} #{options['log_stream']} &]
-                sleep(2)
-                if File.exist? pidfile
-                  note "started"
-                else
+                
+                # wait for the app to initialize
+                tries = 0
+                begin
+                  sleep(0.5)
+                  tries += 1
+                end while tries < options['max_tries'] and !File.exist?(pid_file)
+                if File.exist?(pid_file)
+                  note "started" 
+                else 
                   note "failed to start"
                 end
+                
               else
                 note "already running"
               end
@@ -158,11 +177,13 @@ class Rv
     harness_source = "#{File.dirname(__FILE__)}/rv_harness.rb"
     harness_target = "#{this_dir}/rv_harness.rb"
 
-    unless File.exist? harness_target
+    if !File.exist?(harness_target) or
+        (File.open(harness_target).readlines[2] != File.open(harness_source).readlines[2] and
+        agree("rv_harness.rb is out-of-date; overwrite? "))
       puts "Installing rv_harness.rb file."
       File.copy harness_source, harness_target
     else
-      puts "rv_harness.rb already installed."
+      puts "rv_harness.rb not changed."
     end
     
     defaults = {
@@ -212,7 +233,7 @@ class Rv
       exit_with "Couldn't write to '#{options['conf_dir']}'. Please rerun with 'sudo'."
     end
     
-    exit_with "All done. Please double-check the database configuration in '#{harness_target}'; then run 'sudo rv start'."
+    exit_with "All done. Please double-check the database configuration in 'rv_harness.rb';\nthen run 'sudo /etc/init.d/rv start'."
   end
   
   # Installs the 'rv' executable into /etc/init.d.
@@ -221,6 +242,7 @@ class Rv
     bin_target = "/etc/init.d/rv"
     begin
       File.copy bin_source, bin_target
+      system("chmod u+x #{bin_target}")
     rescue Errno::EACCES
       exit_with "Couldn't write to '#{bin_target}'. Please rerun with 'sudo'."
     end
@@ -238,5 +260,10 @@ class Rv
     puts "  #{msg.capitalize} (#{@port})"
   end
   
+  # system() with debugging output
+  def system(string)
+    $stderr.puts string if ENV['RV_DEBUG']
+    super
+  end
   
 end

data/lib/rv_harness.rb

@@ -1,5 +1,6 @@
 
-# Mongrel harness for Camping apps with Rv.
+# Mongrel harness for Camping apps with Rv. 
+# Version 3
 
 require 'rubygems'
 require 'mongrel'

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: rv
 version: !ruby/object:Gem::Version 
-  version: "2.9"
+  version: "2.99"
 date: 2007-08-06 00:00:00 -04:00
 summary: A little init.d system for running Camping apps.
 require_paths: 
@@ -11,7 +11,7 @@ require_paths:
 email: ""
 homepage: http://blog.evanweaver.com/pages/code#rv
 rubyforge_project: fauna
-description: ""
+description: A little init.d system for running Camping apps.
 autorequire: 
 default_executable: 
 bindir: bin
@@ -32,6 +32,7 @@ files:
 - lib/rv_harness.rb
 - lib/rv.rb
 - bin/rv
+- TODO
 - Rakefile
 - README
 - Manifest