rsmp 0.8.1 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5316c50ad6cd09d30e7d1baab78e717fac4656c06178272ef4adc1c6647fb544
-  data.tar.gz: 6ef4d635b42f3eac19b94b68bbcb05c59ce94de96e0e27f1f5c7a6deefd4e470
+  metadata.gz: e12fd3ea8f7f931b3ce3269a13e8ccd1248642a89062682b0088d044732f1757
+  data.tar.gz: ff18134bf0e16210e30a5820f5bd2c27b5fb7f81bcf2f9f993e6c8aefe69d9d5
 SHA512:
-  metadata.gz: 1947906505e532d0d47d93f1d9fe2c8c3199ff58d378b9be3df18865339e966a6ad5f74512aa168ee4a5d641624cf7b0f170436d2c11e4f495bd7d6b88be502f
-  data.tar.gz: ee0ecbb229637276d6cec21ccacc6414199ad7f0392324633231cb4a8632a8b64b1aa2ba5abd979a7699ed6721a5a40b9d9c531f45dc0f59345149662e608b12
+  metadata.gz: 3335d30f728748483d26e5d3d0c5671746b80dece2badc781064d0ae81f277fd7b899e9e508255a17d6f1cbd017a64164f6f0a21f1ca777b359c23b1fa482ebf
+  data.tar.gz: a2e457988983d9c3173f91c1269979ea6a37ce75ac5e0acc30f21fbb34d2cfab8fe81295ac43c6a6010df0f7c06e11dc9efadd01c28fc20a0e77ff6d6c580787

data/.ruby-version

@@ -1 +1 @@
-3.0.3
+3.1.0

data/Gemfile.lock

@@ -1,27 +1,21 @@
 PATH
   remote: .
   specs:
-    rsmp (0.8.1)
+    rsmp (0.8.5)
       async (~> 1.29.1)
-      async-io (~> 1.32.1)
+      async-io (~> 1.32.2)
       colorize (~> 0.8.1)
       rsmp_schemer
-      thor (~> 1.0.1)
+      thor (~> 1.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    aruba (1.1.2)
+    aruba (2.0.0)
       bundler (>= 1.17, < 3.0)
       childprocess (>= 2.0, < 5.0)
       contracts (>= 0.16.0, < 0.18.0)
-      cucumber (>= 2.4, < 7.0)
+      cucumber (>= 4.0, < 8.0)
       rspec-expectations (~> 3.4)
       thor (~> 1.0)
     async (1.29.2)
@@ -33,68 +27,56 @@ GEM
     builder (3.2.4)
     childprocess (4.1.0)
     colorize (0.8.1)
-    concurrent-ruby (1.1.9)
     console (1.14.0)
       fiber-local
     contracts (0.17)
-    cucumber (6.1.0)
+    cucumber (7.1.0)
       builder (~> 3.2, >= 3.2.4)
-      cucumber-core (~> 9.0, >= 9.0.1)
-      cucumber-create-meta (~> 4.0, >= 4.0.0)
-      cucumber-cucumber-expressions (~> 12.1, >= 12.1.1)
-      cucumber-gherkin (~> 18.1, >= 18.1.0)
-      cucumber-html-formatter (~> 13.0, >= 13.0.0)
-      cucumber-messages (~> 15.0, >= 15.0.0)
-      cucumber-wire (~> 5.0, >= 5.0.1)
+      cucumber-core (~> 10.1, >= 10.1.0)
+      cucumber-create-meta (~> 6.0, >= 6.0.1)
+      cucumber-cucumber-expressions (~> 14.0, >= 14.0.0)
+      cucumber-gherkin (~> 22.0, >= 22.0.0)
+      cucumber-html-formatter (~> 17.0, >= 17.0.0)
+      cucumber-messages (~> 17.1, >= 17.1.1)
+      cucumber-wire (~> 6.2, >= 6.2.0)
       diff-lcs (~> 1.4, >= 1.4.4)
       mime-types (~> 3.3, >= 3.3.1)
       multi_test (~> 0.1, >= 0.1.2)
       sys-uname (~> 1.2, >= 1.2.2)
-    cucumber-core (9.0.1)
-      cucumber-gherkin (~> 18.1, >= 18.1.0)
-      cucumber-messages (~> 15.0, >= 15.0.0)
-      cucumber-tag-expressions (~> 3.0, >= 3.0.1)
-    cucumber-create-meta (4.0.0)
-      cucumber-messages (~> 15.0, >= 15.0.0)
+    cucumber-core (10.1.1)
+      cucumber-gherkin (~> 22.0, >= 22.0.0)
+      cucumber-messages (~> 17.1, >= 17.1.1)
+      cucumber-tag-expressions (~> 4.1, >= 4.1.0)
+    cucumber-create-meta (6.0.4)
+      cucumber-messages (~> 17.1, >= 17.1.1)
       sys-uname (~> 1.2, >= 1.2.2)
-    cucumber-cucumber-expressions (12.1.1)
-    cucumber-gherkin (18.1.1)
-      cucumber-messages (~> 15.0, >= 15.0.0)
-    cucumber-html-formatter (13.0.0)
-      cucumber-messages (~> 15.0, >= 15.0.0)
-    cucumber-messages (15.0.0)
-      protobuf-cucumber (~> 3.10, >= 3.10.8)
-    cucumber-tag-expressions (3.0.1)
-    cucumber-wire (5.0.1)
-      cucumber-core (~> 9.0, >= 9.0.1)
-      cucumber-cucumber-expressions (~> 12.1, >= 12.1.1)
-      cucumber-messages (~> 15.0, >= 15.0.0)
-    diff-lcs (1.4.4)
-    ecma-re-validator (0.3.0)
-      regexp_parser (~> 2.0)
-    ffi (1.15.3)
+    cucumber-cucumber-expressions (14.0.0)
+    cucumber-gherkin (22.0.0)
+      cucumber-messages (~> 17.1, >= 17.1.1)
+    cucumber-html-formatter (17.0.0)
+      cucumber-messages (~> 17.1, >= 17.1.0)
+    cucumber-messages (17.1.1)
+    cucumber-tag-expressions (4.1.0)
+    cucumber-wire (6.2.1)
+      cucumber-core (~> 10.1, >= 10.1.0)
+      cucumber-cucumber-expressions (~> 14.0, >= 14.0.0)
+    diff-lcs (1.5.0)
+    ecma-re-validator (0.4.0)
+      regexp_parser (~> 2.2)
+    ffi (1.15.5)
     fiber-local (1.0.0)
     hana (1.3.7)
-    i18n (1.8.10)
-      concurrent-ruby (~> 1.0)
     json_schemer (0.2.18)
       ecma-re-validator (~> 0.3)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       uri_template (~> 0.7)
-    middleware (0.1.0)
-    mime-types (3.3.1)
+    mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0225)
-    minitest (5.14.4)
+    mime-types-data (3.2022.0105)
     multi_test (0.1.2)
     nio4r (2.5.8)
-    protobuf-cucumber (3.10.8)
-      activesupport (>= 3.2)
-      middleware
-      thor
-      thread_safe
-    rake (13.0.3)
+    rake (13.0.6)
     regexp_parser (2.2.0)
     rsmp_schemer (0.3.2)
       json_schemer (~> 0.2.18)
@@ -104,37 +86,33 @@ GEM
       rspec-mocks (~> 3.10.0)
     rspec-core (3.10.1)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec-expectations (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+    rspec-support (3.10.3)
     sys-uname (1.2.2)
       ffi (~> 1.1)
-    thor (1.0.1)
-    thread_safe (0.3.6)
+    thor (1.2.1)
     timecop (0.9.4)
     timers (4.3.3)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
     uri_template (0.7.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   x86_64-darwin-20
   x86_64-darwin-21
 
 DEPENDENCIES
-  aruba (~> 1.1.2)
-  bundler (~> 2.2.21)
-  cucumber (~> 6.1.0)
-  rake (~> 13.0.3)
+  aruba (~> 2.0.0)
+  bundler (~> 2.3.6)
+  cucumber (~> 7.1.0)
+  rake (~> 13.0.6)
   rsmp!
   rspec (~> 3.10.0)
-  rspec-expectations (~> 3.10.1)
+  rspec-expectations (~> 3.10.2)
   timecop (~> 0.9.4)
 
 BUNDLED WITH
-   2.2.32
+   2.3.6

data/config/tlc.yaml

@@ -20,17 +20,18 @@ signal_plans:
     dynamic_bands:
       1: 0
       2: 5
-    states:
-      A1: '11NBBB'
-      A2: '1NBBBB'
-      B1: 'BBB11N'
-      B2: 'BBB1NB'
-  2:
     states:
       A1: '111NBB'
       A2: '11NBBB'
       B1: 'BBB11N'
       B2: 'BBB1NB'
+  2:
+    states:
+      A1: 'NNNNBB'
+      A2: 'NNNNBN'
+      B1: 'BBNNNN'
+      B2: 'BNNNNN'
+startup_sequence: 'efg'
 intervals:
   timer: 0.1
   watchdog: 0.1
@@ -48,3 +49,4 @@ log:
   level: false
   debug: true
   json: true
+live_output: tmp/tlc.state

data/documentation/collecting_message.md

@@ -157,7 +157,7 @@ task.wait  # wait for collection task to complete (or time out)
 ```
 
 ### With collection
-If you provide `:collect` options, it will be used to construct a StatusUpdateCollector for collecting the relevant status messages. When collection completes the collector is returned in the `:collector` key:
+If you provide `:collect` options, it will be used to construct a StatusCollector for collecting the relevant status messages. When collection completes the collector is returned in the `:collector` key:
 
 ```ruby
 options = {

data/lib/rsmp/collect/collector.rb

@@ -6,8 +6,8 @@ module RSMP
   class Collector < Listener
     attr_reader :condition, :messages, :status, :error, :task
 
-    def initialize proxy, options={}
-      super proxy, options
+    def initialize notifier, options={}
+      super notifier, options
       @options = {
         cancel: {
           schema_error: true,
@@ -18,7 +18,15 @@ module RSMP
       @outgoing = options[:outgoing] == nil ? false : options[:outgoing]
       @condition = Async::Notification.new
       @title = options[:title] || [@options[:type]].flatten.join('/')
-      @task = options[:task]
+      if options[:task]
+        @task = options[:task]
+      else
+         # if notifier is a Proxy, or some other object that implements task(),
+         # then try to get the task that way
+        if notifier.respond_to? 'task'
+          @task = notifier.task
+        end
+      end
       reset
     end
 
@@ -43,12 +51,12 @@ module RSMP
       @status == :collecting
     end
 
-    # Is collection active?
+    # Is collection complete?
     def ok?
       @status == :ok
     end
 
-    # Has collection time out?
+    # Has collection timed out?
     def timeout?
       @status == :timeout
     end
@@ -73,6 +81,13 @@ module RSMP
       @outgoing == true
     end
 
+    # if an errors caused collection to abort, then raise it
+    # return self, so this can be tucked on to calls that return a collector
+    def ok!
+      raise @error if @error
+      self
+    end
+
     # Collect message
     # Will return once all messages have been collected, or timeout is reached
     def collect &block
@@ -80,15 +95,14 @@ module RSMP
       wait
       @status
     ensure
-      @notifier.remove_listener self
+      @notifier.remove_listener self if @notifier
     end
 
     # Collect message
     # Returns the collected messages, or raise an exception in case of a time out.
     def collect! &block
-      if collect(&block) == :timeout
-        raise RSMP::TimeoutError.new describe_progress
-      end
+      collect(&block)
+      ok!
       @messages
     end
 
@@ -104,6 +118,7 @@ module RSMP
       end
       @status
     rescue Async::TimeoutError
+      @error = RSMP::TimeoutError.new describe_progress
       @status = :timeout
     end
 
@@ -112,7 +127,7 @@ module RSMP
     # If timeout is reached, an exceptioin is raised.
     def wait!
       wait
-      raise RSMP::TimeoutError.new(describe_progress) if timeout?
+      raise @error if timeout?
       @messages
     end
 
@@ -151,28 +166,26 @@ module RSMP
     # Handle message. and return true when we're done collecting
     def notify message
       raise ArgumentError unless message
-      raise RuntimeError.new("can't process message when done") unless ready? || collecting?
-      unless reject_not_ack(message)
-        perform_match message
-      end
+      raise RuntimeError.new("can't process message when status is :#{@status}, title: #{@title}, desc: #{describe}") unless ready? || collecting?
+      perform_match message
       @status
     end
 
+    def describe
+    end
+
     # Match message against our collection criteria
     def perform_match message
-      return unless type_match?(message)
+      return false if reject_not_ack(message)
+      return false unless type_match?(message)
       if @block
         status = [@block.call(message)].flatten
+        return unless collecting?
         keep message if status.include?(:keep)
-        if status.include?(:cancel)
-          cancel('Cancelled by block')
-        else
-          complete if done?
-        end
       else
         keep message
-        complete if done?
       end
+      complete if done?
     end
 
     # Have we collected the required number of messages?
@@ -194,8 +207,8 @@ module RSMP
       @condition.signal
     end
 
-    # The proxy experienced some error.
-    # Check if this should cause us to cancel.
+    # An error occured upstream.
+    # Check if we should cancel.
     def notify_error error, options={}
       case error
       when RSMP::SchemaError
@@ -224,7 +237,7 @@ module RSMP
     end
 
     # Abort collection
-    def cancel error
+    def cancel error=nil
       @error = error
       @status = :cancelled
       do_stop

data/lib/rsmp/collect/command_response_collector.rb

@@ -14,7 +14,7 @@ module RSMP
 
     # Get items, in our case the return values
     def get_items message
-      message.attributes['rvs']
+      message.attributes['rvs'] || []
     end
   end
 end

data/lib/rsmp/collect/filter.rb

@@ -0,0 +1,31 @@
+module RSMP
+
+  # Filter messages based on type, direction and component id.
+  # Used by Collectors.
+  class Filter
+    def initialize ingoing:true, outgoing:true, type:, component:nil
+      @ingoing = ingoing
+      @outgoing = outgoing
+      @type = type
+      @component = component
+    end
+
+    # Check a message against our match criteria
+    # Return true if there's a match, false if not
+    def accept? message
+      return false if message.direction == :in && @ingoing == false
+      return false if message.direction == :out && @outgoing == false
+      if @type
+        if @type.is_a? Array
+          return false unless @type.include? message.type
+        else
+          return false unless message.type == @type
+        end
+      end
+      if @component
+        return false if message.attributes['cId'] && message.attributes['cId'] != @component
+      end
+      true
+    end
+  end
+end

data/lib/rsmp/collect/listener.rb

@@ -19,13 +19,5 @@ module RSMP
 
     def notify_error error, options={}
     end
-
-    def listen &block
-      @notifier.add_listener self
-      yield
-    ensure
-      @notifier.remove_listener self
-    end
-
   end
 end

data/lib/rsmp/collect/query.rb

@@ -8,26 +8,36 @@ module RSMP
       @want = want
       @got = nil
       @message = nil
-      @done = false
     end
 
     # Are we done, i.e. did the last checked item match?
     def done?
-      @done
+      @got != nil
     end
 
     # Check an item and set @done to true if it matches
     # Store the item and corresponding message if there's a positive or negative match
-    def perform_match item, message
+    def perform_match item, message, block
       matched = match? item
       if matched != nil
-        @message = message
-        @got = item
-        @done = matched
+        if block
+          status = block.call(nil,item)
+          matched = status if status == true || status == false
+        end
       end
       matched
     end
 
+    def keep message, item
+      @message = message
+      @got = item
+    end
+
+    def forget
+      @message = nil
+      @got = nil
+    end
+
     def match? item
     end
   end

data/lib/rsmp/collect/state_collector.rb

@@ -61,7 +61,7 @@ module RSMP
 
     # Get messages from results
     def messages
-      @queries.map { |query| query.message }.uniq
+      @queries.map { |query| query.message }.uniq.compact
     end
 
     # Return progress as completes queries vs. total number of queries
@@ -90,22 +90,33 @@ module RSMP
     # Check if a messages matches our criteria.
     # Match each query against each item in the message
     def perform_match message
-      return unless type_match?(message)
+      return false if super(message) == false
+      return unless collecting?
       @queries.each do |query|       # look through queries
         get_items(message).each do |item|  # look through items in message
-          matched = query.perform_match(item,message)
-          if matched == true
-            matched = @block.call(message,item) if @block
-          end
+          matched = query.perform_match(item,message,@block)
+          return unless collecting?
           if matched != nil
             type = {true=>'match',false=>'mismatch'}[matched]
             @notifier.log "#{@title.capitalize} #{message.m_id_short} collect #{type} #{query.want}, item #{item}", level: :debug
-            break
+            if matched == true
+              query.keep message, item
+            elsif matched == false
+              query.forget
+            end
           end
         end
       end
       complete if done?
       @notifier.log "#{@title.capitalize} collect reached #{summary}", level: :debug
     end
+
+    # don't collect anything. Query will collect them instead
+    def keep message
+    end
+
+    def describe
+      @queries.map {|q| q.want.to_s }
+    end
   end
 end

data/lib/rsmp/collect/status_collector.rb

@@ -0,0 +1,20 @@
+module RSMP
+  # Base class for waiting for status updates or responses
+  class StatusCollector < StateCollector
+    def initialize proxy, want, options={}
+      super proxy, want, options.merge(title: 'status response', type:['MessageNotAck'])
+
+      @options[:type] << 'StatusUpdate' unless options[:updates] == false
+      @options[:type] << 'StatusResponse' unless options[:reponses] == false
+    end
+
+    def build_query want
+      RSMP::StatusQuery.new want
+    end
+
+    # Get items, in our case status values
+    def get_items message
+      message.attributes['sS'] || []
+    end
+  end
+end

data/lib/rsmp/node.rb

@@ -15,7 +15,6 @@ module RSMP
       @clock = Clock.new
       @error_queue = Async::Queue.new
       @ignore_errors = []
-      options[:collector]
       @collect = options[:collect]
     end
 

data/lib/rsmp/proxy.rb

@@ -52,12 +52,6 @@ module RSMP
       node.clock
     end
 
-    def collect options, &block
-      collector = RSMP::Collector.new self, options.merge(task: @task)
-      collector.collect &block
-      collector
-    end
-
     def run
       start
       @reader.wait if @reader
@@ -579,25 +573,34 @@ module RSMP
     end
 
     def wait_for_acknowledgement parent_task, options={}, m_id
-      collect(parent_task,options.merge({
-        type: ['MessageAck','MessageNotAck'],
-        num: 1
-      })) do |message|
+      collector = Collector.new self, options.merge(task: parent_task, type: ['MessageAck','MessageNotAck'])
+      collector.collect 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 "Aggregated status request #{m_id_short} was rejected with '#{message.attribute('rea')}'"
-            next true   # done, no more messages wanted
+            raise RSMP::MessageRejected.new "Aggregated status request #{m_id_short} was rejected with '#{message.attribute('rea')}'"
           end
         elsif message.is_a?(MessageAck)
-          next true if message.attribute('oMId') == m_id
+          collector.complete if message.attribute('oMId') == m_id
+        end
+      end
+    end
+
+    def send_and_optionally_collect message, options, &block
+      collect_options = options[:collect] || options[:collect!]
+      if collect_options
+        task = @task.async do |task|
+          collector = yield collect_options     # call block to create collector
+          collector.collect
+          collector.ok! if options[:collect!]   # raise any errors if the bang version was specified
+          collector
         end
-        false
+
+        send_message message, validate: options[:validate]
+        { sent: message, collector: task.wait }
+      else
+        send_message message, validate: options[:validate]
+        return { sent: message }
       end
     end
   end

data/lib/rsmp/site.rb

@@ -9,9 +9,9 @@ module RSMP
     attr_reader :rsmp_versions, :site_settings, :logger, :proxies
 
     def initialize options={}
+      super options
       initialize_components
       handle_site_settings options
-      super options
       @proxies = []
       @sleep_condition = Async::Notification.new
       @proxies_condition = Async::Notification.new
@@ -95,7 +95,8 @@ module RSMP
         ip: supervisor_settings['ip'],
         port: supervisor_settings['port'],
         logger: @logger,
-        archive: @archive
+        archive: @archive,
+        collect: @collect
       })
       @proxies << proxy
       @proxies_condition.signal