rsmp_schemer 0.4.0 → 0.5.0

data/schemas/spec/core/version_spec.rb

@@ -0,0 +1,133 @@
+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, 'core') ).to be_nil
+  end
+
+  it 'catches missing mId' do
+    message.delete 'mId'
+    expect( validate(message, 'core') ).to eq(
+      [["", "required", {"missing_keys"=>["mId"]}]]
+    )
+  end
+
+  it 'catches missing siteId' do
+    message.delete 'siteId'
+    expect( validate(message, 'core') ).to eq(
+      [["", "required", {"missing_keys"=>["siteId"]}]]
+    )
+  end
+
+  it 'catches bad siteId format, must be array' do
+    message['siteId'] = '1.0'
+    expect( validate(message, 'core') ).to eq(
+      [["/siteId", "array"]]
+    )
+  end
+
+  it 'catches bad siteId format, array cannot be empty' do
+    message['siteId'] = []
+    expect( validate(message, 'core') ).to eq(
+      [["/siteId", "minItems"]]
+    )
+  end
+
+  it 'catches bad siteId format, item must be hash' do
+    message['siteId'] = ['1.0']
+    expect( validate(message, 'core') ).to eq(
+      [["/siteId/0", "object"]]
+    )
+  end
+
+  it 'catches bad siteId format, item must have version' do
+    message['siteId'] = [{}]
+    expect( validate(message, 'core') ).to eq(
+      [["/siteId/0", "required", {"missing_keys"=>["sId"]}]]
+    )
+  end
+
+  it 'catches bad siteId format, item cannot have extra attributes' do
+    message['siteId'] = [{'sId'=>'RN+SI0001','extra'=>'123'}]
+    expect( validate(message, 'core') ).to eq(
+      [["/siteId/0/extra", "schema"]]
+    )
+  end
+
+  it 'catches missing RSMP version' do
+    message.delete 'RSMP'
+    expect( validate(message, 'core') ).to eq(
+      [["", "required", {"missing_keys"=>["RSMP"]}]]
+    )
+  end
+
+  it 'catches bad RSMP format, must be array' do
+    message['RSMP'] = '1.0'
+    expect( validate(message, 'core') ).to eq(
+      [["/RSMP", "array"]]
+    )
+  end
+
+  it 'catches bad RSMP format, array cannot be empty' do
+    message['RSMP'] = []
+    expect( validate(message, 'core') ).to eq(
+      [["/RSMP", "minItems"]]
+    )
+  end
+
+  it 'catches bad RSMP format, item must be hash' do
+    message['RSMP'] = ['1.0']
+    expect( validate(message, 'core') ).to eq(
+      [["/RSMP/0", "object"]]
+    )
+  end
+
+  it 'catches bad RSMP format, item must have version' do
+    message['RSMP'] = [{}]
+    expect( validate(message, 'core') ).to eq(
+      [["/RSMP/0", "required", {"missing_keys"=>["vers"]}]]
+    )
+  end
+
+  it 'catches bad RSMP format, item cannot have extra attributes' do
+    message['RSMP'] = [{'vers'=>'1.0.0','extra'=>'123'}]
+    expect( validate(message, 'core') ).to eq(
+      [["/RSMP/0/extra", "schema"]]
+    )
+  end
+
+  it 'catches bad RSMP format, version must be 1.0.0 format' do
+    message['RSMP'].first['vers'] = 'latest'
+    expect( validate(message, 'core') ).to eq(
+      [["/RSMP/0/vers", "pattern"]]
+    )
+  end
+
+  it 'catches missing SXL version' do
+    message.delete 'SXL'
+    expect( validate(message, 'core') ).to eq(
+      [["", "required", {"missing_keys"=>["SXL"]}]]
+    )
+  end
+
+  it 'catches bad SXL version' do
+    message['SXL'] = 'Release 1.0.1'
+    expect( validate(message, 'core') ).to eq(
+      [["/SXL", "pattern"]]
+    )
+  end
+end

data/schemas/spec/core/watchdog_spec.rb

@@ -0,0 +1,34 @@
+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, 'core') ).to be_nil
+  end
+
+  it 'catches missing mId' do
+    message.delete 'mId'
+    expect( validate(message, 'core') ).to eq(
+      [["", "required", {"missing_keys"=>["mId"]}]]
+    )
+  end
+
+  it 'catches missing timestamp' do
+    message.delete 'wTs'
+    expect( validate(message, 'core') ).to eq(
+      [["", "required", {"missing_keys"=>["wTs"]}]]
+    )
+  end
+
+  it 'catches bad timestamp format' do
+    message['wTs'] = '2015-06-08T12:01:39.654'     # missing Z at end
+    expect( validate(message, 'core') ).to eq(
+      [["/wTs", "pattern"]]
+    )
+  end
+
+end

data/schemas/spec/schemer_helper.rb

@@ -0,0 +1,83 @@
+require 'json_schemer'
+require 'pp'
+
+$schemers = {
+  'core' => {},
+  'tlc' => {}
+}
+
+[
+  '3.1.1',
+  '3.1.2',
+  '3.1.3',
+  '3.1.4',
+  '3.1.5'
+].each do |version|
+  $schemers['core'][version] = JSONSchemer.schema( Pathname.new("schemas/core/#{version}/rsmp.json") )
+end
+
+[
+  '1.0.7',
+  '1.0.8',
+  '1.0.9',
+  '1.0.10',
+  '1.0.13',
+  '1.0.14',
+  '1.0.15'
+].each do |version|
+  $schemers['tlc'][version] = JSONSchemer.schema( Pathname.new("schemas/tlc/#{version}/sxl.json") )
+end
+
+def validate json, schema, versions = :all
+  validate_variations( {all:json}, schema, versions )
+end
+
+def validate_variations json_variations, schema, versions = :all
+  raise RuntimeError.new("Unknown schema: #{schema}") unless $schemers[schema.to_s]
+  
+  if versions == :all
+    versions = $schemers[schema.to_s].keys
+  elsif versions.is_a? String
+    versions = [versions]
+  end
+
+  schemers = {}
+  versions.each do |version|
+    raise RuntimeError.new("Unknown schema version: #{schema} #{version}") unless $schemers[schema.to_s][version.to_s]
+    schemers[version] = $schemers[schema][version]
+  end
+
+  errors = nil
+  schemers.each_pair do |version,schemer|
+    json_variation = json_variations[:all] || json_variations[version]
+    if schemer.valid? json_variation
+      next
+    else
+      errors ||= {}
+      begin
+        schemer.validate(json_variation).each do |item|
+          errors[version] ||= []
+          errors[version] << [item['data_pointer'],item['type'],item['details']].compact
+        end
+      end
+    end
+  end
+  # done if no errors
+  return nil unless errors
+
+  # if all versions has the same errors, then simplify and just return a value
+  if errors && errors.any?
+    if errors.size == schemers.size && errors.values.uniq.size == 1
+      return errors.values.first
+    end
+  end
+
+  # return errors, grouped by versions with the same error
+  # e.g. {'1.1' => 'A', 1.2 => 'A', '1.3' => 'B' }
+  # is transformed to { ['1.1','1.2'] => 'A', '1.3' => 'B'}
+  errors.
+    keys.
+    group_by {|version| errors[version] }.
+    transform_values {|arr| arr.size == 1 ? arr.first : arr }. 
+    invert
+end

data/schemas/spec/tlc/M0001_spec.rb

@@ -0,0 +1,62 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+  let(: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"
+      }
+    ]
+  }}
+
+  it 'accepts valid command' do
+    expect( validate(message, 'tlc') ).to be_nil
+  end
+
+  it 'catches bad value' do
+    message["arg"].first['v'] = 'bad'
+    expect( validate(message, 'tlc') ).to eq(
+      [["/arg/0/v", "enum"]]
+    )
+  end
+
+  it 'catches bad name' do
+    message["arg"].first['n'] = 'bad'
+    expect( validate(message, 'tlc') ).to eq(
+      [["/arg/0/n", "enum"]]
+    )
+  end
+
+  it 'catches bad status values' do
+    message["arg"].first['n'] = 'status'
+    message["arg"].first['v'] = 'bad'
+    expect( validate(message, 'tlc') ).to eq(
+      [["/arg/0/v", "enum"]]
+    )
+  end
+
+  it 'catches bad timeout values' do
+    message["arg"].first['n'] = 'timeout'
+    message["arg"].first['v'] = 'bad'
+    expect( validate(message, 'tlc') ).to eq(
+      [["/arg/0/v", "pattern"]]
+    )
+  end
+
+  it 'catches bad intersection values' do
+    message["arg"].first['n'] = 'intersection'
+    message["arg"].first['v'] = 'bad'
+    expect( validate(message, 'tlc') ).to eq(
+      [["/arg/0/v", "pattern"]]
+    )
+  end
+
+end

data/schemas/spec/tlc/S0007_intersections_spec.rb

@@ -0,0 +1,104 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+  let(:message) {{
+    "mType" => "rSMsg",
+    "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
+    "type" => "StatusResponse",
+    "cId" => "O+14439=481WA001",
+    "sTs" => "2015-06-08T09:15:18.266Z",
+      "sS" => [
+      { "sCI" => "S0007", "n" => "intersection", "s" => "0", "q" => "recent" },
+      { "sCI" => "S0007", "n" => "status", "s" => "True", "q" => "recent" }
+     ]
+  }}
+
+  it 'accepts valid status request with a single intersection' do
+    expect( validate(message,'tlc') ).to be_nil
+   end
+
+  it 'accepts valid status request with two intersections' do
+    message["sS"] = [
+      { "sCI" => "S0007", "n" => "intersection", "s" => "1,2", "q" => "recent" },
+      { "sCI" => "S0007", "n" => "status", "s" => "True,True", "q" => "recent" }
+    ]
+    expect( validate(message,'tlc') ).to be_nil
+   end
+
+  it 'catches bad intersections list' do
+    # trailing comma
+    message["sS"] = [
+      { "sCI" => "S0007", "n" => "intersection", "s" => "1,2,", "q" => "recent" },
+    ]
+    expect( validate(message,'tlc') ).to eq(
+      [["/sS/0/s", "pattern"]]
+    )
+
+    # leading comma
+    message["sS"] = [
+      { "sCI" => "S0007", "n" => "intersection", "s" => ",1,2", "q" => "recent" },
+    ]
+    expect( validate(message,'tlc') ).to eq(
+      [["/sS/0/s", "pattern"]]
+    )
+
+    # naked comma
+    message["sS"] = [
+      { "sCI" => "S0007", "n" => "intersection", "s" => ",", "q" => "recent" },
+    ]
+    expect( validate(message,'tlc') ).to eq(
+      [["/sS/0/s", "pattern"]]
+    )
+
+    # empty item
+    message["sS"] = [
+      { "sCI" => "S0007", "n" => "intersection", "s" => "1,,2", "q" => "recent" },
+    ]
+    expect( validate(message,'tlc') ).to eq(
+      [["/sS/0/s", "pattern"]]
+    )
+
+    # invalid item
+    message["sS"] = [
+      { "sCI" => "S0007", "n" => "intersection", "s" => "1,a", "q" => "recent" },
+    ]
+    expect( validate(message,'tlc') ).to eq(
+      [["/sS/0/s", "pattern"]]
+    )
+   end
+
+  it 'catches bad status list' do
+    message["sS"] = [
+      { "sCI" => "S0007", "n" => "status", "s" => "True,False,", "q" => "recent" },
+    ]
+    expect( validate(message,'tlc') ).to eq(
+      [["/sS/0/s", "pattern"]]
+    )
+
+    message["sS"] = [
+      { "sCI" => "S0007", "n" => "status", "s" => ",True,False", "q" => "recent" },
+    ]
+    expect( validate(message,'tlc') ).to eq(
+      [["/sS/0/s", "pattern"]]
+    )
+
+    message["sS"] = [
+      { "sCI" => "S0007", "n" => "status", "s" => ",", "q" => "recent" },
+    ]
+    expect( validate(message,'tlc') ).to eq(
+      [["/sS/0/s", "pattern"]]
+    )
+
+    message["sS"] = [
+      { "sCI" => "S0007", "n" => "status", "s" => "True,,False", "q" => "recent" },
+    ]
+    expect( validate(message,'tlc') ).to eq(
+      [["/sS/0/s", "pattern"]]
+    )
+
+    message["sS"] = [
+      { "sCI" => "S0007", "n" => "status", "s" => "True,1", "q" => "recent" },
+    ]
+    expect( validate(message,'tlc') ).to eq(
+      [["/sS/0/s", "pattern"]]
+    )
+   end
+end

data/schemas/spec/tlc/S0007_spec.rb

@@ -0,0 +1,18 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+
+  let(:message) {{
+    "mType" => "rSMsg",
+    "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
+    "type" => "StatusResponse",
+    "cId" => "O+14439=481WA001",
+    "sTs" => "2015-06-08T09:15:18.266Z",
+      "sS" => [
+      { "sCI" => "S0007", "n" => "intersection", "s" => "0", "q" => "recent" },
+      { "sCI" => "S0007", "n" => "status", "s" => "True", "q" => "recent" }
+     ]
+  }}
+
+  it 'accepts valid status request' do
+    expect( validate(message,'tlc') ).to be_nil
+   end
+end