rsmp 0.29.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 128be65ff4ece071590a4ed3dc113cbfdf1a697115033a02a113d894935a6cad
-  data.tar.gz: 4f025722621f8edb751dcbf6f38acbb146c26fddac53a29f14673e8751609ddb
+  metadata.gz: c4dc16f45d38459c4ab31445f39e74c8e0fe71ce906759a4f842ddcc8ca78471
+  data.tar.gz: 50d8ff8a27a2f16ddba8206236cc17997a582b5b5ec01348a55e9a7b3a8004b7
 SHA512:
-  metadata.gz: 89086c19b7ec7b64f234ec19ec70688ae08e62524ec307b66ccb27e159c3d5ea9eee5bcb360de41d457ad3db3174d9b31d159802a92759596cf10dc24525dcc6
-  data.tar.gz: 6ee2489e60c466c9de16d4698b0cfef4e8bb065e9f358b9e0f55133759eab6b5adab248f0ab29ca021bae3cf9138b32c54d955ef2fbf629e2815a6a7f57947f1
+  metadata.gz: 735d346b07fb2ad71cead5a0d934bb415125429e2fa628e9c4aa93a73f7e1e40a8db5cce27b6329fbb520f13f9018fb2f221e4cf60051818043e58cbab2f0523
+  data.tar.gz: aad8d0d4b871916080c7c981a00fea551fb0c7b62599149b017b955d46e6c810fd246682206d89f2a6a99b5ec19cc0285fb6c68e2cde8b594cbe40402e542834

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.29.0)
+    rsmp (0.32.0)
       async (~> 2.12.0)
       async-io (~> 1.43.0)
       colorize (~> 1.1)
@@ -16,16 +16,16 @@ GEM
       cucumber (>= 8.0, < 10.0)
       rspec-expectations (~> 3.4)
       thor (~> 1.0)
-    async (2.12.0)
+    async (2.12.1)
       console (~> 1.25, >= 1.25.2)
       fiber-annotation
-      io-event (~> 1.6)
+      io-event (~> 1.6, >= 1.6.5)
     async-io (1.43.2)
       async
     bigdecimal (3.1.8)
     builder (3.3.0)
     colorize (1.1.0)
-    console (1.25.2)
+    console (1.27.0)
       fiber-annotation
       fiber-local (~> 1.1)
       json
@@ -64,9 +64,9 @@ GEM
     fiber-annotation (0.2.0)
     fiber-local (1.1.0)
       fiber-storage
-    fiber-storage (0.1.2)
+    fiber-storage (1.0.0)
     hana (1.3.7)
-    io-event (1.6.4)
+    io-event (1.6.5)
     json (2.7.2)
     json_schemer (2.3.0)
       bigdecimal
@@ -96,7 +96,7 @@ GEM
     simpleidn (0.2.3)
     sys-uname (1.3.0)
       ffi (~> 1.1)
-    thor (1.3.1)
+    thor (1.3.2)
     timecop (0.9.10)
 
 PLATFORMS

data/documentation/collecting_message.md

@@ -3,30 +3,45 @@ You often need to collect messages or responses. The collector classes are used
 
 A collector can collect ingoing and/or outgoing messages.
 
-An object that includes the Notifier module (or implements the same functionality) must be provided when you construct a Collected. The collector will attach itself to this notifier when it starts collecting, to receive messages. The SiteProxy and SupervisorProxy classes both include the Notifier module, and can therefore be used as message sources.
+An object that includes the Distributor module (or implements the same functionality) must be provided when you construct a Collected. The collector will attach itself to this distributor when it starts collecting, to receive messages. The SiteProxy and SupervisorProxy classes both include the Distributor module, and can therefore be used as message sources.
 
 Messages that match the relevant criteria are stored by the collector.
 
-When the collection is done, the collector detaches from the notifier, and returns the status.
+When the collection is done, the collector detaches from the distributor, and returns the status.
 
 
 ## Collector
-Class uses for collecting messages filtered by message type, direction and/or component id. A block can be used for custom filtering.
+Class used for collecting messages filtered by message type, direction and/or component id. A block can be used for custom filtering.
 
 You can choose to collect a specific number of message and/or for a specific duration.
 
 A collector has a status, which is `:ready` initialialy. When you start collecting, it changes to `:collecting`. It will be `:ok` once collection completes successfully, or `:cancel` if it was cancelled to to some error or by a filter block.
 
 ### Initialization
-When you create a collector, you specify the messages types you want to collect.
-You can also specify ingoing and/or outgoing direction and the RSMP component.
+When you create a collector, you provide a Filter to specify the messages types you want to collect. You can also specify ingoing and/or outgoing direction and the RSMP component.
 
 ```ruby
-collector = MessageCollector.new notifier, num: 10, ingoing: true, outgoing: true
+collector = MessageCollector.new(distributor,
+	num: 10,
+	filter: Filter.new(ingoing: true, outgoing: true)
 ```
 
 num: The number of messages to collect. If not provided, a timeout must be set instead.
-timeout: The number of seconds to collect
+filter: filter to identify the types of messages to look for.
+
+### Filter
+The Filter class is used to filter messages according to message type, direction and component.
+
+```ruby
+filter = Filter.new(
+	type: 'Alarm',
+	ingoing: true,
+	outgoing: false,
+	component: 'DL1'
+	)
+```
+
+type: a string, or an array of string, specifiying one or more RSMP message types.
 ingoing: Whether to collect ingoing messages. Defaults to true
 outgoing: Whether to collect outgoing messages. Defaults to true
 component: An RSMP component id.
@@ -48,7 +63,7 @@ result = collector.wait
 ```
 
 ### Custom filtering
-You can use a block to do extra filtering. The block will be callled for each messages that fulfils the  correct message type, direction and component id.
+You can use a block to do extra filtering. The block will be callled for each messages that passes the Filter provided when initializing the collector.
 
 The block must return nil or a list of symbols to indicate whether the message should be kept, and whether collection should be cancelled.
 
@@ -69,7 +84,7 @@ Exceptions in the block will cause the collector to abort. If the collect! or wa
 The method collect!() will raise exceptions in case of errors, and will return the collect message directly.
 
 ```ruby
-message = collector.collect # => collected message.
+message = collector.collect! # => collected message.
 ```
 
 Similar, `wait!()` will raise an exception in case of timeouts or errors:
@@ -181,7 +196,7 @@ result[:collector].messages # => list of collected messages
 
 ### Processing responses
 If you pass a block, the block will be used to construct a collector. The block will be called for each matching  status item received.
-Collection will continue until the block returns :cancel, or it times.
+Collection will continue until the block returns :cancel, or it times out.
 
 ```ruby
 options = {

data/documentation/message_distribution.md

@@ -1,23 +1,23 @@
 # Message distribution
 
-Proxy - - Notifier --> Listeners
+Proxy - - Distributor --> Receivers
 
-A proxy distributes messages to listeners, when they are installed.
+A proxy distributes messages to receivers, when they are installed.
 
-Collectors are special listenerws that waits for specific message, and are used to implement methods for waiting for RMSP responses, statuses, alarms, etc.
+Collectors are special receiverws that waits for specific message, and are used to implement methods for waiting for RMSP responses, statuses, alarms, etc.
 
-Note that Archive is not a listener, and does not receive messages via the Notifier. Instead the Archive gets and stores messages via the log() interface in the Logging module. The reason is that the items that the Archive and the Logger contain other data as well as the message, like error messages, warnings, text descriptions, colors codes, etc. The Distributor and Receiver handles only Message objects.
+Note that Archive is not a receiver, and does not receive messages via the Distributor. Instead the Archive gets and stores messages via the log() interface in the Logging module. The reason is that the items that the Archive and the Logger contain other data as well as the message, like error messages, warnings, text descriptions, colors codes, etc. The Distributor and Receiver handles only Message objects.
 
-## Notifier
+## Distributor
 A module that handles distributing messages to receivers.
 
-## Listener
+## Receiver
 Receives messages as long as it's installed into a distributor.
 
 ## Collector
-A subclass of Receiver that wait for specific messages. Once received
+Includes the Receiver module to wait for specific messages. Once received
 the client receives the collection.
 
 ## Proxy
-A proxy includes the Notifier module and distributes each message to listerens after processing it.
+A proxy includes the Distributor module and distributes each message to receivers after processing it.
 

data/lib/rsmp/cli.rb

@@ -12,9 +12,10 @@ module RSMP
     method_option :config, :type => :string, :aliases => "-c", banner: 'Path to .yaml config file'
     method_option :id, :type => :string, :aliases => "-i", banner: 'RSMP site id'
     method_option :supervisors, :type => :string, :aliases => "-s", banner: 'ip:port,... list of supervisor to connect to'
+    method_option :core, :string => :string, banner: "Core version: [#{RSMP::Schema.core_versions.join(' ')}]", enum: RSMP::Schema.core_versions
+    method_option :type, :type => :string, :aliases => "-t", banner: 'Type of site: [tlc]', enum: ['tlc'], default: 'tlc'
     method_option :log, :type => :string, :aliases => "-l", banner: 'Path to log file'
     method_option :json, :type => :boolean, :aliases => "-j", banner: 'Show JSON messages in log'
-    method_option :type, :type => :string, :aliases => "-t", banner: 'Type of site: [tlc]'
     def site
       settings = {}
       log_settings = { 'active' => true }
@@ -43,6 +44,20 @@ module RSMP
         end
       end
 
+      if options[:core]
+        settings['core_versions'] = [options[:core]]
+      end
+
+      site_class = RSMP::Site
+      site_type = options[:type] || settings['type']
+      case site_type
+        when 'tlc'
+          site_class = RSMP::TLC::TrafficControllerSite
+        else
+          puts "Error: Unknown site type #{site_type}"
+          exit
+      end
+
       if options[:log]
         log_settings['path'] = options[:log]
       end
@@ -51,22 +66,25 @@ module RSMP
         log_settings['json'] = options[:json]
       end
 
-      site_class = RSMP::Site
-      if options[:type]
-        case options[:type]
-          when 'tlc'
-            site_class = RSMP::TLC::TrafficControllerSite
-          else
-            site_class = RSMP::Site
-        end
-      end
       Async do |task|
         task.annotate 'cli'
         loop do
           begin
-            site = site_class.new(site_settings:settings, log_settings: log_settings)
+            site = site_class.new(site_settings: settings, log_settings: log_settings)
             site.start
             site.wait
+          rescue Psych::SyntaxError => e
+            puts "Cannot read config file #{e}"
+            break
+          rescue RSMP::Schema::UnknownSchemaTypeError => e
+            puts "Cannot start site: #{e}"
+            break
+          rescue RSMP::Schema::UnknownSchemaVersionError => e
+            puts "Cannot start site: #{e}"
+            break
+          rescue RSMP::ConfigurationError => e
+            puts "Cannot start site: #{e}"
+            break
           rescue RSMP::Restart
             site.stop
           end
@@ -74,12 +92,6 @@ module RSMP
       end
     rescue Interrupt
       # cntr-c
-    rescue RSMP::Schema::UnknownSchemaTypeError => e
-      puts "Cannot start site: #{e}"
-    rescue RSMP::Schema::UnknownSchemaVersionError => e
-      puts "Cannot start site: #{e}"
-    rescue Psych::SyntaxError => e
-      puts "Cannot read config file #{e}"
     rescue Exception => e
       puts "Uncaught error: #{e}"
       puts caller.join("\n")
@@ -90,6 +102,7 @@ module RSMP
     method_option :id, :type => :string, :aliases => "-i", banner: 'RSMP site id'
     method_option :ip, :type => :numeric, banner: 'IP address to listen on'
     method_option :port, :type => :string, :aliases => "-p", banner: 'Port to listen on'
+    method_option :core, :string => :string, banner: "Core version: [#{RSMP::Schema.core_versions.join(' ')}]", enum: RSMP::Schema.core_versions
     method_option :log, :type => :string, :aliases => "-l", banner: 'Path to log file'
     method_option :json, :type => :boolean, :aliases => "-j", banner: 'Show JSON messages in log'
     def supervisor
@@ -118,6 +131,11 @@ module RSMP
         settings['port'] = options[:port]
       end
 
+      if options[:core]
+        settings['guest'] = {}
+        settings['guest']['core_versions'] = [options[:core]]
+      end
+
       if options[:log]
         log_settings['path'] = options[:log]
       end
@@ -131,11 +149,17 @@ module RSMP
         supervisor = RSMP::Supervisor.new(supervisor_settings:settings,log_settings:log_settings)
         supervisor.start
         supervisor.wait
+      rescue Psych::SyntaxError => e
+        puts "Cannot read config file #{e}"
+      rescue RSMP::Schema::UnknownSchemaTypeError => e
+        puts "Cannot start supervisor: #{e}"
+      rescue RSMP::Schema::UnknownSchemaVersionError => e
+        puts "Cannot start supervisor: #{e}"
+      rescue RSMP::ConfigurationError => e
+        puts "Cannot start supervisor: #{e}"
       end
     rescue Interrupt
       # ctrl-c
-    rescue RSMP::ConfigurationError => e
-      puts "Cannot start supervisor: #{e}"
     end
 
     desc "convert", "Convert SXL from YAML to JSON Schema"

data/lib/rsmp/collect/ack_collector.rb

@@ -3,14 +3,16 @@ module RSMP
   class AckCollector < Collector
     def initialize proxy, options={}
       raise ArgumentError.new("m_id must be provided") unless options[:m_id]
-      required = { type: 'MessageAck', num: 1, title: 'message acknowledgement' }
-      super proxy, options.merge(required)
+      super proxy, options.merge(
+        filter: RSMP::Filter.new(ingoing: true, outgoing: false, type: 'MessageAck'),
+        num: 1,
+        title: 'message acknowledgement'
+      )
     end
 
     # Check if we the MessageAck related to initiating request, identified by @m_id.
-    def type_match? message
-      return false if super(message) == false
-      return message.attribute('oMId') == @options[:m_id]
+    def acceptable? message
+      super(message) && message.attribute('oMId') == @m_id
     end
   end
 end

data/lib/rsmp/collect/aggregated_status_collector.rb

@@ -2,8 +2,10 @@ module RSMP
   # Class for waiting for an aggregated status response
   class AggregatedStatusCollector < Collector
     def initialize proxy, options={}
-      required = { type: 'AggregatedStatus', title: 'aggregated status' }
-      super proxy, options.merge(required)
+      super proxy, options.merge(
+        filter: RSMP::Filter.new(ingoing: true, outgoing: false, type: 'AggregatedStatus'),
+        title: 'aggregated status'
+      )
     end
   end
 end

data/lib/rsmp/collect/alarm_collector.rb

@@ -2,20 +2,20 @@ module RSMP
   # Class for waiting for specific command responses
   class AlarmCollector < Collector
     def initialize proxy,options={}
-      @query = options[:query] || {}
+      @matcher = options[:matcher] || {}
       super proxy, options.merge(
-        type: 'Alarm',
+        filter: RSMP::Filter.new(ingoing: true, outgoing: false, type: 'Alarm'),
         title:'alarm'
       )
     end
 
     # match alarm attributes
-    def type_match? message
+    def acceptable? message
       return false if super(message) == false
 
       # match fixed attributes
       %w{cId aCId aSp ack aS sS cat pri}.each do |key|
-        want = @query[key]
+        want = @matcher[key]
         got = message.attribute(key)
         case want
         when Regexp
@@ -26,13 +26,13 @@ module RSMP
       end
 
       # match rvs items
-      if @query['rvs']
-        query_rvs = @query['rvs']
+      if @matcher['rvs']
+        matcher_rvs = @matcher['rvs']
         message_rvs = message.attributes['rvs']
         return false unless message_rvs
-        return false unless query_rvs.all? do |query_item|
+        return false unless matcher_rvs.all? do |matcher_item|
           return false unless message_rvs.any? do |message_item|
-            next message_item['n'] == query_item['n'] && message_item['v'] == query_item['v']
+            next message_item['n'] == matcher_item['n'] && message_item['v'] == matcher_item['v']
           end
           next true
         end
@@ -41,8 +41,8 @@ module RSMP
     end
 
     # return a string that describes what we're collecting
-    def describe_query
-      "#{describe_num_and_type} #{ {component: @options[:component]}.merge(@query).compact }"
+    def describe_matcher
+      "#{describe_num_and_type} #{ {component: @options[:component]}.merge(@matcher).compact }"
     end
 
   end

data/lib/rsmp/collect/{alarm_query.rb → alarm_matcher.rb}

@@ -1,7 +1,7 @@
 module RSMP
   # Match a specific alarm
-  class AlarmQuery < Query
-    # Match an alarm value against a query
+  class AlarmMatcher < Matcher
+    # Match an alarm value against a matcher
     def match? item
       return false if @want['n'] && @want['n'] != item['n']
       if @want['v'].is_a? Regexp