activerain-mongrel_runit 0.2.3

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+require "delegate"
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'mongrel_runit', 'version')
+
+AUTHOR = "Adam Jacob"  # can also be an array of Authors
+EMAIL = "adam@hjksolutions.com"
+DESCRIPTION = "Use runit to manage a mongrel cluster"
+GEM_NAME = "mongrel_runit" # what ppl will type to install your gem
+RUBYFORGE_PROJECT = "mongrel_runit" # The unix name for your project
+HOMEPATH = "https://wiki.hjksolutions.com/display/MR/Home"
+
+NAME = "mongrel_runit"
+REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = ENV['VERSION'] || (MongrelRunit::VERSION::STRING + (REV ? ".#{REV}" : ""))
+                          CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "mongrel_runit documentation",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/*_test.rb"]
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  #p.changes        - A description of the release's latest changes.
+  #p.extra_deps     - An array of rubygem dependencies.
+  p.spec_extras = {
+    "files" =>  FileList['lib/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*'].to_a,
+    "executables" => [ "mongrel_runit" ],
+  } # - A hash of extra values to set in the gemspec.
+end
+

data/bin/mongrel_runit

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+#
+#  Created by Adam Jacob on 2007-03-22.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'mongrel_runit/cli'
+
+cli = MongrelRunit::CLI.new(ARGV)
+cli.execute

data/lib/mongrel_runit.rb

@@ -0,0 +1,25 @@
+#
+# Mongrel Runit takes a yaml config file and automatically sets up a
+# group of mongrels for you.  It is functionally equivilant to 
+# mongrel_cluster, but relies on runit for the fairly complex daemon
+# management tasks.
+#
+# Author:: Adam Jacob (<adam@hjksolutions.com>)
+# Copyright:: Copyright (c) 2007 HJK Solutions, LLC
+# License:: GNU General Public License version 2.1
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 
+# as published by the Free Software Foundation.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+
+Dir[File.join(File.dirname(__FILE__), 'mongrel_runit/**/*.rb')].sort.each { |lib| require lib }

data/lib/mongrel_runit/base.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+#
+# Author:: Adam Jacob (<adam@hjksolutions.com>)
+# Copyright:: Copyright (c) 2007 HJK Solutions, LLC
+# License:: GNU General Public License version 2
+#---
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 
+# as published by the Free Software Foundation.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#+++
+
+
+module MongrelRunit
+  
+  # A simple base class, that defines a list of allowed commands.  
+  class Base
+    ALLOWEDCOMMANDS = [
+      "up",
+      "down",
+      "status",
+      "once",
+      "pause",
+      "cont",
+      "hup",
+      "alarm",
+      "interrupt",
+      "1",
+      "2",
+      "term",
+      "kill",
+      "exit",
+      "start",
+      "stop",
+      "restart",
+      "shut-down",
+      "force-stop",
+      "force-reload",
+      "force-restart",
+      "force-shutdown",
+    ]
+    
+    # Returns a given command if it's found in the allowed commands
+    # list.  
+    def has_command?(command)
+      ALLOWEDCOMMANDS.detect { |cmd| cmd == command }
+    end
+    
+  end
+end

data/lib/mongrel_runit/cli.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+#
+# Author:: Adam Jacob (<adam@hjksolutions.com>)
+# Copyright:: Copyright (c) 2007 HJK Solutions, LLC
+# License:: GNU General Public License version 2
+#
+#--
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 
+# as published by the Free Software Foundation.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#++
+
+require 'optparse'
+require 'mongrel_runit/servicerunner'
+require 'mongrel_runit/config'
+require 'yaml'
+
+module MongrelRunit
+  
+# The command line interface. 
+#
+# Example:
+# 
+#   cli = MongrelRunit::CLI.new(ARGV)
+#   cli.execute
+#
+
+  class CLI
+
+    # Takes a list of command line arguments, passing them to 
+    # MongrelRunit::Config and MongrelRunit::ServiceRunner.
+    def initialize(args)
+      @config = MongrelRunit::Config.load_args(args)
+      @servicerunner = MongrelRunit::ServiceRunner.new(@config.config)
+    end
+    
+    # Executes the command (start/stop/restart; see MongrelRunit::Base for the 
+    # list) specified by the arguments passed to MongrelRunit::CLI.  The
+    # command is executed by calling MongrelRunit::ServiceRunner.run.
+    def execute
+      response, status = @servicerunner.run(@config.command)
+      if @config.verbose || status == false
+        response.sort.each do |key, value|
+          puts "#{key}: #{value[1]}: #{value[0]}"
+        end
+      end
+      exit 1 if status == false
+      exit 0 if status == true
+    end
+  end
+end

data/lib/mongrel_runit/config.rb

@@ -0,0 +1,184 @@
+# Author:: Adam Jacob (<adam@hjksolutions.com>)
+# Copyright:: Copyright (c) 2007 HJK Solutions, LLC
+# License:: GNU General Public License version 2
+#---
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 
+# as published by the Free Software Foundation.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#+++
+
+require 'yaml'
+require 'optparse'
+require 'mongrel_runit/base'
+
+module MongrelRunit
+  
+  # Takes a YAML config file and a list of command line arguments, and
+  # populates itself with the resulting combined configuration. 
+  #
+  # Example:
+  #
+  #   config = MongrelRunit::Config('monkey', '/etc/sv/monkey.yml', ARGV)
+  #   puts config["application_name"] # monkey
+  #  
+  class Config < Base
+    attr_accessor :config, :command, :verbose
+    
+    # Takes an application name, a YAML file, and command line arguments
+    # and spits out a working configuration.  The YAML file and arguments
+    # can optionally be nil.
+    #
+    # Unless otherwise specified, the following default values are
+    # set:
+    #
+    #    environment: ENV["RAILS_ENV"] or development
+    #    port: 3000
+    #    servers: 2
+    #    runit_svdir: /etc/sv
+    #    runit_service_dir: /var/service
+    def initialize(appname, yamlfile, args)
+      @config = Hash.new
+      load_args(args) if args
+      load_yaml(yamlfile) if yamlfile
+      @config["environment"] ||= ENV["RAILS_ENV"] || 'development'
+      @config["port"] ||=  "3000"
+      @config["servers"] ||= 2
+      @config["application_name"] ||= appname
+      @config["runit_svdir"] ||= '/etc/sv'
+      @config["runit_service_dir"] ||= '/var/service'
+      @config["address"] ||= '127.0.0.1'
+      
+      raise ArgumentError, "Must supply an application_name!" unless @config["application_name"]
+      
+    end
+    
+    # Returns the value from the config hash.
+    def [](arg)
+      @config[arg]
+    end
+    
+    # Load options from a config file alone
+    def Config.load_file(yamlfile)
+      MongrelRunit::Config.new(nil, yamlfile, nil)
+    end
+    
+    # Load options from command line arguments alone
+    def Config.load_args(*args)
+     MongrelRunit::Config.new(nil, nil, *args)
+    end
+    
+    private
+    
+      def load_yaml(yamlfile)
+        @config = YAML.load_file(File.expand_path(yamlfile))
+      end
+      
+      def load_from_path(path)
+        path.strip!
+        epath = File.expand_path(path)
+        @path = epath
+        mr_conf = File.expand_path(File.join(epath, "config", "mongrel_runit.yml"))
+        mc_conf = File.expand_path(File.join(epath, "config", "mongrel_cluster.yml"))
+        if File.file?(mr_conf)
+          load_yaml(mr_conf)
+        elsif File.file?(mc_conf)
+          load_yaml(mc_conf)
+        else
+          puts "#{path} must have a ./config/mongrel_runit.yml or ./config/mongrel_cluster.yml"
+          return nil
+        end
+        return true
+      end
+      
+      def load_args(args)
+        
+        loaded_config = nil
+        
+        opts = OptionParser.new do |opts|
+          opts.banner = "Usage: #{$0} (options) (#{ALLOWEDCOMMANDS.join('|')})"
+                    
+          opts.on("-p PATH", "--path PATH", "Path to a Rails app to start") do |p|
+            loaded_config = load_from_path(p)
+          end
+          
+          opts.on("-a NAME", "--application NAME", "The name of your Application. (Used for the service directories)") do |a|
+            @config["application_name"] = a
+          end
+          
+          opts.on("-c FILE", "--config FILE", "A mongrel_runit.yml config file") do |c|
+            c.strip!
+            file = File.expand_path(c)
+            if File.file?(file)
+              load_yaml(file)
+              loaded_config = true
+            else
+              puts "I could not find config file: #{file}"
+              exit 1
+            end
+          end
+              
+          opts.on_tail("-v", "--verbose", "Be verbose") do
+            @verbose = true
+          end
+          
+          opts.on_tail("-h", "--help", "Show this message") do
+            puts opts
+            exit
+          end
+        end
+        opts.parse!(args)
+        
+        unless loaded_config
+          path = Dir.getwd
+          loaded_config = load_from_path(path)
+        end
+           
+        if loaded_config && ! @config["application_name"]
+          if @path
+            appname = File.basename(@path)      
+            @config["application_name"] = appname
+          else
+            puts "You need application_name defined in your config!"
+            YAML.dump @config
+            exit 1
+          end
+        end
+        
+        unless loaded_config
+          puts "Configuration Dump:\n\n"
+          puts YAML.dump(@config)
+          puts "I could not find a way to configure myself properly!\n"
+          puts opts.help
+          exit 1
+        end
+     
+        if args.length > 1
+          puts "You specified more command line arguments than I can handle:"
+          puts args.join(" ")
+          puts opts.help
+          exit 1
+        end
+      
+        if self.has_command?(args[0]) || args[0] == "create"
+          @command = args[0]
+        else
+          if args[0]
+            puts "#{args[0]} is not an allowed command"
+          else 
+            puts "You must provide a command!"
+          end
+          puts opts.help
+          exit 1
+        end 
+      end
+  end
+end

data/lib/mongrel_runit/service.rb

@@ -0,0 +1,253 @@
+#  Created by Adam Jacob on 2007-03-21.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'mongrel_runit/base'
+
+module MongrelRunit
+  
+  # Represents a runit service directory for a particular mongrel.
+  # 
+  # Example:
+  # 
+  #   service = MongrelRunit::Service.new(config)
+  #   service.stop
+  #   service.start
+  #   service.create
+  #
+  
+  class Service < Base
+    attr_reader :runfile, :logrunfile, :logconfig, :checkfile, :svdir, :config
+    
+    # Takes a configuration hash as it's argument, ensures the 
+    # runit_service_dir exists, and creates the runit_sv_dir.
+    def initialize(config)
+      @config = config
+      
+      raise ArgumentError, "Must have an application_name!" unless @config.has_key?("application_name")
+      raise ArgumentError, "Must have a port!" unless @config.has_key?("port")
+      raise ArgumentError, "Must have a runit_sv_dir!" unless @config.has_key?("runit_sv_dir")
+      raise ArgumentError, "Must have a runit_service_dir!" unless @config.has_key?("runit_service_dir")
+      
+      check_service_dir
+      make_sv_dir 
+    end
+    
+    # Catch-all for the common service commands.  See MongrelRunit::Base for 
+    # a list.
+    def method_missing(status)
+      if self.has_command?(status.id2name)
+        run(status.id2name)
+      else
+        Kernel.method_missing
+      end
+    end
+    
+    # Returns true if the process is running, nil if it's not.
+    def is_running? 
+      output, success = run("status")
+      output =~ /^run:/ ? true : nil
+    end
+    
+    # Run a given command through sv.
+    def run(status)
+      cmd = "sv "
+      cmd += " -w #{@config['svwait']}" if @config.has_key?('svwait')
+      cmd += " #{status} #{@svdir}"
+      output = `#{cmd}`
+      return output, $?.success?
+    end
+    
+    # Create the service directory for this mongrel.  This includes the
+    # run script, log script, check script, and log config file.  This
+    # should run any time there is a change to the configruation.
+    def create
+      make_run
+      make_check
+      make_log
+      make_log_config
+      link = make_service_link
+      return link, true
+    end
+    
+    # Raises an exception if the runit_service_dir does not exist.
+    def check_service_dir
+      dir_exists = File.directory?(@config["runit_service_dir"])
+      raise ArgumentError, "runit_service_dir does not exist: #{@config["runit_service_dir"]}" unless dir_exists
+      dir_exists
+    end
+    
+    # Creates the symlink between the mongrel's sv directory and the
+    # runit_service_dir.
+    def make_service_link
+      servicename = File.basename(@svdir)
+      link = File.expand_path(File.join(@config["runit_service_dir"], servicename))
+      unless File.symlink?(link)
+        `ln -s #{@svdir} #{@config["runit_service_dir"]}`
+      end
+      link
+    end
+    
+    # Populates the check file, either with the contents of the checkfile
+    # configuration option, or:
+    #
+    #   #!/usr/bin/env ruby
+    #
+    #   require 'net/http'
+    #
+    #   http = Net::HTTP.new('#{address}', #{@config["port"].to_i})
+    #   begin
+    #    response = http.options('/')
+    #    if [Net::HTTPSuccess, Net::HTTPRedirection].any? {|klass| response = klass}
+    #      exit 0
+    #    else 
+    #      exit 1
+    #    end
+    #  rescue Errno::ECONNREFUSED
+    #    exit 1
+    #  end
+    def make_check
+      if @config.has_key?("checkfile") 
+        @checkfile = interpret_line(@config["checkfile"])
+      else
+        @checkfile = <<EOH
+#!/usr/bin/env ruby
+
+require 'net/http'
+
+http = Net::HTTP.new('#{@config['address']}', #{@config["port"].to_i})
+begin
+  response = http.options('/')
+  if [Net::HTTPSuccess, Net::HTTPRedirection].any? {|klass| response = klass}
+    exit 0
+  else 
+    exit 1
+  end
+rescue Errno::ECONNREFUSED
+  exit 1
+end
+EOH
+      end
+      path_to_checkfile = File.expand_path(File.join(@svdir, "check"))
+      create_or_update_file(path_to_checkfile, @checkfile)
+      File.chmod(0755, path_to_checkfile)
+      path_to_checkfile
+    end
+    
+    # Creates the sv direrectory for this mongrel. (From runit_sv_dir)
+    def make_sv_dir
+      @svdir = File.expand_path(File.join(
+        @config["runit_sv_dir"],
+        "mongrel-#{@config["application_name"]}-#{@config["port"]}"
+      ))
+      @svlogdir = File.expand_path(File.join(
+        @svdir, "log"
+      ))
+      `mkdir -p #{@svlogdir}`
+      raise "Cannot create #{@svlogdir}" unless $?.success?
+      @svlogdir
+    end
+    
+    # If svlogd_config is defined, creates the log config file.
+    def make_log_config
+      path_to_file = nil
+      if @config.has_key?("svlogd_config")
+        path_to_file = File.expand_path(File.join(@svlogdir, "config"))
+        @logconfig = @config["svlogd_config"]
+        create_or_update_file(path_to_file, @logconfig)
+      end
+      path_to_file
+    end
+    
+    # Makes the log run script.
+    def make_log
+      logdir = File.expand_path(File.join(@svlogdir, "main"))
+      if @config.has_key?("base_log_directory")
+        logdir = File.expand_path(File.join(
+          @config["base_log_directory"], 
+          "#{@config[application_name]}-#{@config[port]}"
+        ))
+      end
+      `mkdir -p #{logdir}`
+      raise "Cannot create #{logdir}" unless $?.success?
+      @logrunfile =  "#!/bin/sh\n"
+      @logrunfile << "exec svlogd -tt #{logdir}"
+      path_to_logrunfile = File.expand_path(File.join(@svlogdir, "run"))
+      create_or_update_file(path_to_logrunfile, @logrunfile)
+      File.chmod(0755, path_to_logrunfile) 
+      path_to_logrunfile
+    end
+    
+    # Makes the run script, which calls mongrel directly.  The command
+    # line assembly code for mongrel_rails is taken verbatim from mongrel_cluster.
+    def make_run
+      cmd = if @config["command_line"]
+        interpret_line(@config["command_line"])
+      else
+        argv = [ "mongrel_rails" ]
+        argv << "start"
+        argv << "-e #{@config["environment"]}" if @config["environment"]
+        argv << "-p #{@config["port"]}"
+        argv << "-a #{@config["address"]}"  if @config["address"]
+        argv << "-l #{@config["log_file"]}" if @config["log_file"]
+        argv << "-c #{File.expand_path(@config["cwd"])}" if @config["cwd"]
+        argv << "-t #{@config["timeout"]}" if @config["timeout"]
+        argv << "-m #{@config["mime_map"]}" if @config["mime_map"]
+        argv << "-r #{@config["docroot"]}" if @config["docroot"]
+        argv << "-n #{@config["num_procs"]}" if @config["num_procs"]
+        argv << "-B" if @config["debug"]
+        argv << "-S #{@config["config_script"]}" if @config["config_script"]
+        argv << "--user #{@config["user"]}" if @config["user"]
+        argv << "--group #{@config["group"]}" if @config["group"]
+        argv << "--prefix #{@config["prefix"]}" if @config["prefix"]
+        argv.join(" ")
+      end
+      env = nil
+      if @config.has_key?("env_vars")
+       env = "env"
+       @config["env_vars"].each do |key, value|
+         env << " #{key.upcase}=#{value}"
+       end
+      end
+      chpst = nil
+      if @config.has_key?("chpst")
+        chpst_command = `which chpst`.chomp
+        chpst = "#{chpst_command} #{@config['chpst']}"
+      end
+      @runfile = "#!/bin/sh\n"
+      @runfile << "exec \\\n"
+      @runfile << "  #{env} \\\n" if env
+      @runfile << "  #{chpst} \\\n" if chpst
+      @runfile << "  #{cmd} 2>&1\n"
+
+      path_to_runfile = File.expand_path(File.join(@svdir, "run"))
+      create_or_update_file(path_to_runfile, @runfile)
+      File.chmod(0755, path_to_runfile)
+      path_to_runfile
+    end
+
+    private
+    
+      def interpret_line(cmd)
+        begin
+          eval("\"#{cmd}\"")
+        rescue SyntaxError
+          puts "You have a syntax error in your string; perhaps you included a double quote without escaping it?"
+          raise
+        end        
+      end
+      
+      def create_or_update_file(file, new_contents)
+        write = 1
+        if File.file?(file)
+          current_contents = IO.read(file)
+          if current_contents == new_contents
+            write = nil
+          end
+        end
+        
+        File.open(file, "w") do |file|
+          file.print(new_contents)
+        end if write
+      end
+  end
+end