seesaw 0.1.0

data/History.txt

@@ -0,0 +1,5 @@
+== 0.1.0 / 2007-08-18
+
+* 1 major enhancement
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/seesaw
+lib/seesaw/init.rb
+lib/seesaw/mongrel_cluster_patch.rb
+test/test_seesaw.rb

data/README.txt

@@ -0,0 +1,48 @@
+seesaw
+    by Matt Allen and Max Muermann
+    (http://rubyforge.org/projects/rails-oceania)
+
+== DESCRIPTION:
+  
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+  
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+sudo gem install seesaw
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 FIX
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/seesaw/init.rb'
+
+Hoe.new('seesaw', Seesaw::VERSION) do |p|
+  p.rubyforge_name = 'seesaw'
+  p.author = 'Matt Allen, Max Muermann'
+  p.email = 'max@muermann.org'
+  p.summary = 'Ripple-restart a mongrel cluster with no downtime'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps << ['gem_plugin', '>= 0.2.2'] << ['mongrel', '>= 1.0.1'] << ['mongrel_cluster', '>= 1.0.2']
+  p.spec_extras['autorequire'] = 'seesaw/init.rb'
+end
+
+# vim: syntax=Ruby

data/lib/seesaw/init.rb

@@ -0,0 +1,107 @@
+require 'gem_plugin'
+require 'mongrel'
+require 'yaml'
+require 'fileutils'
+require 'seesaw/mongrel_cluster_patch'
+
+module Seesaw
+  VERSION = '0.1.0'
+  
+  module CommandBase
+    def symlink(cluster)
+      p "symlink to #{cluster}"
+      file = File.join(@config_path, @config_files[cluster])
+      p "target: #{file}"
+      FileUtils.ln_sf( file, @config_symlink)
+    end
+    
+    def restart_mongrels(cluster=nil)
+      p "restart mongrels #{cluster}"
+      stop_mongrels(cluster)
+      start_mongrels(cluster)
+    end
+    
+    def start_mongrels(cluster=nil)
+      p "start mongrels #{cluster}"
+      cmd = "mongrel_rails seesaw::start"
+      cmd << " --cluster #{cluster}" if cluster
+      system(cmd)
+    end
+
+    def stop_mongrels(cluster=nil)
+      p "stop mongrels #{cluster}"
+      cmd = "mongrel_rails seesaw::stop"
+      cmd << " --cluster #{cluster}" if cluster
+      system(cmd)
+    end
+    
+    def restart_http(cluster=nil)
+      p "nginx restart"
+      system(@restart_cmd)
+      sleep 5
+    end    
+    
+    def shutdown_half_cluster(half)
+      p "shutdown half #{half}"
+      other_half = half == 1 ? 2 : 1
+      symlink(other_half)
+      restart_http
+      stop_mongrels(half)
+    end
+    
+    def switch_to_half_cluster(half)
+      p "switch_to_half_cluster #{half}"
+      other_half = half == 1 ? 2 : 1
+      shutdown_half_cluster(other_half)
+      start_mongrels(other_half)
+    end
+    
+    def start_cluster
+      p "start cluster"
+      symlink("all")
+      restart_http
+    end
+
+    def parse_options
+      @options = YAML.load(File.read(@config_file))
+      @config_path = @options["config_path"] || "/opt/local/etc/apache"
+      @config_files = @options["config_files"] || {}
+      @config_files[1] ||= "cluster_1.conf"
+      @config_files[2] ||= "cluster_2.conf"
+      @config_files["all"] ||= "cluster_all.conf"
+      @config_symlink = @options["config_symlink"] || "cluster.conf"
+      @config_symlink = File.join(@config_path, @config_symlink)
+      @restart_cmd = @options["restart_cmd"] || "apachectl graceful"
+    end
+    
+    def validate
+      valid_exists?(@config_file, "Configuration file does not exist. Run mongrel_rails seesaw::configure.")
+      return @valid
+    end
+    
+    def configure
+      options [
+       ['-C', '--config PATH', "Path to cluster configuration file", :@config_file, "config/seesaw.yml"],
+      ]
+    end
+    
+  end
+  
+  class Migrate < GemPlugin::Plugin "/commands"
+    include Mongrel::Command::Base
+    include CommandBase
+    
+    def run
+      parse_options
+      p "c1"
+      switch_to_half_cluster(1)
+      p "c2"
+      switch_to_half_cluster(2)
+      p "nighty night"
+      sleep 20
+      p "all"
+      start_cluster
+      p "done"
+    end      
+  end  
+end

data/lib/seesaw/mongrel_cluster_patch.rb

@@ -0,0 +1,368 @@
+require 'gem_plugin'
+require 'mongrel'
+require 'yaml'
+require 'enumerator'
+
+module Seesaw
+  module ExecBase
+    include Mongrel::Command::Base
+      
+    STATUS_OK = 0
+    STATUS_ERROR = 2
+    
+    def validate
+      valid_exists?(@config_file, "Configuration file does not exist. Run mongrel_rails cluster::configure.")
+      return @valid
+    end
+      
+    def read_options
+      @options = { 
+        "environment" => ENV['RAILS_ENV'] || "development",
+        "port" => 3000,
+        "pid_file" => "tmp/pids/mongrel.pid",
+        "log_file" => "log/mongrel.log",
+        "servers" => 2
+      }
+      conf = YAML.load_file(@config_file)
+      @options.merge! conf if conf
+        
+      process_pid_file @options["pid_file"]
+      process_log_file @options["log_file"]
+
+      start_port = end_port = @only
+      start_port ||=  @options["port"].to_i
+      end_port ||=  start_port + @options["servers"] - 1
+      @ports = (start_port..end_port).to_a
+    end
+
+    def process_pid_file(pid_file)
+      @pid_file_ext = File.extname(pid_file)
+      @pid_file_base = File.basename(pid_file, @pid_file_ext)
+      @pid_file_dir = File.dirname(pid_file)
+    end
+
+    def process_log_file(log_file)
+      @log_file_ext = File.extname(log_file)
+      @log_file_base = File.basename(log_file, @log_file_ext)
+      @log_file_dir = File.dirname(log_file)
+    end
+    
+    def port_pid_file(port)
+      pid_file = [@pid_file_base, port].join(".") + @pid_file_ext      
+      File.join(@pid_file_dir, pid_file)
+    end
+      
+    def port_log_file(port)
+      log_file = [@log_file_base, port].join(".") +  @log_file_ext      
+      File.join(@log_file_dir, log_file)
+    end
+      
+    def start
+      argv = [ "mongrel_rails" ]
+      argv << "start"
+      argv << "-d"
+      argv << "-e #{@options["environment"]}" if @options["environment"]
+      argv << "-a #{@options["address"]}"  if @options["address"]
+      argv << "-c #{@options["cwd"]}" if @options["cwd"]
+      argv << "-t #{@options["timeout"]}" if @options["timeout"]
+      argv << "-m #{@options["mime_map"]}" if @options["mime_map"]
+      argv << "-r #{@options["docroot"]}" if @options["docroot"]
+      argv << "-n #{@options["num_procs"]}" if @options["num_procs"]
+      argv << "-B" if @options["debug"]
+      argv << "-S #{@options["config_script"]}" if @options["config_script"]
+      argv << "--user #{@options["user"]}" if @options["user"]
+      argv << "--group #{@options["group"]}" if @options["group"]
+      argv << "--prefix #{@options["prefix"]}" if @options["prefix"]
+      cmd = argv.join " "
+      
+      @ports.each do |port|              
+        if @clean && pid_file_exists?(port) && !check_process(port)
+          pid_file = port_pid_file(port)        
+          log "missing process: removing #{pid_file}"
+          File.unlink(pid_file) 
+        end
+        
+        if pid_file_exists?(port) && check_process(port)
+          log "already started port #{port}"         
+          next
+        end
+
+        exec_cmd = cmd + " -p #{port} -P #{port_pid_file(port)}"
+        exec_cmd += " -l #{port_log_file(port)}"
+        log "starting port #{port}"          
+        log_verbose exec_cmd
+        output = `#{exec_cmd}`
+        log_error output unless $?.success?
+      end
+    end
+      
+    def stop
+      argv = [ "mongrel_rails" ]
+      argv << "stop"
+      argv << "-c #{@options["cwd"]}" if @options["cwd"]
+      argv << "-f" if @force
+      cmd = argv.join " "
+
+      @ports.each do |port|
+        pid = check_process(port)        
+        if @clean && pid && !pid_file_exists?(port)       
+          log "missing pid_file: killing mongrel_rails port #{port}, pid #{pid}"
+          Process.kill("KILL", pid.to_i)  
+        end
+        
+        if !check_process(port)
+          log "already stopped port #{port}"                   
+          next       
+        end
+
+        exec_cmd = cmd + " -P #{port_pid_file(port)}"
+        log "stopping port #{port}"          
+        log_verbose exec_cmd
+        output = `#{exec_cmd}`
+        log_error output unless $?.success?
+        
+      end
+    end
+  
+    def status
+      status = STATUS_OK
+     
+      @ports.each do |port|
+        pid = check_process(port)        
+        unless pid_file_exists?(port)        
+          log "missing pid_file: #{port_pid_file(port)}"  
+          status = STATUS_ERROR
+        else
+          log "found pid_file: #{port_pid_file(port)}"
+        end    
+        if pid
+          log "found mongrel_rails: port #{port}, pid #{pid}"
+        else
+          log "missing mongrel_rails: port #{port}"
+          status = STATUS_ERROR
+        end
+        puts ""
+      end
+
+      return status
+    end
+
+    def pid_file_exists?(port)    
+      pid_file = port_pid_file(port)
+      exists = false
+      chdir_cwd do     
+        exists = File.exists?(pid_file)  
+      end
+      exists
+    end
+
+    def check_process(port)
+      if pid_file_exists?(port)
+        pid = read_pid(port)
+        ps_output = `ps -o #{cmd_name}= -p #{pid}`
+        pid = ps_output =~ /mongrel_rails/ ? pid : nil
+      else
+        pid = find_pid(port)
+      end
+      return pid
+    end 
+    
+    def cmd_name 
+      RUBY_PLATFORM =~ /solaris/i ? "args" : "command"
+    end
+
+    def chdir_cwd
+      pwd = Dir.pwd
+      Dir.chdir(@options["cwd"]) if @options["cwd"]     
+      yield
+      Dir.chdir(pwd) if @options["cwd"]
+    end
+
+    def read_pid(port)
+      pid_file = port_pid_file(port)
+      pid = 0
+      chdir_cwd do     
+        pid = File.read(pid_file)
+      end
+      return pid
+    end
+ 
+    def find_pid(port)
+      ps_cmd = "ps -ewwo pid,#{cmd_name}"
+      ps_output = `#{ps_cmd}`      
+      ps_output.each do |line|     
+        if line =~ /-P #{Regexp.escape(port_pid_file(port))} /              
+          pid = line.split[0]
+          return pid
+        end
+      end
+      return nil
+    end
+
+    def log_error(message)
+      log(message)
+    end
+
+    def log_verbose(message)
+      log(message) if @verbose
+    end
+
+    def log(message)
+      puts message
+    end   
+    
+    def clustered &block
+      if @cluster
+        @only = nil
+        read_options
+        @ports.enum_slice((@ports.size/2.0).ceil).map{|x|x}[@cluster.to_i-1].each do |port|
+          @only = port
+          read_options
+          yield
+        end
+      else
+        read_options
+        yield
+      end
+    end
+    
+  end
+  class Start < GemPlugin::Plugin "/commands"
+    include ExecBase
+    
+    def configure
+      options [ 
+        ['-C', '--config PATH', "Path to cluster configuration file", :@config_file, "config/mongrel_cluster.yml"],
+        ['-v', '--verbose', "Print all called commands and output.", :@verbose, false],
+        ['', '--clean', "Remove pid_file if needed before starting", :@clean, false],
+        ['', '--only PORT', "Port number of cluster member", :@only, nil],
+        ['', '--cluster NUMBER', "1 or 2 - first half or second half of cluster", :@cluster, nil]
+      ]
+    end
+
+    def run
+      clustered {start}
+    end
+  end
+  
+  class Stop < GemPlugin::Plugin "/commands"
+    include ExecBase
+
+    def configure
+      options [
+       ['-C', '--config PATH', "Path to cluster configuration file", :@config_file, "config/mongrel_cluster.yml"],
+       ['-f', '--force', "Force the shutdown.", :@force, false],
+       ['-v', '--verbose', "Print all called commands and output.", :@verbose, false],
+       ['', '--clean', "Remove orphaned process if needed before stopping", :@clean, false],
+       ['', '--only PORT', "Port number of cluster member", :@only, nil],
+       ['', '--cluster NUMBER', "1 or 2 - first half or second half of cluster", :@cluster, nil]
+      ]
+    end
+    
+    def run
+      clustered {stop}
+    end  
+  end
+  
+  class Restart < GemPlugin::Plugin "/commands"
+    include ExecBase
+
+    def configure 
+      options [ 
+        ['-C', '--config PATH', "Path to cluster configuration file", :@config_file, "config/mongrel_cluster.yml"],
+        ['-f', '--force', "Force the shutdown.", :@force, false],
+        ['-v', '--verbose', "Print all called commands and output.", :@verbose, false],
+        ['', '--clean', "Call stop and start with --clean", :@clean, false],        
+        ['', '--only PORT', "Port number of cluster member", :@only, nil],
+        ['', '--cluster NUMBER', "1 or 2 - first half or second half of cluster", :@cluster, nil]
+      ]
+    end
+    
+    def run
+      clustered do
+        stop
+        start
+      end
+    end
+    
+  end
+  
+  class Configure < GemPlugin::Plugin "/commands"
+    include ExecBase
+    
+    def configure 
+      options [
+        ["-e", "--environment ENV", "Rails environment to run as", :@environment, nil],
+        ['-p', '--port PORT', "Starting port to bind to", :@port, 3000],
+        ['-a', '--address ADDR', "Address to bind to", :@address, nil],
+        ['-l', '--log FILE', "Where to write log messages", :@log_file, "log/mongrel.log"],
+        ['-P', '--pid FILE', "Where to write the PID", :@pid_file, "tmp/pids/mongrel.pid"],
+        ['-c', '--chdir PATH', "Change to dir before starting (will be expanded)", :@cwd, nil],
+        ['-t', '--timeout SECONDS', "Timeout all requests after SECONDS time", :@timeout, nil],
+        ['-m', '--mime PATH', "A YAML file that lists additional MIME types", :@mime_map, nil],
+        ['-r', '--root PATH', "Set the document root (default 'public')", :@docroot, nil],
+        ['-n', '--num-procs INT', "Number of processor threads to use", :@num_procs, nil],
+        ['-B', '--debug', "Enable debugging mode", :@debug, nil],
+        ['-S', '--script PATH', "Load the given file as an extra config script.", :@config_script, nil],
+        ['-N', '--num-servers INT', "Number of Mongrel servers", :@servers, 2],
+        ['-C', '--config PATH', "Path to cluster configuration file", :@config_file, "config/mongrel_cluster.yml"],
+        ['', '--user USER', "User to run as", :@user, nil],
+        ['', '--group GROUP', "Group to run as", :@group, nil],
+        ['', '--prefix PREFIX', "Rails prefix to use", :@prefix, nil]
+      ]
+    end
+
+    def validate
+      @servers = @servers.to_i
+      
+      valid?(@servers > 0, "Must give a valid number of servers")
+      valid_dir? File.dirname(@config_file), "Path to config file not valid: #{@config_file}"
+      
+      return @valid
+    end
+
+    def run
+      @options = { 
+        "port" => @port,
+        "servers" => @servers,
+        "pid_file" => @pid_file
+      }
+      
+      @options["log_file"] = @log_file if @log_file
+      @options["debug"] = @debug if @debug
+      @options["num_procs"] = @num_procs if @num_procs
+      @options["docroot"] = @docroot if @docroots
+      @options["address"] = @address if @address
+      @options["timeout"] = @timeout if @timeout
+      @options["environment"] = @environment if @environment
+      @options["mime_map"] = @mime_map if @mime_map
+      @options["config_script"] = @config_script if @config_script
+      @options["cwd"] = @cwd if @cwd
+      @options["user"] = @user if @user
+      @options["group"] = @group if @group
+      @options["prefix"] = @prefix if @prefix
+      
+      log "Writing configuration file to #{@config_file}."
+      File.open(@config_file,"w") {|f| f.write(@options.to_yaml)}
+    end  
+  end
+
+  class Status < GemPlugin::Plugin "/commands"
+    include ExecBase
+
+    def configure 
+      options [ 
+        ['-C', '--config PATH', "Path to cluster configuration file", :@config_file, "config/mongrel_cluster.yml"],
+        ['-v', '--verbose', "Print all called commands and output.", :@verbose, false],
+        ['', '--only PORT', "Port number of cluster member", :@only, nil],
+        ['', '--cluster NUMBER', "1 or 2 - first half or second half of cluster", :@cluster, nil]
+      ]
+    end
+    
+    def run
+      clustered {status}
+    end
+
+  end
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: seesaw
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-08-18 00:00:00 +10:00
+summary: Ripple-restart a mongrel cluster with no downtime
+require_paths: 
+- lib
+email: max@muermann.org
+homepage: "    by Matt Allen and Max Muermann"
+rubyforge_project: seesaw
+description: "== FEATURES/PROBLEMS:  * FIX (list of features or problems)  == SYNOPSIS:  FIX (code sample of usage)  == REQUIREMENTS:"
+autorequire: seesaw/init.rb
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Matt Allen, Max Muermann
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/seesaw
+- lib/seesaw/init.rb
+- lib/seesaw/mongrel_cluster_patch.rb
+- test/test_seesaw.rb
+test_files: 
+- test/test_seesaw.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: 
+- seesaw
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gem_plugin
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mongrel
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mongrel_cluster
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.2
+    version: