rsmp 0.12.2 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34c922ce1e22f31aabc3b476f1aa3d9a6eeaa4b89e4550255f237c5f5810b4e8
-  data.tar.gz: 95590c49d1ba70af34dfd913808239cea39b5dae0324003deb921c21a0bf0aa2
+  metadata.gz: c1840c079564613302ef539e2c0a502c2cafdabe8c875ab2dfb3b389470becf8
+  data.tar.gz: 35eda6efcfabe4624ba58d5150b3c1263a34a2a0b1f363b1a704566acc65cfed
 SHA512:
-  metadata.gz: 3d1c8bfd469ae45764292bf3e2615bf95b1904229d34c2df0eb18ad496a7d1b6ecfd0aeff594f07a0bbf59c34d7b6247fc566e1a94d65412f78719e3f4f42b1b
-  data.tar.gz: 66edc8044373bca92cc52641f49c78f3336d4e5c6caa8615a8da05aad6176d8e2c6161a5d835716fe7feac38948a059b4de6ec1f772de3c1f992d8c7f76bc8e0
+  metadata.gz: 32c6bb82731643e24000e2056a19896fa591755b1336ccad74df28b82ee9800cdb16ee96e6d6e1996e09137fa22cfed5c64801d8b131953a4abc94d32ba9ab08
+  data.tar.gz: d588d1e92eb16473ee86e25e0a595d6bd03c4744f113860bbe89be6f3c3df6ab19bb522daea617f28e8b32708a048d4a2895700cda8de34fed6fd986de85c6a4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.12.2)
+    rsmp (0.13.1)
       async (~> 1.29.1)
       async-io (~> 1.32.2)
       colorize (~> 0.8.1)
@@ -68,7 +68,7 @@ GEM
     ffi (1.15.5-x64-mingw32)
     fiber-local (1.0.0)
     hana (1.3.7)
-    json_schemer (0.2.19)
+    json_schemer (0.2.20)
       ecma-re-validator (~> 0.3)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
@@ -79,8 +79,8 @@ GEM
     multi_test (0.1.2)
     nio4r (2.5.8)
     rake (13.0.6)
-    regexp_parser (2.2.1)
-    rsmp_schemer (0.3.2)
+    regexp_parser (2.3.1)
+    rsmp_schemer (0.4.0)
       json_schemer (~> 0.2.18)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)

data/lib/rsmp/alarm_state.rb

@@ -1,33 +1,94 @@
 module RSMP
   # class that tracks the state of an alarm
   class AlarmState
-    attr_reader :component_id, :code, :acknowledged, :suspended, :active, :timestamp, :category, :priority
+    attr_reader :component_id, :code, :acknowledged, :suspended, :active, :timestamp, :category, :priority, :rvs
 
-    def initialize component_id:, code:
-      @component_id = component_id
+    def initialize component:, code:
+      @component = component
+      @component_id = component.c_id
       @code = code
+      @suspended = false
       @acknowledged = false
       @suspended = false
       @active = false
       @timestamp = nil
-      @category = nil
-      @priority = nil
+      @category = 'D'
+      @priority = 2
+      @rvs = []
     end
 
     def suspend
-      @suspended = true
+      change, @suspended = !@suspended, true
+      update_timestamp if change
+      change
     end
 
     def resume
-      @suspended = false
+      change, @suspended = @suspended, false
+      update_timestamp if change
+      change
     end
 
     def activate
-      @active = true
+      change, @active = !@active, true
+      update_timestamp if change
+      change
     end
 
     def deactivate
-      @active = false
+      change, @active = @active, false
+      update_timestamp if change
+      change
+    end
+    
+    def update_timestamp
+      @timestamp = @component.node.clock.now
+    end
+
+    def to_message specialization:
+      Alarm.new(
+        'cId' => @component_id,
+        'aSp' => specialization,
+        'aCId' => @code,
+        'aTs' => Clock.to_s(@timestamp),
+        'ack' => (@acknowledged ? 'Acknowledged' : 'notAcknowledged'),
+        'sS' => (@suspended ? 'suspended' : 'notSuspended'),
+        'aS' => (@active ? 'Active' : 'inActive'),
+        'cat' => @category,
+        'pri' => @priority.to_s,
+        'rvs' => @rvs
+      )
     end
+
+    def differ_from_message? message
+      return true if @timestamp != message.attribute('aTs')
+      return true if message.attribute('ack') && @acknowledged != (message.attribute('ack') == 'True')
+      return true if message.attribute('sS') && @suspended != (message.attribute('sS') == 'True')
+      return true if message.attribute('aS') && @active != (message.attribute('aS') == 'True')
+      return true if message.attribute('cat') && @category != message.attribute('cat')
+      return true if message.attribute('pri') && @priority != message.attribute('pri').to_i
+      #return true @rvs = message.attribute('rvs')
+      false
+    end
+
+    # update from rsmp message
+    # component id, alarm code and specialization are not updated
+    def update_from_message message
+      unless differ_from_message? message
+        raise RepeatedAlarmError.new("no changes from previous alarm #{message.m_id_short}")
+      end
+      if Time.parse(message.attribute('aTs')) < Time.parse(message.attribute('aTs'))
+        raise TimestampError.new("timestamp is earlier than previous alarm #{message.m_id_short}")
+      end
+    ensure
+      @timestamp = message.attribute('aTs')
+      @acknowledged = message.attribute('ack') == 'True'
+      @suspended = message.attribute('sS') == 'True'
+      @active = message.attribute('aS') == 'True'
+      @category = message.attribute('cat')
+      @priority = message.attribute('pri').to_i
+      @rvs = message.attribute('rvs')
+    end
+
   end
 end

data/lib/rsmp/component.rb

@@ -1,7 +1,5 @@
 module RSMP
-
   # RSMP component
-
   class Component < ComponentBase
     def initialize node:, id:, grouped: false
       super
@@ -15,40 +13,38 @@ module RSMP
       raise UnknownStatus.new "Status #{status_code}/#{status_name} not implemented by #{self.class}"
     end
 
-    def get_alarm_state alarm_code
-      alarm = @alarms[alarm_code] ||= RSMP::AlarmState.new component_id: c_id, code: alarm_code
-    end
-
     def suspend_alarm alarm_code
       alarm = get_alarm_state alarm_code
-      return if alarm.suspended
-      log "Suspending alarm #{alarm_code}", level: :info
-      alarm.suspend
-      @node.alarm_changed alarm
+      if alarm.suspend
+        log "Suspending alarm #{alarm_code}", level: :info
+        @node.alarm_suspended_or_resumed alarm
+      else
+        log "Alarm #{alarm_code} already suspended", level: :info
+      end       
     end
 
     def resume_alarm alarm_code
       alarm = get_alarm_state alarm_code
-      return unless alarm.suspended
-      log "Resuming alarm #{alarm_code}", level: :info
-      alarm.resume
-      @node.alarm_changed alarm
+      if alarm.resume
+        log "Resuming alarm #{alarm_code}", level: :info
+        @node.alarm_suspended_or_resumed alarm
+      else
+        log "Alarm #{alarm_code} already resumed", level: :info
+      end
     end
 
     def activate_alarm alarm_code
       alarm = get_alarm_state alarm_code
-      return if alarm.active
+      return unless alarm.activate
       log "Activating alarm #{alarm_code}", level: :info
-      alarm.activate
-      @node.alarm_changed alarm
+      @node.alarm_activated_or_deactivated alarm
     end
 
     def deactivate_alarm alarm_code
       alarm = get_alarm_state alarm_code
-      return unless alarm.active
+      return unless alarm.deactivate
       log "Deactivating alarm #{alarm_code}", level: :info
-      alarm.deactivate
-      @node.alarm_changed alarm
+      @node.alarm_activated_or_deactivated alarm
     end
   end
 end

data/lib/rsmp/component_base.rb

@@ -20,8 +20,12 @@ module RSMP
       @c_id = id
       @node = node
       @grouped = grouped
-      @alarms = {}
       clear_aggregated_status
+      @alarms = {}
+    end
+
+    def get_alarm_state alarm_code
+      alarm = @alarms[alarm_code] ||= RSMP::AlarmState.new component: self, code: alarm_code
     end
 
     def clear_aggregated_status

data/lib/rsmp/component_proxy.rb

@@ -1,10 +1,9 @@
 module RSMP
-
   # A proxy to a remote RSMP component.
-
   class ComponentProxy < ComponentBase
     def initialize node:, id:, grouped: false
       super
+      @alarms = {}
       @statuses = {}
       @allow_repeat_updates = {}
     end
@@ -45,23 +44,12 @@ module RSMP
         @allow_repeat_updates[sCI].delete(n) if @allow_repeat_updates[sCI]
       end
     end
- 
+
     # handle incoming alarm
     def handle_alarm message
-#      code = message.attribute('aCId')
-#      previous = @alarms[code]
-#      if previous
-#        unless message.differ?(previous)
-#          raise RepeatedAlarmError.new("no changes from previous alarm #{previous.m_id_short}")
-#        end
-#        if Time.parse(message.attribute('aTs')) < Time.parse(previous.attribute('aTs'))
-#          raise TimestampError.new("timestamp is earlier than previous alarm #{previous.m_id_short}")
-#        end
-#      end
-#      p message
-#    ensure
-#      @alarms[code] = message
+      code = message.attribute('aCId')
+      alarm = get_alarm_state code
+      alarm.update_from_message message
     end
-
- end
+  end
 end

data/lib/rsmp/message.rb

@@ -68,7 +68,13 @@ module RSMP
       when /Acknowledge/i
         AlarmAcknowledged.new attributes
       when /Suspend/i
-        AlarmSuspend.new attributes
+        if attributes['sS'] =~ /suspended/i
+          AlarmSuspended.new attributes
+        elsif attributes['sS'] =~ /notSuspended/i
+          AlarmResumed.new attributes
+        else
+          AlarmSuspend.new attributes
+        end
       when /Resume/i
         AlarmResume.new attributes
       else
@@ -264,7 +270,23 @@ module RSMP
     end
   end
 
+  class AlarmSuspended < Alarm
+    def initialize attributes = {}
+      super({
+        "aSp" => "Suspend",
+        "sS" => "suspended"
+      }.merge attributes)
+    end
+  end
 
+  class AlarmResumed < Alarm
+    def initialize attributes = {}
+      super({
+        "aSp" => "Suspend",
+        "sS" => "notSuspended"
+      }.merge attributes)
+    end
+  end
 
   class Watchdog < Message
     def initialize attributes = {}

data/lib/rsmp/site.rb

@@ -93,23 +93,31 @@ module RSMP
       end
     end
 
-    def alarm_state_to_message alarm_state
-      Alarm.new(
+    def alarm_state_to_hash alarm_state
+      {
         'cId' => alarm_state.component_id,
-        'aTs' => clock.to_s,
         'aCId' => alarm_state.code,
-        'aSp' => (alarm_state.suspended ? 'Suspend' : 'Issue'),
+        'aTs' => Clock.to_s(alarm_state.timestamp),
         'ack' => (alarm_state.acknowledged ? 'Acknowledged' : 'notAcknowledged'),
         'sS' => (alarm_state.suspended ? 'suspended' : 'notSuspended'),
         'aS' => (alarm_state.active ? 'Active' : 'inActive'),
-        'cat' => (alarm_state.category || 'D'),
-        'pri' => (alarm_state.priority || '2'),
-        'rvs' => []
-      )
+        'cat' => alarm_state.category,
+        'pri' => alarm_state.priority.to_s,
+        'rvs' => alarm_state.rvs
+      }
+    end
+
+    def alarm_suspended_or_resumed alarm_state
+      alarm = AlarmIssue.new( alarm_state_to_hash(alarm_state).merge('aSp' => 'Suspend') )
+      send_alarm alarm
+    end
+
+    def alarm_activated_or_deactivated alarm_state
+      alarm = AlarmIssue.new( alarm_state_to_hash(alarm_state).merge('aSp' => 'Issue') )
+      send_alarm alarm
     end
 
-    def alarm_changed alarm_state
-      alarm = alarm_state_to_message alarm_state
+    def send_alarm alarm
       @proxies.each do |proxy|
         proxy.send_message alarm if proxy.ready?
       end

data/lib/rsmp/site_proxy.rb

@@ -63,7 +63,7 @@ module RSMP
           process_aggregated_status message
         when AggregatedStatusRequest
           will_not_handle message
-        when Alarm
+        when AlarmIssue, AlarmSuspended, AlarmResumed
           process_alarm message
         when CommandResponse
           process_command_response message
@@ -116,8 +116,8 @@ module RSMP
       m_id = options[:m_id] || RSMP::Message.make_m_id
 
       message = RSMP::AggregatedStatusRequest.new({
-          "ntsOId" => '',
-          "xNId" => '',
+          "ntsOId" => @ntsOId,
+          "xNId" => @xNId,
           "cId" => component,
           "mId" => m_id
       })
@@ -187,8 +187,8 @@ module RSMP
       request_list = status_list.map { |item| item.slice('sCI','n') }
 
       message = RSMP::StatusRequest.new({
-          "ntsOId" => '',
-          "xNId" => '',
+          "ntsOId" => @ntsOId,
+          "xNId" => @xNId,
           "cId" => component,
           "sS" => request_list,
           "mId" => m_id
@@ -232,8 +232,8 @@ module RSMP
       component.allow_repeat_updates subscribe_list
 
       message = RSMP::StatusSubscribe.new({
-          "ntsOId" => '',
-          "xNId" => '',
+          "ntsOId" => @ntsOId,
+          "xNId" => @xNId,
           "cId" => component_id,
           "sS" => subscribe_list,
           'mId' => m_id
@@ -262,8 +262,8 @@ module RSMP
       end
 
       message = RSMP::StatusUnsubscribe.new({
-        "ntsOId" => '',
-        "xNId" => '',
+        "ntsOId" => @ntsOId,
+        "xNId" => @xNId,
         "cId" => component_id,
         "sS" => status_list
       })
@@ -292,8 +292,8 @@ module RSMP
       validate_ready 'send command'
       m_id = options[:m_id] || RSMP::Message.make_m_id
       message = RSMP::CommandRequest.new({
-          "ntsOId" => '',
-          "xNId" => '',
+          "ntsOId" => @ntsOId,
+          "xNId" => @xNId,
           "cId" => component,
           "arg" => command_list,
           "mId" => m_id
@@ -369,6 +369,8 @@ module RSMP
       @site_settings = find_site_settings @site_id
       if @site_settings
         @sxl = @site_settings['sxl']
+        @ntsOId = @site_settings['ntsOId']
+        @xNId = @site_settings['xNId']
         setup_components @site_settings['components']
       else
         dont_acknowledge message, 'Rejected', "No config found for site #{@site_id}"

data/lib/rsmp/supervisor_proxy.rb

@@ -15,6 +15,8 @@ module RSMP
       @port = options[:port]
       @status_subscriptions = {}
       @sxl = @site_settings['sxl']
+      @ntsOId = @site_settings['ntsOId']
+      @xNId = @site_settings['xNId']
       @synthetic_id = Supervisor.build_id_from_ip_port @ip, @port
     end
 
@@ -105,7 +107,7 @@ module RSMP
         process_status_subcribe message
       when StatusUnsubscribe
         process_status_unsubcribe message
-      when AlarmAcknowledged, AlarmSuspend, AlarmResume, AlarmRequest
+      when Alarm, AlarmAcknowledged, AlarmSuspend, AlarmResume, AlarmRequest
         process_alarm message
       else
         super message
@@ -160,6 +162,8 @@ module RSMP
         "se" => component.aggregated_status_bools,
         "mId" => m_id,
       })
+      message.attributes['ntsOId'] = @site_settings['ntsOId'] if @site_settings['ntsOId']
+      message.attributes['xNId'] = @site_settings['xNId'] if @site_settings['xNId']
 
       send_and_optionally_collect message, options do |collect_options|
         Collector.new self, collect_options.merge(task:@task, type: 'MessageAck')

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.12.2"
+  VERSION = "0.13.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.13.1
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-01 00:00:00.000000000 Z
+date: 2022-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async