rsmp 0.43.2 → 0.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ac8dcc5eb14943b0e14c10eb9e6f4c5a42fde921d9db9d05b0a390b4019ecf6
-  data.tar.gz: 9ef754b98f86317516078a6ce1f263ae82f5f7a697e68ef5fbf50c0976016f47
+  metadata.gz: 9c85b2875cd3f63dfb4d146d1a3d4718f666444d4773eb6a2b8feb21bd309030
+  data.tar.gz: f7492b775476f78362c8317bb76f4a76eefd8720afc8657c705bb23991e24fec
 SHA512:
-  metadata.gz: bd8ca1c5aabffa57015ff7519af57349e40044681dae5765d8e5144e49fef4305ecb688bbb9e271ee14c85b80364ba8111263cab41cf73c82fe4ef4540ad4d49
-  data.tar.gz: 3b44d60f188df7a54087c8baf3ae56592d3187d348aef3a2f01ecd156802078b59727071a6055da77680700373c0dff7364e0f2c0a0aab958c437f747a508f2e
+  metadata.gz: 4cf58cbf2d93df79e9accef572eb767dcac614499c8aec296369d9e63e57dffe0f387c28906d537bc60d1008dda823e58ab132f9c65c06d2e7e0fb069d3c687a
+  data.tar.gz: '096b1798a92696a5d1db4859d90cdee8b3fd9a3ac3c75028988ed4deb698c7f18b1d1d368f85173ae1c9093f45652c45ba9a800536dfa760dbd4eb7ce67427c5'

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    rsmp (0.43.2)
-      async (~> 2.32)
+    rsmp (0.45.0)
+      async (~> 2.39)
       colorize (~> 1.1)
-      io-endpoint (~> 0.15)
-      io-stream (~> 0.10)
+      io-endpoint (~> 0.17)
+      io-stream (~> 0.13)
       json_schemer (~> 2.5)
-      logger (~> 1.6)
+      logger (~> 1.7)
       ostruct (~> 0.6)
       thor (~> 1.5)
 
@@ -31,7 +31,7 @@ GEM
     bigdecimal (4.1.2)
     builder (3.3.0)
     colorize (1.1.0)
-    console (1.35.1)
+    console (1.36.0)
       fiber-annotation
       fiber-local (~> 1.1)
       json
@@ -82,7 +82,7 @@ GEM
       prism (>= 1.3.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.19.7)
+    json (2.19.8)
     json_schemer (2.5.0)
       bigdecimal
       hana (~> 1.3)
@@ -104,7 +104,7 @@ GEM
       prettyprint
     prettyprint (0.2.0)
     prism (1.9.0)
-    psych (5.3.1)
+    psych (5.4.0)
       date
       stringio
     racc (1.8.1)
@@ -121,7 +121,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.86.2)
+    rubocop (1.87.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -141,7 +141,7 @@ GEM
     ruby-progressbar (1.13.0)
     simpleidn (0.2.3)
     stringio (3.2.0)
-    sus (0.36.0)
+    sus (0.37.0)
     sus-fixtures-async (0.2.0)
       async
       sus (~> 0.10)
@@ -181,4 +181,4 @@ DEPENDENCIES
   timecop (~> 0.9)
 
 BUNDLED WITH
-  4.0.3
+  4.0.13

data/README.md

@@ -4,7 +4,7 @@ This is a Ruby implementation of the RSMP protocol, including:
  - Command-line tools for quickly running RSMP supervisors or sites and view messages exchanged
 
 ## Installation
-You need a recent version of Ruby intalled. 2.6.3 or later is recommended.
+You need a recent version of Ruby intalled. 4.0.5 or later is recommended.
 
 Install required gems:
 
@@ -124,7 +124,24 @@ RN+SU0001     RN+SI0001     -->  f8c7  Received Version message for sites [RN+SI
 ```
 
 ### JSON Schema validation
-All messages sent and received will be validated against the core [RSMP JSON Schema](https://github.com/rsmp-nordic/rsmp_schema).
+All messages sent and received are validated against the copied RSMP JSON Schemas maintained in
+`rsmp_core`.
+
+Core and SXL schemas are selected with a flat map:
+
+```ruby
+RSMP::Schema.validate(message, {
+  core: '3.3.0',
+  tlc: '1.3.0'
+})
+```
+
+Sites and supervisors configure one or more SXLs with `sxls`:
+
+```yaml
+sxls:
+  tlc: '1.3.0'
+```
 
 ## Command-line tool
 Tools for easily running RSMP supervisors and sites. The binary is called ```rsmp```.
@@ -198,4 +215,3 @@ Feature: Run site
 28 steps (28 passed)
 0m7.036s
 ```
-

data/Rakefile

@@ -4,8 +4,8 @@ task :test do
   sh 'bundle exec sus'
 end
 
-CORE_VERSIONS = %w[3.1.2 3.1.3 3.1.4 3.1.5 3.2.0 3.2.1 3.2.2].freeze
-TLC_VERSIONS  = %w[1.0.7 1.0.8 1.0.9 1.0.10 1.0.13 1.0.14 1.0.15 1.1.0 1.2.0 1.2.1].freeze
+CORE_VERSIONS = %w[3.1.2 3.1.3 3.1.4 3.1.5 3.2.0 3.2.1 3.2.2 3.3.0].freeze
+TLC_VERSIONS  = %w[1.0.7 1.0.8 1.0.9 1.0.10 1.0.13 1.0.14 1.0.15 1.1.0 1.2.0 1.2.1 1.3.0].freeze
 
 # Update vendored schemas from source repos.
 # Usage: rake schemas:update[/path/to/rsmp_core,/path/to/rsmp_sxl_traffic_lights]

data/config/supervisor.yaml

@@ -1,6 +1,7 @@
 port: 12111
 default:
-  sxl: tlc
+  sxls:
+    tlc: '1.2.1'
   intervals:
     timer: 0.1
     watchdog: 0.1

data/config/tlc.yaml

@@ -2,8 +2,8 @@ site_id: RN+SI0001
 supervisors:
   - ip: 127.0.0.1
     port: 12111
-sxl: tlc
-sxl_version: '1.2.1'
+sxls:
+  tlc: '1.2.1'
 components:
   main:
     TC:

data/lib/rsmp/cli.rb

@@ -75,7 +75,7 @@ module RSMP
         return [settings, log_settings] unless options[:config]
 
         begin
-          options_object = RSMP::Site::Options.load_file(options[:config])
+          options_object = site_options_class.load_file(options[:config])
           settings = options_object.to_h
           log_settings = log_settings.deep_merge(options_object.log_settings)
         rescue RSMP::ConfigurationError => e
@@ -89,6 +89,15 @@ module RSMP
 
     private
 
+    def site_options_class
+      case site_type
+      when 'tlc'
+        RSMP::TLC::TrafficControllerSite::Options
+      else
+        RSMP::Site::Options
+      end
+    end
+
     def apply_site_options(settings, log_settings)
       apply_basic_site_options(settings)
       parse_supervisors(settings) if options[:supervisors]
@@ -98,7 +107,19 @@ module RSMP
     def apply_basic_site_options(settings)
       settings['site_id'] = options[:id] if options[:id]
       settings['core_version'] = options[:core] || ENV['CORE_VERSION'] if options[:core] || ENV['CORE_VERSION']
-      settings['sxl_version'] = ENV['SXL_VERSION'] if ENV['SXL_VERSION']
+      settings['sxls'] = parse_sxls(ENV['SXLS']) if ENV['SXLS']
+    end
+
+    def parse_sxls(value)
+      value.split(',').each_with_object({}) do |item, memo|
+        parts = item.split(':')
+        unless parts.length == 2
+          raise RSMP::ConfigurationError, "Invalid SXLS item #{item.inspect}, expected name:version"
+        end
+
+        name, version = parts
+        memo[name] = version
+      end
     end
 
     def parse_supervisors(settings)
@@ -112,16 +133,19 @@ module RSMP
     end
 
     def determine_site_class(settings)
-      site_type = options[:type] || settings['type']
-      case site_type
+      case site_type(settings)
       when 'tlc'
         RSMP::TLC::TrafficControllerSite
       else
-        puts "Error: Unknown site type #{site_type}"
+        puts "Error: Unknown site type #{site_type(settings)}"
         exit
       end
     end
 
+    def site_type(settings = nil)
+      options[:type] || settings&.fetch('type', nil)
+    end
+
     def run_site(site_class, settings, log_settings)
       Async do |task|
         task.annotate 'cli'

data/lib/rsmp/component/component.rb

@@ -1,10 +1,6 @@
 module RSMP
   # RSMP component
   class Component < ComponentBase
-    def initialize(node:, id:, ntsoid: nil, xnid: nil, grouped: false)
-      super
-    end
-
     def handle_command(command_code, _arg)
       raise UnknownCommand, "Command #{command_code} not implemented by #{self.class}"
     end

data/lib/rsmp/component/component_base.rb

@@ -1,7 +1,7 @@
 module RSMP
   # RSMP component base class.
   class ComponentBase
-    attr_reader :c_id, :ntsoid, :xnid, :node, :alarms, :statuses,
+    attr_reader :c_id, :component_type, :name, :ntsoid, :xnid, :node, :alarms, :statuses,
                 :aggregated_status, :aggregated_status_bools, :grouped
 
     AGGREGATED_STATUS_KEYS = %i[local_control
@@ -13,13 +13,21 @@ module RSMP
                                 rest
                                 not_connected].freeze
 
-    def initialize(node:, id:, ntsoid: nil, xnid: nil, grouped: false)
+    def initialize(node:, id:, **attributes)
+      type = attributes[:type]
+      name = attributes[:name]
+      ntsoid = attributes[:ntsoid]
+      xnid = attributes[:xnid]
+      grouped = attributes.fetch(:grouped, false)
+
       if grouped == false && (ntsoid || xnid)
         raise RSMP::ConfigurationError,
               'ntsoid and xnid are only allowed for grouped objects'
       end
 
       @c_id = id
+      @component_type = type
+      @name = name || id
       @ntsoid = ntsoid
       @xnid = xnid
       @node = node
@@ -32,6 +40,11 @@ module RSMP
       "#<#{self.class.name}:#{object_id}:#{object_id} c_id:#{@c_id}>"
     end
 
+    def update_metadata(type: nil, name: nil)
+      @component_type = type if type
+      @name = name if name
+    end
+
     def now
       node.now
     end

data/lib/rsmp/component/component_proxy.rb

@@ -1,7 +1,7 @@
 module RSMP
   # A proxy to a remote RSMP component.
   class ComponentProxy < ComponentBase
-    def initialize(node:, id:, ntsoid: nil, xnid: nil, grouped: false)
+    def initialize(node:, id:, **attributes)
       super
       @alarms = {}
       @statuses = {}

data/lib/rsmp/component/components.rb

@@ -19,7 +19,12 @@ module RSMP
 
         components_by_type.each_pair do |id, component_settings|
           component_settings ||= {}
-          @components[id] = build_component(id: id, type: type, settings: component_settings)
+          component = build_component(id: id, type: type, settings: component_settings)
+          component.update_metadata(
+            type: component_settings['type'] || type,
+            name: component_settings['name'] || id
+          )
+          @components[id] = component
           @main = @components[id] if type == 'main'
         end
       end
@@ -36,6 +41,22 @@ module RSMP
       @components[component.c_id] = component
     end
 
+    def natural_sort_key(value)
+      value.to_s.split(/(\d+)/).map do |part|
+        part.match?(/\A\d+\z/) ? part.to_i : part
+      end
+    end
+
+    def component_list
+      @components.values.sort_by { |component| natural_sort_key(component.c_id) }.map do |component|
+        {
+          'id' => component.c_id,
+          'type' => component.component_type || 'component',
+          'name' => component.name || component.c_id
+        }
+      end
+    end
+
     def infer_component_type(component_id)
       raise UnknownComponent, "Component #{component_id} mising and cannot infer type"
     end

data/lib/rsmp/convert/export/json_schema/outputs.rb

@@ -112,6 +112,7 @@ module RSMP
             'version' => meta['version'],
             'allOf' => root_type_rules
           }
+          json['prefix'] = meta['prefix'] if meta['prefix']
           out['rsmp.json'] = output_json json
         end
 

data/lib/rsmp/convert/export/json_schema/values.rb

@@ -7,7 +7,7 @@ module RSMP
         def self.build_value(item)
           out = {}
           out['description'] = item['description'] if item['description']
-          if item['type'] =~ /_list$/
+          if item['type'] =~ /_list(_as_string)?$/
             handle_string_list item, out
           else
             handle_types item, out
@@ -59,11 +59,13 @@ module RSMP
         # convert a yaml item with list: true to json schema
         def self.handle_string_list(item, out)
           case item['type']
-          when 'boolean_list'
+          when 'boolean_list', 'boolean_list_as_string'
             out['$ref'] = '../defs/definitions.json#/boolean_list'
-          when 'integer_list'
+          when 'integer_list', 'integer_list_as_string'
             out['$ref'] = '../defs/definitions.json#/integer_list'
-          when 'string_list'
+          when 'number_list', 'number_list_as_string'
+            out['$ref'] = '../defs/definitions.json#/number_list'
+          when 'string_list', 'string_list_as_string'
             out['$ref'] = '../defs/definitions.json#/string_list'
           else
             raise "Error: List of #{item['type']} is not supported: #{item.inspect}"

data/lib/rsmp/convert/export/json_schema.rb

@@ -26,8 +26,11 @@ module RSMP
           JSON.generate(item, JSON_OPTIONS)
         end
 
-        # Default path to definitions.json bundled with the gem's core schemas
-        DEFINITIONS_SOURCE = File.expand_path('../../../../schemas/core/3.1.2/definitions.json', __dir__)
+        # Path to definitions.json for the latest bundled core schema version
+        def self.definitions_source
+          version = RSMP::Schema.latest_core_version
+          File.expand_path("../../../../schemas/core/#{version}/definitions.json", __dir__)
+        end
 
         # generate the json schema from a string containing yaml
         def self.generate(sxl)
@@ -50,7 +53,8 @@ module RSMP
           # Copy definitions.json so each version folder is self-contained
           defs_dest = File.join(folder, 'defs', 'definitions.json')
           FileUtils.mkdir_p File.dirname(defs_dest)
-          FileUtils.cp DEFINITIONS_SOURCE, defs_dest if File.exist?(DEFINITIONS_SOURCE)
+          source = definitions_source
+          FileUtils.cp source, defs_dest if File.exist?(source)
         end
       end
     end

data/lib/rsmp/helpers/deep_merge.rb

@@ -3,8 +3,8 @@ class Hash
   def deep_merge(other_hash)
     return self unless other_hash
 
-    merge(other_hash) do |_key, old, fresh|
-      if old.is_a?(Hash) && fresh.is_a?(Hash)
+    merge(other_hash) do |key, old, fresh|
+      if key != 'sxls' && old.is_a?(Hash) && fresh.is_a?(Hash)
         old.deep_merge(fresh)
       else
         fresh

data/lib/rsmp/message.rb

@@ -30,6 +30,7 @@ module RSMP
         'MessageAck' => MessageAck,
         'MessageNotAck' => MessageNotAck,
         'Version' => Version,
+        'ComponentList' => ComponentList,
         'AggregatedStatus' => AggregatedStatus,
         'AggregatedStatusRequest' => AggregatedStatusRequest,
         'Watchdog' => Watchdog,
@@ -216,6 +217,37 @@ module RSMP
     def versions
       attribute('RSMP').map { |item| item['vers'] }
     end
+
+    def step
+      @attributes['step']
+    end
+
+    def request?
+      step == 'Request'
+    end
+
+    def response?
+      step == 'Response'
+    end
+
+    def sxls
+      (@attributes['SXLS'] || []).map do |item|
+        item.transform_keys(&:to_s)
+      end
+    end
+
+    def site_ids
+      attribute('siteId').map { |item| item['sId'] }
+    end
+  end
+
+  # ComponentList message, lists site components and their component types.
+  class ComponentList < Message
+    def initialize(attributes = {})
+      super({
+        'type' => 'ComponentList'
+      }.merge attributes)
+    end
   end
 
   # Unknown message type wrapper.

data/lib/rsmp/node/site/site.rb

@@ -19,8 +19,16 @@ module RSMP
       build_proxies
     end
 
+    def sxls
+      @site_settings['sxls']
+    end
+
+    def primary_sxl
+      sxls.first
+    end
+
     def sxl_version
-      @site_settings['sxl_version']
+      primary_sxl && primary_sxl['version']
     end
 
     def site_id
@@ -30,18 +38,34 @@ module RSMP
     def handle_site_settings(options = {})
       options_class = self.class.options_class
       settings = options[:site_settings] || {}
+      settings = denormalize_sxls(settings)
       @site_options = options_class.new(settings)
       @site_settings = @site_options.to_h
 
-      check_sxl_version
+      check_sxls
       check_core_versions
       setup_components @site_settings['components']
     end
 
-    def check_sxl_version
-      sxl = @site_settings['sxl']
-      version = @site_settings['sxl_version'].to_s
-      RSMP::Schema.find_schema! sxl, version, lenient: true
+    def denormalize_sxls(settings)
+      sxls = settings['sxls']
+      return settings unless sxls.is_a?(Array)
+
+      settings.merge(
+        'sxls' => sxls.to_h { |sxl| [sxl['name'], sxl['version']] }
+      )
+    end
+
+    def check_sxls
+      raise RSMP::ConfigurationError, 'No SXLs specified' unless sxls
+
+      sxls.each do |sxl|
+        name = sxl['name']
+        version = sxl['version'].to_s
+        raise RSMP::ConfigurationError, 'SXL name cannot be core' if name.to_s == 'core'
+
+        RSMP::Schema.find_schema! name, version, lenient: true
+      end
     end
 
     def check_core_versions
@@ -60,7 +84,7 @@ module RSMP
 
     def log_site_starting
       log "Starting #{site_type_name} #{@site_settings['site_id']}", level: :info, timestamp: @clock.now
-      sxl = "Using #{@site_settings['sxl']} sxl #{@site_settings['sxl_version']}"
+      sxl = "Using SXLs #{sxls.map { |item| "#{item['name']} #{item['version']}" }.join(', ')}"
       version = @site_settings['core_version']
       core = if version
                "accepting only core version #{version}"
@@ -113,7 +137,7 @@ module RSMP
 
     def send_alarm(alarm)
       @proxies.each do |proxy|
-        proxy.send_message alarm if proxy.ready?
+        proxy.send_message alarm if proxy.ready? && proxy.receive_alarms?
       end
     end
 
@@ -158,10 +182,10 @@ module RSMP
     def build_component(id:, type:, settings:)
       settings ||= {}
       if type == 'main'
-        Component.new id: id, node: self, grouped: true,
+        Component.new id: id, node: self, type: type, name: settings['name'], grouped: true,
                       ntsoid: settings['ntsOId'], xnid: settings['xNId']
       else
-        Component.new id: id, node: self, grouped: false
+        Component.new id: id, node: self, type: type, name: settings['name'], grouped: false
       end
     end
   end

data/lib/rsmp/node/supervisor/modules/configuration.rb

@@ -4,22 +4,49 @@ module RSMP
       # Handles supervisor configuration and site settings
       module Configuration
         def handle_supervisor_settings(supervisor_settings)
+          supervisor_settings = denormalize_supervisor_sxls(supervisor_settings || {})
           options = RSMP::Supervisor::Options.new(supervisor_settings || {})
           @supervisor_settings = options.to_h
           @core_version = @supervisor_settings.dig('default', 'core_version')
-          check_site_sxl_types
+          check_site_sxls
         end
 
-        def check_site_sxl_types
+        def denormalize_supervisor_sxls(settings)
+          settings = settings.merge('default' => denormalize_site_sxls(settings['default'])) if settings['default']
+          return settings unless settings['sites']
+
+          settings.merge(
+            'sites' => settings['sites'].transform_values { |site_settings| denormalize_site_sxls(site_settings) }
+          )
+        end
+
+        def denormalize_site_sxls(settings)
+          sxls = settings['sxls']
+          return settings unless sxls.is_a?(Array)
+
+          settings.merge(
+            'sxls' => sxls.to_h { |sxl| [sxl['name'], sxl['version']] }
+          )
+        end
+
+        def check_site_sxls
           sites = @supervisor_settings['sites'].clone || {}
           sites['default'] = @supervisor_settings['default']
           sites.each do |site_id, settings|
             raise RSMP::ConfigurationError, "Configuration for site '#{site_id}' is empty" unless settings
 
-            sxl = settings['sxl']
-            raise RSMP::ConfigurationError, "Configuration error for site '#{site_id}': No SXL specified" unless sxl
+            sxls = settings['sxls']
+            raise RSMP::ConfigurationError, "Configuration error for site '#{site_id}': No SXLs specified" unless sxls
+
+            sxls.each do |sxl|
+              name = sxl['name']
+              if name.to_s == 'core'
+                raise RSMP::ConfigurationError,
+                      "Configuration error for site '#{site_id}': SXL name cannot be core"
+              end
 
-            RSMP::Schema.find_schemas! sxl if sxl
+              RSMP::Schema.find_schema! name, sxl['version'], lenient: true
+            end
           rescue RSMP::Schema::UnknownSchemaError => e
             raise RSMP::ConfigurationError, "Configuration error for site '#{site_id}': #{e}"
           end

data/lib/rsmp/node/supervisor/modules/connection.rb

@@ -128,8 +128,6 @@ module RSMP
           stop if @supervisor_settings['one_shot']
         end
 
-        # Proxy type is now derived from `site_settings['sxl']` in Supervisor#build_proxy.
-
         def reject_connection(_socket, info)
           log 'Site rejected', ip: info[:ip], level: :info
         end

data/lib/rsmp/node/supervisor/supervisor.rb

@@ -59,13 +59,6 @@ module RSMP
     end
 
     def build_proxy(settings)
-      # Determine proxy type from site settings (SXL). Fall back to supervisor
-      # default settings when site-specific settings are not present.
-      site_settings = settings[:site_settings] || @supervisor_settings['default']
-      sxl_type = site_settings && site_settings['sxl']
-
-      return RSMP::TLC::TrafficControllerProxy.new(settings) if sxl_type == 'tlc'
-
       SiteProxy.new settings
     end