tcell_agent 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4460b2fd01c8b788c8139cbeb2cee7f8a2505e4cc365c279a518778766d9cdb0
-  data.tar.gz: 18dfdd5e944e91155d6b58fa22262b027292038192fac0b6afd4693314f74fd8
+  metadata.gz: 521fa2c98be5ea73aa4a9f4a8c00b9c1e51e2dd801de3c886324e28c95205142
+  data.tar.gz: a257258e3e3a4f71ee52d2242a3e37ec56c103da6aaae7ed471b87ef3b5ae054
 SHA512:
-  metadata.gz: a2404786f0663783fd45194043c4a12efda21db0e933c14aca5f2d4532e900aac3b3f700ca8282b1995b38c718b6e0eade2a2b1ffbc9df467bf8ab5b4f144b18
-  data.tar.gz: 5021cff2601b66fd94a41b710ab0ab0211be35b2bd442afc0ca992ce4236d6c65e3ef69e14cd2ca9455fb4282d8affa1ba3e7aa3f05c75e4285ff6b5ab77e871
+  metadata.gz: '0349621e1d4393d435561bb72dcb8928746caffb6f57828f4ea429d93546ef550be81ce7d15fad344775b9c4af18b17cff6339c800c51bcc573c025bcb2e4f49'
+  data.tar.gz: 4c7b9c61a59d6b7023fd2e54b8262a8ea1efed04600a36ccd5d92be85eb2240a1832178197dfa40ccef35ecddc886ee34d25ec674ba926c909461c7164b5b11d

data/lib/tcell_agent/servers/puma.rb

@@ -21,12 +21,12 @@ if defined?(Puma.cli_config)
            (Gem::Version.new(Puma::Const::PUMA_VERSION) < Gem::Version.new('5.1.0'))
           def run(background = true)
             TCellAgent.thread_agent.start('Puma')
-            original_run(background, options)
+            tcell_original_run(background)
           end
         else
           def run(background = true, thread_name: 'server')
             TCellAgent.thread_agent.start('Puma')
-            original_run(background, :thread_name => thread_name)
+            tcell_original_run(background, :thread_name => thread_name)
           end
         end
       end
@@ -48,7 +48,7 @@ if defined?(Puma.cli_config)
       else
         def run(background = true, thread_name: 'server')
           TCellAgent.thread_agent.start('Puma')
-          original_run(background, :thread_name => thread_name)
+          tcell_original_run(background, :thread_name => thread_name)
         end
       end
     end

data/lib/tcell_agent/servers/rack_puma_handler.rb

@@ -15,7 +15,7 @@ Rack::Handler::Puma.class_eval do
              (Gem::Version.new(Puma::Const::PUMA_VERSION) >= Gem::Version.new('5.1.0'))
             def run(background = true, thread_name: 'server')
               TCellAgent.thread_agent.start('Puma')
-              original_run(background, :thread_name => thread_name)
+              tcell_original_run(background, :thread_name => thread_name)
             end
           else
             def run(background = true)

data/lib/tcell_agent/servers/webrick.rb

@@ -1,18 +1,18 @@
 Rack::Handler::WEBrick.class_eval do
   class << self
-    alias_method :original_run, :run
+    alias_method :tcell_original_run, :run
 
     if defined?(Gem::Version) &&
        defined?(Rack.release) &&
        Gem::Version.new(Rack.release) < Gem::Version.new('2.2.0')
       def run(app, options = {})
         TCellAgent.thread_agent.start('WEBrick')
-        original_run(app, options)
+        tcell_original_run(app, options)
       end
     else
       def run(app, **options)
         TCellAgent.thread_agent.start('WEBrick')
-        original_run(app, **options)
+        tcell_original_run(app, **options)
       end
     end
   end

data/lib/tcell_agent/version.rb

@@ -1,5 +1,5 @@
 # See the file "LICENSE" for the full license governing this code.
 
 module TCellAgent
-  VERSION = '2.5.0'.freeze
+  VERSION = '2.5.1'.freeze
 end

data/spec/lib/tcell_agent/instrument_servers_spec.rb

@@ -18,13 +18,34 @@ def test_passenger
   expect(PhusionPassenger::LoaderSharedHelpers.instance_methods.include?(:tcell_before_handling_requests))
 end
 
-def test_puma
+def test_puma1
   expect(Puma.cli_config.options[:preload_app]).to be_falsey
   expect(Puma::Server.instance_methods.include?(:tcell_original_run)).to be_truthy
+
+  TCellAgent.thread_agent.should_receive(:start).and_return nil
+  expect { Puma::Server.new.run }.not_to raise_error
+end
+
+def test_puma2
+  expect(Puma.cli_config.options[:preload_app]).to be_truthy
+  Puma.cli_config.options[:workers].should eq 0
+  expect(Puma::Runner.instance_methods.include?(:tcell_original_start_server)).to be_truthy
+
+  TCellAgent.thread_agent.should_receive(:start).and_return nil
+  expect { Puma::Runner.new.start_server }.not_to raise_error
+end
+
+def test_puma3
+  expect(Puma.cli_config.options[:preload_app]).to be_truthy
+  Puma.cli_config.options[:workers].should eq 1
+  expect(Puma::Server.instance_methods.include?(:tcell_original_run)).to be_truthy
+
+  TCellAgent.thread_agent.should_receive(:start).and_return nil
+  expect { Puma::Server.new.run }.not_to raise_error
 end
 
 def test_server(filenames, funcs)
-  fork do
+  pid = fork do
     filenames.each do |file|
       load file
     end
@@ -35,6 +56,10 @@ def test_server(filenames, funcs)
       method(func).call
     end
   end
+
+  Process.wait(pid)
+
+  raise 'RSpec test failed. See output above for additional information.' unless $?.exitstatus == 0
 end
 
 describe 'instrument_servers' do
@@ -56,9 +81,19 @@ describe 'instrument_servers' do
     end
 
     context 'with Puma server' do
-      it 'should instrument Puma' do
-        mocks = ['spec/support/server_mocks/puma_mock.rb']
-        tests = [:test_puma]
+      it 'should instrument Puma, when :preload is false and workers is 0' do
+        mocks = ['spec/support/server_mocks/puma_mock_1.rb']
+        tests = [:test_puma1]
+        test_server(mocks, tests)
+      end
+      it 'should instrument Puma, when :preload is true and workers is 0' do
+        mocks = ['spec/support/server_mocks/puma_mock_2.rb']
+        tests = [:test_puma2]
+        test_server(mocks, tests)
+      end
+      it 'should instrument Puma, when :preload is true and workers is 1' do
+        mocks = ['spec/support/server_mocks/puma_mock_3.rb']
+        tests = [:test_puma3]
         test_server(mocks, tests)
       end
     end
@@ -83,11 +118,11 @@ describe 'instrument_servers' do
     it 'should instrument all servers available' do
       mocks = ['spec/support/server_mocks/rails_mock.rb',
                'spec/support/server_mocks/thin_mock.rb',
-               'spec/support/server_mocks/puma_mock.rb',
+               'spec/support/server_mocks/puma_mock_1.rb',
                'spec/support/server_mocks/unicorn_mock.rb',
                'spec/support/server_mocks/passenger_mock.rb']
 
-      tests = %i[test_rails test_thin test_puma test_unicorn test_passenger]
+      tests = %i[test_rails test_thin test_puma1 test_unicorn test_passenger]
 
       test_server(mocks, tests)
     end

data/spec/support/server_mocks/{puma_mock.rb → puma_mock_1.rb}

@@ -2,7 +2,7 @@
 
 module Puma
   class Server
-    def run; end
+    def run(background = true, thread_name: 'server'); end
   end
 
   class Config

data/spec/support/server_mocks/puma_mock_2.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Puma
+  class Server
+    def run(background = true, thread_name: 'server'); end
+  end
+
+  class Runner
+    def start_server; end
+  end
+
+  class Config
+    def self.options
+      { :preload_app => true,
+        :workers => 0 }
+    end
+  end
+
+  def self.cli_config
+    Config
+  end
+
+  module Const
+    PUMA_VERSION = '5.1.0'
+  end
+end

data/spec/support/server_mocks/puma_mock_3.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Puma
+  class Server
+    def run(background = true, thread_name: 'server'); end
+  end
+
+  class Config
+    def self.options
+      { :preload_app => true,
+        :workers => 1 }
+    end
+  end
+
+  def self.cli_config
+    Config
+  end
+
+  module Const
+    PUMA_VERSION = '5.1.0'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcell_agent
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Rapid7, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-03 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -242,7 +242,9 @@ files:
 - spec/support/resources/lfi_sample_file.txt
 - spec/support/resources/normal_config.json
 - spec/support/server_mocks/passenger_mock.rb
-- spec/support/server_mocks/puma_mock.rb
+- spec/support/server_mocks/puma_mock_1.rb
+- spec/support/server_mocks/puma_mock_2.rb
+- spec/support/server_mocks/puma_mock_3.rb
 - spec/support/server_mocks/rails_mock.rb
 - spec/support/server_mocks/thin_mock.rb
 - spec/support/server_mocks/unicorn_mock.rb
@@ -324,7 +326,9 @@ test_files:
 - spec/support/resources/lfi_sample_file.txt
 - spec/support/resources/normal_config.json
 - spec/support/server_mocks/passenger_mock.rb
-- spec/support/server_mocks/puma_mock.rb
+- spec/support/server_mocks/puma_mock_1.rb
+- spec/support/server_mocks/puma_mock_2.rb
+- spec/support/server_mocks/puma_mock_3.rb
 - spec/support/server_mocks/rails_mock.rb
 - spec/support/server_mocks/thin_mock.rb
 - spec/support/server_mocks/unicorn_mock.rb