projectlocker_pulse 0.2.1

data/script/integration_test.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require 'logger'
+require 'fileutils'
+
+RAILS_ENV = "production"
+RAILS_ROOT = FileUtils.pwd
+RAILS_DEFAULT_LOGGER = Logger.new(STDOUT)
+
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'projectlocker_pulse'
+require 'rails/init'
+
+fail "Please supply an API Key as the first argument" if ARGV.empty?
+
+host = ARGV[1]
+host ||= "errors.projectlocker.com"
+
+secure = (ARGV[2] == "secure")
+
+exception = begin
+              raise "Testing Pulse notifier with secure = #{secure}. If you can see this, it works."
+            rescue => foo
+              foo
+            end
+
+Pulse.configure do |config|
+  config.secure  = secure
+  config.host    = host
+  config.api_key = ARGV.first
+end
+puts "Configuration:"
+Pulse.configuration.to_hash.each do |key, value|
+  puts sprintf("%25s: %s", key.to_s, value.inspect.slice(0, 55))
+end
+puts "Sending #{secure ? "" : "in"}secure notification to project with key #{ARGV.first}"
+Pulse.notify(exception)
+

data/test/backtrace_test.rb

@@ -0,0 +1,162 @@
+require File.expand_path '../helper', __FILE__
+
+class BacktraceTest < Test::Unit::TestCase
+
+  should "parse a backtrace into lines" do
+    array = [
+      "app/models/user.rb:13:in `magic'",
+      "app/controllers/users_controller.rb:8:in `index'"
+    ]
+
+    backtrace = Pulse::Backtrace.parse(array)
+
+    line = backtrace.lines.first
+    assert_equal '13', line.number
+    assert_equal 'app/models/user.rb', line.file
+    assert_equal 'magic', line.method
+
+    line = backtrace.lines.last
+    assert_equal '8', line.number
+    assert_equal 'app/controllers/users_controller.rb', line.file
+    assert_equal 'index', line.method
+  end
+
+  should "parse a windows backtrace into lines" do
+    array = [
+      "C:/Program Files/Server/app/models/user.rb:13:in `magic'",
+      "C:/Program Files/Server/app/controllers/users_controller.rb:8:in `index'"
+    ]
+
+    backtrace = Pulse::Backtrace.parse(array)
+
+    line = backtrace.lines.first
+    assert_equal '13', line.number
+    assert_equal 'C:/Program Files/Server/app/models/user.rb', line.file
+    assert_equal 'magic', line.method
+
+    line = backtrace.lines.last
+    assert_equal '8', line.number
+    assert_equal 'C:/Program Files/Server/app/controllers/users_controller.rb', line.file
+    assert_equal 'index', line.method
+  end
+
+  should "be equal with equal lines" do
+    one = build_backtrace_array
+    two = one.dup
+
+    assert_equal Pulse::Backtrace.parse(one), Pulse::Backtrace.parse(two)
+  end
+
+  should "parse massive one-line exceptions into multiple lines" do
+    original_backtrace = Pulse::Backtrace.
+      parse(["one:1:in `one'\n   two:2:in `two'\n      three:3:in `three`"])
+    expected_backtrace = Pulse::Backtrace.
+      parse(["one:1:in `one'", "two:2:in `two'", "three:3:in `three`"])
+
+    assert_equal expected_backtrace, original_backtrace
+  end
+
+  context "with a project root" do
+    setup do
+      @project_root = '/some/path'
+      Pulse.configure {|config| config.project_root = @project_root }
+    end
+
+    teardown do
+      reset_config
+    end
+
+    should "filter out the project root" do
+      backtrace_with_root = Pulse::Backtrace.parse(
+        ["#{@project_root}/app/models/user.rb:7:in `latest'",
+         "#{@project_root}/app/controllers/users_controller.rb:13:in `index'",
+         "/lib/something.rb:41:in `open'"],
+        :filters => default_filters)
+      backtrace_without_root = Pulse::Backtrace.parse(
+        ["[PROJECT_ROOT]/app/models/user.rb:7:in `latest'",
+         "[PROJECT_ROOT]/app/controllers/users_controller.rb:13:in `index'",
+         "/lib/something.rb:41:in `open'"])
+
+      assert_equal backtrace_without_root, backtrace_with_root
+    end
+  end
+
+  context "with a project root equals to a part of file name" do
+    setup do
+      # Heroku-like
+      @project_root = '/app'
+      Pulse.configure {|config| config.project_root = @project_root }
+    end
+
+    teardown do
+      reset_config
+    end
+
+    should "filter out the project root" do
+      backtrace_with_root = Pulse::Backtrace.parse(
+        ["#{@project_root}/app/models/user.rb:7:in `latest'",
+         "#{@project_root}/app/controllers/users_controller.rb:13:in `index'",
+         "/lib/something.rb:41:in `open'"],
+        :filters => default_filters)
+      backtrace_without_root = Pulse::Backtrace.parse(
+        ["[PROJECT_ROOT]/app/models/user.rb:7:in `latest'",
+         "[PROJECT_ROOT]/app/controllers/users_controller.rb:13:in `index'",
+         "/lib/something.rb:41:in `open'"])
+
+      assert_equal backtrace_without_root, backtrace_with_root
+    end
+  end
+
+  context "with a blank project root" do
+    setup do
+      Pulse.configure {|config| config.project_root = '' }
+    end
+
+    teardown do
+      reset_config
+    end
+
+    should "not filter line numbers with respect to any project root" do
+      backtrace = ["/app/models/user.rb:7:in `latest'",
+                   "/app/controllers/users_controller.rb:13:in `index'",
+                   "/lib/something.rb:41:in `open'"]
+
+      backtrace_with_root =
+        Pulse::Backtrace.parse(backtrace, :filters => default_filters)
+
+      backtrace_without_root =
+        Pulse::Backtrace.parse(backtrace)
+
+      assert_equal backtrace_without_root, backtrace_with_root
+    end
+  end
+
+  should "remove notifier trace" do
+    inside_notifier  = ['lib/pulse.rb:13:in `voodoo`']
+    outside_notifier = ['users_controller:8:in `index`']
+
+    without_inside = Pulse::Backtrace.parse(outside_notifier)
+    with_inside    = Pulse::Backtrace.parse(inside_notifier + outside_notifier,
+                                                      :filters => default_filters)
+
+    assert_equal without_inside, with_inside
+  end
+
+  should "run filters on the backtrace" do
+    filters = [lambda { |line| line.sub('foo', 'bar') }]
+    input = Pulse::Backtrace.parse(["foo:13:in `one'", "baz:14:in `two'"],
+                                             :filters => filters)
+    expected = Pulse::Backtrace.parse(["bar:13:in `one'", "baz:14:in `two'"])
+    assert_equal expected, input
+  end
+
+  def build_backtrace_array
+    ["app/models/user.rb:13:in `magic'",
+      "app/controllers/users_controller.rb:8:in `index'"]
+  end
+
+  def default_filters
+    Pulse::Configuration::DEFAULT_BACKTRACE_FILTERS
+  end
+
+end

data/test/capistrano_test.rb

@@ -0,0 +1,34 @@
+require File.expand_path '../helper', __FILE__
+
+require 'capistrano/configuration'
+require 'pulse/capistrano'
+
+class CapistranoTest < Test::Unit::TestCase
+  def setup
+    super
+    reset_config
+
+    @configuration = Capistrano::Configuration.new
+    Pulse::Capistrano.load_into(@configuration)
+    @configuration.dry_run = true
+  end
+
+  should "define pulse:deploy task" do
+    assert_not_nil @configuration.find_task('pulse:deploy')
+  end
+
+  should "log when calling pulse:deploy task" do
+    @configuration.set(:current_revision, '084505b1c0e0bcf1526e673bb6ac99fbcb18aecc')
+    @configuration.set(:repository, 'repository')
+    @configuration.set(:current_release, '/home/deploy/rails_app/hoptoad')
+    io = StringIO.new
+    logger = Capistrano::Logger.new(:output => io)
+    logger.level = Capistrano::Logger::MAX_LEVEL
+
+    @configuration.logger = logger
+    @configuration.find_and_execute_task('pulse:deploy')
+
+    assert io.string.include?('** Notifying Pulse of Deploy')
+    assert io.string.include?('** Pulse Notification Complete')
+  end
+end

data/test/catcher_test.rb

@@ -0,0 +1,333 @@
+require File.expand_path '../helper', __FILE__
+
+class ActionControllerCatcherTest < Test::Unit::TestCase
+
+  include DefinesConstants
+
+  def setup
+    super
+    reset_config
+    Pulse.sender = CollectingSender.new
+    define_constant('RAILS_ROOT', '/path/to/rails/root')
+  end
+
+  def ignore(exception_class)
+    Pulse.configuration.ignore << exception_class
+  end
+
+  def build_controller_class(&definition)
+     Class.new(ActionController::Base).tap do |klass|
+      klass.__send__(:include, Pulse::Rails::ActionControllerCatcher)
+      klass.class_eval(&definition) if definition
+      define_constant('PulseTestController', klass)
+    end
+  end
+
+  def assert_sent_hash(hash, xpath)
+    hash.each do |key, value|
+      next if key.match(/^pulse\./) # We added this key.
+
+      element_xpath = "#{xpath}/var[@key = '#{key}']"
+      if value.respond_to?(:to_hash)
+        assert_sent_hash value.to_hash, element_xpath
+      else
+        assert_sent_element value, element_xpath
+      end
+    end
+  end
+
+  def assert_sent_element(value, xpath)
+    assert_valid_node last_sent_notice_document, xpath, stringify_array_elements(value).to_s
+  end
+
+  def stringify_array_elements(data)
+    if data.respond_to?(:to_ary)
+      data.collect do |value|
+        stringify_array_elements(value)
+      end
+    else
+      data.to_s
+    end
+  end
+
+  def assert_sent_request_info_for(request)
+    params = request.parameters.to_hash
+    assert_sent_hash params, '/notice/request/params'
+    assert_sent_element params['controller'], '/notice/request/component'
+    assert_sent_element params['action'], '/notice/request/action'
+    assert_sent_element url_from_request(request), '/notice/request/url'
+    assert_sent_hash request.env, '/notice/request/cgi-data'
+  end
+
+  def url_from_request(request)
+    url = "#{request.protocol}#{request.host}"
+
+    unless [80, 443].include?(request.port)
+      url << ":#{request.port}"
+    end
+
+    url << request.request_uri
+    url
+  end
+
+  def sender
+    Pulse.sender
+  end
+
+  def last_sent_notice_xml
+    sender.collected.last.to_xml
+  end
+
+  def last_sent_notice_document
+    assert_not_nil xml = last_sent_notice_xml, "No xml was sent"
+    Nokogiri::XML.parse(xml)
+  end
+
+  def process_action(opts = {}, &action)
+    opts[:request]  ||= ActionController::TestRequest.new
+    opts[:response] ||= ActionController::TestResponse.new
+    klass = build_controller_class do
+      cattr_accessor :local
+      define_method(:index, &action)
+      def local_request?
+        local
+      end
+    end
+    if opts[:filters]
+      klass.filter_parameter_logging *opts[:filters]
+    end
+    if opts[:user_agent]
+      if opts[:request].respond_to?(:user_agent=)
+        opts[:request].user_agent = opts[:user_agent]
+      else
+        opts[:request].env["HTTP_USER_AGENT"] = opts[:user_agent]
+      end
+    end
+    if opts[:port]
+      opts[:request].port = opts[:port]
+    end
+    klass.consider_all_requests_local = opts[:all_local]
+    klass.local                       = opts[:local]
+    controller = klass.new
+    controller.stubs(:rescue_action_in_public_without_pulse)
+    opts[:request].query_parameters = opts[:request].query_parameters.merge(opts[:params] || {})
+    opts[:request].session = ActionController::TestSession.new(opts[:session] || {})
+    # Prevents request.fullpath from crashing Rails in tests
+    opts[:request].env['REQUEST_URI'] = opts[:request].request_uri
+    controller.process(opts[:request], opts[:response])
+    controller
+  end
+
+  def process_action_with_manual_notification(args = {})
+    process_action(args) do
+      notify_pulse(:error_message => 'fail')
+      # Rails will raise a template error if we don't render something
+      render :nothing => true
+    end
+  end
+
+  def process_action_with_automatic_notification(args = {})
+    process_action(args) { raise "Hello" }
+  end
+
+  should "deliver notices from exceptions raised in public requests" do
+    process_action_with_automatic_notification
+    assert_caught_and_sent
+  end
+
+  should "not deliver notices from exceptions in local requests" do
+    process_action_with_automatic_notification(:local => true)
+    assert_caught_and_not_sent
+  end
+
+  should "not deliver notices from exceptions when all requests are local" do
+    process_action_with_automatic_notification(:all_local => true)
+    assert_caught_and_not_sent
+  end
+
+  should "not deliver notices from actions that don't raise" do
+    controller = process_action { render :text => 'Hello' }
+    assert_caught_and_not_sent
+    assert_equal 'Hello', controller.response.body
+  end
+
+  should "not deliver ignored exceptions raised by actions" do
+    ignore(RuntimeError)
+    process_action_with_automatic_notification
+    assert_caught_and_not_sent
+  end
+
+  should "deliver ignored exception raised manually" do
+    ignore(RuntimeError)
+    process_action_with_manual_notification
+    assert_caught_and_sent
+  end
+
+  should "deliver manually sent notices in public requests" do
+    process_action_with_manual_notification
+    assert_caught_and_sent
+  end
+
+  should "not deliver manually sent notices in local requests" do
+    process_action_with_manual_notification(:local => true)
+    assert_caught_and_not_sent
+  end
+
+  should "not deliver manually sent notices when all requests are local" do
+    process_action_with_manual_notification(:all_local => true)
+    assert_caught_and_not_sent
+  end
+
+  should "continue with default behavior after delivering an exception" do
+    controller = process_action_with_automatic_notification(:public => true)
+    # TODO: can we test this without stubbing?
+    assert_received(controller, :rescue_action_in_public_without_pulse)
+  end
+
+  should "not create actions from Pulse methods" do
+    controller = build_controller_class.new
+    assert_equal [], Pulse::Rails::ActionControllerCatcher.instance_methods
+  end
+
+  should "ignore exceptions when user agent is being ignored by regular expression" do
+    Pulse.configuration.ignore_user_agent_only = [/Ignored/]
+    process_action_with_automatic_notification(:user_agent => 'ShouldBeIgnored')
+    assert_caught_and_not_sent
+  end
+
+  should "ignore exceptions when user agent is being ignored by string" do
+    Pulse.configuration.ignore_user_agent_only = ['IgnoredUserAgent']
+    process_action_with_automatic_notification(:user_agent => 'IgnoredUserAgent')
+    assert_caught_and_not_sent
+  end
+
+  should "not ignore exceptions when user agent is not being ignored" do
+    Pulse.configuration.ignore_user_agent_only = ['IgnoredUserAgent']
+    process_action_with_automatic_notification(:user_agent => 'NonIgnoredAgent')
+    assert_caught_and_sent
+  end
+
+  should "send session data for manual notifications" do
+    data = { 'one' => 'two' }
+    process_action_with_manual_notification(:session => data)
+    assert_sent_hash data, "/notice/request/session"
+  end
+
+  should "send session data for automatic notification" do
+    data = { 'one' => 'two' }
+    process_action_with_automatic_notification(:session => data)
+    assert_sent_hash data, "/notice/request/session"
+  end
+
+  should "send request data for manual notification" do
+    params = { 'controller' => "pulse_test", 'action' => "index" }
+    controller = process_action_with_manual_notification(:params => params)
+    assert_sent_request_info_for controller.request
+  end
+
+  should "send request data for manual notification with non-standard port" do
+    params = { 'controller' => "pulse_test", 'action' => "index" }
+    controller = process_action_with_manual_notification(:params => params, :port => 81)
+    assert_sent_request_info_for controller.request
+  end
+
+  should "send request data for automatic notification" do
+    params = { 'controller' => "pulse_test", 'action' => "index" }
+    controller = process_action_with_automatic_notification(:params => params)
+    assert_sent_request_info_for controller.request
+  end
+
+  should "send request data for automatic notification with non-standard port" do
+    params = { 'controller' => "pulse_test", 'action' => "index" }
+    controller = process_action_with_automatic_notification(:params => params, :port => 81)
+    assert_sent_request_info_for controller.request
+  end
+
+  should "use standard rails logging filters on params and session and env" do
+    filtered_params = { "abc" => "123",
+                        "def" => "456",
+                        "ghi" => "[FILTERED]" }
+    filtered_session = { "abc" => "123",
+                         "ghi" => "[FILTERED]" }
+    ENV['ghi'] = 'abc'
+    filtered_env = { 'ghi' => '[FILTERED]' }
+    filtered_cgi = { 'REQUEST_METHOD' => '[FILTERED]' }
+
+    process_action_with_automatic_notification(:filters => [:ghi, :request_method],
+                                               :params => { "abc" => "123",
+                                                            "def" => "456",
+                                                            "ghi" => "789" },
+                                               :session => { "abc" => "123",
+                                                             "ghi" => "789" })
+    assert_sent_hash filtered_params, '/notice/request/params'
+    assert_sent_hash filtered_cgi, '/notice/request/cgi-data'
+    assert_sent_hash filtered_session, '/notice/request/session'
+  end
+
+  context "for a local error with development lookup enabled" do
+    setup do
+      Pulse.configuration.development_lookup = true
+      Pulse.stubs(:build_lookup_hash_for).returns({ :awesome => 2 })
+
+      @controller = process_action_with_automatic_notification(:local => true)
+      @response   = @controller.response
+    end
+
+    should "append custom CSS and JS to response body for a local error" do
+      assert_match /text\/css/, @response.body
+      assert_match /text\/javascript/, @response.body
+    end
+
+    should "contain host, API key and notice JSON" do
+      assert_match Pulse.configuration.host.to_json, @response.body
+      assert_match Pulse.configuration.api_key.to_json, @response.body
+      assert_match ({ :awesome => 2 }).to_json, @response.body
+    end
+  end
+
+  context "for a local error with development lookup disabled" do
+    setup do
+      Pulse.configuration.development_lookup = false
+
+      @controller = process_action_with_automatic_notification(:local => true)
+      @response   = @controller.response
+    end
+
+    should "not append custom CSS and JS to response for a local error" do
+      assert_no_match /text\/css/, @response.body
+      assert_no_match /text\/javascript/, @response.body
+    end
+  end
+
+  should "call session.to_hash if available" do
+    hash_data = {:key => :value}
+
+    session = ActionController::TestSession.new
+    ActionController::TestSession.stubs(:new).returns(session)
+    session.stubs(:to_hash).returns(hash_data)
+
+    process_action_with_automatic_notification
+    assert_received(session, :to_hash)
+    assert_received(session, :data) { |expect| expect.never }
+    assert_caught_and_sent
+  end
+
+  should "call session.data if session.to_hash is undefined" do
+    hash_data = {:key => :value}
+
+    session = ActionController::TestSession.new
+    ActionController::TestSession.stubs(:new).returns(session)
+    session.stubs(:data).returns(hash_data)
+    if session.respond_to?(:to_hash)
+      class << session
+        undef to_hash
+      end
+    end
+
+    process_action_with_automatic_notification
+    assert_received(session, :to_hash) { |expect| expect.never }
+    assert_received(session, :data) { |expect| expect.at_least_once }
+    assert_caught_and_sent
+  end
+
+end