litmus_paper 0.9.3 → 0.9.4

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-- 1.9.2
 - 1.9.3
 - 2.0.0
 sudo: false

data/README.md

@@ -1,6 +1,6 @@
 # LitmusPaper
 
-Backend health tester for HA Services
+Backend health tester for HA Services, or as an agent-check for HAProxy
 
 [![Build Status](https://secure.travis-ci.org/braintree/litmus_paper.png)](http://travis-ci.org/braintree/litmus_paper)
 
@@ -20,7 +20,8 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Use the sample config to run it under unicorn. Or when running it as an
+agent-check for HAProxy use the sample xinetd config.
 
 ## Contributing
 

data/bin/litmus-agent-check

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'litmus_paper'
+require 'litmus_paper/cli/agent_check'
+
+LitmusPaper::CLI::AgentCheck.new.run(ARGV)

data/lib/litmus_paper/cli/agent_check.rb

@@ -0,0 +1,71 @@
+module LitmusPaper
+  module CLI
+    class AgentCheck
+
+      def parse_args(args)
+        options = {}
+        optparser = OptionParser.new do |opts|
+          opts.on("-s", "--service SERVICE", "Service to check") do |s|
+            options[:service] = s
+          end
+          opts.on("-c", "--config CONFIG", "Path to config file") do |c|
+            options[:config] = c
+          end
+          opts.on("-h", "--help", "Help text") do |h|
+            options[:help] = h
+          end
+        end
+
+        begin
+          optparser.parse! args
+        rescue OptionParser::InvalidOption => e
+          puts e
+          puts optparser
+          exit 1
+        end
+
+        if options[:help]
+          puts optparser
+          exit 0
+        end
+
+        if !options.has_key?(:service)
+          puts "Error: `-s SERVICE` required"
+          puts optparser
+          exit 1
+        end
+        options
+      end
+
+      def output_service_status(service, stdout)
+        output = []
+        health = LitmusPaper.check_service(service)
+        if health.nil?
+          output << "failed#NOT_FOUND"
+        else
+          case health.direction
+          when :up, :health
+            output << "ready"
+          when :down
+            output << "drain"
+          when :none
+            if health.ok?
+              output << "ready"
+            else
+              output << "down"
+            end
+          end
+          output << "#{health.value.to_s}%"
+        end
+        stdout.printf("%s\r\n", output.join("\t"))
+      end
+
+      def run(args)
+        options = parse_args(args)
+        LitmusPaper.configure(options[:config])
+        output_service_status(options[:service], $stdout)
+      end
+
+    end
+  end
+end

data/lib/litmus_paper/version.rb

@@ -1,3 +1,3 @@
 module LitmusPaper
-  VERSION = "0.9.3"
+  VERSION = "0.9.4"
 end

data/spec/litmus_paper/cli/agent_check_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+require 'litmus_paper/cli/agent_check'
+
+describe LitmusPaper::CLI::AgentCheck do
+  before :each do
+    LitmusPaper.configure(TEST_CONFIG)
+  end
+
+  def agent_check(service)
+    output = StringIO.new
+    LitmusPaper::CLI::AgentCheck.new.output_service_status(service, output)
+    output.rewind
+    output.readline
+  end
+
+  describe "output_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)
+      agent_check("test").should == "ready\t88%\r\n"
+    end
+
+    it "returns the actual 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)
+      agent_check("test").should == "ready\t0%\r\n"
+    end
+
+    it "is 'ready' when the service is passing" do
+      test_service = LitmusPaper::Service.new('test', [AlwaysAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
+      LitmusPaper.services['test'] = test_service
+      agent_check("test").should == "ready\t100%\r\n"
+    end
+
+    it "is 'down' when the check fails" do
+      test_service = LitmusPaper::Service.new('test', [NeverAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
+      LitmusPaper.services['test'] = test_service
+      agent_check("test").should == "down\t0%\r\n"
+    end
+
+    it "is 'failed' when the service is unknown" do
+      agent_check("unknown").should == "failed#NOT_FOUND\r\n"
+    end
+
+    it "is 'drain' when an up file and down file exists" do
+      test_service = LitmusPaper::Service.new('test', [AlwaysAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
+      LitmusPaper.services['test'] = test_service
+      LitmusPaper::StatusFile.service_up_file("test").create("Up for testing")
+      LitmusPaper::StatusFile.service_down_file("test").create("Down for testing")
+      agent_check("test").should == "drain\t0%\r\n"
+    end
+
+    it "is 'drain' when a global down file and up file exists" do
+      test_service = LitmusPaper::Service.new('test', [AlwaysAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
+      LitmusPaper.services['test'] = test_service
+      LitmusPaper::StatusFile.global_down_file.create("Down for testing")
+      LitmusPaper::StatusFile.global_up_file.create("Up for testing")
+      agent_check("test").should == "drain\t0%\r\n"
+    end
+
+    it "is 'ready' when an up file exists" do
+      test_service = LitmusPaper::Service.new('test', [NeverAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
+      LitmusPaper.services['test'] = test_service
+      LitmusPaper::StatusFile.service_up_file("test").create("Up for testing")
+      agent_check("test").should == "ready\t100%\r\n"
+    end
+
+    it "is 'drain' when a global down file exists" do
+      test_service = LitmusPaper::Service.new('test', [AlwaysAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
+      LitmusPaper.services['test'] = test_service
+      LitmusPaper::StatusFile.global_down_file.create("Down for testing")
+      agent_check("test").should == "drain\t0%\r\n"
+    end
+
+    it "is 'ready' when a global up file exists" do
+      test_service = LitmusPaper::Service.new('test', [NeverAvailableDependency.new], [LitmusPaper::Metric::ConstantMetric.new(100)])
+      LitmusPaper.services['test'] = test_service
+      LitmusPaper::StatusFile.global_up_file.create("Up for testing")
+      agent_check("test").should == "ready\t100%\r\n"
+    end
+  end
+end

data/xinetd.conf

@@ -0,0 +1,13 @@
+service internet_health
+{
+  disable     = no
+  socket_type = stream
+  protocol    = tcp
+  port        = 9191
+  user        = agent-check
+  wait        = no
+  server      = /usr/bin/litmus-agent-check
+  server_args = -s isp
+  type        = UNLISTED
+  instances   = 10
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: litmus_paper
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -176,6 +176,7 @@ email:
 - code@getbraintree.com
 executables:
 - litmus
+- litmus-agent-check
 - litmusctl
 extensions: []
 extra_rdoc_files: []
@@ -189,6 +190,7 @@ files:
 - README.md
 - Rakefile
 - bin/litmus
+- bin/litmus-agent-check
 - bin/litmusctl
 - config.ru
 - lib/facts/loadaverage.rb
@@ -199,6 +201,7 @@ files:
 - lib/litmus_paper/cli/admin/force.rb
 - lib/litmus_paper/cli/admin/list.rb
 - lib/litmus_paper/cli/admin/status.rb
+- lib/litmus_paper/cli/agent_check.rb
 - lib/litmus_paper/cli/server.rb
 - lib/litmus_paper/configuration.rb
 - lib/litmus_paper/configuration_file.rb
@@ -222,6 +225,7 @@ files:
 - litmus_paper.gemspec
 - spec/litmus_paper/app_spec.rb
 - spec/litmus_paper/cli/admin_spec.rb
+- spec/litmus_paper/cli/agent_check_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
@@ -255,6 +259,7 @@ files:
 - spec/support/test.d.config
 - spec/support/test.reload.config
 - spec/support/test.unicorn.config
+- xinetd.conf
 homepage: https://github.com/braintree/litmus_paper
 licenses: []
 post_install_message: 
@@ -267,12 +272,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 293212437870820872
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 293212437870820872
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -282,6 +293,7 @@ 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/agent_check_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