litmus_paper 1.0.0 → 1.1.0

data/README.md

@@ -23,6 +23,10 @@ Or install it yourself as:
 Use the sample config to run it under unicorn. Or execute litmus-agent-check to
 use it as an agent-check for HAProxy.
 
+## Releasing
+
+    $ ./release
+
 ## Contributing
 
 1. Fork it

data/lib/litmus_paper/app.rb

@@ -34,7 +34,12 @@ module LitmusPaper
     end
 
     get "/:service/status" do
-      health = LitmusPaper.check_service(params[:service])
+      health = _cache.get(params[:service])
+      _cache.set(
+        params[:service],
+        health = LitmusPaper.check_service(params[:service])
+      ) unless health
+
       if health.nil?
         _text 404, "NOT FOUND", { "X-Health" => "0" }
       else
@@ -100,6 +105,14 @@ module LitmusPaper
       _text 500, "Server Error"
     end
 
+    def _cache
+      @cache ||= LitmusPaper::Cache.new(
+        LitmusPaper.cache_location,
+        "litmus_cache",
+        LitmusPaper.cache_ttl
+      )
+    end
+
     def _create_status_file(status_file)
       status_file.create(params[:reason], params[:health])
       _text 201, "File created"

data/lib/litmus_paper/cache.rb

@@ -0,0 +1,33 @@
+require 'yaml'
+
+module LitmusPaper
+  class Cache
+    def initialize(location, namespace, ttl)
+      @path = File.join(location, namespace)
+      @ttl = ttl
+
+      FileUtils.mkdir_p(@path)
+    end
+
+    def set(key, value)
+      return unless @ttl > 0
+      File.open(File.join(@path, key), "a") do |f|
+        f.flock(File::LOCK_EX)
+        f.rewind
+        f.write("#{Time.now.to_f + @ttl} #{YAML::dump(value)}")
+        f.flush
+        f.truncate(f.pos)
+      end
+    end
+
+    def get(key)
+      return unless File.exists?(File.join(@path, key))
+      File.open(File.join(@path, key), "r") do |f|
+        f.flock(File::LOCK_SH)
+        entry = f.read
+        expires_at, value = entry.split(" ", 2)
+        expires_at.to_f < Time.now.to_f ? nil : YAML::load(value)
+      end
+    end
+  end
+end

data/lib/litmus_paper/configuration.rb

@@ -1,4 +1,11 @@
 module LitmusPaper
-  class Configuration < Struct.new(:port, :data_directory, :services)
+  fields = [
+    :port,
+    :data_directory,
+    :services,
+    :cache_location,
+    :cache_ttl
+  ]
+  class Configuration < Struct.new(*fields)
   end
 end

data/lib/litmus_paper/configuration_file.rb

@@ -5,13 +5,21 @@ module LitmusPaper
       @services = {}
       @port = 9292
       @data_directory = "/etc/litmus"
+      @cache_location = "/run/shm"
+      @cache_ttl = -1
     end
 
     def evaluate(file = @config_file_path)
       LitmusPaper.logger.info "Loading file #{file}"
       config_contents = File.read(file)
       instance_eval(config_contents)
-      LitmusPaper::Configuration.new(@port, @data_directory, @services)
+      LitmusPaper::Configuration.new(
+        @port,
+        @data_directory,
+        @services,
+        @cache_location,
+        @cache_ttl
+      )
     end
 
     def include_files(glob_pattern)
@@ -36,5 +44,13 @@ module LitmusPaper
       block.call(service)
       @services[name.to_s] = service
     end
+
+    def cache_location(location)
+      @cache_location = location
+    end
+
+    def cache_ttl(ttl)
+      @cache_ttl = ttl
+    end
   end
 end

data/lib/litmus_paper/version.rb

@@ -1,3 +1,3 @@
 module LitmusPaper
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/litmus_paper.rb

@@ -14,6 +14,7 @@ require 'forwardable'
 
 require 'remote_syslog_logger'
 
+require 'litmus_paper/cache'
 require 'litmus_paper/configuration'
 require 'litmus_paper/configuration_file'
 require 'litmus_paper/dependency/file_contents'
@@ -35,7 +36,7 @@ require 'litmus_paper/version'
 module LitmusPaper
   class << self
     extend Forwardable
-    def_delegators :@config, :services, :data_directory, :port
+    def_delegators :@config, :services, :data_directory, :port, :cache_location, :cache_ttl
     attr_accessor :logger
   end
 

data/release

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+set -o errexit
+set -o pipefail
+set -o nounset
+set -o xtrace
+
+chmod -R go+rX .
+rm -f *.gem
+gem build litmus_paper.gemspec
+gem push litmus_paper*.gem

data/spec/litmus_paper/app_spec.rb

@@ -272,7 +272,7 @@ describe LitmusPaper::App do
       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
+    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)
@@ -418,6 +418,45 @@ describe LitmusPaper::App do
       last_response.headers["X-Health-Forced"].should == "up"
       last_response.body.should match(/Up for testing/)
     end
+
+    it "retrieves a cached value during the cache_ttl" do
+      begin
+        cache = LitmusPaper::Cache.new(
+          location = "/tmp/litmus_cache",
+          namespace = "test_cache",
+          ttl = 0.05
+        )
+        LitmusPaper::App.any_instance.stub(:_cache).and_return(cache)
+        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 match(/health for testing 88/)
+
+        sleep ttl
+
+        get "/test/status"
+        last_response.should be_ok
+        last_response.body.should_not match(/health for testing 88/)
+      ensure
+        FileUtils.rm_rf(location)
+      end
+    end
   end
 
   describe "server errors" do

data/spec/litmus_paper/cache_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe LitmusPaper::Cache do
+  before(:each) do
+    @location = "/tmp/litmus_cache"
+    @namespace = "test_cache"
+    @ttl = -1
+  end
+
+  after(:each) do
+    FileUtils.rm_rf(@location)
+  end
+
+  describe "initialize" do
+    it "creates the directory structure" do
+      File.exists?(@location).should be false
+      LitmusPaper::Cache.new(@location, @namespace, @ttl)
+      File.exists?(File.join(@location, @namespace)).should be true
+    end
+  end
+
+  describe "get" do
+    it "returns false if the key was not previously set" do
+      cache = LitmusPaper::Cache.new(@location, @namespace, @ttl)
+      cache.get("non-existant-key").should be_nil
+    end
+
+    context "when called with fresh entry" do
+      it "returns the value set" do
+        cache = LitmusPaper::Cache.new(@location, @namespace, 10)
+        cache.set("key", "some value")
+        cache.get("key").should == "some value"
+      end
+    end
+
+    context "when called with expired entry" do
+      it "returns nil" do
+        cache = LitmusPaper::Cache.new(@location, @namespace, -1)
+        cache.set("key", "some value")
+        cache.get("key").should be_nil
+      end
+    end
+  end
+
+  describe "set" do
+    context "when called with non-positive ttl" do
+      it "does not store the value" do
+        key = "key"
+        cache = LitmusPaper::Cache.new(@location, @namespace, 0)
+        cache.set(key, "some value")
+        File.exists?(File.join(@location, @namespace, key)).should be false
+      end
+    end
+
+    context "when called with positive ttl" do
+      it "stores the value" do
+        key = "key"
+        cache = LitmusPaper::Cache.new(@location, @namespace, 1)
+        cache.set(key, "some value")
+        File.exists?(File.join(@location, @namespace, key)).should be true
+      end
+    end
+
+    it "expires the entry after the ttl" do
+      key = "key"
+      ttl = 0.01
+      cache = LitmusPaper::Cache.new(@location, @namespace, ttl)
+      cache.set(key, "some value")
+      cache.get(key).should == "some value"
+      sleep ttl
+      cache.get(key).should be_nil
+    end
+  end
+end

data/spec/litmus_paper/configuration_file_spec.rb

@@ -19,6 +19,18 @@ describe LitmusPaper::ConfigurationFile do
       config = config_file.evaluate
       config.data_directory.should == "/tmp/litmus_paper"
     end
+
+    it "configures the cache_location" do
+      config_file = LitmusPaper::ConfigurationFile.new(TEST_CONFIG)
+      config = config_file.evaluate
+      config.cache_location.should == "/tmp/litmus_paper_cache"
+    end
+
+    it "configures the cache_ttl" do
+      config_file = LitmusPaper::ConfigurationFile.new(TEST_CONFIG)
+      config = config_file.evaluate
+      config.cache_ttl.should == -1
+    end
   end
 
   describe "include_files" do

data/spec/support/test.config

@@ -4,6 +4,9 @@ port 9293
 
 data_directory "/tmp/litmus_paper"
 
+cache_location "/tmp/litmus_paper_cache"
+cache_ttl -1
+
 service :test do |s|
   s.depends Dependency::HTTP, "http://localhost/heartbeat"
 

data/spec/support/test.reload.config

@@ -4,6 +4,9 @@ port 9293
 
 data_directory "/tmp/litmus_paper"
 
+cache_location "/tmp/litmus_paper_cache"
+cache_ttl -1
+
 service :foo do |s|
   s.depends Dependency::HTTP, "http://localhost/heartbeat"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: litmus_paper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-05 00:00:00.000000000 Z
+date: 2017-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -165,6 +165,7 @@ files:
 - lib/litmus_paper/agent_check_handler.rb
 - lib/litmus_paper/agent_check_server.rb
 - lib/litmus_paper/app.rb
+- lib/litmus_paper/cache.rb
 - lib/litmus_paper/cli/admin.rb
 - lib/litmus_paper/cli/admin/command.rb
 - lib/litmus_paper/cli/admin/force.rb
@@ -192,9 +193,11 @@ files:
 - lib/litmus_paper/version.rb
 - litmus-agent-check.init.sh
 - litmus_paper.gemspec
+- release
 - spec/litmus_paper/agent_check_handler_spec.rb
 - spec/litmus_paper/agent_check_server_spec.rb
 - spec/litmus_paper/app_spec.rb
+- spec/litmus_paper/cache_spec.rb
 - spec/litmus_paper/cli/admin_spec.rb
 - spec/litmus_paper/configuration_file_spec.rb
 - spec/litmus_paper/dependency/file_contents_spec.rb
@@ -255,6 +258,7 @@ test_files:
 - spec/litmus_paper/agent_check_handler_spec.rb
 - spec/litmus_paper/agent_check_server_spec.rb
 - spec/litmus_paper/app_spec.rb
+- spec/litmus_paper/cache_spec.rb
 - spec/litmus_paper/cli/admin_spec.rb
 - spec/litmus_paper/configuration_file_spec.rb
 - spec/litmus_paper/dependency/file_contents_spec.rb