appsignal 1.4.0.alpha.2 → 1.4.0.beta.1

data/spec/lib/appsignal_spec.rb

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require './spec/support/mocks/mock_extension'
 
 describe Appsignal do
@@ -9,7 +8,7 @@ describe Appsignal do
     Appsignal.extensions.clear
   end
 
-  let(:transaction) { regular_transaction }
+  let(:transaction) { http_request_transaction }
 
   describe ".config=" do
     it "should set the config" do
@@ -67,11 +66,6 @@ describe Appsignal do
         Appsignal.start
       end
 
-      it "should create a subscriber" do
-        Appsignal.start
-        Appsignal.subscriber.should be_a(Appsignal::Subscriber)
-      end
-
       context "when not active for this environment" do
         before { Appsignal.config = project_fixture_config('staging') }
 
@@ -92,18 +86,23 @@ describe Appsignal do
 
       context "when allocation tracking and gc instrumentation have been enabled" do
         before do
+          allow(GC::Profiler).to receive(:enable)
           Appsignal.config.config_hash[:enable_allocation_tracking] = true
           Appsignal.config.config_hash[:enable_gc_instrumentation] = true
         end
 
-        it "should install event hooks" do
-          Appsignal::Extension.should_receive(:install_allocation_event_hook)
-          Appsignal::Extension.should_receive(:install_gc_event_hooks)
+        it "should enable Ruby's GC::Profiler" do
+          expect(GC::Profiler).to receive(:enable)
+          Appsignal.start
+        end
+
+        it "should install the allocation event hook" do
+          expect(Appsignal::Extension).to receive(:install_allocation_event_hook)
           Appsignal.start
         end
 
         it "should add the gc probe to minutely" do
-          Appsignal::Minutely.should_receive(:add_gc_probe)
+          expect(Appsignal::Minutely).to receive(:add_gc_probe)
           Appsignal.start
         end
       end
@@ -114,14 +113,18 @@ describe Appsignal do
           Appsignal.config.config_hash[:enable_gc_instrumentation] = false
         end
 
-        it "should not install event hooks" do
-          Appsignal::Extension.should_not_receive(:install_allocation_event_hook)
-          Appsignal::Extension.should_not_receive(:install_gc_event_hooks)
+        it "should not enable Ruby's GC::Profiler" do
+          expect(GC::Profiler).not_to receive(:enable)
+          Appsignal.start
+        end
+
+        it "should not install the allocation event hook" do
+          expect(Appsignal::Minutely).not_to receive(:install_allocation_event_hook)
           Appsignal.start
         end
 
        it "should not add the gc probe to minutely" do
-          Appsignal::Minutely.should_not_receive(:add_gc_probe)
+          expect(Appsignal::Minutely).not_to receive(:add_gc_probe)
           Appsignal.start
        end
       end
@@ -163,7 +166,6 @@ describe Appsignal do
     context "when not active" do
       it "should should do nothing" do
         Appsignal::Extension.should_not_receive(:start)
-        Appsignal::Subscriber.should_not_receive(:new)
 
         Appsignal.forked
       end
@@ -177,7 +179,6 @@ describe Appsignal do
       it "should resubscribe and start the extension" do
         Appsignal.should_receive(:start_logger)
         Appsignal::Extension.should_receive(:start)
-        Appsignal::Subscriber.any_instance.should_receive(:resubscribe)
 
         Appsignal.forked
       end
@@ -252,7 +253,7 @@ describe Appsignal do
     describe ".monitor_transaction" do
       it "should do nothing but still yield the block" do
         Appsignal::Transaction.should_not_receive(:create)
-        ActiveSupport::Notifications.should_not_receive(:instrument)
+        Appsignal.should_not_receive(:instrument)
         object = double
         object.should_receive(:some_method).and_return(1)
 
@@ -322,7 +323,7 @@ describe Appsignal do
     describe ".monitor_transaction" do
       context "with a successful call" do
         it "should instrument and complete for a background job" do
-          ActiveSupport::Notifications.should_receive(:instrument).with(
+          Appsignal.should_receive(:instrument).with(
             'perform_job.something'
           ).and_yield
           Appsignal::Transaction.should_receive(:complete_current!)
@@ -341,7 +342,7 @@ describe Appsignal do
         end
 
         it "should instrument and complete for a http request" do
-          ActiveSupport::Notifications.should_receive(:instrument).with(
+          Appsignal.should_receive(:instrument).with(
             'process_action.something'
           ).and_yield
           Appsignal::Transaction.should_receive(:complete_current!)
@@ -361,7 +362,7 @@ describe Appsignal do
       end
 
       context "with an erroring call" do
-        let(:error) { VerySpecificError.new('the roof') }
+        let(:error) { VerySpecificError.new }
 
         it "should add the error to the current transaction and complete" do
           Appsignal::Transaction.any_instance.should_receive(:set_error).with(error)
@@ -392,7 +393,7 @@ describe Appsignal do
       end
 
       context "with an erroring call" do
-        let(:error) { VerySpecificError.new('the roof') }
+        let(:error) { VerySpecificError.new }
 
         it "should call monitor_transaction and stop and then raise the error" do
           Appsignal.should_receive(:monitor_transaction).with(
@@ -551,69 +552,123 @@ describe Appsignal do
 
     describe ".start_logger" do
       let(:out_stream) { StringIO.new }
-      let(:log_path) { File.join(project_fixture_path, 'log') }
+      let(:log_path) { File.join(tmp_dir, 'log') }
       let(:log_file) { File.join(log_path, 'appsignal.log') }
 
       before do
-        FileUtils.rm_f(log_file)
-        @original_stdout = $stdout
-        $stdout = out_stream
-        Appsignal.logger.error('Log something')
+        FileUtils.mkdir_p(log_path)
+
+        Appsignal.logger.error('Log in memory')
         Appsignal.config = project_fixture_config(
           'production',
           :log_path => log_path
         )
       end
-      after do
-        $stdout = @original_stdout
+      around do |example|
+        capture_stdout(out_stream) { example.run }
       end
+      after { FileUtils.rm_rf(log_path) }
 
       context "when the log path is writable" do
-        it "should log to file" do
-          Appsignal.start_logger
-          Appsignal.logger.level.should eq Logger::INFO
-          Appsignal.logger.error('Log to file')
-          File.exist?(log_file).should be_true
-          File.open(log_file).read.should include 'Log to file'
-          File.open(log_file).read.should include 'Log something'
+        context "when the log file is writable" do
+          let(:log_file_contents) { File.open(log_file).read }
+          before do
+            Appsignal.start_logger
+            Appsignal.logger.error('Log to file')
+          end
+
+          it "logs to file" do
+            expect(File.exist?(log_file)).to be_true
+            expect(log_file_contents).to include 'Log to file'
+          end
+
+          it "amends in memory log to log file" do
+            expect(log_file_contents).to include 'Log in memory'
+          end
+        end
+
+        context "when the log file is not writable" do
+          before do
+            FileUtils.touch log_file
+            FileUtils.chmod 0444, log_file
+
+            Appsignal.start_logger
+            Appsignal.logger.error('Log to not writable log file')
+          end
+
+          it "logs to stdout" do
+            expect(File.writable?(log_file)).to be_false
+            expect(out_stream.string).to include 'Log to not writable log file'
+          end
+
+          it "outputs a warning" do
+            output = out_stream.string
+            expect(output).to include "appsignal: Unable to start logger with "\
+              "log path '#{log_file}'."
+            expect(output).to include "appsignal: Permission denied"
+          end
         end
       end
 
-      context "when we're on Heroku" do
+      context "when the log path is not writable" do
         before do
-          ENV['DYNO'] = 'dyno1'
+          FileUtils.chmod 0444, log_path
+
+          Appsignal.start_logger
+          Appsignal.logger.error('Log to not writable log path')
         end
-        after { ENV.delete('DYNO') }
 
-        it "should log to stdout" do
+        it "logs to stdout" do
+          expect(File.writable?(log_path)).to be_false
+          expect(out_stream.string).to include 'Log to not writable log path'
+        end
+
+        it "amends in memory log to stdout" do
+          expect(out_stream.string).to include 'Log in memory'
+        end
+      end
+
+      context "when on Heroku" do
+        before do
           Appsignal.start_logger
-          Appsignal.logger.level.should eq Logger::INFO
           Appsignal.logger.error('Log to stdout')
+        end
+        around { |example| recognize_as_heroku { example.run } }
+
+        it "should log to stdout" do
           out_stream.string.should include 'appsignal: Log to stdout'
-          out_stream.string.should include 'Log something'
         end
-      end
 
-      context "when there is no in memory log" do
-        it "should not crash" do
-          Appsignal.in_memory_log = nil
-          Appsignal.start_logger
+        it "amends in memory log to stdout" do
+          expect(out_stream.string).to include 'Log in memory'
         end
       end
 
-      context "when there is no config and debug is on" do
-        it "should set the log level to info" do
-          Appsignal.config = nil
-          Appsignal.start_logger
-          Appsignal.logger.level.should eq Logger::INFO
+      describe "#logger#level" do
+        subject { Appsignal.logger.level }
+
+        context "when there is no config" do
+          before do
+            Appsignal.config = nil
+            Appsignal.start_logger
+          end
+
+          it "sets the log level to info" do
+            expect(subject).to eq Logger::INFO
+          end
         end
-      end
 
-      context "when there is a config and debug is on" do
-        it "should set the log level to debug" do
-          Appsignal.config.config_hash[:debug] = true
-          Appsignal.start_logger
-          Appsignal.logger.level.should eq Logger::DEBUG
+        context "when there is a config" do
+          context "when log level is configured to debug" do
+            before do
+              Appsignal.config.config_hash[:debug] = true
+              Appsignal.start_logger
+            end
+
+            it "sets the log level to debug" do
+              expect(subject).to eq Logger::DEBUG
+            end
+          end
         end
       end
     end
@@ -744,6 +799,25 @@ describe Appsignal do
       end
     end
 
+    describe ".instrument_sql" do
+      it "should instrument sql through the transaction" do
+        stub = double
+        stub.should_receive(:method_call).and_return('return value')
+
+        transaction.should_receive(:start_event)
+        transaction.should_receive(:finish_event).with(
+          'name',
+          'title',
+          'body',
+          1
+        )
+
+        Appsignal.instrument_sql 'name', 'title', 'body' do
+          stub.method_call
+        end.should eq 'return value'
+      end
+    end
+
     describe ".without_instrumentation" do
       let(:transaction) { double }
       before { Appsignal::Transaction.stub(:current => transaction) }

data/spec/spec_helper.rb

@@ -1,125 +1,28 @@
 ENV['RAILS_ENV'] ||= 'test'
+ENV['RACK_ENV'] ||= 'test'
 ENV['PADRINO_ENV'] ||= 'test'
 
+APPSIGNAL_SPEC_DIR = File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(APPSIGNAL_SPEC_DIR, 'support/stubs'))
+
+Bundler.require :default
 require 'rack'
 require 'rspec'
 require 'pry'
 require 'timecop'
 require 'webmock/rspec'
 
-puts "Runnings specs in #{RUBY_VERSION} on #{RUBY_PLATFORM}"
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'support/stubs'))
-
-begin
-  require 'rails'
-  Dir[File.expand_path(File.join(File.dirname(__FILE__), 'support/rails','*.rb'))].each {|f| require f}
-  puts 'Rails present, running Rails specific specs'
-  RAILS_PRESENT = true
-rescue LoadError
-  puts 'Rails not present, skipping Rails specific specs'
-  RAILS_PRESENT = false
-end
-
-def rails_present?
-  RAILS_PRESENT
-end
-
-def active_job_present?
-  require 'active_job'
-  true
-rescue LoadError
-  false
-end
-
-def active_record_present?
-  require 'active_record'
-  true
-rescue LoadError
-  false
+Dir[File.join(APPSIGNAL_SPEC_DIR, 'support/helpers', '*.rb')].each do |f|
+  require f
 end
-
-def running_jruby?
-  defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
-end
-
-def capistrano_present?
-  !! Gem.loaded_specs['capistrano']
-end
-
-def capistrano2_present?
-  capistrano_present? &&
-    Gem.loaded_specs['capistrano'].version < Gem::Version.new('3.0')
-end
-
-def capistrano3_present?
-  capistrano_present? &&
-    Gem.loaded_specs['capistrano'].version >= Gem::Version.new('3.0')
-end
-
-def sequel_present?
-  require 'sequel'
-  true
-rescue LoadError
-  false
-end
-
-def resque_present?
-  require 'resque'
-  true
-rescue LoadError
-  false
-end
-
-def sinatra_present?
-  begin
-    require 'sinatra'
-    true
-  rescue LoadError
-    false
+if DependencyHelper.rails_present?
+  Dir[File.join(DirectoryHelper.support_dir, 'rails', '*.rb')].each do |f|
+    require f
   end
 end
-
-def padrino_present?
-  require 'padrino'
-  true
-rescue LoadError
-  false
-end
-
-def grape_present?
-  require 'grape'
-  true
-rescue LoadError
-  false
-end
-
-def webmachine_present?
-  require 'webmachine'
-  true
-rescue LoadError
-  false
-end
-
 require 'appsignal'
 
-def spec_dir
-  File.dirname(__FILE__)
-end
-
-def tmp_dir
-  @tmp_dir ||= File.expand_path('tmp', spec_dir)
-end
-
-def fixtures_dir
-  @fixtures_dir ||= File.expand_path('support/fixtures', spec_dir)
-end
-
-def helpers_dir
-  @helpers_dir ||= File.expand_path('support/helpers', spec_dir)
-end
-
-Dir[File.join(helpers_dir, '*.rb')].each { |file| require file }
+puts "Running specs in #{RUBY_VERSION} on #{RUBY_PLATFORM}\n\n"
 
 # Add way to clear subscribers between specs
 module ActiveSupport
@@ -134,19 +37,24 @@ module ActiveSupport
 end
 
 RSpec.configure do |config|
+  config.include DirectoryHelper
+  config.include StdStreamsHelper
   config.include ConfigHelpers
   config.include EnvHelpers
-  config.include NotificationHelpers
   config.include TimeHelpers
   config.include TransactionHelpers
+  config.include ApiRequestHelper
+  config.include SystemHelpers
+  config.extend DependencyHelper
 
   config.before :all do
     FileUtils.rm_rf(tmp_dir)
     FileUtils.mkdir_p(tmp_dir)
-  end
 
-  config.after do
-    Thread.current[:appsignal_transaction] = nil
+    # Use modifiable SYSTEM_TMP_DIR
+    Appsignal::Config.send :remove_const, :SYSTEM_TMP_DIR
+    Appsignal::Config.send :const_set, :SYSTEM_TMP_DIR,
+      File.join(tmp_dir, 'system-tmp')
   end
 
   config.before do
@@ -159,13 +67,13 @@ RSpec.configure do |config|
     end
   end
 
+  config.after do
+    Thread.current[:appsignal_transaction] = nil
+  end
+
   config.after :all do
-    ActiveSupport::Notifications.notifier.clear_subscribers
     FileUtils.rm_f(File.join(project_fixture_path, 'log/appsignal.log'))
     Appsignal.config = nil
     Appsignal.logger = nil
   end
 end
-
-class VerySpecificError < RuntimeError
-end