appoptics_apm 4.0.2 → 4.0.3

data/test/mocked/typhoeus_mocked_test.rb

@@ -8,12 +8,14 @@ unless defined?(JRUBY_VERSION)
   class TyphoeusMockedTest < Minitest::Test
 
     def setup
+      AppOpticsAPM::Context.clear
       AppOpticsAPM.config_lock.synchronize do
         @sample_rate = AppOpticsAPM::Config[:sample_rate]
       end
     end
 
     def teardown
+      AppOpticsAPM::Context.clear
       AppOpticsAPM.config_lock.synchronize do
         AppOpticsAPM::Config[:sample_rate] = @sample_rate
         AppOpticsAPM::Config[:blacklist] = []
@@ -30,6 +32,8 @@ unless defined?(JRUBY_VERSION)
         assert request.options[:headers]['X-Trace']
         assert_match /^2B[0-9,A-F]*01$/,request.options[:headers]['X-Trace']
       end
+
+      refute AppOpticsAPM::Context.isValid
     end
 
     def test_tracing_not_sampling
@@ -44,6 +48,7 @@ unless defined?(JRUBY_VERSION)
           refute_match /^2B0*$/, request.options[:headers]['X-Trace']
         end
       end
+      refute AppOpticsAPM::Context.isValid
     end
 
     def test_no_xtrace
@@ -51,6 +56,7 @@ unless defined?(JRUBY_VERSION)
       request.run
 
       refute request.options[:headers]['X-Trace']
+      refute AppOpticsAPM::Context.isValid
     end
 
     def test_blacklisted
@@ -63,6 +69,7 @@ unless defined?(JRUBY_VERSION)
           refute request.options[:headers]['X-Trace']
         end
       end
+      refute AppOpticsAPM::Context.isValid
     end
 
     def test_not_sampling_blacklisted
@@ -76,6 +83,7 @@ unless defined?(JRUBY_VERSION)
           refute request.options[:headers]['X-Trace']
         end
       end
+      refute AppOpticsAPM::Context.isValid
     end
 
     def test_preserves_custom_headers
@@ -86,6 +94,7 @@ unless defined?(JRUBY_VERSION)
         assert request.options[:headers]['Custom']
         assert_match /specialvalue/, request.options[:headers]['Custom']
       end
+      refute AppOpticsAPM::Context.isValid
     end
 
 
@@ -105,6 +114,7 @@ unless defined?(JRUBY_VERSION)
         assert request_2.options[:headers]['X-Trace'], "There is an X-Trace header"
         assert_match /^2B[0-9,A-F]*01$/, request_2.options[:headers]['X-Trace']
       end
+      refute AppOpticsAPM::Context.isValid
     end
 
     def test_hydra_tracing_not_sampling
@@ -126,6 +136,7 @@ unless defined?(JRUBY_VERSION)
           refute_match /^2B0*$/, request_2.options[:headers]['X-Trace']
         end
       end
+      refute AppOpticsAPM::Context.isValid
     end
 
     def test_hydra_no_xtrace
@@ -138,6 +149,7 @@ unless defined?(JRUBY_VERSION)
 
       refute request_1.options[:headers]['X-Trace'], "There should not be an X-Trace header"
       refute request_2.options[:headers]['X-Trace'], "There should not be an X-Trace header"
+      refute AppOpticsAPM::Context.isValid
     end
 
     def test_hydra_blacklisted
@@ -155,6 +167,7 @@ unless defined?(JRUBY_VERSION)
           refute request_2.options[:headers]['X-Trace'], "There should not be an X-Trace header"
         end
       end
+      refute AppOpticsAPM::Context.isValid
     end
 
     def test_hydra_not_sampling_blacklisted
@@ -173,6 +186,7 @@ unless defined?(JRUBY_VERSION)
           refute request_2.options[:headers]['X-Trace'], "There should not be an X-Trace header"
         end
       end
+      refute AppOpticsAPM::Context.isValid
     end
 
 
@@ -186,6 +200,7 @@ unless defined?(JRUBY_VERSION)
         assert request.options[:headers]['Custom']
         assert_match /specialvalue/, request.options[:headers]['Custom']
       end
+      refute AppOpticsAPM::Context.isValid
     end
 
   end

data/test/noop/noop_test.rb

@@ -0,0 +1,145 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+#
+
+# Force noop by setting the platform to something we don't support
+RUBY_PLATFORM = 'noop'
+
+# These tests assert:
+# - that there is no instrumentation nor tracing in noop mode
+# - that the 'official' SDK methods don't create
+
+require 'minitest_helper'
+require 'rack/lobster'
+require 'net/http'
+
+class NoopTest < Minitest::Test
+  include Rack::Test::Methods
+
+  class ArrayTest < Array; end
+
+  def setup
+    clear_all_traces
+  end
+
+  def app
+    @app = Rack::Builder.new {
+      use Rack::CommonLogger
+      use Rack::ShowExceptions
+      use AppOpticsAPM::Rack
+      map '/lobster' do
+        use Rack::Lint
+        run Rack::Lobster.new
+      end
+    }
+  end
+
+  def test_requests_still_work
+    get '/lobster'
+    traces = get_all_traces
+    assert_equal 0, traces.count, 'generate no traces'
+    assert AppOpticsAPM::Rack.noop?, 'This is not running in noop mode.'
+  end
+
+  def test_appoptics_config_doesnt_barf
+    tm = AppOpticsAPM::Config[:tracing_mode]
+    vb = AppOpticsAPM::Config[:verbose]
+    la = AppOpticsAPM::Config[:rack][:log_args]
+
+    # Test that we can set various things into AppOpticsAPM::Config still
+    AppOpticsAPM::Config[:tracing_mode] = :always
+    AppOpticsAPM::Config[:verbose] = false
+    AppOpticsAPM::Config[:rack][:log_args] = true
+
+    assert_equal :always, AppOpticsAPM::Config[:tracing_mode]
+    assert_equal false, AppOpticsAPM::Config[:verbose]
+    assert_equal true, AppOpticsAPM::Config[:rack][:log_args]
+
+    # Restore the originals
+    AppOpticsAPM::Config[:tracing_mode] = tm
+    AppOpticsAPM::Config[:verbose] = vb
+    AppOpticsAPM::Config[:rack][:log_args] = la
+  end
+
+  # ===== Make sure the AppOpticsAPM::Inst module does not exist ============================
+  # this is the module in which all the instrumented methods are defined
+  def test_not_instrumented
+    refute ::AppOpticsAPM.const_defined?('Inst'), 'This should be noop mode, but instrumentation was found.'
+  end
+
+  # ===== Make sure the frameworks are not instrumented =====================================
+  def test_rails_not_instrumented
+    refute ::AppOpticsAPM.const_defined?('Rails'), 'This should be noop mode, but Rails is instrumented.'
+  end
+
+  def test_sinatra_not_instrumented
+    refute ::AppOpticsAPM.const_defined?('Sinatra'), 'This should be noop mode, but Sinatra is instrumented.'
+  end
+
+  def test_grape_not_instrumented
+    refute ::AppOpticsAPM.const_defined?('Grape'), 'This should be noop mode, but Grape is instrumented.'
+  end
+
+  def test_padrino_not_instrumented
+    refute ::AppOpticsAPM.const_defined?('Padrino'), 'This should be noop mode, but Padrino is instrumented.'
+  end
+
+  # ===== Make sure the methods we document as SDK don't barf in noop mode ==================
+
+  def test_start_trace_doesnt_barf
+    AppOpticsAPM::API.start_trace('noop_test')  do
+      AppOpticsAPM::API.trace('blah_block') do
+        "this block should not be traced"
+      end
+    end
+
+    traces = get_all_traces
+    assert_equal 0, traces.count, "generate no traces"
+  end
+
+  def test_trace_doesnt_barf
+    AppOpticsAPM::API.trace('noop_test')  do
+      "this block should not be traced"
+    end
+
+    traces = get_all_traces
+    assert_equal 0, traces.count, "generate no traces"
+  end
+
+  def test_method_profiling_doesnt_barf
+    AppOpticsAPM::API.profile_method(ArrayTest, :sort)
+
+    x = ArrayTest.new
+    x.push(1).push(3).push(2)
+    assert_equal [1, 2, 3], x.sort
+
+    traces = get_all_traces
+    assert_equal 0, traces.count, "generate no traces"  end
+
+  def test_profile_doesnt_barf
+    def fib(n)
+      return n if n <= 1
+      n + fib(n-1)
+    end
+
+    def computation(n)
+      AppOpticsAPM::API.profile('fib', { :n => n }) do
+        fib(n)
+      end
+    end
+
+    result = computation(4)
+    assert_equal 10, result
+
+
+    traces = get_all_traces
+    assert_equal 0, traces.count, "generate no traces"  end
+
+  def test_log_info_doesnt_barf
+    AppOpticsAPM::API.log_info(nil, {:ok => :yeah })
+
+    traces = get_all_traces
+    assert_equal 0, traces.count, "generate no traces"
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appoptics_apm
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.3
 platform: ruby
 authors:
 - Maia Engeli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-30 00:00:00.000000000 Z
+date: 2018-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -174,6 +174,7 @@ files:
 - gemfiles/frameworks.gemfile
 - gemfiles/instrumentation_mocked.gemfile
 - gemfiles/libraries.gemfile
+- gemfiles/noop.gemfile
 - gemfiles/rails23.gemfile
 - gemfiles/rails30.gemfile
 - gemfiles/rails31.gemfile
@@ -330,6 +331,7 @@ files:
 - test/mocked/rest_client_mocked_test.rb
 - test/mocked/typhoeus_mocked_test.rb
 - test/models/widget.rb
+- test/noop/noop_test.rb
 - test/profiling/legacy_method_profiling_test.rb
 - test/profiling/method_profiling_test.rb
 - test/queues/delayed_job-client_test.rb
@@ -352,7 +354,6 @@ files:
 - test/support/init_report_test.rb
 - test/support/liboboe_settings_test.rb
 - test/support/logging_test.rb
-- test/support/noop_test.rb
 - test/support/sql_sanitize_test.rb
 - test/support/tracing_mode_test.rb
 - test/support/tvalias_test.rb
@@ -393,6 +394,7 @@ test_files:
 - test/mocked/faraday_mocked_test.rb
 - test/mocked/typhoeus_mocked_test.rb
 - test/mocked/curb_mocked_test.rb
+- test/noop/noop_test.rb
 - test/reporter/reporter_test.rb
 - test/models/widget.rb
 - test/instrumentation/sequel_mysql_test.rb
@@ -430,7 +432,6 @@ test_files:
 - test/instrumentation/httpclient_test.rb
 - test/support/config_test.rb
 - test/support/xtrace_test.rb
-- test/support/noop_test.rb
 - test/support/tracing_mode_test.rb
 - test/support/init_report_test.rb
 - test/support/backcompat_test.rb

data/test/support/noop_test.rb

@@ -1,88 +0,0 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
-
-require 'minitest_helper'
-require 'rack/test'
-require 'rack/lobster'
-require 'appoptics_apm/inst/rack'
-require 'net/http'
-
-class NoopTest < Minitest::Test
-  include Rack::Test::Methods
-
-  class ArrayTest < Array; end
-
-  def setup
-    AppOpticsAPM.loaded = false
-  end
-
-  def teardown
-    AppOpticsAPM.loaded = true
-  end
-
-  def app
-    @app = Rack::Builder.new {
-      use Rack::CommonLogger
-      use Rack::ShowExceptions
-      use AppOpticsAPM::Rack
-      map "/lobster" do
-        use Rack::Lint
-        run Rack::Lobster.new
-      end
-    }
-  end
-
-  def test_requests_still_work
-    clear_all_traces
-
-    get "/lobster"
-
-    traces = get_all_traces
-    assert_equal 0, traces.count, "generate no traces"
-  end
-
-  def test_tracing_api_doesnt_barf
-    AppOpticsAPM::API.start_trace('noop_test')  do
-      AppOpticsAPM::API.trace('blah_block') do
-        "this block should not be traced"
-      end
-    end
-
-    AppOpticsAPM::API.log_start('noop_test')
-    AppOpticsAPM::API.log_info(nil, {:ok => :yeah })
-    AppOpticsAPM::API.log_exception(nil, Exception.new("yeah ok"))
-    AppOpticsAPM::API.log_end('noop_test')
-
-    traces = get_all_traces
-    assert_equal 0, traces.count, "generate no traces"
-  end
-
-  def test_method_profiling_doesnt_barf
-    AppOpticsAPM::API.profile_method(ArrayTest, :sort)
-
-    x = ArrayTest.new
-    x.push(1).push(3).push(2)
-    assert_equal [1, 2, 3], x.sort
-  end
-
-  def test_appoptics_config_doesnt_barf
-    tm = AppOpticsAPM::Config[:tracing_mode]
-    vb = AppOpticsAPM::Config[:verbose]
-    la = AppOpticsAPM::Config[:rack][:log_args]
-
-    # Test that we can set various things into AppOpticsAPM::Config still
-    AppOpticsAPM::Config[:tracing_mode] = :always
-    AppOpticsAPM::Config[:verbose] = false
-    AppOpticsAPM::Config[:rack][:log_args] = true
-
-    assert_equal :always, AppOpticsAPM::Config[:tracing_mode]
-    assert_equal false, AppOpticsAPM::Config[:verbose]
-    assert_equal true, AppOpticsAPM::Config[:rack][:log_args]
-
-    # Restore the originals
-    AppOpticsAPM::Config[:tracing_mode] = tm
-    AppOpticsAPM::Config[:verbose] = vb
-    AppOpticsAPM::Config[:rack][:log_args] = la
-  end
-end
-