appsignal 2.0.3 → 2.0.4

data/spec/lib/appsignal_spec.rb

@@ -44,7 +44,9 @@ describe Appsignal do
       it "should create a config from the env" do
         ENV['APPSIGNAL_PUSH_API_KEY'] = 'something'
         Appsignal::Extension.should_receive(:start)
-        Appsignal.start
+        expect(Appsignal.logger).not_to receive(:error)
+        silence { Appsignal.start }
+        expect(Appsignal.config[:push_api_key]).to eq('something')
       end
     end
 
@@ -551,7 +553,8 @@ describe Appsignal do
     end
 
     describe ".start_logger" do
-      let(:out_stream) { StringIO.new }
+      let(:out_stream) { std_stream }
+      let(:output) { out_stream.read }
       let(:log_path) { File.join(tmp_dir, 'log') }
       let(:log_file) { File.join(log_path, 'appsignal.log') }
 
@@ -564,28 +567,28 @@ describe Appsignal do
           :log_path => log_path
         )
       end
-      around do |example|
-        recognize_as_container(:none) do
-          capture_stdout(out_stream) { example.run }
-        end
-      end
+      around { |example| recognize_as_container(:none) { example.run } }
       after { FileUtils.rm_rf(log_path) }
 
       context "when the log path is writable" do
         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')
+            capture_stdout(out_stream) do
+              Appsignal.start_logger
+              Appsignal.logger.error('Log to file')
+            end
           end
 
           it "logs to file" do
             expect(File.exist?(log_file)).to be_true
-            expect(log_file_contents).to include 'Log to file'
+            expect(log_file_contents).to include '[ERROR] Log to file'
+            expect(output).to be_empty
           end
 
           it "amends in memory log to log file" do
-            expect(log_file_contents).to include 'Log in memory'
+            expect(log_file_contents).to include '[ERROR] appsignal: Log in memory'
           end
         end
 
@@ -594,46 +597,54 @@ describe Appsignal do
             FileUtils.touch log_file
             FileUtils.chmod 0444, log_file
 
-            Appsignal.start_logger
-            Appsignal.logger.error('Log to not writable log file')
+            capture_stdout(out_stream) do
+              Appsignal.start_logger
+              Appsignal.logger.error('Log to not writable log file')
+            end
           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'
+            expect(output).to include '[ERROR] appsignal: Log to not writable log file'
           end
 
           it "amends in memory log to stdout" do
-            expect(out_stream.string).to include 'Log in memory'
+            expect(output).to include '[ERROR] appsignal: Log in memory'
           end
 
           it "outputs a warning" do
-            expect(out_stream.string).to include \
-              "appsignal: Unable to start logger with log path '#{log_file}'.",
-              "appsignal: Permission denied"
+            expect(output).to include \
+              "[WARN] appsignal: Unable to start logger with log path '#{log_file}'.",
+              "[WARN] appsignal: Permission denied"
           end
         end
       end
 
-      context "when the log path is not writable" do
+      context "when the log path and fallback path are not writable" do
         before do
           FileUtils.chmod 0444, log_path
+          FileUtils.chmod 0444, Appsignal::Config::SYSTEM_TMP_DIR
 
-          Appsignal.start_logger
-          Appsignal.logger.error('Log to not writable log path')
+          capture_stdout(out_stream) do
+            Appsignal.start_logger
+            Appsignal.logger.error('Log to not writable log path')
+          end
+        end
+        after do
+          FileUtils.chmod 0755, Appsignal::Config::SYSTEM_TMP_DIR
         end
 
         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'
+          expect(output).to include '[ERROR] appsignal: Log to not writable log path'
         end
 
         it "amends in memory log to stdout" do
-          expect(out_stream.string).to include 'Log in memory'
+          expect(output).to include '[ERROR] appsignal: Log in memory'
         end
 
         it "outputs a warning" do
-          expect(out_stream.string).to include \
+          expect(output).to include \
             "appsignal: Unable to log to '#{log_path}' "\
             "or the '#{Appsignal::Config::SYSTEM_TMP_DIR}' fallback."
         end
@@ -641,17 +652,19 @@ describe Appsignal do
 
       context "when on Heroku" do
         before do
-          Appsignal.start_logger
-          Appsignal.logger.error('Log to stdout')
+          capture_stdout(out_stream) do
+            Appsignal.start_logger
+            Appsignal.logger.error('Log to stdout')
+          end
         end
         around { |example| recognize_as_heroku { example.run } }
 
         it "logs to stdout" do
-          expect(out_stream.string).to include 'appsignal: Log to stdout'
+          expect(output).to include '[ERROR] appsignal: Log to stdout'
         end
 
         it "amends in memory log to stdout" do
-          expect(out_stream.string).to include 'Log in memory'
+          expect(output).to include '[ERROR] appsignal: Log in memory'
         end
       end
 
@@ -661,7 +674,9 @@ describe Appsignal do
         context "when there is no config" do
           before do
             Appsignal.config = nil
-            Appsignal.start_logger
+            capture_stdout(out_stream) do
+              Appsignal.start_logger
+            end
           end
 
           it "sets the log level to info" do
@@ -673,7 +688,9 @@ describe Appsignal do
           context "when log level is configured to debug" do
             before do
               Appsignal.config.config_hash[:debug] = true
-              Appsignal.start_logger
+              capture_stdout(out_stream) do
+                Appsignal.start_logger
+              end
             end
 
             it "sets the log level to debug" do
@@ -685,11 +702,21 @@ describe Appsignal do
     end
 
     describe ".log_formatter" do
-      subject { Appsignal.log_formatter }
+      subject { Appsignal.log_formatter.call('Debug', Time.parse('2015-07-08'), nil, 'log line') }
+
+      it "formats a log" do
+        expect(subject).to eq "[2015-07-08T00:00:00 (process) ##{Process.pid}][Debug] log line\n"
+      end
+
+      context "with prefix" do
+        subject do
+          Appsignal.log_formatter("prefix").call('Debug', Time.parse('2015-07-08'), nil, 'log line')
+        end
 
-      it "should format a log line" do
-        Process.stub(:pid => 100)
-        subject.call('Debug', Time.parse('2015-07-08'), nil, 'log line').should eq "[2015-07-08T00:00:00 (process) #100][Debug] log line\n"
+        it "adds a prefix" do
+          expect(subject)
+            .to eq "[2015-07-08T00:00:00 (process) ##{Process.pid}][Debug] prefix: log line\n"
+        end
       end
     end
 
@@ -792,40 +819,36 @@ describe Appsignal do
     end
 
     describe ".instrument" do
-      it "should instrument through the transaction" do
-        stub = double
-        stub.should_receive(:method_call).and_return('return value')
+      before do
+        expect(Appsignal::Transaction).to receive(:current).at_least(:once).and_return(transaction)
+      end
 
-        transaction.should_receive(:start_event)
-        transaction.should_receive(:finish_event).with(
-          'name',
-          'title',
-          'body',
-          0
-        )
+      it "should instrument through the transaction" do
+        expect(transaction).to receive(:start_event)
+        expect(transaction).to receive(:finish_event)
+          .with('name', 'title', 'body', Appsignal::EventFormatter::DEFAULT)
 
-        Appsignal.instrument 'name', 'title', 'body' do
-          stub.method_call
-        end.should eq 'return value'
+        result = Appsignal.instrument 'name', 'title', 'body' do
+          'return value'
+        end
+        expect(result).to eq 'return value'
       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')
+      before do
+        expect(Appsignal::Transaction).to receive(:current).at_least(:once).and_return(transaction)
+      end
 
-        transaction.should_receive(:start_event)
-        transaction.should_receive(:finish_event).with(
-          'name',
-          'title',
-          'body',
-          1
-        )
+      it "should instrument sql through the transaction" do
+        expect(transaction).to receive(:start_event)
+        expect(transaction).to receive(:finish_event)
+          .with('name', 'title', 'body', Appsignal::EventFormatter::SQL_BODY_FORMAT)
 
-        Appsignal.instrument_sql 'name', 'title', 'body' do
-          stub.method_call
-        end.should eq 'return value'
+        result = Appsignal.instrument_sql 'name', 'title', 'body' do
+          'return value'
+        end
+        expect(result).to eq 'return value'
       end
     end
 

data/spec/spec_helper.rb

@@ -48,22 +48,23 @@ RSpec.configure do |config|
   config.extend DependencyHelper
 
   config.before :all do
-    FileUtils.rm_rf(tmp_dir)
-    FileUtils.mkdir_p(tmp_dir)
-
-    # Use modifiable SYSTEM_TMP_DIR
+    # Use modified 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')
+
+    FileUtils.rm_rf(tmp_dir)
+    FileUtils.mkdir_p(Appsignal::Config::SYSTEM_TMP_DIR)
   end
 
   config.before do
-    ENV['RAILS_ENV'] = 'test'
-    ENV['PADRINO_ENV'] = 'test'
+    ENV['RAILS_ENV'] ||= 'test'
+    ENV['RACK_ENV'] ||= 'test'
+    ENV['PADRINO_ENV'] ||= 'test'
 
     # Clean environment
     ENV.keys.select { |key| key.start_with?('APPSIGNAL_') }.each do |key|
-      ENV[key] = nil
+      ENV.delete(key)
     end
   end
 

data/spec/support/helpers/cli_helpers.rb

@@ -14,4 +14,13 @@ module CLIHelpers
       end
     end
   end
+
+  def set_input(value)
+    $stdin.puts value
+  end
+
+  def prepare_input
+    # Prepare the input by rewinding the pointer in the StringIO
+    $stdin.rewind
+  end
 end

data/spec/support/helpers/std_streams_helper.rb

@@ -1,35 +1,66 @@
 module StdStreamsHelper
+  def std_stream
+    Tempfile.new SecureRandom.uuid
+  end
+
   # Capture STDOUT in a variable
   #
+  # Given tempfiles are rewinded and unlinked after yield, so no cleanup
+  # required. You can read from the stream using `stdout.read`.
+  #
   # Usage
   #
-  #     out_stream = StringIO.new
+  #     out_stream = Tempfile.new
   #     capture_stdout(out_stream) { do_something }
   def capture_stdout(stdout)
-    original_stdout = $stdout
-    $stdout = stdout
+    original_stdout = $stdout.dup
+    $stdout.reopen stdout
 
     yield
-
-    $stdout = original_stdout
+  ensure
+    $stdout.reopen original_stdout
+    stdout.rewind
+    stdout.unlink
   end
 
   # Capture STDOUT and STDERR in variables
   #
+  # Given tempfiles are rewinded and unlinked after yield, so no cleanup
+  # required. You can read from the stream using `stdout.read`.
+  #
   # Usage
   #
-  #     out_stream = StringIO.new
-  #     err_stream = StringIO.new
+  #     out_stream = Tempfile.new
+  #     err_stream = Tempfile.new
   #     capture_std_streams(out_stream, err_stream) { do_something }
   def capture_std_streams(stdout, stderr)
-    original_stdout = $stdout
-    $stdout = stdout
-    original_stderr = $stderr
-    $stderr = stderr
+    original_stdout = $stdout.dup
+    $stdout.reopen stdout
+    original_stderr = $stderr.dup
+    $stderr.reopen stderr
 
     yield
+  ensure
+    $stdout.reopen original_stdout
+    $stderr.reopen original_stderr
+    stdout.rewind
+    stdout.unlink
+    stderr.rewind
+    stderr.unlink
+  end
 
-    $stdout = original_stdout
-    $stderr = original_stderr
+  def silence
+    std_stream = Tempfile.new(SecureRandom.uuid)
+    original_stdout = $stdout.dup
+    original_stderr = $stderr.dup
+    $stdout.reopen std_stream
+    $stderr.reopen std_stream
+
+    yield
+  ensure
+    $stdout.reopen original_stdout
+    $stderr.reopen original_stderr
+    std_stream.rewind
+    std_stream.unlink
   end
 end

data/spec/support/helpers/transaction_helpers.rb

@@ -8,7 +8,7 @@ module TransactionHelpers
   end
 
   def background_job_transaction(args={})
-    Appsignal::Transaction.create(
+    Appsignal::Transaction.new(
       '1',
       Appsignal::Transaction::BACKGROUND_JOB,
       Appsignal::Transaction::GenericRequest.new({
@@ -19,7 +19,7 @@ module TransactionHelpers
   end
 
   def http_request_transaction(args={})
-    Appsignal::Transaction.create(
+    Appsignal::Transaction.new(
       '1',
       Appsignal::Transaction::HTTP_REQUEST,
       Appsignal::Transaction::GenericRequest.new({

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Robert Beekman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-17 00:00:00.000000000 Z
+date: 2016-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -43,16 +43,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +153,7 @@ files:
 - lib/appsignal/cli.rb
 - lib/appsignal/cli/demo.rb
 - lib/appsignal/cli/diagnose.rb
+- lib/appsignal/cli/helpers.rb
 - lib/appsignal/cli/install.rb
 - lib/appsignal/cli/notify_of_deploy.rb
 - lib/appsignal/config.rb
@@ -220,6 +221,7 @@ files:
 - spec/lib/appsignal/capistrano3_spec.rb
 - spec/lib/appsignal/cli/demo_spec.rb
 - spec/lib/appsignal/cli/diagnose_spec.rb
+- spec/lib/appsignal/cli/helpers_spec.rb
 - spec/lib/appsignal/cli/install_spec.rb
 - spec/lib/appsignal/cli/notify_of_deploy_spec.rb
 - spec/lib/appsignal/cli_spec.rb
@@ -340,6 +342,7 @@ test_files:
 - spec/lib/appsignal/capistrano3_spec.rb
 - spec/lib/appsignal/cli/demo_spec.rb
 - spec/lib/appsignal/cli/diagnose_spec.rb
+- spec/lib/appsignal/cli/helpers_spec.rb
 - spec/lib/appsignal/cli/install_spec.rb
 - spec/lib/appsignal/cli/notify_of_deploy_spec.rb
 - spec/lib/appsignal/cli_spec.rb