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

data/spec/lib/appsignal/system/container_spec.rb

@@ -0,0 +1,67 @@
+describe Appsignal::System::Container do
+  describe ".id" do
+    subject { described_class.id }
+
+    context "when in docker" do
+      context "when running normally" do
+        around { |example| recognize_as_container(:docker) { example.run } }
+
+        it "returns id" do
+          expect(subject).to eq("0c703b75cdeaad7c933aa68b4678cc5c37a12d5ef5d7cb52c9cefe684d98e575")
+        end
+      end
+
+      context "when running with systemd" do
+        around do |example|
+          # Fabricated example. I'm unable to set up an environment that
+          # produces such a cgroups file.
+          recognize_as_container(:docker_systemd) { example.run }
+        end
+
+        it "returns id" do
+          expect(subject).to eq("09f1c4d420025670a3633edbc9b31450f1d6b2ff87b5912a10c320ad398c7215")
+        end
+      end
+    end
+
+    context "when in LXC" do
+      around { |example| recognize_as_container(:lxc) { example.run } }
+
+      it "returns id" do
+        expect(subject).to eq("1a2e485e-3947-4bb6-8c24-8774f0859648")
+      end
+    end
+
+    context "when not in container" do
+      around { |example| recognize_as_container(:none) { example.run } }
+
+      it "returns nil" do
+        expect(subject).to be_nil
+      end
+    end
+
+    context "when no permission to read cgroup file" do
+      let(:out_stream) { StringIO.new }
+      let(:no_permission_file) do
+        File.join(fixtures_dir, 'containers', 'cgroups', 'no_permission')
+      end
+      before do
+        File.chmod 0333, no_permission_file
+        Appsignal.logger = Logger.new(out_stream)
+      end
+      around { |example| recognize_as_container(:no_permission) { example.run } }
+      after { File.chmod 0644, no_permission_file }
+
+      it "returns nil" do
+        expect(subject).to be_nil
+      end
+
+      it "logs the error" do
+        subject
+        expect(out_stream.string).to include \
+          "Unable to read '#{no_permission_file}' to determine cgroup",
+          "Permission denied"
+      end
+    end
+  end
+end

data/spec/lib/appsignal/system_spec.rb

@@ -0,0 +1,49 @@
+describe Appsignal::System do
+  describe ".container?" do
+    subject { described_class.container? }
+
+    context "when on Heroku" do
+      around { |example| recognize_as_heroku { example.run } }
+
+      it "returns true" do
+        expect(subject).to be_true
+      end
+    end
+
+    context "when in docker" do
+      around { |example| recognize_as_container(:docker) { example.run } }
+
+      it "returns true" do
+        expect(subject).to be_true
+      end
+    end
+
+    context "when not in container" do
+      around { |example| recognize_as_container(:none) { example.run } }
+
+      it "returns false" do
+        expect(subject).to be_false
+      end
+    end
+  end
+
+  describe ".heroku?" do
+    subject { described_class.heroku? }
+
+    context "when on Heroku" do
+      around { |example| recognize_as_heroku { example.run } }
+
+      it "returns true" do
+        expect(subject).to be_true
+      end
+    end
+
+    context "when not on Heroku" do
+      around { |example| recognize_as_container(:none) { example.run } }
+
+      it "returns false" do
+        expect(subject).to be_false
+      end
+    end
+  end
+end

data/spec/lib/appsignal/transaction_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require_relative '../../support/mocks/fake_gc_profiler'
 
 class Smash < Hash
   def []=(key, val)
@@ -25,7 +25,7 @@ describe Appsignal::Transaction do
   context "class methods" do
     describe ".create" do
       it "should add the transaction to thread local" do
-        Appsignal::Extension.should_receive(:start_transaction).with('1', 'http_request')
+        Appsignal::Extension.should_receive(:start_transaction).with('1', 'http_request', 0)
 
         created_transaction = Appsignal::Transaction.create('1', namespace, request, options)
 
@@ -122,10 +122,11 @@ describe Appsignal::Transaction do
 
       context "if a transaction is discarded" do
         it "should not complete the transaction" do
-          Appsignal::Transaction.current.should_not_receive(:complete)
+          expect(Appsignal::Transaction.current.ext).to_not receive(:complete)
 
           Appsignal::Transaction.current.discard!
           expect(Appsignal::Transaction.current.discarded?).to be_true
+
           Appsignal::Transaction.complete_current!
 
           Thread.current[:appsignal_transaction].should be_nil
@@ -351,10 +352,10 @@ describe Appsignal::Transaction do
     end
 
     describe "set_sample_data" do
-      it "should generate json and set the data" do
+      it "should set the data" do
         transaction.ext.should_receive(:set_sample_data).with(
           'params',
-          '{"controller":"blog_posts","action":"show","id":"1"}'
+          Appsignal::Utils.data_generate({"controller" => "blog_posts", "action" => "show", "id" => "1"})
         ).once
 
         transaction.set_sample_data(
@@ -381,23 +382,29 @@ describe Appsignal::Transaction do
       it "should sample data" do
         transaction.ext.should_receive(:set_sample_data).with(
           'environment',
-          "{\"CONTENT_LENGTH\":\"0\",\"REQUEST_METHOD\":\"GET\",\"SERVER_NAME\":\"example.org\",\"SERVER_PORT\":\"80\",\"PATH_INFO\":\"/blog\"}"
+          Appsignal::Utils.data_generate({
+            "CONTENT_LENGTH" => "0",
+            "REQUEST_METHOD" => "GET",
+            "SERVER_NAME" => "example.org",
+            "SERVER_PORT" => "80",
+            "PATH_INFO" => "/blog"
+          })
         ).once
         transaction.ext.should_receive(:set_sample_data).with(
           'session_data',
-          "{}"
+          Appsignal::Utils.data_generate({})
         ).once
         transaction.ext.should_receive(:set_sample_data).with(
           'params',
-          '{"controller":"blog_posts","action":"show","id":"1"}'
+          Appsignal::Utils.data_generate({"controller" => "blog_posts", "action" => "show", "id" => "1"})
         ).once
         transaction.ext.should_receive(:set_sample_data).with(
           'metadata',
-          '{"key":"value"}'
+          Appsignal::Utils.data_generate({"key" => "value"})
         ).once
         transaction.ext.should_receive(:set_sample_data).with(
           'tags',
-          "{}"
+          Appsignal::Utils.data_generate({})
         ).once
 
         transaction.sample_data
@@ -431,7 +438,7 @@ describe Appsignal::Transaction do
           transaction.ext.should_receive(:set_error).with(
             'RSpec::Mocks::Mock',
             'test message',
-            "[\"line 1\"]"
+            Appsignal::Utils.data_generate(['line 1'])
           )
 
           transaction.set_error(error)
@@ -449,7 +456,7 @@ describe Appsignal::Transaction do
           transaction.ext.should_receive(:set_error).with(
             'RSpec::Mocks::Mock',
             '',
-            "[\"line 1\"]"
+            Appsignal::Utils.data_generate(['line 1'])
           )
 
           transaction.set_error(error)
@@ -471,7 +478,8 @@ describe Appsignal::Transaction do
           'name',
           'title',
           'body',
-          1
+          1,
+          0
         )
 
         transaction.finish_event(
@@ -487,6 +495,7 @@ describe Appsignal::Transaction do
           'name',
           '',
           '',
+          0,
           0
         )
 
@@ -497,6 +506,14 @@ describe Appsignal::Transaction do
           nil
         )
       end
+
+      it "should add garbage collection time" do
+        allow_any_instance_of(Appsignal::GarbageCollectionProfiler)
+          .to receive(:internal_profiler)
+          .and_return(FakeGCProfiler.new(0.12345))
+
+        transaction.finish_event('name', nil, nil, nil)
+      end
     end
 
     describe "#record_event" do

data/spec/lib/appsignal/transmitter_spec.rb

@@ -1,13 +1,14 @@
-require 'spec_helper'
-
 describe Appsignal::Transmitter do
   let(:config) { project_fixture_config }
   let(:action) { 'action' }
+  let(:log) { StringIO.new }
   let(:instance) { Appsignal::Transmitter.new(action, config) }
+  before do
+    config.config_hash[:hostname] = 'app1.local'
+    config.logger = Logger.new(log)
+  end
 
   describe "#uri" do
-    before { ENV['APPSIGNAL_HOSTNAME'] = 'app1.local' }
-
     subject { instance.uri.to_s }
 
     it { should include 'https://push.appsignal.com/1/action?' }
@@ -22,9 +23,11 @@ describe Appsignal::Transmitter do
     before do
       stub_request(
         :post,
-        "https://push.appsignal.com/1/action?api_key=abc&environment=production&gem_version=#{Appsignal::VERSION}&hostname=#{Socket.gethostname}&name=TestApp"
+        "https://push.appsignal.com/1/action?api_key=abc"\
+          "&environment=production&gem_version=#{Appsignal::VERSION}"\
+          "&hostname=#{config.config_hash[:hostname]}&name=TestApp"
       ).with(
-        :body => Zlib::Deflate.deflate("{\"the\":\"payload\"}", Zlib::BEST_SPEED),
+        :body => Appsignal::Utils::Gzip.compress("{\"the\":\"payload\"}"),
         :headers => {
           'Content-Encoding' => 'gzip',
           'Content-Type' => 'application/json; charset=UTF-8',
@@ -33,20 +36,57 @@ describe Appsignal::Transmitter do
         :status => 200
       )
     end
-
     subject { instance.transmit(:the => :payload) }
 
     it { should eq '200' }
-  end
 
-  describe "#http_post" do
-    before do
-      Socket.stub(:gethostname => 'app1.local')
+    context "with ca_file_path config option set" do
+      context "when not existing file" do
+        before do
+          config.config_hash[:ca_file_path] = File.join(resources_dir, "cacert.pem")
+        end
+
+        it "ignores the config and logs a warning" do
+          expect(subject).to eq '200'
+          expect(log.string).to_not include "Ignoring non-existing or unreadable " \
+            "`ca_file_path`: #{config[:ca_file_path]}"
+        end
+      end
+
+      context "when not existing file" do
+        before do
+          config.config_hash[:ca_file_path] = File.join(tmp_dir, "ca_file_that_does_not_exist")
+        end
+
+        it "ignores the config and logs a warning" do
+          expect(subject).to eq '200'
+          expect(log.string).to include "Ignoring non-existing or unreadable " \
+            "`ca_file_path`: #{config[:ca_file_path]}"
+        end
+      end
+
+      context "when not readable file" do
+        let(:file) { File.join(tmp_dir, "ca_file") }
+        before do
+          config.config_hash[:ca_file_path] = file
+          File.open(file, "w") { |f| f.chmod 0000 }
+        end
+
+        it "ignores the config and logs a warning" do
+          expect(subject).to eq '200'
+          expect(log.string).to include "Ignoring non-existing or unreadable " \
+            "`ca_file_path`: #{config[:ca_file_path]}"
+        end
+
+        after { File.delete file }
+      end
     end
+  end
 
+  describe "#http_post" do
     subject { instance.send(:http_post, 'the' => 'payload') }
 
-    its(:body) { should eq Zlib::Deflate.deflate("{\"the\":\"payload\"}", Zlib::BEST_SPEED) }
+    its(:body) { should eq Appsignal::Utils::Gzip.compress("{\"the\":\"payload\"}") }
     its(:path) { should eq instance.uri.request_uri }
 
     it "should have the correct headers" do
@@ -55,13 +95,6 @@ describe Appsignal::Transmitter do
     end
   end
 
-  describe ".CA_FILE_PATH" do
-    subject { Appsignal::Transmitter::CA_FILE_PATH }
-
-    it { should include('resources/cacert.pem') }
-    it("should exist") { File.exist?(subject).should be_true }
-  end
-
   describe "#http_client" do
     subject { instance.send(:http_client) }
 
@@ -80,7 +113,7 @@ describe Appsignal::Transmitter do
       its(:proxy?) { should be_false }
       its(:use_ssl?) { should be_true }
       its(:verify_mode) { should eq OpenSSL::SSL::VERIFY_PEER }
-      its(:ca_file) { Appsignal::Transmitter::CA_FILE_PATH }
+      its(:ca_file) { should eq config[:ca_file_path] }
     end
 
     context "with a proxy" do

data/spec/lib/appsignal/utils/gzip_spec.rb

@@ -0,0 +1,10 @@
+describe Appsignal::Utils::Gzip do
+  describe ".compress" do
+    let(:value) { "foo" }
+    subject { described_class.compress(value).force_encoding("UTF-8") }
+
+    it "returns a gziped value" do
+      expect(subject).to eq("x\u0001K\xCB\xCF\a\u0000\u0002\x82\u0001E")
+    end
+  end
+end

data/spec/lib/appsignal/utils/params_sanitizer_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe Appsignal::Utils::ParamsSanitizer do
   let(:file) { uploaded_file }
   let(:params) do

data/spec/lib/appsignal/utils/query_params_sanitizer_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe Appsignal::Utils::QueryParamsSanitizer do
   describe ".sanitize" do
     context "when only_top_level = true" do

data/spec/lib/appsignal/utils_spec.rb

@@ -1,8 +1,64 @@
 # encoding: UTF-8
 
-require 'spec_helper'
-
 describe Appsignal::Utils do
+  describe ".data_generate" do
+    subject { Appsignal::Utils.data_generate(body) }
+
+    context "with a valid hash body" do
+      let(:body) do
+        {
+          'the' => 'payload',
+          'int' => 1,
+          'float' => 1.0,
+          1 => true,
+          nil => 'test',
+          :foo => [1, 2, 'three', {'foo' => 'bar'}],
+          'bar' => nil,
+          'baz' => {'foo' => 'bʊr', 'arr' => [1, 2]}
+        }
+      end
+
+      it { should eq Appsignal::Utils.data_generate(body) }
+      it { should_not eq Appsignal::Utils.data_generate({}) }
+      it { should_not eq 'a string' }
+      its(:to_s) { should eq %({"":"test","1":true,"bar":null,"baz":{"arr":[1,2],"foo":"bʊr"},"float":1.0,"foo":[1,2,"three",{"foo":"bar"}],"int":1,"the":"payload"}) }
+    end
+
+    context "with a valid array body" do
+      let(:body) do
+        [1, 'string', 10, {'foo' => 'bʊr'}]
+      end
+
+      its(:to_s) { should eq %([1,\"string\",10,{\"foo\":\"bʊr\"}]) }
+    end
+
+    context "with a body that contains strings with invalid utf-8 content" do
+      let(:string_with_invalid_utf8) { [0x61, 0x61, 0x85].pack('c*') }
+      let(:body) { {
+        'field_one' => [0x61, 0x61].pack('c*'),
+        :field_two => string_with_invalid_utf8,
+        'field_three' => [
+          'one', string_with_invalid_utf8
+        ],
+        'field_four' => {
+          'one' => string_with_invalid_utf8
+        }
+      } }
+
+      its(:to_s) { should eq %({"field_four":{"one":"aa�"},"field_one":"aa","field_three":["one","aa�"],"field_two":"aa�"}) }
+    end
+
+    context "with an invalid body" do
+      let(:body) { 'body' }
+
+      it "should raise a type error" do
+        expect {
+          subject
+        }.to raise_error TypeError
+      end
+    end
+  end
+
   describe ".json_generate" do
     subject { Appsignal::Utils.json_generate(body) }
 
@@ -14,7 +70,7 @@ describe Appsignal::Utils do
           nil => 'test',
           :foo => [1, 2, 'three'],
           'bar' => nil,
-          'baz' => { 'foo' => 'bar' }
+          'baz' => {'foo' => 'bar'}
         }
       end