projectlocker_pulse 0.2.1

data/test/configuration_test.rb

@@ -0,0 +1,236 @@
+require File.expand_path '../helper', __FILE__
+
+class ConfigurationTest < Test::Unit::TestCase
+
+  include DefinesConstants
+
+  should "provide default values" do
+    assert_config_default :proxy_host,          nil
+    assert_config_default :proxy_port,          nil
+    assert_config_default :proxy_user,          nil
+    assert_config_default :proxy_pass,          nil
+    assert_config_default :project_root,        nil
+    assert_config_default :environment_name,    nil
+    assert_config_default :logger,              nil
+    assert_config_default :notifier_version,    Pulse::VERSION
+    assert_config_default :notifier_name,       'Pulse Notifier'
+    assert_config_default :notifier_url,        'http://rubyforge.org/projects/pl-errata/'
+    assert_config_default :secure,              false
+    assert_config_default :host,                'errors.projectlocker.com'
+    assert_config_default :http_open_timeout,   2
+    assert_config_default :http_read_timeout,   5
+    assert_config_default :ignore_by_filters,   []
+    assert_config_default :ignore_user_agent,   []
+    assert_config_default :params_filters,
+                          Pulse::Configuration::DEFAULT_PARAMS_FILTERS
+    assert_config_default :backtrace_filters,
+                          Pulse::Configuration::DEFAULT_BACKTRACE_FILTERS
+    assert_config_default :ignore,
+                          Pulse::Configuration::IGNORE_DEFAULT
+    assert_config_default :development_lookup, true
+    assert_config_default :framework, 'Standalone'
+    assert_config_default :async, nil
+  end
+
+  should "set GirlFriday-callable for async=true" do
+    config = Pulse::Configuration.new
+    config.async = true
+    assert config.async.respond_to?(:call)
+  end
+
+  should "set provided-callable for async {}" do
+    config = Pulse::Configuration.new
+    config.async {|notice| :ok}
+    assert config.async.respond_to?(:call)
+    assert_equal :ok, config.async.call
+  end
+
+  should "provide default values for secure connections" do
+    config = Pulse::Configuration.new
+    config.secure = true
+    assert_equal 443, config.port
+    assert_equal 'https', config.protocol
+  end
+
+  should "provide default values for insecure connections" do
+    config = Pulse::Configuration.new
+    config.secure = false
+    assert_equal 80, config.port
+    assert_equal 'http', config.protocol
+  end
+
+  should "not cache inferred ports" do
+    config = Pulse::Configuration.new
+    config.secure = false
+    config.port
+    config.secure = true
+    assert_equal 443, config.port
+  end
+
+  should "allow values to be overwritten" do
+    assert_config_overridable :proxy_host
+    assert_config_overridable :proxy_port
+    assert_config_overridable :proxy_user
+    assert_config_overridable :proxy_pass
+    assert_config_overridable :secure
+    assert_config_overridable :host
+    assert_config_overridable :port
+    assert_config_overridable :http_open_timeout
+    assert_config_overridable :http_read_timeout
+    assert_config_overridable :project_root
+    assert_config_overridable :notifier_version
+    assert_config_overridable :notifier_name
+    assert_config_overridable :notifier_url
+    assert_config_overridable :environment_name
+    assert_config_overridable :development_lookup
+    assert_config_overridable :logger
+    assert_config_overridable :async
+  end
+
+  should "have an api key" do
+    assert_config_overridable :api_key
+  end
+
+  should "act like a hash" do
+    config = Pulse::Configuration.new
+    hash = config.to_hash
+    [:api_key, :backtrace_filters, :development_environments,
+     :environment_name, :host, :http_open_timeout,
+     :http_read_timeout, :ignore, :ignore_by_filters, :ignore_user_agent,
+     :notifier_name, :notifier_url, :notifier_version, :params_filters,
+     :project_root, :port, :protocol, :proxy_host, :proxy_pass, :proxy_port,
+     :proxy_user, :secure, :development_lookup, :async].each do |option|
+      assert_equal config[option], hash[option], "Wrong value for #{option}"
+    end
+  end
+
+  should "be mergable" do
+    config = Pulse::Configuration.new
+    hash = config.to_hash
+    assert_equal hash.merge(:key => 'value'), config.merge(:key => 'value')
+  end
+
+  should "allow param filters to be appended" do
+    assert_appends_value :params_filters
+  end
+
+  should "warn when attempting to read environment filters" do
+    config = Pulse::Configuration.new
+    config.
+      expects(:warn).
+      with(regexp_matches(/deprecated/i))
+    assert_equal [], config.environment_filters
+  end
+
+  should "warn when attempting to write js_notifier" do
+    config = Pulse::Configuration.new
+    config.
+      expects(:warn).
+      with(regexp_matches(/deprecated/i))
+    config.js_notifier = true
+  end
+
+  should "allow ignored user agents to be appended" do
+    assert_appends_value :ignore_user_agent
+  end
+
+  should "allow backtrace filters to be appended" do
+    assert_appends_value(:backtrace_filters) do |config|
+      new_filter = lambda {}
+      config.filter_backtrace(&new_filter)
+      new_filter
+    end
+  end
+
+  should "allow ignore by filters to be appended" do
+    assert_appends_value(:ignore_by_filters) do |config|
+      new_filter = lambda {}
+      config.ignore_by_filter(&new_filter)
+      new_filter
+    end
+  end
+
+  should "allow ignored exceptions to be appended" do
+    config = Pulse::Configuration.new
+    original_filters = config.ignore.dup
+    new_filter = 'hello'
+    config.ignore << new_filter
+    assert_same_elements original_filters + [new_filter], config.ignore
+  end
+
+  should "allow ignored exceptions to be replaced" do
+    assert_replaces(:ignore, :ignore_only=)
+  end
+
+  should "allow ignored user agents to be replaced" do
+    assert_replaces(:ignore_user_agent, :ignore_user_agent_only=)
+  end
+
+  should "use development and test as development environments by default" do
+    config = Pulse::Configuration.new
+    assert_same_elements %w(development test cucumber), config.development_environments
+  end
+
+  should "be public in a public environment" do
+    config = Pulse::Configuration.new
+    config.development_environments = %w(development)
+    config.environment_name = 'production'
+    assert config.public?
+  end
+
+  should "not be public in a development environment" do
+    config = Pulse::Configuration.new
+    config.development_environments = %w(staging)
+    config.environment_name = 'staging'
+    assert !config.public?
+  end
+
+  should "be public without an environment name" do
+    config = Pulse::Configuration.new
+    assert config.public?
+  end
+
+  should "use the assigned logger if set" do
+    config = Pulse::Configuration.new
+    config.logger = "CUSTOM LOGGER"
+    assert_equal "CUSTOM LOGGER", config.logger
+  end
+
+  should 'give a new instance if non defined' do
+    Pulse.configuration = nil
+    assert_kind_of Pulse::Configuration, Pulse.configuration
+  end
+
+  def assert_config_default(option, default_value, config = nil)
+    config ||= Pulse::Configuration.new
+    assert_equal default_value, config.send(option)
+  end
+
+  def assert_config_overridable(option, value = 'a value')
+    config = Pulse::Configuration.new
+    config.send(:"#{option}=", value)
+    assert_equal value, config.send(option)
+  end
+
+  def assert_appends_value(option, &block)
+    config = Pulse::Configuration.new
+    original_values = config.send(option).dup
+    block ||= lambda do |config|
+      new_value = 'hello'
+      config.send(option) << new_value
+      new_value
+    end
+    new_value = block.call(config)
+    assert_same_elements original_values + [new_value], config.send(option)
+  end
+
+  def assert_replaces(option, setter)
+    config = Pulse::Configuration.new
+    new_value = 'hello'
+    config.send(setter, [new_value])
+    assert_equal [new_value], config.send(option)
+    config.send(setter, new_value)
+    assert_equal [new_value], config.send(option)
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,263 @@
+require 'simplecov'
+SimpleCov.start
+require 'test/unit'
+require 'rubygems'
+
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'thread'
+
+require 'shoulda'
+require 'mocha'
+
+require 'action_controller'
+require 'action_controller/test_process'
+require 'active_record'
+require 'active_support'
+require 'nokogiri'
+require 'rack'
+require 'bourne'
+require 'sham_rack'
+
+require "pulse"
+
+begin require 'redgreen'; rescue LoadError; end
+
+module TestMethods
+  def rescue_action e
+    raise e
+  end
+
+  def do_raise
+    raise "Pulse"
+  end
+
+  def do_not_raise
+    render :text => "Success"
+  end
+
+  def do_raise_ignored
+    raise ActiveRecord::RecordNotFound.new("404")
+  end
+
+  def do_raise_not_ignored
+    raise ActiveRecord::StatementInvalid.new("Statement invalid")
+  end
+
+  def manual_notify
+    notify_pulse(Exception.new)
+    render :text => "Success"
+  end
+
+  def manual_notify_ignored
+    notify_pulse(ActiveRecord::RecordNotFound.new("404"))
+    render :text => "Success"
+  end
+end
+
+class Test::Unit::TestCase
+  def request(action = nil, method = :get, user_agent = nil, params = {})
+    @request = ActionController::TestRequest.new
+    @request.action = action ? action.to_s : ""
+
+    if user_agent
+      if @request.respond_to?(:user_agent=)
+        @request.user_agent = user_agent
+      else
+        @request.env["HTTP_USER_AGENT"] = user_agent
+      end
+    end
+    @request.query_parameters = @request.query_parameters.merge(params)
+    @response = ActionController::TestResponse.new
+    @controller.process(@request, @response)
+  end
+
+  # Borrowed from ActiveSupport 2.3.2
+  def assert_difference(expression, difference = 1, message = nil, &block)
+    b = block.send(:binding)
+    exps = Array.wrap(expression)
+    before = exps.map { |e| eval(e, b) }
+
+    yield
+
+    exps.each_with_index do |e, i|
+      error = "#{e.inspect} didn't change by #{difference}"
+      error = "#{message}.\n#{error}" if message
+      assert_equal(before[i] + difference, eval(e, b), error)
+    end
+  end
+
+  def assert_no_difference(expression, message = nil, &block)
+    assert_difference expression, 0, message, &block
+  end
+
+  def stub_sender
+    stub('sender', :send_to_pulse => nil)
+  end
+
+  def stub_sender!
+    Pulse.sender = stub_sender
+  end
+
+  def stub_notice
+    stub('notice', :to_xml => 'some yaml', :ignore? => false)
+  end
+
+  def stub_notice!
+     stub_notice.tap do |notice|
+      Pulse::Notice.stubs(:new => notice)
+    end
+  end
+
+  def create_dummy
+    Pulse::DummySender.new
+  end
+
+  def reset_config
+    Pulse.configuration = nil
+    Pulse.configure do |config|
+      config.api_key = 'abc123'
+    end
+  end
+
+  def clear_backtrace_filters
+    Pulse.configuration.backtrace_filters.clear
+  end
+
+  def build_exception(opts = {})
+    backtrace = ["pulse/test/helper.rb:132:in `build_exception'",
+                 "pulse/test/backtrace.rb:4:in `build_notice_data'",
+                 "/var/lib/gems/1.8/gems/pulse-2.4.5/rails/init.rb:2:in `send_exception'"]
+    opts = {:backtrace => backtrace}.merge(opts)
+    BacktracedException.new(opts)
+  end
+
+  def build_notice_data(exception = nil)
+    exception ||= build_exception
+    {
+      :api_key       => 'abc123',
+      :error_class   => exception.class.name,
+      :error_message => "#{exception.class.name}: #{exception.message}",
+      :backtrace     => exception.backtrace,
+      :environment   => { 'PATH' => '/bin', 'REQUEST_URI' => '/users/1' },
+      :request       => {
+        :params     => { 'controller' => 'users', 'action' => 'show', 'id' => '1' },
+        :rails_root => '/path/to/application',
+        :url        => "http://test.host/users/1"
+      },
+      :session       => {
+        :key  => '123abc',
+        :data => { 'user_id' => '5', 'flash' => { 'notice' => 'Logged in successfully' } }
+      }
+    }
+  end
+
+  def assert_caught_and_sent
+    assert !Pulse.sender.collected.empty?
+  end
+
+  def assert_caught_and_not_sent
+    assert Pulse.sender.collected.empty?
+  end
+
+  def assert_array_starts_with(expected, actual)
+    assert_respond_to actual, :to_ary
+    array = actual.to_ary.reverse
+    expected.reverse.each_with_index do |value, i|
+      assert_equal value, array[i]
+    end
+  end
+
+  def assert_valid_node(document, xpath, content)
+    nodes = document.xpath(xpath)
+    assert nodes.any?{|node| node.content == content },
+           "Expected xpath #{xpath} to have content #{content}, " +
+           "but found #{nodes.map { |n| n.content }} in #{nodes.size} matching nodes." +
+           "Document:\n#{document.to_s}"
+  end
+
+  def assert_logged(expected)
+    assert_received(Pulse, :write_verbose_log) do |expect|
+      expect.with {|actual| actual =~ expected }
+    end
+  end
+
+  def assert_not_logged(expected)
+    assert_received(Pulse, :write_verbose_log) do |expect|
+      expect.with {|actual| actual =~ expected }.never
+    end
+  end
+
+
+end
+
+module DefinesConstants
+  def setup
+    @defined_constants = []
+  end
+
+  def teardown
+    @defined_constants.each do |constant|
+      Object.__send__(:remove_const, constant)
+    end
+  end
+
+  def define_constant(name, value)
+    Object.const_set(name, value)
+    @defined_constants << name
+  end
+end
+
+# Also stolen from AS 2.3.2
+class Array
+  # Wraps the object in an Array unless it's an Array.  Converts the
+  # object to an Array using #to_ary if it implements that.
+  def self.wrap(object)
+    case object
+    when nil
+      []
+    when self
+      object
+    else
+      if object.respond_to?(:to_ary)
+        object.to_ary
+      else
+        [object]
+      end
+    end
+  end
+
+end
+
+class CollectingSender
+  attr_reader :collected
+
+  def initialize
+    @collected = []
+  end
+
+  def send_to_pulse(data)
+    @collected << data
+  end
+end
+
+class FakeLogger
+  def info(*args);  end
+  def debug(*args); end
+  def warn(*args);  end
+  def error(*args); end
+  def fatal(*args); end
+end
+
+class BacktracedException < Exception
+  attr_accessor :backtrace
+  def initialize(opts)
+    @backtrace = opts[:backtrace]
+  end
+  def set_backtrace(bt)
+    @backtrace = bt
+  end
+  def message
+    "Something went wrong. Did you press the red button?"
+  end
+end

data/test/javascript_notifier_test.rb

@@ -0,0 +1,51 @@
+require File.expand_path '../helper', __FILE__
+require 'pulse/rails/javascript_notifier'
+require 'ostruct'
+
+class JavascriptNotifierTest < Test::Unit::TestCase
+  module FakeRenderer
+    def javascript_tag(text)
+      "<script>#{text}</script>"
+    end
+    def escape_javascript(text)
+      "ESC#{text}ESC"
+    end
+  end
+
+  class FakeController
+    def self.helper_method(*args)
+    end
+
+    include Pulse::Rails::JavascriptNotifier
+
+    def action_name
+      "action"
+    end
+
+    def controller_name
+      "controller"
+    end
+
+    def request
+      @request ||= OpenStruct.new
+    end
+
+    def render_to_string(options)
+      context = OpenStruct.new(options[:locals])
+      context.extend(FakeRenderer)
+      context.instance_eval do
+        erb = ERB.new(IO.read(options[:file]))
+        erb.result(binding)
+      end
+    end
+  end
+
+  should "make sure escape_javacript is called on the request.url" do
+    Pulse.configure do
+    end
+    controller = FakeController.new
+    controller.request.url = "bad_javascript"
+    assert controller.send(:pulse_javascript_notifier)['"ESCbad_javascriptESC"']
+    assert ! controller.send(:pulse_javascript_notifier)['"bad_javascript"']
+  end
+end

data/test/logger_test.rb

@@ -0,0 +1,79 @@
+require File.expand_path '../helper', __FILE__
+
+class LoggerTest < Test::Unit::TestCase
+  def stub_http(response, body = nil)
+    response.stubs(:body => body) if body
+    @http = stub(:post => response,
+                 :read_timeout= => nil,
+                 :open_timeout= => nil,
+                 :use_ssl= => nil)
+    Net::HTTP.stubs(:new).returns(@http)
+  end
+
+  def send_notice
+    Pulse.sender.send_to_pulse({'foo' => "bar"})
+  end
+
+  def stub_verbose_log
+    Pulse.stubs(:write_verbose_log)
+  end
+
+  def configure
+    Pulse.configure { |config| }
+  end
+
+  should "report that notifier is ready when configured" do
+    stub_verbose_log
+    configure
+    assert_logged /Notifier (.*) ready/
+  end
+
+  should "not report that notifier is ready when internally configured" do
+    stub_verbose_log
+    Pulse.configure(true) { |config| }
+    assert_not_logged /.*/
+  end
+
+  should "print environment info a successful notification without a body" do
+    reset_config
+    stub_verbose_log
+    stub_http(Net::HTTPSuccess)
+    send_notice
+    assert_logged /Environment Info:/
+    assert_not_logged /Response from Pulse:/
+  end
+
+  should "print environment info on a failed notification without a body" do
+    reset_config
+    stub_verbose_log
+    stub_http(Net::HTTPError)
+    send_notice
+    assert_logged /Environment Info:/
+    assert_not_logged /Response from Pulse:/
+  end
+
+  should "print environment info and response on a success with a body" do
+    reset_config
+    stub_verbose_log
+    stub_http(Net::HTTPSuccess, 'test')
+    send_notice
+    assert_logged /Environment Info:/
+    assert_logged /Response from Pulse:/
+  end
+
+  should "print environment info and response on a failure with a body" do
+    reset_config
+    stub_verbose_log
+    stub_http(Net::HTTPError, 'test')
+    send_notice
+    assert_logged /Environment Info:/
+    assert_logged /Response from Pulse:/
+  end
+
+  should "print information about the notice when Pulse server fails" do
+    stub_verbose_log
+    stub_http(Net::HTTPError, "test")
+    send_notice
+    assert_logged /Notice details:/
+  end
+end