rsmp 0.1.17 → 0.1.19

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.1.17"
+  VERSION = "0.1.19"
 end

data/lib/rsmp/wait.rb

@@ -1,10 +1,11 @@
 # Helper for waiting for an Async condition using a block
 
 module RSMP
-  class Wait
+  module Wait
 
-    def self.wait_for task, condition, timeout, &block
-      task.with_timeout(timeout) do
+    def wait_for condition, timeout, &block
+      raise RuntimeError.new("Can't wait for state because task is stopped") unless @task.running? 
+      @task.with_timeout(timeout) do
         while task.running? do
           value = condition.wait
           result = yield value 
@@ -13,5 +14,150 @@ module RSMP
       end
     end   
 
+    def capture_status_updates_or_responses task, type, options, m_id
+      task.annotate "wait for status update/response"
+      want = convert_status_list options[:status_list]
+      result = {}
+      # wait for a status update
+      item = @archive.capture(task,options.merge({
+        type: [type,'MessageNotAck'],
+        num: 1
+      })) do |item|
+        message = item[:message]
+        if message.is_a?(MessageNotAck) && 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
+        found = []
+        # look through querues
+        want.each_with_index do |query,i|
+          # look through status items in message
+          item[:message].attributes['sS'].each do |input|
+            ok = status_match? query, input
+            if ok
+              result[query] = input
+              found << i   # record which queries where matched succesfully
+            end
+          end
+        end
+        # remove queries that where matched
+        found.sort.reverse.each do |i|
+          want.delete_at i
+        end
+        want.empty? # any queries left to match?
+      end
+      result
+    rescue Async::TimeoutError
+      type_str = {'StatusUpdate'=>'update', 'StatusResponse'=>'response'}[type]
+      raise RSMP::TimeoutError.new "Did not received status #{type_str} in reply to #{m_id} within #{options[:timeout]}s"
+    end
+
+    def wait_for_status_updates_or_responses parent_task, type, options={}, &block
+      raise ArgumentError.new("component argument is missing") unless options[:component]
+      raise ArgumentError.new("status_list argument is missing") unless options[:status_list]
+      m_id = RSMP::Message.make_m_id    # make message id so we can start waiting for it
+
+      # wait for command responses in an async task
+      task = parent_task.async do |task|
+        capture_status_updates_or_responses task, type, options, m_id
+      end
+
+       # call block, it should send command request using the given m_id
+      yield m_id
+
+      # wait for the response and return it, raise exception if NotAck received, it it timed out
+      task.wait
+    end
+
+    def wait_for_status_updates parent_task, options={}, &block
+      wait_for_status_updates_or_responses parent_task, 'StatusUpdate', options, &block
+    end
+
+    def wait_for_status_responses parent_task, options={}, &block
+      wait_for_status_updates_or_responses parent_task, 'StatusResponse', options, &block
+    end
+
+    def process_command_response message
+      log "Received #{message.type}", message: message, level: :log
+      acknowledge message
+    end
+
+    def command_match? query, item
+      return false if query[:sCI] && query[:sCI] != item['sCI']
+      return false if query[:n] && query[:n] != item['n']
+      if query[:s].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 capture_command_responses parent_task, type, options, m_id
+      task.annotate "wait for command response"
+      want = options[:command_list].clone
+      result = {}
+      item = @archive.capture(parent_task,options.merge({
+        type: [type,'MessageNotAck'],
+        num: 1
+      })) do |item|
+        message = item[:message]
+        if message.is_a?(MessageNotAck) && message.attribute('oMId') == m_id
+           # and 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
+        end
+
+        found = []
+        # look through querues
+        want.each_with_index do |query,i|
+          # look through items in message
+          item[:message].attributes['rvs'].each do |input|
+            ok = command_match? query, input
+            if ok
+              result[query] = input
+              found << i   # record which queries where matched succesfully
+            end
+          end
+        end
+        # remove queries that where matched
+        found.sort.reverse.each do |i|
+          want.delete_at i
+        end
+        want.empty? # any queries left to match?
+      end
+      result
+    rescue Async::TimeoutError
+      raise RSMP::TimeoutError.new "Did not receive command response to #{m_id} within #{options[:timeout]}s"
+    end
+
+    def wait_for_command_responses parent_task, options={}, &block
+      raise ArgumentError.new("component argument is missing") unless options[:component]
+      raise ArgumentError.new("command_list argument is missing") unless options[:command_list]
+      m_id = RSMP::Message.make_m_id    # make message id so we can start waiting for it
+
+      # wait for command responses in an async task
+      task = parent_task.async do |task|
+        capture_command_responses task, 'CommandResponse', options, m_id
+      end
+
+       # call block, it should send command request using the given m_id
+      yield m_id
+
+      # wait for the response and return it, raise exception if NotAck received, it it timed out
+      task.wait
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.19
 platform: ruby
 authors:
 - Emil Tin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-24 00:00:00.000000000 Z
+date: 2020-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -200,6 +200,7 @@ files:
 - config/site.yaml
 - config/supervisor.yaml
 - config/tlc.yaml
+- documentation/classes.md
 - exe/rsmp
 - lib/rsmp.rb
 - lib/rsmp/alarm.rb
@@ -219,7 +220,6 @@ files:
 - lib/rsmp/site_base.rb
 - lib/rsmp/site_proxy.rb
 - lib/rsmp/supervisor.rb
-- lib/rsmp/supervisor_base.rb
 - lib/rsmp/supervisor_proxy.rb
 - lib/rsmp/tlc.rb
 - lib/rsmp/version.rb
@@ -274,7 +274,10 @@ files:
 - lib/rsmp_schema/schema/tlc/commands/M0017.json
 - lib/rsmp_schema/schema/tlc/commands/M0018.json
 - lib/rsmp_schema/schema/tlc/commands/M0019.json
+- lib/rsmp_schema/schema/tlc/commands/M0020.json
+- lib/rsmp_schema/schema/tlc/commands/M0021.json
 - lib/rsmp_schema/schema/tlc/commands/M0103.json
+- lib/rsmp_schema/schema/tlc/commands/M0104.json
 - lib/rsmp_schema/schema/tlc/commands/command_requests.json
 - lib/rsmp_schema/schema/tlc/commands/command_responses.json
 - lib/rsmp_schema/schema/tlc/commands/commands.json
@@ -307,10 +310,13 @@ files:
 - lib/rsmp_schema/schema/tlc/statuses/S0027.json
 - lib/rsmp_schema/schema/tlc/statuses/S0028.json
 - lib/rsmp_schema/schema/tlc/statuses/S0029.json
+- lib/rsmp_schema/schema/tlc/statuses/S0030.json
+- lib/rsmp_schema/schema/tlc/statuses/S0031.json
 - lib/rsmp_schema/schema/tlc/statuses/S0091.json
 - lib/rsmp_schema/schema/tlc/statuses/S0092.json
 - lib/rsmp_schema/schema/tlc/statuses/S0095.json
 - lib/rsmp_schema/schema/tlc/statuses/S0096.json
+- lib/rsmp_schema/schema/tlc/statuses/S0097.json
 - lib/rsmp_schema/schema/tlc/statuses/S0201.json
 - lib/rsmp_schema/schema/tlc/statuses/S0202.json
 - lib/rsmp_schema/schema/tlc/statuses/S0203.json

data/lib/rsmp/supervisor_base.rb

@@ -1,10 +0,0 @@
-# Things shared between sites and site proxies
-
-module RSMP
-  module SupervisorBase
-
-    def initialize_supervisor
-    end
-
-  end
-end