statsd-instrument 2.9.0 → 3.0.0

data/lib/statsd/instrument/version.rb

@@ -2,6 +2,6 @@
 
 module StatsD
   module Instrument
-    VERSION = "2.9.0"
+    VERSION = "3.0.0"
   end
 end

data/test/assertions_test.rb

@@ -132,43 +132,55 @@ class AssertionsTest < Minitest::Test
   end
 
   def test_assert_statsd_gauge_call_with_numeric_value
-    @test_case.assert_statsd_gauge('gauge', value: 42) do
+    @test_case.assert_statsd_gauge('gauge', 42) do
       StatsD.gauge('gauge', 42)
     end
 
-    @test_case.assert_statsd_gauge('gauge', value: '42') do
+    @test_case.assert_statsd_gauge('gauge', '42') do
       StatsD.gauge('gauge', 42)
     end
 
     assert_raises(Minitest::Assertion) do
-      @test_case.assert_statsd_gauge('gauge', value: 42) do
+      @test_case.assert_statsd_gauge('gauge', 42) do
         StatsD.gauge('gauge', 45)
       end
     end
+
+    @test_case.assert_statsd_gauge('gauge', value: 42) do
+      StatsD.gauge('gauge', 42)
+    end
   end
 
   def test_assert_statsd_set_call_with_string_value
-    @test_case.assert_statsd_set('set', value: 12345) do
+    @test_case.assert_statsd_set('set', 12345) do
       StatsD.set('set', '12345')
     end
 
-    @test_case.assert_statsd_set('set', value: '12345') do
+    @test_case.assert_statsd_set('set', '12345') do
       StatsD.set('set', '12345')
     end
 
-    @test_case.assert_statsd_set('set', value: 12345) do
+    @test_case.assert_statsd_set('set', 12345) do
       StatsD.set('set', 12345)
     end
 
-    @test_case.assert_statsd_set('set', value: '12345') do
+    @test_case.assert_statsd_set('set', '12345') do
       StatsD.set('set', 12345)
     end
 
     assert_raises(Minitest::Assertion) do
-      @test_case.assert_statsd_set('set', value: '42') do
+      @test_case.assert_statsd_set('set', '42') do
         StatsD.set('set', 45)
       end
     end
+
+    @test_case.assert_statsd_set('set', value: 12345) do
+      StatsD.set('set', '12345')
+    end
+
+    @test_case.assert_statsd_set('set', 'wrong_value', value: 12345) do
+      StatsD.set('set', '12345')
+    end
   end
 
   def test_tags_will_match_subsets
@@ -285,7 +297,7 @@ class AssertionsTest < Minitest::Test
     end
 
     foo_1_metric = StatsD::Instrument::Expectation.increment('counter', times: 2, tags: ['foo:1'])
-    foo_2_metric = StatsD::Instrument::Expectation.increment('counter', tags: ['foo:2'])
+    foo_2_metric = StatsD::Instrument::Expectation.increment('counter', 1, tags: ['foo:2'])
     @test_case.assert_statsd_expectations([foo_1_metric, foo_2_metric]) do
       StatsD.increment('counter', tags: { foo: 1 })
       StatsD.increment('counter', tags: { foo: 1 })

data/test/client_test.rb

@@ -186,6 +186,17 @@ class ClientTest < Minitest::Test
     assert_equal "bar", datagrams[1].name
   end
 
+  def test_default_tags_normalization
+    client = StatsD::Instrument::Client.new(default_tags: { first_tag: 'f|irst_value', second_tag: 'sec,ond_value' })
+    datagrams = client.capture do
+      client.increment('bar', tags: ['th|ird_#,tag'])
+    end
+
+    assert_includes datagrams.first.tags, 'first_tag:first_value'
+    assert_includes datagrams.first.tags, 'second_tag:second_value'
+    assert_includes datagrams.first.tags, 'third_#tag'
+  end
+
   def test_sampling
     mock_sink = mock('sink')
     mock_sink.stubs(:sample?).returns(false, true, false, false, true)

data/test/environment_test.rb

@@ -5,37 +5,6 @@ require 'test_helper'
 module Rails; end
 
 class EnvironmentTest < Minitest::Test
-  def setup
-    ENV['STATSD_ADDR'] = nil
-    ENV['IMPLEMENTATION'] = nil
-  end
-
-  def test_default_backend_uses_logger_in_development_environment
-    StatsD::Instrument::Environment.stubs(:environment).returns('development')
-    assert_instance_of StatsD::Instrument::Backends::LoggerBackend, StatsD::Instrument::Environment.default_backend
-  end
-
-  def test_default_backend_uses_null_backend_in_test_environment
-    StatsD::Instrument::Environment.stubs(:environment).returns('test')
-    assert_instance_of StatsD::Instrument::Backends::NullBackend, StatsD::Instrument::Environment.default_backend
-  end
-
-  def test_default_backend_uses_udp_backend_in_production_environment
-    StatsD::Instrument::Environment.stubs(:environment).returns('production')
-    assert_instance_of StatsD::Instrument::Backends::UDPBackend, StatsD::Instrument::Environment.default_backend
-  end
-
-  def test_default_backend_uses_environment_variables_in_production_environment
-    StatsD::Instrument::Environment.stubs(:environment).returns('production')
-    ENV['STATSD_ADDR'] = '127.0.0.1:1234'
-    ENV['STATSD_IMPLEMENTATION'] = 'datadog'
-
-    backend = StatsD::Instrument::Environment.default_backend
-    assert_equal '127.0.0.1', backend.host
-    assert_equal 1234, backend.port
-    assert_equal :datadog, backend.implementation
-  end
-
   def test_environment_prefers_statsd_env_if_available
     env = StatsD::Instrument::Environment.new(
       'STATSD_ENV' => 'set_from_STATSD_ENV',
@@ -62,13 +31,8 @@ class EnvironmentTest < Minitest::Test
     assert_equal 'development', env.environment
   end
 
-  def test_legacy_client_is_default_client
+  def test_client_returns_client_instance
     env = StatsD::Instrument::Environment.new({})
-    assert_kind_of StatsD::Instrument::LegacyClient, env.client
-  end
-
-  def test_client_returns_new_client_if_environment_asks_for_it
-    env = StatsD::Instrument::Environment.new('STATSD_USE_NEW_CLIENT' => '1')
     assert_kind_of StatsD::Instrument::Client, env.client
   end
 

data/test/integration_test.rb

@@ -6,39 +6,24 @@ class IntegrationTest < Minitest::Test
   def setup
     @server = UDPSocket.new
     @server.bind('localhost', 0)
-    port = @server.addr[1]
 
-    @old_backend = StatsD.backend
-    StatsD.backend = StatsD::Instrument::Backends::UDPBackend.new("localhost:#{port}")
+    @env = StatsD::Instrument::Environment.new(
+      'STATSD_ADDR' => "#{@server.addr[2]}:#{@server.addr[1]}",
+      'STATSD_IMPLEMENTATION' => 'dogstatsd',
+      'STATSD_ENV' => 'production',
+    )
+
+    @old_client = StatsD.singleton_client
+    StatsD.singleton_client = @env.client
   end
 
   def teardown
+    StatsD.singleton_client = @old_client
     @server.close
-    StatsD.backend = @old_backend
   end
 
   def test_live_local_udp_socket
     StatsD.increment('counter')
     assert_equal "counter:1|c", @server.recvfrom(100).first
   end
-
-  def test_synchronize_in_exit_handler_handles_thread_error_and_exits_cleanly
-    pid = fork do
-      Signal.trap('TERM') do
-        StatsD.increment('exiting')
-        Process.exit!(0)
-      end
-
-      sleep 100
-    end
-
-    Process.kill('TERM', pid)
-    _, exit_status = Process.waitpid2(pid)
-
-    assert_equal 0, exit_status, "The forked process did not exit cleanly"
-    assert_equal "exiting:1|c", @server.recvfrom_nonblock(100).first
-
-  rescue NotImplementedError
-    pass("Fork is not implemented on #{RUBY_PLATFORM}")
-  end
 end

data/test/statsd_instrumentation_test.rb

@@ -326,30 +326,42 @@ class StatsDInstrumentationTest < Minitest::Test
   end
 
   def test_statsd_respects_global_prefix_changes
-    StatsD.prefix = 'Foo'
+    old_client = StatsD.singleton_client
+
+    StatsD.singleton_client = StatsD::Instrument::Client.new(prefix: 'Foo')
     ActiveMerchant::Gateway.singleton_class.extend StatsD::Instrument
     ActiveMerchant::Gateway.singleton_class.statsd_count :sync, 'ActiveMerchant.Gateway.sync'
-    StatsD.prefix = 'Quc'
+    StatsD.singleton_client = StatsD::Instrument::Client.new(prefix: 'Quc')
 
-    statsd_calls = capture_statsd_calls { ActiveMerchant::Gateway.sync }
-    assert_equal 1, statsd_calls.length
-    assert_equal "Quc.ActiveMerchant.Gateway.sync", statsd_calls.first.name
+    datagrams = capture_statsd_calls { ActiveMerchant::Gateway.sync }
+    assert_equal 1, datagrams.length
+    assert_equal "Quc.ActiveMerchant.Gateway.sync", datagrams.first.name
   ensure
-    StatsD.prefix = nil
+    StatsD.singleton_client = old_client
     ActiveMerchant::Gateway.singleton_class.statsd_remove_count :sync, 'ActiveMerchant.Gateway.sync'
   end
 
+  def test_statsd_count_with_injected_client
+    client = StatsD::Instrument::Client.new(prefix: 'prefix')
+
+    ActiveMerchant::Gateway.statsd_count(:ssl_post, 'ActiveMerchant.Gateway.ssl_post', client: client)
+    assert_statsd_increment('prefix.ActiveMerchant.Gateway.ssl_post', client: client) do
+      ActiveMerchant::Gateway.new.purchase(true)
+    end
+  ensure
+    ActiveMerchant::Gateway.statsd_remove_count :ssl_post, 'ActiveMerchant.Gateway.ssl_post'
+  end
+
   def test_statsd_macro_can_disable_prefix
-    StatsD.prefix = 'Foo'
+    client = StatsD::Instrument::Client.new(prefix: 'foo')
     ActiveMerchant::Gateway.singleton_class.extend StatsD::Instrument
-    ActiveMerchant::Gateway.singleton_class.statsd_count_success :sync, 'ActiveMerchant.Gateway.sync', no_prefix: true
-    StatsD.prefix = 'Quc'
+    ActiveMerchant::Gateway.singleton_class.statsd_count_success(:sync,
+      'ActiveMerchant.Gateway.sync', no_prefix: true, client: client)
 
-    statsd_calls = capture_statsd_calls { ActiveMerchant::Gateway.sync }
-    assert_equal 1, statsd_calls.length
-    assert_equal "ActiveMerchant.Gateway.sync.success", statsd_calls.first.name
+    datagrams = client.capture { ActiveMerchant::Gateway.sync }
+    assert_equal 1, datagrams.length
+    assert_equal "ActiveMerchant.Gateway.sync.success", datagrams.first.name
   ensure
-    StatsD.prefix = nil
     ActiveMerchant::Gateway.singleton_class.statsd_remove_count_success :sync, 'ActiveMerchant.Gateway.sync'
   end
 
@@ -417,43 +429,6 @@ class StatsDInstrumentationTest < Minitest::Test
     end
   end
 
-  def test_statsd_measure_with_new_client
-    old_client = StatsD.singleton_client
-    StatsD.singleton_client = StatsD::Instrument::Client.new
-
-    ActiveMerchant::UniqueGateway.statsd_measure :ssl_post, 'ActiveMerchant.Gateway.ssl_post', sample_rate: 0.3
-    assert_statsd_measure('ActiveMerchant.Gateway.ssl_post', sample_rate: 0.3) do
-      ActiveMerchant::UniqueGateway.new.purchase(true)
-    end
-  ensure
-    ActiveMerchant::UniqueGateway.statsd_remove_measure :ssl_post, 'ActiveMerchant.Gateway.ssl_post'
-    StatsD.singleton_client = old_client
-  end
-
-  def test_statsd_count_with_new_client
-    old_client = StatsD.singleton_client
-    StatsD.singleton_client = StatsD::Instrument::Client.new
-
-    ActiveMerchant::Gateway.statsd_count :ssl_post, 'ActiveMerchant.Gateway.ssl_post'
-    assert_statsd_increment('ActiveMerchant.Gateway.ssl_post') do
-      ActiveMerchant::Gateway.new.purchase(true)
-    end
-  ensure
-    ActiveMerchant::Gateway.statsd_remove_count :ssl_post, 'ActiveMerchant.Gateway.ssl_post'
-    StatsD.singleton_client = old_client
-  end
-
-  def test_statsd_count_with_injected_client
-    client = StatsD::Instrument::Client.new(prefix: 'prefix')
-
-    ActiveMerchant::Gateway.statsd_count(:ssl_post, 'ActiveMerchant.Gateway.ssl_post', client: client)
-    assert_statsd_increment('prefix.ActiveMerchant.Gateway.ssl_post', client: client) do
-      ActiveMerchant::Gateway.new.purchase(true)
-    end
-  ensure
-    ActiveMerchant::Gateway.statsd_remove_count :ssl_post, 'ActiveMerchant.Gateway.ssl_post'
-  end
-
   private
 
   def assert_scope(klass, method, expected_scope)

data/test/statsd_test.rb

@@ -5,15 +5,6 @@ require 'test_helper'
 class StatsDTest < Minitest::Test
   include StatsD::Instrument::Assertions
 
-  def teardown
-    StatsD.default_tags = nil
-  end
-
-  def test_statsd_passed_collections_to_backend
-    StatsD.backend.expects(:collect_metric).with(instance_of(StatsD::Instrument::Metric))
-    StatsD.increment('test')
-  end
-
   def test_statsd_measure_with_explicit_value
     metric = capture_statsd_call { StatsD.measure('values.foobar', 42) }
     assert_equal 'values.foobar', metric.name
@@ -21,10 +12,6 @@ class StatsDTest < Minitest::Test
     assert_equal :ms, metric.type
   end
 
-  def test_statsd_measure_without_value_or_block
-    assert_raises(ArgumentError) { StatsD.measure('values.foobar', tags: 123) }
-  end
-
   def test_statsd_measure_with_explicit_value_and_sample_rate
     metric = capture_statsd_call { StatsD.measure('values.foobar', 42, sample_rate: 0.1) }
     assert_equal 0.1, metric.sample_rate
@@ -68,7 +55,8 @@ class StatsDTest < Minitest::Test
 
       begin
         result = lambda.call
-      rescue # rubocop:disable Lint/HandleExceptions:
+      rescue
+        # noop
       end
     end
 
@@ -85,7 +73,7 @@ class StatsDTest < Minitest::Test
 
   def test_statsd_increment_with_hash_argument
     metric = capture_statsd_call { StatsD.increment('values.foobar', tags: ['test']) }
-    assert_equal StatsD.default_sample_rate, metric.sample_rate
+    assert_equal StatsD.singleton_client.default_sample_rate, metric.sample_rate
     assert_equal ['test'], metric.tags
     assert_equal 1, metric.value
   end
@@ -98,7 +86,7 @@ class StatsDTest < Minitest::Test
   end
 
   def test_statsd_gauge_without_value
-    assert_raises(ArgumentError) { StatsD.gauge('values.foobar', tags: 123) }
+    assert_raises(ArgumentError) { StatsD.gauge('values.foobar') }
   end
 
   def test_statsd_set
@@ -159,7 +147,8 @@ class StatsDTest < Minitest::Test
 
       begin
         result = lambda.call
-      rescue # rubocop:disable Lint/HandleExceptions
+      rescue
+        # noop
       end
     end
 
@@ -200,20 +189,6 @@ class StatsDTest < Minitest::Test
     end
   end
 
-  def test_statsd_default_tags_get_normalized
-    StatsD.default_tags = { first_tag: 'first_value', second_tag: 'second_value' }
-    assert_equal ['first_tag:first_value', 'second_tag:second_value'], StatsD.default_tags
-  end
-
-  def test_name_prefix
-    StatsD.legacy_singleton_client.stubs(:prefix).returns('prefix')
-    m = capture_statsd_call { StatsD.increment('counter') }
-    assert_equal 'prefix.counter', m.name
-
-    m = capture_statsd_call { StatsD.increment('counter', no_prefix: true) }
-    assert_equal 'counter', m.name
-  end
-
   protected
 
   def capture_statsd_call(&block)

data/test/test_helper.rb

@@ -4,7 +4,7 @@ ENV['ENV'] = 'test'
 
 require 'minitest/autorun'
 require 'minitest/pride'
-require 'mocha/setup'
+require 'mocha/minitest'
 require 'statsd-instrument'
 
 require_relative 'helpers/rubocop_helper'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-31 00:00:00.000000000 Z
+date: 2020-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -133,17 +133,11 @@ files:
 - README.md
 - Rakefile
 - benchmark/README.md
-- benchmark/datagram-client
 - benchmark/send-metrics-to-dev-null-log
 - benchmark/send-metrics-to-local-udp-receiver
 - lib/statsd-instrument.rb
 - lib/statsd/instrument.rb
 - lib/statsd/instrument/assertions.rb
-- lib/statsd/instrument/backend.rb
-- lib/statsd/instrument/backends/capture_backend.rb
-- lib/statsd/instrument/backends/logger_backend.rb
-- lib/statsd/instrument/backends/null_backend.rb
-- lib/statsd/instrument/backends/udp_backend.rb
 - lib/statsd/instrument/capture_sink.rb
 - lib/statsd/instrument/client.rb
 - lib/statsd/instrument/datagram.rb
@@ -153,10 +147,8 @@ files:
 - lib/statsd/instrument/environment.rb
 - lib/statsd/instrument/expectation.rb
 - lib/statsd/instrument/helpers.rb
-- lib/statsd/instrument/legacy_client.rb
 - lib/statsd/instrument/log_sink.rb
 - lib/statsd/instrument/matchers.rb
-- lib/statsd/instrument/metric.rb
 - lib/statsd/instrument/null_sink.rb
 - lib/statsd/instrument/railtie.rb
 - lib/statsd/instrument/rubocop.rb
@@ -174,28 +166,22 @@ files:
 - lib/statsd/instrument/version.rb
 - shipit.rubygems.yml
 - statsd-instrument.gemspec
-- test/assertions_on_legacy_client_test.rb
 - test/assertions_test.rb
 - test/benchmark/clock_gettime.rb
 - test/benchmark/default_tags.rb
 - test/benchmark/metrics.rb
 - test/benchmark/tags.rb
-- test/capture_backend_test.rb
 - test/capture_sink_test.rb
 - test/client_test.rb
-- test/compatibility/dogstatsd_datagram_compatibility_test.rb
 - test/datagram_builder_test.rb
 - test/datagram_test.rb
-- test/deprecations_test.rb
 - test/dogstatsd_datagram_builder_test.rb
 - test/environment_test.rb
 - test/helpers/rubocop_helper.rb
 - test/helpers_test.rb
 - test/integration_test.rb
 - test/log_sink_test.rb
-- test/logger_backend_test.rb
 - test/matchers_test.rb
-- test/metric_test.rb
 - test/null_sink_test.rb
 - test/rubocop/measure_as_dist_argument_test.rb
 - test/rubocop/metaprogramming_positional_arguments_test.rb
@@ -209,7 +195,6 @@ files:
 - test/statsd_instrumentation_test.rb
 - test/statsd_test.rb
 - test/test_helper.rb
-- test/udp_backend_test.rb
 - test/udp_sink_test.rb
 homepage: https://github.com/Shopify/statsd-instrument
 licenses:
@@ -235,28 +220,22 @@ signing_key:
 specification_version: 4
 summary: A StatsD client for Ruby apps
 test_files:
-- test/assertions_on_legacy_client_test.rb
 - test/assertions_test.rb
 - test/benchmark/clock_gettime.rb
 - test/benchmark/default_tags.rb
 - test/benchmark/metrics.rb
 - test/benchmark/tags.rb
-- test/capture_backend_test.rb
 - test/capture_sink_test.rb
 - test/client_test.rb
-- test/compatibility/dogstatsd_datagram_compatibility_test.rb
 - test/datagram_builder_test.rb
 - test/datagram_test.rb
-- test/deprecations_test.rb
 - test/dogstatsd_datagram_builder_test.rb
 - test/environment_test.rb
 - test/helpers/rubocop_helper.rb
 - test/helpers_test.rb
 - test/integration_test.rb
 - test/log_sink_test.rb
-- test/logger_backend_test.rb
 - test/matchers_test.rb
-- test/metric_test.rb
 - test/null_sink_test.rb
 - test/rubocop/measure_as_dist_argument_test.rb
 - test/rubocop/metaprogramming_positional_arguments_test.rb
@@ -270,5 +249,4 @@ test_files:
 - test/statsd_instrumentation_test.rb
 - test/statsd_test.rb
 - test/test_helper.rb
-- test/udp_backend_test.rb
 - test/udp_sink_test.rb