rsmp-validator 0.1.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55ee531553c2e8a6e8a4e92a88a225c84d9eae9cc44226c5ecc57f7c51be87fa
-  data.tar.gz: '09a94572268f042111a5799c6c0a5248445eb22422110d624b6c4d455b45cadf'
+  metadata.gz: bf28fcdaff9ccf8df4f107cbe2f045e55316f81285c21520da2ef63a19f9f94f
+  data.tar.gz: 5c7614286acbcb9dce4abb36b66fb48a94493b072a7f88432b598e3249d0b6df
 SHA512:
-  metadata.gz: 6fc22fafb1e68d93fc092fd90cfd8598892f2a19369dc4b50ca8f3ce4bf524418d08d7e996e05da22ac30e4f937ab0305816572af598338dbebea956ceb42d53
-  data.tar.gz: 4f39f0305b3d3a779e1f1c3355f4839f6790fbca9eb8bf049fea8694d85a29688242dd3ef5b9a350d5187af59e7f95a88894f14f8169eeae3b6d437674cd98a7
+  metadata.gz: 3e31a7dd63d4143b7804f04026d090a1936e3918a6bd2f060c6e6dd8ae81ad74600ac76cac553a17a89daad2bf769efeaf293f0c6f73d5ca049dbcc756f99e06
+  data.tar.gz: 4abbb6813ee551793997e18e680f131f15680f2a2a16361d524607baf9068807e4f7a663e5d136e2941b9dad8c9601a3ba995dcf80dcc778fef365702e34aa01

data/config/cross_rs4s.yaml

@@ -1,6 +1,12 @@
 # Config for testing Cross RS4S traffic light controller.
 # The settings are used for starting a local supervisor listening for the site tested
 # See https://rsmp-nordic.github.io/rsmp_validator/config/
+compliance:
+  id: cross-rs4s
+  kind: site
+  name: Cross RS4S/RS4T/RS5
+  product_url: https://www.cross-traffic.com/en/traffic-light-controllers/
+
 local_supervisor:
   ips: all
   max_sites: 1

data/config/gem_supervisor.yaml

@@ -1,5 +1,11 @@
 # Config for testing a supervisor running on localhost (e.g. one from the rsmp gem)
 # The settings are used for starting a local site connecting to the supervisor tested
+compliance:
+  id: gem-supervisor
+  kind: supervisor
+  name: RSMP Nordic CLI supervisor
+  product_url: https://github.com/rsmp-nordic/rsmp
+
 local_site:
   type: tlc
   site_id: RN+SI0001

data/config/gem_tlc.yaml

@@ -1,6 +1,12 @@
 # Config for testing RSMP Nordic traffic light controller emulator.
 # The settings are used for starting a local supervisor listening for the site tested
 # See https://rsmp-nordic.github.io/rsmp_validator/config/
+compliance:
+  id: gem-tlc
+  kind: site
+  name: RSMP Nordic CLI TLC
+  product_url: https://github.com/rsmp-nordic/rsmp
+
 local_supervisor:
   port: 13111
   ips: all

data/config/kapsch_etx.yaml

@@ -1,13 +1,20 @@
 # Config for testing Kapsch ETX traffic light controller.
 # The settings are used for starting a local supervisor listening for the site tested
 # See https://rsmp-nordic.github.io/rsmp_validator/config/
+compliance:
+  id: kapsch-etx
+  kind: site
+  name: Kapsch EcoTrafiX
+  product_url: https://www.kapsch.net/_Resources/Persistent/f9e0a0525985dc4a9d0b3cb6b67476c0b1257b1c/Kapsch_EcoTrafiX-Controller-16_Datasheet-EN.pdf
+
 local_supervisor:
   ips: all
   max_sites: 1
-  guest:
-    intervals:
-      timer: 1 # main validator timer resolution in seconds
-      watchdog: 60 # send watchdog every x seconds
+  sites:
+    default:
+      intervals:
+        timer: 1 # main validator timer resolution in seconds
+        watchdog: 60 # send watchdog every x seconds
 sxls:
   tlc: "1.2.1"
 timeouts: # Timeouts used when waiting for messages from site.
@@ -50,5 +57,5 @@ alarm_triggers:
     component: KTT+TC=101DL004
 secrets:
   security_codes:
-    1: "1111"
-    2: "2222"
+    1: '1111'
+    2: '2222'

data/config/lightmotion_satellite.yaml

@@ -1,6 +1,12 @@
 # Configuration for testing Lightmotion Satellite RSMP proxy software
 # The settings are used for starting a local supervisor listening for the site tested
 # See https://rsmp-nordic.github.io/rsmp_validator/config/
+compliance:
+  id: lightmotion-satellite
+  kind: site
+  name: Lightmotion Satellite
+  product_url: https://lightmotion.fi/
+
 local_supervisor:
   ips: all
   max_sites: 1
@@ -52,5 +58,5 @@ alarm_triggers:
     component: AA+BBCCC=DDDDL001
 secrets:
   security_codes:
-    1: "1234"
-    2: "4321"
+    1: '1234'
+    2: '4321'

data/config/semaforica_cartesio.yaml

@@ -1,6 +1,12 @@
 # Config for testing Cross RS4S traffic light controller.
 # The settings are used for starting a local supervisor listening for the site tested
 # See https://rsmp-nordic.github.io/rsmp_validator/config/
+compliance:
+  id: semaforica-cartesio
+  kind: site
+  name: La Semaforica TECSEN Cartesio
+  product_url: https://lasemaforica.com/en/products/cartesio-highest-processing-power-interactive-traffic-controllers/
+
 local_supervisor:
   ips: all
   max_sites: 1
@@ -52,5 +58,5 @@ alarm_triggers:
     component: CAR_DL_016
 secrets:
   security_codes:
-    1: 1234
-    2: 12341234
+    1: '1234'
+    2: '12341234'

data/config/sus.rb

@@ -6,7 +6,7 @@
 #   bundle exec sus test/validator
 #
 # To run conformance tests against real equipment, use the rsmp-validator executable:
-#   bundle exec rsmp-validator
+#   bundle exec rsmp-validator run test/site
 
 def test_paths
   Dir.glob('test/validator/**/*.rb', base: @root)

data/config/swarco_itc3.yaml

@@ -1,6 +1,12 @@
 # Config for testing Swarco ITC-3 traffic light controller.
 # The settings are used for starting a local supervisor listening for the site tested
 # See https://rsmp-nordic.github.io/rsmp_validator/config/
+compliance:
+  id: swarco-itc3
+  kind: site
+  name: Swarco ITC-3
+  product_url: https://www.swarco.com/products/traffic-light-controllers/itc-3-traffic-controller
+
 local_supervisor:
   ips: all
   max_sites: 1
@@ -51,5 +57,5 @@ alarm_triggers:
     component: AA+BBCCC=DDDDL002
 secrets:
   security_codes:
-    1: default
-    2: default
+    1: 'default'
+    2: 'default'

data/config/tecsen_tmacs_supervisor.yaml

@@ -1,5 +1,11 @@
 # The settings are used for starting a local tlc emulator connecting to the supervisor system to be tested
 
+compliance:
+  id: tecsen-tmacs
+  kind: supervisor
+  name: TECSEN TMacs
+  product_url: https://www.tmacs.it/en/
+
 local_site:
   type: tlc
   site_id: CAR_TC_001

data/exe/rsmp-validator

@@ -1,121 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'bundler/setup'
-require 'sus'
-require 'sus/config'
+require_relative '../lib/rsmp/validator/cli/entrypoint'
 
-def print_help
-  puts <<~HELP
-    RSMP Validator runs conformance tests against RSMP sites and supervisors.
-    Full documentation: https://rsmp-nordic.github.io/rsmp_validator/
-
-    Usage:
-      rsmp-validator [OPTIONS] PATH...
-
-    Examples:
-      rsmp-validator test/site
-      rsmp-validator test/site/core
-      rsmp-validator test/supervisor/connect_spec.rb
-
-    Options:
-      --verbose      Show detailed sus output.
-      --log          Print RSMP log output to stdout.
-      --log PATH     Write RSMP log output to PATH.
-      -h, --help     Show this help.
-
-    Environment:
-      SITE_CONFIG        Path to site test configuration.
-      SUPERVISOR_CONFIG  Path to supervisor test configuration.
-      AUTO_SITE_CONFIG   Path to local site configuration to start automatically.
-  HELP
-end
-
-if ARGV.first == 'help' || ARGV.include?('--help') || ARGV.include?('-h')
-  print_help
-  exit 0
-end
-
-# Parse --log [path] from ARGV before Sus::Config.load consumes remaining args.
-# --log        => RSMP logs to $stdout
-# --log <path> => RSMP logs to file, sus output to console (brief)
-#   + --verbose => sus output also goes to file (interleaved, perfectly ordered)
-# (no --log)   => RSMP logs suppressed
-log_index = ARGV.index('--log')
-log_path = nil
-log_to_stdout = false
-if log_index
-  ARGV.delete_at(log_index)
-  if ARGV[log_index] && !ARGV[log_index].start_with?('-')
-    log_path = ARGV.delete_at(log_index)
-  else
-    log_to_stdout = true
-  end
-end
-
-# Writes to two IOs simultaneously through a single object, so both RSMP messages
-# and Sus verbose output share one file descriptor and are perfectly interleaved.
-class TeeIO
-  def initialize(primary, secondary)
-    @primary = primary
-    @secondary = secondary
-  end
-
-  def write(*args)
-    @primary.write(*args)
-    @secondary.write(*args)
-  end
-
-  def puts(*args)
-    @primary.puts(*args)
-    @secondary.puts(*args)
-  end
-
-  def flush
-    @primary.flush
-    @secondary.flush
-  end
-
-  def isatty       = @primary.isatty
-  def tty?         = @primary.tty?
-end
-
-# Load config/validator.rb instead of config/sus.rb so that conformance tests
-# live in valid/site/ and valid/supervisor/, keeping them separate from the
-# internal tests in test/ that plain `sus` runs.
-validator_config_class = Class.new(Sus::Config) do
-  attr_accessor :log_to_stdout, :log_path, :log_file_io
-
-  def self.path(root)
-    path = File.join(root, 'config/validator.rb')
-    File.exist?(path) ? path : nil
-  end
-end
-
-config = validator_config_class.load
-config.log_to_stdout = log_to_stdout
-config.log_path = log_path
-
-registry = config.registry
-
-def run_suite(config, registry, output, verbose)
-  assertions = Sus::Assertions.default(output: output, verbose: verbose)
-  config.before_tests(assertions)
-  registry.call(assertions)
-  config.after_tests(assertions)
-  exit(1) unless assertions.passed?
-end
-
-# When --log <path> and --verbose are both given, open the file once and share
-# the handle: Sus writes via TeeIO (terminal + file), RSMP writes to the same
-# File object directly. One fd => serialized writes => perfect ordering.
-if log_path && config.verbose?
-  File.open(log_path, 'w') do |log_file|
-    config.log_path = nil
-    config.log_file_io = log_file
-    output = Sus::Output.default(TeeIO.new($stderr, log_file))
-    run_suite(config, registry, output, true)
-  end
-else
-  output = config.verbose? ? config.output : Sus::Output::Null.new
-  run_suite(config, registry, output, config.verbose?)
-end
+RSMP::Validator::CLI.start(ARGV)

data/lib/rsmp/validator/async_context.rb

@@ -3,12 +3,13 @@ module RSMP
     # Sus fixture module that runs each test inside the shared Async reactor.
     # Include this in the sus base class to ensure all tests run within the reactor context.
     module AsyncContext
-      def around
-        RSMP::Validator.reactor.run do |_task|
-          yield
+      def around(&block)
+        task = RSMP::Validator.reactor.run do |_task|
+          catch(:rsmp_validator_test_failure, &block)
         ensure
           RSMP::Validator.reactor.interrupt
         end
+        task.wait
       end
     end
   end

data/lib/rsmp/validator/auto_node.rb

@@ -19,25 +19,15 @@ module RSMP
         return if @node
 
         @node = build_node
-
-        @task = Async do |task|
-          task.annotate "auto_#{node_type}"
-          log("Starting auto #{node_type}")
-          @node.start
-        rescue Async::TimeoutError
-          raise RSMP::TimeoutError, "Timeout while starting auto #{node_type}"
-        end
+        log("Starting auto #{node_type}")
+        @task = @node.start(parent: Async::Task.current)
       end
 
       # Stop the auto node
       def stop
-        if @node
-          log("Stopping auto #{node_type}")
-          @node.ignore_errors RSMP::DisconnectError do
-            @node.stop
-          end
-        end
-        @task&.stop
+        log("Stopping auto #{node_type}") if @node
+        @node&.stop
+        @task&.wait
       ensure
         @task = nil
         @node = nil

data/lib/rsmp/validator/cli/config_cli.rb

@@ -0,0 +1,32 @@
+require 'thor'
+require_relative '../config_check'
+
+module RSMP
+  module Validator
+    # CLI subcommands for validator configuration.
+    class ConfigCLI < Thor
+      namespace :config
+      desc 'check PATH...', 'Validate rsmp-validator config files'
+      method_option :mode, type: :string, aliases: '-m', default: 'auto',
+                           enum: %w[auto site supervisor],
+                           banner: 'Validator config mode: auto, site or supervisor'
+      def check(*paths)
+        if paths.empty?
+          puts 'Error: config check requires at least one path'
+          exit 1
+        end
+
+        valid = true
+        paths.each do |path|
+          RSMP::Validator::ConfigCheck.check_file(path, mode: options[:mode])
+          puts 'OK'
+        rescue RSMP::ConfigurationError => e
+          valid = false
+          puts "Error: #{e.message}"
+        end
+
+        exit 1 unless valid
+      end
+    end
+  end
+end

data/lib/rsmp/validator/cli/entrypoint.rb

@@ -0,0 +1,40 @@
+require 'thor'
+require_relative '../../validator'
+require_relative 'config_cli'
+require_relative 'run_options'
+require_relative 'runner'
+
+module RSMP
+  module Validator
+    # Thor entrypoint for validator commands.
+    class CLI < Thor
+      desc 'run PATH...', 'Run validator conformance tests'
+      method_option :verbose, type: :boolean, aliases: '-v', desc: 'Show detailed sus output'
+      method_option :log, type: :boolean, desc: 'Print RSMP log output to stdout'
+      method_option :log_path, type: :string, desc: 'Write RSMP log output to PATH'
+      method_option :report_json, type: :string, desc: 'Write a machine-readable compliance report to PATH'
+      method_option :core, type: :string, desc: 'Override RSMP Core version for this run'
+      method_option :sxls, type: :string, desc: 'Override SXL versions as name:version,...'
+      method_option :site_config, type: :string, desc: 'Use PATH as the site test config'
+      method_option :supervisor_config, type: :string, desc: 'Use PATH as the supervisor test config'
+      method_option :auto_site_config, type: :string, desc: 'Use PATH as the auto site config'
+      method_option :auto_supervisor_config, type: :string, desc: 'Use PATH as the auto supervisor config'
+      def run_tests(*paths)
+        run_options = RunOptions.parse(paths, thor_options: options)
+        if run_options[:log_to_stdout] && run_options[:log_path]
+          raise Thor::Error, '--log and --log-path cannot be used together'
+        end
+
+        status = Runner.new(run_options).run
+        exit status
+      end
+      map 'run' => :run_tests
+
+      register ConfigCLI, 'config', 'config COMMAND', 'Configuration commands'
+
+      def self.exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/rsmp/validator/cli/run_options.rb

@@ -0,0 +1,87 @@
+require 'thor'
+
+module RSMP
+  module Validator
+    # Parses run options that Thor leaves in the path list when options appear
+    # after variadic test paths.
+    class RunOptions
+      FLAG_OPTIONS = {
+        '--verbose' => :verbose,
+        '-v' => :verbose,
+        '--log' => :log_to_stdout
+      }.freeze
+
+      VALUE_OPTIONS = {
+        '--log-path' => :log_path,
+        '--report-json' => :report_json_path,
+        '--core' => :core_version,
+        '--sxls' => :sxls,
+        '--site-config' => :site_config_path,
+        '--supervisor-config' => :supervisor_config_path,
+        '--auto-site-config' => :auto_site_config_path,
+        '--auto-supervisor-config' => :auto_supervisor_config_path
+      }.freeze
+
+      def self.parse(args, thor_options:)
+        new(args, thor_options).parse
+      end
+
+      def initialize(args, thor_options)
+        @args = args
+        @parsed = {
+          paths: [],
+          verbose: thor_options[:verbose],
+          log_to_stdout: thor_options[:log],
+          log_path: thor_options[:log_path],
+          report_json_path: thor_options[:report_json],
+          core_version: thor_options[:core],
+          sxls: thor_options[:sxls],
+          site_config_path: thor_options[:site_config],
+          supervisor_config_path: thor_options[:supervisor_config],
+          auto_site_config_path: thor_options[:auto_site_config],
+          auto_supervisor_config_path: thor_options[:auto_supervisor_config]
+        }
+      end
+
+      def parse
+        remaining = @args.dup
+        remaining.shift if remaining.first == 'run'
+        parse_remaining(remaining)
+        @parsed
+      end
+
+      private
+
+      def parse_remaining(remaining)
+        parse_arg(remaining.shift, remaining) until remaining.empty?
+      end
+
+      def parse_arg(arg, remaining)
+        flag_key = FLAG_OPTIONS[arg]
+        return @parsed[flag_key] = true if flag_key
+
+        option_key = VALUE_OPTIONS[arg]
+        return @parsed[option_key] = required_option_value(arg, remaining) if option_key
+
+        return parse_inline_value(arg) if arg.start_with?('--') && arg.include?('=')
+
+        @parsed[:paths] << arg
+      end
+
+      def parse_inline_value(arg)
+        option, value = arg.split('=', 2)
+        option_key = VALUE_OPTIONS[option]
+        return @parsed[option_key] = value if option_key
+
+        @parsed[:paths] << arg
+      end
+
+      def required_option_value(option, remaining)
+        value = remaining.shift
+        raise Thor::Error, "#{option} requires a value" if value.nil? || value.start_with?('-')
+
+        value
+      end
+    end
+  end
+end

data/lib/rsmp/validator/cli/runner.rb

@@ -0,0 +1,119 @@
+require 'sus'
+require 'sus/config'
+require_relative '../compliance/report'
+require_relative 'tee_io'
+require_relative 'validator_overrides'
+
+module RSMP
+  module Validator
+    # Runs the conformance test suite through Sus while preserving validator
+    # specific options that Sus does not know about.
+    class Runner
+      include ValidatorOverrides
+
+      def initialize(options)
+        @paths = options[:paths]
+        @verbose = options[:verbose]
+        @log_to_stdout = options[:log_to_stdout]
+        @log_path = options[:log_path]
+        @report_json_path = options[:report_json_path]
+        @overrides = options.slice(
+          :core_version,
+          :sxls,
+          :site_config_path,
+          :supervisor_config_path,
+          :auto_site_config_path,
+          :auto_supervisor_config_path
+        )
+      end
+
+      def run
+        with_argv(sus_args) { run_with_args }
+      rescue RSMP::ConnectionError
+        1
+      end
+
+      private
+
+      def run_with_args
+        apply_overrides(@overrides)
+        config = validator_config_class.load
+        config.log_to_stdout = @log_to_stdout
+        config.log_path = @log_path
+
+        registry = config.registry
+        return run_with_log_file(config, registry) if @log_path && config.verbose?
+
+        run_with_default_output(config, registry)
+      ensure
+        clear_overrides(@overrides)
+      end
+
+      def sus_args
+        args = @paths.dup
+        args << '--verbose' if @verbose
+        args
+      end
+
+      def with_argv(args)
+        original = ARGV.dup
+        ARGV.replace(args)
+        yield
+      ensure
+        ARGV.replace(original)
+      end
+
+      def validator_config_class
+        Class.new(Sus::Config) do
+          attr_accessor :log_to_stdout, :log_path, :log_file_io
+
+          def self.path(root)
+            path = File.join(root, 'config/validator.rb')
+            File.exist?(path) ? path : nil
+          end
+        end
+      end
+
+      def run_with_log_file(config, registry)
+        File.open(@log_path, 'w') do |log_file|
+          config.log_path = nil
+          config.log_file_io = log_file
+          output = Sus::Output.default(TeeIO.new($stderr, log_file))
+          run_suite(config, registry, output, true)
+        end
+      end
+
+      def run_with_default_output(config, registry)
+        output = config.verbose? ? config.output : Sus::Output::Null.new
+        run_suite(config, registry, output, config.verbose?)
+      end
+
+      def run_suite(config, registry, output, verbose)
+        assertions = Sus::Assertions.default(output: output, verbose: verbose)
+        begin
+          config.before_tests(assertions)
+          registry.call(assertions)
+        ensure
+          config.after_tests(assertions)
+        end
+        write_report(assertions)
+        assertions.passed? ? 0 : 1
+      end
+
+      def write_report(assertions)
+        return unless @report_json_path
+
+        RSMP::Validator::Compliance::Report.write(
+          @report_json_path,
+          assertions: assertions,
+          env: ENV,
+          args: @paths,
+          config: RSMP::Validator.config,
+          config_path: RSMP::Validator.config_path,
+          log_path: @log_path,
+          report_json_path: @report_json_path
+        )
+      end
+    end
+  end
+end

data/lib/rsmp/validator/cli/tee_io.rb

@@ -0,0 +1,30 @@
+module RSMP
+  module Validator
+    # Writes to two IOs simultaneously through a single object, so both RSMP
+    # messages and Sus verbose output can share one file descriptor.
+    class TeeIO
+      def initialize(primary, secondary)
+        @primary = primary
+        @secondary = secondary
+      end
+
+      def write(*args)
+        @primary.write(*args)
+        @secondary.write(*args)
+      end
+
+      def puts(*args)
+        @primary.puts(*args)
+        @secondary.puts(*args)
+      end
+
+      def flush
+        @primary.flush
+        @secondary.flush
+      end
+
+      def isatty = @primary.isatty
+      def tty? = @primary.tty?
+    end
+  end
+end

data/lib/rsmp/validator/cli/validator_overrides.rb

@@ -0,0 +1,28 @@
+module RSMP
+  module Validator
+    # Applies CLI overrides to global validator settings for a single run.
+    module ValidatorOverrides
+      OVERRIDE_ACCESSORS = {
+        core_version: :core_version_override,
+        sxls: :sxls_override,
+        site_config_path: :site_config_path,
+        supervisor_config_path: :supervisor_config_path,
+        auto_site_config_path: :auto_site_config_path,
+        auto_supervisor_config_path: :auto_supervisor_config_path
+      }.freeze
+
+      def apply_overrides(overrides)
+        overrides.each do |name, value|
+          RSMP::Validator.public_send("#{OVERRIDE_ACCESSORS.fetch(name)}=", value)
+        end
+      end
+
+      def clear_overrides(overrides)
+        overrides.each_key do |name|
+          RSMP::Validator.public_send("#{OVERRIDE_ACCESSORS.fetch(name)}=", nil)
+        end
+        RSMP::Validator.config_path = nil
+      end
+    end
+  end
+end