rsmp_schemer 0.4.0 → 0.5.0

data/schemas/spec/core/message_ack.rb

@@ -0,0 +1,26 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+  let(:message) {{
+    "mType" => "rSMsg",
+    "type" => "MessageAck",
+    "oMId" => "92b9706d-0466-4518-8663-00b9690e9c41"
+  }}
+
+  it 'accepts valid message' do
+    expect( validate(message, 'core') ).to be_nil
+  end
+
+  it 'catches missing oMId' do
+    message.delete 'oMId'
+    expect( validate(message, 'core') ).to eq(
+      [["", "required", {"missing_keys"=>["oMId"]}]
+    )
+  end
+
+  it 'catches bad oMid' do
+    message['oMId'] = '4173c2c8a93343cb942566d4613731ed'    # missing dashes
+    expect( validate(message, 'core') ).to eq(
+      [["/oMId", "pattern"]
+    )
+  end
+
+end

data/schemas/spec/core/message_not_ack_spec.rb

@@ -0,0 +1,50 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+  let(:message) {{
+    "mType" => "rSMsg",
+    "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
+    "siteId" => [
+      { "sId" => "RN+SI0001" }
+    ],
+    "type" => "MessageNotAck",
+    "oMId" => "92b9706d-0466-4518-8663-00b9690e9c41",
+    "rea" => "Unknown json type: Watchdog"
+  }}
+
+  it 'accepts valid message' do
+    expect( validate(message, 'core') ).to be_nil
+  end
+
+  it 'catches missing old message id' do
+    message.delete 'oMId'
+    expect( validate(message, 'core') ).to eq(
+      [["", "required", {"missing_keys"=>["oMId"]}]]
+    )
+  end
+
+  it 'catches bad old version message id format' do
+    message['oMId'] = '4173c2c8-a933-ouch-9425-66d4613731ed'
+    expect( validate(message, 'core') ).to eq(
+      [["/oMId", "pattern"]]
+    )
+  end
+
+  it 'catches wrong old version message id type' do
+    message['oMId'] = 1234
+    expect( validate(message, 'core') ).to eq(
+      [["/oMId", "string"]]
+    )
+  end
+
+  it 'allows reason to be omitted' do
+    message.delete 'rea'
+    expect( validate(message, 'core') ).to be_nil
+  end
+
+  it 'catches bad reason, must be string' do
+    message['rea'] = 123
+    expect( validate(message, 'core') ).to eq(
+      [["/rea", "string"]]
+    )
+  end
+ 
+end

data/schemas/spec/core/status_request_spec.rb

@@ -0,0 +1,84 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+  let(:message) {{
+    "mType" => "rSMsg",
+    "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
+    "type" => "StatusRequest",
+    "cId" => "O+14439=481WA001",
+     "sS" => [
+       { "sCI" => "S0003", "n" => "inputstatus" }
+     ]
+  }}
+
+  it 'accepts valid status request' do
+    expect( validate(message, 'core') ).to be_nil
+  end
+
+  it 'catches missing component id' do
+    message.delete 'cId'
+    expect( validate(message, 'core') ).to eq(
+      [["", "required", {"missing_keys"=>["cId"]}]]
+    )
+  end
+
+  it 'catches bad status code' do
+    message['sS'].first['sCI'] = '99'
+    expect( validate(message, 'core') ).to eq(
+      [["/sS/0/sCI", "pattern"]]
+    )
+  end
+
+  it 'catches missing sS' do
+    message.delete 'sS'
+    expect( validate(message, 'core') ).to eq(
+      [["", "required", {"missing_keys"=>['sS']}]]
+    )
+  end
+
+  it 'catches empty sS array' do
+    message['sS'].clear
+    expect( validate(message, 'core') ).to eq(
+      [["/sS", "minItems"]]
+    )
+  end
+
+  it 'catches bad sS type' do
+    message['sS'] = {}
+    expect( validate(message, 'core') ).to eq(
+      [["/sS", "array"]]
+    )
+  end
+
+  it 'catches missing status code' do
+    message['sS'].first.delete 'sCI'
+    expect( validate(message, 'core') ).to eq(
+      [["/sS/0", "required", {"missing_keys"=>["sCI"]}]]
+    )
+  end
+
+  it 'catches bad status code' do
+    message['sS'].first['sCI'] = 3
+    expect( validate(message, 'core') ).to eq(
+      [["/sS/0/sCI", "string"]]
+    )
+
+    message['sS'].first['sCI'] = '3'
+    expect( validate(message, 'core') ).to eq(
+      [["/sS/0/sCI", "pattern"]]
+    )
+  end
+
+  it 'catches missing name' do
+    message['sS'].first.delete 'n'
+    expect( validate(message, 'core') ).to eq(
+      [["/sS/0", "required", {"missing_keys"=>["n"]}]]
+    )
+  end
+
+  it 'catches bad name' do
+    message['sS'].first['n'] = 3
+    expect( validate(message, 'core') ).to eq(
+      [["/sS/0/n", "string"]]
+    )
+  end
+
+end

data/schemas/spec/core/status_response_spec.rb

@@ -0,0 +1,135 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+  let(:message_3_1_1) {{
+    "mType" => "rSMsg",
+    "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
+    "type" => "StatusResponse",
+    "cId" => "O+14439=481WA001",
+    "sTs" => "2015-06-08T09:15:18.266Z",
+     "sS" => [
+       { "sCI" => "S0003", "n" => "inputstatus", "s" => "100101", "ageState" => "recent" }
+     ]
+  }}
+
+  let(:message_3_1_3) {{
+    "mType" => "rSMsg",
+    "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
+    "type" => "StatusResponse",
+    "cId" => "O+14439=481WA001",
+    "sTs" => "2015-06-08T09:15:18.266Z",
+     "sS" => [
+       { "sCI" => "S0003", "n" => "inputstatus", "s" => "100101", "q" => "recent" }
+     ]
+  }}
+
+  def make_variations
+    {
+      '3.1.1' => message_3_1_1,
+      '3.1.2' => message_3_1_1,
+      '3.1.3' => message_3_1_3,
+      '3.1.4' => message_3_1_3,
+      '3.1.5' => message_3_1_3
+    }
+  end
+
+  def validate_core
+    validate_variations(make_variations, 'core')
+  end
+
+  it 'accepts ageState in message_3_1_1 versions, q in newer' do
+    expect(validate_core).to be_nil
+  end
+
+  it 'rejects q in message_3_1_1 version, ageState in newer' do
+    expect( validate(message_3_1_3, 'core', ['3.1.1','3.1.2']) ).to eq(
+      [["/sS/0", "required", {"missing_keys"=>["ageState"]}], ["/sS/0/q", "schema"]]
+    )
+
+    expect( validate(message_3_1_1, 'core', ['3.1.3','3.1.4','3.1.5']) ).to eq(
+      [["/sS/0", "required", {"missing_keys"=>["q"]}],["/sS/0/ageState", "schema"]]
+    )
+  end
+
+  it 'catches missing component id' do
+    message_3_1_1.delete 'cId'
+    message_3_1_3.delete 'cId'
+    expect(validate_core).to eq( [["", "required", {"missing_keys"=>["cId"]}]] )
+  end
+
+  it 'catches bad status code' do
+    message_3_1_3['sS'].first['sCI'] = '99'
+    message_3_1_1['sS'].first['sCI'] = '99'
+    expect(validate_core).to eq([["/sS/0/sCI", "pattern"]])
+  end
+
+  it 'catches missing sS' do
+    message_3_1_3.delete 'sS'
+    message_3_1_1.delete 'sS'
+    expect(validate_core).to eq([["", "required", {"missing_keys"=>['sS']}]])
+  end
+
+  it 'catches empty sS array' do
+    message_3_1_3['sS'].clear
+    expect( validate(message_3_1_3, 'core') ).to eq([["/sS", "minItems"]])
+  end
+
+  it 'catches bad sS type' do
+    message_3_1_3['sS'] = {}
+    expect( validate(message_3_1_3, 'core') ).to eq([["/sS", "array"]])
+  end
+
+  it 'catches missing status code' do
+    message_3_1_1['sS'].first.delete 'sCI'
+    message_3_1_3['sS'].first.delete 'sCI'
+    expect(validate_core).to eq([["/sS/0", "required", {"missing_keys"=>["sCI"]}]])
+  end
+
+  it 'catches bad status code' do
+    message_3_1_1['sS'].first['sCI'] = 3
+    message_3_1_3['sS'].first['sCI'] = 3
+    expect(validate_core).to eq([["/sS/0/sCI", "string"]])
+
+    message_3_1_3['sS'].first['sCI'] = '3'
+    message_3_1_1['sS'].first['sCI'] = '3'
+    expect(validate_core).to eq([["/sS/0/sCI", "pattern"]])
+  end
+
+  it 'catches missing name' do
+    message_3_1_1['sS'].first.delete 'n'
+    message_3_1_3['sS'].first.delete 'n'
+    expect(validate_core).to eq([["/sS/0", "required", {"missing_keys"=>["n"]}]])
+  end
+
+  it 'catches bad name' do
+    message_3_1_1['sS'].first['n'] = 3
+    message_3_1_3['sS'].first['n'] = 3
+    expect(validate_core).to eq([["/sS/0/n", "string"]])
+  end
+
+  it 'catches missing value' do
+    message_3_1_1['sS'].first.delete 's'
+    message_3_1_3['sS'].first.delete 's'
+    expect(validate_core).to eq([["/sS/0", "required", {"missing_keys"=>["s"]}]])
+  end
+
+  it 'catches missing quality' do
+    message_3_1_1['sS'].first.delete 'ageState'
+    message_3_1_3['sS'].first.delete 'q'
+    expect( validate(message_3_1_1, 'core', ['3.1.1','3.1.2']) ).to eq(
+      [["/sS/0", "required", {"missing_keys"=>["ageState"]}]]
+    )
+    expect( validate(message_3_1_3, 'core', ['3.1.3','3.1.4','3.1.5']) ).to eq(
+      [["/sS/0", "required", {"missing_keys"=>["q"]}]]
+    )
+  end
+
+  it 'catches bad quality' do
+    message_3_1_1['sS'].first['ageState'] = 'great'
+    message_3_1_3['sS'].first['q'] = 'great'
+    expect( validate(message_3_1_1, 'core', ['3.1.1','3.1.2']) ).to eq(
+      [["/sS/0/ageState", "enum"]]
+    )
+    expect( validate(message_3_1_3, 'core', ['3.1.3','3.1.4','3.1.5']) ).to eq(
+      [["/sS/0/q", "enum"]]
+    )
+  end
+end

data/schemas/spec/core/status_subscribe_spec.rb

@@ -0,0 +1,154 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+  let(:message_3_1_1) {{
+    "mType" => "rSMsg",
+    "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
+    "type" => "StatusSubscribe",
+    "cId" => "O+14439=481WA001",
+     "sS" => [
+       { "sCI" => "S0003", "n" => "inputstatus", "uRt" => "0" }
+     ]
+  }}
+  let(:message_3_1_5) {{
+    "mType" => "rSMsg",
+    "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
+    "type" => "StatusSubscribe",
+    "cId" => "O+14439=481WA001",
+     "sS" => [
+       { "sCI" => "S0003", "n" => "inputstatus", "uRt" => "0", "sOc" => "True" }
+     ]
+  }}
+
+  def make_variations
+    {
+      '3.1.1' => message_3_1_1,
+      '3.1.2' => message_3_1_1,
+      '3.1.3' => message_3_1_1,
+      '3.1.4' => message_3_1_1,
+      '3.1.5' => message_3_1_5
+    }
+  end
+
+  def validate_core
+    validate_variations(make_variations, 'core')
+  end
+
+  it 'accepts valid status subscription' do
+    expect(validate_core).to be_nil
+  end
+
+  it 'catches missing component id' do
+    message_3_1_1.delete 'cId'
+    message_3_1_5.delete 'cId'
+    expect(validate_core).to eq(
+      [["", "required", {"missing_keys"=>["cId"]}]]
+    )
+  end
+
+  it 'catches bad status code' do
+    message_3_1_1['sS'].first['sCI'] = '99'
+    message_3_1_5['sS'].first['sCI'] = '99'
+    expect(validate_core).to eq(
+      [["/sS/0/sCI", "pattern"]]
+    )
+  end
+
+  it 'catches missing sS' do
+    message_3_1_1.delete 'sS'
+    message_3_1_5.delete 'sS'
+    expect(validate_core).to eq(
+      [["", "required", {"missing_keys"=>['sS']}]]
+    )
+  end
+
+  it 'catches empty sS array' do
+    message_3_1_1['sS'].clear
+    message_3_1_5['sS'].clear
+    expect(validate_core).to eq(
+      [["/sS", "minItems"]]
+    )
+  end
+
+  it 'catches bad sS type' do
+    message_3_1_1['sS'] = {}
+    message_3_1_5['sS'] = {}
+    expect(validate_core).to eq(
+      [["/sS", "array"]]
+    )
+  end
+
+  it 'catches missing status code' do
+    message_3_1_1['sS'].first.delete 'sCI'
+    message_3_1_5['sS'].first.delete 'sCI'
+    expect(validate_core).to eq(
+      [["/sS/0", "required", {"missing_keys"=>["sCI"]}]]
+    )
+  end
+
+  it 'catches bad status code' do
+    message_3_1_1['sS'].first['sCI'] = 3
+    message_3_1_5['sS'].first['sCI'] = 3
+    expect(validate_core).to eq(
+      [["/sS/0/sCI", "string"]]
+    )
+
+    message_3_1_1['sS'].first['sCI'] = '3'
+    message_3_1_5['sS'].first['sCI'] = '3'
+    expect(validate_core).to eq(
+      [["/sS/0/sCI", "pattern"]]
+    )
+  end
+
+  it 'catches missing name' do
+    message_3_1_1['sS'].first.delete 'n'
+    message_3_1_5['sS'].first.delete 'n'
+    expect(validate_core).to eq(
+      [["/sS/0", "required", {"missing_keys"=>["n"]}]]
+    )
+  end
+
+  it 'catches bad name' do
+    message_3_1_1['sS'].first['n'] = 3
+    message_3_1_5['sS'].first['n'] = 3
+    expect(validate_core).to eq(
+      [["/sS/0/n", "string"]]
+    )
+  end
+
+  it 'catches missing uRt' do
+    message_3_1_1['sS'].first.delete 'uRt'
+    message_3_1_5['sS'].first.delete 'uRt'
+    expect(validate_core).to eq(
+      [["/sS/0", "required", {"missing_keys"=>["uRt"]}]]
+    )
+  end
+
+  it 'catches bad uRt' do
+    message_3_1_1['sS'].first['uRt'] = 3
+    message_3_1_5['sS'].first['uRt'] = 3
+    expect(validate_core).to eq(
+      [["/sS/0/uRt", "string"]]
+    )
+
+    message_3_1_1['sS'].first['uRt'] = "fast"
+    message_3_1_5['sS'].first['uRt'] = "fast"
+    expect(validate_core).to eq(
+      [["/sS/0/uRt", "pattern"]]
+    )
+  end
+
+  it 'catches missing sOc' do
+    message_3_1_5['sS'].first.delete 'sOc'
+    expect(validate_core).to eq({
+      '3.1.5' => [["/sS/0", "required", {"missing_keys"=>["sOc"]}]]
+    })
+  end
+
+  it 'catches extra attributes' do
+    message_3_1_1['sS'].first['bad'] = "Foo"
+    message_3_1_5['sS'].first['bad'] = "Foo"
+    expect(validate_core).to eq(
+      [["/sS/0/bad", "schema"]]
+    )
+  end
+
+end

data/schemas/spec/core/status_unsubscribe_spec.rb

@@ -0,0 +1,91 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+  let(:message) {{
+    "mType" => "rSMsg",
+    "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
+    "type" => "StatusUnsubscribe",
+    "cId" => "O+14439=481WA001",
+     "sS" => [
+       { "sCI" => "S0003", "n" => "inputstatus" }
+     ]
+  }}
+
+  it 'accepts valid status unsubscription' do
+    expect( validate(message, 'core') ).to be_nil
+  end
+
+  it 'catches missing component id' do
+    message.delete 'cId'
+    expect( validate(message, 'core') ).to eq(
+      [["", "required", {"missing_keys"=>["cId"]}]]
+    )
+  end
+
+  it 'catches bad status code' do
+    message['sS'].first['sCI'] = '99'
+    expect( validate(message, 'core') ).to eq(
+      [["/sS/0/sCI", "pattern"]]
+    )
+  end
+
+  it 'catches missing sS' do
+    message.delete 'sS'
+    expect( validate(message, 'core') ).to eq(
+      [["", "required", {"missing_keys"=>['sS']}]]
+    )
+  end
+
+  it 'catches empty sS array' do
+    message['sS'].clear
+    expect( validate(message, 'core') ).to eq(
+      [["/sS", "minItems"]]
+    )
+  end
+
+  it 'catches bad sS type' do
+    message['sS'] = {}
+    expect( validate(message, 'core') ).to eq(
+      [["/sS", "array"]]
+    )
+  end
+
+  it 'catches missing status code' do
+    message['sS'].first.delete 'sCI'
+    expect( validate(message, 'core') ).to eq(
+      [["/sS/0", "required", {"missing_keys"=>["sCI"]}]]
+    )
+  end
+
+  it 'catches bad status code' do
+    message['sS'].first['sCI'] = 3
+    expect( validate(message, 'core') ).to eq(
+      [["/sS/0/sCI", "string"]]
+    )
+
+    message['sS'].first['sCI'] = '3'
+    expect( validate(message, 'core') ).to eq(
+      [["/sS/0/sCI", "pattern"]]
+    )
+  end
+
+  it 'catches missing name' do
+    message['sS'].first.delete 'n'
+    expect( validate(message, 'core') ).to eq(
+      [["/sS/0", "required", {"missing_keys"=>["n"]}]]
+    )
+  end
+
+  it 'catches bad name' do
+    message['sS'].first['n'] = 3
+    expect( validate(message, 'core') ).to eq(
+      [["/sS/0/n", "string"]]
+    )
+  end
+
+  it 'catches extra attributes' do
+    message['sS'].first['bad'] = "Foo"
+    expect( validate(message, 'core') ).to eq(
+      [["/sS/0/bad", "schema"]]
+    )
+  end
+
+end

data/schemas/spec/core/status_update_spec.rb

@@ -0,0 +1,143 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+  let(:message_3_1_1) {{
+    "mType" => "rSMsg",
+    "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
+    "type" => "StatusUpdate",
+    "cId" => "O+14439=481WA001",
+    "sTs" => "2015-06-08T09:15:18.266Z",
+     "sS" => [
+       { "sCI" => "S0003", "n" => "inputstatus", "s" => "100101", "ageState" => "recent" }
+     ]
+  }}
+
+  let(:message_3_1_3) {{
+    "mType" => "rSMsg",
+    "mId" => "4173c2c8-a933-43cb-9425-66d4613731ed",
+    "type" => "StatusUpdate",
+    "cId" => "O+14439=481WA001",
+    "sTs" => "2015-06-08T09:15:18.266Z",
+     "sS" => [
+       { "sCI" => "S0003", "n" => "inputstatus", "s" => "100101", "q" => "recent" }
+     ]
+  }}
+
+  def make_variations
+    {
+      '3.1.1' => message_3_1_1,
+      '3.1.2' => message_3_1_1,
+      '3.1.3' => message_3_1_3,
+      '3.1.4' => message_3_1_3,
+      '3.1.5' => message_3_1_3
+    }
+  end
+
+  it 'accepts ageState in message_3_1_1 versions, q in newer' do
+    expect( validate_variations(make_variations, 'core', '3.1.1') ).to be_nil
+  end
+
+  it 'rejects q in message_3_1_1 version, ageState in newer' do
+    expect( validate(message_3_1_3, 'core', ['3.1.1','3.1.2']) ).to eq(
+      [["/sS/0", "required", {"missing_keys"=>["ageState"]}], ["/sS/0/q", "schema"]]
+     )
+
+    expect( validate(message_3_1_1, 'core', ['3.1.3','3.1.4','3.1.5']) ).to eq(
+     [["/sS/0", "required", {"missing_keys"=>["q"]}], ["/sS/0/ageState", "schema"]]
+     )
+  end
+
+  it 'accepts valid status request' do
+    expect( validate_variations(make_variations, 'core') ).to be_nil
+  end
+
+  it 'catches missing component id' do
+    message_3_1_1.delete 'cId'
+    message_3_1_3.delete 'cId'
+    expect( validate_variations(make_variations, 'core') ).to eq(
+      [["", "required", {"missing_keys"=>["cId"]}]]
+    )
+  end
+
+  it 'catches bad status code' do
+    message_3_1_1['sS'].first['sCI'] = '99'
+    message_3_1_3['sS'].first['sCI'] = '99'
+    expect( validate_variations(make_variations, 'core') ).to eq(
+      [["/sS/0/sCI", "pattern"]]
+    )
+  end
+
+  it 'catches missing sS' do
+    message_3_1_3.delete 'sS'
+    expect( validate(message_3_1_3, 'core') ).to eq(
+      [["", "required", {"missing_keys"=>['sS']}]]
+    )
+  end
+
+  it 'catches empty sS array' do
+    message_3_1_3['sS'].clear
+    expect( validate(message_3_1_3, 'core') ).to eq(
+      [["/sS", "minItems"]]
+    )
+  end
+
+  it 'catches bad sS type' do
+    message_3_1_3['sS'] = {}
+    expect( validate(message_3_1_3, 'core') ).to eq(
+      [["/sS", "array"]]
+    )
+  end
+
+  it 'catches missing status code' do
+    message_3_1_1['sS'].first.delete 'sCI'
+    message_3_1_3['sS'].first.delete 'sCI'
+    expect( validate_variations(make_variations, 'core') ).to eq(
+      [["/sS/0", "required", {"missing_keys"=>["sCI"]}]]
+    )
+  end
+
+  it 'catches bad status code' do
+    message_3_1_1['sS'].first['sCI'] = 3
+    message_3_1_3['sS'].first['sCI'] = 3
+    expect( validate_variations(make_variations, 'core') ).to eq(
+      [["/sS/0/sCI", "string"]]
+    )
+
+    message_3_1_1['sS'].first['sCI'] = '3'
+    message_3_1_3['sS'].first['sCI'] = '3'
+    expect( validate_variations(make_variations, 'core') ).to eq(
+      [["/sS/0/sCI", "pattern"]]
+    )
+  end
+
+  it 'catches missing name' do
+    message_3_1_1['sS'].first.delete 'n'
+    message_3_1_3['sS'].first.delete 'n'
+    expect( validate_variations(make_variations, 'core') ).to eq(
+      [["/sS/0", "required", {"missing_keys"=>["n"]}]]
+    )
+  end
+
+  it 'catches bad name' do
+    message_3_1_1['sS'].first['n'] = 3
+    message_3_1_3['sS'].first['n'] = 3
+    expect( validate_variations(make_variations, 'core') ).to eq(
+      [["/sS/0/n", "string"]]
+    )
+  end
+
+  it 'catches missing value' do
+    message_3_1_1['sS'].first.delete 's'
+    message_3_1_3['sS'].first.delete 's'
+    expect( validate_variations(make_variations, 'core') ).to eq(
+      [["/sS/0", "required", {"missing_keys"=>["s"]}]]
+    )
+  end
+
+  it 'catches bad quality' do
+    message_3_1_1['sS'].first['ageState'] = 'great'
+    message_3_1_3['sS'].first['q'] = 'great'
+    expect( validate_variations(make_variations, 'core') ).to eq({
+      ['3.1.1','3.1.2']         => [["/sS/0/ageState", "enum"]],
+      ['3.1.3','3.1.4','3.1.5'] => [["/sS/0/q", "enum"]]
+    })
+  end
+end