rsmp 0.9.0 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dde978c380def64dfcad00d0a7c9845a7c57476828623664dcf2ace7f3f6b669
-  data.tar.gz: 6dadc564b21089271b9921f876b95c899ad42c5bbc27b9250d34b47648447937
+  metadata.gz: b4eb81e9be58fe5645d41ffe88fad923aac8ba5db14382ce0532d17721b18b0c
+  data.tar.gz: 806810e243027d1349631b1b0153c452557e9b7ad01470ff51376c6a181a3810
 SHA512:
-  metadata.gz: 7bc25b5125c599a5c46db4c919e8bf6891ddad0631de6264dfe5df97eac5cdf85768f099df8f41bff26203fb6fb15d95f4b09c8e2d4b32e80b24b3065be88d1e
-  data.tar.gz: 8b58da0f830cc4e4fa7f0906a2d691a3d1548b364c21e320c0f597ce4da873dd16b2db0d5e196c70f21fa9126c24a4e3f4c951586768cad0f99b78047ed7eb18
+  metadata.gz: cfa09b0e9692c42999c97866166631e5e805c16741af046b21670a5cdaad862afa9fd532d266877da1c623b0ebb42f4d23854bac9dcb1884e095dabf6027b97a
+  data.tar.gz: 493156ab24d418536dd57a5d0a68d008320b9c896e99b33e9ed6023c061f597467569865645895b106f3e13423c686f5c3c89c2177cafbd28a1707c387a5a00c

data/.github/workflows/rspec.yaml

@@ -1,14 +1,21 @@
 # This workflow runs RSpec tests
 
 name: RSpec
-on: [push, pull_request]
+on: [push]
 jobs:
   test:
-    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest, windows-2022]
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: ['3.0', '3.1']
+    runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1
       with:
-        # ruby-version is not needed because we have a .ruby-version file
+        ruby-version: ${{ matrix.ruby }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - run: bundle exec rspec
+    - run: bundle exec rspec -f d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.9.0)
+    rsmp (0.9.3)
       async (~> 1.29.1)
       async-io (~> 1.32.2)
       colorize (~> 0.8.1)
@@ -64,9 +64,11 @@ GEM
     ecma-re-validator (0.4.0)
       regexp_parser (~> 2.2)
     ffi (1.15.5)
+    ffi (1.15.5-x64-mingw-ucrt)
+    ffi (1.15.5-x64-mingw32)
     fiber-local (1.0.0)
     hana (1.3.7)
-    json_schemer (0.2.18)
+    json_schemer (0.2.19)
       ecma-re-validator (~> 0.3)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
@@ -77,7 +79,7 @@ GEM
     multi_test (0.1.2)
     nio4r (2.5.8)
     rake (13.0.6)
-    regexp_parser (2.2.0)
+    regexp_parser (2.2.1)
     rsmp_schemer (0.3.2)
       json_schemer (~> 0.2.18)
     rspec (3.10.0)
@@ -101,6 +103,9 @@ GEM
     uri_template (0.7.0)
 
 PLATFORMS
+  x64-mingw-ucrt
+  x64-mingw32
+  x86_64-darwin-19
   x86_64-darwin-20
   x86_64-darwin-21
   x86_64-linux

data/README.md

@@ -13,16 +13,6 @@ $ gem install bundler
 $ bundle
 ```
 
-Install git submodules:
-The JSON Schema is is included as a git submodule. To install it:
-
-```console
-$ git submodule init     # initialize local submodule config
-$ git submodule update   # fetch submodules
-```
-
-Alternatively, you can pass --recurse-submodules to the git clone command, and it will automatically initialize and update each submodule in the repository.
-
 ## Usage
 ### Site and Supervisor
 The RSMP::Site and RSMP::Supervisor classes can be used to run a RSMP site.

data/cucumber.yml

@@ -0,0 +1 @@
+default: --publish-quiet

data/lib/rsmp/cli.rb

@@ -161,5 +161,10 @@ module RSMP
       RSMP::Convert::Export::JSONSchema.write sxl, options[:out]
     end
 
+    # avoid Thor returnin 0 on failures, see
+    # https://github.com/coinbase/salus/pull/380/files
+    def self.exit_on_failure?
+      true
+    end
   end
 end

data/lib/rsmp/collect/alarm_collector.rb

@@ -0,0 +1,20 @@
+module RSMP
+  # Class for waiting for specific command responses
+  class AlarmCollector < Collector
+    def initialize proxy, want, options={}
+      @want = want
+      super proxy, options.merge(
+        type: 'Alarm',
+        title:'alarm'
+      )
+    end
+
+    def type_match? message
+      return false if super(message) == false
+      [:aCId, :aSp, :ack, :aS, :sS, :cat, :pri].each do |key|
+        return false if @want[key] && @want[key] != message.attribute(key.to_s)
+      end
+      true
+    end
+  end
+end

data/lib/rsmp/collect/alarm_query.rb

@@ -0,0 +1,15 @@
+module RSMP
+  # Match a specific alarm
+  class AlarmQuery < Query
+    # Match an alarm value against a query
+    def match? item
+      return false if @want['n'] && @want['n'] != item['n']
+      if @want['v'].is_a? Regexp
+        return false if item['v'] !~ @want['v']
+      elsif @want['v']
+        return false if item['v'] != @want['v']
+      end
+      true
+    end
+  end
+end

data/lib/rsmp/deep_merge.rb

@@ -1,5 +1,6 @@
 class Hash
   def deep_merge(other_hash)
+    return self unless other_hash
     self.merge(other_hash) do |key, old, fresh|
       if old.is_a?(Hash) && fresh.is_a?(Hash)
         old.deep_merge(fresh)

data/lib/rsmp/site_proxy.rb

@@ -72,7 +72,7 @@ module RSMP
         else
           super message
       end
-    rescue RSMP::RepeatedAlarmError, RSMP::RepeatedStatusError
+    rescue RSMP::RepeatedAlarmError, RSMP::RepeatedStatusError => e
       str = "Rejected #{message.type} message,"
       dont_acknowledge message, str, "#{e}"
       notify_error e.exception("#{str}#{e.message} #{message.json}")
@@ -346,14 +346,5 @@ module RSMP
       @supervisor.notify_error e, options if @supervisor
       distribute_error e, options
     end
-
-    def collect_alarms options={}
-      collect(@task,options.merge(type: "Alarm")) do |alarm|
-        next if options[:aCId] && options[:aCId] != alarm.attribute("aCId")
-        next if options[:aSp] && options[:aSp] != alarm.attribute("aSp")
-        next if options[:aS] && options[:aS] != alarm.attribute("aS")
-        :keep
-      end
-    end
   end
 end

data/lib/rsmp/supervisor_proxy.rb

@@ -71,10 +71,13 @@ module RSMP
     def connect_tcp
       @endpoint = Async::IO::Endpoint.tcp(@ip, @port)
 
-      # Async::IO::Endpoint#connect renames the current task. run in a subtask to avoid this
+      # Async::IO::Endpoint#connect renames the current task. run in a subtask to avoid this see issue #22
       @task.async do |task|
         task.annotate 'socket task'
-        @socket = @endpoint.connect
+        # this timeout is a workaround for #connect hanging on windows if the other side is not present yet
+        task.with_timeout 1.1 do
+          @socket = @endpoint.connect
+        end
       end.wait
 
       @stream = Async::IO::Stream.new(@socket)

data/lib/rsmp/task.rb

@@ -29,7 +29,7 @@ module RSMP
     end
 
     # get the status of our task, or nil of no task
-    def status
+    def task_status
       @task.status if @task
     end
 

data/lib/rsmp/tlc/signal_group.rb

@@ -13,8 +13,8 @@ module RSMP
       end
 
       def compute_state
-        return 'a' if node.main.dark_mode
-        return 'c' if node.main.yellow_flash
+        return 'a' if node.main.dark?
+        return 'c' if node.main.yellow_flash?
 
         cycle_counter = node.main.cycle_counter
 

data/lib/rsmp/tlc/traffic_controller.rb

@@ -6,7 +6,7 @@ module RSMP
     # not have dedicated components.
     class TrafficController < Component
       attr_reader :pos, :cycle_time, :plan, :cycle_counter,
-        :yellow_flash, :dark_mode,
+        :functional_position,
         :startup_sequence_active, :startup_sequence, :startup_sequence_pos
 
       def initialize node:, id:, cycle_time: 10, signal_plans:,
@@ -24,15 +24,16 @@ module RSMP
       end
 
       def reset_modes
-        @dark_mode = true
-        @yellow_flash = false
+        @function_position = 'NormalControl'
+        @previous_functional_position = nil
+        @functional_position_timeout = nil
+
         @booting = false
         @is_starting = false
         @control_mode = 'control'
         @manual_control = false
         @fixed_time_control = false
         @isolated_control = false
-        @yellow_flash = false
         @all_red = false
         @police_key = 0
       end
@@ -49,6 +50,8 @@ module RSMP
 
         @inputs = '0'*@num_inputs
         @input_activations = '0'*@num_inputs
+        @input_forced = '0'*@num_inputs
+        @input_forced_values = '0'*@num_inputs
         @input_results = '0'*@num_inputs
 
         @day_time_table = {}
@@ -58,6 +61,18 @@ module RSMP
         @time_int = nil
       end
 
+      def dark?
+        @function_position == 'Dark'
+      end
+
+      def yellow_flash?
+        @function_position == 'YellowFlash'
+      end
+
+      def normal_control?
+        @function_position == 'NormalControl'
+      end
+
       def clock
         node.clock
       end
@@ -85,6 +100,7 @@ module RSMP
         return if time == @time_int
         @time_int = time
         move_cycle_counter
+        check_functional_position_timeout
         move_startup_sequence if @startup_sequence_active
 
         @signal_groups.each { |group| group.timer }
@@ -97,6 +113,15 @@ module RSMP
         @cycle_counter = counter
       end
 
+      def check_functional_position_timeout
+        return unless @functional_position_timeout
+        if clock.now >= @functional_position_timeout
+          switch_functional_position @previous_functional_position, reverting: true
+          @functional_position_timeout = nil
+          @previous_functional_position = nil
+        end
+      end
+
       def startup_state
         return unless @startup_sequence_active
         return unless @startup_sequence_pos
@@ -106,7 +131,6 @@ module RSMP
       def initiate_startup_sequence
         log "Initiating startup sequence", level: :info
         reset_modes
-        @dark_mode = false
         @startup_sequence_active = true
         @startup_sequence_initiated_at = nil
         @startup_sequence_pos = nil
@@ -116,8 +140,6 @@ module RSMP
         @startup_sequence_active = false
         @startup_sequence_initiated_at = nil
         @startup_sequence_pos = nil
-        @yellow_flash = false
-        @dark_mode = false
       end
 
       def move_startup_sequence
@@ -155,18 +177,23 @@ module RSMP
         end.join ' '
 
         modes = '.'*9
-        modes[0] = 'B' if @booting
-        modes[1] = 'S' if @startup_sequence_active
-        modes[2] = 'D' if @dark_mode
-        modes[3] = 'Y' if @yellow_flash
-        modes[4] = 'M' if @manual_control
-        modes[5] = 'F' if @fixed_time_control
-        modes[6] = 'R' if @all_red
-        modes[7] = 'I' if @isolated_control
-        modes[8] = 'P' if @police_key != 0
+        modes[0] = 'N' if @function_position == 'NormalControl'
+        modes[1] = 'Y' if @function_position == 'YellowFlash'
+        modes[2] = 'D' if @function_position == 'Dark'
+        modes[3] = 'B' if @booting
+        modes[4] = 'S' if @startup_sequence_active
+        modes[5] = 'M' if @manual_control
+        modes[6] = 'F' if @fixed_time_control
+        modes[7] = 'R' if @all_red
+        modes[8] = 'I' if @isolated_control
+        modes[9] = 'P' if @police_key != 0
 
         plan = "P#{@plan}"
 
+        # create folders if needed
+        FileUtils.mkdir_p File.dirname(@live_output)
+
+        # append a line with the current state to the file
         File.open @live_output, 'w' do |file|
           file.puts "#{modes}  #{plan.rjust(2)}  #{@cycle_counter.to_s.rjust(3)}  #{str}\r"
         end
@@ -191,7 +218,7 @@ module RSMP
 
       def handle_m0001 arg
         @node.verify_security_code 2, arg['securityCode']
-        switch_mode arg['status']
+        switch_functional_position arg['status'], timeout: arg['timeout'].to_i*60
       end
 
       def handle_m0002 arg
@@ -228,18 +255,27 @@ module RSMP
         end
       end
 
+      def recompute_input idx
+        if @input_forced[idx] == '1'
+          @input_results[idx] = @input_forced_values[idx]
+        elsif @input_activations[idx]=='1'
+          @input_results[idx] = '1'
+        else
+          @input_results[idx] = bool_to_digit( @inputs[idx]=='1' )
+        end
+      end
+
       def handle_m0006 arg
         @node.verify_security_code 2, arg['securityCode']
         input = arg['input'].to_i
         idx = input - 1
         return unless idx>=0 && input<@num_inputs # TODO should NotAck
-        @input_activations[idx] = (arg['status']=='True' ? '1' : '0')
-        result = @input_activations[idx]=='1' || @inputs[idx]=='1'
-        @input_results[idx] = (result ? '1' : '0')
+        @input_activations[idx] = bool_string_to_digit arg['status']
+        recompute_input idx
         if @input_activations[idx]
-          log "Activate input #{idx}", level: :info
+          log "Activating input #{idx+1}", level: :info
         else
-          log "Deactivate input #{idx}", level: :info
+          log "Deactivating input #{idx+1}", level: :info
         end
       end
 
@@ -302,8 +338,39 @@ module RSMP
         @node.verify_security_code 2, arg['securityCode']
       end
 
+      def bool_string_to_digit bool
+        case bool
+          when 'True'
+            '1'
+          when 'False'
+            '0'
+          else
+            raise RSMP::MessageRejected.new "Invalid boolean '#{bool}', must be 'True' or 'False'"
+        end
+      end
+
+      def bool_to_digit bool
+        bool ?  '1' : '0'
+      end
+
       def handle_m0019 arg
         @node.verify_security_code 2, arg['securityCode']
+        input = arg['input'].to_i
+        idx = input - 1
+        unless idx>=0 && input<@num_inputs # TODO should NotAck
+          log "Can't force input #{idx+1}, only have #{@num_inputs} inputs", level: :warning
+          return
+        end
+        @input_forced[idx] = bool_string_to_digit arg['status']
+        if @input_forced[idx]
+          @input_forced_values[idx] = bool_string_to_digit arg['inputValue']
+        end
+        recompute_input idx
+        if @input_forced[idx]
+          log "Forcing input #{idx+1} to #{@input_forced_values[idx]}, #{@input_results}", level: :info
+        else
+          log "Releasing input #{idx+1}", level: :info
+        end
       end
 
       def handle_m0020 arg
@@ -330,13 +397,13 @@ module RSMP
           arg['second'],
           'UTC'
         )
-        @node.clock.set time
-        log "Clock set to #{time}, (adjustment is #{@node.clock.adjustment}s)", level: :info
+        clock.set time
+        log "Clock set to #{time}, (adjustment is #{clock.adjustment}s)", level: :info
       end
 
       def set_input i, value
         return unless i>=0 && i<@num_inputs
-        @inputs[i] = (arg['value'] ? '1' : '0')
+        @inputs[i] = bool_to_digit arg['value']
       end
 
       def set_fixed_time_control status
@@ -354,20 +421,24 @@ module RSMP
         @plan = plan_nr
       end
 
-      def switch_mode mode
-        log "Switching to mode #{mode}", level: :info
-        case mode
-        when 'NormalControl'
-          initiate_startup_sequence if @yellow_flash || @dark_mode
-          @yellow_flash = false
-          @dark_mode = false
-        when 'YellowFlash'
-          @yellow_flash = true
-          @dark_mode = false
-        when 'Dark'
-          @yellow_flash = false
-          @dark_mode = true
+      def switch_functional_position mode, timeout: nil, reverting: false
+        unless ['NormalControl','YellowFlash','Dark'].include? mode
+          raise RSMP::MessageRejected.new "Invalid functional position '#{mode}', must be NormalControl, YellowFlash or Dark'"
         end
+        if reverting
+          log "Reverting to functional position #{mode} after timeout", level: :info
+        elsif timeout && timeout > 0
+          log "Switching to functional position #{mode} with timeout #{timeout}min", level: :info
+          @previous_functional_position = @function_position
+          now = clock.now
+          @functional_position_timeout = now + timeout
+        else
+          log "Switching to functional position #{mode}", level: :info
+        end 
+        if mode == 'NormalControl'
+          initiate_startup_sequence if @function_position != 'NormalControl'
+        end
+        @function_position = mode
         mode
       end
 
@@ -402,7 +473,7 @@ module RSMP
       def handle_s0002 status_code, status_name=nil
         case status_name
         when 'detectorlogicstatus'
-          TrafficControllerSite.make_status @detector_logics.map { |dl| dl.value ? '1' : '0' }.join
+          TrafficControllerSite.make_status @detector_logics.map { |dl| bool_to_digit(dl.value) }.join
         end
       end
 
@@ -445,7 +516,7 @@ module RSMP
         when 'intersection'
           TrafficControllerSite.make_status @intersection
         when 'status'
-          TrafficControllerSite.make_status !@dark_mode
+          TrafficControllerSite.make_status @function_position != 'Dark'
         end
       end
 
@@ -481,7 +552,7 @@ module RSMP
         when 'intersection'
           TrafficControllerSite.make_status @intersection
         when 'status'
-          TrafficControllerSite.make_status @yellow_flash
+          TrafficControllerSite.make_status TrafficControllerSite.to_rmsp_bool( @function_position == 'YellowFlash' )
         end
       end
 
@@ -557,7 +628,7 @@ module RSMP
       def handle_s0021 status_code, status_name=nil
         case status_name
         when 'detectorlogics'
-          TrafficControllerSite.make_status @detector_logics.map { |logic| logic.forced=='True' ? '1' : '0'}.join
+          TrafficControllerSite.make_status @detector_logics.map { |logic| bool_to_digit(logic.forced)}.join
         end
       end
 
@@ -611,7 +682,7 @@ module RSMP
       def handle_s0029 status_code, status_name=nil
         case status_name
         when 'status'
-          TrafficControllerSite.make_status ''
+          TrafficControllerSite.make_status @input_forced
         end
       end
 
@@ -677,7 +748,7 @@ module RSMP
         when 'checksum'
           TrafficControllerSite.make_status '1'
         when 'timestamp'
-          now = @node.clock.to_s
+          now = clock.to_s
           TrafficControllerSite.make_status now
         end
       end

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.9.0"
+  VERSION = "0.9.3"
 end

data/lib/rsmp.rb

@@ -25,9 +25,11 @@ require 'rsmp/collect/filter'
 require 'rsmp/collect/query'
 require 'rsmp/collect/status_query'
 require 'rsmp/collect/command_query'
+require 'rsmp/collect/alarm_query'
 require 'rsmp/collect/status_collector'
 require 'rsmp/collect/command_response_collector'
 require 'rsmp/collect/aggregated_status_collector'
+require 'rsmp/collect/alarm_collector'
 require 'rsmp/component'
 require 'rsmp/site'
 require 'rsmp/proxy'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.3
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-31 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -201,6 +201,7 @@ files:
 - bin/setup
 - config/supervisor.yaml
 - config/tlc.yaml
+- cucumber.yml
 - documentation/classes_and_modules.md
 - documentation/collecting_message.md
 - documentation/message_distribution.md
@@ -210,6 +211,8 @@ files:
 - lib/rsmp/archive.rb
 - lib/rsmp/cli.rb
 - lib/rsmp/collect/aggregated_status_collector.rb
+- lib/rsmp/collect/alarm_collector.rb
+- lib/rsmp/collect/alarm_query.rb
 - lib/rsmp/collect/collector.rb
 - lib/rsmp/collect/command_query.rb
 - lib/rsmp/collect/command_response_collector.rb