litmus_paper 0.8.6 → 0.8.7

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 rvm:
-- 1.8.7
 - 1.9.2
 - 1.9.3
 - 2.0.0
+notifications:
+  email:
+    - blue@getbraintree.com

data/lib/litmus_paper/app.rb

@@ -22,6 +22,14 @@ module LitmusPaper
       _create_status_file(StatusFile.global_up_file)
     end
 
+    delete "/health" do
+      _delete_status_file(StatusFile.global_health_file)
+    end
+
+    post "/health" do
+      _create_status_file(StatusFile.global_health_file)
+    end
+
     get "/:service/status" do
       health = LitmusPaper.check_service(params[:service])
       if health.nil?
@@ -38,8 +46,14 @@ module LitmusPaper
         headers = {"X-Health" => health.value.to_s}
         body = "Health: #{health.value}\n"
         if health.forced?
+          if health.direction == :health
+            status = "health"
+            reason = health.forced_reason.split("\n").join(" ")
+          else
+            reason = health.forced_reason
+          end
           body << "Measured Health: #{health.measured_health}\n"
-          body << "Forced Reason: #{health.forced_reason}\n"
+          body << "Forced Reason: #{reason}\n"
         end
         body << health.summary
 
@@ -59,6 +73,14 @@ module LitmusPaper
       _create_status_file(StatusFile.service_down_file(params[:service]))
     end
 
+    delete "/:service/health" do
+      _delete_status_file(StatusFile.service_health_file(params[:service]))
+    end
+
+    post "/:service/health" do
+      _create_status_file(StatusFile.service_health_file(params[:service]))
+    end
+
     delete "/:service/up" do
       _delete_status_file(StatusFile.service_up_file(params[:service]))
     end
@@ -76,7 +98,7 @@ module LitmusPaper
     end
 
     def _create_status_file(status_file)
-      status_file.create(params[:reason])
+      status_file.create(params[:reason], params[:health])
       _text 201, "File created"
     end
 

data/lib/litmus_paper/cli/admin/force.rb

@@ -9,17 +9,21 @@ module LitmusPaper
         def self.build_request(options, args)
           options.merge! _default_options
           opt_parser = _extend_default_parser(options) do |opts|
-            opts.banner = "Usage: litmusctl force <up|down> [service] [options]"
+            opts.banner = "Usage: litmusctl force <up|down|health N> [service] [options]"
             opts.on("-d", "--delete", "Remove status file") do
               options[:delete] = true
             end
             opts.on("-r", "--reason=reason", String, "Reason for status file") do |reason|
-              options[:reason] = reason
+              options[:reason] = reason.gsub("\n", " ")
             end
           end
 
           opt_parser.parse! args
-          direction, service = args
+          if args[0] == "health" && !options[:delete]
+            direction, value, service = args
+          else
+            direction, service = args
+          end
           path = service ? "/#{service}/#{direction}" : "/#{direction}"
 
           if options[:delete]
@@ -27,10 +31,12 @@ module LitmusPaper
           else
             if !options.has_key?(:reason)
               print "Reason? "
-              options[:reason] = STDIN.gets.chomp
+              options[:reason] = STDIN.gets.chomp.gsub("\n", " ")
             end
             request = Net::HTTP::Post.new(path)
-            request.set_form_data('reason' => options[:reason])
+            params = {'reason' => options[:reason]}
+            params.merge!({'health' => value}) if direction == 'health'
+            request.set_form_data(params)
           end
 
           request

data/lib/litmus_paper/health.rb

@@ -19,9 +19,25 @@ module LitmusPaper
       @forced != :none
     end
 
+    def direction
+      @forced
+    end
+
     def value
       if forced?
-        return @forced == :up ? 100 : 0
+        return case @forced
+        when :up
+          100
+        when :down
+          0
+        when :health
+          forced_health = @forced_reason.split("\n").last.to_i
+
+          # This could potentially be argued differently, but I feel like forcing
+          # a health value != forcing up - if the measured health is less than the
+          # forced health, we should return the measured health.
+          measured_health < forced_health ? measured_health : forced_health
+        end
       end
 
       measured_health

data/lib/litmus_paper/metric/script.rb

@@ -0,0 +1,62 @@
+module LitmusPaper
+  module Metric
+    class Script
+      attr_reader :script_pid
+
+      def initialize(command, weight, options = {})
+        @command = command
+        @weight = weight
+        @timeout = options.fetch(:timeout, 5)
+      end
+
+      def current_health
+        @weight * result
+      end
+
+      def result
+        value = 0
+        Timeout.timeout(@timeout) do
+          script_stdout = script_stderr = nil
+          script_status = POpen4.popen4(@command) do |stdout, stderr, stdin, pid|
+            @script_pid = pid
+            value = 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 stdout: #{script_stdout}")
+            LitmusPaper.logger.info("Failed stderr: #{script_stderr}")
+          end
+
+          value.to_f
+        end
+      rescue Timeout::Error
+        LitmusPaper.logger.info("Available check to '#{@command}' timed out")
+        kill_and_reap_script(@script_pid)
+        0
+      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
+        "Metric::Script(#{@command}, #{@weight})"
+      end
+    end
+  end
+end

data/lib/litmus_paper/status_file.rb

@@ -10,6 +10,10 @@ module LitmusPaper
       new("global_up", :up)
     end
 
+    def self.global_health_file
+      new("global_health", :health)
+    end
+
     def self.service_down_file(service_name)
       new("#{service_name}_down", :down)
     end
@@ -18,12 +22,18 @@ module LitmusPaper
       new("#{service_name}_up", :up)
     end
 
+    def self.service_health_file(service_name)
+      new("#{service_name}_health", :health)
+    end
+
     def self.priority_check_order_for_service(service_name)
       [
         global_down_file,
         global_up_file,
+        global_health_file,
         service_down_file(service_name),
-        service_up_file(service_name)
+        service_up_file(service_name),
+        service_health_file(service_name),
       ]
     end
 
@@ -36,10 +46,11 @@ module LitmusPaper
       File.read(@path).chomp
     end
 
-    def create(reason)
+    def create(reason, health = nil)
       FileUtils.mkdir_p(File.dirname(@path))
       File.open(@path, 'w') do |file|
         file.puts(reason)
+        file.puts(health) if health
       end
     end
 

data/lib/litmus_paper/terminal_output.rb

@@ -4,7 +4,7 @@ module LitmusPaper
     def self.service_status
       max_service_length = (LitmusPaper.services.keys << "Service").max { |a, b| a.length <=> b.length }.length
 
-      output = "Litmus Paper #{LitmusPaper::VERSION}\n"
+      output = "Litmus Paper #{LitmusPaper::VERSION}\n\n"
       output += sprintf(" %s │ %s │ %s │ %s\n", "Service".ljust(max_service_length), "Reported", "Measured", "Health")
       output += sprintf(" %s │ %s │ %s │ %s\n", "Name".ljust(max_service_length), "Health".ljust(8), "Health".ljust(8), "Forced?")
       output += "─" * (max_service_length + 2) + "┴" + "─" * 10 + "┴" + "─" * 10 + "┴" + "─" * 9 + "\n"
@@ -14,11 +14,16 @@ module LitmusPaper
         measured_health = health.measured_health.to_s.rjust(3)
         reported_health = health.value.to_s.rjust(3)
         service_forced = if health.forced?
-          "Yes: #{health.forced_reason}"
-        else
-          "No"
-        end
-        output += sprintf("* %-#{max_service_length}s   %s   %s   %s\n",
+                           message = "Yes,"
+                           forced_reason, forced_health = health.forced_reason.split("\n")
+                           if forced_health
+                             message += " Health: #{forced_health}"
+                           end
+                            message += " Reason: #{forced_reason}"
+                         else
+                           "No"
+                         end
+        output += sprintf("- %-#{max_service_length}s   %s   %s   %s\n",
                           service_name,
                           reported_health.center(8).colorize(_health_color(health.value)),
                           measured_health.center(8),

data/lib/litmus_paper/version.rb

@@ -1,3 +1,3 @@
 module LitmusPaper
-  VERSION = "0.8.6"
+  VERSION = "0.8.7"
 end

data/lib/litmus_paper.rb

@@ -37,6 +37,7 @@ require 'litmus_paper/metric/available_memory'
 require 'litmus_paper/metric/big_brother_service'
 require 'litmus_paper/metric/constant_metric'
 require 'litmus_paper/metric/cpu_load'
+require 'litmus_paper/metric/script'
 require 'litmus_paper/service'
 require 'litmus_paper/status_file'
 require 'litmus_paper/terminal_output'

data/spec/litmus_paper/app_spec.rb

@@ -52,6 +52,14 @@ describe LitmusPaper::App do
       last_response.body.should include('Down for testing')
       last_response.body.should include('Up for testing')
     end
+
+    it "includes the health value if health is forced" do
+      LitmusPaper.services['test'] = LitmusPaper::Service.new('test')
+      LitmusPaper::StatusFile.service_health_file("test").create("Forcing health", 88)
+      get "/"
+      last_response.body.should include('Forcing health')
+      last_response.body.should include('88')
+    end
   end
 
   describe "POST /up" do
@@ -82,6 +90,20 @@ describe LitmusPaper::App do
     end
   end
 
+  describe "POST /health" do
+    it "creates a global healthfile" do
+      test_service = LitmusPaper::Service.new('test', [AlwaysAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
+      LitmusPaper.services['test'] = test_service
+
+      post "/health", :reason => "health for testing", :health => 88
+      last_response.status.should == 201
+
+      get "/test/status"
+      last_response.status.should == 200
+      last_response.body.should match(/health for testing 88/)
+    end
+  end
+
   describe "POST /:service/up" do
     it "creates a service specific upfile" do
       test_service = LitmusPaper::Service.new('test', [NeverAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
@@ -96,6 +118,20 @@ describe LitmusPaper::App do
     end
   end
 
+  describe "POST /:service/health" do
+    it "creates a service specific healthfile" do
+      test_service = LitmusPaper::Service.new('test', [AlwaysAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
+      LitmusPaper.services['test'] = test_service
+
+      post "/test/health", :reason => "health for testing", :health => 88
+      last_response.status.should == 201
+
+      get "/test/status"
+      last_response.status.should == 200
+      last_response.body.should match(/health for testing 88/)
+    end
+  end
+
   describe "DELETE /up" do
     it "removes the global upfile" do
       test_service = LitmusPaper::Service.new('test', [NeverAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
@@ -144,6 +180,35 @@ describe LitmusPaper::App do
     end
   end
 
+  describe "DELETE /health" do
+    it "removes the global healthfile" do
+      test_service = LitmusPaper::Service.new('test', [AlwaysAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
+      LitmusPaper.services['test'] = test_service
+
+      post "/health", :reason => "health for testing", :health => 88
+      last_response.status.should == 201
+
+      get "/test/status"
+      last_response.status.should == 200
+      last_response.body.should match(/health for testing 88/)
+
+      delete "/health"
+      last_response.status.should == 200
+
+      get "/test/status"
+      last_response.should be_ok
+      last_response.body.should_not match(/health for testing 88/)
+    end
+
+    it "404s if there is no healthfile" do
+      test_service = LitmusPaper::Service.new('test', [NeverAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
+
+      delete "/health"
+
+      last_response.status.should == 404
+    end
+  end
+
   describe "DELETE /:service/up" do
     it "removes a service specific upfile" do
       test_service = LitmusPaper::Service.new('test', [NeverAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
@@ -164,7 +229,63 @@ describe LitmusPaper::App do
     end
   end
 
+  describe "DELETE /:service/health" do
+    it "removes the service specific healthfile" do
+      test_service = LitmusPaper::Service.new('test', [AlwaysAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
+      LitmusPaper.services['test'] = test_service
+
+      post "/test/health", :reason => "health for testing", :health => 88
+      last_response.status.should == 201
+
+      get "/test/status"
+      last_response.status.should == 200
+      last_response.body.should match(/health for testing 88/)
+
+      delete "/test/health"
+      last_response.status.should == 200
+
+      get "/test/status"
+      last_response.should be_ok
+      last_response.body.should_not match(/health for testing 88/)
+    end
+
+    it "404s if there is no healthfile" do
+      test_service = LitmusPaper::Service.new('test', [NeverAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
+
+      delete "/test/health"
+
+      last_response.status.should == 404
+    end
+  end
+
   describe "GET /:service/status" do
+    it "returns the forced health value for a healthy service" do
+      test_service = LitmusPaper::Service.new('test', [AlwaysAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
+      LitmusPaper.services['test'] = test_service
+      LitmusPaper::StatusFile.service_health_file("test").create("Forcing health", 88)
+
+      get "/test/status"
+      last_response.should be_ok
+      last_response.header["X-Health"].should == "88"
+      last_response.body.should match(/Health: 88/)
+      last_response.body.should match(/Measured Health: 100/)
+      last_response.header["X-Health-Forced"].should == "health"
+    end
+
+    it "returns the actualy health value for an unhealthy service when the measured health is less than the forced value" do
+      test_service = LitmusPaper::Service.new('test', [NeverAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
+      LitmusPaper.services['test'] = test_service
+      LitmusPaper::StatusFile.service_health_file("test").create("Forcing health", 88)
+
+      get "/test/status"
+      last_response.should_not be_ok
+      last_response.header["X-Health"].should == "0"
+      last_response.header["X-Health-Forced"].should == "health"
+      last_response.body.should match(/Health: 0/)
+      last_response.body.should match(/Measured Health: 0/)
+      last_response.body.should match(/Forcing health 88\n/)
+    end
+
     it "is successful when the service is passing" do
       test_service = LitmusPaper::Service.new('test', [AlwaysAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
       LitmusPaper.services['test'] = test_service

data/spec/litmus_paper/cli/admin_spec.rb

@@ -50,6 +50,14 @@ describe 'litmusctl' do
       status.should match(/for testing/)
     end
 
+    it "can create a global healthfile" do
+      _litmusctl('force health 88 -r "for testing"').should match("File created")
+
+      status = _litmusctl('status test')
+      status.should match(/Health: 0/) # This service is actually failing so we'll get 0 back
+      status.should match(/for testing 88/)
+    end
+
     it "creates a downfile" do
       _litmusctl('force down test -r "for testing"').should match("File created")
 
@@ -58,6 +66,14 @@ describe 'litmusctl' do
       status.should match(/for testing/)
     end
 
+    it "creates a healthfile" do
+      _litmusctl('force health 88 test -r "for testing"').should match("File created")
+
+      status = _litmusctl('status test')
+      status.should match(/Health: 0/)
+      status.should match(/for testing 88/)
+    end
+
     it 'removes an upfile for the service' do
       _litmusctl('force up test -r "for testing"').should match("File created")
       _litmusctl('force up test -d').should match("File deleted")
@@ -67,6 +83,14 @@ describe 'litmusctl' do
       status.should_not match(/for testing/)
     end
 
+    it "removes a healthfile for the service" do
+      _litmusctl('force health 88 test -r "for testing"').should match("File created")
+      _litmusctl('force health test -d').should match("File deleted")
+      status = _litmusctl('status passing_test')
+      status.should match(/Health: \d\d/)
+      status.should_not match(/for testing/)
+    end
+
     it "returns not found if downfile doesn't exist" do
       _litmusctl('force down test -d').should match("NOT FOUND")
     end

data/spec/litmus_paper/metric/script_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe LitmusPaper::Metric::Script do
+  describe "#result" do
+    it "is 1 when the script outputs 1" do
+      check = LitmusPaper::Metric::Script.new("echo 1", 1)
+      check.current_health.should == 1
+    end
+
+    it "is zero when the script exits 1" do
+      check = LitmusPaper::Metric::Script.new("false", 1)
+      check.current_health.should == 0
+    end
+
+    it "is zero when the script exceeds the timeout" do
+      check = LitmusPaper::Metric::Script.new("sleep 10", 1, :timeout => 1)
+      check.current_health.should == 0
+    end
+
+    it "kills the child process when script check exceeds timeout" do
+      check = LitmusPaper::Metric::Script.new("sleep 50", 1, :timeout => 1)
+      check.current_health.should == 0
+      expect { Process.kill(0, check.script_pid) }.to raise_error(Errno::ESRCH)
+    end
+
+    it "can handle pipes" do
+      check = LitmusPaper::Metric::Script.new("echo 'a' | tr a 1", 1)
+      check.current_health.should == 1
+
+      check = LitmusPaper::Metric::Script.new("echo 'a' | tr a 0", 0)
+      check.current_health.should == 0
+    end
+  end
+
+  describe "to_s" do
+    it "returns the command" do
+      check = LitmusPaper::Metric::Script.new("sleep 10", 1)
+      check.to_s.should == "Metric::Script(sleep 10, 1)"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: litmus_paper
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.8.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-30 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -213,6 +213,7 @@ files:
 - lib/litmus_paper/metric/big_brother_service.rb
 - lib/litmus_paper/metric/constant_metric.rb
 - lib/litmus_paper/metric/cpu_load.rb
+- lib/litmus_paper/metric/script.rb
 - lib/litmus_paper/service.rb
 - lib/litmus_paper/status_file.rb
 - lib/litmus_paper/terminal_output.rb
@@ -231,6 +232,7 @@ files:
 - spec/litmus_paper/metric/big_brother_service_spec.rb
 - spec/litmus_paper/metric/constant_metric_spec.rb
 - spec/litmus_paper/metric/cpu_load_spec.rb
+- spec/litmus_paper/metric/script_spec.rb
 - spec/litmus_paper/service_spec.rb
 - spec/litmus_paper/status_file_spec.rb
 - spec/litmus_paper_spec.rb
@@ -289,6 +291,7 @@ test_files:
 - spec/litmus_paper/metric/big_brother_service_spec.rb
 - spec/litmus_paper/metric/constant_metric_spec.rb
 - spec/litmus_paper/metric/cpu_load_spec.rb
+- spec/litmus_paper/metric/script_spec.rb
 - spec/litmus_paper/service_spec.rb
 - spec/litmus_paper/status_file_spec.rb
 - spec/litmus_paper_spec.rb