cli-proton-ruby 1.0.0

data/lib/handlers/sender_handler.rb

@@ -0,0 +1,269 @@
+#--
+# Copyright 2017 Red Hat Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+require_relative '../utils/duration'
+require_relative 'sr_common_handler'
+
+module Handlers
+
+  # Sender events handler for sender client
+  class SenderHandler < Handlers::SRCommonHandler
+
+    # Count of messages to be send
+    attr_accessor :count
+    # Message properties
+    attr_accessor :msg_properties
+    # Message content
+    attr_accessor :msg_content
+    # Message content type
+    attr_accessor :msg_content_type
+    # Message durability
+    attr_accessor :msg_durable
+    # Message TTL (ms)
+    attr_accessor :msg_ttl
+    # Message correlation ID
+    attr_accessor :msg_correlation_id
+    # Reply to address
+    attr_accessor :msg_reply_to
+    # Message group ID
+    attr_accessor :msg_group_id
+    # Message destination
+    attr_accessor :msg_to
+    # Message priority
+    attr_accessor :msg_priority
+    # Message ID
+    attr_accessor :msg_id
+    # Message user ID
+    attr_accessor :msg_user_id
+    # Message subject
+    attr_accessor :msg_subject
+    # Anonymous
+    attr_accessor :anonymous
+
+    # Initialization of sender events handler
+    # ==== Sender events handler arguments
+    # broker:: URI of broker
+    # log_msgs:: format of message(s) log
+    # count:: number of messages to send
+    # msg_content:: message content
+    # msg_durable:: message durability
+    # msg_ttl:: message TTL (ms)
+    # msg_correlation_id:: message correlation ID
+    # msg_reply_to:: address to send reply to
+    # msg_group_id:: message group ID
+    # msg_to:: message destination
+    # sasl_mechs:: allowed SASL mechanisms
+    def initialize(
+      broker,
+      log_msgs,
+      msg_content_hashed,
+      count,
+      msg_properties,
+      msg_content,
+      msg_content_type,
+      msg_durable,
+      msg_ttl,
+      msg_correlation_id,
+      msg_reply_to,
+      msg_group_id,
+      msg_to,
+      msg_priority,
+      msg_id,
+      msg_user_id,
+      msg_subject,
+      anonymous,
+      sasl_mechs,
+      idle_timeout,
+      max_frame_size,
+      sasl_enabled,
+      log_lib,
+      auto_settle_off,
+      exit_timer,
+      duration,
+      duration_mode
+    )
+      super(
+        broker,
+        log_msgs,
+        msg_content_hashed,
+        sasl_mechs,
+        idle_timeout,
+        max_frame_size,
+        sasl_enabled,
+        log_lib,
+        auto_settle_off,
+        exit_timer
+      )
+      # Save count of messages to be send
+      @count = count
+      # Save message properties
+      @msg_properties = msg_properties
+      # Save message content
+      @msg_content = msg_content
+      # Save message content type
+      @msg_content_type = msg_content_type
+      # Save message durability
+      @msg_durable = msg_durable
+      # Save message TTL (ms)
+      @msg_ttl = msg_ttl
+      # Save message correlation ID
+      @msg_correlation_id = msg_correlation_id
+      # Save reply to address
+      @msg_reply_to = msg_reply_to
+      # Save message group ID
+      @msg_group_id = msg_group_id
+      # Save message destination
+      @msg_to = msg_to
+      # Save message priority
+      @msg_priority = msg_priority
+      # Save message ID
+      @msg_id = msg_id
+      # Save user ID
+      @msg_user_id = msg_user_id
+      # Save message subject
+      @msg_subject = msg_subject
+      # Save anonymous
+      @anonymous = anonymous
+      # Number of sent messages
+      @sent = 0
+      # Number of accepted messages
+      @accepted = 0
+      # Duration
+      @duration = Duration.new(duration, count, duration_mode)
+      # True if a send has been scheduled
+      @scheduled = false
+    end
+
+    # Called when the event loop starts,
+    # connects sender client to SRCommonHandler#broker
+    # and creates sender
+    def on_container_start(container)
+      # Connecting to broker and creating sender
+      container.connect(
+        # Set broker URI
+        @broker,
+        # Enable SASL authentication
+        sasl_enabled: @sasl_enabled,
+        # Enable insecure SASL mechanisms
+        sasl_allow_insecure_mechs: true,
+        # Set allowed SASL mechanisms
+        sasl_allowed_mechs: @sasl_mechs,
+        # Set idle timeout
+        idle_timeout: @idle_timeout,
+        # Set max frame size
+        max_frame_size: @max_frame_size,
+      ).open_sender({
+          # Set target address
+          :target => anonymous ? nil : @broker.amqp_address,
+          # Set auto settle
+          :auto_settle => @auto_settle_off ? false : true,
+        })
+    end
+
+    def delay
+      before = @duration.delay("before-send")
+      after = @duration.delay("after-send") if @sent > 0 # No after-delay on first send
+      [before, after].compact.inject(:+)
+    end
+
+    # Called when the sender link has credit
+    # and messages can therefore be transferred,
+    # sending SenderHandler#count messages
+    def on_sendable(sender)
+      if @duration.zero?        # Send immediately
+        send(sender) while (sender.credit > 0) && (@sent < @count)
+      elsif (sender.credit > 0) && (@sent < @count) && !@scheduled # Schedule to send after delay
+        @scheduled = true
+        c = sender.connection.container
+        c.schedule(delay) do
+          send(sender)
+          @scheduled = false    # Need to re-schedule for another send
+        end
+      end
+    end
+
+    def send(sender)
+      exit_timer.reset if exit_timer
+      # Create new message
+      msg = Qpid::Proton::Message.new
+      # Set message destination
+       msg.address = @msg_to
+      # If message destination is not set
+      unless msg.address
+        # Set message destination if anonymous mode
+      	msg.address = @broker.amqp_address if @anonymous
+      end
+      # Set message properties
+      if @msg_properties
+        @msg_properties.each { |k, v| msg[k] = v }
+      end
+      # If message content is set
+      if @msg_content
+        # If message content is string and contains formatting part
+        if @msg_content.is_a? String and @msg_content =~ /%[0-9]*d/
+          # Format message content with number of sent messages
+          msg.body = sprintf(@msg_content, @sent)
+        else
+          # Set message content as it is
+          msg.body = @msg_content
+        end
+      end # if
+      # Set message content type if specified
+      msg.content_type = @msg_content_type if @msg_content_type
+      # Set message durability
+      msg.durable = @msg_durable
+      # Set message TTL (ms)
+      msg.ttl = @msg_ttl
+      # If message correlation ID is set
+      if @msg_correlation_id
+        msg.correlation_id = @msg_correlation_id
+      end # if
+      # Set reply to address
+      msg.reply_to = @msg_reply_to
+      # If message group ID is set
+      if @msg_group_id
+        msg.group_id = @msg_group_id
+      end
+      msg.priority = @msg_priority if @msg_priority
+      msg.id = @msg_id if @msg_id
+      msg.user_id = @msg_user_id if @msg_user_id
+      msg.subject = @msg_subject if @msg_subject
+      # Send message
+      sender.send(msg)
+      # Increase number of sent messages
+      @sent = @sent + 1
+      print_message(msg)
+    end
+
+    # Called when the remote peer accepts an outgoing message,
+    # accepting SenderHandler#count messages
+    def on_tracker_accept(tracker)
+      # Increase number of accepted messages
+      @accepted = @accepted + 1
+      # If all messages to be send are sent and accepted
+      if @accepted == @count
+        # Close sender
+        tracker.sender.close
+        # Close connection
+        tracker.sender.connection.close
+      end # if
+    end
+
+  end # class SenderHandler
+
+end # module Handlers
+
+# eof

data/lib/handlers/sr_common_handler.rb

@@ -0,0 +1,100 @@
+#--
+# Copyright 2017 Red Hat Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+require_relative 'basic_handler'
+
+require_relative '../formatters/basic_formatter'
+require_relative '../formatters/dict_formatter'
+require_relative '../formatters/interop_formatter'
+
+module Handlers
+
+  # Common events handler for sender and receiver client
+  class SRCommonHandler < Handlers::BasicHandler
+
+    # Format of log
+    attr_accessor :log_msgs
+    # Content hashed
+    attr_accessor :msg_content_hashed
+    # Idle timeout
+    attr_accessor :idle_timeout
+    # Max frame size
+    attr_accessor :max_frame_size
+    # SASL enabled
+    attr_accessor :sasl_enabled
+    # Client library logging
+    attr_accessor :log_lib
+    # Auto settle off
+    attr_accessor :auto_settle_off
+
+    # Initialization of common events handler for sender and receiver client
+    # ==== Common events handler arguments
+    # broker:: URI of broker
+    # log_msgs:: format of message(s) log
+    # sasl_mechs:: allowed SASL mechanisms
+    def initialize(
+      broker,
+      log_msgs,
+      msg_content_hashed,
+      sasl_mechs,
+      idle_timeout,
+      max_frame_size,
+      sasl_enabled,
+      log_lib,
+      auto_settle_off,
+      exit_timer
+    )
+      super(
+        broker,
+        sasl_mechs,
+        idle_timeout,
+        max_frame_size,
+        sasl_enabled,
+        log_lib,
+        exit_timer
+      )
+      # Save message(s) log format
+      @log_msgs = log_msgs
+      # Save message(s) content hashed
+      @msg_content_hashed = msg_content_hashed
+      # Save auto settle off
+      @auto_settle_off = auto_settle_off
+    end
+
+    # Print of sent/received message
+    # ==== Arguments
+    # msg:: message to print
+    def print_message(msg)
+      case @log_msgs
+      when "body"
+        Formatters::BasicFormatter.new(msg, @msg_content_hashed).print
+      when "dict"
+        Formatters::DictFormatter.new(msg, @msg_content_hashed).print
+      when "interop"
+        Formatters::InteropFormatter.new(msg, @msg_content_hashed).print
+      end
+    end
+
+    # Default for un-handled errors is to raise an exception
+    def on_error(condition)
+      raise condition
+    end
+
+  end # class SRCommonHandler
+
+end # module Handlers
+
+# eof

data/lib/options.rb

@@ -0,0 +1,38 @@
+#--
+# Copyright 2017 Red Hat Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+require 'options/basic_option_parser'
+require 'options/connector_option_parser'
+require 'options/sr_common_option_parser'
+require 'options/sender_option_parser'
+require 'options/receiver_option_parser'
+
+# Module containing option parsers for cli-proton-ruby clients
+# ==== Option parsers
+# * Options::BasicOptionParser of basic options for all clients
+# * Options::ConnectorOptionParser of basic and specific options for connector
+#   client
+# * Options::SRCommonOptionParser of basic and common options for sender and
+#   receiver client
+# * Options::SenderOptionParser of basic, common and specific options
+#   for sender client
+# * Options::ReceiverOptionParser of basic, common and specific options
+#   for receiver client
+module Options
+
+end # module Options
+
+# eof

data/lib/options/basic_option_parser.rb

@@ -0,0 +1,169 @@
+#--
+# Copyright 2017 Red Hat Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+require 'optparse'
+require 'ostruct'
+
+require_relative '../defaults'
+require_relative '../utils/exit_timer'
+
+module Options
+
+  BOOLEAN_STRINGS = %w(true True yes false False no)
+  LOG_LIB_STRINGS = %w(NONE TRANSPORT_RAW TRANSPORT_FRM TRANSPORT_DRV)
+
+  # Option parser of basic options for all clients
+  # ==== Basic client options
+  # broker:: URI of broker in format IP:PORT (default: DEFAULT_BROKER,
+  #          see Defaults)
+  # conn-allowed-mechs:: allowed SASL mechanisms for authentication
+  # help:: show help message and exit
+  class BasicOptionParser
+
+    # Client options
+    attr_accessor :options
+
+    # Initialization of basic client options
+    def initialize()
+      @options = OpenStruct.new
+      # Basic client's options with default values
+
+      # Broker in format IP:PORT option
+      @options.broker = Defaults::DEFAULT_BROKER
+      # Exit timer
+      @options.exit_timer = Defaults::DEFAULT_EXIT_TIMER
+      # Allowed SASL mechanisms
+      @options.sasl_mechs = Defaults::DEFAULT_SASL_MECHS
+      # Idle timeout
+      @options.idle_timeout = Defaults::DEFAULT_IDLE_TIMEOUT
+      # Max frame size
+      @options.max_frame_size = Defaults::DEFAULT_MAX_FRAME_SIZE
+      # SASL enabled
+      @options.sasl_enabled = Defaults::DEFAULT_SASL_ENABLED
+      # Client library logging
+      @options.log_lib = Defaults::DEFAULT_LOG_LIB
+
+      @opt_parser = OptionParser.new
+      # Basic usage
+      @opt_parser.banner = "Usage: <basic_program> [OPTIONS]"
+
+      @opt_parser.separator ""
+      # Broker
+      @opt_parser.on(
+        "-b",
+        "--broker BROKER",
+        String,
+        "URI of broker in format IP:PORT "+
+        "(default: #{Defaults::DEFAULT_BROKER})"
+      ) do |broker|
+        @options.broker = broker
+      end
+
+      # Client exits after this timeout.
+      # Handlers can restart the timer
+      # (e.g. on receiving messages, making connections etc.)
+      @opt_parser.on(
+        "-t",
+        "--timeout TIMEOUT",
+        Float,
+        "timeout in seconds to wait before exiting, 0 unlimited (default: 0)"
+      ) do |timeout|
+        @options.exit_timer = ExitTimer.new(timeout) if timeout > 0
+      end
+
+      # Allowed SASL mechanisms
+      @opt_parser.on(
+        "--conn-allowed-mechs MECHS",
+        String,
+        "space separated list of SASL mechanisms allowed by client "+
+        "for authentication (ANONYMOUS/PLAIN/EXTERNAL, default: "+
+        "'#{Defaults::DEFAULT_SASL_MECHS}')"
+      ) do |sasl_mechs|
+        @options.sasl_mechs = sasl_mechs
+      end
+
+      # Max frame size
+      @opt_parser.on(
+        "--conn-max-frame-size SIZE",
+        Integer,
+        "define custom maximum frame size in bytes " +
+        "(range: #{Defaults::DEFAULT_MIN_MAX_FRAME_SIZE}-" +
+        "#{Defaults::DEFAULT_MAX_MAX_FRAME_SIZE}, " +
+        "default: #{Defaults::DEFAULT_MAX_FRAME_SIZE})",
+      ) do |max_frame_size|
+        if max_frame_size < Defaults::DEFAULT_MIN_MAX_FRAME_SIZE \
+          or max_frame_size > Defaults::DEFAULT_MAX_MAX_FRAME_SIZE
+          raise OptionParser::InvalidArgument, "#{max_frame_size} " +
+            "(out of range: #{Defaults::DEFAULT_MIN_MAX_FRAME_SIZE}-" +
+            "#{Defaults::DEFAULT_MAX_MAX_FRAME_SIZE})"
+        end
+        @options.max_frame_size = max_frame_size
+      end
+
+      # Heartbeats configuration
+      @opt_parser.on(
+        "--conn-heartbeat HEARTBEAT",
+        Integer,
+        "enable and set connection heartbeat, " +
+        "default: #{Defaults::DEFAULT_IDLE_TIMEOUT})"
+      ) do |idle_timeout|
+        @options.idle_timeout = idle_timeout
+      end
+
+      # Connection SASL enabled
+      @opt_parser.on(
+        "--conn-sasl-enabled [ENABLED]",
+        Options::BOOLEAN_STRINGS,
+        "enable connection SASL (#{Options::BOOLEAN_STRINGS.join("/")}, "+
+        "default: #{Defaults::DEFAULT_SASL_ENABLED})"
+      ) do |sasl_enabled|
+        @options.sasl_enabled = true
+        @options.sasl_enabled = StringUtils.str_to_bool(sasl_enabled) if sasl_enabled
+      end
+
+      # Client library logging
+      @opt_parser.on(
+        "--log-lib LEVEL",
+        LOG_LIB_STRINGS,
+        "enable client library logging (#{LOG_LIB_STRINGS.join("/")}, " +
+        "default: #{Defaults::DEFAULT_LOG_LIB})"
+      ) do |log_lib|
+        @options.log_lib = log_lib
+      end
+
+      # Help
+      @opt_parser.on_tail(
+        "-h",
+        "--help",
+        "show help message and exit"
+      ) do
+        puts @opt_parser
+        exit
+      end
+    end
+
+    # Parsing of basic options for all clients
+    # ==== Parameters
+    # args:: arguments to parse
+    def parse(args)
+      @opt_parser.parse(args)
+    end
+
+  end # class BasicOptionParser
+
+end # module Options
+
+# eof