vault-tools 0.3.1 → 0.3.2

data/Gemfile

@@ -12,4 +12,5 @@ end
 
 group :test do
   gem 'vault-test-tools', :path => '../vault-test-tools'
+  gem 'minitest'
 end

data/lib/vault-tools.rb

@@ -3,6 +3,7 @@ require "vault-tools/version"
 require 'sinatra/base'
 require 'scrolls'
 require 'rack/ssl-enforcer'
+require 'heroku-api'
 
 module Vault
   #require bundler and the proper gems for the ENV

data/lib/vault-tools/config.rb

@@ -2,6 +2,15 @@ module Vault
   module Config
     extend self
 
+    def remote_env(app, env)
+      heroku = Heroku::API.new
+      heroku.get_config_vars(app).body[env]
+    end
+
+    def core_follower_url
+      remote_env('vault-core-follower', 'DATABASE_URL')
+    end
+
     def env(key)
       ENV[key]
     end
@@ -18,8 +27,13 @@ module Vault
       env('RACK_ENV') == 'test'
     end
 
-    def app_name; env("APP_NAME"); end
-    def port; env!("PORT").to_i; end
+    def app_name
+      env("APP_NAME")
+    end
+
+    def port
+      env!("PORT").to_i
+    end
 
     def database_url(kind = '')
       kind = "#{kind}_".upcase unless kind.empty?

data/lib/vault-tools/log.rb

@@ -1,61 +1,54 @@
 module Vault
   module Log
-    extend self
-
-    # Public: logs a counter
-    #
-    # name - Name of the counter
-    #
-    # Examples
-    #   Log.count('foo')
-    #   => "measure=true at=foo"
+    # Log a count metric.
     #
-    # Logs via Scrolls
-    def count(name)
-      log(measure: true, at: name)
+    # @param name [String] The name of the metric.
+    def self.count(name)
+      name = "#{Config.app_name}.#{name}" if Config.app_name
+      log(measure: name)
     end
 
-    # Public: logs an HTTP status code
+    # Log an HTTP status code.  Two log metrics are written each time this
+    # method is invoked:
     #
-    # status - HTTP status code
+    # - The first one emits a metric called `http_200` for an HTTP 200
+    #   response.
+    # - The second one emits a metric called `http_2xx` for the same code.
     #
-    # Examples
-    #   Log.count_status(400)
-    #   => "measure=true at=web-40"
+    # This makes it possible to easily measure individual HTTP status codes as
+    # well as classes of HTTP status codes.
     #
-    # Logs via Scrolls
-    def count_status(status)
-      if prefix = status.to_s.match(/\d\d/)[0]
-        log(measure: true, at: "web-#{prefix}")
+    # @param status [Fixnum] The HTTP status code to record.
+    def self.count_status(status)
+      count("http_#{status}")
+      if status_prefix = status.to_s.match(/\d/)[0]
+        count("http_#{status_prefix}xx")
       end
     end
 
-    # Public: logs the time of a web request
+    # Log a timing metric.
     #
-    # name - a Sinatra-formatted route url
-    # t - time (integer seconds or milliseconds)
-    #
-    # Examples
-    #   Log.time(name, t)
-    #   => "measure=true at=web-40"
-    #
-    # Logs via Scrolls
-    def time(name, t)
+    # @param name [String] A Sinatra-formatted route URL.
+    # @param duration [Fixnum] The duration to record, in seconds or
+    #   milliseconds.
+    def self.time(name, duration)
       if name
-        name.
-          gsub(/\/:\w+/,'').            #remove param names from path
-          gsub("/","-").                #remove slash from path
-          gsub(/[^A-Za-z0-9\-\_]/, ''). #only keep subset of chars
-          slice(1..-1).
-          tap {|res| log(measure: true, fn: res, elapsed: t)}
+        name.gsub(/\/:\w+/, '').           # Remove param names from path.
+             gsub("/", "_").               # Replace slash with underscore.
+             gsub(/[^A-Za-z0-9\-\_]/, ''). # Only keep subset of chars.
+             slice(1..-1).
+             tap { |name| log(measure: name, val: duration) }
       end
     end
 
-    # Internal: log something
-    #
-    # Logs via Scrolls
-    def log(data, &blk)
-      Scrolls.log(data, &blk)
+    # Write a message with key/value pairs to the log stream.
+    #
+    # @param data [Hash] A mapping of key/value pairs to include in the
+    #   output.
+    # @param block [Proc] Optionally, a block of code to run before writing
+    #   the log message.
+    def self.log(data, &block)
+      Scrolls.log(data, &block)
     end
   end
 end

data/lib/vault-tools/version.rb

@@ -1,5 +1,5 @@
 module Vault
   module Tools
-    VERSION = '0.3.1'
+    VERSION = '0.3.2'
   end
 end

data/test/config_test.rb

@@ -1,7 +1,7 @@
 require 'helper'
+require 'minitest/mock'
 
 class ConfigTest < Vault::TestCase
-
   # Config.production? is true when RACK_ENV=production
   def test_production_mode
     set_env 'RACK_ENV', nil
@@ -36,6 +36,8 @@ class ConfigTest < Vault::TestCase
     end
   end
 
+  # Vault::Config.app_name returns the value of the APP_NAME environment
+  # variable.
   def test_app_name
     Vault::Config.app_name.must_equal nil
     set_env 'APP_NAME', "my-app"
@@ -63,4 +65,15 @@ class ConfigTest < Vault::TestCase
     set_env 'VAULT_TOOLS_DISABLE_SSL', 'foo'
     refute Vault::Config.enable_ssl?
   end
+
+  # Config.remote_env uses Heroku API to read config
+  # vars from apps
+  def test_remote_env
+    api_mock = MiniTest::Mock.new
+    api_response = OpenStruct.new(body: {'DATABASE_URL' => 'postgres:///foo'})
+    Heroku::API.stub(:new, api_mock) do
+      api_mock.expect(:get_config_vars, api_response, ['app'])
+      assert_equal('postgres:///foo', Vault::Config.remote_env('app', 'DATABASE_URL'))
+    end
+  end
 end

data/test/helper.rb

@@ -1,5 +1,7 @@
 require 'vault-test-tools'
 require 'vault-tools'
+ENV['RACK_ENV'] = 'test'
+Vault.setup
 
 class Vault::TestCase
   include Vault::Test::EnvironmentHelpers

data/test/log_test.rb

@@ -0,0 +1,84 @@
+require 'helper'
+
+class LogTest < Vault::TestCase
+  # Vault::Log.count emits a metric, using the specified name, that represents
+  # a countable event.
+  def test_count
+    set_env('APP_NAME', nil)
+    Vault::Log.count('countable')
+    assert_match(/measure=countable/, Scrolls.stream.string)
+  end
+
+  # Vault::Log.count emits a metric that represents a countable event.  If an
+  # APP_NAME environment variable is available it will be prepended to the
+  # measurement name.
+  def test_count_with_app_name
+    set_env('APP_NAME', 'vault_app')
+    Vault::Log.count('countable')
+    assert_match(/measure=vault_app.countable/, Scrolls.stream.string)
+  end
+
+  # Vault::Log.count_status emits metrics to measure HTTP responses.  The
+  # exact HTTP status, and the status family, are recorded.
+  def test_count_status
+    set_env('APP_NAME', nil)
+    Vault::Log.count_status(201)
+    assert_match(/measure=http_201/, Scrolls.stream.string)
+    assert_match(/measure=http_2xx/, Scrolls.stream.string)
+  end
+
+  # Vault::Log.count_status emits metrics to measure HTTP responses.  If an
+  # APP_NAME environment variable is available it will be prepended to the
+  # measurement name.
+  def test_count_status_with_app_name
+    set_env('APP_NAME', 'vault_app')
+    Vault::Log.count_status(201)
+    assert_match(/measure=vault_app.http_201/, Scrolls.stream.string)
+    assert_match(/measure=vault_app.http_2xx/, Scrolls.stream.string)
+  end
+
+  # Vault::Log.time emits a metric to measure the duration of an HTTP request.
+  # It converts slashes to underscores.
+  def test_time_replaces_slash_with_underscore
+    Vault::Log.time('/some/web/path', 123.4)
+    assert_match(/measure=some_web_path val=123.400/, Scrolls.stream.string)
+    assert_match(/val=123.4/, Scrolls.stream.string)
+  end
+
+  # Vault::Log.time removes parameters.
+  def test_time_removes_parameters
+    Vault::Log.time('/some/:web/path', 123.4)
+    assert_match(/measure=some_path val=123.400/, Scrolls.stream.string)
+    assert_match(/val=123.4/, Scrolls.stream.string)
+  end
+
+  # Vault::Log.time removes non-alphanumeric characters.
+  def test_time_removes_non_alphanumeric_characters
+    Vault::Log.time('/some/web+path', 123.4)
+    assert_match(/measure=some_webpath val=123.400/, Scrolls.stream.string)
+    assert_match(/val=123.4/, Scrolls.stream.string)
+  end
+
+  # Vault::Log.time is a no-op if a nil name is provided.
+  def test_time_without_name
+    Vault::Log.time(nil, 123.4)
+    assert_equal('', Scrolls.stream.string)
+  end
+
+  # Vault::Log.log emits a set of key/value metrics using data from the
+  # specified hash.
+  def test_log
+    Vault::Log.log(integer: 123, float: 123.4, string: 'string', bool: false)
+    assert_match(/integer=123 float=123.400 string=string bool=false/,
+                 Scrolls.stream.string)
+  end
+
+  # Vault::Log.log can be used to measure the time spent in a block.
+  def test_log_with_block
+    Vault::Log.log(A: true) do
+      Vault::Log.log(B: true)
+    end
+    assert_match(/A=true at=start\nB=true\nA=true at=finish elapsed=0/,
+                 Scrolls.stream.string)
+  end
+end

data/test/web_test.rb

@@ -14,38 +14,40 @@ class WebTest < Vault::TestCase
     reload_web!
   end
 
-  # middleware is attached at load time, so we have to
-  # delete the web class and reload it to simulate being
-  # loaded with a given ENV
+  # Middleware is attached at load time, so we have to delete the Vault::Web
+  # class and reload it to simulate being loaded with different environment
+  # variables.
   def reload_web!
     # remove the constant to force a clean reload
     Vault.send(:remove_const, 'Web')
     load 'lib/vault-tools/web.rb'
   end
 
-  # A successful request causes a `web-20` log entry to be written.
+  # An `http_200` and an `http_2xx` log metric is written for successful
+  # requests.
   def test_head_status_check
     head '/'
-    assert_match(/measure=true/, Scrolls.stream.string)
-    assert_match(/at=web-20/, Scrolls.stream.string)
+    assert_match(/measure=http_200/, Scrolls.stream.string)
+    assert_match(/measure=http_2xx/, Scrolls.stream.string)
     assert_equal(200, last_response.status)
   end
 
-  # A successful request causes `web-20` log entry to be written and `OK`
-  # content is returned in the response body.
+  # A GET /health request logs success metrics and returns 'OK' in the
+  # response body.
   def test_get_health_check
     get '/health'
-    assert_match(/measure=true/, Scrolls.stream.string)
-    assert_match(/at=web-20/, Scrolls.stream.string)
+    assert_match(/measure=http_200/, Scrolls.stream.string)
+    assert_match(/measure=http_2xx/, Scrolls.stream.string)
     assert_equal(200, last_response.status)
     assert_equal('OK', last_response.body)
   end
 
-  # A validation error causes a `web-40` log entry to be written.
+  # An `http_404` and an `http_4xx` log metric is written when a path doesn't
+  # match a known resource.
   def test_head_with_unknown_endpoint
     head '/unknown'
-    assert_match(/measure=true/, Scrolls.stream.string)
-    assert_match(/at=web-40/, Scrolls.stream.string)
+    assert_match(/measure=http_404/, Scrolls.stream.string)
+    assert_match(/measure=http_4xx/, Scrolls.stream.string)
     assert_equal(404, last_response.status)
   end
 
@@ -53,26 +55,28 @@ class WebTest < Vault::TestCase
   # traceback is also written to the response body to ease debugging.
   def test_error_logs_500
     get '/boom'
-    assert_match(/measure=true/, Scrolls.stream.string)
-    assert_match(/at=web-50/, Scrolls.stream.string)
+    assert_match(/measure=http_500/, Scrolls.stream.string)
+    assert_match(/measure=http_5xx/, Scrolls.stream.string)
     assert_match(/^RuntimeError: An expected error occurred.$/m,
                  last_response.body)
     assert_equal(500, last_response.status)
   end
 
-
   # SSL is enforced when we are in production mode
   def test_ssl_enforced_in_production_mode
     set_env 'RACK_ENV', 'production'
+    set_env 'VAULT_TOOLS_DISABLE_SSL', nil
     reload_web!
     get '/health'
     assert_equal(301, last_response.status)
     assert_match(/^https/, last_response.headers['Location'])
   end
 
+  # SSL isn't enforced when the VAULT_TOOLS_DISABLE_SSL environment variable
+  # has a true value.
   def test_ssl_can_be_disabled
     set_env 'RACK_ENV', 'production'
-    set_env 'VAULT_TOOLS_DISABLE_SSL', 'anything'
+    set_env 'VAULT_TOOLS_DISABLE_SSL', '1'
     reload_web!
     get '/health'
     assert_equal(200, last_response.status)

data/vault-tools.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'sinatra'
   gem.add_dependency 'uuidtools'
   gem.add_dependency 'rack-ssl-enforcer'
+  gem.add_dependency 'heroku-api'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vault-tools
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-27 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scrolls
@@ -76,6 +76,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: heroku-api
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Basic tools for Heroku Vault's Ruby projects
 email:
 - christopher.continanza@gmail.com
@@ -108,6 +124,7 @@ files:
 - test/config_test.rb
 - test/helper.rb
 - test/hid_test.rb
+- test/log_test.rb
 - test/pipeline_test.rb
 - test/product_test.rb
 - test/test_spec.rb
@@ -128,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3619778048086262088
+      hash: -4204391023637480040
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -137,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3619778048086262088
+      hash: -4204391023637480040
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23