rsmp 0.1.11 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96c6fb10c7c6e59410be4cbd59a29ca3cd157231e3e8800982616c0d036d82bb
-  data.tar.gz: 3f29330cabf6abf2f0e96c81cefd3765560ae6224e41dfc59061473951c0e756
+  metadata.gz: 0aea7740c0640bc069efa1ec9426deb23b3bf4e3f7dce4656e3df814500615d3
+  data.tar.gz: 30d954a75a62d71d46b76b30e448dbc2e30281784f18b82488780e9837b1223b
 SHA512:
-  metadata.gz: 85c04e5637cefcf677546c2dbd887126276499c88d1e3261080957177f6e2a8853694134e28733ff9d77268a7ba574ec498801bf5f0752d92b919b8d64884012
-  data.tar.gz: ba575044445b063bff0751aeddf42849de980604f43d69765b62a39764a13e7f46ea220bc08bbc6ecabc0cdadc0a287c2ade6b3e846a8a823a101a4674420692
+  metadata.gz: 7a42695cbf11f334d1873843a2550e7734d7719e8fca7ef245d32946d71aa884b6305ff329afbd1713caec41bf213bd0aab62d4f91f5d685c05ed5ce929c68f6
+  data.tar.gz: 3e6c90b6aa6d505285fc27613ce06716f5a00a21893d266cb2e31e0c0f99ea2784610f30f9c4a583c129e95c94770c84a08aabcc6e0e35accfc70b94f3aa2e60

data/.gitignore

@@ -12,5 +12,6 @@ log
 /spec/reports/
 /tmp/
 /lib/rsmp_schema/
+/config/private/
 
 

data/Gemfile.lock

@@ -1,35 +1,35 @@
 PATH
   remote: .
   specs:
-    rsmp (0.1.11)
-      async (~> 1.23.0)
-      async-io (~> 1.27.1)
+    rsmp (0.1.21)
+      async (~> 1.28.3)
+      async-io (~> 1.30.1)
       colorize (~> 0.8.1)
-      json_schemer (~> 0.2.8)
-      thor (~> 0.20.3)
+      json_schemer (~> 0.2.17)
+      thor (~> 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    aruba (0.14.11)
-      childprocess (>= 0.6.3, < 3.0.0)
-      contracts (~> 0.9)
-      cucumber (>= 1.3.19)
+    aruba (1.0.0)
+      childprocess (~> 3.0)
+      contracts (~> 0.16.0)
+      cucumber (>= 2.4, < 4.0)
       ffi (~> 1.9)
-      rspec-expectations (>= 2.99)
-      thor (~> 0.19)
-    async (1.23.0)
-      console (~> 1.0)
+      rspec-expectations (~> 3.4)
+      thor (~> 1.0)
+    async (1.28.3)
+      console (~> 1.10)
       nio4r (~> 2.3)
       timers (~> 4.1)
-    async-io (1.27.1)
+    async-io (1.30.1)
       async (~> 1.14)
-    backports (3.15.0)
-    builder (3.2.3)
-    childprocess (2.0.0)
-      rake (< 13.0)
+    backports (3.17.0)
+    builder (3.2.4)
+    childprocess (3.0.0)
     colorize (0.8.1)
-    console (1.6.0)
+    console (1.10.1)
+      fiber-local
     contracts (0.16.0)
     cucumber (3.1.2)
       builder (>= 2.1.2)
@@ -48,54 +48,52 @@ GEM
     cucumber-tag_expressions (1.1.1)
     cucumber-wire (0.0.1)
     diff-lcs (1.3)
-    ecma-re-validator (0.2.0)
-      regexp_parser (~> 1.2)
-    ffi (1.11.1)
+    ecma-re-validator (0.3.0)
+      regexp_parser (~> 2.0)
+    ffi (1.12.2)
+    fiber-local (1.0.0)
     gherkin (5.1.0)
-    hana (1.3.5)
-    json_schemer (0.2.8)
-      ecma-re-validator (~> 0.2)
+    hana (1.3.7)
+    json_schemer (0.2.17)
+      ecma-re-validator (~> 0.3)
       hana (~> 1.3)
-      regexp_parser (~> 1.5)
+      regexp_parser (~> 2.0)
       uri_template (~> 0.7)
-    multi_json (1.13.1)
+    multi_json (1.14.1)
     multi_test (0.1.2)
-    nio4r (2.5.2)
-    rake (10.5.0)
-    regexp_parser (1.6.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    nio4r (2.5.4)
+    rake (13.0.1)
+    regexp_parser (2.0.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rspec-with_params (0.2.0)
-      rspec (~> 3.0)
-    thor (0.20.3)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    thor (1.0.1)
     timecop (0.9.1)
-    timers (4.3.0)
+    timers (4.3.2)
     uri_template (0.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  aruba (~> 0.14.11)
-  bundler (~> 2.0)
+  aruba (~> 1.0.0)
+  bundler (~> 2.2.3)
   cucumber (~> 3.1.2)
-  rake (~> 10.0)
+  rake (~> 13.0.1)
   rsmp!
-  rspec (~> 3.0)
-  rspec-expectations (~> 3.8.3)
-  rspec-with_params (~> 0.2.0)
+  rspec (~> 3.9.0)
+  rspec-expectations (~> 3.9.1)
   timecop (~> 0.9.1)
 
 BUNDLED WITH
-   2.1.0.pre.2
+   2.2.3

data/README.md

@@ -163,6 +163,12 @@ The ```site``` command will start an RSMP site, which will try to connect to one
 2019-11-11 12:22:00 UTC  RN+SU0001  C1  <--  8280  Sent AggregatedStatus
 ```
 
+
+Use the the --type switch to select a specific type of site. Messages will be validated against the corresponding SXL JSON schema. Without any type specified, messages will be validated against the core RSMP schema only.
+
+Use the ```tlc``` site type to run an emulation of a traffic light controller. This type of site implements enough of functionality to pass all the rsmp_validator tests. You can setup signal group components, in the config file.
+
+
 ### CLI help and options.
 Use ```--help <command>``` to get a list of available options.
 
@@ -172,7 +178,7 @@ Use ```--config <path>``` to point to a .yaml config file, controlling things li
 ### RSpec
 RSpec tests are located in spec/. The tests will start supervisor and sites to test communication, but will do so on port 13111, rather than the usual port 12111, to avoid inferference with other RMSP processes running locally.
 
-Note that these tests are NOT intented for testing external equipment or systems. The tests are for validating the code in this repository. To test external equipment or systems.
+Note that these tests are NOT intented for testing external equipment or systems. The tests are for validating the code in this repository. To test external equipment or systems use the rsmp_validator tool.
 
 ```console
 $ rspec

data/config/site.yaml

@@ -12,8 +12,8 @@ rsmp_versions:
   - 3.1.4
 
 components:
-  C1:
-    type: main
+  main:
+    C1:
 
 watchdog_interval: 1
 watchdog_timeout: 2

data/config/tlc.yaml

@@ -0,0 +1,44 @@
+site_id: RN+SI0001
+supervisors:
+  - ip: 127.0.0.1
+    port: 12111
+
+components:
+  main:
+    TC:
+      cycle_time: 6
+  signal_group:
+    A1:
+      plan: '11NBBB'
+    A2:
+      plan: '1NBBBB'
+    B1:
+      plan: 'BBB11N'
+    B2:
+      plan: 'BBB1NB'
+  detector_logic:
+    DL1:
+watchdog_interval: 0.1
+watchdog_timeout: 0.2
+acknowledgement_timeout: 0.2
+reconnect_interval: 0.1
+
+security_codes:
+  1: '1111'
+  2: '2222'
+
+log:
+  active: true
+  color: true
+  timestamp: true
+  id: true
+  component: true
+  ip: false
+  site_id: true
+  level: false
+  text: true
+  direction: true
+  json: true
+  acknowledgements: false
+  watchdogs: false
+

data/documentation/classes_and_modules.md

@@ -0,0 +1,65 @@
+# Classes and Modules
+
+## Overview
+```
+	 Node - - include Logging, Wait
+	/   \
+Super    Site - - include Components
+
+
+              Proxy - - include Logging, Wait
+              /    \
+SupervisorProxy    SiteProxy - - include Components, SiteProxyWait
+```
+
+## Modules
+### Logging
+Handle logging.
+
+### Wait
+Handles waiting for an async condition and block.
+
+### SiteProxyWait
+Handles waiting for different types of messages and responses from a remote site.
+
+### Components
+Component handling.
+
+## Classes
+### Node
+A Node has an async task. A node can be started and stopped.
+
+Node has two child classes: Site and Supervisor.
+
+### Site
+A Site represents an RSMP site, typically a traffic light, variable message sign, or other type of field equipment. An RSMP site can connect to one or more supervisors.
+
+A Site has one or more SupervisorProxies (connections to supervisor).
+
+A site has one of more components.
+
+### Supervisor 
+A Supervisor represents an RSMP supervisor, typically a central supervisor system. An RSMP supervisor can handle connections one or more sites.
+
+A Supervisor has one or more SiteProxies (connections to sites).
+
+### Proxy
+A Proxy represents a connection to a remove Site or Supervisor and handles the RSMP interface.
+
+A proxy has an async task listening for messages on an TCP/IP socket. Incoming RSMP messages are parsing and appropriate handles are called.
+
+A proxy also has a repaating async timer task for handling watchdog and acknowledgement timeouts.
+
+Proxy has to child classes: SiteProxy and SupervisorProxy.
+
+### SiteProxy
+A connection to a remote Site.
+
+Handles RSMP messaging specific to a supervisor, including methods for requesting status, sending commands, etc.
+
+A SiteProxy has one or more components, representing the components in the remote site.
+
+### SupervisorProxy
+A connection to a remote Site. Handles RSMP messaging specific to a site, including sending aggregated status, handling status requests, status subscription and command requests.
+
+Status and command requests are delegated to the appropriate components.

data/documentation/message_distribution.md

@@ -0,0 +1,23 @@
+# Message distribution
+
+Proxy - - Distributor --> Receivers
+
+A proxy distributes message to receivers, when they are installed.
+
+Probes are special receivers that waits for specific message, and are used to implement methods for waiting for RMSP responses, statuses, alarms, etc.
+
+Note that Archive is not a receiver, and does not receive messages via the Distributor. Instead the Archive gets and stores messages via the log() interface in the Logging module. The reason is that the items that the Archive and the Logger contain other data as well as the message, like error messages, warnings, text descriptions, colors codes, etc. The Distributor and Receiver handles only Message objects.
+
+## Distributor
+A module that handles distributing messages to receivers.
+
+## Receiver
+Receives messages as long as it's installed into a distributor.
+
+## Probe
+A subclass of Receiver that wait for specific messages. Once received
+the client receives the collection.
+
+## Proxy
+A proxy includes the Distributor module and distributes each message to listerens after processing it.
+

data/lib/rsmp.rb

@@ -10,20 +10,25 @@ require 'json_schemer'
 require 'async/queue'
 
 require 'rsmp/rsmp'
-require 'rsmp/base'
+require 'rsmp/logging'
 require 'rsmp/wait'
-require 'rsmp/version'
 require 'rsmp/node'
 require 'rsmp/supervisor'
+require 'rsmp/components'
+require 'rsmp/notifier'
+
+require 'rsmp/listener'
+require 'rsmp/collector'
 require 'rsmp/component'
-require 'rsmp/site_base'
 require 'rsmp/site'
 require 'rsmp/proxy'
 require 'rsmp/supervisor_proxy'
+require 'rsmp/site_proxy_wait'
 require 'rsmp/site_proxy'
 require 'rsmp/error'
-require 'rsmp/probe'
-require 'rsmp/probe_collection'
 require 'rsmp/message'
 require 'rsmp/logger'
 require 'rsmp/archive'
+require 'rsmp/tlc'
+
+require 'rsmp/version'

data/lib/rsmp/archive.rb

@@ -4,11 +4,12 @@
 module RSMP
   class Archive
     attr_reader :items
-    attr_accessor :probes
 
-    def initialize
+    @@index = 0
+
+    def initialize  max=100
       @items = []
-      @probes = ProbeCollection.new
+      @max = max
     end
 
     def self.prepare_item item
@@ -27,6 +28,14 @@ module RSMP
       cleaned
     end
 
+    def self.increase_index
+      @@index += 1
+    end
+
+    def self.current_index
+      @@index
+    end
+
     def by_level levels
       items.select { |item| levels.include? item[:level] }
     end
@@ -35,27 +44,16 @@ module RSMP
       items.map { |item| item[:str] }
     end
 
-    def current_index
-      @items.size
-    end
-
     def add item
-      item[:index] = @items.size
+      item[:index] = RSMP::Archive.increase_index
       @items << item
-      probe item
-    end
-
-    def capture task, options, &block
-      probe = RSMP::Probe.new self
-      probe.capture task, options, &block
+      if @items.size > @max
+        @items.shift
+      end
     end
     
     private
 
-    def probe item
-      @probes.process item
-    end
-
     def find options, &block
       # search backwards from newest to older, stopping once messages
       # are older that options[:earliest]

data/lib/rsmp/cli.rb

@@ -10,6 +10,7 @@ module RSMP
 		method_option :supervisors, :type => :string, :aliases => "-s", banner: 'ip:port,... list of supervisor to connect to'			
 		method_option :log, :type => :string, :aliases => "-l", banner: 'Path to log file'
 		method_option :json, :type => :boolean, :aliases => "-j", banner: 'Show JSON messages in log'
+		method_option :type, :type => :string, :aliases => "-t", banner: 'Type of site: [tlc]'
 		def site
 			settings = {}
 			log_settings = { 'active' => true }
@@ -17,7 +18,7 @@ module RSMP
 			if options[:config]
 				if File.exist? options[:config]
 					settings = YAML.load_file options[:config]
-					log_settings = settings.delete 'log'
+					log_settings = settings.delete('log') || {}
 				else
 					puts "Error: Config #{options[:config]} not found"
 					exit
@@ -28,9 +29,9 @@ module RSMP
 				settings['site_id'] = options[:id]
 			end
 
-		if options[:supervisors]
-			options[:supervisors].split(',').each do |supervisor|
-				settings[:supervisors] ||= []
+			if options[:supervisors]
+				options[:supervisors].split(',').each do |supervisor|
+					settings[:supervisors] ||= []
 					ip, port = supervisor.split ':'
 					ip = '127.0.0.1' if ip.empty?
 					port = '12111' if port.empty?
@@ -46,7 +47,16 @@ module RSMP
 				log_settings['json'] = options[:json]
 			end
 
-			RSMP::Site.new(site_settings:settings, log_settings: log_settings).start
+			site_class = RSMP::Site
+			if options[:type]
+				case options[:type]
+					when 'tlc'
+						site_class = RSMP::Tlc
+					else
+						site_class = RSMP::Site
+				end
+			end
+			site_class.new(site_settings:settings, log_settings: log_settings).start
 		end
 
 		desc "supervisor", "Run RSMP supervisor"