mmtrix_rpm 1.0.0.1

data/test/mmtrix/agent/configuration/default_source_test.rb

@@ -0,0 +1,226 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','test_helper'))
+require 'mmtrix/agent/configuration/default_source'
+
+module Mmtrix::Agent::Configuration
+  class DefaultSourceTest < Minitest::Test
+    def setup
+      @default_source = DefaultSource.new
+      @defaults = ::Mmtrix::Agent::Configuration::DEFAULTS
+    end
+
+    def test_default_values_have_a_public_setting
+      @defaults.each do |config_setting, config_value|
+        refute_nil config_value[:public], "Config setting: #{config_setting}"
+      end
+    end
+
+    def test_default_values_have_types
+      @defaults.each do |config_setting, config_value|
+        refute_nil config_value[:type], "Config setting: #{config_setting}"
+      end
+    end
+
+    def test_default_values_have_descriptions
+      @defaults.each do |config_setting, config_value|
+        refute_nil config_value[:description]
+        assert config_value[:description].length > 0, "Config setting: #{config_setting}"
+      end
+    end
+
+    def test_declared_types_match_default_values
+      Mmtrix::Control.instance.local_env.stubs(:discovered_dispatcher).returns(:unicorn)
+
+      @default_source.keys.each do |key|
+        actual_type = get_config_value_class(fetch_config_value(key))
+        expected_type = @defaults[key][:type]
+
+        if @defaults[key][:allow_nil]
+          assert [NilClass, expected_type].include?(actual_type), "Default value for #{key} should be NilClass or #{expected_type}, is #{actual_type}."
+        else
+          assert_equal expected_type, actual_type, "Default value for #{key} should be #{expected_type}, is #{actual_type}."
+        end
+      end
+    end
+
+    def test_default_values_maps_keys_to_their_default_values
+      default_values = @default_source.default_values
+
+      @defaults.each do |key, value|
+        assert_equal value[:default], default_values[key]
+      end
+    end
+
+    def test_config_search_paths_include_application_root
+      Mmtrix::Control.instance.stubs(:root).returns('app_root')
+      paths = DefaultSource.config_search_paths.call
+      assert paths.any? { |p| p.include? 'app_root' }
+    end
+
+    def fetch_config_value(key)
+      accessor = key.to_sym
+      config = @default_source
+
+      if config.has_key?(accessor)
+        if config[accessor].respond_to?(:call)
+          value = config[accessor]
+
+          while value.respond_to?(:call)
+            value = config.instance_eval(&value)
+          end
+
+          return value
+        else
+          return config[accessor]
+        end
+      end
+      nil
+    end
+
+    def test_transform_for_returns_something_callable
+      transform = DefaultSource.transform_for(:'rules.ignore_url_regexes')
+      assert transform.respond_to?(:call)
+    end
+
+    def test_transform_for_returns_nil_for_settings_that_do_not_have_a_transform
+      assert_nil DefaultSource.transform_for(:ca_bundle_path)
+    end
+
+    def test_convert_to_list
+      result = DefaultSource.convert_to_list("Foo,Bar,Baz")
+      assert_equal ['Foo', 'Bar', 'Baz'], result
+    end
+
+    def test_convert_to_list_returns_original_argument_given_array
+      result = DefaultSource.convert_to_list(['Foo'])
+      assert_equal ['Foo'], result
+    end
+
+    def test_convert_to_list_raises_on_totally_wrong_object
+      assert_raises(ArgumentError) do
+        DefaultSource.convert_to_list(Object.new)
+      end
+    end
+
+    def test_rules_ignore_converts_comma_delimited_string_to_array
+      with_config(:'rules.ignore_url_regexes' => 'Foo,Bar,Baz') do
+        assert_equal [/Foo/, /Bar/, /Baz/], Mmtrix::Agent.config[:'rules.ignore_url_regexes']
+      end
+    end
+
+    def test_config_search_paths_with_home
+      with_environment("HOME" => "/home") do
+        paths = DefaultSource.config_search_paths.call()
+        assert_includes paths, "/home/.mmtrix/mmtrix.yml"
+        assert_includes paths, "/home/mmtrix.yml"
+      end
+    end
+
+    def test_config_search_path_in_warbler
+      with_environment("GEM_HOME" => "/some/path.jar!") do
+        assert_includes DefaultSource.config_search_paths.call(), "/some/path.jar!/path/config/mmtrix.yml"
+      end
+    end
+
+    def test_transaction_tracer_attributes_enabled_default
+      with_config(:'transaction_tracer.capture_attributes' => :foo) do
+        assert_equal :foo, Mmtrix::Agent.config['transaction_tracer.attributes.enabled']
+      end
+    end
+
+    def test_transaction_events_attributes_enabled_default
+      with_config(:'analytics_events.capture_attributes' => :foo) do
+        assert_equal :foo, Mmtrix::Agent.config['transaction_events.attributes.enabled']
+      end
+    end
+
+    def test_error_collector_attributes_enabled_default
+      with_config(:'error_collector.capture_attributes' => :foo) do
+        assert_equal :foo, Mmtrix::Agent.config['error_collector.attributes.enabled']
+      end
+    end
+
+    def test_browser_monitoring_attributes_enabled_default
+      with_config(:'browser_monitoring.capture_attributes' => :foo) do
+        assert_equal :foo, Mmtrix::Agent.config['browser_monitoring.attributes.enabled']
+      end
+    end
+
+    def test_agent_attribute_settings_convert_comma_delimited_strings_into_an_arrays
+      types = %w(transaction_tracer. transaction_events. error_collector. browser_monitoring.)
+      types << ''
+
+      types.each do |type|
+        key = "#{type}attributes.exclude".to_sym
+
+        with_config(key => 'foo,bar,baz') do
+          expected = ["foo", "bar", "baz"]
+          result = Mmtrix::Agent.config[key]
+
+          message = "Expected #{key} to convert comma delimited string into array.\nExpected: #{expected.inspect}, Result: #{result.inspect}\n"
+          assert expected == result, message
+        end
+
+        key = "#{type}attributes.include".to_sym
+
+        with_config(key => 'foo,bar,baz') do
+          assert_equal ["foo", "bar", "baz"], Mmtrix::Agent.config[key]
+        end
+      end
+    end
+
+    def test_agent_attributes_settings_with_yaml_array
+      types = %w(transaction_tracer. transaction_events. error_collector. browser_monitoring.)
+      types << ''
+
+      types.each do |type|
+        key = "#{type}attributes.exclude".to_sym
+
+        with_config(key => ['foo','bar','baz']) do
+          expected = ["foo", "bar", "baz"]
+          result = Mmtrix::Agent.config[key]
+
+          message = "Expected #{key} not to modify settings from YAML array.\nExpected: #{expected.inspect}, Result: #{result.inspect}\n"
+          assert expected == result, message
+        end
+
+        key = "#{type}attributes.include".to_sym
+
+        with_config(key => 'foo,bar,baz') do
+          assert_equal ["foo", "bar", "baz"], Mmtrix::Agent.config[key]
+        end
+      end
+    end
+
+    def test_all_settings_specify_whether_they_are_allowed_from_server
+      unspecified_keys = []
+      bad_value_keys = []
+
+      @defaults.each do |key, spec|
+        if !spec.has_key?(:allowed_from_server)
+          unspecified_keys << key
+        end
+
+        if ![true, false].include?(spec[:allowed_from_server])
+          bad_value_keys << key
+        end
+      end
+
+      assert unspecified_keys.empty?, "The following keys did not specify a value for :allowed_from_server: #{unspecified_keys.join(', ')}"
+      assert bad_value_keys.empty?, "The following keys had incorrect :allowed_from_server values (only true or false are allowed): #{bad_value_keys.join(', ')}"
+    end
+
+    def get_config_value_class(value)
+      type = value.class
+
+      if type == TrueClass || type == FalseClass
+        Boolean
+      else
+        type
+      end
+    end
+  end
+end

data/test/mmtrix/agent/configuration/dotted_hash_test.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','test_helper'))
+
+module Mmtrix::Agent::Configuration
+  class DottedHashTest < Minitest::Test
+    def test_without_nesting
+      hash = DottedHash.new({ :turtle => 1 })
+      assert_equal({ :turtle => 1 }, hash)
+    end
+
+    def test_with_nesting
+      hash = DottedHash.new({ :turtle => { :turtle => 1 } })
+      assert_equal({ :'turtle.turtle' => 1 }, hash)
+    end
+
+    def test_with_multiple_layers_of_nesting
+      hash = DottedHash.new({ :turtle => { :turtle => { :turtle => 1 } } })
+      assert_equal({ :'turtle.turtle.turtle' => 1 }, hash)
+    end
+
+    def test_turns_keys_to_symbols
+      hash = DottedHash.new({ "turtle" => { "turtle" => { "turtle" => 1 } } })
+      assert_equal({ :'turtle.turtle.turtle' => 1 }, hash)
+    end
+
+    def test_to_hash
+      dotted = DottedHash.new({ "turtle" => { "turtle" => { "turtle" => 1 } } })
+      hash = dotted.to_hash
+
+      assert_instance_of(Hash, hash)
+      assert_equal({ :'turtle.turtle.turtle' => 1 }, hash)
+    end
+
+    def test_option_to_keep_nesting
+      hash = DottedHash.new({ :turtle => { :turtle => 1 } }, true)
+      expected = {
+        :turtle => { :turtle => 1},
+        :'turtle.turtle' => 1,
+      }
+
+      assert_equal(expected, hash)
+    end
+
+    def test_borks_with_non_symbolizing_key
+      assert_raises(NoMethodError) do
+        DottedHash.new({ Object.new => 2 }, true)
+      end
+    end
+  end
+end

data/test/mmtrix/agent/configuration/environment_source_test.rb

@@ -0,0 +1,201 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','test_helper'))
+require 'mmtrix/agent/configuration/environment_source'
+
+module Mmtrix::Agent::Configuration
+  class EnvironmentSourceTest < Minitest::Test
+
+    def setup
+      @original_env = {}
+      @original_env.replace(ENV)
+      @environment_source = EnvironmentSource.new
+    end
+
+    def teardown
+      ENV.replace(@original_env)
+    end
+
+    def test_environment_strings_are_applied
+      assert_applied_string 'NRCONFIG', 'config_path'
+      assert_applied_string 'MM_TRIX_LICENSE_KEY', 'license_key'
+      assert_applied_string 'MMTRIX_LICENSE_KEY', 'license_key'
+      assert_applied_string 'MM_TRIX_APP_NAME', 'app_name'
+      assert_applied_string 'MMTRIX_APP_NAME', 'app_name'
+      assert_applied_string 'MM_TRIX_HOST', 'host'
+    end
+
+    def test_environment_fixnums_are_applied
+      assert_applied_fixnum 'MM_TRIX_PORT', 'port'
+    end
+
+    def test_environment_symbols_are_applied
+      assert_applied_symbol 'MM_TRIX_DISPATCHER', 'dispatcher'
+      assert_applied_symbol 'MMTRIX_DISPATCHER', 'dispatcher'
+      assert_applied_symbol 'MM_TRIX_FRAMEWORK', 'framework'
+      assert_applied_symbol 'MMTRIX_FRAMEWORK', 'framework'
+    end
+
+    %w| MMTRIX_ENABLE MMTRIX_ENABLED MM_TRIX_ENABLE MM_TRIX_ENABLED |.each do |var|
+      define_method("test_environment_booleans_truths_are_applied_to_#{var}") do
+        ENV[var] = 'true'
+        assert EnvironmentSource.new[:enabled]
+        ENV[var] = 'on'
+        assert EnvironmentSource.new[:enabled]
+        ENV[var] = 'yes'
+        assert EnvironmentSource.new[:enabled]
+        ENV.delete(var)
+      end
+
+      define_method("test_environment_booleans_falsehoods_are_applied_to_#{var}") do
+        ENV[var] = 'false'
+        assert !EnvironmentSource.new[:enabled]
+        ENV[var] = 'off'
+        assert !EnvironmentSource.new[:enabled]
+        ENV[var] = 'no'
+        assert !EnvironmentSource.new[:enabled]
+        ENV.delete(var)
+      end
+    end
+
+    %w| MMTRIX_DISABLE_HARVEST_THREAD MM_TRIX_DISABLE_HARVEST_THREAD |.each do |var|
+      define_method("test_environment_booleans_truths_are_applied_to_#{var}") do
+        ENV[var] = 'true'
+        assert EnvironmentSource.new[:disable_harvest_thread]
+        ENV[var] = 'on'
+        assert EnvironmentSource.new[:disable_harvest_thread]
+        ENV[var] = 'yes'
+        assert EnvironmentSource.new[:disable_harvest_thread]
+        ENV.delete(var)
+      end
+
+      define_method("test_environment_booleans_falsehoods_are_applied_to_#{var}") do
+        ENV[var] = 'false'
+        assert !EnvironmentSource.new[:disable_harvest_thread]
+        ENV[var] = 'off'
+        assert !EnvironmentSource.new[:disable_harvest_thread]
+        ENV[var] = 'no'
+        assert !EnvironmentSource.new[:disable_harvest_thread]
+        ENV.delete(var)
+      end
+    end
+
+    def test_set_log_config_from_environment
+      ENV['MM_TRIX_LOG'] = 'off/in/space.log'
+      source = EnvironmentSource.new
+      assert_equal 'off/in', source[:log_file_path]
+      assert_equal 'space.log', source[:log_file_name]
+    end
+
+    def test_set_log_config_STDOUT_from_environment
+      ENV['MM_TRIX_LOG'] = 'STDOUT'
+      source = EnvironmentSource.new
+      assert_equal 'STDOUT', source[:log_file_name]
+      assert_equal 'STDOUT', source[:log_file_path]
+    end
+
+    def test_set_values_from_mmtrix_environment_variables
+      keys = %w(MM_TRIX_LICENSE_KEY MMTRIX_CONFIG_PATH)
+      keys.each { |key| ENV[key] = 'skywizards' }
+
+      expected_source = EnvironmentSource.new
+
+      [:license_key, :config_path].each do |key|
+        assert_equal 'skywizards', expected_source[key]
+      end
+    end
+
+    def test_set_values_from_mmtrix_environment_variables_warns_unknowns
+      ENV['MMTRIX_DOESNT_USE_THIS_VALUE'] = "true"
+      expects_logging(:info, includes("MMTRIX_DOESNT_USE_THIS_VALUE"))
+      @environment_source.set_values_from_mmtrix_environment_variables
+    end
+
+    def test_set_values_from_mmtrix_environment_variables_ignores_MM_TRIX_LOG
+      ENV['MM_TRIX_LOG'] = "STDOUT"
+      expects_no_logging(:info)
+      @environment_source.set_values_from_mmtrix_environment_variables
+    end
+
+    def test_set_value_from_environment_variable
+      ENV['MM_TRIX_LICENSE_KEY'] = 'super rad'
+      @environment_source.set_value_from_environment_variable('MM_TRIX_LICENSE_KEY')
+      assert_equal @environment_source[:license_key], 'super rad'
+    end
+
+    def test_set_key_by_type_uses_the_default_type
+      ENV['MM_TRIX_TEST'] = 'true'
+      @environment_source.set_key_by_type(:enabled, 'MM_TRIX_TEST')
+      assert_equal true, @environment_source[:enabled]
+    end
+
+    def test_set_key_with_mmtrix_prefix
+      assert_applied_string('MM_TRIX_LICENSE_KEY', :license_key)
+    end
+
+    def test_set_key_with_mmtrix_prefix
+      assert_applied_string('MMTRIX_LICENSE_KEY', :license_key)
+    end
+
+    def test_does_not_set_key_without_mmtrix_related_prefix
+      ENV['CONFIG_PATH'] = 'boom'
+      refute_equal 'boom', EnvironmentSource.new[:config_path]
+    end
+
+    def test_convert_environment_key_to_config_key
+      result = @environment_source.convert_environment_key_to_config_key('MM_TRIX_IS_RAD')
+      assert_equal :is_rad, result
+    end
+
+    def test_convert_environment_key_to_config_key_respects_aliases
+      assert_applied_boolean('MMTRIX_ENABLE', :enabled)
+    end
+
+    def test_convert_environment_key_to_config_key_allows_underscores_as_dots
+      assert_applied_string('MM_TRIX_AUDIT_LOG_PATH', :'audit_log.path')
+    end
+
+    def test_collect_mmtrix_environment_variable_keys
+      keys = %w(MM_TRIX_IS_RAD MMTRIX_IS_MAGIC)
+      keys.each { |key| ENV[key] = 'true' }
+
+      result = @environment_source.collect_mmtrix_environment_variable_keys
+      assert_equal keys, result
+    end
+
+    def test_does_not_warn_for_mmtrix_env_environment_variable
+      expects_no_logging(:warn)
+      expects_no_logging(:info)
+      with_environment('MM_TRIX_ENV' => 'foo') do
+        @environment_source.set_values_from_mmtrix_environment_variables
+      end
+    end
+
+    def assert_applied_string(env_var, config_var)
+      ENV[env_var] = 'test value'
+      assert_equal 'test value', EnvironmentSource.new[config_var.to_sym]
+      ENV.delete(env_var)
+    end
+
+    def assert_applied_symbol(env_var, config_var)
+      ENV[env_var] = 'test value'
+      assert_equal :'test value', EnvironmentSource.new[config_var.to_sym]
+      ENV.delete(env_var)
+    end
+
+    def assert_applied_fixnum(env_var, config_var)
+      ENV[env_var] = '3000'
+      assert_equal 3000, EnvironmentSource.new[config_var.to_sym]
+      ENV.delete(env_var)
+    end
+
+    def assert_applied_boolean(env_var, config_var)
+      ENV[env_var] = 'true'
+      assert_equal true, EnvironmentSource.new[config_var.to_sym]
+      ENV.delete(env_var)
+    end
+
+  end
+end

data/test/mmtrix/agent/configuration/high_security_source_test.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','test_helper'))
+require 'mmtrix/agent/configuration/high_security_source'
+
+module Mmtrix::Agent::Configuration
+  class HighSecuritySourceTest < Minitest::Test
+    def test_leaves_obfuscated_record_sql_parameters
+      local_settings = {
+        :'transaction_tracer.record_sql' => 'obfuscated',
+        :'slow_sql.record_sql'           => 'obfuscated'
+      }
+
+      source = HighSecuritySource.new(local_settings)
+
+      assert_equal('obfuscated', source[:'transaction_tracer.record_sql'])
+      assert_equal('obfuscated', source[:'slow_sql.record_sql'])
+    end
+
+    def test_leaves_off_record_sql_parameters
+      local_settings = {
+        :'transaction_tracer.record_sql' => 'off',
+        :'slow_sql.record_sql'           => 'off'
+      }
+
+      source = HighSecuritySource.new(local_settings)
+
+      assert_equal('off', source[:'transaction_tracer.record_sql'])
+      assert_equal('off', source[:'slow_sql.record_sql'])
+    end
+
+    def test_changes_raw_record_sql_to_obfuscated
+      local_settings = {
+        :'transaction_tracer.record_sql' => 'raw',
+        :'slow_sql.record_sql'           => 'raw'
+      }
+
+      source = HighSecuritySource.new(local_settings)
+
+      assert_equal('obfuscated', source[:'transaction_tracer.record_sql'])
+      assert_equal('obfuscated', source[:'slow_sql.record_sql'])
+    end
+
+    def test_forces_unrecognized_values_to_off
+      local_settings = {
+        :'transaction_tracer.record_sql' => 'jibberish',
+        :'slow_sql.record_sql'           => 'junk'
+      }
+
+      expects_logging(:info, includes('jibberish'))
+
+      source = HighSecuritySource.new(local_settings)
+
+      assert_equal('off', source[:'transaction_tracer.record_sql'])
+      assert_equal('off', source[:'slow_sql.record_sql'])
+    end
+
+    def test_logs_when_changing_raw_to_obfuscated
+      local_settings = {
+        :'transaction_tracer.record_sql' => 'raw',
+        :'slow_sql.record_sql'           => 'raw'
+      }
+
+      expects_logging(:info, all_of(includes('raw'), includes('obfuscated')))
+
+      HighSecuritySource.new(local_settings)
+    end
+
+    def test_no_logging_when_allowed_values
+      local_settings = {
+        :'transaction_tracer.record_sql' => 'off',
+        :'slow_sql.record_sql'           => 'obfuscated'
+      }
+
+      expects_no_logging(:info)
+
+      HighSecuritySource.new(local_settings)
+    end
+
+  end
+end