litmus_paper 0.7.5 → 0.7.9

data/README.md

@@ -1,4 +1,4 @@
-# IpvsLitmus
+# LitmusPaper
 
 Backend health tester for HA Services
 

data/bin/litmus

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+require 'optparse'
 require 'litmus_paper'
 require 'litmus_paper/cli/server'
 

data/config.ru

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift File.expand_path('lib', File.dirname(__FILE__))
 require 'litmus_paper'
 
+LitmusPaper.configure
 use Rack::CommonLogger, LitmusPaper.logger
 run LitmusPaper::App

data/lib/litmus_paper.rb

@@ -15,6 +15,7 @@ require 'English'
 #
 require 'resolv-replace'
 
+require 'popen4'
 require 'sinatra/base'
 require 'facter'
 require 'syslog_logger'
@@ -58,9 +59,17 @@ module LitmusPaper
     end
   end
 
-  def self.configure(filename)
-    @config_file = filename
-    @config = LitmusPaper::ConfigurationFile.new(filename).evaluate
+  def self.configure(filename = nil)
+    @config_file = if filename
+      filename
+    elsif ENV['LITMUS_CONFIG'] && File.exists?(ENV['LITMUS_CONFIG'])
+      ENV['LITMUS_CONFIG']
+    elsif File.exists?('/etc/litmus.conf')
+      '/etc/litmus.conf'
+    else
+      raise "No litmus configuration file"
+    end
+    @config = LitmusPaper::ConfigurationFile.new(@config_file).evaluate
   end
 
   def self.reload
@@ -74,4 +83,4 @@ module LitmusPaper
   end
 end
 
-Signal.trap("USR1") { LitmusPaper.reload }
+Signal.trap("HUP") { LitmusPaper.reload }

data/lib/litmus_paper/app.rb

@@ -1,11 +1,14 @@
 module LitmusPaper
   class App < Sinatra::Base
+    disable :show_exceptions
+
     get "/" do
       output = "Litmus Paper #{LitmusPaper::VERSION}\n\n"
       output += "Services monitored:\n"
       LitmusPaper.services.each do |service_name, service|
-        output += "* #{service_name} (#{service.current_health.value})"
-        if service.current_health.forced?
+        health = service.current_health
+        output += "* #{service_name} (#{health.value})"
+        if health.forced?
           output += " - forced: #{service.current_health.summary}"
         end
         output += "\n"

data/lib/litmus_paper/cli/server.rb

@@ -1,22 +1,23 @@
 module LitmusPaper
   module CLI
-    class Server < Rack::Server
+    class Server
       class Options
         def parse!(args)
           args, options = args.dup, {}
+          options[:unicorn_config] = "/etc/litmus_unicorn.rb"
+          options[:daemonize] = false
+          options[:Host] = "0.0.0.0"
+          options[:Port] = 9293
 
           opt_parser = OptionParser.new do |opts|
-            opts.banner = "Usage: litmus [mongrel, thin, etc] [options]"
-            opts.on("-c", "--config=file", String,
-                    "Litmus configuration file", "Default: /etc/litmus.conf") { |v| options[:litmus_config] = v }
+            opts.banner = "Usage: litmus [options]"
             opts.separator ""
 
             opts.on("-b", "--binding=ip", String,
                     "Binds Litmus to the specified ip.", "Default: 0.0.0.0") { |v| options[:Host] = v }
-            opts.on("-d", "--daemon", "Make server run as a Daemon.") { options[:daemonize] = true }
-            opts.on("-P","--pid=pid",String,
-                    "Specifies the PID file.",
-                    "Default: rack.pid") { |v| options[:pid] = v }
+            opts.on("-d", "--daemon", "Make server run as a Daemon.") { |d| options[:daemonize] = true }
+            opts.on("-p", "--port=port", "Listen Port") { |p| options[:Port] = p }
+            opts.on("-c", "--unicorn-config=config", "Unicorn Config") { |c| options[:unicorn_config] = c }
 
             opts.separator ""
 
@@ -25,8 +26,6 @@ module LitmusPaper
 
           opt_parser.parse! args
 
-          options[:config] = File.expand_path("../../../config.ru", File.dirname(__FILE__))
-          options[:server] = args.shift
           options
         end
       end
@@ -36,22 +35,12 @@ module LitmusPaper
       end
 
       def start
-        if !File.exists?(options[:litmus_config])
-          puts "Could not find #{options[:litmus_config]}. Specify correct location with -c file"
-          exit 1
-        end
-
-        LitmusPaper.configure(options[:litmus_config])
-        options[:Port] = LitmusPaper.port
-
-        super
+        options = opt_parser.parse!(ARGV)
+        unicorn_args = ['-c', options[:unicorn_config], '-l', "#{options[:Host]}:#{options[:Port]}"]
+        unicorn_args << '-D' if options[:daemonize]
+        Kernel.exec('unicorn', *unicorn_args)
       end
 
-      def default_options
-        super.merge(
-          :litmus_config => '/etc/litmus.conf'
-        )
-      end
     end
   end
 end

data/lib/litmus_paper/dependency/script.rb

@@ -1,6 +1,8 @@
 module LitmusPaper
   module Dependency
     class Script
+      attr_reader :script_pid
+
       def initialize(command, options = {})
         @command = command
         @timeout = options.fetch(:timeout, 5)
@@ -8,18 +10,43 @@ module LitmusPaper
 
       def available?
         Timeout.timeout(@timeout) do
-          output = %x[#{@command}]
-          unless $CHILD_STATUS.success?
+          script_stdout = script_stderr = nil
+          script_status = POpen4.popen4(@command) do |stdout, stderr, stdin, pid|
+            @script_pid = pid
+            script_stdout = stdout.read.strip
+            script_stderr = stderr.read.strip
+          end
+          unless script_status.success?
             LitmusPaper.logger.info("Available check to #{@command} failed with status #{$CHILD_STATUS.exitstatus}")
-            LitmusPaper.logger.info("Failed output #{output}")
+            LitmusPaper.logger.info("Failed stdout: #{script_stdout}")
+            LitmusPaper.logger.info("Failed stderr: #{script_stderr}")
           end
-          $CHILD_STATUS.success?
+          script_status.success?
         end
       rescue Timeout::Error
         LitmusPaper.logger.info("Available check to '#{@command}' timed out")
+        kill_and_reap_script(@script_pid)
         false
       end
 
+      def kill_and_reap_script(pid)
+        Process.kill(9, pid)
+        stop_time = Time.now + 2
+        while Time.now < stop_time
+          if Process.waitpid(pid, Process::WNOHANG)
+            LitmusPaper.logger.info("Reaped PID #{pid}")
+            return
+          else
+            sleep 0.1
+          end
+        end
+        LitmusPaper.logger.error("Unable to reap PID #{pid}")
+      rescue Errno::ESRCH
+        LitmusPaper.logger.info("Attempted to kill non-existent PID #{pid} (ESRCH)")
+      rescue Errno::ECHILD
+        LitmusPaper.logger.info("Attempted to reap PID #{pid} but it has already been reaped (ECHILD)")
+      end
+
       def to_s
         "Dependency::Script(#{@command})"
       end

data/lib/litmus_paper/version.rb

@@ -1,3 +1,3 @@
 module LitmusPaper
-  VERSION = "0.7.5"
+  VERSION = "0.7.9"
 end

data/litmus_paper.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency "sinatra", "~> 1.3.2"
   gem.add_dependency "facter", "~> 1.6.7"
   gem.add_dependency "SyslogLogger", "~> 1.4.1"
+  gem.add_dependency "popen4", "~> 0.1.2"
+  gem.add_dependency "unicorn", "~> 4.6.2"
 
   gem.add_development_dependency "rspec", "~> 2.9.0"
   gem.add_development_dependency "rack-test", "~> 0.6.1"

data/spec/litmus_paper/cli/admin_spec.rb

@@ -7,11 +7,15 @@ describe 'litmusctl' do
   end
 
   before(:all) do
-    system "bundle exec ruby -I lib bin/litmus -d -c #{TEST_CONFIG} -P /tmp/litmus.pid"
+    CONFIG_FILE = 'tmp/test.config'
+    system("cp #{TEST_CONFIG} #{CONFIG_FILE}")
+    ENV['LITMUS_CONFIG'] = CONFIG_FILE
+    system "bundle exec ruby -I lib bin/litmus -d -u #{TEST_UNICORN_CONFIG}"
+    @litmus_pid = File.read("tmp/unicorn.pid").chomp.to_i
   end
 
   after(:all) do
-    system "kill -9 `cat /tmp/litmus.pid`"
+    Process.kill("TERM", @litmus_pid)
   end
 
   describe 'help' do
@@ -67,4 +71,21 @@ describe 'litmusctl' do
       _litmusctl('force down test -d').should match("NOT FOUND")
     end
   end
+
+  describe "reload" do
+    after(:each) do
+      restore_config_file(CONFIG_FILE)
+      Process.kill("HUP", @litmus_pid)
+    end
+
+    it "reloads on a USR1 signal" do
+      _litmusctl('status test').should match("Health: 0")
+
+      replace_config_file(CONFIG_FILE, :with => TEST_RELOAD_CONFIG)
+
+      Process.kill("HUP", @litmus_pid)
+
+      _litmusctl('status foo').should match("Health: 0")
+    end
+  end
 end

data/spec/litmus_paper/dependency/script_spec.rb

@@ -17,6 +17,12 @@ describe LitmusPaper::Dependency::Script do
       check.should_not be_available
     end
 
+    it "kills the child process when script check exceeds timeout" do
+      check = LitmusPaper::Dependency::Script.new("sleep 50", :timeout => 1)
+      check.should_not be_available
+      expect { Process.kill(0, check.script_pid) }.to raise_error(Errno::ESRCH)
+    end
+
     it "can handle pipes" do
       check = LitmusPaper::Dependency::Script.new("ls | grep lib")
       check.should be_available

data/spec/litmus_paper_spec.rb

@@ -11,25 +11,19 @@ describe LitmusPaper do
   describe "reload" do
     it "will reconfigure the services" do
       LitmusPaper.configure(TEST_CONFIG)
+      replace_config_file(TEST_CONFIG, :with => TEST_RELOAD_CONFIG)
       LitmusPaper.services["bar"] = :service
 
-      LitmusPaper.reload
-
-      LitmusPaper.services.has_key?('bar').should == false
+      LitmusPaper.services.has_key?('bar').should == true
       LitmusPaper.services.has_key?('test').should == true
-    end
 
-    it "reloads on a USR1 signal" do
-      LitmusPaper.configure(TEST_CONFIG)
-      LitmusPaper.services["bar"] = :service
-
-      current_pid = $$
-      Process.kill("USR1", current_pid)
-
-      sleep 0.5 # wait for reload
+      LitmusPaper.reload
 
       LitmusPaper.services.has_key?('bar').should == false
-      LitmusPaper.services.has_key?('test').should == true
+      LitmusPaper.services.has_key?('test').should == false
+      LitmusPaper.services.has_key?('foo').should == true
+
+      restore_config_file(TEST_CONFIG)
     end
 
     it "blows up when initial configuration is invalid" do
@@ -40,7 +34,7 @@ describe LitmusPaper do
       END
       expect do
         LitmusPaper.configure(bad_config_file)
-      end.should raise_error
+      end.to raise_error
     end
 
     it "keeps the old config if there are errors in the new config" do

data/spec/spec_helper.rb

@@ -7,6 +7,8 @@ require 'tempfile'
 
 TEST_CONFIG_DIR = "/tmp/litmus_paper"
 TEST_CONFIG = File.expand_path('support/test.config', File.dirname(__FILE__))
+TEST_RELOAD_CONFIG = File.expand_path('support/test.reload.config', File.dirname(__FILE__))
+TEST_UNICORN_CONFIG = File.expand_path('support/test.unicorn.config', File.dirname(__FILE__))
 TEST_D_CONFIG = File.expand_path('support/test.d.config', File.dirname(__FILE__))
 TEST_CA_CERT = File.expand_path('ssl/server.crt', File.dirname(__FILE__))
 
@@ -44,3 +46,15 @@ module SpecHelper
     end
   end
 end
+
+def replace_config_file(old_config_file, replacement_hash)
+  replacement_config_file = replacement_hash[:with]
+
+  system("cp #{old_config_file} #{old_config_file}.bak")
+  system("cp #{replacement_config_file} #{old_config_file}")
+end
+
+
+def restore_config_file(config_file)
+  system("mv #{config_file}.bak #{config_file}")
+end

data/spec/support/test.reload.config

@@ -0,0 +1,17 @@
+# vim: set ft=ruby
+
+port 9293
+
+data_directory "/tmp/litmus_paper"
+
+service :foo do |s|
+  s.depends Dependency::HTTP, "http://localhost/heartbeat"
+
+  s.measure_health Metric::CPULoad, :weight => 50
+  s.measure_health Metric::AvailableMemory, :weight => 50
+end
+
+service :passing_test do |s|
+  s.measure_health Metric::CPULoad, :weight => 50
+  s.measure_health Metric::AvailableMemory, :weight => 50
+end

data/spec/support/test.unicorn.config

@@ -0,0 +1,11 @@
+# vim: set ft=ruby
+
+APP_ROOT = File.expand_path('../../',File.dirname(__FILE__))
+
+worker_processes 5
+working_directory APP_ROOT
+
+stderr_path "#{APP_ROOT}/tmp/unicorn.stderr"
+stdout_path "#{APP_ROOT}/tmp/unicorn.stdout"
+
+pid "#{APP_ROOT}/tmp/unicorn.pid"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: litmus_paper
 version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: 
+  hash: 17
+  prerelease: false
   segments: 
   - 0
   - 7
-  - 5
-  version: 0.7.5
+  - 9
+  version: 0.7.9
 platform: ruby
 authors: 
 - Braintreeps
@@ -15,7 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-04 00:00:00 Z
+date: 2013-05-20 00:00:00 +00:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sinatra
@@ -66,9 +67,41 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: popen4
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: unicorn
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 4
+        - 6
+        - 2
+        version: 4.6.2
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -80,11 +113,11 @@ dependencies:
         - 0
         version: 2.9.0
   type: :development
-  version_requirements: *id004
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: rack-test
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -96,11 +129,11 @@ dependencies:
         - 1
         version: 0.6.1
   type: :development
-  version_requirements: *id005
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -113,11 +146,11 @@ dependencies:
         - 2
         version: 0.9.2.2
   type: :development
-  version_requirements: *id006
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: rake_commit
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -128,7 +161,7 @@ dependencies:
         - 13
         version: "0.13"
   type: :development
-  version_requirements: *id007
+  version_requirements: *id009
 description: Backend health tester for HA Services
 email: 
 - code@getbraintree.com
@@ -179,7 +212,6 @@ files:
 - litmus_paper.gemspec
 - spec/litmus_paper/app_spec.rb
 - spec/litmus_paper/cli/admin_spec.rb
-- spec/litmus_paper/cli/server_spec.rb
 - spec/litmus_paper/configuration_file_spec.rb
 - spec/litmus_paper/dependency/file_contents_spec.rb
 - spec/litmus_paper/dependency/haproxy_backends_spec.rb
@@ -209,6 +241,9 @@ files:
 - spec/support/stub_facter.rb
 - spec/support/test.config
 - spec/support/test.d.config
+- spec/support/test.reload.config
+- spec/support/test.unicorn.config
+has_rdoc: true
 homepage: https://github.com/braintree/litmus_paper
 licenses: []
 
@@ -238,14 +273,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Backend health tester for HA Services, partner project of big_brother
 test_files: 
 - spec/litmus_paper/app_spec.rb
 - spec/litmus_paper/cli/admin_spec.rb
-- spec/litmus_paper/cli/server_spec.rb
 - spec/litmus_paper/configuration_file_spec.rb
 - spec/litmus_paper/dependency/file_contents_spec.rb
 - spec/litmus_paper/dependency/haproxy_backends_spec.rb
@@ -275,3 +309,5 @@ test_files:
 - spec/support/stub_facter.rb
 - spec/support/test.config
 - spec/support/test.d.config
+- spec/support/test.reload.config
+- spec/support/test.unicorn.config

data/spec/litmus_paper/cli/server_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-require 'litmus_paper/cli/server'
-
-describe LitmusPaper::CLI::Server do
-  describe 'parse!' do
-    it 'parses litmus config file options' do
-      options = LitmusPaper::CLI::Server::Options.new.parse!(['-c', 'foo.conf'])
-      options[:litmus_config].should == 'foo.conf'
-    end
-  end
-end