statsd-instrument 2.8.0 → 2.9.0

data/test/assertions_on_legacy_client_test.rb

@@ -333,7 +333,7 @@ class AssertionsOnLegacyClientTest < Minitest::Test
   end
 
   def test_assertion_block_with_other_assertion_failures
-    # If another assertion failure happens inside the block, that failrue should have priority
+    # If another assertion failure happens inside the block, that failure should have priority
     assertion = assert_raises(Minitest::Assertion) do
       @test_case.assert_statsd_increment('counter') do
         @test_case.flunk('other assertion failure')

data/test/assertions_test.rb

@@ -33,6 +33,31 @@ class AssertionsTest < Minitest::Test
     end
     assert_equal assertion.message, "No StatsD calls for metric counter expected."
 
+    @test_case.assert_no_statsd_calls('counter1', 'counter2') do
+      # noop
+    end
+
+    @test_case.assert_no_statsd_calls('counter1', 'counter2') do
+      StatsD.increment('counter')
+    end
+
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_no_statsd_calls('counter1', 'counter2') do
+        StatsD.increment('counter0')
+        StatsD.increment('counter1')
+        StatsD.increment('counter2')
+        StatsD.increment('counter3')
+      end
+    end
+    assert_equal assertion.message, "No StatsD calls for metric counter1, counter2 expected."
+
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_no_statsd_calls('counter0', 'counter1', 'counter2') do
+        StatsD.increment('counter1')
+      end
+    end
+    assert_equal assertion.message, "No StatsD calls for metric counter1 expected."
+
     assertion = assert_raises(Minitest::Assertion) do
       @test_case.assert_no_statsd_calls do
         StatsD.increment('other')
@@ -363,7 +388,7 @@ class AssertionsTest < Minitest::Test
   end
 
   def test_assertion_block_with_other_assertion_failures
-    # If another assertion failure happens inside the block, that failrue should have priority
+    # If another assertion failure happens inside the block, that failure should have priority
     assertion = assert_raises(Minitest::Assertion) do
       @test_case.assert_statsd_increment('counter') do
         @test_case.flunk('other assertion failure')

data/test/capture_sink_test.rb

@@ -2,7 +2,7 @@
 
 require 'test_helper'
 
-class CaptureSinktest < Minitest::Test
+class CaptureSinkTest < Minitest::Test
   def test_capture_sink_captures_datagram_instances
     capture_sink = StatsD::Instrument::CaptureSink.new(parent: [])
     capture_sink << 'foo:1|c'

data/test/client_test.rb

@@ -75,11 +75,11 @@ class ClientTest < Minitest::Test
     assert_equal ['baz'], inner_datagrams.map(&:name)
   end
 
-  def test_metric_methods_return_nil
-    assert_nil @client.increment('foo')
-    assert_nil @client.measure('bar', 122.54)
-    assert_nil @client.set('baz', 123)
-    assert_nil @client.gauge('baz', 12.3)
+  def test_metric_methods_return_truish_void
+    assert @client.increment('foo')
+    assert @client.measure('bar', 122.54)
+    assert @client.set('baz', 123)
+    assert @client.gauge('baz', 12.3)
   end
 
   def test_increment_with_default_value

data/test/compatibility/dogstatsd_datagram_compatibility_test.rb

@@ -101,7 +101,7 @@ module Compatibility
       assert_equal_datagrams { |client| client.event('foo', "bar\nbaz") }
       assert_equal_datagrams { |client| client.event('foo', "bar\nbaz", no_prefix: true) }
       assert_equal_datagrams do |client|
-        client.event('Something happend', "And it's not good", timestamp: Time.parse('2019-09-09T04:22:17Z'),
+        client.event('Something happened', "And it's not good", timestamp: Time.parse('2019-09-09T04:22:17Z'),
           hostname: 'localhost', tags: ['foo'], alert_type: 'warning', priority: 'low',
           aggregation_key: 'foo', source_type_name: 'logs')
       end

data/test/datagram_builder_test.rb

@@ -18,7 +18,7 @@ class DatagramBuilderTest < Minitest::Test
     assert_equal ['ign#ored'], @datagram_builder.send(:normalize_tags, ['ign#o|re,d'])
     # Note: how this is interpreted by the backend is undefined.
     # We rely on the user to not do stuff like this if they don't want to be surprised.
-    # We do not want to take the performance hit of normaling this.
+    # We do not want to take the performance hit of normalizing this.
     assert_equal ['lol::class:omg::lol'], @datagram_builder.send(:normalize_tags, "lol::class" => "omg::lol")
   end
 

data/test/deprecations_test.rb

@@ -74,7 +74,7 @@ class DeprecationsTest < Minitest::Test
   # rubocop:enable StatsD/MetricValueKeywordArgument
 
   # rubocop:disable StatsD/MetricReturnValue
-  def test__deprecated__statsd_increment_retuns_metric_instance
+  def test__deprecated__statsd_increment_returns_metric_instance
     metric = StatsD.increment('key')
     assert_kind_of StatsD::Instrument::Metric, metric
     assert_equal 'key', metric.name
@@ -122,6 +122,13 @@ class DeprecationsTest < Minitest::Test
   end
   # rubocop:enable StatsD/MetricPrefixArgument
 
+  def test__deprecated__statsd_key_value
+    metric = capture_statsd_call { StatsD.key_value('values.foobar', 42) }
+    assert_equal :kv, metric.type
+    assert_equal 'values.foobar', metric.name
+    assert_equal 42, metric.value
+  end
+
   protected
 
   def capture_statsd_call(&block)

data/test/dogstatsd_datagram_builder_test.rb

@@ -11,20 +11,57 @@ class DogStatsDDatagramBuilderTest < Minitest::Test
     assert_raises(NotImplementedError) { @datagram_builder.kv('foo', 10, nil, nil) }
   end
 
-  def test_service_check
-    assert_equal '_sc|service|0', @datagram_builder._sc('service', :ok)
+  def test_simple_service_check
+    datagram = @datagram_builder._sc('service', :ok)
+    assert_equal '_sc|service|0', datagram
+    parsed_datagram = StatsD::Instrument::DogStatsDDatagramBuilder.datagram_class.new(datagram)
+    assert_equal :_sc, parsed_datagram.type
+    assert_equal 'service', parsed_datagram.name
+    assert_equal 0, parsed_datagram.value
+  end
+
+  def test_complex_service_check
     datagram = @datagram_builder._sc('service', :warning, timestamp: Time.parse('2019-09-30T04:22:12Z'),
       hostname: 'localhost', tags: { foo: 'bar|baz' }, message: 'blah')
     assert_equal "_sc|service|1|h:localhost|d:1569817332|#foo:barbaz|m:blah", datagram
+
+    parsed_datagram = StatsD::Instrument::DogStatsDDatagramBuilder.datagram_class.new(datagram)
+    assert_equal :_sc, parsed_datagram.type
+    assert_equal 'service', parsed_datagram.name
+    assert_equal 1, parsed_datagram.value
+    assert_equal 'localhost', parsed_datagram.hostname
+    assert_equal Time.parse('2019-09-30T04:22:12Z'), parsed_datagram.timestamp
+    assert_equal ["foo:barbaz"], parsed_datagram.tags
+    assert_equal 'blah', parsed_datagram.message
   end
 
-  def test_event
-    assert_equal '_e{5,5}:hello|world', @datagram_builder._e('hello', "world")
+  def test_simple_event
+    datagram = @datagram_builder._e('hello', "world")
+    assert_equal '_e{5,5}:hello|world', datagram
 
+    parsed_datagram = StatsD::Instrument::DogStatsDDatagramBuilder.datagram_class.new(datagram)
+    assert_equal :_e, parsed_datagram.type
+    assert_equal 'hello', parsed_datagram.name
+    assert_equal 'world', parsed_datagram.value
+  end
+
+  def test_complex_event
     datagram = @datagram_builder._e("testing", "with\nnewline", timestamp: Time.parse('2019-09-30T04:22:12Z'),
       hostname: 'localhost', aggregation_key: 'my-key', priority: 'low', source_type_name: 'source',
       alert_type: 'success', tags: { foo: 'bar|baz' })
     assert_equal '_e{7,13}:testing|with\\nnewline|h:localhost|d:1569817332|k:my-key|' \
       'p:low|s:source|t:success|#foo:barbaz', datagram
+
+    parsed_datagram = StatsD::Instrument::DogStatsDDatagramBuilder.datagram_class.new(datagram)
+    assert_equal :_e, parsed_datagram.type
+    assert_equal 'testing', parsed_datagram.name
+    assert_equal "with\nnewline", parsed_datagram.value
+    assert_equal 'localhost', parsed_datagram.hostname
+    assert_equal Time.parse('2019-09-30T04:22:12Z'), parsed_datagram.timestamp
+    assert_equal ["foo:barbaz"], parsed_datagram.tags
+    assert_equal "my-key", parsed_datagram.aggregation_key
+    assert_equal "low", parsed_datagram.priority
+    assert_equal "source", parsed_datagram.source_type_name
+    assert_equal "success", parsed_datagram.alert_type
   end
 end

data/test/environment_test.rb

@@ -67,7 +67,7 @@ class EnvironmentTest < Minitest::Test
     assert_kind_of StatsD::Instrument::LegacyClient, env.client
   end
 
-  def test_client_returns_new_client_if_envcironment_asks_for_it
+  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

@@ -35,7 +35,7 @@ class IntegrationTest < Minitest::Test
     Process.kill('TERM', pid)
     _, exit_status = Process.waitpid2(pid)
 
-    assert_equal 0, exit_status, "The foked process did not exit cleanly"
+    assert_equal 0, exit_status, "The forked process did not exit cleanly"
     assert_equal "exiting:1|c", @server.recvfrom_nonblock(100).first
 
   rescue NotImplementedError

data/test/log_sink_test.rb

@@ -2,7 +2,7 @@
 
 require 'test_helper'
 
-class LogSinktest < Minitest::Test
+class LogSinkTest < Minitest::Test
   def test_log_sink
     logger = Logger.new(log = StringIO.new)
     logger.formatter = proc do |severity, _datetime, _progname, msg|

data/test/null_sink_test.rb

@@ -2,7 +2,7 @@
 
 require 'test_helper'
 
-class NullSinktest < Minitest::Test
+class NullSinkTest < Minitest::Test
   def test_null_sink
     null_sink = StatsD::Instrument::NullSink.new
     null_sink << 'foo:1|c' << 'bar:1|c'

data/test/rubocop/metric_prefix_argument_test.rb

@@ -19,7 +19,7 @@ module Rubocop
 
     def test_ok_for_metaprogramming_method_without_prefix_argument
       assert_no_offenses("statsd_measure(:method, 'metric_name')")
-      assert_no_offenses("statsd_count(:method, 'metric_name', sample_rate: 1, no_pefix: true)")
+      assert_no_offenses("statsd_count(:method, 'metric_name', sample_rate: 1, no_prefix: true)")
       assert_no_offenses("statsd_count_if(:method, 'metric_name', sample_rate: 1) {}")
     end
 

data/test/rubocop/positional_arguments_test.rb

@@ -21,7 +21,7 @@ module Rubocop
       assert_no_offenses("StatsD.gauge('foo', 2, **kwargs)")
     end
 
-    def test_no_offense_for_now_when_using_value_keyword_argumenr
+    def test_no_offense_for_now_when_using_value_keyword_argument
       assert_no_offenses("StatsD.increment 'foo', value: 3")
       assert_no_offenses("StatsD.increment 'foo', value: 3, sample_rate: 0.5")
       assert_no_offenses("StatsD.increment('foo', value: 3, tags: ['foo']) { foo }")
@@ -29,7 +29,7 @@ module Rubocop
 
     def test_offense_when_using_method_or_constant
       assert_offense("StatsD.gauge('foo', 2, SAMPLE_RATE_CONSTANT)")
-      assert_offense("StatsD.gauge('foo', 2, method_ruturning_a_hash)")
+      assert_offense("StatsD.gauge('foo', 2, method_returning_a_hash)")
     end
 
     def test_offense_when_using_local_variable
@@ -46,7 +46,7 @@ module Rubocop
 
     def test_no_autocorrect_when_using_method_or_constant
       assert_no_autocorrect("StatsD.gauge('foo', 2, SAMPLE_RATE_CONSTANT)")
-      assert_no_autocorrect("StatsD.gauge('foo', 2, method_ruturning_a_hash)")
+      assert_no_autocorrect("StatsD.gauge('foo', 2, method_returning_a_hash)")
     end
 
     def test_autocorrect_only_sample_rate

data/test/statsd_instrumentation_test.rb

@@ -443,6 +443,17 @@ class StatsDInstrumentationTest < Minitest::Test
     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

@@ -189,19 +189,12 @@ class StatsDTest < Minitest::Test
     assert_nil return_value
   end
 
-  def test_statsd_key_value
-    metric = capture_statsd_call { StatsD.key_value('values.foobar', 42) }
-    assert_equal :kv, metric.type
-    assert_equal 'values.foobar', metric.name
-    assert_equal 42, metric.value
-  end
-
-  def test_statsd_durarion_returns_time_in_seconds
+  def test_statsd_duration_returns_time_in_seconds
     duration = StatsD::Instrument.duration {}
     assert_kind_of Float, duration
   end
 
-  def test_statsd_durarion_does_not_swallow_exceptions
+  def test_statsd_duration_does_not_swallow_exceptions
     assert_raises(RuntimeError) do
       StatsD::Instrument.duration { raise "Foo" }
     end

data/test/udp_backend_test.rb

@@ -160,6 +160,7 @@ class UDPBackendTest < Minitest::Test
   end
 
   def test_supports_key_value_syntax_on_statsite
+    skip if StatsD::Instrument.strict_mode_enabled?
     @backend.implementation = :statsite
     @backend.expects(:write_packet).with("fooy:42|kv\n")
     StatsD.key_value('fooy', 42)
@@ -173,6 +174,7 @@ class UDPBackendTest < Minitest::Test
 
   # rubocop:disable StatsD/PositionalArguments
   def test_supports_key_value_with_timestamp_on_statsite
+    skip if StatsD::Instrument.strict_mode_enabled?
     @backend.implementation = :statsite
     @backend.expects(:write_packet).with("fooy:42|kv|@123456\n")
     StatsD.key_value('fooy', 42, 123456)
@@ -180,6 +182,7 @@ class UDPBackendTest < Minitest::Test
   # rubocop:enable StatsD/PositionalArguments
 
   def test_warn_when_using_key_value_and_not_on_statsite
+    skip if StatsD::Instrument.strict_mode_enabled?
     @backend.implementation = :other
     @backend.expects(:write_packet).never
     @logger.expects(:warn)

data/test/udp_sink_test.rb

@@ -2,7 +2,7 @@
 
 require 'test_helper'
 
-class UDPSinktest < Minitest::Test
+class UDPSinkTest < Minitest::Test
   def setup
     @receiver = UDPSocket.new
     @receiver.bind('localhost', 0)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-21 00:00:00.000000000 Z
+date: 2019-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -148,6 +148,7 @@ files:
 - lib/statsd/instrument/client.rb
 - lib/statsd/instrument/datagram.rb
 - lib/statsd/instrument/datagram_builder.rb
+- lib/statsd/instrument/dogstatsd_datagram.rb
 - lib/statsd/instrument/dogstatsd_datagram_builder.rb
 - lib/statsd/instrument/environment.rb
 - lib/statsd/instrument/expectation.rb