rsmp 0.1.17 → 0.1.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b583271d38fc35e2badabf94b0a8a764f07a8e36025c2902922d926adbf320b
-  data.tar.gz: 9e37dd8939d68a19e1cf16580c558c813e8a5d6214a733cc8dce08fe4957be59
+  metadata.gz: 78085a76c3c6c8d5b504f614f72137e9d540e884e5cb08c37fbea304d397a183
+  data.tar.gz: 9b2c223b8f9f4f1e221f72ee1c80b61dc365089a0bfa56ff343c5ff2a08efdf9
 SHA512:
-  metadata.gz: 1af3ecb44fc6c9e9fa0735b524c1561eafd91ef05775c0be325c8093635354e535d9d8f024d05cbc256859319a13795dfff34233165b8b57c53ac82fb76dbbd5
-  data.tar.gz: aeaa068f63614bcd8e3af873400e5af54810c51e7a1941d62834c1bd2d94a3ff4ae62e59d89ad3242749fff54126aa3ccabf3bf3ac672f29c9cac9611ebddd47
+  metadata.gz: 362fac56d0554fff5b48b53d317b70bd4bbf88efa56e7a097ac7a5b71231e474399cb6039f55f0cbb11789f861d31c9f9c93b4fbd32e5e6cf8b92f2159c98468
+  data.tar.gz: 49edc4941f8b23f45fbbb6e2d344254b3ce3a5ff309cbcd965f069822c3cf31683d75889762490077944300551406738e385901bf78469f5e29d8264664a668e

data/.gitignore

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

data/.gitmodules

@@ -1,4 +0,0 @@
-[submodule "rsmp_schema"]
-	path = lib/rsmp_schema
-        url = git@github.com:rsmp-nordic/rsmp_schema.git
-

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    rsmp (0.1.17)
-      async (~> 1.23.0)
-      async-io (~> 1.27.4)
+    rsmp (0.1.30)
+      async (~> 1.28.7)
+      async-io (~> 1.30.2)
       colorize (~> 0.8.1)
-      json_schemer (~> 0.2.11)
+      rsmp_schemer (~> 0.2.0)
       thor (~> 1.0.1)
 
 GEM
@@ -18,17 +18,18 @@ GEM
       ffi (~> 1.9)
       rspec-expectations (~> 3.4)
       thor (~> 1.0)
-    async (1.23.0)
-      console (~> 1.0)
+    async (1.28.9)
+      console (~> 1.10)
       nio4r (~> 2.3)
       timers (~> 4.1)
-    async-io (1.27.5)
+    async-io (1.30.2)
       async (~> 1.14)
     backports (3.17.0)
     builder (3.2.4)
     childprocess (3.0.0)
     colorize (0.8.1)
-    console (1.8.2)
+    console (1.12.0)
+      fiber-local
     contracts (0.16.0)
     cucumber (3.1.2)
       builder (>= 2.1.2)
@@ -47,21 +48,24 @@ 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)
+    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.11)
-      ecma-re-validator (~> 0.2)
+    hana (1.3.7)
+    json_schemer (0.2.18)
+      ecma-re-validator (~> 0.3)
       hana (~> 1.3)
-      regexp_parser (~> 1.5)
+      regexp_parser (~> 2.0)
       uri_template (~> 0.7)
     multi_json (1.14.1)
     multi_test (0.1.2)
-    nio4r (2.5.2)
+    nio4r (2.5.7)
     rake (13.0.1)
-    regexp_parser (1.7.0)
+    regexp_parser (2.1.1)
+    rsmp_schemer (0.2.0)
+      json_schemer (~> 0.2.18)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -77,7 +81,7 @@ GEM
     rspec-support (3.9.2)
     thor (1.0.1)
     timecop (0.9.1)
-    timers (4.3.0)
+    timers (4.3.3)
     uri_template (0.7.0)
 
 PLATFORMS
@@ -85,7 +89,7 @@ PLATFORMS
 
 DEPENDENCIES
   aruba (~> 1.0.0)
-  bundler (~> 2.1.4)
+  bundler (~> 2.2.3)
   cucumber (~> 3.1.2)
   rake (~> 13.0.1)
   rsmp!
@@ -94,4 +98,4 @@ DEPENDENCIES
   timecop (~> 0.9.1)
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/README.md

@@ -178,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/supervisor.yaml

@@ -1,18 +1,12 @@
 port: 12111
-rsmp_versions:
-  - 3.1.1
-  - 3.1.2
-  - 3.1.3
-  - 3.1.4
-
-watchdog_interval: 1
-watchdog_timeout: 2
-acknowledgement_timeout: 2
-store_messages: false
-command_response_timeout: 1
-status_response_timeout: 1
-status_update_timeout: 1
-
+guest:
+  sxl: tlc
+  intervals:
+    timer: 0.1
+    watchdog: 0.1
+  timeouts:
+    watchdog: 0.2
+    acknowledgement: 0.2
 log:
   active: true
   color: true
@@ -20,6 +14,7 @@ log:
   id: true
   component: true
   ip: false
+  port: true
   site_id: true
   text: true
   direction: true
@@ -27,4 +22,3 @@ log:
   json: true
   acknowledgements: false
   watchdogs: false
-

data/config/tlc.yaml

@@ -2,7 +2,8 @@ site_id: RN+SI0001
 supervisors:
   - ip: 127.0.0.1
     port: 12111
-
+sxl: tlc
+sxl_version: 1.0.15
 components:
   main:
     TC:
@@ -18,14 +19,16 @@ components:
       plan: 'BBB1NB'
   detector_logic:
     DL1:
-watchdog_interval: 1
-watchdog_timeout: 2
-acknowledgement_timeout: 1
-command_response_timeout: 1
-status_response_timeout: 1
-status_update_timeout: 1
-reconnect_interval: 0.1
-
+intervals:
+  timer: 0.1
+  watchdog: 0.1
+  reconnect: 0.1
+timeouts:
+  watchdog: 0.2
+  acknowledgement: 0.2
+security_codes:
+  1: '1111'
+  2: '2222'
 log:
   active: true
   color: true
@@ -40,4 +43,3 @@ log:
   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 - - Notifier --> Listeners
+
+A proxy distributes messages to listeners, when they are installed.
+
+Collectors are special listenerws 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 listener, and does not receive messages via the Notifier. 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.
+
+## Notifier
+A module that handles distributing messages to receivers.
+
+## Listener
+Receives messages as long as it's installed into a distributor.
+
+## Collector
+A subclass of Receiver that wait for specific messages. Once received
+the client receives the collection.
+
+## Proxy
+A proxy includes the Notifier module and distributes each message to listerens after processing it.
+

data/lib/rsmp.rb

@@ -10,21 +10,30 @@ require 'json_schemer'
 require 'async/queue'
 
 require 'rsmp/rsmp'
-require 'rsmp/base'
+require 'rsmp/deep_merge'
+require 'rsmp/inspect'
+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/convert/import/yaml'
+require 'rsmp/convert/export/json_schema'
+
+require 'rsmp/version'

data/lib/rsmp/archive.rb

@@ -3,22 +3,26 @@
 
 module RSMP
   class Archive
+    include Inspect
+
     attr_reader :items
-    attr_accessor :probes
 
-    def initialize
+    @@index = 0
+
+    def initialize  max=100
       @items = []
-      @probes = ProbeCollection.new
+      @max = max
+    end
+
+    def inspect
+      "#<#{self.class.name}:#{self.object_id}, #{inspector(:@items)}>"
     end
 
     def self.prepare_item item
       raise ArgumentError unless item.is_a? Hash
     
-      now_obj = RSMP.now_object
-      now_str = RSMP.now_string(now_obj)
-
       cleaned = item.select { |k,v| [:author,:level,:ip,:port,:site_id,:component_id,:str,:message,:exception].include? k }
-      cleaned[:timestamp] = now_obj
+      cleaned[:timestamp] = Clock.now
       if item[:message]
         cleaned[:direction] = item[:message].direction 
         cleaned[:component_id] = item[:message].attributes['cId'] 
@@ -27,6 +31,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 +47,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

@@ -2,106 +2,137 @@ require 'thor'
 require 'rsmp'
 
 module RSMP
-	class CLI < Thor
-
-		desc "site", "Run RSMP site"
-		method_option :config, :type => :string, :aliases => "-c", banner: 'Path to .yaml config file'
-		method_option :id, :type => :string, :aliases => "-i", banner: 'RSMP site id'
-		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 }
-
-			if options[:config]
-				if File.exist? options[:config]
-					settings = YAML.load_file options[:config]
-					log_settings = settings.delete('log') || {}
-				else
-					puts "Error: Config #{options[:config]} not found"
-					exit
-				end
-			end
-
-			if options[:id]
-				settings['site_id'] = options[:id]
-			end
-
-			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?
-					settings[:supervisors] << {"ip"=>ip, "port"=>port}
-				end
-			end
-
-			if options[:log]
-				log_settings['path'] = options[:log]
-			end
-
-			if options[:json]
-				log_settings['json'] = options[:json]
-			end
-
-			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"
-		method_option :config, :type => :string, :aliases => "-c", banner: 'Path to .yaml config file'
-		method_option :id, :type => :string, :aliases => "-i", banner: 'RSMP site id'
-		method_option :ip, :type => :numeric, banner: 'IP address to listen on'			
-		method_option :port, :type => :string, :aliases => "-p", banner: 'Port to listen on'
-		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'
-		def supervisor
-			settings = {}
-			log_settings = { 'active' => true }
-
-			if options[:config]
-				if File.exist? options[:config]
-					settings = YAML.load_file options[:config]
-					log_settings = settings.delete 'log'
-				else
-					puts "Error: Config #{options[:config]} not found"
-					exit
-				end
-			end
-
-			if options[:id]
-				settings['site_id'] = options[:id]
-			end
-
-			if options[:ip]
-				settings['ip'] = options[:ip]
-			end
-
-			if options[:port]
-				settings['port'] = options[:port]
-			end
-
-			if options[:log]
-				log_settings['path'] = options[:log]
-			end
-
-			if options[:json]
-				log_settings['json'] = options[:json]
-			end
-
-			RSMP::Supervisor.new(supervisor_settings:settings,log_settings:log_settings).start
-		end
-
-	end
+  class CLI < Thor
+
+    desc "site", "Run RSMP site"
+    method_option :config, :type => :string, :aliases => "-c", banner: 'Path to .yaml config file'
+    method_option :id, :type => :string, :aliases => "-i", banner: 'RSMP site id'
+    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 }
+
+      if options[:config]
+        if File.exist? options[:config]
+          settings = YAML.load_file options[:config]
+          log_settings = settings.delete('log') || {}
+        else
+          puts "Error: Config #{options[:config]} not found"
+          exit
+        end
+      end
+
+      if options[:id]
+        settings['site_id'] = options[:id]
+      end
+
+      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?
+          settings['supervisors'] << {"ip"=>ip, "port"=>port}
+        end
+      end
+
+      if options[:log]
+        log_settings['path'] = options[:log]
+      end
+
+      if options[:json]
+        log_settings['json'] = options[:json]
+      end
+
+      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
+    rescue RSMP::Schemer::UnknownSchemaTypeError => e
+      puts "Cannot start site: #{e}"
+    rescue RSMP::Schemer::UnknownSchemaVersionError => e
+      puts "Cannot start site: #{e}"
+    rescue Psych::SyntaxError => e
+      puts "Cannot read config file #{e}"
+    end
+
+    desc "supervisor", "Run RSMP supervisor"
+    method_option :config, :type => :string, :aliases => "-c", banner: 'Path to .yaml config file'
+    method_option :id, :type => :string, :aliases => "-i", banner: 'RSMP site id'
+    method_option :ip, :type => :numeric, banner: 'IP address to listen on'      
+    method_option :port, :type => :string, :aliases => "-p", banner: 'Port to listen on'
+    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'
+    def supervisor
+      settings = {}
+      log_settings = { 'active' => true }
+
+      if options[:config]
+        if File.exist? options[:config]
+          settings = YAML.load_file options[:config]
+          log_settings = settings.delete 'log'
+        else
+          puts "Error: Config #{options[:config]} not found"
+          exit
+        end
+      end
+
+      if options[:id]
+        settings['site_id'] = options[:id]
+      end
+
+      if options[:ip]
+        settings['ip'] = options[:ip]
+      end
+
+      if options[:port]
+        settings['port'] = options[:port]
+      end
+
+      if options[:log]
+        log_settings['path'] = options[:log]
+      end
+
+      if options[:json]
+        log_settings['json'] = options[:json]
+      end
+
+      RSMP::Supervisor.new(supervisor_settings:settings,log_settings:log_settings).start
+    rescue RSMP::ConfigurationError => e
+      puts "Cannot start supervisor: #{e}"
+    end
+
+    desc "convert", "Convert SXL from YAML to JSON Schema"
+    method_option :in, :type => :string, :aliases => "-i", banner: 'Path to YAML input file'
+    method_option :out, :type => :string, :aliases => "-o", banner: 'Path to JSON Schema output file'
+    def convert
+      unless options[:in]
+        puts "Error: Input option missing"
+        exit
+      end
+
+      unless options[:out]
+        puts "Error: Output option missing"
+        exit
+      end
+
+      unless File.exist? options[:in]
+        puts "Error: Input path file #{options[:in]} not found"
+        exit
+      end
+
+      sxl = RSMP::Convert::Import::YAML.read options[:in]
+      RSMP::Convert::Export::JSONSchema.write sxl, options[:out]
+    end
+
+  end
 end