appsignal 2.4.0 → 2.4.1

data/spec/lib/appsignal/integrations/que_spec.rb

@@ -0,0 +1,174 @@
+if DependencyHelper.que_present?
+  require "appsignal/integrations/que"
+
+  describe Appsignal::Integrations::QuePlugin do
+    describe "#_run" do
+      let(:job_attrs) do
+        {
+          :job_id => 123,
+          :queue => "dfl",
+          :job_class => "MyQueJob",
+          :priority => 100,
+          :args => %w(1 birds),
+          :run_at => fixed_time,
+          :error_count => 0
+        }
+      end
+
+      let(:env) do
+        {
+          :class => "MyQueJob",
+          :method => "run",
+          :metadata => {
+            :id => 123,
+            :queue => "dfl",
+            :priority => 100,
+            :run_at => fixed_time.to_s,
+            :attempts => 0
+          },
+          :params => %w(1 birds)
+        }
+      end
+
+      let(:job) do
+        Class.new(::Que::Job) do
+          def run(*args)
+          end
+        end
+      end
+      let(:instance) { job.new(job_attrs) }
+      let(:transaction) do
+        Appsignal::Transaction.new(
+          SecureRandom.uuid,
+          Appsignal::Transaction::BACKGROUND_JOB,
+          Appsignal::Transaction::GenericRequest.new(env)
+        )
+      end
+
+      before do
+        allow(Que).to receive(:execute)
+
+        start_agent
+        expect(Appsignal.active?).to be_truthy
+        transaction
+
+        expect(Appsignal::Transaction).to receive(:create)
+          .with(
+            kind_of(String),
+            Appsignal::Transaction::BACKGROUND_JOB,
+            kind_of(Appsignal::Transaction::GenericRequest)
+          ).and_return(transaction)
+        allow(Appsignal::Transaction).to receive(:current).and_return(transaction)
+        expect(transaction.ext).to receive(:finish).and_return(true)
+        expect(transaction.ext).to receive(:complete)
+      end
+
+      subject { transaction.to_h }
+
+      context "success" do
+        it "creates a transaction for a job" do
+          expect do
+            instance._run
+          end.to_not raise_exception
+
+          expect(subject).to include(
+            "action" => "MyQueJob#run",
+            "id" => instance_of(String),
+            "namespace" => Appsignal::Transaction::BACKGROUND_JOB
+          )
+          expect(subject["error"]).to be_nil
+          expect(subject["events"].first).to include(
+            "allocation_count" => kind_of(Integer),
+            "body" => "",
+            "body_format" => Appsignal::EventFormatter::DEFAULT,
+            "child_allocation_count" => kind_of(Integer),
+            "child_duration" => kind_of(Float),
+            "child_gc_duration" => kind_of(Float),
+            "count" => 1,
+            "gc_duration" => kind_of(Float),
+            "start" => kind_of(Float),
+            "duration" => kind_of(Float),
+            "name" => "perform_job.que",
+            "title" => ""
+          )
+          expect(subject["sample_data"]).to include(
+            "params" => %w(1 birds),
+            "metadata" => {
+              "attempts" => 0,
+              "id" => 123,
+              "priority" => 100,
+              "queue" => "dfl",
+              "run_at" => fixed_time.to_s
+            }
+          )
+        end
+      end
+
+      context "with exception" do
+        let(:error) { ExampleException.new("oh no!") }
+
+        it "should report exceptions and re-raise them" do
+          allow(instance).to receive(:run).and_raise(error)
+
+          expect do
+            instance._run
+          end.to raise_error(ExampleException)
+
+          expect(subject).to include(
+            "action" => "MyQueJob#run",
+            "id" => instance_of(String),
+            "namespace" => Appsignal::Transaction::BACKGROUND_JOB
+          )
+          expect(subject["error"]).to include(
+            "backtrace" => kind_of(String),
+            "name" => error.class.name,
+            "message" => error.message
+          )
+          expect(subject["sample_data"]).to include(
+            "params" => %w(1 birds),
+            "metadata" => {
+              "attempts" => 0,
+              "id" => 123,
+              "priority" => 100,
+              "queue" => "dfl",
+              "run_at" => fixed_time.to_s
+            }
+          )
+        end
+      end
+
+      context "with error" do
+        let(:error) { ExampleStandardError.new("oh no!") }
+
+        it "should report errors and not re-raise them" do
+          allow(instance).to receive(:run).and_raise(error)
+
+          expect do
+            instance._run
+          end.to_not raise_error
+
+          expect(subject).to include(
+            "action" => "MyQueJob#run",
+            "id" => instance_of(String),
+            "namespace" => Appsignal::Transaction::BACKGROUND_JOB
+          )
+          expect(subject["error"]).to include(
+            "backtrace" => kind_of(String),
+            "name" => error.class.name,
+            "message" => error.message
+          )
+          expect(subject["sample_data"]).to include(
+            "params" => %w(1 birds),
+            "metadata" => {
+              "attempts" => 0,
+              "id" => 123,
+              "priority" => 100,
+              "queue" => "dfl",
+              "run_at" => fixed_time.to_s
+            }
+          )
+        end
+      end
+    end
+  end
+end

data/spec/lib/appsignal/system_spec.rb

@@ -1,3 +1,5 @@
+require "appsignal/system"
+
 describe Appsignal::System do
   describe ".heroku?" do
     subject { described_class.heroku? }
@@ -16,4 +18,113 @@ describe Appsignal::System do
       end
     end
   end
+
+  describe ".installed_agent_platform" do
+    let(:const_name) { "GEM_EXT_PATH".freeze }
+    let(:tmp_ext_dir) { File.join(tmp_dir, "ext") }
+    let(:platform_file) { File.join(Appsignal::System::GEM_EXT_PATH, "appsignal.platform") }
+    around do |example|
+      original_gem_ext_path = Appsignal::System.const_get(const_name)
+      Appsignal::System.send(:remove_const, const_name)
+      Appsignal::System.const_set(const_name, tmp_ext_dir)
+      example.run
+      Appsignal::System.send(:remove_const, const_name)
+      Appsignal::System.const_set(const_name, original_gem_ext_path)
+    end
+    after { FileUtils.rm_rf(tmp_ext_dir) }
+    subject { described_class.installed_agent_platform }
+
+    context "with an ext/appsignal.platform file" do
+      before do
+        FileUtils.mkdir_p(Appsignal::System::GEM_EXT_PATH)
+        File.open(platform_file, "w") do |file|
+          file.write "foo"
+        end
+      end
+
+      it "returns the contents of the file" do
+        expect(subject).to eq("foo")
+      end
+    end
+
+    context "without an ext/appsignal.platform file" do
+      it "returns nil" do
+        expect(subject).to be_nil
+      end
+    end
+  end
+
+  describe ".agent_platform" do
+    let(:os) { "linux" }
+    let(:ldd_output) { "" }
+    before do
+      allow(described_class).to receive(:ldd_version_output).and_return(ldd_output)
+      allow(Gem::Platform.local).to receive(:os).and_return(os)
+    end
+    subject { described_class.agent_platform }
+
+    context "when the system detection doesn't work" do
+      it "returns the libc build" do
+        is_expected.to eq("linux")
+      end
+    end
+
+    context "when using the APPSIGNAL_BUILD_FOR_MUSL env var" do
+      it "returns the musl build" do
+        ENV["APPSIGNAL_BUILD_FOR_MUSL"] = "1"
+        is_expected.to eq("linux-musl")
+        ENV.delete("APPSIGNAL_BUILD_FOR_MUSL")
+      end
+    end
+
+    context "when on a musl system" do
+      let(:ldd_output) { "musl libc (x86_64)\nVersion 1.1.16" }
+
+      it "returns the musl build" do
+        is_expected.to eq("linux-musl")
+      end
+    end
+
+    context "when on a libc system" do
+      let(:ldd_output) { "ldd (Debian GLIBC 2.15-18+deb8u7) 2.15" }
+
+      it "returns the libc build" do
+        is_expected.to eq("linux")
+      end
+
+      context "when on an old libc system" do
+        let(:ldd_output) { "ldd (Debian GLIBC 2.14-18+deb8u7) 2.14" }
+
+        it "returns the musl build" do
+          is_expected.to eq("linux-musl")
+        end
+      end
+
+      context "when on a very old libc system" do
+        let(:ldd_output) { "ldd (Debian GLIBC 2.5-18+deb8u7) 2.5" }
+
+        it "returns the musl build" do
+          is_expected.to eq("linux-musl")
+        end
+      end
+    end
+
+    context "when on macOS" do
+      let(:os) { "darwin" }
+      let(:ldd_output) { "ldd: command not found" }
+
+      it "returns the darwin build" do
+        is_expected.to eq("darwin")
+      end
+    end
+
+    context "when on FreeBSD" do
+      let(:os) { "freebsd" }
+      let(:ldd_output) { "ldd: illegal option -- -" }
+
+      it "returns the darwin build" do
+        is_expected.to eq("freebsd")
+      end
+    end
+  end
 end

data/spec/support/helpers/dependency_helper.rb

@@ -63,6 +63,10 @@ module DependencyHelper
       Gem.loaded_specs["capistrano"].version >= Gem::Version.new("3.0")
   end
 
+  def que_present?
+    dependency_present? "que"
+  end
+
   def dependency_present?(dependency_file)
     Gem.loaded_specs.key? dependency_file
   end

data/spec/support/helpers/log_helpers.rb

@@ -1,15 +1,20 @@
 module LogHelpers
   def use_logger_with(log)
-    Appsignal.logger = Logger.new(log)
-    Appsignal.logger.formatter =
-      proc do |severity, _datetime, _progname, msg|
-        # This format is used in the `contains_log` matcher.
-        "[#{severity}] #{msg}\n"
-      end
+    Appsignal.logger = test_logger(log)
     yield
     Appsignal.logger = nil
   end
 
+  def test_logger(log)
+    Logger.new(log).tap do |logger|
+      logger.formatter =
+        proc do |severity, _datetime, _progname, msg|
+          # This format is used in the `contains_log` matcher.
+          "[#{severity}] #{msg}\n"
+        end
+    end
+  end
+
   def log_contents(log)
     log.rewind
     log.read

data/spec/support/helpers/transaction_helpers.rb

@@ -28,4 +28,10 @@ module TransactionHelpers
       }.merge(args))
     )
   end
+
+  # Use when {Appsignal::Transaction.clear_current_transaction!} is stubbed to
+  # clear the current transaction on the current thread.
+  def clear_current_transaction!
+    Thread.current[:appsignal_transaction] = nil
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Robert Beekman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2017-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -154,6 +154,7 @@ files:
 - gemfiles/grape.gemfile
 - gemfiles/no_dependencies.gemfile
 - gemfiles/padrino.gemfile
+- gemfiles/que.gemfile
 - gemfiles/rails-3.2.gemfile
 - gemfiles/rails-4.0.gemfile
 - gemfiles/rails-4.1.gemfile
@@ -196,6 +197,7 @@ files:
 - lib/appsignal/hooks/net_http.rb
 - lib/appsignal/hooks/passenger.rb
 - lib/appsignal/hooks/puma.rb
+- lib/appsignal/hooks/que.rb
 - lib/appsignal/hooks/rake.rb
 - lib/appsignal/hooks/redis.rb
 - lib/appsignal/hooks/sequel.rb
@@ -211,6 +213,7 @@ files:
 - lib/appsignal/integrations/mongo_ruby_driver.rb
 - lib/appsignal/integrations/object.rb
 - lib/appsignal/integrations/padrino.rb
+- lib/appsignal/integrations/que.rb
 - lib/appsignal/integrations/railtie.rb
 - lib/appsignal/integrations/rake.rb
 - lib/appsignal/integrations/resque.rb
@@ -266,6 +269,7 @@ files:
 - spec/lib/appsignal/hooks/net_http_spec.rb
 - spec/lib/appsignal/hooks/passenger_spec.rb
 - spec/lib/appsignal/hooks/puma_spec.rb
+- spec/lib/appsignal/hooks/que_spec.rb
 - spec/lib/appsignal/hooks/rake_spec.rb
 - spec/lib/appsignal/hooks/redis_spec.rb
 - spec/lib/appsignal/hooks/sequel_spec.rb
@@ -279,6 +283,7 @@ files:
 - spec/lib/appsignal/integrations/mongo_ruby_driver_spec.rb
 - spec/lib/appsignal/integrations/object_spec.rb
 - spec/lib/appsignal/integrations/padrino_spec.rb
+- spec/lib/appsignal/integrations/que_spec.rb
 - spec/lib/appsignal/integrations/railtie_spec.rb
 - spec/lib/appsignal/integrations/resque_active_job_spec.rb
 - spec/lib/appsignal/integrations/resque_spec.rb
@@ -389,6 +394,7 @@ test_files:
 - spec/lib/appsignal/hooks/net_http_spec.rb
 - spec/lib/appsignal/hooks/passenger_spec.rb
 - spec/lib/appsignal/hooks/puma_spec.rb
+- spec/lib/appsignal/hooks/que_spec.rb
 - spec/lib/appsignal/hooks/rake_spec.rb
 - spec/lib/appsignal/hooks/redis_spec.rb
 - spec/lib/appsignal/hooks/sequel_spec.rb
@@ -402,6 +408,7 @@ test_files:
 - spec/lib/appsignal/integrations/mongo_ruby_driver_spec.rb
 - spec/lib/appsignal/integrations/object_spec.rb
 - spec/lib/appsignal/integrations/padrino_spec.rb
+- spec/lib/appsignal/integrations/que_spec.rb
 - spec/lib/appsignal/integrations/railtie_spec.rb
 - spec/lib/appsignal/integrations/resque_active_job_spec.rb
 - spec/lib/appsignal/integrations/resque_spec.rb