rsmp 0.1.27 → 0.1.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bae0b092e316d3d2fd5297d6c7a36bbe84f80150dd093d101c0c49916f4b93ba
-  data.tar.gz: 3fb3f09d863c7309e0eae3c61f0a31e3068d5d80ad520f706c4ed437f2414e90
+  metadata.gz: c123985ef66b5f1a4b1676a01d07900d1a4ca365b93cc06a113bd0a7605679a9
+  data.tar.gz: 5df915ef9e4e6143281ab23ffc48127a71502784e4a132691be2463285762b22
 SHA512:
-  metadata.gz: 0ca10d29c54b8bcf3c7b359c78838b03f64c50b90c988d1cf2390bf392bad26570b7618045409a8b182df1cbcecd4c820be3ab535a47211c3149bdbcc9ccaab7
-  data.tar.gz: de933522e4f50fbd861bac067e803e56cad258903ab4a654ee7f994fc0d7c34150c6d70c55f8350e0e73a38e70673db9111bff4a2086b42628a85a71edf50b9b
+  metadata.gz: 8989828fa898324ce2b5dc9b0d0de2bd90ddc0ff5276ac768ae09526e3adf0728de67e87b01554f7374b25aed5884201367e4368efbaf37b3d594e4958c8ce3e
+  data.tar.gz: 2fd22365257c3f2595fb3329cd047feaa87b9d52aa335232a3126023414bf5859950a11d778d0e8b2a6983644475c95173aa8ec0886b3018850ae156a98c6063

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.1.27)
+    rsmp (0.1.29)
       async (~> 1.28.7)
       async-io (~> 1.30.2)
       colorize (~> 0.8.1)

data/config/supervisor.yaml

@@ -1,23 +1,12 @@
 port: 12111
-rsmp_versions:
-  - 3.1.1
-  - 3.1.2
-  - 3.1.3
-  - 3.1.4
-  - 3.1.5
-
-sites:
-  :any:
-    sxl: tlc
-
-watchdog_interval: 0.1
-watchdog_timeout: 0.2
-acknowledgement_timeout: 0.2
-store_messages: false
-command_response_timeout: 0.1
-status_response_timeout: 0.1
-status_update_timeout: 0.1
-
+guest:
+  sxl: tlc
+  intervals:
+    timer: 0.1
+    watchdog: 0.1
+  timeouts:
+    watchdog: 0.2
+    acknowledgement: 0.2
 log:
   active: true
   color: true
@@ -33,4 +22,3 @@ log:
   json: true
   acknowledgements: false
   watchdogs: false
-

data/config/tlc.yaml

@@ -2,15 +2,8 @@ site_id: RN+SI0001
 supervisors:
   - ip: 127.0.0.1
     port: 12111
-
-# if you leave it out, all know version will be allowed
-#rsmp_versions:
-#  - 3.1.4
-#  - 3.1.5
-
 sxl: tlc
 sxl_version: 1.0.15
-
 components:
   main:
     TC:
@@ -26,15 +19,16 @@ components:
       plan: 'BBB1NB'
   detector_logic:
     DL1:
-watchdog_interval: 0.1
-watchdog_timeout: 0.2
-acknowledgement_timeout: 0.2
-reconnect_interval: 0.1
-
+intervals:
+  timer: 0.1
+  watchdog: 0.1
+  reconnect: 0.1
+timeouts:
+  watchdog: 0.2
+  acknowledgement: 0.2
 security_codes:
   1: '1111'
   2: '2222'
-
 log:
   active: true
   color: true
@@ -49,4 +43,3 @@ log:
   json: true
   acknowledgements: false
   watchdogs: false
-

data/lib/rsmp.rb

@@ -10,6 +10,7 @@ require 'json_schemer'
 require 'async/queue'
 
 require 'rsmp/rsmp'
+require 'rsmp/deep_merge'
 require 'rsmp/inspect'
 require 'rsmp/logging'
 require 'rsmp/wait'

data/lib/rsmp/cli.rb

@@ -31,11 +31,11 @@ module RSMP
 
       if options[:supervisors]
         options[:supervisors].split(',').each do |supervisor|
-          settings[:supervisors] ||= []
+          settings['supervisors'] ||= []
           ip, port = supervisor.split ':'
           ip = '127.0.0.1' if ip.empty?
           port = '12111' if port.empty?
-          settings[:supervisors] << {"ip"=>ip, "port"=>port}
+          settings['supervisors'] << {"ip"=>ip, "port"=>port}
         end
       end
 
@@ -61,6 +61,8 @@ module RSMP
       puts "Cannot start site: #{e}"
     rescue RSMP::Schemer::UnknownSchemaVersionError => e
       puts "Cannot start site: #{e}"
+    rescue Psych::SyntaxError => e
+      puts "Cannot read config file #{e}"
     end
 
     desc "supervisor", "Run RSMP supervisor"

data/lib/rsmp/deep_merge.rb

@@ -0,0 +1,11 @@
+class Hash 
+  def deep_merge(other_hash)
+    self.merge(other_hash) do |key, old, fresh|
+      if old.is_a?(Hash) && fresh.is_a?(Hash)
+        old.deep_merge(fresh)
+      else
+        fresh
+      end
+    end
+  end
+end

data/lib/rsmp/proxy.rb

@@ -22,10 +22,10 @@ module RSMP
       @port = options[:port]
       @connection_info = options[:info]
       @sxl = nil
+      @site_settings = nil  # can't pick until we know the site id
       initialize_distributor
 
-      prepare_collection options[:settings]['collect']
-
+      prepare_collection @settings['collect']
       clear
     end
 
@@ -144,14 +144,14 @@ module RSMP
     end
 
     def start_watchdog
-      log "Starting watchdog with interval #{@settings["watchdog_interval"]} seconds", level: :debug
+      log "Starting watchdog with interval #{@site_settings['intervals']['watchdog']} seconds", level: :debug
       send_watchdog
       @watchdog_started = true
     end
 
     def start_timer
       name = "timer"
-      interval = @settings["timer_interval"] || 1
+      interval = @site_settings['intervals']['timer'] || 1
       log "Starting #{name} with interval #{interval} seconds", level: :debug
       @latest_watchdog_received = Clock.now
 
@@ -189,7 +189,7 @@ module RSMP
 
     def watchdog_send_timer now
       return unless @watchdog_started  
-      return if @settings["watchdog_interval"] == :never
+      return if @site_settings['intervals']['watchdog'] == :never
       
       if @latest_watchdog_send_at == nil
         send_watchdog now
@@ -197,7 +197,7 @@ module RSMP
         # we add half the timer interval to pick the timer
         # event closes to the wanted wathcdog interval
         diff = now - @latest_watchdog_send_at
-        if (diff + 0.5*@settings["timer_interval"]) >= (@settings["watchdog_interval"])
+        if (diff + 0.5*@site_settings['intervals']['timer']) >= (@site_settings['intervals']['watchdog'])
           send_watchdog now
         end
       end
@@ -210,7 +210,7 @@ module RSMP
     end
 
     def check_ack_timeout now
-      timeout = @settings["acknowledgement_timeout"]
+      timeout = @site_settings['timeouts']['acknowledgement']
       # hash cannot be modify during iteration, so clone it
       @awaiting_acknowledgement.clone.each_pair do |m_id, message|
         latest = message.timestamp + timeout
@@ -222,7 +222,7 @@ module RSMP
     end
 
     def check_watchdog_timeout now
-      timeout = @settings["watchdog_timeout"]
+      timeout = @site_settings['timeouts']['watchdog']
       latest = @latest_watchdog_received + timeout
       left = latest - now
       if left < 0
@@ -360,13 +360,20 @@ module RSMP
       dont_acknowledge message, "Received", "extraneous Version message"
     end
 
+    def rsmp_versions
+      return ['3.1.5'] if @site_settings["rsmp_versions"] == 'latest'
+      return ['3.1.1','3.1.2','3.1.3','3.1.4','3.1.5'] if @site_settings["rsmp_versions"] == 'all'
+      @site_settings["rsmp_versions"]
+    end
+
     def check_rsmp_version message
+      versions = rsmp_versions
       # find versions that both we and the client support
-      candidates = message.versions & @settings["rsmp_versions"]
+      candidates = message.versions & versions
       if candidates.any?
         @rsmp_version = candidates.sort_by { |v| Gem::Version.new(v) }.last  # pick latest version
       else
-        raise FatalError.new "RSMP versions [#{message.versions.join(',')}] requested, but only [#{@settings["rsmp_versions"].join(',')}] supported."
+        raise FatalError.new "RSMP versions [#{message.versions.join(',')}] requested, but only [#{versions.join(',')}] supported."
       end
     end
 
@@ -410,7 +417,15 @@ module RSMP
     end
 
     def send_version site_id, rsmp_versions
-      versions_array = [rsmp_versions].flatten.map {|v| {"vers" => v} }
+      if rsmp_versions=='latest'
+        versions = ['3.1.5']
+      elsif rsmp_versions=='all'
+        versions = ['3.1.1','3.1.2','3.1.3','3.1.4','3.1.5']
+      else
+        versions = [rsmp_versions].flatten
+      end
+      versions_array = versions.map {|v| {"vers" => v} }
+
       site_id_array = [site_id].flatten.map {|id| {"sId" => id} }
 
       version_response = Version.new({

data/lib/rsmp/site.rb

@@ -20,42 +20,33 @@ module RSMP
       @site_settings['site_id']
     end
 
-    def handle_site_settings options
-      @site_settings = {
+    def handle_site_settings options={}
+      defaults = {
         'site_id' => 'RN+SI0001',
         'supervisors' => [
           { 'ip' => '127.0.0.1', 'port' => 12111 }
         ],
-        'rsmp_versions' => ['3.1.1','3.1.2','3.1.3','3.1.4','3.1.5'],
+        'rsmp_versions' => 'all',
         'sxl' => 'tlc',
         'sxl_version' => '1.0.15',
-        'timer_interval' => 0.1,
-        'watchdog_interval' => 1,
-        'watchdog_timeout' => 2,
-        'acknowledgement_timeout' => 2,
-        'command_response_timeout' => 1,
-        'status_response_timeout' => 1,
-        'status_update_timeout' => 1,
-        'site_connect_timeout' => 2,
-        'site_ready_timeout' => 1,
-        'reconnect_interval' => 0.1,
+        'intervals' => {
+          'timer_' => 0.1,
+          'watchdog' => 1,
+          'reconnect' => 0.1
+        },
+        'timeouts' => {
+          'watchdog' => 2,
+          'acknowledgement' => 2
+        },
         'send_after_connect' => true,
         'components' => {
           'C1' => {}
         }
       }
-      if options[:site_settings]
-        converted = options[:site_settings].map { |k,v| [k.to_s,v] }.to_h   #convert symbol keys to string keys
-        converted.compact!
-        @site_settings.merge! converted
-      end
-
-      required = [:supervisors,:rsmp_versions,:site_id,:watchdog_interval,:watchdog_timeout,
-                  :acknowledgement_timeout,:command_response_timeout]
-      check_required_settings @site_settings, required
-
+      
+      @site_settings = defaults.deep_merge options[:site_settings]
+      pp @site_settings
       check_sxl_version
-
       setup_components @site_settings['components']
     end
 
@@ -115,10 +106,10 @@ module RSMP
         notify_error e, level: :internal
       ensure
         begin
-          if @site_settings["reconnect_interval"] != :no
+          if @site_settings['intervals']['watchdog'] != :no
             # sleep until waken by reconnect() or the reconnect interval passed
             proxy.set_state :wait_for_reconnect
-            task.with_timeout(@site_settings["reconnect_interval"]) do
+            task.with_timeout(@site_settings['intervals']['watchdog']) do
               @sleep_condition.wait
             end
           else

data/lib/rsmp/site_proxy.rb

@@ -36,7 +36,7 @@ module RSMP
 
     def connection_complete
       super
-      log "Connection to site #{@site_id} established, using core #{@rsmp_version}, sxl #{@sxl} #{@site_sxl_version}", level: :info
+      log "Connection to site #{@site_id} established, using core #{@rsmp_version}, #{@sxl} #{@site_sxl_version}", level: :info
     end
 
     def process_message message
@@ -73,21 +73,10 @@ module RSMP
     end
 
     def version_accepted message
-      if @settings['sites']
-        @site_settings = @settings['sites'][@site_id]
-        @site_settings = @settings['sites'][:any] unless @site_settings
-        if @site_settings
-          @sxl = @site_settings['sxl']
-          setup_components @site_settings['components']
-        else
-          dont_acknowledge message, 'Rejected', "No config found for site #{@site_id}"
-        end
-      end
-
       log "Received Version message for site #{@site_id}", message: message, level: :log
       start_timer
       acknowledge message
-      send_version @site_id, @settings['rsmp_versions']
+      send_version @site_id, rsmp_versions
       @version_determined = true
 
     end
@@ -309,7 +298,7 @@ module RSMP
     end
 
     def set_watchdog_interval interval
-      @settings["watchdog_interval"] = interval
+      @settings['intervals']['watchdog'] = interval
     end
 
     def check_sxl_version message
@@ -347,9 +336,35 @@ module RSMP
       site_id = message.attribute("siteId").map { |item| item["sId"] }.first
       @supervisor.check_site_id site_id
       @site_id = site_id
+      setup_site_settings
       site_ids_changed
     end
 
+    def find_site_settings site_id
+      if @settings['sites'] && @settings['sites'][@site_id]
+        log "Using site settings for site id #{@site_id}", level: :debug
+        return @settings['sites'][@site_id]
+      end
+
+      settings = @settings['guest']
+      if @settings['guest']
+        log "Using site settings for guest", level: :debug
+        return @settings['guest']
+      end
+  
+      nil
+    end
+
+    def setup_site_settings
+      @site_settings = find_site_settings @site_id
+      if @site_settings
+        @sxl = @site_settings['sxl']
+        setup_components @site_settings['components']
+      else
+        dont_acknowledge message, 'Rejected', "No config found for site #{@site_id}"
+      end
+    end
+
     def notify_error e, options={}
       @supervisor.notify_error e, options if @supervisor
     end

data/lib/rsmp/supervisor.rb

@@ -17,55 +17,45 @@ module RSMP
       @supervisor_settings['site_id']
     end
 
-    def handle_supervisor_settings options
-      @supervisor_settings = {
+    def handle_supervisor_settings options={}
+      defaults = {
         'port' => 12111,
-        'rsmp_versions' => ['3.1.1','3.1.2','3.1.3','3.1.4','3.1.5'],
-        'timer_interval' => 0.1,
-        'watchdog_interval' => 1,
-        'watchdog_timeout' => 2,
-        'acknowledgement_timeout' => 2,
-        'command_response_timeout' => 1,
-        'status_response_timeout' => 1,
-        'status_update_timeout' => 1,
-        'site_connect_timeout' => 2,
-        'site_ready_timeout' => 1,
-        'stop_after_first_session' => false,
-        'sites' => {
-          :any => {
-            'sxl' => 'tlc'
+        'ips' => 'all',
+        'guest' => {
+          'rsmp_versions' => 'all',
+          'sxl' => 'tlc',
+          'intervals' => {
+            'timer' => 1,
+            'watchdog' => 1
+          },
+          'timeouts' => {
+            'watchdog' => 2,
+            'acknowledgement' => 2
           }
         }
       }
-      
-      if options[:supervisor_settings]
-        converted = options[:supervisor_settings].map { |k,v| [k.to_s,v] }.to_h   #convert symbol keys to string keys
-        converted.compact!
-        @supervisor_settings.merge! converted
-      end
-
-      required = [:port, :rsmp_versions, :watchdog_interval, :watchdog_timeout,
-                  :acknowledgement_timeout, :command_response_timeout]
-      check_required_settings @supervisor_settings, required
 
+      # merge options into defaults
+      @supervisor_settings = defaults.deep_merge(options[:supervisor_settings] || {})
       @rsmp_versions = @supervisor_settings["rsmp_versions"]
-
       check_site_sxl_types
     end
 
     def check_site_sxl_types
-      @supervisor_settings['sites'].each do |ip,settings|
+      sites = @supervisor_settings['sites'].clone || {}
+      sites['guest'] = @supervisor_settings['guest']
+      sites.each do |site_id,settings|
         unless settings
-          raise RSMP::ConfigurationError.new("Configuration for site '#{ip}' is empty")
+          raise RSMP::ConfigurationError.new("Configuration for site '#{site_id}' is empty")
         end
         sxl = settings['sxl']
         sxl = 'tlc' unless sxl    # temporary fix until configs are updated
         unless sxl
-          raise RSMP::ConfigurationError.new("Configuration error for site '#{ip}': No SXL specified")
+          raise RSMP::ConfigurationError.new("Configuration error for site '#{site_id}': No SXL specified")
         end
         RSMP::Schemer.find_schemas! sxl if sxl
       rescue RSMP::Schemer::UnknownSchemaError => e
-        raise RSMP::ConfigurationError.new("Configuration error for site '#{ip}': #{e}")
+        raise RSMP::ConfigurationError.new("Configuration error for site '#{site_id}': #{e}")
       end
     end
 
@@ -101,7 +91,8 @@ module RSMP
         reject socket, info
       end
     rescue ConnectionError => e
-      log "Rejected connection from #{remote_ip}, #{e.to_s}", level: :info
+      log "Rejected connection from #{remote_ip}:#{remote_port}, #{e.to_s}", level: :warning
+      notify_error e
     rescue StandardError => e
       log "Connection: #{e.to_s}", exception: e, level: :error
       notify_error e, level: :internal
@@ -131,6 +122,21 @@ module RSMP
       end
     end
 
+    def authorize_ip ip
+      return if @supervisor_settings['ips'] == 'all'
+      return if @supervisor_settings['ips'].include? ip
+      raise ConnectionError.new('guest ip not allowed')
+    end
+
+    def check_max_sites
+      max = @supervisor_settings['max_sites']
+      if max
+        if @proxies.size >= max
+          raise ConnectionError.new("maximum of #{max} sites already connected")
+        end
+      end
+    end
+
     def connect socket, info
       log "Site connected from #{format_ip_and_port(info)}",
           ip: info[:ip],
@@ -138,15 +144,15 @@ module RSMP
           level: :info,
           timestamp: Clock.now
 
-      settings = ip_to_site_settings info[:ip]
-      raise ConnectionError.new('unknown ip not allowed') unless settings
+      authorize_ip info[:ip]
+      check_max_sites
 
       proxy = build_proxy({
         supervisor: self,
         ip: info[:ip],
         port: info[:port],
         task: @task,
-        settings: settings,
+        settings: {'collect'=>@supervisor_settings['collect']},
         socket: socket,
         info: info,
         logger: @logger,
@@ -158,7 +164,7 @@ module RSMP
       @proxies.delete proxy
       site_ids_changed
 
-      stop if @supervisor_settings['stop_after_first_session']
+      stop if @supervisor_settings['one_shot']
     end
 
     def site_ids_changed
@@ -195,36 +201,36 @@ module RSMP
       return site if site
       wait_for(@site_id_condition,timeout) { find_site site_id }
     rescue Async::TimeoutError
-      raise RSMP::TimeoutError.new "Site '#{site_id}'' did not connect within #{timeout}s"
+      raise RSMP::TimeoutError.new "Site '#{site_id}' did not connect within #{timeout}s"
     end
 
     def wait_for_site_disconnect site_id, timeout
       wait_for(@site_id_condition,timeout) { true unless find_site site_id }
     rescue Async::TimeoutError
-      raise RSMP::TimeoutError.new "Site '#{site_id}'' did not disconnect within #{timeout}s"
+      raise RSMP::TimeoutError.new "Site '#{site_id}' did not disconnect within #{timeout}s"
     end
 
     def check_site_id site_id
       check_site_already_connected site_id
-      return find_allowed_site_setting site_id
+      return site_id_to_site_setting site_id
     end
 
     def check_site_already_connected site_id
-      raise FatalError.new "Site '#{site_id}'' already connected" if find_site(site_id)
+      raise FatalError.new "Site '#{site_id}' already connected" if find_site(site_id)
     end
 
-    def find_allowed_site_setting site_id
+    def site_id_to_site_setting site_id
       return {} unless @supervisor_settings['sites']
       @supervisor_settings['sites'].each_pair do |id,settings|
-        if id == :any || id == site_id
+        if id == 'guest' || id == site_id
           return settings
         end
       end
-      raise FatalError.new "site id #{site_id} rejected"
+      raise FatalError.new "site id #{site_id} unknown"
     end
 
     def ip_to_site_settings ip
-      @supervisor_settings['sites'][ip] || @supervisor_settings['sites'][:any]
+      @supervisor_settings['sites'][ip] || @supervisor_settings['sites']['guest']
     end
 
     def aggregated_status_changed site_proxy, component

data/lib/rsmp/supervisor_proxy.rb

@@ -32,8 +32,8 @@ module RSMP
       send_version @site_settings['site_id'], @site_settings["rsmp_versions"]
     rescue Errno::ECONNREFUSED
       log "No connection to supervisor at #{@ip}:#{@port}", level: :error
-      unless @site.site_settings["reconnect_interval"] == :no
-        log "Will try to reconnect again every #{@site.site_settings["reconnect_interval"]} seconds..", level: :info
+      unless @site.site_settings['intervals']['reconnect'] == :no
+        log "Will try to reconnect again every #{@site.site_settings['intervals']['reconnect']} seconds..", level: :info
         @logger.mute @ip, @port
       end
     end
@@ -110,7 +110,7 @@ module RSMP
     end
 
     def reconnect_delay
-      interval = @site_settings["reconnect_interval"]
+      interval = @site_settings['intervals']['watchdog']
       log "Waiting #{interval} seconds before trying to reconnect", level: :info
       @task.sleep interval
     end

data/lib/rsmp/tlc.rb

@@ -88,7 +88,11 @@ module RSMP
     end
 
     def format_signal_group_status
-      @signal_groups.map { |group| group.state }.join
+      if @yellow_flash
+        'c' * @signal_groups.size
+      else
+        @signal_groups.map { |group| group.state }.join
+      end
     end
 
     def handle_command command_code, arg

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.1.27"
+  VERSION = "0.1.29"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.1.27
+  version: 0.1.29
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-19 00:00:00.000000000 Z
+date: 2021-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -197,7 +197,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- config/site.yaml
 - config/supervisor.yaml
 - config/tlc.yaml
 - documentation/classes_and_modules.md
@@ -212,6 +211,7 @@ files:
 - lib/rsmp/components.rb
 - lib/rsmp/convert/export/json_schema.rb
 - lib/rsmp/convert/import/yaml.rb
+- lib/rsmp/deep_merge.rb
 - lib/rsmp/error.rb
 - lib/rsmp/inspect.rb
 - lib/rsmp/listener.rb

data/config/site.yaml

@@ -1,40 +0,0 @@
-site_id: RN+SI0001
-supervisors:
-  - ip: 127.0.0.1
-    port: 12111
-
-sxl: traffic_light_controller
-
-rsmp_versions:
-  - 3.1.1
-  - 3.1.2
-  - 3.1.3
-  - 3.1.4
-
-components:
-  main:
-    C1:
-
-watchdog_interval: 1
-watchdog_timeout: 2
-acknowledgement_timeout: 1
-command_response_timeout: 1
-status_response_timeout: 1
-status_update_timeout: 1
-reconnect_interval: 0.1
-
-log:
-  active: true
-  color: true
-  timestamp: true
-  id: true
-  component: true
-  ip: false
-  site_id: true
-  level: false
-  text: true
-  direction: true
-  json: true
-  acknowledgements: false
-  watchdogs: false
-