mmtrix_rpm 1.0.0.1

data/test/mmtrix/language_support_test.rb

@@ -0,0 +1,104 @@
+# 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'))
+
+class Mmtrix::LanguageSupportTest < Minitest::Test
+  include ::Mmtrix::TestHelpers::RuntimeDetection
+
+  def test_object_space_usable_on_jruby_with_object_space_enabled
+    return unless jruby?
+    JRuby.objectspace = true
+    assert_truthy Mmtrix::LanguageSupport.object_space_usable?
+  end
+
+  def test_object_space_not_usable_on_jruby_with_object_space_disabled
+    return unless jruby?
+    JRuby.objectspace = false
+    assert_falsy Mmtrix::LanguageSupport.object_space_usable?
+  end
+
+  def test_object_space_not_usable_on_rubinius
+    return unless rubinius?
+    assert_falsy Mmtrix::LanguageSupport.object_space_usable?
+  end
+
+  def test_gc_profiler_unavailable_without_constant
+    undefine_constant(:'GC::Profiler') do
+      assert_equal false, Mmtrix::LanguageSupport.gc_profiler_usable?
+    end
+  end
+
+  def test_gc_profiler_unavailable_on_jruby
+    return unless jruby?
+    assert_equal false, Mmtrix::LanguageSupport.gc_profiler_usable?
+  end
+
+  def test_gc_profiler_disabled_without_constant
+    undefine_constant(:'GC::Profiler') do
+      assert_equal false, Mmtrix::LanguageSupport.gc_profiler_enabled?
+    end
+  end
+
+  if Mmtrix::LanguageSupport.gc_profiler_usable?
+    def test_gc_profiler_disabled_when_enabled_is_falsy
+      ::GC::Profiler.stubs(:enabled?).returns(false)
+      assert_equal false, Mmtrix::LanguageSupport.gc_profiler_enabled?
+    end
+
+    def test_gc_profiler_enabled
+      ::GC::Profiler.stubs(:enabled?).returns(true)
+      assert_equal true, Mmtrix::LanguageSupport.gc_profiler_enabled?
+    end
+
+    def test_gc_profiler_enabled_when_response_is_only_truthy
+      ::GC::Profiler.stubs(:enabled?).returns(0)
+      assert_equal true, Mmtrix::LanguageSupport.gc_profiler_enabled?
+    end
+
+    def test_gc_profiler_enabled_when_config_is_disabled
+      ::GC::Profiler.stubs(:enabled?).returns(true)
+      with_config(:disable_gc_profiler => true) do
+        refute Mmtrix::LanguageSupport.gc_profiler_enabled?
+      end
+    end
+  end
+
+  def test_gc_profiler_disabled_on_jruby
+    return unless defined?(::GC::Profiler) && jruby?
+
+    ::GC::Profiler.stubs(:enabled?).returns(true)
+    assert_equal false, Mmtrix::LanguageSupport.gc_profiler_enabled?
+  end
+
+  module ::Outer
+    class Included
+    end
+  end
+
+  class ::Excluded
+  end
+
+  module ::ContainsAnObject
+    class ContainedObject
+    end
+  end
+
+  def test_should_look_within_module
+    assert_equal ::Outer::Included, Mmtrix::LanguageSupport.constantize("Outer::Included")
+  end
+
+  def test_shouldnt_look_outside_module_for_class
+    assert_equal nil, Mmtrix::LanguageSupport.constantize("Outer::Excluded")
+  end
+
+  def test_shouldnt_look_outside_module_for_module
+    assert_equal nil, Mmtrix::LanguageSupport.constantize("Outer::Outer")
+  end
+
+  def test_should_allow_object_in_module_names
+    assert_equal ::ContainsAnObject::ContainedObject,
+                  Mmtrix::LanguageSupport.constantize("ContainsAnObject::ContainedObject")
+  end
+end

data/test/mmtrix/latest_changes_test.rb

@@ -0,0 +1,45 @@
+# 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__,'..','..','test_helper'))
+
+module Mmtrix
+  class LatestChangesTest < MiniTest::Test
+    def setup
+      # 1.8.7 returns relative paths for __FILE__. test:env environment then
+      # can't find the CHANGELOG since current dir is test app instead of gem.
+      #
+      # This doesn't impact production usage of Mmtrix::LatestChanges on
+      # the gem post-installation, since that's run in our gem's context. So
+      # just fix up the pathing in the test for finding default changelog.
+      if RUBY_VERSION < '1.9.1'
+        Mmtrix::LatestChanges.stubs(:default_changelog).returns(File.join(File.dirname(__FILE__), '..', '..', 'CHANGELOG'))
+      end
+    end
+
+    def test_read_default_changelog
+      result = Mmtrix::LatestChanges.read
+      assert_match(/# Mmtrix Ruby Agent Release Notes #/, result)
+      assert_match(/## v\d\.\d{1,2}\.\d{1,2} ##/, result)
+    end
+
+    def test_latest_changes_from_fakechangelog
+      result = Mmtrix::LatestChanges.read(File.join(File.dirname(__FILE__), 'FAKECHANGELOG'))
+      assert_match(/3.7.2/, result)
+    end
+
+    def test_patch_latest_changes_from_fakechangelog
+      result = Mmtrix::LatestChanges.read_patch('3.7.2.4242', File.join(File.dirname(__FILE__), 'FAKECHANGELOG'))
+      expected = <<END
+## v3.7.2.4242 ##
+
+* Patch (3.7.2.4242)
+
+  Patch for something
+END
+      assert_equal expected, result
+    end
+
+  end
+end

data/test/mmtrix/license_test.rb

@@ -0,0 +1,128 @@
+# 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'))
+
+# look through the source code to enforce some simple rules that help us keep
+# our license data up to date.
+class LicenseTest < Minitest::Test
+  include Mmtrix::TestHelpers::FileSearching
+
+  # A list of regexs that will likely match license info
+  LICENSE_TERMS = {
+    'GPL' => /GPL/i,
+    '(c)' => /\(c\)/i,
+    'Copyright' => /copyright/i,
+    'BSD' => /\bBSD\b/i,
+    'MIT' => /\bMIT\b/i,
+    'Apache' => /\bapache\b/i,
+    'rights reserved' => /rights reserved/i,
+  }
+
+  # Known occurrences of the above license terms
+  # format is:
+  # [ file, term ] => expected_number_of_occurances
+  # unless listed here the expectation is that these terms will not occur in
+  # the source code.
+  EXPECTED_LICENSE_OCCURRENCES = {
+    ['/mmtrix_rpm.gemspec', 'MIT'] => 1, # licenses specificiation, which includes MIT for MIT-licensed portions of code
+    ['/lib/mmtrix/okjson.rb', '(c)'] => 3, # methods arguments like (c)
+    ['/lib/mmtrix/okjson.rb', 'Copyright'] => 3, # okjson license info
+    ['/lib/mmtrix/timer_lib.rb', '(c)'] => 1, # timer_lib license info
+    ['/lib/mmtrix/timer_lib.rb', 'Copyright'] => 1, # timer_lib license info
+    ['/LICENSE', 'GPL'] => 1, # dual license info for system_timer
+    ['/LICENSE', 'MIT'] => 3,
+    ['/LICENSE', '(c)'] => 3,
+    ['/LICENSE', 'Copyright'] => 11,
+    ['/LICENSE', 'rights reserved'] => 1,
+    ['/ui/views/layouts/mmtrix_default.rhtml', 'rights reserved'] => 1,
+    ['/ui/views/mmtrix/file/javascript/jquery-1.4.2.js', 'GPL'] => 3,
+    ['/ui/views/mmtrix/file/javascript/jquery-1.4.2.js', 'BSD'] => 2,
+    ['/ui/views/mmtrix/file/javascript/jquery-1.4.2.js', 'Copyright'] => 3,
+    ['/ui/views/mmtrix/file/javascript/jquery-1.4.2.js', 'MIT'] => 3,
+    ['/test/mmtrix/agent/agent_test_controller_test.rb', 'Apache'] => 1, # apache header tests
+    ['/vendor/gems/metric_parser-0.1.0.pre1/lib/mmtrix/metric_parser/solr.rb', 'Apache'] => 2, # parse apache solr metrics
+    ['/vendor/gems/metric_parser-0.1.0.pre1/lib/mmtrix/metric_parser/solr_request_handler.rb', 'Apache'] => 1, # parse apache solr metrics
+    ['/lib/mmtrix/agent/system_info.rb', 'BSD'] => 4,
+    ['/test/mmtrix/agent/system_info_test.rb', 'BSD'] => 2
+  }
+
+  def shebang
+    /^#!/
+  end
+
+  def encoding
+    /^# ?(en)?coding: utf-8/
+  end
+
+  def syntax_mark
+    /^# -\*- ruby -\*-/
+  end
+
+  def should_skip?(path)
+    (
+      # skip directories
+      !File.file?(path) ||
+      # skip binary files
+      %w| .sqlite3 .log .png .ico .gif .pdf .gem |.include?(File.extname(path)) ||
+      # skip this file
+      File.expand_path(__FILE__) == path ||
+      # skip rpm_test_app and other stuff that ends up in tmp
+      path.include?(gem_root + '/tmp/') ||
+      # skip the auto-generated build.rb file
+      path =~ %r{lib/mmtrix/build\.rb} ||
+      # skip tags file
+      path =~ %r{/tags$}i ||
+      # skip multiverse auto-generated gemfiles
+      path =~ %r{/test/multiverse/suites/.*/Gemfile\.\d+(\.lock)?$} ||
+      # skip multiverse auto-generated db/schema
+      path =~ %r{/test/multiverse/suites/.*/db/schema.rb$} ||
+      # skip the artifacts directory
+      path =~ %r{/artifacts/}
+    )
+  end
+
+  def test_all_rb_and_js_files_have_license_header
+    all_rb_and_js_files.each do |filename|
+      next if should_skip?(filename)
+
+      first_thousand_bytes = File.read(filename, 1000)
+      refute_nil first_thousand_bytes, "#{filename} is shorter than 1000 bytes."
+
+      first_four_lines = first_thousand_bytes.split("\n")[0...4]
+
+      if first_four_lines.first =~ shebang
+        first_four_lines.shift # discard it
+      end
+      if first_four_lines.first =~ syntax_mark
+        first_four_lines.shift # discard it
+      end
+      if first_four_lines.first =~ encoding
+        first_four_lines.shift # discard it
+      end
+
+      assert_match(/This file is distributed under .+ license terms\./, first_four_lines[0], "#{filename} does not contain the proper license header.")
+      assert_match(%r"See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.", first_four_lines[1])
+    end
+  end
+
+  def test_for_scary_license_terms
+    files_to_check = all_files.reject { |f| should_skip?(f) }
+    files_to_check.each do |filename|
+      LICENSE_TERMS.each do |key, pattern|
+        begin
+          # we're checking this one.  We'll update the count of checked files below.
+          occurrences = File.readlines(filename).grep(pattern).size
+          expected = (EXPECTED_LICENSE_OCCURRENCES[[filename.sub(gem_root, ''), key]] || 0)
+          assert_equal expected, occurrences, "#{filename} contains #{key} #{occurrences} times. Should be #{expected}"
+        rescue => e
+          raise "Error when checking file #{filename}: #{e}"
+        end
+      end
+    end
+    # sanity check that we are not skipping all the files.
+    checked_files = files_to_check.size
+    assert checked_files >= 390, "Somethings off. We only scanned #{checked_files} files for license info.  There should be more."
+  end
+end

data/test/mmtrix/load_test.rb

@@ -0,0 +1,15 @@
+# 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 'resolv'
+require 'mocha/setup'
+
+class LoadTest < Minitest::Test
+  def test_loading_agent_when_disabled_does_not_resolv_addresses
+    ::Resolv.expects(:getaddress).never
+    ::IPSocket.expects(:getaddress).never
+
+    require File.expand_path(File.join(File.dirname(__FILE__),'..','test_helper'))
+  end
+end

data/test/mmtrix/local_environment_test.rb

@@ -0,0 +1,103 @@
+# 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'))
+class Mmtrix::LocalEnvironmentTest < Minitest::Test
+
+  def teardown
+    Mmtrix::Control.reset
+  end
+
+  def test_passenger
+    with_constant_defined(:PhusionPassenger, Module.new) do
+      Mmtrix::Agent.reset_config
+      e = Mmtrix::LocalEnvironment.new
+      assert_equal :passenger, e.discovered_dispatcher
+      assert_equal :passenger, Mmtrix::Agent.config[:dispatcher]
+
+      with_config(:app_name => 'myapp') do
+        e = Mmtrix::LocalEnvironment.new
+        assert_equal :passenger, e.discovered_dispatcher
+      end
+    end
+  end
+
+  def test_not_resque
+    combinations = [["notrake", "resque:work",    { "QUEUE" => "*" } ],
+                    ["rake",    "notresque:work", { "QUEUE" => "*" } ],
+                    ["rake",    "resque:work",    { "BBQ"   => "*" } ]]
+
+    combinations.each do |settings|
+      with_resque(*settings) do
+        refute_resque(settings)
+      end
+    end
+  end
+
+  def test_resque
+    combinations = [["rake", "resque:work", { "QUEUE"  => "*" }],
+                    ["rake", "resque:work", { "QUEUES" => "*" }]]
+
+    combinations.each do |settings|
+      with_resque(*settings) do
+        assert_resque(settings)
+      end
+    end
+  end
+
+  def test_not_resque_pool
+    combinations = [["notresque-pool", nil],
+                    ["rake", "notresque:pool"]]
+
+    combinations.each do |settings|
+      with_resque_pool(*settings) do
+        refute_resque(settings)
+      end
+    end
+  end
+
+  def test_resque_pool
+    combinations = [["resque-pool", nil],
+                    ["rake", "resque:pool"]]
+
+    combinations.each do |settings|
+      with_resque_pool(*settings) do
+        assert_resque(settings)
+      end
+    end
+  end
+
+  def with_resque(basename, *args)
+    env  = {}
+    env  = args.last if args.last.is_a?(Hash)
+    argv = args[0..-1]
+
+    with_constant_defined(:Resque) do
+      with_environment(env) do
+        with_argv(argv) do
+          File.stubs(:basename).returns(basename)
+          yield
+        end
+      end
+    end
+  end
+
+  def with_resque_pool(basename, *args)
+    with_resque(basename, *args) do
+      with_constant_defined(:'Resque::Pool') do
+        yield
+      end
+    end
+  end
+
+  def assert_resque(settings)
+    e = Mmtrix::LocalEnvironment.new
+    assert_equal :resque, e.discovered_dispatcher, settings.inspect
+  end
+
+  def refute_resque(settings)
+    e = Mmtrix::LocalEnvironment.new
+    refute_equal :resque, e.discovered_dispatcher, settings.inspect
+  end
+end

data/test/mmtrix/marshalling_test_cases.rb

@@ -0,0 +1,140 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+# These tests are intended to exercise the basic marshalling functionality of
+# the agent in it's different permutations (Ruby and JSON)
+module MarshallingTestCases
+
+  def test_sends_metrics
+    with_around_hook do
+      Mmtrix::Agent.record_metric('Boo', 42)
+    end
+
+    transmit_data
+
+    result = $collector.calls_for('metric_data')
+    assert_equal 1, result.length
+    assert_includes result.first.metric_names, 'Boo'
+  end
+
+  def test_sends_errors
+    with_around_hook do
+      Mmtrix::Agent.notice_error(StandardError.new("Boom"))
+    end
+
+    transmit_data
+
+    result = $collector.calls_for('error_data')
+    assert_equal 1, result.length
+    assert_equal 1, result.first.errors.length
+    assert_equal "StandardError", result.first.errors.first.exception_class_name
+  end
+
+  def test_sends_transaction_traces
+    with_config(:'transaction_tracer.transaction_threshold' => -1.0) do
+      with_around_hook do
+        Transactioner.new.do_it
+      end
+    end
+
+    transmit_data
+
+    result = $collector.calls_for('transaction_sample_data')
+    assert_equal 1, result.length
+    assert_equal "TestTransaction/do_it", result.first.metric_name
+  end
+
+  def test_sends_transaction_events
+    t0 = freeze_time(Time.at(Time.now.to_i))
+
+    with_around_hook do
+      Transactioner.new.do_it
+    end
+
+    transmit_event_data
+
+    result = $collector.calls_for('analytic_event_data')
+    assert_equal 1, result.length
+    events = result.first.events
+    assert_equal 1, events.length
+
+    expected_event = [
+      {
+        "type"      => "Transaction",
+        "timestamp" => t0.to_f,
+        "name"      => "TestTransaction/do_it",
+        "duration"  => 0.0,
+      },
+      {},
+      {}
+    ]
+
+    event = events.first
+    # this is only present on REE, and we don't really care - the point of this
+    # test is just to validate basic marshalling
+    event[0].delete("gcCumulative")
+
+    assert_equal(expected_event, event)
+  end
+
+  def test_sends_custom_events
+    t0 = freeze_time
+
+    with_around_hook do
+      Mmtrix::Agent.record_custom_event("CustomEventType", :foo => 'bar', :baz => 'qux')
+    end
+
+    transmit_event_data
+
+    result = $collector.calls_for('custom_event_data')
+    assert_equal 1, result.length
+    events = result.first.events
+    assert_equal 1, events.length
+
+    expected_event = [
+      {
+        "type"      => "CustomEventType",
+        "timestamp" => t0.to_i
+      },
+      {
+        "foo" => "bar",
+        "baz" => "qux"
+      }
+    ]
+
+    assert_equal(expected_event, events.first)
+  end
+
+  class Transactioner
+    include Mmtrix::Agent::Instrumentation::ControllerInstrumentation
+
+    def do_it
+      Mmtrix::Agent.set_transaction_name("do_it", :category => "TestTransaction")
+    end
+
+    add_transaction_tracer :do_it
+  end
+
+  def with_around_hook(&blk)
+    if respond_to?(:around_each)
+      around_each do
+        blk.call
+      end
+    else
+      blk.call
+    end
+
+    if respond_to?(:after_each)
+      after_each
+    end
+  end
+
+  def transmit_data
+    Mmtrix::Agent.instance.send(:transmit_data)
+  end
+
+  def transmit_event_data
+    Mmtrix::Agent.instance.send(:transmit_event_data)
+  end
+end