rsmp-validator 0.1.0 → 0.3.2

data/lib/rsmp/validator/helpers/connection.rb

@@ -4,11 +4,11 @@ module RSMP
       # Helpers for connecting to a site or supervisor in tests, with optional
       # version-based skipping via sxl: and core: keyword arguments.
       #
-      # with_site(:connected, sxl: '>=1.2') do |supervisor, site_proxy|
+      # with_site(:connected, sxl: '>=1.2.0') do |supervisor, site_proxy|
       #   ...
       # end
       #
-      # with_supervisor(:connected, core: '>=3.2') do |site, supervisor_proxy|
+      # with_supervisor(:connected, core: '>=3.2.0') do |site, supervisor_proxy|
       #   ...
       # end
       module Connection
@@ -31,10 +31,10 @@ module RSMP
           else
             RSMP::Validator::SiteTester.public_send(state, **opts) do |_task, _node, proxy|
               block.call(proxy)
-            rescue RSMP::TimeoutError => e
-              @__assertions__.assert false, e.message
+            rescue RSMP::OperationError => e
+              fail_test e.failure.message
             rescue StandardError => e
-              @__assertions__.error!(UncaughtException.new(e))
+              error_test UncaughtException.new(e)
             end
           end
         end
@@ -47,16 +47,26 @@ module RSMP
           else
             RSMP::Validator::SupervisorTester.public_send(state, **opts) do |_task, _node, proxy|
               block.call(proxy)
-            rescue RSMP::TimeoutError => e
-              @__assertions__.assert false, e.message
+            rescue RSMP::OperationError => e
+              fail_test e.failure.message
             rescue StandardError => e
-              @__assertions__.error!(UncaughtException.new(e))
+              error_test UncaughtException.new(e)
             end
           end
         end
 
         private
 
+        def fail_test(message)
+          @__assertions__.assert false, message
+          throw :rsmp_validator_test_failure
+        end
+
+        def error_test(error)
+          @__assertions__.error! error
+          throw :rsmp_validator_test_failure
+        end
+
         def validate_state!(state)
           return if VALID_STATES.include?(state)
 

data/lib/rsmp/validator/helpers/handshake.rb

@@ -28,17 +28,14 @@ module RSMP
 
           RSMP::Validator::SiteTester.isolated(
             'collect' => { timeout: timeout, num: length, ingoing: true, outgoing: true },
-            'sites' => { 'default' => { 'rsmp_versions' => [core_version] } }
-          ) do |task, _supervisor, site|
+            'sites' => { 'default' => { 'core_version' => core_version } }
+          ) do |_task, _supervisor, site|
             assert(site.ready?, 'expected site to be ready')
             collector = site.collector
-            collector.use_task task
-            collector.wait!
-            got = collector.messages.map { |message| "#{message.direction}:#{message.type}" }
+            messages = collector.wait!
+            got = messages.map { |message| "#{message.direction}:#{message.type}" }
           end
           got
-        rescue Async::TimeoutError
-          raise "Did not collect #{length} messages within #{timeout}s"
         end
 
         def check_sequence_v311_to_v313(core_version)
@@ -96,7 +93,7 @@ module RSMP
           case version
           when '3.1.1', '3.1.2', '3.1.3'
             check_sequence_v311_to_v313 version
-          when '3.1.4', '3.1.5', '3.2', '3.2.1', '3.2.2'
+          when '3.1.4', '3.1.5', '3.2.0', '3.2.1', '3.2.2'
             check_sequence_v314_or_later version
           when '3.3.0'
             check_sequence_v330 version

data/lib/rsmp/validator/helpers/input.rb

@@ -6,7 +6,7 @@ module RSMP
         include Status
 
         def force_input_and_confirm(site_proxy, input:, value:, within:)
-          site_proxy.tlc.force_input(input:, status: 'True', value:, within:)
+          site_proxy.tlc.force_input!(input:, status: 'True', value:, within:)
           digit = (value == 'True' ? '1' : '0')
 
           wait_for_status(
@@ -19,7 +19,7 @@ module RSMP
         end
 
         def switch_input(site_proxy, indx, within:)
-          site_proxy.tlc.set_input(input: indx.to_s, status: 'True', within:)
+          site_proxy.tlc.set_input!(input: indx.to_s, status: 'True', within:)
 
           wait_for_status(
             site_proxy,
@@ -29,7 +29,7 @@ module RSMP
             ]
           )
 
-          site_proxy.tlc.set_input(input: indx.to_s, status: 'False', within:)
+          site_proxy.tlc.set_input!(input: indx.to_s, status: 'False', within:)
           wait_for_status(
             site_proxy,
             "input #{indx} to be False",

data/lib/rsmp/validator/helpers/security.rb

@@ -12,7 +12,7 @@ module RSMP
           component = RSMP::Validator.get_config('components', 'detector_logic').keys[0]
           timeout = RSMP::Validator.get_config('timeouts', 'command_response')
           site_proxy.send_command_and_collect(command_list, component: component,
-                                                            within: timeout).ok!
+                                                            within: timeout)
         end
 
         def require_security_codes

data/lib/rsmp/validator/helpers/signal_plans.rb

@@ -5,30 +5,30 @@ module RSMP
       module SignalPlans
         def with_cycle_time_extended(site_proxy, extension = 5, &block)
           timeout = RSMP::Validator.get_config('timeouts', 'command_response')
-          plan = site_proxy.tlc.read_current_plan
+          plan = site_proxy.tlc.read_current_plan!
           time = read_plan_cycle_time(site_proxy, plan)
           need_to_reset = true
           time_extended = time + extension
-          site_proxy.tlc.set_cycle_time(plan: plan, cycle_time: time_extended, within: timeout)
+          site_proxy.tlc.set_cycle_time!(plan: plan, cycle_time: time_extended, within: timeout)
           verify_cycle_time(site_proxy, plan, time_extended)
           block.yield
         ensure
           if need_to_reset
             log 'Reset cycle time'
-            site_proxy.tlc.set_cycle_time(plan: plan, cycle_time: time, within: timeout)
+            site_proxy.tlc.set_cycle_time!(plan: plan, cycle_time: time, within: timeout)
           end
         end
 
         private
 
         def read_plan_cycle_time(site_proxy, plan)
-          time = site_proxy.tlc.read_cycle_times[plan]
+          time = site_proxy.tlc.read_cycle_times![plan]
           assert(!time.nil?, 'Site returned empty cycle times list')
           time
         end
 
         def verify_cycle_time(site_proxy, plan, expected)
-          actual = site_proxy.tlc.read_cycle_times[plan]
+          actual = site_proxy.tlc.read_cycle_times![plan]
           assert(actual == expected, "Expected cycle time #{expected}, got #{actual}")
         end
       end

data/lib/rsmp/validator/helpers/signal_priority.rb

@@ -40,15 +40,14 @@ module RSMP
         class RequestHelper < RSMP::Queue
           include RSMP::Validator::Helpers::Status
 
-          def initialize(site_proxy, component:, signal_group_id:, timeout:, task:)
+          def initialize(site_proxy, component:, signal_group_id:, timeout:)
             super(site_proxy,
                   filter: RSMP::Filter.new(
                     type: 'StatusUpdate',
                     ingoing: true,
                     outgoing: false,
                     component: component
-                  ),
-                  task: task)
+                  ))
             @site_proxy = site_proxy
             @component = component
             @signal_group_id = signal_group_id
@@ -76,7 +75,7 @@ module RSMP
                                                  'level' => level,
                                                  'eta' => eta,
                                                  'vehicleType' => vehicle_type).to_a
-            @site_proxy.send_command(command_list, component: @component)
+            @site_proxy.send_command!(command_list, component: @component)
           end
 
           def request_unrelated(level: 7, eta: 2, vehicle_type: 'car')
@@ -87,21 +86,19 @@ module RSMP
                                                  'level' => level,
                                                  'eta' => eta,
                                                  'vehicleType' => vehicle_type).to_a
-            @site_proxy.send_command(command_list, component: @component)
+            @site_proxy.send_command!(command_list, component: @component)
           end
 
           def cancel
             command_list = RSMP::CommandList.new(:M0022, :requestPriority,
                                                  requestId: @request_id,
                                                  type: 'cancel').to_a
-            @site_proxy.send_command(command_list, component: @component)
+            @site_proxy.send_command!(command_list, component: @component)
           end
 
           def expect(state)
             @matcher.state = state
-            wait_for_message timeout: @timeout
-          rescue RSMP::TimeoutError
-            raise RSMP::TimeoutError, "Priority request did not reach state #{state} within #{@timeout}s"
+            wait_for_message!(timeout: @timeout)
           end
 
           private
@@ -112,11 +109,11 @@ module RSMP
 
           def start
             start_receiving
-            @site_proxy.subscribe_to_status @subscribe_list, component: @component
+            @site_proxy.subscribe_to_status! @subscribe_list, component: @component
           end
 
           def stop
-            @site_proxy.unsubscribe_to_status @unsubscribe_list, component: @component
+            @site_proxy.unsubscribe_to_status! @unsubscribe_list, component: @component
             stop_receiving
           end
 

data/lib/rsmp/validator/helpers/startup.rb

@@ -83,7 +83,7 @@ module RSMP
         end
 
         def wait_normal_control(site_proxy, timeout: RSMP::Validator.get_config('timeouts', 'startup_sequence'))
-          site_proxy.tlc.wait_for_normal_control(timeout: timeout)
+          site_proxy.tlc.wait_for_normal_control!(timeout: timeout)
         end
 
         def verify_startup_sequence(site_proxy)
@@ -94,13 +94,14 @@ module RSMP
           collector = RSMP::StatusCollector.new site_proxy, status_list, timeout: timeout
           sequencer = SignalGroupSequence.new RSMP::Validator.get_config('startup_sequence')
           collector_task = start_sequence_collector(collector, sequencer)
-          site_proxy.subscribe_to_status subscribe_list, component: component
+          site_proxy.subscribe_to_status! subscribe_list, component: component
           yield
-          handle_startup_sequence_result(collector_task.wait, sequencer, collector, timeout)
+          collector_task.wait.value!
+          log 'Startup sequence verified'
           wait_for_status(site_proxy, 'control mode to be startup',
-                          [{ 'sCI' => 'S0020', 'n' => 'controlmode', 's' => 'control' }])
+                          [{ 'sCI' => 'S0020', 'n' => 'controlmode', 's' => ['control'] }])
         ensure
-          site_proxy.unsubscribe_to_status unsubscribe_list, component: component
+          site_proxy.unsubscribe_to_status! unsubscribe_list, component: component
         end
 
         private
@@ -136,21 +137,6 @@ module RSMP
           log "Startup sequence #{states}: Fail"
           collector.cancel status
         end
-
-        def handle_startup_sequence_result(result, sequencer, collector, timeout)
-          case result
-          when :ok
-            log 'Startup sequence verified'
-          when :timeout
-            raise(
-              "Startup sequence '#{sequencer.sequence}' didn't complete in #{timeout}s, " \
-              "reached #{sequencer.latest}, #{sequencer.num_started} started, " \
-              "#{sequencer.num_done} done"
-            )
-          when :cancelled
-            raise "Startup sequence '#{sequencer.sequence}' not followed: #{collector.error}"
-          end
-        end
       end
     end
   end

data/lib/rsmp/validator/helpers/status.rb

@@ -8,7 +8,7 @@ module RSMP
           timeout = options.fetch(:timeout, RSMP::Validator.get_config('timeouts', 'command'))
           component_id = options.fetch(:component_id, RSMP::Validator.get_config('main_component'))
           log "Wait for #{description}"
-          site_proxy.tlc.wait_for_status(
+          site_proxy.tlc.wait_for_status!(
             description,
             RSMP::StatusList.new(status_list).to_a,
             update_rate: update_rate,

data/lib/rsmp/validator/lifecycle.rb

@@ -51,17 +51,20 @@ module RSMP
 
       # Called at sus shutdown: stops the auto node and reactor.
       def after_suite
-        reactor.run do |_task|
-          auto_node&.stop
+        task = reactor.run do |_task|
+          begin
+            auto_node&.stop
+          ensure
+            current_tester&.stop
+          end
         ensure
           reactor.interrupt
         end
+        task.wait
         # Explicitly close the reactor now, while the log stream is still open.
         # Without this, Ruby's fiber scheduler hook fires after the File.open block
         # has closed the log file, causing IOError when cancelled tasks try to log.
         reactor.close
-      rescue StandardError
-        nil
       end
 
       # Initialize the Async reactor.
@@ -72,6 +75,10 @@ module RSMP
 
       private
 
+      def current_tester
+        mode == :site ? SiteTester.instance : SupervisorTester.instance
+      end
+
       def load_log_defaults(name)
         path = File.expand_path("../../../config/#{name}.yaml", __dir__)
         YAML.load_file(path)

data/lib/rsmp/validator/options/site_test_options.rb

@@ -35,17 +35,37 @@ module RSMP
             value = options[key]
             next if value.nil? || merged_default.key?(key)
 
+            value = rsmp_timeouts(value) if key == 'timeouts'
+            next if value == {}
+
             merged_default[key] = value
           end
 
           merged_default
         end
 
+        def rsmp_timeouts(value)
+          return value unless value.is_a?(Hash)
+
+          value.slice(*rsmp_timeout_keys)
+        end
+
+        def rsmp_timeout_keys
+          %w[
+            connect
+            ready
+            watchdog
+            acknowledgement
+            command
+            command_timeout
+            status_response
+          ]
+        end
+
         def site_defaults
           %w[
             sxls
             core_version
-            rsmp_versions
             intervals
             timeouts
             components

data/lib/rsmp/validator/options/supervisor_test_options.rb

@@ -21,29 +21,66 @@ module RSMP
           local_site = options['local_site']
           return options unless local_site.is_a?(Hash)
 
+          merge_site_defaults(options, local_site)
+          site_options_class = site_options_class_for(local_site)
+          local_site = normalize_local_site_for_rsmp(local_site)
+          local_site = site_options_class.new(local_site).to_h
+
+          options.merge('local_site' => local_site)
+        end
+
+        def merge_site_defaults(options, local_site)
+          rsmp_site_default_keys.each do |key|
+            value = options[key]
+            next if value.nil? || local_site.key?(key)
+
+            value = rsmp_timeouts(value) if key == 'timeouts'
+            next if value == {}
+
+            local_site[key] = value
+          end
+        end
+
+        def rsmp_site_default_keys
           %w[
             sxls
             core_version
-            rsmp_versions
             intervals
             timeouts
             components
             skip_validation
-          ].each do |key|
-            value = options[key]
-            next if value.nil? || local_site.key?(key)
+          ]
+        end
 
-            local_site[key] = value
-          end
+        def site_options_class_for(local_site)
+          local_site['type'] == 'tlc' ? RSMP::TLC::TrafficControllerSite::Options : RSMP::Site::Options
+        end
 
-          site_options_class = if local_site['type'] == 'tlc'
-                                 RSMP::TLC::TrafficControllerSite::Options
-                               else
-                                 RSMP::Site::Options
-                               end
-          local_site = site_options_class.new(local_site).to_h
+        def rsmp_timeouts(value)
+          return value unless value.is_a?(Hash)
 
-          options.merge('local_site' => local_site)
+          value.slice(*rsmp_timeout_keys)
+        end
+
+        def rsmp_timeout_keys
+          %w[
+            connect
+            ready
+            watchdog
+            acknowledgement
+            command
+            command_timeout
+            status_response
+          ]
+        end
+
+        def normalize_local_site_for_rsmp(local_site)
+          normalized = local_site.dup
+          if normalized['security_codes'].nil? && normalized.dig('secrets', 'security_codes').is_a?(Hash)
+            normalized['security_codes'] = normalized['secrets']['security_codes']
+          end
+          normalized.delete('secrets')
+          normalized
         end
       end
     end

data/lib/rsmp/validator/site_tester.rb

@@ -68,7 +68,9 @@ module RSMP
 
       def build_node(options)
         logger = create_supervisor_logger(@supervisor_config)
-        supervisor_settings = ConfigNormalizer.normalize_supervisor_settings(@supervisor_config.deep_merge(options))
+        supervisor_settings = ConfigNormalizer.normalize_supervisor_settings(
+          @supervisor_config.deep_merge(rsmp_node_options(options))
+        )
 
         RSMP::Supervisor.new(
           supervisor_settings: supervisor_settings,
@@ -82,20 +84,23 @@ module RSMP
         return if @proxy
 
         log 'Waiting for site to connect'
-        @proxy = @node.wait_for_site(:any, timeout: config['timeouts']['connect'])
-      rescue RSMP::TimeoutError
-        raise RSMP::ConnectionError, "Site did not connect within #{config['timeouts']['connect']}s"
+        result = @node.wait_for_site(:any, timeout: config['timeouts']['connect'])
+        raise RSMP::ConnectionError, "Site did not connect within #{config['timeouts']['connect']}s" if result.failure?
+
+        @proxy = result.value
       end
 
       def wait_for_handshake
         return if @proxy.ready?
 
         log 'Waiting for handshake to complete'
-        @proxy.wait_for_state :ready, timeout: config['timeouts']['ready']
+        result = @proxy.wait_for_state :ready, timeout: config['timeouts']['ready']
+        raise RSMP::ConnectionError, result.failure.message if result.failure?
+
         log 'Ready'
         return if @initial_unsubscribe_done
 
-        @proxy.unsubscribe_from_all component: RSMP::Validator.get_config('main_component')
+        @proxy.unsubscribe_from_all(component: RSMP::Validator.get_config('main_component')).value!
         @initial_unsubscribe_done = true
       end
 
@@ -108,6 +113,10 @@ module RSMP
         logger_settings.delete('stream') if log_settings['path']
         RSMP::Logger.new(logger_settings)
       end
+
+      def rsmp_node_options(options)
+        options.except('collect')
+      end
     end
   end
 end

data/lib/rsmp/validator/supervisor_tester.rb

@@ -39,7 +39,7 @@ module RSMP
                 else
                   RSMP::Site
                 end
-        site_settings = ConfigNormalizer.normalize_site_settings(@site_config.deep_merge(options))
+        site_settings = ConfigNormalizer.normalize_site_settings(@site_config.deep_merge(rsmp_node_options(options)))
         logger = create_site_logger(@site_config)
         @site = klass.new(
           site_settings: site_settings,
@@ -51,14 +51,16 @@ module RSMP
       def wait_for_connection
         log 'Waiting for connection to supervisor'
         @proxy = @node.find_supervisor :any
-        @proxy.wait_for_state %i[connected ready], timeout: config['timeouts']['connect']
-      rescue RSMP::TimeoutError
+        result = @proxy.wait_for_state %i[connected ready], timeout: config['timeouts']['connect']
+        return if result.success?
+
         raise RSMP::ConnectionError, "Could not connect to supervisor within #{config['timeouts']['connect']}s"
       end
 
       def wait_for_handshake
-        @proxy.wait_for_state :ready, timeout: config['timeouts']['ready']
-      rescue RSMP::TimeoutError
+        result = @proxy.wait_for_state :ready, timeout: config['timeouts']['ready']
+        return if result.success?
+
         raise RSMP::ConnectionError, "Handshake didn't complete within #{config['timeouts']['ready']}s"
       end
 
@@ -71,6 +73,10 @@ module RSMP
         logger_settings.delete('stream') if log_settings['path']
         RSMP::Logger.new(logger_settings)
       end
+
+      def rsmp_node_options(options)
+        options.except('collect')
+      end
     end
   end
 end

data/lib/rsmp/validator/tester.rb

@@ -8,10 +8,6 @@ module RSMP
     class Tester
       include RSMP::Validator::Log
 
-      def self.sentinel_errors
-        @sentinel_errors ||= []
-      end
-
       def config
         RSMP::Validator.config
       end
@@ -22,7 +18,9 @@ module RSMP
       def connected(options = {})
         start options, 'Connecting'
         wait_for_proxy
-        yield Async::Task.current, @node, @proxy
+        result = yield Async::Task.current, @node, @proxy
+        check_health
+        result
       end
 
       # Disconnects the site if connected, then waits until the site is connected
@@ -31,7 +29,9 @@ module RSMP
         stop 'Reconnecting'
         start options
         wait_for_proxy
-        yield Async::Task.current, @node, @proxy
+        result = yield Async::Task.current, @node, @proxy
+        check_health
+        result
       end
 
       # Like connected, except that the connection is closed after the test.
@@ -40,6 +40,7 @@ module RSMP
         start options, 'Connecting'
         wait_for_proxy
         yield Async::Task.current, @node, @proxy
+      ensure
         stop 'Isolating'
       end
 
@@ -51,42 +52,37 @@ module RSMP
 
       # Stop the rsmp supervisor
       def stop(why = nil)
-        if @node
-          log why if why
-          @node.ignore_errors RSMP::DisconnectError do
-            @node.stop
-          end
-        end
+        log why if why && @node
+        @node&.stop
+        @node_task&.wait
+        @node_task = nil
         @node = nil
         @proxy = nil
       end
 
+      def receive_event(event)
+        failure = event.failure
+        detail = failure ? "#{failure.code}: #{failure.message}" : event.type
+        log "Node event: #{detail}", level: :debug
+      end
+
       private
 
+      def check_health
+        @node_task.wait if @node_task&.failed?
+      end
+
       def initialize
         parse_config
       end
 
-      # Start the tester node inside an async task that will persist between tests.
+      # Start the tester node under the shared reactor's current task.
       def start(options = {}, _why = nil)
         return if @node
 
-        RSMP::Validator.reactor.async do |task|
-          task.annotate 'node runner'
-
-          @node = build_node options
-
-          RSMP::Validator.reactor.async do |sentinel|
-            sentinel.annotate 'sentinel'
-            while @node
-              e = @node.error_queue.dequeue
-              log "Sentinel warning: #{e.class}: #{e}"
-              self.class.sentinel_errors << e
-            end
-          end
-
-          @node.start
-        end
+        @node = build_node options
+        @node.add_event_receiver(self)
+        @node_task = @node.start(parent: Async::Task.current)
       end
 
       # Wait until communication has been established, and handshake completed.

data/lib/rsmp/validator/version.rb

@@ -1,5 +1,5 @@
 module RSMP
   module Validator
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.3.2'.freeze
   end
 end

data/lib/rsmp/validator/version_filter.rb

@@ -11,7 +11,7 @@ module RSMP
       end
 
       # Check if the configured core version satisfies the given requirement.
-      # @param requirement [String] Gem::Requirement-compatible string, e.g. ">= 3.2"
+      # @param requirement [String] Gem::Requirement-compatible string, e.g. ">= 3.2.0"
       def self.core_matches?(requirement)
         version_satisfies?(requirement, RSMP::Validator.config['core_version'])
       end