tcell_agent 2.0.0 → 2.2.1

data/lib/tcell_agent/settings_reporter.rb

@@ -37,85 +37,6 @@ module TCellAgent
         )
       end
 
-      TCellAgent::Instrumentation.safe_block('Instrumenting Initial Config') do
-        TCellAgent.send_event(
-          TCellAgent::SensorEvents::AgentSettingEvent.new(
-            'allow_payloads',
-            (!!TCellAgent.configuration.allow_payloads).to_s # rubocop:disable Style/DoubleNegation
-          )
-        )
-
-        TCellAgent.send_event(
-          TCellAgent::SensorEvents::AgentSettingEvent.new(
-            'reverse_proxy',
-            (!!TCellAgent.configuration.reverse_proxy).to_s # rubocop:disable Style/DoubleNegation
-          )
-        )
-
-        # Because of all the diff ways to initialize the agent
-        # some some of the following vars might not be set until
-        # we call this method, so call this method to set all
-        # the variables
-        TCellAgent.configuration.log_filename
-
-        TCellAgent.send_event(
-          TCellAgent::SensorEvents::AgentSettingEvent.new(
-            'config_filename',
-            TCellAgent.configuration.config_filename
-          )
-        )
-        TCellAgent.send_event(
-          TCellAgent::SensorEvents::AgentSettingEvent.new(
-            'logging_directory',
-            TCellAgent.configuration.agent_log_dir
-          )
-        )
-
-        TCellAgent.send_event(
-          TCellAgent::SensorEvents::AgentSettingEvent.new(
-            'agent_home_directory',
-            TCellAgent.configuration.agent_home_dir
-          )
-        )
-
-        logging_options = TCellAgent.configuration.logging_options || {}
-        use_default_setting = !logging_options.key?(:enabled) && !logging_options.key?('enabled')
-        if use_default_setting || logging_options[:enabled] || logging_options['enabled']
-          TCellAgent.send_event(
-            TCellAgent::SensorEvents::AgentSettingEvent.new('logging_enabled', 'true')
-          )
-
-          TCellAgent.send_event(
-            TCellAgent::SensorEvents::AgentSettingEvent.new(
-              'logging_level',
-              logging_options[:level] || logging_options['level'] || 'INFO'
-            )
-          )
-        else
-          TCellAgent.send_event(
-            TCellAgent::SensorEvents::AgentSettingEvent.new('logging_enabled', 'false')
-          )
-        end
-
-        if TCellAgent.configuration.hmac_key
-          TCellAgent.send_event(
-            TCellAgent::SensorEvents::AgentSettingEvent.new(
-              'hmac_key_present',
-              (!!TCellAgent.configuration.hmac_key).to_s # rubocop:disable Style/DoubleNegation
-            )
-          )
-        end
-
-        if TCellAgent.configuration.reverse_proxy
-          TCellAgent.send_event(
-            TCellAgent::SensorEvents::AgentSettingEvent.new(
-              'reverse_proxy_ip_address_header',
-              TCellAgent.configuration.reverse_proxy_ip_address_header
-            )
-          )
-        end
-      end
-
       if defined?(::Rails)
         TCellAgent::Instrumentation.safe_block('Instrumenting routes') do
           TCellAgent::Instrumentation::Rails.instrument_routes

data/lib/tcell_agent/tcell_context.rb

@@ -40,7 +40,7 @@ module TCellAgent
           tcell_context.request_method,
           tcell_context.remote_address,
           tcell_context.route_id,
-          tcell_context.hmac_session_id,
+          tcell_context.session_id,
           tcell_context.user_id,
           tcell_context.transaction_id,
           tcell_context.uri

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.0.0'.freeze
+  VERSION = '2.2.1'.freeze
 end

data/spec/lib/tcell_agent/configuration_spec.rb

@@ -2,228 +2,78 @@ require 'spec_helper'
 
 module TCellAgent
   describe Configuration do
-    describe '#agent_home_dir' do
-      context 'no TCELL_AGENT_HOME defined' do
-        it 'should set cache file, config, and log file to defaults' do
-          configuration = Configuration.new
+    describe 'should_instrument?' do
+      context 'with the agent disabled' do
+        it 'should return false' do
+          config = Configuration.new
+          config.enabled = false
 
-          expect(configuration.log_filename).to eq(
-            File.join(Dir.getwd, 'tcell/logs/tcell_agent.log')
-          )
-          expect(configuration.config_filename).to eq(
-            File.join(Dir.getwd, 'config/tcell_agent.config')
-          )
+          expect(config.should_instrument?).to be_falsey
         end
       end
-
-      context 'TCELL_AGENT_HOME defined' do
-        it 'should set config filename to default, cache file and log file are updated' do
-          old_tcell_agent_home = ENV['TCELL_AGENT_HOME']
-
-          ENV['TCELL_AGENT_HOME'] = 'spec_tcell_home'
-
-          configuration = Configuration.new
-
-          expect(configuration.log_filename).to eq(
-            'spec_tcell_home/logs/tcell_agent.log'
-          )
-          expect(configuration.config_filename).to eq(
-            File.join(Dir.getwd, 'config/tcell_agent.config')
-          )
-
-          ENV['TCELL_AGENT_HOME'] = old_tcell_agent_home
-        end
-      end
-
-      context 'TCELL_AGENT_HOME and TCELL_AGENT_LOG_DIR defined' do
-        it 'should set config filename to default, cache file and log file are updated' do
-          old_tcell_agent_home = ENV['TCELL_AGENT_HOME']
-          old_tcell_agent_log_dir = ENV['TCELL_AGENT_LOG_DIR']
-
-          ENV['TCELL_AGENT_HOME'] = 'spec_tcell_home'
-          ENV['TCELL_AGENT_LOG_DIR'] = 'spec_tcell_log_dir'
-
-          configuration = Configuration.new
-
-          expect(configuration.log_filename).to eq(
-            'spec_tcell_log_dir/tcell_agent.log'
-          )
-          expect(configuration.config_filename).to eq(
-            File.join(Dir.getwd, 'config/tcell_agent.config')
-          )
-
-          ENV['TCELL_AGENT_HOME'] = old_tcell_agent_home
-          ENV['TCELL_AGENT_LOG_DIR'] = old_tcell_agent_log_dir
-        end
-      end
-
-      context 'TCELL_AGENT_HOME, TCELL_AGENT_LOG_DIR, and TCELL_AGENT_CONFIG defined ' do
-        it 'should update config filename, cache file, and log file' do
-          old_tcell_agent_home = ENV['TCELL_AGENT_HOME']
-          old_tcell_agent_log_dir = ENV['TCELL_AGENT_LOG_DIR']
-          old_config_filename = ENV['TCELL_AGENT_CONFIG']
-
-          ENV['TCELL_AGENT_HOME'] = 'spec_tcell_home'
-          ENV['TCELL_AGENT_LOG_DIR'] = 'spec_tcell_log_dir'
-          ENV['TCELL_AGENT_CONFIG'] = 'spec_config/tcell_agent.config'
-
-          configuration = Configuration.new
-
-          expect(configuration.log_filename).to eq(
-            'spec_tcell_log_dir/tcell_agent.log'
-          )
-          expect(configuration.config_filename).to eq(
-            'spec_config/tcell_agent.config'
-          )
-
-          ENV['TCELL_AGENT_HOME'] = old_tcell_agent_home
-          ENV['TCELL_AGENT_LOG_DIR'] = old_tcell_agent_log_dir
-          ENV['TCELL_AGENT_CONFIG'] = old_config_filename
-        end
-      end
-    end
-
-    describe '#data_exposure' do
-      context 'no data_exposure defined' do
-        it 'should set max_data_ex_db_records_per_request to default' do
-          no_data_ex = double(
-            'no_data_ex',
-            :read => {
-              :version => 1,
-              :applications => [
-                :app_id => 'app_id',
-                :name => 'test',
-                :api_key => 'api_key'
-              ]
-            }.to_json
-          )
-          expect(File).to receive(:file?).with(
-            File.join(Dir.getwd, 'no_data_ex.config')
-          ).and_return(true)
-          expect(File).to receive(:open).with(
-            File.join(Dir.getwd, 'no_data_ex.config')
-          ).and_return(no_data_ex)
-          configuration = Configuration.new('no_data_ex.config')
-
-          expect(configuration.max_data_ex_db_records_per_request).to eq(1000)
-        end
-      end
-
-      context 'data_exposure is empty' do
-        it 'should set max_data_ex_db_records_per_request to default' do
-          no_data_ex = double(
-            'no_data_ex',
-            :read => {
-              :version => 1,
-              :applications => [
-                :app_id => 'app_id',
-                :name => 'test',
-                :api_key => 'api_key',
-                :data_exposure => {}
-              ]
-            }.to_json
-          )
-          expect(File).to receive(:file?).with(
-            File.join(Dir.getwd, 'no_data_ex.config')
-          ).and_return(true)
-          expect(File).to receive(:open).with(
-            File.join(Dir.getwd, 'no_data_ex.config')
-          ).and_return(no_data_ex)
-          configuration = Configuration.new('no_data_ex.config')
-
-          expect(configuration.max_data_ex_db_records_per_request).to eq(1000)
+      context 'with the agent enabled' do
+        context 'with all instrumentation enabled' do
+          context 'with no parameters' do
+            it 'should return true' do
+              config = Configuration.new
+              config.enabled = true
+              config.instrument = true
+
+              expect(config.should_instrument?).to be_truthy
+            end
+          end
+          context 'with parameters' do
+            it 'should return true' do
+              config = Configuration.new
+              config.enabled = true
+              config.instrument = true
+              config.disabled_instrumentation = Set.new
+
+              expect(config.should_instrument?('devise')).to be_truthy
+            end
+          end
         end
-      end
+        context 'with auth frameworks disabled' do
+          it 'should return false' do
+            config = Configuration.new
+            config.disabled_instrumentation = Set.new(%w[authlogic devise doorkeeper])
 
-      context 'data_exposure contains an override' do
-        it 'should set max_data_ex_db_records_per_request to override' do
-          no_data_ex = double(
-            'no_data_ex',
-            :read => {
-              :version => 1,
-              :applications => [
-                :app_id => 'app_id',
-                :name => 'test',
-                :api_key => 'api_key',
-                :data_exposure => {
-                  :max_data_ex_db_records_per_request => 5000
-                }
-              ]
-            }.to_json
-          )
-          expect(File).to receive(:file?).with(
-            File.join(Dir.getwd, 'no_data_ex.config')
-          ).and_return(true)
-          expect(File).to receive(:open).with(
-            File.join(Dir.getwd, 'no_data_ex.config')
-          ).and_return(no_data_ex)
-          configuration = Configuration.new('no_data_ex.config')
-
-          expect(configuration.max_data_ex_db_records_per_request).to eq(5000)
+            expect(config.should_instrument?('devise')).to be_falsey
+          end
         end
       end
     end
-
-    describe '#allow_payloads' do
-      context 'setting it via config' do
-        context 'using allow_payloads' do
-          it 'should be false' do
-            allow_payloads_enabled = double(
-              'no_data_ex',
-              :read => {
-                :version => 1,
-                :applications => [
-                  :app_id => 'app_id',
-                  :api_key => 'api_key',
-                  :allow_payloads => false
-                ]
-              }.to_json
-            )
-            expect(File).to receive(:file?).with(
-              File.join(Dir.getwd, 'config/tcell_agent.config')
-            ).and_return(true)
-            expect(File).to receive(:open).with(
-              File.join(Dir.getwd, 'config/tcell_agent.config')
-            ).and_return(allow_payloads_enabled)
-
-            configuration = Configuration.new
-
-            expect(configuration.allow_payloads).to eq(false)
-          end
+    describe 'populate_configuration' do
+      context 'with a poor native_agent_config_response' do
+        it 'should not throw an error' do
+          native_agent_config_response = {}
+
+          config = Configuration.new
+          expect do
+            config.populate_configuration(native_agent_config_response)
+          end.not_to raise_error
         end
       end
-
-      context 'setting it via env var' do
-        context 'TCELL_AGENT_ALLOW_PAYLOADS overrides everything else' do
-          it 'should be false' do
-            old_tcell_agent_allow_payloads = ENV['TCELL_AGENT_ALLOW_PAYLOADS']
-
-            ENV['TCELL_AGENT_ALLOW_PAYLOADS'] = 'false'
-
-            allow_payloads_enabled = double(
-              'no_data_ex',
-              :read => {
-                :version => 1,
-                :applications => [
-                  :app_id => 'app_id',
-                  :api_key => 'api_key',
-                  :allow_payloads => true
-                ]
-              }.to_json
-            )
-            expect(File).to receive(:file?).with(
-              File.join(Dir.getwd, 'config/tcell_agent.config')
-            ).and_return(true)
-            expect(File).to receive(:open).with(
-              File.join(Dir.getwd, 'config/tcell_agent.config')
-            ).and_return(allow_payloads_enabled)
-
-            configuration = Configuration.new
-
-            ENV['TCELL_AGENT_ALLOW_PAYLOADS'] = old_tcell_agent_allow_payloads
-
-            expect(configuration.allow_payloads).to eq(false)
-          end
+      context 'with an elaborate native_agent_config_response' do
+        it 'should set all the correct configurations' do
+          native_agent_config_response = { 'enabled' => true,
+                                           'disabled_instrumentation' => %w[devise doorkeeper],
+                                           'update_policy' => 'true',
+                                           'applications' => { 'first' => { 'app_id' => 'app_id_placeholder',
+                                                                            'api_key' => 'api_key_paceholder',
+                                                                            'hmac_key' => 'hmac_key_placeholder',
+                                                                            'password_hmac_key' => 'password_hmac_key_placeholder',
+                                                                            'proxy_config' => { 'reverse_proxy' => true,
+                                                                                                'reverse_proxy_ip_address_header' => 'X-Forwarded-For' } } },
+                                           'endpoint_config' => { 'api_url' => 'https://us.agent.tcell.insight.rapid7.com/api/v1' },
+                                           'ruby_config' => { 'enable_policy_polling' => true } }
+
+          config = Configuration.new
+          config.populate_configuration(native_agent_config_response)
+
+          expect(config.disabled_instrumentation).to be_a(Set)
+          expect(config.disabled_instrumentation).to include('devise', 'doorkeeper')
+          expect(config.enable_intercept_requests).to be_truthy
         end
       end
     end

data/spec/lib/tcell_agent/instrument_servers_spec.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+def test_rails
+  expect(Rails::Server.instance_methods.include?(:tcell_build_app)).to be_truthy
+end
+
+def test_thin
+  expect(Thin::Server.instance_methods.include?(:original_start)).to be_truthy
+end
+
+def test_unicorn
+  expect(Unicorn::HttpServer::START_CTX[0]).to be_falsy
+  expect(Unicorn::HttpServer.instance_methods.include?(:tcell_init_worker_process)).to be_truthy
+  expect(Unicorn::HttpServer.instance_methods.include?(:tcell_load_config!)).to be_truthy
+end
+
+def test_passenger
+  expect(PhusionPassenger::LoaderSharedHelpers.instance_methods.include?(:tcell_before_handling_requests))
+end
+
+def test_puma
+  expect(Puma.cli_config.options[:preload_app]).to be_falsey
+  expect(Puma::Server.instance_methods.include?(:original_run)).to be_truthy
+end
+
+def test_server(filenames, funcs)
+  fork do
+    filenames.each do |file|
+      load file
+    end
+
+    load 'tcell_agent/instrument_servers.rb'
+
+    funcs.each do |func|
+      method(func).call
+    end
+  end
+end
+
+describe 'instrument_servers' do
+  context 'with single server dependency' do
+    context 'with webrick server' do
+      it 'should instrument Webrick' do
+        mocks = ['spec/support/server_mocks/rails_mock.rb']
+        tests = [:test_rails]
+        test_server(mocks, tests)
+      end
+    end
+
+    context 'with Thin server' do
+      it 'should instrument Thin' do
+        mocks = ['spec/support/server_mocks/thin_mock.rb']
+        tests = [:test_thin]
+        test_server(mocks, tests)
+      end
+    end
+
+    context 'with Puma server' do
+      it 'should instrument Puma' do
+        mocks = ['spec/support/server_mocks/puma_mock.rb']
+        tests = [:test_puma]
+        test_server(mocks, tests)
+      end
+    end
+
+    context 'with Unicorn server' do
+      it 'should instrument Unicorn' do
+        mocks = ['spec/support/server_mocks/unicorn_mock.rb']
+        tests = [:test_unicorn]
+        test_server(mocks, tests)
+      end
+    end
+
+    context 'with Passenger server' do
+      it 'should instrument Unicorn' do
+        mocks = ['spec/support/server_mocks/passenger_mock.rb']
+        tests = [:test_passenger]
+        test_server(mocks, tests)
+      end
+    end
+  end
+  context 'with multiple server dependencies' 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/unicorn_mock.rb',
+               'spec/support/server_mocks/passenger_mock.rb']
+
+      tests = %i[test_rails test_thin test_puma test_unicorn test_passenger]
+
+      test_server(mocks, tests)
+    end
+  end
+end