rsmp_schemer 0.2.0

data/schemas/core_3.1.4/spec/core/version_spec.rb

@@ -0,0 +1,149 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+	let(:message) {{
+	  "mType" => "rSMsg",
+	  "mId" => "a28e94b9-05c7-41bb-8f8b-54693adc9698",
+	  "siteId" => [
+	    { "sId" => "RN+SI0001" }
+	  ],
+	  "type" => "Version",
+	  "RSMP" => [
+	    { "vers" => "3.1.1" },
+	    { "vers" => "3.1.2" },
+	    { "vers" => "3.1.3" },
+	    { "vers" => "3.1.4" }
+	  ],
+	  "SXL" => "1.1"
+	}}
+
+	it 'accepts valid message' do
+	  expect( validate(message) ).to be_nil
+  end
+
+  it 'catches missing mId' do
+		invalid = message.dup
+		invalid.delete 'mId'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["mId"]}]
+	  ])
+  end
+
+  it 'catches missing siteId' do
+		invalid = message.dup
+		invalid.delete 'siteId'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["siteId"]}]
+	  ])
+  end
+
+  it 'catches bad siteId format, must be array' do
+		invalid = message.dup
+		invalid['siteId'] = '1.0'
+	  expect( validate(invalid) ).to eq([
+	  	["/siteId", "array"]
+	  ])
+  end
+
+  it 'catches bad siteId format, array cannot be empty' do
+		invalid = message.dup
+		invalid['siteId'] = []
+	  expect( validate(invalid) ).to eq([
+	  	["/siteId", "minItems"]
+	  ])
+  end
+
+  it 'catches bad siteId format, item must be hash' do
+		invalid = message.dup
+		invalid['siteId'] = ['1.0']
+	  expect( validate(invalid) ).to eq([
+	  	["/siteId/0", "object"]
+	  ])
+  end
+
+  it 'catches bad siteId format, item must have version' do
+		invalid = message.dup
+		invalid['siteId'] = [{}]
+	  expect( validate(invalid) ).to eq([
+	  	["/siteId/0", "required", {"missing_keys"=>["sId"]}]
+	  ])
+  end
+
+  it 'catches bad siteId format, item cannot have extra attributes' do
+		invalid = message.dup
+		invalid['siteId'] = [{'sId'=>'RN+SI0001','extra'=>'123'}]
+	  expect( validate(invalid) ).to eq([
+	  	["/siteId/0/extra", "schema"]
+	  ])
+  end
+
+  it 'catches missing RSMP version' do
+		invalid = message.dup
+		invalid.delete 'RSMP'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["RSMP"]}]
+	  ])
+  end
+
+  it 'catches bad RSMP format, must be array' do
+		invalid = message.dup
+		invalid['RSMP'] = '1.0'
+	  expect( validate(invalid) ).to eq([
+	  	["/RSMP", "array"]
+	  ])
+  end
+
+  it 'catches bad RSMP format, array cannot be empty' do
+		invalid = message.dup
+		invalid['RSMP'] = []
+	  expect( validate(invalid) ).to eq([
+	  	["/RSMP", "minItems"]
+	  ])
+  end
+
+  it 'catches bad RSMP format, item must be hash' do
+		invalid = message.dup
+		invalid['RSMP'] = ['1.0']
+	  expect( validate(invalid) ).to eq([
+	  	["/RSMP/0", "object"]
+	  ])
+  end
+
+  it 'catches bad RSMP format, item must have version' do
+		invalid = message.dup
+		invalid['RSMP'] = [{}]
+	  expect( validate(invalid) ).to eq([
+	  	["/RSMP/0", "required", {"missing_keys"=>["vers"]}]
+	  ])
+  end
+
+  it 'catches bad RSMP format, item cannot have extra attributes' do
+		invalid = message.dup
+		invalid['RSMP'] = [{'vers'=>'1.0.0','extra'=>'123'}]
+	  expect( validate(invalid) ).to eq([
+	  	["/RSMP/0/extra", "schema"]
+	  ])
+  end
+
+  it 'catches bad RSMP format, version must be 1.0.0 format' do
+		invalid = message.dup
+		invalid['RSMP'].first['vers'] = 'latest'
+	  expect( validate(invalid) ).to eq([
+	  	["/RSMP/0/vers", "pattern"]
+	  ])
+  end
+
+  it 'catches missing SXL version' do
+		invalid = message.dup
+		invalid.delete 'SXL'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["SXL"]}]
+	  ])
+  end
+
+  it 'catches bad SXL version' do
+		invalid = message.dup
+		invalid['SXL'] = 'Release 1.0.1'
+	  expect( validate(invalid) ).to eq([
+	  	["/SXL", "pattern"]
+	  ])
+  end
+end

data/schemas/core_3.1.4/spec/core/watchdog_spec.rb

@@ -0,0 +1,37 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+	let(:message) {{
+	  "mType" => "rSMsg",
+	  "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
+	  "type" => "Watchdog",
+    "wTs" => "2015-06-08T12:01:39.654Z"
+	}}
+
+	it 'accepts valid message' do
+	  expect( validate(message) ).to be_nil
+  end
+
+  it 'catches missing mId' do
+		invalid = message.dup
+		invalid.delete 'mId'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["mId"]}]
+	  ])
+  end
+
+  it 'catches missing timestamp' do
+		invalid = message.dup
+		invalid.delete 'wTs'
+	  expect( validate(invalid) ).to eq([
+	  	["", "required", {"missing_keys"=>["wTs"]}]
+	  ])
+  end
+
+  it 'catches bad timestamp format' do
+		invalid = message.dup
+		invalid['wTs'] = '2015-06-08T12:01:39.654' 		# missing Z at end
+	  expect( validate(invalid) ).to eq([
+	  	["/wTs", "pattern"]
+	  ])
+  end
+
+end

data/schemas/core_3.1.4/spec/schemer_helper.rb

@@ -0,0 +1,23 @@
+require 'json_schemer'
+require 'pp'
+
+$schema_core = Pathname.new('schema/core/rsmp.json')
+$schemer_core = JSONSchemer.schema($schema_core)
+
+#schema_tlc = Pathname.new('schema/tlc/sxl.json')
+#schemer_tlc = JSONSchemer.schema(schema_tlc)
+
+def validate json, schemer=$schemer_core
+  if schemer.valid? json
+    nil
+  else
+    errors = []
+    begin
+      schemer.validate(json).each do |item|
+        errors ||= []
+        errors << [item['data_pointer'],item['type'],item['details']].compact
+      end
+    end
+    errors
+  end
+end

data/schemas/core_3.1.4/spec/spec_helper.rb

@@ -0,0 +1,102 @@
+require_relative 'schemer_helper'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/schemas/core_3.1.5/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/schemas/core_3.1.5/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rsmp.gemspec
+gem 'json_schemer'
+gem 'rspec'

data/schemas/core_3.1.5/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    ecma-re-validator (0.3.0)
+      regexp_parser (~> 2.0)
+    hana (1.3.7)
+    json_schemer (0.2.18)
+      ecma-re-validator (~> 0.3)
+      hana (~> 1.3)
+      regexp_parser (~> 2.0)
+      uri_template (~> 0.7)
+    regexp_parser (2.1.1)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    uri_template (0.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json_schemer
+  rspec
+
+BUNDLED WITH
+   2.2.3

data/schemas/core_3.1.5/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 The City Copenhagen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/schemas/core_3.1.5/README.md

@@ -0,0 +1,70 @@
+# About
+JSON Schema for RSMP messages. The schema can be used to automatically validate RSMP messages.
+
+The schema so far covers the core specifiation and the SXL for Trafic Light Controllers:
+https://github.com/rsmp-nordic/rsmp_core
+https://github.com/rsmp-nordic/rsmp_sxl_traffic_lights
+
+More about JSON Schema:
+https://json-schema.org/
+
+## Schema organisation
+The schema is split into multiple files to enable reuse.
+
+An SXL defines massages specific to a particular type of equipment, but they all rely on the core part of the RSMP specification.
+
+To validate a message against a particular SXL, use the sxl.json file in the relevant folder.
+For example, to validate against the SXL for Trafic Light Controllers (TLCs), include 'tcl/sxl.json'
+
+This main sxl.json file includes the core.json part, which contains validations for the RSMP core elements.
+Depending on the message type, commands.json, alarms.json, etc. will be included. That file in turn looks at the command/status/alarm code and includes the file describing the detailed parameters, arguments, etc.
+
+For example, validating a CommandRequest M0001 message will include these parts:
+
+```
+sxl.json
+  core.json
+  commands.json
+    M0001.json
+```
+
+## Example usage
+To validate a JSON message with Ruby using the json_schemer gem:
+
+```ruby
+require 'json_schemer'
+
+message = {
+  "mType" => "rSMsg",
+  "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
+  "type" => "CommandRequest",
+  "siteId" => [
+    { "sId" => "RN+SI0001" }
+  ],
+  "cId" => "O+14439=481WA001",
+  "arg" => [
+    {
+      "cCI" => "M0001",
+      "n" => "status",
+      "cO" => "setValue",
+      "v" => "YellowFlash"
+    }
+  ]
+}
+
+# try validating a message against our schema
+schema = Pathname.new('tlc/sxl.json')
+schemer = JSONSchemer.schema(schema)
+puts schemer.valid? message     # => true
+```
+
+## RSpec tests
+The reposity includes RSpec test that checks the schema, by testing the result of validating a set of valid and invalid RSMP messages using the json_schemer gem.
+
+This is useful when developing the schema, to ensure it validates correctly.
+
+
+```
+$ bundle              # install gems
+$ bundle exec rspec   # run rspec tests
+```

data/schemas/core_3.1.5/examples/validate.rb

@@ -0,0 +1,35 @@
+require 'json_schemer'
+
+message = {
+  "mType" => "rSMsg",
+  "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
+  "type" => "CommandRequest",
+  "siteId" => [
+    { "sId" => "RN+SI0001" }
+  ],
+  "cId" => "O+14439=481WA001",
+  "arg" => [
+    {
+      "n" => "timeplan",
+      "cO" => "setPlan",
+      "v" => "1"
+    }
+  ]
+}
+
+# try validating a message against our schema
+schema_core = Pathname.new('schema/core/rsmp.json')
+schemer_core = JSONSchemer.schema(schema_core)
+
+def validate message, schemer
+  if schemer.valid? message
+    'ok'
+  else
+    schemer.validate(message).map do |item|
+      [item['data_pointer'],item['type'],item['details']].compact.join(' ')
+    end
+  end
+end
+
+puts "core: #{validate message, schemer_core}"
+