manageiq-messaging 1.1.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 191fa67428995db65820476da103a6e5aec0d9dd9c39197f4f66acea13503d2e
-  data.tar.gz: 07fd94d6722e61ea6518d52fd2352b6f2e7b432313af30a30715805af4800a1e
+  metadata.gz: b0f15797e5132dab8e6e37ca495eb1c0018b665c853c9e042f472d7b6ff1fa8a
+  data.tar.gz: 26c517dac36367c0c1e707618f02c1ccc0622a0f4ba2cea585d84e9020fa1c00
 SHA512:
-  metadata.gz: d3be8c5b3346bed57d236b2e5ce56524fc0f5777e650c2dbe5efe428832b29e028e27037d484c47dddb0598b15c6b1aedaae7bff02841ca51880eb03a4dd8346
-  data.tar.gz: 6520395f34a358aff5aa447345ad8f9ea335fdf961bb9a929cebaa25c0daa9e97e1a8e23dabaea056929ae8543beac62de59de0cb63104ad2831284009f86ddd
+  metadata.gz: 777d39d0123ffd98a5bdb5d7b1e82f7642089f12489ee56ccbe4463a01b8d5371c26b62663815ff3e8bcfdf213f08917bb3fd04154f137ff45039b425c441b60
+  data.tar.gz: 8e9002b7f3f4f60240baa7eb7ed1cfb3b8e1da6bc18830ff3d7edc98c0cd9f7bed2f24c3d6a514ecc067c0b78d637f5765897dc121c92f9cfa00aeb09b3dc984

data/CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [1.3.0] - 03-Apr-2023
+* Add Kafka SSL keystore options to client [#77](https://github.com/ManageIQ/manageiq-messaging/pull/77)
+
+## [1.2.0] - 19-Oct-2022
+
+* Add ssl and ca_file options to `Client.open` [#76](https://github.com/ManageIQ/manageiq-messaging/pull/76)
+* Add wait_for_topic option to Kafka [#75](https://github.com/ManageIQ/manageiq-messaging/pull/75)
+
 ## [1.1.2] - 6-Oct-2022
 
 * Fix kafka publish_topic on ruby3 [#74](https://github.com/ManageIQ/manageiq-messaging/pull/74)
@@ -68,7 +76,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 * Initial release
 
-[Unreleased]: https://github.com/ManageIQ/manageiq-messaging/compare/v1.1.1...HEAD
+[Unreleased]: https://github.com/ManageIQ/manageiq-messaging/compare/v1.3.0...HEAD
+[1.3.0]: https://github.com/ManageIQ/manageiq-messaging/compare/v1.2.0...v1.3.0
+[1.2.0]: https://github.com/ManageIQ/manageiq-messaging/compare/v1.1.2...v1.2.0
+[1.1.2]: https://github.com/ManageIQ/manageiq-messaging/compare/v1.1.1...v1.1.2
 [1.1.1]: https://github.com/ManageIQ/manageiq-messaging/compare/v1.1.0...v1.1.1
 [1.1.0]: https://github.com/ManageIQ/manageiq-messaging/compare/v1.0.3...v1.1.0
 [1.0.3]: https://github.com/ManageIQ/manageiq-messaging/compare/v1.0.2...v1.0.3

data/lib/manageiq/messaging/client.rb

@@ -33,6 +33,12 @@ module ManageIQ
       # Open or create a connection to the message broker.
       # Expected +options+ keys are:
       # * :protocol (Implemented: 'Stomp', 'Kafka'. Default 'Stomp')
+      # * :host (hostname or IP address of the messaging broker)
+      # * :port (host port number)
+      # * :username (optional)
+      # * :password (optional)
+      # * :ssl (true/false)
+      # * :ca_file (optional. path to a certificate authority cert)
       # * :encoding ('yaml' or 'json'. Default 'yaml')
       # Other connection options are underlying messaging system specific.
       #

data/lib/manageiq/messaging/kafka/client.rb

@@ -8,13 +8,11 @@ module ManageIQ
       # Kafka specific connection options accepted by +open+ method:
       # * :client_ref (A reference string to identify the client)
       # * :hosts (Array of Kafka cluster hosts, or)
-      # * :host (Single host name)
-      # * :port (host port number)
       #
-      # For additional security options, please refer to 
+      # For additional security options, please refer to
       # https://github.com/edenhill/librdkafka/wiki/Using-SSL-with-librdkafka and
-      # https://github.com/edenhill/librdkafka/wiki/Using-SASL-with-librdkafka 
-      # 
+      # https://github.com/edenhill/librdkafka/wiki/Using-SASL-with-librdkafka
+      #
       #
       # Kafka specific +publish_message+ options:
       # * :group_name (Used as Kafka partition_key)
@@ -89,10 +87,16 @@ module ManageIQ
 
           result = {:"bootstrap.servers" => hosts.join(',')}
           result[:"client.id"] = options[:client_ref] if options[:client_ref]
-          result[:"sasl.username"] = options[:username] if options[:username]
-          result[:"sasl.password"] = options[:password] if options[:password]
 
-          result.merge(options.except(:port, :host, :hosts, :encoding, :protocol, :client_ref, :username, :password))
+          result[:"sasl.mechanism"]    = "PLAIN"
+          result[:"sasl.username"]     = options[:username] if options[:username]
+          result[:"sasl.password"]     = options[:password] if options[:password]
+          result[:"security.protocol"] = !!options[:ssl] ? "SASL_SSL" : "PLAINTEXT"
+          result[:"ssl.ca.location"]   = options[:ca_file] if options[:ca_file]
+          result[:"ssl.keystore.location"] = options[:keystore_location] if options[:keystore_location]
+          result[:"ssl.keystore.password"] = options[:keystore_password] if options[:keystore_password]
+
+          result.merge(options.except(:port, :host, :hosts, :encoding, :protocol, :client_ref, :username, :password, :ssl, :ca_file, :keystore_location, :keystore_password))
         end
       end
     end

data/lib/manageiq/messaging/kafka/common.rb

@@ -94,6 +94,22 @@ module ManageIQ
           end
         end
 
+        def wait_for_topic(wait = true)
+          retry_count     = 0
+          maximum_backoff = 300
+
+          begin
+            yield
+          rescue Rdkafka::RdkafkaError => err
+            raise if err.code != :unknown_topic_or_part || !wait
+
+            retry_count += 1
+            sleep([1.5 * retry_count, maximum_backoff].min)
+
+            retry
+          end
+        end
+
         def message_header_keys
           [:sender, :message_type, :class_name]
         end

data/lib/manageiq/messaging/kafka/queue.rb

@@ -17,13 +17,18 @@ module ManageIQ
         end
 
         def subscribe_messages_impl(options, &block)
+          wait = options.delete(:wait_for_topic)
+          wait = true if wait.nil?
+
           topic = address(options)
           options[:persist_ref] = GROUP_FOR_QUEUE_MESSAGES + topic
 
-          queue_consumer = consumer(true, options)
-          queue_consumer.subscribe(topic)
-          queue_consumer.each do |message|
-            process_queue_message(queue_consumer, topic, message, &block)
+          wait_for_topic(wait) do
+            queue_consumer = consumer(true, options)
+            queue_consumer.subscribe(topic)
+            queue_consumer.each do |message|
+              process_queue_message(queue_consumer, topic, message, &block)
+            end
           end
         end
       end

data/lib/manageiq/messaging/kafka/topic.rb

@@ -14,13 +14,19 @@ module ManageIQ
         end
 
         def subscribe_topic_impl(options, &block)
+          wait = options.delete(:wait_for_topic)
+          wait = true if wait.nil?
+
           topic = address(options)
 
           options[:persist_ref] = "#{GROUP_FOR_ADHOC_LISTENERS}_#{Time.now.to_i}" unless options[:persist_ref]
-          topic_consumer = consumer(false, options)
-          topic_consumer.subscribe(topic)
-          topic_consumer.each do |message|
-            process_topic_message(topic_consumer, topic, message, &block)
+
+          wait_for_topic(wait) do
+            topic_consumer = consumer(false, options)
+            topic_consumer.subscribe(topic)
+            topic_consumer.each do |message|
+              process_topic_message(topic_consumer, topic, message, &block)
+            end
           end
         end
       end

data/lib/manageiq/messaging/stomp/client.rb

@@ -61,7 +61,7 @@ module ManageIQ
         attr_reader :stomp_client
 
         def initialize(options)
-          host = options.slice(:host, :port)
+          host = options.slice(:host, :port, :ssl)
           host[:passcode] = options[:password] if options[:password]
           host[:login] = options[:username] if options[:username]
 

data/lib/manageiq/messaging/version.rb

@@ -1,5 +1,5 @@
 module ManageIQ
   module Messaging
-    VERSION = "1.1.2"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-messaging
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.3.0
 platform: ruby
 authors:
 - ManageIQ Authors
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-06 00:00:00.000000000 Z
+date: 2023-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport