rsmp 0.3.1 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a19b3e748ae4dff7c8f652f7015d8f0b798f78a3d8f07c545638724308f4c819
-  data.tar.gz: 8353a6b756fa36f45b0c9e8cf33d56cb96f69ef30ab158ebf34ea2cc8a863122
+  metadata.gz: d22d8796a378484c9c7a9d50b3bc48386db2e12893c5af07a1ef83825d2f1b0e
+  data.tar.gz: ee6a4ebb4fcf094cb45e1f541e6f228e6ea9c3364fca6e1526e4fe46026751f2
 SHA512:
-  metadata.gz: 23fb75e6bad681f67be2f04038a6bebec458c5e6e5c29ee5d5333dc5583b490ba8e1841e5304a88a384ac4761edea45818848f2144a97e73a31dbe2ca89090ed
-  data.tar.gz: cc37d48a622961d41444631cb3543967ccbd926dfcf1314a45294c676270977272e842853a5e1f59a08f1706b26dd85a2494aaea1a12b5dced4917dbaaee9015
+  metadata.gz: a1a495ba2c110ebb42db60596516de255b9c9a9cb903fdd66bf77bd27a3f5d5b786b273436b522af3dbf57e983651676b9a9e67aee7387ba134ef89812261618
+  data.tar.gz: 21f2e48b596dcca6296da89f687ec46d3845eaafb6cad497a16ac4fabca1cb5574da6df324256f4929b7207eeccd17697bd5021b328b4d265ff7d836d2a5e2c3

data/Gemfile.lock

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

data/lib/rsmp/component.rb

@@ -57,9 +57,6 @@ module RSMP
     def aggregated_status_changed options={}
       @node.aggregated_status_changed self, options
     end
- 
-    def alarm code:, status:
-    end
 
     def log str, options
       @node.log str, options
@@ -73,5 +70,18 @@ module RSMP
       raise UnknownStatus.new "Status #{status_code}/#{status_name} not implemented by #{self.class}"
     end
 
+    def handle_alarm message
+      code = message.attribute('aCId')
+      alarm = @alarms[code]
+      if alarm
+        if alarm.differ? message
+          @alarms[code] = alarm
+        else
+          raise RepeatedAlarmError.new("no changes from previous alarm #{alarm.m_id_short}")
+        end
+      else
+        @alarms[code] = message
+      end
+    end
   end
 end

data/lib/rsmp/components.rb

@@ -13,6 +13,7 @@ module RSMP
 
     def setup_components settings
       return unless settings
+      check_main_component settings
       settings.each_pair do |type,components_by_type|
         components_by_type.each_pair do |id,settings|
           @components[id] = build_component(id:id, type:type, settings:settings)
@@ -20,6 +21,15 @@ module RSMP
       end
     end
 
+    def check_main_component settings
+      unless settings['main'] && settings['main'].size >= 1
+        raise ConfigurationError.new("main component must be defined") 
+      end
+      if settings['main'].size > 1
+        raise ConfigurationError.new("only one main component can be defined, found #{settings['main'].keys.join(', ')}") 
+      end
+    end
+
     def add_component component
       @components[component.c_id] = component
     end

data/lib/rsmp/error.rb

@@ -52,4 +52,7 @@ module RSMP
 
 	class ConfigurationError < Error
 	end
+
+	class RepeatedAlarmError < Error
+	end
 end

data/lib/rsmp/message.rb

@@ -36,7 +36,7 @@ module RSMP
       when "Watchdog"
         message = Watchdog.new attributes
       when "Alarm"
-        message = Alarm.new attributes
+        message = self.build_alarm attributes
       when "CommandRequest"
         message = CommandRequest.new attributes
       when "CommandResponse"
@@ -59,6 +59,23 @@ module RSMP
       message
     end
 
+    def self.build_alarm attributes
+      case attributes["aSp"]
+      when 'Issue'
+        AlarmIssue.new attributes
+      when 'Request'
+        AlarmRequest.new attributes
+      when 'Acknowledge'
+        AlarmAcknowledged.new attributes
+      when 'Suspend'
+        AlarmSuspend.new attributes
+      when 'Resume'
+        AlarmResume.new attributes
+      else
+        Alarm.new attributes
+      end
+    end
+
     def type
       @attributes["type"]
     end
@@ -191,26 +208,64 @@ module RSMP
     def initialize attributes = {}
       super({
         "type" => "Alarm",
+        "ntsOId" => '',
+        "xNId" => '',
+        "xACId" => '',
+        "xNACId" => ''
       }.merge attributes)
     end
+
+    def differ? from
+      %w{aSp aCId ack aS sS aTs cat pri}.each do |key|
+        return true if attribute(key).downcase != from.attribute(key).downcase
+      end
+      return true if attribute('rvs') != from.attribute('rvs')
+      false
+    end
   end
 
-  class AlarmRequest < Message
+  class AlarmIssue < Alarm
     def initialize attributes = {}
       super({
-        "type" => "Alarm",
+        "aSp" => "Issue",
       }.merge attributes)
     end
   end
 
-  class AlarmAcknowledged < Message
+  class AlarmRequest < Alarm
     def initialize attributes = {}
       super({
-        "type" => "Alarm",
+        "aSp" => "Request",
+      }.merge attributes)
+    end
+  end
+
+  class AlarmAcknowledged < Alarm
+    def initialize attributes = {}
+      super({
+        "aSp" => "Acknowledge",
       }.merge attributes)
     end
   end
 
+  class AlarmSuspend < Alarm
+    def initialize attributes = {}
+      super({
+        "aSp" => "Suspend",
+      }.merge attributes)
+    end
+  end
+
+  class AlarmResume < Alarm
+    def initialize attributes = {}
+      super({
+        "aSp" => "Resume",
+      }.merge attributes)
+    end
+  end
+
+
+
   class Watchdog < Message
     def initialize attributes = {}
       super({

data/lib/rsmp/proxy.rb

@@ -73,6 +73,11 @@ module RSMP
       @state == :ready
     end
 
+    def connected?
+      @state == :starting || @state == :ready
+    end
+
+
     def start
       set_state :starting
     end
@@ -118,7 +123,6 @@ module RSMP
         task.annotate "reader"
         @stream ||= Async::IO::Stream.new(@socket)
         @protocol ||= Async::IO::Protocol::Line.new(@stream,WRAPPING_DELIMITER) # rsmp messages are json terminated with a form-feed
-
         while json = @protocol.read_line
           beginning = Time.now
           message = process_packet json
@@ -267,12 +271,13 @@ module RSMP
     end
 
     def send_message message, reason=nil, validate: true
+      raise NotReady unless connected?
       raise IOError unless @protocol
       message.direction = :out
       message.generate_json
       message.validate get_schemas unless validate==false
-      expect_acknowledgement message
       @protocol.write_lines message.json
+      expect_acknowledgement message
       notify message
       log_send message, reason
     rescue EOFError, IOError
@@ -302,10 +307,18 @@ module RSMP
       end
     end
 
+    def should_validate_ingoing_message? message
+      return true unless @site_settings
+      skip = @site_settings.dig('skip_validation')
+      return true unless skip
+      klass = message.class.name.split('::').last
+      !skip.include?(klass)
+    end
+
     def process_packet json
       attributes = Message.parse_attributes json
       message = Message.build attributes, json
-      message.validate get_schemas
+      message.validate(get_schemas) if should_validate_ingoing_message?(message)
       notify message
       expect_version_message(message) unless @version_determined
       process_message message

data/lib/rsmp/site.rb

@@ -46,7 +46,11 @@ module RSMP
           }
         }
       }
-      
+      # only one main component can be defined, so replace the default if options define one
+      if options.dig(:site_settings,'components','main')
+        defaults['components']['main'] = options[:site_settings]['components']['main']
+      end
+
       @site_settings = defaults.deep_merge options[:site_settings]
       check_sxl_version
       setup_components @site_settings['components']
@@ -79,7 +83,7 @@ module RSMP
 
     def aggregated_status_changed component, options={}
       @proxies.each do |proxy|
-        proxy.send_aggregated_status component, options
+        proxy.send_aggregated_status component, options if proxy.ready?
       end
     end
 

data/lib/rsmp/site_proxy.rb

@@ -148,11 +148,17 @@ module RSMP
     end
 
     def process_alarm message
+      component = find_component message.attribute("cId")
+      status = ["ack","aS","sS"].map { |key| message.attribute(key) }.join(',')
+      component.handle_alarm message
       alarm_code = message.attribute("aCId")
       asp = message.attribute("aSp")
-      status = ["ack","aS","sS"].map { |key| message.attribute(key) }.join(',')
       log "Received #{message.type}, #{alarm_code} #{asp} [#{status}]", message: message, level: :log
       acknowledge message
+    rescue RSMP::RepeatedAlarmError => e
+      str = "Rejected #{message.type} message, "
+      dont_acknowledge message, str, "#{e}"
+      notify_error e.exception("#{str}#{e.message} #{message.json}")
     end
 
     def version_acknowledged
@@ -241,13 +247,8 @@ module RSMP
 
     def send_alarm_acknowledgement component, alarm_code, options={}
       message = RSMP::AlarmAcknowledged.new({
-          "ntsOId" => '',
-          "xNId" => '',
           "cId" => component,
           "aCId" => alarm_code,
-          "xACId" => '',
-          "xNACId" => '',
-          "aSp" => 'Acknowledge'
       })
       send_message message, validate: options[:validate]
       message

data/lib/rsmp/supervisor_proxy.rb

@@ -363,16 +363,6 @@ module RSMP
       end
     end
 
-    def send_alarm
-      message = Alarm.new({
-        "aSTS"=>clock.to_s,
-        "fP"=>nil,
-        "fS"=>nil,
-        "se"=>@site.aggregated_status_bools
-      })
-      send_message message
-    end
-
     def sxl_version
       @site_settings['sxl_version']
     end

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.3.1"
+  VERSION = "0.3.5"
 end

data/lib/rsmp.rb

@@ -18,7 +18,6 @@ require 'rsmp/node'
 require 'rsmp/supervisor'
 require 'rsmp/components'
 require 'rsmp/notifier'
-
 require 'rsmp/listener'
 require 'rsmp/collector'
 require 'rsmp/matcher'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.5
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-18 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -203,7 +203,6 @@ files:
 - documentation/message_distribution.md
 - exe/rsmp
 - lib/rsmp.rb
-- lib/rsmp/alarm.rb
 - lib/rsmp/archive.rb
 - lib/rsmp/cli.rb
 - lib/rsmp/collector.rb

data/lib/rsmp/alarm.rb

@@ -1,15 +0,0 @@
-# RSMP Alarm. Manages the various states an alarm can be in.
-
-module RSMP
-  class Alarm
-
-    def initialize code: code, blocked: blocked=false, suspended: suspended=false, acknowledged: acknowledged=false
-      @code = code
-      @code = code
-      @blocked = blocked
-      @suspended = suspended
-      @acknowledged = acknowledged
-    end
-
-  end
-end