rsmp-validator 0.1.0

data/test/site/tlc/system_spec.rb

@@ -0,0 +1,76 @@
+describe 'Site::Tlc::System' do
+  include RSMP::Validator::Helpers::Security
+
+  # Verify status S0091 operator logged in/out OP-panel
+  #
+  # 1. Given the site_proxy is connected
+  # 2. Request status
+  # 3. Expect status response before timeout
+  it 'operator logged in/out of OP-panel is read with S0091' do
+    with_site(:connected, sxl: '>=1.0.7') do |site_proxy|
+      status_list = if RSMP::Proxy.version_meets_requirement?(site_proxy.sxl_version, '>=1.1')
+                      { S0091: [:user] }
+                    else
+                      { S0091: %i[user status] }
+                    end
+      site_proxy.request_status_and_collect(status_list,
+                                            within: RSMP::Validator.get_config('timeouts', 'status_response')).ok!
+    end
+  end
+
+  # Verify status S0092 operator logged in/out web-interface
+  #
+  # 1. Given the site_proxy is connected
+  # 2. Request status
+  # 3. Expect status response before timeout
+  it 'operator logged in/out of web-interface is read with S0092' do
+    with_site(:connected, sxl: '>=1.0.7') do |site_proxy|
+      status_list = if RSMP::Proxy.version_meets_requirement?(site_proxy.sxl_version, '>=1.1')
+                      { S0092: [:user] }
+                    else
+                      { S0092: %i[user status] }
+                    end
+      site_proxy.request_status_and_collect(status_list,
+                                            within: RSMP::Validator.get_config('timeouts', 'status_response')).ok!
+    end
+  end
+
+  # Verify status S0095 version of traffic controller
+  #
+  # 1. Given the site_proxy is connected
+  # 2. Request status
+  # 3. Expect status response before timeout
+  it 'version is read with S0095' do
+    with_site(:connected, sxl: '>=1.0.7') do |site_proxy|
+      site_proxy.request_status_and_collect({ S0095: [:status] },
+                                            within: RSMP::Validator.get_config('timeouts', 'status_response')).ok!
+    end
+  end
+
+  # 1. Verify connection
+  # 2. Send control command to set securitycode_level
+  # 3. Wait for status = true
+  # 4. Send control command to setsecuritycode_level
+  # 5. Wait for status = true
+  it 'security code is set with M0103' do
+    with_site(:connected, sxl: '>=1.0.7') do |site_proxy|
+      code1 = RSMP::Validator.get_config('secrets', 'security_codes', 1)
+      code2 = RSMP::Validator.get_config('secrets', 'security_codes', 2)
+      timeout = RSMP::Validator.get_config('timeouts', 'command_response')
+      site_proxy.tlc.set_security_code(level: 'Level1', old_code: code1, new_code: code1, within: timeout)
+      site_proxy.tlc.set_security_code(level: 'Level2', old_code: code2, new_code: code2, within: timeout)
+    end
+  end
+
+  # Verify that the site_proxy responds with NotAck if we send incorrect security cdoes.
+  # RThis hehaviour is defined in SXL >= 1.1. For earlier versions,
+  # The behaviour is undefined.
+  # 1. Given the site_proxy is connected
+  # 2. When we send a M0008 command with incorrect security codes
+  # 3. Then we should received a NotAck
+  it 'security code is rejected when incorrect' do
+    with_site(:connected, sxl: '>=1.1') do |site_proxy|
+      expect { wrong_security_code(site_proxy) }.to raise_exception(RSMP::MessageRejected)
+    end
+  end
+end

data/test/site/tlc/tlc_spec.rb

@@ -0,0 +1,7 @@
+describe 'Site' do
+  # Tests for Traffic Light Controllers.
+
+  describe 'Traffic Light Controller' do
+    # This group is intentionally empty, but exist so for documentation generation purposes.
+  end
+end

data/test/site/tlc/traffic_data_spec.rb

@@ -0,0 +1,151 @@
+describe 'Site::Tlc::TrafficData' do
+  include RSMP::Validator::Helpers::Status
+
+  # Verify status S0201 traffic counting: number of vehicles
+  #
+  # 1. Given the site_proxy is connected
+  # 2. Request status
+  # 3. Expect status response before timeout
+  it 'number of vehicles for a single detector is read with S0201' do
+    with_site(:connected, sxl: '>=1.0.7') do |site_proxy|
+      component = RSMP::Validator.get_config('components', 'detector_logic').keys.first
+      site_proxy.request_status_and_collect(
+        { S0201: %i[starttime vehicles] },
+        component: component,
+        within: RSMP::Validator.get_config('timeouts', 'status_response')
+      ).ok!
+    end
+  end
+
+  # Verify status S0205 traffic counting: number of vehicles
+  #
+  # 1. Given the site_proxy is connected
+  # 2. Request status
+  # 3. Expect status response before timeout
+  it 'number of vehicles for all detectors is read with S0205' do
+    with_site(:connected, sxl: '>=1.0.14') do |site_proxy|
+      site_proxy.request_status_and_collect({ S0205: %i[start vehicles] },
+                                            within: RSMP::Validator.get_config('timeouts', 'status_response')).ok!
+    end
+  end
+
+  # Verify status S0202 traffic counting: vehicle speed
+  #
+  # 1. Given the site_proxy is connected
+  # 2. Request status
+  # 3. Expect status response before timeout
+  it 'vehicle speed for a single detector is read with S0202' do
+    with_site(:connected, sxl: '>=1.0.7') do |site_proxy|
+      component = RSMP::Validator.get_config('components', 'detector_logic').keys.first
+      site_proxy.request_status_and_collect(
+        { S0202: %i[starttime speed] },
+        component: component,
+        within: RSMP::Validator.get_config('timeouts', 'status_response')
+      ).ok!
+    end
+  end
+
+  # Verify status S0206 traffic counting: vehicle speed
+  #
+  # 1. Given the site_proxy is connected
+  # 2. Request status
+  # 3. Expect status response before timeout
+  it 'vehicle speed for all detectors is read with S0206' do
+    with_site(:connected, sxl: '>=1.0.14') do |site_proxy|
+      site_proxy.request_status_and_collect({ S0206: %i[start speed] },
+                                            within: RSMP::Validator.get_config('timeouts', 'status_response')).ok!
+    end
+  end
+
+  # Verify status S0203 traffic counting: occupancy
+  #
+  # 1. Given the site_proxy is connected
+  # 2. Request status
+  # 3. Expect status response before timeout
+  it 'occupancy for a single detector is read with S0203' do
+    with_site(:connected, sxl: '>=1.0.7') do |site_proxy|
+      component = RSMP::Validator.get_config('components', 'detector_logic').keys.first
+      site_proxy.request_status_and_collect(
+        { S0203: %i[starttime occupancy] },
+        component: component,
+        within: RSMP::Validator.get_config('timeouts', 'status_response')
+      ).ok!
+    end
+  end
+
+  # Verify status S0207 traffic counting: occupancy
+  #
+  # 1. Given the site_proxy is connected
+  # 2. Request status
+  # 3. Expect status response before timeout
+  it 'occupancy for all detectors is read with S0207' do
+    with_site(:connected, sxl: '>=1.0.14') do |site_proxy|
+      result = wait_for_status(site_proxy, 'traffic counting: occupancy',
+                               { S0207: %i[start occupancy] },
+                               update_rate: 60)
+
+      occupancies = result.matcher_got_hash.dig('S0207', 'occupancy')
+      start = result.matcher_got_hash.dig('S0207', 'start')
+
+      expect(occupancies).to be_a(String)
+      expect(start).to be_a(String)
+
+      occupancies.split(',').each do |occupancy|
+        num = occupancy.to_i
+        assert((-1..100).cover?(num), "Occupancy must be in the range -1..100, got #{num}")
+      end
+    end
+  end
+
+  # Verify status S0204 traffic counting: classification
+  #
+  # 1. Given the site_proxy is connected
+  # 2. Request status
+  # 3. Expect status response before timeout
+  it 'classification for a single detector is read with S0204' do
+    with_site(:connected, sxl: '>=1.0.7') do |site_proxy|
+      component = RSMP::Validator.get_config('components', 'detector_logic').keys.first
+      site_proxy.request_status_and_collect(
+        { S0204: %i[
+          starttime
+          P
+          PS
+          L
+          LS
+          B
+          SP
+          MC
+          C
+          F
+        ] },
+        component: component,
+        within: RSMP::Validator.get_config('timeouts', 'status_response')
+      ).ok!
+    end
+  end
+
+  # Verify status S0208 traffic counting: classification
+  #
+  # 1. Given the site_proxy is connected
+  # 2. Request status
+  # 3. Expect status response before timeout
+  it 'classification for all detectors is read with S0208' do
+    with_site(:connected, sxl: '>=1.0.14') do |site_proxy|
+      site_proxy.request_status_and_collect(
+        { S0208: %i[
+          start
+          P
+          PS
+          L
+          LS
+          B
+          SP
+          MC
+          C
+          F
+        ] },
+        within: RSMP::Validator.get_config('timeouts', 'status_response')
+      ).ok!
+    end
+  end
+end

data/test/site/tlc/traffic_situations_spec.rb

@@ -0,0 +1,50 @@
+describe 'Site::Tlc::TrafficSituations' do
+  # Verify status S0015 current traffic situation
+  #
+  # 1. Given the site_proxy is connected
+  # 2. Request status
+  # 3. Expect status response before timeout
+  it 'is read with S0015' do
+    with_site(:connected, sxl: '>=1.0.7') do |site_proxy|
+      status_list = if RSMP::Proxy.version_meets_requirement?(site_proxy.sxl_version, '>=1.1')
+                      { S0015: %i[status source] }
+                    else
+                      { S0015: [:status] }
+                    end
+      site_proxy.request_status_and_collect(status_list,
+                                            within: RSMP::Validator.get_config('timeouts', 'status_response')).ok!
+    end
+  end
+
+  # Verify that we change traffic situation
+  #
+  # 1. Given the site_proxy is connected
+  # 2. Verify that there is a RSMP::Validator.get_config('validator') with a traffic situation
+  # 3. Send the control command to switch traffic situation for each traffic situation
+  # 4. Wait for status "Current traffic situation" = requested traffic situation
+  it 'is set with M0003' do
+    skip 'requires sxl >= 1.0.7' unless RSMP::Validator.sxl_matches?('>=1.0.7')
+    situations = RSMP::Validator.get_config('items', 'traffic_situations')
+    skip('No traffic situations configured') if situations.nil? || situations.empty?
+    timeout = RSMP::Validator.get_config('timeouts', 'command')
+    with_site(:connected) do |site_proxy|
+      situations.each do |traffic_situation|
+        assert site_proxy.tlc.set_traffic_situation(traffic_situation.to_s, within: timeout)
+      end
+    ensure
+      site_proxy.tlc.unset_traffic_situation(within: timeout)
+    end
+  end
+
+  # Verify status S0019 number of traffic situations
+  #
+  # 1. Given the site_proxy is connected
+  # 2. Request status
+  # 3. Expect status response before timeout
+  it 'list size is read with S0019' do
+    with_site(:connected, sxl: '>=1.0.7') do |site_proxy|
+      site_proxy.request_status_and_collect({ S0019: [:number] },
+                                            within: RSMP::Validator.get_config('timeouts', 'status_response')).ok!
+    end
+  end
+end

data/test/supervisor/aggregated_status_spec.rb

@@ -0,0 +1,18 @@
+describe 'Supervisor' do
+  # Validate behaviour related to aggregated status messages
+  describe 'Aggregated Status' do
+    # Validate that the supervisor responds correctly when we send an aggregated status message
+    it 'receives aggregated status' do
+      with_supervisor(:connected) do |supervisor_proxy|
+        component = supervisor_proxy.node.find_component RSMP::Validator.get_config('main_component')
+
+        # setting ':collect' will cause set_aggregated_status() to wait for the
+        # outgoing aggregated status is acknowledged
+        component.set_aggregated_status :high_priority_alarm, collect!: {
+          timeout: RSMP::Validator.get_config('timeouts', 'acknowledgement'),
+          num: 1
+        }
+      end
+    end
+  end
+end

data/test/supervisor/connect_spec.rb

@@ -0,0 +1,219 @@
+describe 'Supervisor' do
+  describe 'Connection Sequence' do
+    def connection_collect_options(timeout, length)
+      {
+        timeout: timeout,
+        num: length,
+        ingoing: true,
+        outgoing: true
+      }
+    end
+
+    def prepare_and_wait_for_collector(supervisor_proxy)
+      collector = supervisor_proxy.collector
+      collector.use_task Async::Task.current
+      collector.wait!
+    end
+
+    def direction_and_type_pairs(messages)
+      messages.map { |message| [message.direction.to_s, message.type] }
+    end
+
+    def get_connection_message(core_version, length)
+      timeout = RSMP::Validator.get_config('timeouts', 'ready')
+      got_messages = nil
+      with_supervisor(:isolated,
+                      'rsmp_versions' => [core_version],
+                      'collect' => {
+                        **connection_collect_options(timeout, length)
+                      }) do |supervisor_proxy|
+        prepare_and_wait_for_collector(supervisor_proxy)
+        assert(supervisor_proxy.ready?, 'expected site proxy to be ready')
+        got_messages = supervisor_proxy.collector.messages
+      end
+      direction_and_type_pairs(got_messages)
+    rescue Async::TimeoutError
+      raise "Did not collect #{length} messages within #{timeout}s"
+    end
+
+    def check_sequence_v311(core_version)
+      # in earlier core version, both sides sends a Version
+      # message simulatenously. we therefore cannot expect
+      # a specific sequence
+      # but we can expect a set of messages
+
+      expected_version_messages = [
+        %w[out Version],
+        %w[in MessageAck],
+        %w[in Version],
+        %w[out MessageAck]
+      ]
+      expected_watchdog_messages = [
+        %w[out Watchdog],
+        %w[in MessageAck],
+        %w[in Watchdog],
+        %w[out MessageAck]
+      ]
+
+      length = expected_version_messages.length +
+               expected_watchdog_messages.length
+
+      got = get_connection_message core_version, length
+      got_version_messages = got[0..3]
+      got_watchdog_messages = got[4..7]
+
+      assert(expected_version_messages.all? { |e| got_version_messages.include?(e) },
+             'expected version messages not found in connection sequence')
+      assert(got_watchdog_messages.all? { |e| expected_watchdog_messages.include?(e) },
+             'unexpected watchdog messages in connection sequence')
+    end
+
+    def check_sequence_v314(version)
+      expected = [
+        %w[out Version],
+        %w[in MessageAck],
+        %w[in Version],
+        %w[out MessageAck],
+        %w[out Watchdog],
+        %w[in MessageAck],
+        %w[in Watchdog],
+        %w[out MessageAck],
+        %w[out AggregatedStatus],
+        %w[in MessageAck]
+      ]
+      got = get_connection_message version, expected.length
+      expect(got).to eq(expected)
+    end
+
+    def check_sequence_v330(version)
+      expected = [
+        %w[out Version],
+        %w[in MessageAck],
+        %w[in Version],
+        %w[out MessageAck],
+        %w[out Watchdog],
+        %w[in MessageAck],
+        %w[in Watchdog],
+        %w[out MessageAck],
+        %w[out ComponentList],
+        %w[in MessageAck],
+        %w[out AggregatedStatus],
+        %w[in MessageAck]
+      ]
+      got = get_connection_message version, expected.length
+      expect(got).to eq(expected)
+    end
+
+    def check_sequence(version)
+      case version
+      when '3.1.1', '3.1.2', '3.1.3'
+        check_sequence_v311 version
+      when '3.1.4', '3.1.5', '3.2', '3.2.1', '3.2.2'
+        check_sequence_v314 version
+      when '3.3.0'
+        check_sequence_v330 version
+      else
+        raise "Unkown rsmp version #{version}"
+      end
+    end
+
+    # Verify the connection sequence when using rsmp core 3.1.1
+    #
+    # 1. Given the site is connected and using core 3.1.1
+    # 2. Send and receive handshake messages
+    # 3. Expect the handshake messages to be in the specified sequence corresponding to version 3.1.1
+    # 4. Expect the connection sequence to be complete
+    it 'exchanges correct connection sequence of rsmp version 3.1.1' do
+      skip 'requires core == 3.1.1' unless RSMP::Validator.core_matches?('3.1.1')
+      check_sequence '3.1.1'
+    end
+
+    # Verify the connection sequence when using rsmp core 3.1.2
+    #
+    # 1. Given the site is connected and using core 3.1.2
+    # 2. Send and receive handshake messages
+    # 3. Expect the handshake messages to be in the specified sequence corresponding to version 3.1.2
+    # 4. Expect the connection sequence to be complete
+    it 'exchanges correct connection sequence of rsmp version 3.1.2' do
+      skip 'requires core == 3.1.2' unless RSMP::Validator.core_matches?('3.1.2')
+      check_sequence '3.1.2'
+    end
+
+    # Verify the connection sequence when using rsmp core 3.1.3
+    #
+    # 1. Given the site is connected and using core 3.1.3
+    # 2. Send and receive handshake messages
+    # 3. Expect the handshake messages to be in the specified sequence corresponding to version 3.1.3
+    # 4. Expect the connection sequence to be complete
+    it 'exchanges correct connection sequence of rsmp version 3.1.3' do
+      skip 'requires core == 3.1.3' unless RSMP::Validator.core_matches?('3.1.3')
+      check_sequence '3.1.3'
+    end
+
+    # Verify the connection sequence when using rsmp core 3.1.4
+    #
+    # 1. Given the site is connected and using core 3.1.4
+    # 2. Send and receive handshake messages
+    # 3. Expect the handshake messages to be in the specified sequence corresponding to version 3.1.4
+    # 4. Expect the connection sequence to be complete
+    it 'exchanges correct connection sequence of rsmp version 3.1.4' do
+      skip 'requires core == 3.1.4' unless RSMP::Validator.core_matches?('3.1.4')
+      check_sequence '3.1.4'
+    end
+
+    # Verify the connection sequence when using rsmp core 3.1.5
+    #
+    # 1. Given the site is connected and using core 3.1.5
+    # 2. Send and receive handshake messages
+    # 3. Expect the handshake messages to be in the specified sequence corresponding to version 3.1.5
+    # 4. Expect the connection sequence to be complete
+    it 'exchanges correct connection sequence of rsmp version 3.1.5' do
+      skip 'requires core == 3.1.5' unless RSMP::Validator.core_matches?('3.1.5')
+      check_sequence '3.1.5'
+    end
+
+    # Verify the connection sequence when using rsmp core 3.2
+    #
+    # 1. Given the site is connected and using core 3.2
+    # 2. Send and receive handshake messages
+    # 3. Expect the handshake messages to be in the specified sequence corresponding to version 3.1.5
+    # 4. Expect the connection sequence to be complete
+    it 'exchanges correct connection sequence of rsmp version 3.2' do
+      skip 'requires core == 3.2' unless RSMP::Validator.core_matches?('3.2')
+      check_sequence '3.2'
+    end
+
+    # Verify the connection sequence when using rsmp core 3.2.1
+    #
+    # 1. Given the site is connected and using core 3.2.1
+    # 2. Send and receive handshake messages
+    # 3. Expect the handshake messages to be in the specified sequence corresponding to version 3.1.5
+    # 4. Expect the connection sequence to be complete
+    it 'exchanges correct connection sequence of rsmp version 3.2.1' do
+      skip 'requires core == 3.2.1' unless RSMP::Validator.core_matches?('3.2.1')
+      check_sequence '3.2.1'
+    end
+
+    # Verify the connection sequence when using rsmp core 3.2.2
+    #
+    # 1. Given the site is connected and using core 3.2.2
+    # 2. Send and receive handshake messages
+    # 3. Expect the handshake messages to be in the specified sequence corresponding to version 3.1.5
+    # 4. Expect the connection sequence to be complete
+    it 'exchanges correct connection sequence of rsmp version 3.2.2' do
+      skip 'requires core == 3.2.2' unless RSMP::Validator.core_matches?('3.2.2')
+      check_sequence '3.2.2'
+    end
+
+    # Verify the connection sequence when using rsmp core 3.3.0
+    #
+    # 1. Given the site is connected and using core 3.3.0
+    # 2. Send and receive handshake messages
+    # 3. Expect the ComponentList before application traffic
+    # 4. Expect the connection sequence to be complete
+    it 'exchanges correct connection sequence of rsmp version 3.3.0' do
+      skip 'requires core == 3.3.0' unless RSMP::Validator.core_matches?('3.3.0')
+      check_sequence '3.3.0'
+    end
+  end
+end

data/test/supervisor/supervisor_spec.rb

@@ -0,0 +1,11 @@
+# Tests for RSMP supervisors.
+# Supervisor testing is still preliminary, and only a small set of tests are available,
+# covering just the core specification. No tests are available for specific equipment types, e.g.
+# Traffic Light Controllers.
+#
+# When testing a supervisor the validator will run a local RSMP site. Because commands and status requests
+# are initiated by the supervisor, only a limited set of tests can be automated by the validator.
+
+describe 'Supervisor' do
+  # This group is intentionally empty, but exist so for documentation generation purposes.
+end