rsmp 0.1.17 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b583271d38fc35e2badabf94b0a8a764f07a8e36025c2902922d926adbf320b
-  data.tar.gz: 9e37dd8939d68a19e1cf16580c558c813e8a5d6214a733cc8dce08fe4957be59
+  metadata.gz: bfbb10fc77baf015a50f7ce94b2ee3b0830a09f8c083b9f0dfbb86fcd4285893
+  data.tar.gz: 8756ab6010d199fdc2e22973ab960156b66f000c7a8feacad201f5be5bb0ff08
 SHA512:
-  metadata.gz: 1af3ecb44fc6c9e9fa0735b524c1561eafd91ef05775c0be325c8093635354e535d9d8f024d05cbc256859319a13795dfff34233165b8b57c53ac82fb76dbbd5
-  data.tar.gz: aeaa068f63614bcd8e3af873400e5af54810c51e7a1941d62834c1bd2d94a3ff4ae62e59d89ad3242749fff54126aa3ccabf3bf3ac672f29c9cac9611ebddd47
+  metadata.gz: af59d9680e6717f8d0e89cae43e1a95aa17ad322c54024c4dae91bb8e58216d7fc57c727c3e1d56ac9c6770131f2197f6708cceba890b0b83867a493b410111e
+  data.tar.gz: 20597a90bc6c9abaf196ffba19d233fa76716c2febee7af2c0c057337953d40d77ac965a671716ed5e645fb93734265231def5104efc7a39a6e92fade86a5ce7

data/.gitignore

@@ -12,5 +12,6 @@ log
 /spec/reports/
 /tmp/
 /lib/rsmp_schema/
+/config/private/
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.1.17)
+    rsmp (0.1.19)
       async (~> 1.23.0)
       async-io (~> 1.27.4)
       colorize (~> 0.8.1)
@@ -22,13 +22,14 @@ GEM
       console (~> 1.0)
       nio4r (~> 2.3)
       timers (~> 4.1)
-    async-io (1.27.5)
+    async-io (1.27.7)
       async (~> 1.14)
     backports (3.17.0)
     builder (3.2.4)
     childprocess (3.0.0)
     colorize (0.8.1)
-    console (1.8.2)
+    console (1.10.1)
+      fiber-local
     contracts (0.16.0)
     cucumber (3.1.2)
       builder (>= 2.1.2)
@@ -47,21 +48,22 @@ GEM
     cucumber-tag_expressions (1.1.1)
     cucumber-wire (0.0.1)
     diff-lcs (1.3)
-    ecma-re-validator (0.2.0)
-      regexp_parser (~> 1.2)
+    ecma-re-validator (0.3.0)
+      regexp_parser (~> 2.0)
     ffi (1.12.2)
+    fiber-local (1.0.0)
     gherkin (5.1.0)
-    hana (1.3.5)
-    json_schemer (0.2.11)
-      ecma-re-validator (~> 0.2)
+    hana (1.3.7)
+    json_schemer (0.2.17)
+      ecma-re-validator (~> 0.3)
       hana (~> 1.3)
-      regexp_parser (~> 1.5)
+      regexp_parser (~> 2.0)
       uri_template (~> 0.7)
     multi_json (1.14.1)
     multi_test (0.1.2)
-    nio4r (2.5.2)
+    nio4r (2.5.4)
     rake (13.0.1)
-    regexp_parser (1.7.0)
+    regexp_parser (2.0.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -77,7 +79,7 @@ GEM
     rspec-support (3.9.2)
     thor (1.0.1)
     timecop (0.9.1)
-    timers (4.3.0)
+    timers (4.3.2)
     uri_template (0.7.0)
 
 PLATFORMS

data/README.md

@@ -178,7 +178,7 @@ Use ```--config <path>``` to point to a .yaml config file, controlling things li
 ### RSpec
 RSpec tests are located in spec/. The tests will start supervisor and sites to test communication, but will do so on port 13111, rather than the usual port 12111, to avoid inferference with other RMSP processes running locally.
 
-Note that these tests are NOT intented for testing external equipment or systems. The tests are for validating the code in this repository. To test external equipment or systems.
+Note that these tests are NOT intented for testing external equipment or systems. The tests are for validating the code in this repository. To test external equipment or systems use the rsmp_validator tool.
 
 ```console
 $ rspec

data/config/tlc.yaml

@@ -18,14 +18,15 @@ components:
       plan: 'BBB1NB'
   detector_logic:
     DL1:
-watchdog_interval: 1
-watchdog_timeout: 2
-acknowledgement_timeout: 1
-command_response_timeout: 1
-status_response_timeout: 1
-status_update_timeout: 1
+watchdog_interval: 0.1
+watchdog_timeout: 0.2
+acknowledgement_timeout: 0.2
 reconnect_interval: 0.1
 
+security_codes:
+  1: '1111'
+  2: '2222'
+
 log:
   active: true
   color: true

data/documentation/classes.md

@@ -0,0 +1,62 @@
+# Classes
+
+## Class tree:
+```
+
+		   .------ Base -------.
+		  /                     \
+	     /                       \
+	    / 	  SiteBase module     \
+	Node 	  /	 	        \ 	   Proxy
+	/   \    /	 	         \    /    \
+Super    Site             SiteProxy	    SupervisorProxy
+
+```
+
+
+## Base
+The Base class handle logging.
+
+Node and Site inherit from Base.
+
+## Node
+A Node has an async task. A node can be started and stopped.
+
+Node has two child classes: Site and Supervisor.
+
+## Site
+A Site represents an RSMP site, typically a traffic light, variable message sign, or other type of field equipment. An RSMP site can connect to one or more supervisors.
+
+A Site has one or more SupervisorProxies (connections to supervisor).
+
+A site has one of more components.
+
+## Supervisor 
+A Supervisor represents an RSMP supervisor, typically a central supervisor system. An RSMP supervisor can handle connections one or more sites.
+
+A Supervisor has one or more SiteProxies (connections to sites).
+
+## Proxy
+A Proxy represents a connection to a remove Site or Supervisor and handles the RSMP interface.
+
+A proxy has an async task listening for messages on an TCP/IP socket. Incoming RSMP messages are parsing and appropriate handles are called.
+
+A proxy also has a repaating async timer task for handling watchdog and acknowledgement timeouts.
+
+Proxy has to child classes: SiteProxy and SupervisorProxy.
+
+## SiteProxy
+A connection to a remote Site.
+
+Handles RSMP messaging specific to a supervisor, including methods for requesting status, sending commands, etc.
+
+A SiteProxy has one or more components, representing the components in the remote site.
+
+## Supervisor Proxy
+A connection to a remote Site. Handles RSMP messaging specific to a site, including sending aggregated status, handling status requests, status subscription and command requests.
+
+Status and command requests are delegated to the appropriate components.
+
+## SiteBase
+Things shared between Site and SiteProxy, mainly handling components.
+

data/lib/rsmp/archive.rb

@@ -6,6 +6,8 @@ module RSMP
     attr_reader :items
     attr_accessor :probes
 
+    @@index = 0
+
     def initialize
       @items = []
       @probes = ProbeCollection.new
@@ -27,6 +29,14 @@ module RSMP
       cleaned
     end
 
+    def self.increase_index
+      @@index += 1
+    end
+
+    def self.current_index
+      @@index
+    end
+
     def by_level levels
       items.select { |item| levels.include? item[:level] }
     end
@@ -35,12 +45,8 @@ module RSMP
       items.map { |item| item[:str] }
     end
 
-    def current_index
-      @items.size
-    end
-
     def add item
-      item[:index] = @items.size
+      item[:index] = RSMP::Archive.increase_index
       @items << item
       probe item
     end

data/lib/rsmp/component.rb

@@ -23,6 +23,7 @@ module RSMP
     def clear_aggregated_status
       @aggregated_status = []
       @aggregated_status_bools = Array.new(8,false)
+      @aggregated_status_bools[5] = true
     end
 
     def set_aggregated_status status

data/lib/rsmp/error.rb

@@ -23,7 +23,7 @@ module RSMP
 	class MissingWatchdog < Error
 	end
 
-	class MissingAcknowledgment < Error
+	class MessageRejected < Error
 	end
 
 	class MissingAttribute < InvalidMessage

data/lib/rsmp/message.rb

@@ -27,6 +27,9 @@ module RSMP
 
     @@schemas = load_schemas
 
+    def self.make_m_id
+      SecureRandom.uuid()
+    end
 
     def self.parse_attributes json
       raise ArgumentError unless json
@@ -80,8 +83,12 @@ module RSMP
       @attributes["mId"]
     end
 
+    def self.shorten_m_id m_id, length=4
+      m_id[0..length-1]
+    end
+
     def m_id_short
-      @attributes["mId"][0..3]
+      Message.shorten_m_id @attributes["mId"]
     end
 
     def attribute key
@@ -126,7 +133,7 @@ module RSMP
 
     def ensure_message_id
       # if message id is empty, generate a new one
-      @attributes["mId"] ||= SecureRandom.uuid()
+      @attributes["mId"] ||= Message.make_m_id
     end
 
     def validate sxl=nil
@@ -197,6 +204,22 @@ module RSMP
     end
   end
 
+  class AlarmRequest < Message
+    def initialize attributes = {}
+      super({
+        "type" => "Alarm",
+      }.merge attributes)
+    end
+  end
+
+  class AlarmAcknowledged < Message
+    def initialize attributes = {}
+      super({
+        "type" => "Alarm",
+      }.merge attributes)
+    end
+  end
+
   class Watchdog < Message
     def initialize attributes = {}
       super({

data/lib/rsmp/node.rb

@@ -5,19 +5,46 @@
 
 module RSMP
   class Node < Base
-    attr_reader :archive, :logger, :task
+    include Wait
+
+    attr_reader :archive, :logger, :task, :deferred
 
     def initialize options
       super options
+      @task = options[:task]
+      @deferred = []
+    end
+
+    def defer item
+      @deferred << item
+    end
+
+    def process_deferred
+      cloned = @deferred.clone    # clone in case do_deferred restarts the current task
+      @deferred.clear
+      cloned.each do |item|
+        do_deferred item
+      end
+    end
+
+    def do_deferred item
+    end
+
+    def do_start task
+      task.annotate self.class.to_s
+      @task = task
+      start_action
+      idle
     end
 
     def start
       starting
-      Async do |task|
-        task.annotate self.class
-        @task = task
-        start_action
-        idle
+      if @task
+        do_start @task
+      else
+        Async do |task|
+          do_start task
+        end
       end
     rescue Errno::EADDRINUSE => e
       log "Cannot start: #{e.to_s}", level: :error

data/lib/rsmp/probe.rb

@@ -6,22 +6,6 @@ module RSMP
   class Probe
     attr_reader :condition, :items, :done
 
-    # block should send a message and return message just sent
-    def self.collect_response proxy, options={}, &block
-      from = proxy.archive.current_index
-      sent = yield
-      raise RuntimeError unless sent && sent[:message].is_a?(RSMP::Message)
-      item = proxy.archive.capture(options.merge(from: from+1, num: 1, with_message: true)) do |item|
-        ["CommandResponse","StatusResponse","MessageNotAck"].include?(item[:message].type)
-      end
-      if item
-        item[:message] 
-      else
-        nil
-      end
-    end
-
-
     def initialize archive
       raise ArgumentError.new("Archive expected") unless archive.is_a? Archive
       @archive = archive
@@ -30,6 +14,7 @@ module RSMP
     end
 
     def capture task, options={}, &block
+      raise ArgumentError.new("timeout option is missing") unless options[:timeout]
       @options = options
       @block = block
       @num = options[:num]
@@ -37,8 +22,6 @@ module RSMP
       if options[:earliest]
         from = find_timestamp_index options[:earliest]
         backscan from
-      elsif options[:from]
-        backscan options[:from]
       end
 
       # if backscan didn't find enough items, then
@@ -62,6 +45,7 @@ module RSMP
     end
 
     def find_timestamp_index earliest
+      return 0 if earliest == :start
       (0..@archive.items.size).bsearch do |i|        # use binary search to find item index
         @archive.items[i][:timestamp] >= earliest
       end
@@ -105,6 +89,9 @@ module RSMP
       end
       return if @options[:level] && item[:level] != @options[:level]
       return false if @options[:with_message] && !(item[:direction] && item[:message])
+      if @options[:component]
+        return false if item[:message].attributes['cId'] && item[:message].attributes['cId'] != @options[:component]
+      end
       if @block
         return false if @block.call(item) == false
       end

data/lib/rsmp/proxy.rb

@@ -2,7 +2,9 @@
 
 module RSMP  
   class Proxy < Base
-    attr_reader :state, :archive, :connection_info, :sxl
+    include Wait
+
+    attr_reader :state, :archive, :connection_info, :sxl, :task
 
     def initialize options
       super options
@@ -18,7 +20,7 @@ module RSMP
     def run
       start
       @reader.wait if @reader
-      stop
+      stop unless [:stopped, :stopping].include? @state
     end
 
     def ready?
@@ -120,10 +122,22 @@ module RSMP
         task.annotate "timer"
         next_time = Time.now.to_f
         loop do
-          now = RSMP.now_object
-          break if timer(now) == false
-        rescue StandardError => e
-          log ["#{name} exception: #{e}",e.backtrace].flatten.join("\n"), level: :error
+          begin
+            now = RSMP.now_object
+            timer(now)
+          rescue EOFError => e
+            log "Timer: Connection closed: #{e}", level: :warning
+          rescue IOError => e
+            log "Timer: IOError", level: :warning
+          rescue Errno::ECONNRESET
+            log "Timer: Connection reset by peer", level: :warning
+          rescue Errno::EPIPE => e
+            log "Timer: Broken pipe", level: :warning
+          rescue StandardError => e
+            log "Error: #{e}", level: :debug
+          #rescue StandardError => e
+          #  log ["Timer error: #{e}",e.backtrace].flatten.join("\n"), level: :error
+          end
         ensure
           next_time += interval
           duration = next_time - Time.now.to_f
@@ -133,12 +147,12 @@ module RSMP
     end
 
     def timer now
-      check_watchdog_send_time now
-      return false if check_ack_timeout now
-      return false if check_watchdog_timeout now
+      watchdog_send_timer now
+      check_ack_timeout now
+      check_watchdog_timeout now
     end
 
-    def check_watchdog_send_time now
+    def watchdog_send_timer now
       return unless @watchdog_started  
       return if @settings["watchdog_interval"] == :never
       
@@ -152,8 +166,6 @@ module RSMP
           send_watchdog now
         end
       end
-    rescue StandardError => e
-      log ["Watchdog error: #{e}",e.backtrace].flatten.join("\n"), level: :error
     end
 
     def send_watchdog now=nil
@@ -171,24 +183,18 @@ module RSMP
         if now > latest
           log "No acknowledgements for #{message.type} #{message.m_id_short} within #{timeout} seconds", level: :error
           stop
-          return true
         end
       end
-      false
     end
 
     def check_watchdog_timeout now
-
       timeout = @settings["watchdog_timeout"]
       latest = @latest_watchdog_received + timeout
       left = latest - now
-      #log "Check watchdog, time:#{timeout}, last:#{@latest_watchdog_received}, now: #{now}, latest:#{latest}, left #{left}, fail:#{left<0}", level: :debug
       if left < 0
         log "No Watchdog within #{timeout} seconds", level: :error
         stop
-        return true
       end
-      false
     end
 
     def stop_tasks
@@ -216,7 +222,7 @@ module RSMP
 
     def buffer_message message
       # TODO
-      log "Cannot send #{message.type} because the connection is closed.", message: message, level: :error
+      #log "Cannot send #{message.type} because the connection is closed.", message: message, level: :error
     end
 
     def log_send message, reason=nil
@@ -239,12 +245,13 @@ module RSMP
       message.validate sxl
       expect_version_message(message) unless @version_determined
       process_message message
+      process_deferred
       message
     rescue InvalidPacket => e
-      warning "Received invalid package, must be valid JSON but got #{json.size} bytes: #{e.message}"
+      log "Received invalid package, must be valid JSON but got #{json.size} bytes: #{e.message}", level: :warning
       nil
     rescue MalformedMessage => e
-      warning "Received malformed message, #{e.message}", Malformed.new(attributes)
+      log "Received malformed message, #{e.message}", message: Malformed.new(attributes), level: :warning
       # cannot send NotAcknowledged for a malformed message since we can't read it, just ignore it
       nil
     rescue SchemaError => e
@@ -335,7 +342,7 @@ module RSMP
     def wait_for_state state, timeout
       states = [state].flatten
       return if states.include?(@state)
-      RSMP::Wait.wait_for(@task,@state_condition,timeout) do |s|
+      wait_for(@state_condition,timeout) do |s|
         states.include?(@state)
       end
       @state
@@ -445,27 +452,16 @@ module RSMP
     def version_acknowledged
     end
 
-    def wait_for_acknowledgement original, timeout, options={}
-      raise ArgumentError unless original
-      RSMP::Wait.wait_for(@task,@acknowledgement_condition,timeout) do |message|
-        message.is_a?(MessageAck) &&
-        message.attributes["oMId"] == original.m_id
-      end
-    end
-
-    def wait_for_not_acknowledged original, timeout
+    def wait_for_acknowledgement original, timeout
       raise ArgumentError unless original
-      RSMP::Wait.wait_for(@task,@acknowledgement_condition,timeout) do |message|
-        message.is_a?(MessageNotAck) &&
-        message.attributes["oMId"] == original.m_id
-      end
-    end
-
-    def wait_for_acknowledgements timeout
-      return if @awaiting_acknowledgement.empty?
-      RSMP::Wait.wait_for(@task,@acknowledgement_condition,timeout) do |message|
-        @awaiting_acknowledgement.empty?
+      wait_for(@acknowledgement_condition,timeout) do |message|
+        if message.is_a?(MessageNotAck) && message.attributes["oMId"] == original.m_id
+          raise RSMP::MessageRejected.new(message.attributes['rea'])
+        end
+        message.is_a?(MessageAck) && message.attributes["oMId"] == original.m_id
       end
+    rescue Async::TimeoutError
+      raise RSMP::TimeoutError.new("Acknowledgement for #{original.type} #{original.m_id} not received within #{timeout}s")
     end
 
     def node