rsmp 0.42.9 → 0.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14695207a9d722b94988550ab5a9d2e5c3dfb31cab1073601c9dce66a6b15b08
-  data.tar.gz: 9d3721e8c5155a3156c678142f09bc2f343d336b55bd8906343b4d6feb785084
+  metadata.gz: 4388b553588ba4ad894f3daac620992cc351b4c2d061132a37690f77e72971ad
+  data.tar.gz: 0dfd1b5a8a83ab75810a8a822e6507dca3728b53e99462bf69fe96f924395fac
 SHA512:
-  metadata.gz: 4c0b0ba9f632cc0c567e4a989510cde9f9cf3e4c968d7112c147dc98e87862c83bf49dc8f6b4994b6c9386e26d9a486718bf223c1dd1fa8883643d824191dd79
-  data.tar.gz: 6026dc8779960ad5bbf4006bc813dad26b0d98e4abca735f51cc8563097874014d3dc5a928949198c9b6c315ca7fd51c44585fbaee6b78b520ca27f4b47bd05f
+  metadata.gz: 513d73bbb2e42366fbb0c598f92ef97745379769ecc2ba7aa79fda31e94fc3c34f39e81daa707e687159c7d644034057671b14ab5941da0615b3884fa95e53ac
+  data.tar.gz: 11cb9674aea89d3c3f693707ecce22d65632a0391ef635cb6ef0c1ea4226445c747c117e34ef0e28eb056618cd262f8f8d51f75941e9107d8fb8f17633453156

data/.rubocop.yml

@@ -8,6 +8,8 @@ AllCops:
     - '.bundle/**/*'
     - 'ignore/**/*'
     - 'config/private/**/*'
+    - 'schemas/**/*'
+    - 'tmp/**/*'
 
 # Allow longer line lengths for tests with long JSON strings
 Layout/LineLength:

data/CHANGELOG.md

@@ -652,4 +652,10 @@ Initial release.
 
 ## 0.40.1
 - fix config normalization
-- improve config schema validation
+- improve config schema validation
+
+## 0.43.0
+- rsmp_schema folded into this gem
+- all schema files vendored into this repo, with rake task to update them
+- moved `rake regenerate` to `rsmp schema generate` CLI
+ 

data/Gemfile.lock

@@ -1,14 +1,15 @@
 PATH
   remote: .
   specs:
-    rsmp (0.42.9)
+    rsmp (0.43.0)
       async (~> 2.32)
       colorize (~> 1.1)
       io-endpoint (~> 0.15)
       io-stream (~> 0.10)
+      json_schemer (~> 2.5)
       logger (~> 1.6)
       ostruct (~> 0.6)
-      rsmp_schema (~> 0.10)
+      thor (~> 1.5)
 
 GEM
   remote: https://rubygems.org/
@@ -95,9 +96,6 @@ GEM
     rainbow (3.1.1)
     rake (13.4.2)
     regexp_parser (2.12.0)
-    rsmp_schema (0.10.1)
-      json_schemer (~> 2.5)
-      thor (~> 1.5)
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)

data/Rakefile

@@ -4,4 +4,40 @@ task :test do
   sh 'bundle exec sus'
 end
 
+CORE_VERSIONS = %w[3.1.2 3.1.3 3.1.4 3.1.5 3.2.0 3.2.1 3.2.2].freeze
+TLC_VERSIONS  = %w[1.0.7 1.0.8 1.0.9 1.0.10 1.0.13 1.0.14 1.0.15 1.1.0 1.2.0 1.2.1].freeze
+
+# Update vendored schemas from source repos.
+# Usage: rake schemas:update[/path/to/rsmp_core,/path/to/rsmp_sxl_traffic_lights]
+# Defaults to sibling directories ../rsmp_core and ../rsmp_sxl_traffic_lights.
+#
+# NOTE: The source repos must have the version branches up to date locally.
+# If the remote has been updated, fetch first:
+#   git -C ../rsmp_core fetch
+#   git -C ../rsmp_sxl_traffic_lights fetch
+namespace :schemas do
+  task :update, [:core_path, :tlc_path] do |_t, args|
+    core_path = File.expand_path(args[:core_path] || '../rsmp_core')
+    tlc_path  = File.expand_path(args[:tlc_path]  || '../rsmp_sxl_traffic_lights')
+
+    puts "Updating core schemas from #{core_path}:"
+    CORE_VERSIONS.each do |ver|
+      target = "schemas/core/#{ver}"
+      puts "  #{ver}"
+      FileUtils.rm_rf(target)
+      FileUtils.mkdir_p(target)
+      sh "git -C #{core_path} archive refs/heads/#{ver} -- schema/ | tar x --strip-components=1 -C #{target}"
+    end
+
+    puts "Updating TLC schemas from #{tlc_path}:"
+    TLC_VERSIONS.each do |ver|
+      target = "schemas/tlc/#{ver}"
+      puts "  #{ver}"
+      FileUtils.rm_rf(target)
+      FileUtils.mkdir_p(target)
+      sh "git -C #{tlc_path} archive refs/heads/#{ver} -- schema/ | tar x --strip-components=1 -C #{target}"
+    end
+  end
+end
+
 task default: :test

data/lib/rsmp/cli.rb

@@ -2,6 +2,24 @@ require 'thor'
 require_relative '../rsmp'
 
 module RSMP
+  # CLI subcommands for SXL schema operations.
+  class SchemaCLI < Thor
+    namespace :schema
+    desc 'generate', 'Generate JSON Schema files from sxl.yaml'
+    method_option :in,  type: :string, aliases: '-i', banner: 'Path to sxl.yaml input file', default: 'sxl.yaml'
+    method_option :out, type: :string, aliases: '-o', banner: 'Path to output directory',    default: '.'
+    def generate
+      input  = options[:in]
+      output = options[:out]
+      unless File.exist?(input)
+        puts "Error: Input file #{input} not found"
+        exit 1
+      end
+      sxl = RSMP::Convert::Import::YAML.read(input)
+      RSMP::Convert::Export::JSONSchema.write(sxl, output)
+    end
+  end
+
   # CLI commands for running RSMP site and supervisor.
   class CLI < Thor
     desc 'version', 'Show version'
@@ -47,14 +65,7 @@ module RSMP
       # ctrl-c
     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
-      validate_convert_options
-      validate_input_file_exists
-      perform_conversion
-    end
+    register SchemaCLI, 'schema', 'schema COMMAND', 'SXL schema commands'
 
     no_commands do
       def load_site_configuration
@@ -187,30 +198,6 @@ module RSMP
       end
     end
 
-    def validate_convert_options
-      unless options[:in]
-        puts 'Error: Input option missing'
-        exit
-      end
-
-      return if options[:out]
-
-      puts 'Error: Output option missing'
-      exit
-    end
-
-    def validate_input_file_exists
-      return if File.exist? options[:in]
-
-      puts "Error: Input path file #{options[:in]} not found"
-      exit
-    end
-
-    def perform_conversion
-      sxl = RSMP::Convert::Import::YAML.read options[:in]
-      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?

data/lib/rsmp/convert/export/json_schema/items.rb

@@ -0,0 +1,55 @@
+module RSMP
+  module Convert
+    module Export
+      # Converts SXL definitions to JSON Schema files.
+      module JSONSchema
+        # convert yaml alarm/status/command item to corresponding json schema
+        def self.build_item(item, property_key: 'v')
+          arguments = item['arguments']
+          return simple_item(item) unless arguments
+
+          property_key == 's' ? build_status_item(item, arguments) : build_default_item(item, arguments, property_key)
+        end
+
+        def self.simple_item(item)
+          {
+            '$schema' => 'https://json-schema.org/draft/2020-12/schema',
+            'description' => item['description']
+          }
+        end
+
+        def self.build_status_item(item, arguments)
+          branches = arguments.map do |key, argument|
+            {
+              'if' => { 'properties' => { 'n' => { 'const' => key } } },
+              'then' => { 'properties' => { 's' => build_value(argument) } }
+            }
+          end
+          {
+            '$schema' => 'https://json-schema.org/draft/2020-12/schema',
+            'description' => item['description'],
+            'properties' => { 'n' => { 'enum' => arguments.keys.sort } },
+            'if' => { '$ref' => '../defs/guards.json#/$defs/q_unknown_or_undefined' },
+            'then' => {},
+            'else' => { 'allOf' => branches }
+          }
+        end
+
+        def self.build_default_item(item, arguments, property_key)
+          rules = arguments.map do |key, argument|
+            {
+              'if' => { 'properties' => { 'n' => { 'const' => key } } },
+              'then' => { 'properties' => { property_key => build_value(argument) } }
+            }
+          end
+          {
+            '$schema' => 'https://json-schema.org/draft/2020-12/schema',
+            'description' => item['description'],
+            'properties' => { 'n' => { 'enum' => arguments.keys.sort } },
+            'allOf' => rules
+          }
+        end
+      end
+    end
+  end
+end

data/lib/rsmp/convert/export/json_schema/outputs.rb

@@ -0,0 +1,147 @@
+module RSMP
+  module Convert
+    module Export
+      # Converts SXL definitions to JSON Schema files.
+      module JSONSchema
+        GUARDS_JSON = {
+          '$schema' => 'https://json-schema.org/draft/2020-12/schema',
+          '$defs' => {
+            'q_unknown_or_undefined' => {
+              'allOf' => [
+                { 'required' => ['q'] },
+                { 'properties' => { 'q' => { 'enum' => %w[undefined unknown] } } }
+              ]
+            }
+          }
+        }.freeze
+
+        # convert alarms to json schema
+        def self.output_alarms(out, items)
+          list = items.keys.sort.map do |key|
+            {
+              'if' => { 'required' => ['aCId'], 'properties' => { 'aCId' => { 'const' => key } } },
+              'then' => { '$ref' => "#{key}.json" }
+            }
+          end
+          json = {
+            '$schema' => 'https://json-schema.org/draft/2020-12/schema',
+            'properties' => {
+              'aCId' => { 'enum' => items.keys.sort },
+              'rvs' => { 'items' => { 'allOf' => list } }
+            }
+          }
+          out['alarms/alarms.json'] = output_json json
+          items.each_pair { |key, item| output_alarm out, key, item }
+        end
+
+        # convert an alarm to json schema
+        def self.output_alarm(out, key, item)
+          json = build_item item
+          out["alarms/#{key}.json"] = output_json json
+        end
+
+        # convert statuses to json schema
+        def self.output_statuses(out, items)
+          out['defs/guards.json'] ||= output_json(GUARDS_JSON)
+
+          list = [{ 'properties' => { 'sCI' => { 'enum' => items.keys.sort } } }]
+          items.keys.sort.each do |key|
+            list << {
+              'if' => { 'required' => ['sCI'], 'properties' => { 'sCI' => { 'const' => key } } },
+              'then' => { '$ref' => "#{key}.json" }
+            }
+          end
+          json = {
+            '$schema' => 'https://json-schema.org/draft/2020-12/schema',
+            'properties' => { 'sS' => { 'items' => { 'allOf' => list } } }
+          }
+          out['statuses/statuses.json'] = output_json json
+          items.each_pair { |key, item| output_status out, key, item }
+        end
+
+        # convert a status to json schema
+        def self.output_status(out, key, item)
+          json = build_item item, property_key: 's'
+          out["statuses/#{key}.json"] = output_json json
+        end
+
+        # convert commands to json schema
+        def self.output_commands(out, items)
+          list = [{ 'properties' => { 'cCI' => { 'enum' => items.keys.sort } } }]
+          items.keys.sort.each do |key|
+            list << {
+              'if' => { 'required' => ['cCI'], 'properties' => { 'cCI' => { 'const' => key } } },
+              'then' => { '$ref' => "#{key}.json" }
+            }
+          end
+          json = {
+            '$schema' => 'https://json-schema.org/draft/2020-12/schema',
+            'items' => { 'allOf' => list }
+          }
+          out['commands/commands.json'] = output_json json
+
+          json = {
+            '$schema' => 'https://json-schema.org/draft/2020-12/schema',
+            'properties' => { 'arg' => { '$ref' => 'commands.json' } }
+          }
+          out['commands/command_requests.json'] = output_json json
+
+          json = {
+            '$schema' => 'https://json-schema.org/draft/2020-12/schema',
+            'properties' => { 'rvs' => { '$ref' => 'commands.json' } }
+          }
+          out['commands/command_responses.json'] = output_json json
+
+          items.each_pair { |key, item| output_command out, key, item }
+        end
+
+        # convert a command to json schema
+        def self.output_command(out, key, item)
+          json = build_item item
+          json['properties'] ||= {}
+          json['properties']['cO'] = { 'const' => item['command'] }
+          out["commands/#{key}.json"] = output_json json
+        end
+
+        # output the json schema root
+        def self.output_root(out, meta)
+          json = {
+            '$schema' => 'https://json-schema.org/draft/2020-12/schema',
+            'name' => meta['name'],
+            'description' => meta['description'],
+            'version' => meta['version'],
+            'allOf' => root_type_rules
+          }
+          out['rsmp.json'] = output_json json
+        end
+
+        def self.root_type_rules
+          [
+            {
+              'if' => { 'required' => ['type'], 'properties' => { 'type' => { 'const' => 'CommandRequest' } } },
+              'then' => { '$ref' => 'commands/command_requests.json' }
+            },
+            {
+              'if' => { 'required' => ['type'], 'properties' => { 'type' => { 'const' => 'CommandResponse' } } },
+              'then' => { '$ref' => 'commands/command_responses.json' }
+            },
+            {
+              'if' => {
+                'required' => ['type'],
+                'properties' => {
+                  'type' => { 'enum' => %w[StatusRequest StatusResponse StatusSubscribe StatusUnsubscribe
+                                           StatusUpdate] }
+                }
+              },
+              'then' => { '$ref' => 'statuses/statuses.json' }
+            },
+            {
+              'if' => { 'required' => ['type'], 'properties' => { 'type' => { 'const' => 'Alarm' } } },
+              'then' => { '$ref' => 'alarms/alarms.json' }
+            }
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/rsmp/convert/export/json_schema/values.rb

@@ -0,0 +1,120 @@
+module RSMP
+  module Convert
+    module Export
+      # Converts SXL definitions to JSON Schema files.
+      module JSONSchema
+        # convert a yaml item to json schema
+        def self.build_value(item)
+          out = {}
+          out['description'] = item['description'] if item['description']
+          if item['type'] =~ /_list$/
+            handle_string_list item, out
+          else
+            handle_types item, out
+            handle_enum item, out
+            handle_pattern item, out
+          end
+          wrap_refs out
+        end
+
+        # convert an item which is not a string-list, to json schema
+        def self.handle_types(item, out)
+          case item['type']
+          when 'boolean'
+            out['$ref'] = '../defs/definitions.json#/boolean'
+          when 'timestamp'
+            out['$ref'] = '../defs/definitions.json#/timestamp'
+          when 'integer', 'ordinal', 'unit', 'scale', 'long'
+            out['$ref'] = '../defs/definitions.json#/integer'
+          when 'array' # a json array
+            build_json_array item['items'], out
+          else # string, base64, and any unknown types
+            out['type'] = 'string'
+          end
+        end
+
+        # convert an yaml item with type: array to json schema
+        def self.build_json_array(item, out)
+          required = item.reject { |_k, v| v['optional'] == true }.keys.sort
+          out.merge!({
+                       'type' => 'array',
+                       'items' => {
+                         'type' => 'object',
+                         'required' => required,
+                         'unevaluatedProperties' => false
+                       }
+                     })
+          out['items']['properties'] = {}
+          item.each_pair do |key, v|
+            out['items']['properties'][key] = build_value(v)
+          end
+          out
+        end
+
+        # JSON Schema 2020-12 allows combining $ref with other properties directly
+        def self.wrap_refs(out)
+          out
+        end
+
+        # convert a yaml item with list: true to json schema
+        def self.handle_string_list(item, out)
+          case item['type']
+          when 'boolean_list'
+            out['$ref'] = '../defs/definitions.json#/boolean_list'
+          when 'integer_list'
+            out['$ref'] = '../defs/definitions.json#/integer_list'
+          when 'string_list'
+            out['$ref'] = '../defs/definitions.json#/string_list'
+          else
+            raise "Error: List of #{item['type']} is not supported: #{item.inspect}"
+          end
+
+          if item['values']
+            value_list = item['values'].keys.join('|')
+            out['pattern'] = /(?-mix:^(#{value_list})(?:,(#{value_list}))*$)/
+          end
+
+          puts "Warning: Pattern not support for lists: #{item.inspect}" if item['pattern']
+        end
+
+        # convert yaml values to json schema enum
+        def self.handle_enum(item, out)
+          return unless item['values']
+
+          out['enum'] = stringify_values(enum_keys(item))
+        end
+
+        def self.enum_keys(item)
+          case item['values']
+          when Hash
+            validate_hash_values! item
+            item['values'].keys.sort
+          when Array
+            item['values'].sort
+          else
+            raise 'Error: Values must be specified as either a Hash or an Array, ' \
+                  "got #{item['values'].class}"
+          end
+        end
+
+        def self.validate_hash_values!(item)
+          item['values'].each_pair do |k, v|
+            next unless ['', nil].include?(v)
+
+            raise "Error: '#{k}' has empty value in #{item}. " \
+                  '(When using a hash to specify \'values\', the hash values cannot be empty.)'
+          end
+        end
+
+        def self.stringify_values(values)
+          values.map { |v| v.is_a?(Integer) || v.is_a?(Float) ? v.to_s : v }
+        end
+
+        # convert yaml pattern to json schema
+        def self.handle_pattern(item, out)
+          out['pattern'] = item['pattern'] if item['pattern']
+        end
+      end
+    end
+  end
+end

data/lib/rsmp/convert/export/json_schema.rb

@@ -0,0 +1,58 @@
+# Export SXL to JSON Schema format
+
+require 'yaml'
+require 'json'
+require 'fileutils'
+
+require_relative 'json_schema/values'
+require_relative 'json_schema/items'
+require_relative 'json_schema/outputs'
+
+module RSMP
+  module Convert
+    # Handles exporting SXL definitions.
+    module Export
+      # Converts SXL definitions to JSON Schema files.
+      module JSONSchema
+        JSON_OPTIONS = {
+          array_nl: "\n",
+          object_nl: "\n",
+          indent: '  ',
+          space_before: ' ',
+          space: ' '
+        }.freeze
+
+        def self.output_json(item)
+          JSON.generate(item, JSON_OPTIONS)
+        end
+
+        # Default path to definitions.json bundled with the gem's core schemas
+        DEFINITIONS_SOURCE = File.expand_path('../../../../schemas/core/3.1.2/definitions.json', __dir__)
+
+        # generate the json schema from a string containing yaml
+        def self.generate(sxl)
+          out = {}
+          output_root out, sxl[:meta]
+          output_alarms out, sxl[:alarms]
+          output_statuses out, sxl[:statuses]
+          output_commands out, sxl[:commands]
+          out
+        end
+
+        # convert yaml to json schema and write files to a folder
+        def self.write(sxl, folder)
+          out = generate sxl
+          out.each_pair do |relative_path, str|
+            path = File.join(folder, relative_path)
+            FileUtils.mkdir_p File.dirname(path)
+            File.open(path, 'w+') { |file| file.puts str }
+          end
+          # Copy definitions.json so each version folder is self-contained
+          defs_dest = File.join(folder, 'defs', 'definitions.json')
+          FileUtils.mkdir_p File.dirname(defs_dest)
+          FileUtils.cp DEFINITIONS_SOURCE, defs_dest if File.exist?(DEFINITIONS_SOURCE)
+        end
+      end
+    end
+  end
+end

data/lib/rsmp/message.rb

@@ -1,5 +1,3 @@
-require 'rsmp_schema'
-
 # rsmp messages
 module RSMP
   # Base RSMP message class used to represent parsed and built messages.