statsd-instrument 3.5.5 → 3.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b4caa06189952666d3dd979521ec76bcf4bbf4265605c2d9d30198773f74ab8
-  data.tar.gz: ec65748283c1a32434f6388e24b167133ba53ec36353c4ec5f8ccfe920657b58
+  metadata.gz: ebf148c48529e19f207e601d9f31158c7d1fda2d6dc0f368192163b4d01c2f9c
+  data.tar.gz: b66c620179390cf51365d4d9f23ffba1cdf02b8036d35a3bc161d7394148b9f0
 SHA512:
-  metadata.gz: af4a6f52973f439a4d9246fff0d68c74751173998b1a76c9fdbff87ac001f2718ccc8fe2c5abb6d5bdaa5555f9c82150f196c8fe6f819e913a6828ef269a2e14
-  data.tar.gz: 79f76342bc46cf2d07fd96f1d72bbe5bc2367251ff93b05b6c4ed938fe96d85bf44c8178ca4f1f4a7186f10921bfbaea456b2ce2d32e64db806ec526b2894d71
+  metadata.gz: 25633d9db00b7187fe226ec98b2d4d1944a550af5de739b0a99f87152322f6d0fe764cf0b491308a6bf7165038ae122f9cd13f352f2a0eee17ded614886fa959
+  data.tar.gz: 187a4bce514fc40da281fab5ddf6d620a788151663410da44444985e9172ca56764679cdab51323ad4a130ecedb1ebbee5c896caf7604a89e2f64bafe6aa7b57

data/CHANGELOG.md

@@ -6,6 +6,11 @@ section below.
 
 ## Unreleased changes
 
+## Version 3.5.6
+
+- Fix issue from 3.5.5 where tests using RSpec matcher for tag assertion would fail, because the matcher as being
+  use as an array.
+
 ## Version 3.5.5
 
 - Fix issue on 3.5.4, allowing user to specify compound matcher without tags

data/lib/statsd/instrument/assertions.rb

@@ -49,19 +49,41 @@ module StatsD
       # @param [Array<String>] metric_names (default: []) The metric names that are not
       #   allowed to happen inside the block. If this is set to `[]`, the assertion
       #   will fail if any metric occurs.
+      # @param [Array<StatsD::Instrument::Datagram>] datagrams (default: nil) The datagrams
+      #   to be inspected for metric emission.
+      # @param [StatsD::Instrument::Client] client (default: nil) The client to be used
+      #   for fetching datagrams (if not provided) and metric prefix. If not provided, the
+      #   singleton client will attempt to be used.
+      # @param [Boolean] no_prefix (default: false) A directive to indicate if the client's
+      #   prefix should be prepended to the metric names.
       # @yield A block in which the specified metric should not occur. This block
       #   should not raise any exceptions.
       # @return [void]
       # @raise [Minitest::Assertion] If an exception occurs, or if any metric (with the
       #   provided names, or any), occurred during the execution of the provided block.
-      def assert_no_statsd_calls(*metric_names, datagrams: nil, client: nil, &block)
+      def assert_no_statsd_calls(*metric_names, datagrams: nil, client: nil, no_prefix: false, &block)
+        client ||= StatsD.singleton_client
+
         if datagrams.nil?
           raise LocalJumpError, "assert_no_statsd_calls requires a block" unless block_given?
 
           datagrams = capture_statsd_datagrams_with_exception_handling(client: client, &block)
         end
 
-        datagrams.select! { |metric| metric_names.include?(metric.name) } unless metric_names.empty?
+        formatted_metrics = if no_prefix
+          metric_names
+        else
+          metric_names.map do |metric|
+            if StatsD::Instrument::Helpers.prefixed_metric?(metric, client: client)
+              warn("`#{__method__}` will prefix metrics by default. `#{metric}` skipped due to existing prefix.")
+              metric
+            else
+              StatsD::Instrument::Helpers.prefix_metric(metric, client: client)
+            end
+          end
+        end
+
+        datagrams.select! { |metric| formatted_metrics.include?(metric.name) } unless formatted_metrics.empty?
         assert(datagrams.empty?, "No StatsD calls for metric #{datagrams.map(&:name).join(", ")} expected.")
       end
 

data/lib/statsd/instrument/expectation.rb

@@ -37,9 +37,8 @@ module StatsD
       def initialize(client: nil, type:, name:, value: nil,
         sample_rate: nil, tags: nil, no_prefix: false, times: 1)
 
-        client ||= StatsD.singleton_client
         @type = type
-        @name = no_prefix || !client.prefix ? name : "#{client.prefix}.#{name}"
+        @name = no_prefix ? name : StatsD::Instrument::Helpers.prefix_metric(name, client: client)
         @value = normalized_value_for_type(type, value) if value
         @sample_rate = sample_rate
         @tags = normalize_tags(tags)

data/lib/statsd/instrument/helpers.rb

@@ -26,6 +26,18 @@ module StatsD
 
         tags
       end
+
+      def self.prefix_metric(metric_name, client: nil)
+        client ||= StatsD.singleton_client
+        client&.prefix ? "#{client.prefix}.#{metric_name}" : metric_name
+      end
+
+      def self.prefixed_metric?(metric_name, client: nil)
+        client ||= StatsD.singleton_client
+        return false unless client&.prefix
+
+        metric_name =~ /\A#{Regexp.escape(client.prefix)}\./
+      end
     end
   end
 end

data/lib/statsd/instrument/matchers.rb

@@ -45,8 +45,8 @@ module StatsD
           metrics = capture_statsd_calls(&block)
           metrics = metrics.select do |m|
             metric_tags = m.tags || []
-            options_tags = options[:tags] || []
-            tag_matches = options_tags.empty? || metric_tags.all? { |t| options_tags.include?(t) }
+            options_tags = options[:tags]
+            tag_matches = options_tags.nil? || RSpec::Matchers::BuiltIn::Match.new(options_tags).matches?(metric_tags)
             m.type == metric_type && m.name == metric_name && tag_matches
           end
 

data/lib/statsd/instrument/version.rb

@@ -2,6 +2,6 @@
 
 module StatsD
   module Instrument
-    VERSION = "3.5.5"
+    VERSION = "3.5.6"
   end
 end

data/test/assertions_test.rb

@@ -74,6 +74,66 @@ class AssertionsTest < Minitest::Test
     assert_equal(assertion.message, "No StatsD calls for metric other, another expected.")
   end
 
+  def test_assert_no_statsd_calls_with_prefix
+    client = StatsD::Instrument::Client.new(prefix: "prefix")
+
+    @test_case.assert_no_statsd_calls("counter", client: client) do
+      client.increment("other")
+    end
+
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_no_statsd_calls("counter", client: client) do
+        client.increment("counter")
+      end
+    end
+    assert_equal(assertion.message, "No StatsD calls for metric prefix.counter expected.")
+
+    @test_case.expects(:warn).with(
+      "`assert_no_statsd_calls` will prefix metrics by default. `prefix.counter` skipped due to existing prefix."
+    )
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_no_statsd_calls("prefix.counter", client: client) do
+        client.increment("counter")
+      end
+    end
+    assert_equal(assertion.message, "No StatsD calls for metric prefix.counter expected.")
+
+    @test_case.expects(:warn).never
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_no_statsd_calls("prefix.counter", client: client, no_prefix: true) do
+        client.increment("counter")
+      end
+    end
+    assert_equal(assertion.message, "No StatsD calls for metric prefix.counter expected.")
+
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_no_statsd_calls("counter", client: client, no_prefix: true) do
+        client.increment("counter", no_prefix: true)
+      end
+    end
+    assert_equal(assertion.message, "No StatsD calls for metric counter expected.")
+
+    StatsD.singleton_client = client
+
+    @test_case.assert_no_statsd_calls("counter") do
+      StatsD.increment("other")
+    end
+
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_no_statsd_calls("counter") do
+        StatsD.increment("counter")
+      end
+    end
+    assert_equal(assertion.message, "No StatsD calls for metric prefix.counter expected.")
+
+    assertion = assert_raises(Minitest::Assertion) do
+      @test_case.assert_no_statsd_calls("counter", no_prefix: true) do
+        StatsD.increment("counter", no_prefix: true)
+      end
+    end
+    assert_equal(assertion.message, "No StatsD calls for metric counter expected.")
+  end
+
   def test_assert_statsd
     @test_case.assert_statsd_increment("counter") do
       StatsD.increment("counter")

data/test/helpers_test.rb

@@ -7,6 +7,11 @@ class HelpersTest < Minitest::Test
     test_class = Class.new(Minitest::Test)
     test_class.send(:include, StatsD::Instrument::Helpers)
     @test_case = test_class.new("fake")
+    @old_client = StatsD.singleton_client
+  end
+
+  def teardown
+    StatsD.singleton_client = @old_client
   end
 
   def test_capture_metrics_inside_block_only
@@ -78,4 +83,58 @@ class HelpersTest < Minitest::Test
       StatsD::Instrument::Helpers.add_tag(1, :key, 123)
     end
   end
+
+  def test_prefix_metric_returns_metric_if_no_prefix
+    metric = "metric"
+    client = StatsD::Instrument::Client.new(prefix: nil)
+    assert_equal(metric, StatsD::Instrument::Helpers.prefix_metric(metric, client: client))
+  end
+
+  def test_prefix_metric_returns_prefixed_metric
+    prefix = "prefix"
+    metric = "metric"
+    client = StatsD::Instrument::Client.new(prefix: prefix)
+    assert_equal("#{prefix}.#{metric}", StatsD::Instrument::Helpers.prefix_metric(metric, client: client))
+  end
+
+  def test_prefix_metric_can_use_singleton_client
+    prefix = "prefix"
+    metric = "metric"
+    StatsD.singleton_client = StatsD::Instrument::Client.new(prefix: prefix)
+    assert_equal("#{prefix}.#{metric}", StatsD::Instrument::Helpers.prefix_metric(metric))
+  end
+
+  def test_prefixed_metric_return_true_if_prefix_present
+    prefix = "prefix"
+    metric = "prefix.metric"
+    client = StatsD::Instrument::Client.new(prefix: prefix)
+    assert(StatsD::Instrument::Helpers.prefixed_metric?(metric, client: client))
+  end
+
+  def test_prefixed_meric_returns_false_if_prefix_missing
+    prefix = "prefix"
+    metric = "metric"
+    client = StatsD::Instrument::Client.new(prefix: prefix)
+    refute(StatsD::Instrument::Helpers.prefixed_metric?(metric, client: client))
+  end
+
+  def test_prefixed_metric_returns_false_if_prefix_not_at_beginning
+    prefix = "prefix"
+    metric = "metric.prefix"
+    client = StatsD::Instrument::Client.new(prefix: prefix)
+    refute(StatsD::Instrument::Helpers.prefixed_metric?(metric, client: client))
+  end
+
+  def test_prefixed_metrics_returns_false_if_no_prefix_defined
+    metric = "prefix.metric"
+    client = StatsD::Instrument::Client.new(prefix: nil)
+    refute(StatsD::Instrument::Helpers.prefixed_metric?(metric, client: client))
+  end
+
+  def test_prefixed_metric_can_use_singleton_client
+    prefix = "prefix"
+    metric = "prefix.metric"
+    StatsD.singleton_client = StatsD::Instrument::Client.new(prefix: prefix)
+    assert(StatsD::Instrument::Helpers.prefixed_metric?(metric))
+  end
 end

data/test/matchers_test.rb

@@ -2,6 +2,7 @@
 
 require "test_helper"
 require "statsd/instrument/matchers"
+require "rspec/mocks/argument_matchers"
 
 class MatchersTest < Minitest::Test
   def test_statsd_increment_matched
@@ -114,6 +115,13 @@ class MatchersTest < Minitest::Test
       .matches?(lambda { StatsD.increment("counter", tags: ["a", "b"]) }))
   end
 
+  def test_statsd_increment_with_subset_matcher
+    include_matcher = RSpec::Matchers::BuiltIn::Include.new("foo:bar")
+    final = RSpec::Matchers::AliasedMatcher.new(include_matcher, :include)
+    assert(StatsD::Instrument::Matchers::Increment.new(:c, "counter", tags: final)
+      .matches?(lambda { StatsD.increment("counter", tags: ["foo:bar", "bar:baz"]) }))
+  end
+
   def test_statsd_increment_with_tags_not_matched
     refute(StatsD::Instrument::Matchers::Increment.new(:c, "counter", tags: ["a", "b"])
       .matches?(lambda { StatsD.increment("counter", tags: ["c"]) }))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 3.5.5
+  version: 3.5.6
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-02 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies: []
 description: A StatsD client for Ruby apps. Provides metaprogramming methods to inject
   StatsD instrumentation into your code.