nugget 0.0.2

data/README.md

@@ -0,0 +1,27 @@
+### Nugget
+
+Nugget is a service for performing http and tcp integration tests. It uses [turd](https://github.com/joewilliams/turd/) under the covers to verify urls are responding properly. Kinda like pingdom, better in some ways, worse in others.
+
+#### Usage
+
+The examples directory includes an example config file. The config file is a json description of tests you want to run.
+
+The following starts nugget up in daemon mode. In this mode nugget just loops performing tests and writing the results in json to `/tmp/nugget_results.json`.
+
+        $ nugget -c examples/config.json -d
+
+Running nugget once is also possible.
+
+        $ nugget -c examples/config.json
+
+Nugget also includes a very basic web service daemon that simply reads the current results file.
+
+        $ nugget -w
+
+Additionally, nugget includes support for sending results of the tests to [backstop](https://github.com/obfuscurity/backstop).
+
+![](https://dl.dropboxusercontent.com/s/1xhl7fnuw0y0934/2014-01-13%20at%207.47%20PM.png)
+
+#### License
+
+nugget is open source software available under the MIT License

data/bin/nugget

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'nugget'))
+
+Nugget.main

data/lib/nugget/backstop.rb

@@ -0,0 +1,54 @@
+module Nugget
+  class Backstop
+
+    def self.send_metrics(name, result, response)
+      send_test_result(name, result)
+      send_test_timings(name, response)
+    end
+
+    def self.send_test_result(name, result)
+
+      if result == "FAIL"
+        backstop_requst("#{name}.result", 1)
+      end
+
+    end
+
+    def self.send_test_timings(name, response)
+
+      response.each do |key, value|
+        if key.to_s.include?("_time")
+          backstop_requst("#{name}.#{key}", value)
+        end
+      end
+
+    end
+
+    def self.backstop_requst(metric, value)
+
+      Nugget::Log.debug("Sending the following to backstop: #{metric}: #{value}")
+
+      body = [{
+        metric: metric,
+        value: value,
+        measure_time: Time.now.to_i
+      }].to_json
+
+      request = Typhoeus::Request.new(
+        Nugget::Config.backstop_url,
+        method: :post,
+        body: body,
+        headers: { 'Content-Type' => 'application/json' }
+      )
+
+      response = request.run
+
+      if response.options[:response_code] > 299
+        # hack a bad response error in here
+        Nugget::Log.error("Error publishing #{metric} to backstop, got #{response.options[:response_code]}")
+      end
+
+    end
+
+  end
+end

data/lib/nugget/cli.rb

@@ -0,0 +1,69 @@
+module Nugget
+  class CLI
+    include Mixlib::CLI
+
+    option :log_level,
+      :short => "-l LEVEL",
+      :long  => "--log_level LEVEL",
+      :description => "Set the log level (debug, info, warn, error, fatal)",
+      :default => :info,
+      :proc => Proc.new { |l| l.to_sym }
+
+    option :interval,
+      :short => "-i SECONDS",
+      :long => "--interval SECONDS",
+      :default => 30,
+      :description => "How long Nugget waits between testing runs when in daemon mode."
+
+    option :config,
+      :short => "-c PATH",
+      :long => "--config PATH",
+      :description => "Path of the json config."
+
+    option :daemon,
+      :short => "-d",
+      :long => "--daemon",
+      :boolean => true,
+      :default => false,
+      :description => "Run as a daemon. If not specified nugget just runs once."
+
+    option :web,
+      :short => "-w",
+      :long => "--web",
+      :boolean => true,
+      :description => "Run the web service."
+
+    option :ip,
+      :short => "-z IP",
+      :long => "--ip IP",
+      :default => "0.0.0.0",
+      :description => "IP for the web service."
+
+    option :port,
+      :short => "-p PORT",
+      :long => "--port PORT",
+      :default => 3000,
+      :description => "Port for the web service."
+
+    option :backstop_url,
+      :short => "-b URL",
+      :long => "--backstop URL",
+      :description => "URL for backstop metrics thing."
+
+    option :resultsfile,
+      :short => "-r FILE",
+      :long => "--results FILE",
+      :default => "/tmp/nugget_results.json",
+      :description => "Path to where results file is written/read."
+
+    option :help,
+      :short => "-h",
+      :long => "--help",
+      :description => "Show this message",
+      :on => :tail,
+      :boolean => true,
+      :show_options => true,
+      :exit => 0
+
+  end
+end

data/lib/nugget/config.rb

@@ -0,0 +1,10 @@
+module Nugget
+  class Config
+    extend Mixlib::Config
+
+    configure do |c|
+
+    end
+
+  end
+end

data/lib/nugget/log.rb

@@ -0,0 +1,6 @@
+module Nugget
+  class Log
+    extend Mixlib::Log
+
+  end
+end

data/lib/nugget/service.rb

@@ -0,0 +1,96 @@
+module Nugget
+  class Service
+
+    def self.run_daemon()
+      Nugget::Log.info("Starting up Nugget in daemon mode ...")
+
+      loop do
+        run()
+
+        # chill
+        sleep(Nugget::Config.interval.to_i)
+      end
+    end
+
+    def self.run_once()
+      Nugget::Log.info("Starting up Nugget in run-once mode ...")
+      run()
+    end
+
+    def self.run()
+      config_file = File.new(Nugget::Config.config, 'r')
+      parser = Yajl::Parser.new(:symbolize_keys => true)
+      config = parser.parse(config_file)
+
+      results = Hash.new
+
+      config.each do |test, definition|
+        result = nil
+        response = nil
+
+        begin
+          request_definition = config_converter(definition)
+          response_definition = definition[:response]
+
+          response = Turd.run(request_definition, response_definition)
+          result = "PASS"
+        rescue Exception => e
+          Nugget::Log.error("#{definition[:type]} test #{test} failed!")
+          Nugget::Log.error(e)
+
+          result = "FAIL"
+          response = e.response
+        end
+
+        Nugget::Log.info("Test #{test} complete with status #{result}")
+
+        results.store(test, {
+          :config => definition,
+          :result => result,
+          :response => response,
+          :timestamp => Time.now.to_i
+        })
+
+        if Nugget::Config.backstop_url
+          Nugget::Backstop.send_metrics(test, result, response)
+        end
+      end
+
+      if Nugget::Config.daemon
+        Nugget::Service.write_results(results)
+      end
+    end
+
+    def self.config_converter(definition)
+      options = definition[:request]
+
+      if options[:method]
+        sym_method = options[:method].to_sym
+        options.store(:method, sym_method)
+      end
+
+      if options[:url]
+        url = options[:url]
+        options.delete(:url)
+      end
+
+      {
+        :url => url,
+        :type => definition[:type],
+        :options => options
+      }
+    end
+
+    def self.write_results(results)
+      begin
+        file = File.open(Nugget::Config.resultsfile, "w")
+        file.puts(results.to_json)
+        file.close
+      rescue Exception => e
+        Nugget::Log.error("Something went wrong with writing out the results file!")
+        Nugget::Log.error(e)
+      end
+    end
+
+  end
+end

data/lib/nugget/version.rb

@@ -0,0 +1,3 @@
+module Nugget
+  VERSION = "0.0.2"
+end

data/lib/nugget/web.rb

@@ -0,0 +1,21 @@
+module Nugget
+  class Web
+
+    def self.run()
+      app = Rack::URLMap.new('/'  => Nugget::Web.new)
+      Thin::Server.start(Nugget::Config.ip, Nugget::Config.port, app)
+    end
+
+    def call(env)
+      time_diff = Time.now.to_i - File.mtime(Nugget::Config.resultsfile).to_i
+
+      if time_diff < 3600
+        body = [File.read(Nugget::Config.resultsfile)]
+        [200, { 'Content-Type' => 'text/plain' }, body]
+      else
+        [500, { 'Content-Type' => 'text/plain' }, ["nugget results file is stale (#{time_diff} seconds), something is wrong"]]
+      end
+    end
+
+  end
+end

data/lib/nugget.rb

@@ -0,0 +1,50 @@
+require 'rubygems'
+
+require 'turd'
+require 'mixlib/cli'
+require 'mixlib/config'
+require 'mixlib/log'
+require 'yajl/json_gem'
+require 'thin'
+
+__DIR__ = File.dirname(__FILE__)
+
+$LOAD_PATH.unshift __DIR__ unless
+  $LOAD_PATH.include?(__DIR__) ||
+  $LOAD_PATH.include?(File.expand_path(__DIR__))
+
+require 'nugget/config'
+require 'nugget/log'
+require 'nugget/cli'
+require 'nugget/service'
+require 'nugget/web'
+require 'nugget/backstop'
+require 'nugget/version'
+
+module  Nugget
+  class << self
+
+    def main
+      cli = Nugget::CLI.new
+      cli.parse_options
+      Nugget::Config.merge!(cli.config)
+
+      Nugget::Log.level(Nugget::Config.log_level)
+
+      if Nugget::Config.web
+        Nugget::Web.run()
+      else
+        if Nugget::Config.config
+          if  Nugget::Config.daemon
+            Nugget::Service.run_daemon()
+          else
+            Nugget::Service.run_once()
+          end
+        else
+          Nugget::Log.error("No config supplied! Use \"-c FILE\".")
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: nugget
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- joe williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixlib-config
+  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'
+- !ruby/object:Gem::Dependency
+  name: mixlib-log
+  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'
+- !ruby/object:Gem::Dependency
+  name: mixlib-cli
+  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'
+- !ruby/object:Gem::Dependency
+  name: turd
+  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'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  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'
+- !ruby/object:Gem::Dependency
+  name: thin
+  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: 
+email: joe@joetify.com
+executables:
+- nugget
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- bin/nugget
+- lib/nugget/backstop.rb
+- lib/nugget/cli.rb
+- lib/nugget/config.rb
+- lib/nugget/log.rb
+- lib/nugget/service.rb
+- lib/nugget/version.rb
+- lib/nugget/web.rb
+- lib/nugget.rb
+- README.md
+homepage: http://github.com/joewilliams/nugget
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: a http and tcp testing service
+test_files: []