rsmp 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55265e42f3956b7af530055680da60f82c84d34d7febd19286bf7c78bd2048f8
-  data.tar.gz: 445498a67e24c6b63cbfceca009ad736e962717eb89e92239bdd7ad4870cf72f
+  metadata.gz: a57d963e9f3f6f4dccdfbfaf7bc2d4c09fcbae56d1ec886ed699faa373e054ed
+  data.tar.gz: 4035d49f738d335f94d4df8c9dd33a3744d258740e51df55be9da5998ce3e538
 SHA512:
-  metadata.gz: '0854ca1835fc15e8ccd10059c3f6f30638daf54677d215799eabae0f87fa4de11c9f825319f10ba92f9d25052fc90927fb54eb9f5df19cb714ba9ead236effbf'
-  data.tar.gz: 5d60090a4de455ca03fcb0fc182977ff938d0c8df9ea0bfb69d1dc985546c6de6ece83296bb25a64cc5f9e3b67d94e7694ec9702e08877bd6d9e05853d700ebd
+  metadata.gz: 94e7df5ad072745c960726053e0630b8b9efefc87c746a0f96afb53c32c4ff7450a553d3576a9ad9cd430640355e8ff329862cb4fd24da8338780e500f3c0245
+  data.tar.gz: 70b0a93eb41dca5cfabe62cacfb08f675fe2f359886bc4038aa647a95d873553b04056277ee08bac16476c441c7b6f646300179567fe2b33f58aa83121456b37

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.2.2)
+    rsmp (0.2.3)
       async (~> 1.29.1)
       async-io (~> 1.32.1)
       colorize (~> 0.8.1)

data/lib/rsmp/site_proxy_wait.rb

@@ -2,6 +2,113 @@
 module RSMP
   module SiteProxyWait
 
+    class Matcher
+      attr_reader :result, :messages
+
+      # Initialize with a list a wanted statuses
+      def initialize want, options={}
+        @want = want.clone
+        @result = {}
+        @messages = []
+        @m_id = options[:m_id]
+      end
+
+      # Check if a messages is wanted.
+      # Returns true when we found all that we want.
+      def process message
+        ack_status = check_not_ack message
+        return ack_status if ack_status != nil
+
+        add = false
+        @want.each_with_index do |query,i|          # look through wanted
+          get_items(message).each do |input|  # look through status items in message
+            matching = match? query, input
+            if matching == true
+              @result[query] = input
+              add = true
+            elsif matching == false
+              @result.delete query
+            end
+          end
+        end
+        @messages << message if add
+        @result.size == @want.size      # queries left to match?
+      end
+
+      # Check for MessageNotAck
+      # If the original request identified by @m_id is rejected, we abort
+      def check_not_ack message
+        if message.is_a?(MessageNotAck)
+          if message.attribute('oMId') == @m_id
+            # Set result to an exception, but don't raise it.
+            # This will be returned by the async task and stored as the task result
+            # When the parent task call wait() on the task, the exception
+            # will be raised in the parent task, and caught by RSpec.
+            # RSpec will then show the error and record the test as failed
+            m_id_short = RSMP::Message.shorten_m_id @m_id, 8
+            @result = RSMP::MessageRejected.new("#{type_str} #{m_id_short} was rejected: #{message.attribute('rea')}")
+            @messages = [message]
+            return true
+          end
+          return false
+        end
+      end
+    end
+
+    class CommandResponseMatcher < RSMP::SiteProxyWait::Matcher
+      def initialize want, options={}
+        super
+      end
+
+      def type_str
+        "Command request"
+      end
+
+      def get_items message
+        message.attributes['rvs']
+      end
+
+      def match? query, item
+        return nil if query['cCI'] && query['cCI'] != item['cCI']
+        return nil if query['n'] && query['n'] != item['n']
+        if query['v'].is_a? Regexp
+          return false if query['v'] && item['v'] !~ query['v']
+        else
+          return false if query['v'] && item['v'] != query['v']
+        end
+        true
+      end
+    end
+
+    # Class for matching incoming messaging against a list of wanted statuses,
+    # and flagging when everything has been matched.
+    class StatusResponseMatcher < RSMP::SiteProxyWait::Matcher
+      def initialize want, options={}
+        super
+      end
+
+      def type_str
+        "Status request"
+      end
+
+      def get_items message
+        message.attributes['sS']
+      end
+
+      # Match an item against a query
+      def match? query, item
+        return nil if query['sCI'] && query['sCI'] != item['sCI']
+        return nil if query['n'] && query['n'] != item['n']
+        return false if query['q'] && query['q'] != item['q']
+        if query['s'].is_a? Regexp
+          return false if query['s'] && item['s'] !~ query['s']
+        else
+          return false if query['s'] && item['s'] != query['s']
+        end
+        true
+      end
+    end
+
     def wait_for_alarm parent_task, options={}
       matching_alarm = nil
       message = collect(parent_task,options.merge(type: "Alarm", with_message: true, num: 1)) do |message|
@@ -29,120 +136,26 @@ module RSMP
 
     def collect_command_responses parent_task, options, m_id
       task.annotate "wait for command response"
-      want = options[:command_list].clone
-      result = {}
-      messages = []
-      collect(parent_task,options.merge({
-        type: ['CommandResponse','MessageNotAck'],
-        num: 1
-      })) do |message|
-        if message.is_a?(MessageNotAck)
-          if message.attribute('oMId') == m_id
-            # set result to an exception, but don't raise it.
-            # this will be returned by the task and stored as the task result
-            # when the parent task call wait() on the task, the exception
-            # will be raised in the parent task, and caught by rspec.
-            # rspec will then show the error and record the test as failed
-            m_id_short = RSMP::Message.shorten_m_id m_id, 8
-            result = RSMP::MessageRejected.new "Command request #{m_id_short} was rejected: #{message.attribute('rea')}"
-            next true   # done, no more messages wanted
-          else
-            false
-          end
-        else
-          add = false
-          # look through querues
-          want.each_with_index do |query,i|
-            # look through items in message
-            message.attributes['rvs'].each do |input|
-              matching = command_match? query, input
-              if matching == true
-                result[query] = input
-                add = true
-              elsif matching == false
-                result.delete query
-              end
-            end
-          end
-          messages << message if add
-          result.size == want.size # any queries left to match?
-        end
+      matcher = CommandResponseMatcher.new options[:command_list], m_id: m_id
+      collect(parent_task,options.merge(type: ['CommandResponse','MessageNotAck'], num: 1)) do |message|
+        matcher.process message   # returns true when done (all queries matched)
       end
-      return result, messages
+      return matcher.result, matcher.messages
     rescue Async::TimeoutError
       raise RSMP::TimeoutError.new "Did not receive correct command response to #{m_id} within #{options[:timeout]}s"
     end
 
     def collect_status_updates_or_responses task, type, options, m_id
-      want = options[:status_list].clone
-      result = {}
-      messages = []
-      # wait for a status update
-      collect(task,options.merge({
-        type: [type,'MessageNotAck'],
-        num: 1
-      })) do |message|
-        if message.is_a?(MessageNotAck)
-          if message.attribute('oMId') == m_id
-            # set result to an exception, but don't raise it.
-            # this will be returned by the task and stored as the task result
-            # when the parent task call wait() on the task, the exception
-            # will be raised in the parent task, and caught by rspec.
-            # rspec will then show the error and record the test as failed
-            m_id_short = RSMP::Message.shorten_m_id m_id, 8
-            result = RSMP::MessageRejected.new "Status request #{m_id_short} was rejected: #{message.attribute('rea')}"
-            next true   # done, no more messages wanted
-          end
-          false
-        else
-          found = []
-          add = false
-          # look through querues
-          want.each_with_index do |query,i|
-            # look through status items in message
-            message.attributes['sS'].each do |input|
-              matching = status_match? query, input
-              if matching == true
-                result[query] = input
-                add = true
-              elsif matching == false
-                result.delete query
-              end
-            end
-          end
-          messages << message if add
-          result.size == want.size # any queries left to match?
-        end
+      matcher = StatusResponseMatcher.new options[:status_list], m_id: m_id
+      collect(task,options.merge( type: [type,'MessageNotAck'], num: 1 )) do |message|
+        matcher.process message   # returns true when done (all queries matched)
       end
-      return result, messages
+      return matcher.result, matcher.messages
     rescue Async::TimeoutError
       type_str = {'StatusUpdate'=>'update', 'StatusResponse'=>'response'}[type]
       raise RSMP::TimeoutError.new "Did not received correct status #{type_str} in reply to #{m_id} within #{options[:timeout]}s"
     end
 
-    def status_match? query, item
-      return nil if query['sCI'] && query['sCI'] != item['sCI']
-      return nil if query['n'] && query['n'] != item['n']
-      return false if query['q'] && query['q'] != item['q']
-      if query['s'].is_a? Regexp
-        return false if query['s'] && item['s'] !~ query['s']
-      else
-        return false if query['s'] && item['s'] != query['s']
-      end
-      true
-    end
-
-    def command_match? query, item
-      return nil if query['cCI'] && query['cCI'] != item['cCI']
-      return nil if query['n'] && query['n'] != item['n']
-      if query['v'].is_a? Regexp
-        return false if query['v'] && item['v'] !~ query['v']
-      else
-        return false if query['v'] && item['v'] != query['v']
-      end
-      true
-    end
-
     def wait_for_aggregated_status parent_task, options, m_id
       collect(parent_task,options.merge({
         type: ['AggregatedStatus','MessageNotAck'],
@@ -168,4 +181,4 @@ module RSMP
     end
 
   end
-end
+end

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-22 00:00:00.000000000 Z
+date: 2021-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async