karafka-testing 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84ae796af17d02ace2ed5130aab0d964ea724bcd5b8379f954b3b93d265afbf2
-  data.tar.gz: 938a1f00fa6b1670d6cf8c6a045426c17ad9964398e6f3e16785ee927f21be93
+  metadata.gz: 073f7b386365e017596e6ad5d8c1f5753d72dab2eaf90c46504a4676f2690066
+  data.tar.gz: c64a949126353354af0218ed81fc2ee0229fea1edbc3dacf08d129f495053929
 SHA512:
-  metadata.gz: 7229353c31414e28d97b0d498ec0a92d628432d8544b3a34811d518681607573ab2734c75ea936cb25666e1f12dbcce7c6de8fda2e39e2ce7f5f1c394759ec2a
-  data.tar.gz: 0a5b5db670109114c6fbb77e6da81fde0215dbe2c2b38dc95cc063654cc349d836fde8dd09a18fa76a52a50c0560529c4ddd0971b5e4da1ae37a50845e103c08
+  metadata.gz: eedf2b5d5ac5c5507f0e5ddf7c3a1f24efb729966c7de9e5f1ecc785f27a08a8fa16d38b8cd12aa5446ed3e5f94d2a3db3e71b675ce1ca250cad7b28635937b3
+  data.tar.gz: 709de9d3f9f6d4351c5abd33c4c0a1888d680fb8159ca07f643bfe4153860e6ed290272cd7545a697b7eeaef4b754f446c945f40cef872413831aefa444c33ec

data/.github/workflows/ci.yml

@@ -16,6 +16,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
+          - '3.3.0-preview2'
           - '3.2'
           - '3.1'
           - '3.0'
@@ -24,7 +25,7 @@ jobs:
           - ruby: '3.2'
             coverage: 'true'
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install package dependencies
         run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
       - name: Set up Ruby
@@ -43,7 +44,7 @@ jobs:
     strategy:
       fail-fast: false
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Set up Ruby
@@ -62,7 +63,7 @@ jobs:
     strategy:
       fail-fast: false
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Run Coditsu

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 # Karafka Test gem changelog
 
-## 2.2.0 (2023-09-91)
+## 2.2.1 (2023-10-26)
+- [Enhancement] Support patterns in `#consumer_for` consumer builder.
+
+## 2.2.0 (2023-09-01)
 - [Maintenance] Ensure that `2.2.0` works with consumers for patterns.
 - [Maintenance] Replace signing key with a new one (old expired).
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    karafka-testing (2.2.0)
+    karafka-testing (2.2.1)
       karafka (>= 2.2.0, < 3.0.0)
       waterdrop (>= 2.6.6)
 

data/karafka-testing.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.metadata = {
     'funding_uri' => 'https://karafka.io/#become-pro',
     'homepage_uri' => 'https://karafka.io',
-    'changelog_uri' => 'https://github.com/karafka/karafka-testing/blob/master/CHANGELOG.md',
+    'changelog_uri' => 'https://karafka.io/docs/Changelog-Karafka-Testing',
     'bug_tracker_uri' => 'https://github.com/karafka/karafka-testing/issues',
     'source_code_uri' => 'https://github.com/karafka/karafka-testing',
     'documentation_uri' => 'https://karafka.io/docs',

data/lib/karafka/testing/errors.rb

@@ -13,6 +13,9 @@ module Karafka
 
       # Raised when topic is in many consumer groups and not limited by consumer group expectation
       TopicInManyConsumerGroupsError = Class.new(BaseError)
+
+      # Raised when you requested a topic from a consumer group that does not exist
+      ConsumerGroupNotFound = Class.new(BaseError)
     end
   end
 end

data/lib/karafka/testing/rspec/helpers.rb

@@ -57,17 +57,10 @@ module Karafka
         #     subject(:consumer) { karafka.consumer_for(:my_requested_topic) }
         #   end
         def _karafka_consumer_for(requested_topic, requested_consumer_group = nil)
-          all_topics = ::Karafka::App.consumer_groups.map(&:topics).flat_map(&:to_a)
-
-          # First select topics that match what we are looking for
-          selected_topics = all_topics.select do |topic|
-            topic.name == requested_topic.to_s
-          end
-
-          # And then narrow it down based on the consumer group criteria (if present)
-          selected_topics.delete_if do |topic|
-            requested_consumer_group && topic.consumer_group.name != requested_consumer_group.to_s
-          end
+          selected_topics = _karafka_consumer_find_candidate_topics(
+            requested_topic.to_s,
+            requested_consumer_group.to_s
+          )
 
           raise Errors::TopicInManyConsumerGroupsError, requested_topic if selected_topics.size > 1
           raise Errors::TopicNotFoundError, requested_topic if selected_topics.empty?
@@ -183,6 +176,47 @@ module Karafka
           consumer.instance_variable_set('@used', true)
           consumer
         end
+
+        # Finds all the routing topics matching requested topic within all topics or within
+        # provided consumer group based on name
+        #
+        # @param requested_topic [String] requested topic name
+        # @param requested_consumer_group [String] requested consumer group or nil to look in all
+        # @return [Array<Karafka::Routing::Topic>] all matching topics
+        #
+        # @note Since we run the lookup on subscription groups, the search will automatically
+        #   expand with matching patterns
+        def _karafka_consumer_find_candidate_topics(requested_topic, requested_consumer_group)
+          _karafka_consumer_find_subscription_groups(requested_consumer_group)
+            .map(&:topics)
+            .filter_map do |topics|
+              topics.find(requested_topic.to_s)
+            rescue Karafka::Errors::TopicNotFoundError
+              nil
+            end
+        end
+
+        # Finds subscription groups from the requested consumer group or selects all if no
+        # consumer group specified
+        # @param requested_consumer_group [String] requested consumer group or nil to look in all
+        # @return [Array<Karafka::Routing::SubscriptionGroup>] requested subscription groups
+        def _karafka_consumer_find_subscription_groups(requested_consumer_group)
+          if requested_consumer_group && !requested_consumer_group.empty?
+            ::Karafka::App
+              .subscription_groups
+              # Find matching consumer group
+              .find { |cg, _sgs| cg.name == requested_consumer_group.to_s }
+              # Raise error if not found
+              .tap { |cg| cg || raise(Errors::ConsumerGroupNotFound, requested_consumer_group) }
+              # Since lookup was on a hash, get the value, that is subscription groups
+              .last
+          else
+            ::Karafka::App
+              .subscription_groups
+              .values
+              .flatten
+          end
+        end
       end
     end
   end

data/lib/karafka/testing/version.rb

@@ -4,6 +4,6 @@
 module Karafka
   module Testing
     # Current version of gem. It should match Karafka framework version
-    VERSION = '2.2.0'
+    VERSION = '2.2.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-testing
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   AnG1dJU+yL2BK7vaVytLTstJME5mepSZ46qqIJXMuWob/YPDmVaBF39TDSG9e34s
   msG3BiCqgOgHAnL23+CN3Rt8MsuRfEtoTKpJVcCfoEoNHOkc
   -----END CERTIFICATE-----
-date: 2023-09-01 00:00:00.000000000 Z
+date: 2023-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka
@@ -109,7 +109,7 @@ licenses:
 metadata:
   funding_uri: https://karafka.io/#become-pro
   homepage_uri: https://karafka.io
-  changelog_uri: https://github.com/karafka/karafka-testing/blob/master/CHANGELOG.md
+  changelog_uri: https://karafka.io/docs/Changelog-Karafka-Testing
   bug_tracker_uri: https://github.com/karafka/karafka-testing/issues
   source_code_uri: https://github.com/karafka/karafka-testing
   documentation_uri: https://karafka.io/docs