rsmp_schemer 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5ded20247c8a17c4c9408c1936de71fe1782041241280ea9e0dcc352e67649f
-  data.tar.gz: 85829fef328b91fa96068d01f6b8410370ec34393a2cf631f67f37c2901c9f8d
+  metadata.gz: 5f23ae0165f3b4dc8d68e61df4478eb60871487273f3f17af3a0903373fc889b
+  data.tar.gz: 94ebfc23355613e74959648481b6edac1cce6c22a5339c94651f3e86f9e9428f
 SHA512:
-  metadata.gz: e670455f64901cb3cff4b9445309f57f143865dbd67a08f628f0d541aa0b1f934914829d7d85f2f4e5c19a8db8968599ca29005c8ab1f7a8522988b4846b3863
-  data.tar.gz: 1fcabd99fd4dcff846fa372e1f6c928a1edeacfc06a0c25014a676e7c5369052f0b502fc21b91aa6ad504981052f080b053b8c78726bc48ab912e86e701eb25f
+  metadata.gz: b17100f32895d3d7542bf93bff1da5a2bfd89ac869c5e9fb77bf9e3cfe3710452448893c96885c1f9e4eb7f3ea06c7ce7860be55969fe9721586a975f01a4b5e
+  data.tar.gz: 6025a9a9cf344aa20fdfd728eeb2ea5e8af8c73b694a472201771daa49b022453067e1353888cd854e3bca04e704f41912d0785d10605d402c890ddeef5345d0

data/Gemfile.lock

@@ -1,23 +1,23 @@
 PATH
   remote: .
   specs:
-    rsmp_schemer (0.3.2)
+    rsmp_schemer (0.4.0)
       json_schemer (~> 0.2.18)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.4.4)
-    ecma-re-validator (0.3.0)
-      regexp_parser (~> 2.0)
+    diff-lcs (1.5.0)
+    ecma-re-validator (0.4.0)
+      regexp_parser (~> 2.2)
     hana (1.3.7)
-    json_schemer (0.2.18)
+    json_schemer (0.2.20)
       ecma-re-validator (~> 0.3)
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       uri_template (~> 0.7)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -35,6 +35,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-20
+  x86_64-darwin-21
 
 DEPENDENCIES
   rake (~> 13.0)
@@ -43,4 +44,4 @@ DEPENDENCIES
   rspec-expectations (~> 3.9.1)
 
 BUNDLED WITH
-   2.2.15
+   2.3.5

data/lib/rsmp_schemer/version.rb

@@ -2,6 +2,6 @@
 
 module RSMP
 	module Schemer
-  	VERSION = "0.3.2"
+  	VERSION = "0.4.0"
 	end
 end

data/schemas/core_3.1.5/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/schemas/core_3.1.5/schema/core/alarm.json

@@ -7,49 +7,45 @@
     "aCId" : { "$ref": "definitions.json#/alarm_code" },
     "xACId" : { "description" : "External alarm code id", "type" : "string" },
     "aSp" : {
-      "description" : "Alarm message variant",
+      "description" : "Alarm specialization",
       "type" : "string",
       "enum" : [ "Issue", "Acknowledge", "Suspend", "Resume", "Request" ]
+    }
+  },
+  "required" : [ "aSp"],
+  "allOf" : [
+    {
+      "if": {
+        "required" : [ "aSp" ],
+        "properties" : { "aSp" : { "const" : "Issue" } }
+      },
+      "then": { "$ref": "alarm_issue.json" }
     },
-    "ack" : {
-      "description" : "Acknowledgement",
-      "type" : "string",
-      "enum" : [ "Acknowledged", "notAcknowledged" ]
-    },
-    "aS" : {
-      "description" : "Status",
-      "type" : "string",
-      "enum" : [ "inActive", "Active" ]
-    },
-    "sS" : {
-      "description" : "Suspended",
-      "type" : "string",
-      "enum" : [ "suspended", "notSuspended" ]
-    },
-    "aTs" : { "$ref": "definitions.json#/timestamp" },
-    "cat" : {
-      "description" : "Category",
-      "type" : "string",
-      "enum" : [ "T", "D" ]
-    },
-    "pri" : {
-      "description" : "Priority",
-      "type" : "string",
-      "enum" : [ "1", "2", "3" ]
+    {
+      "if": {
+        "allOf" : [
+          {
+            "required" : [ "aSp" ],
+            "properties" : {
+              "aSp" : { "enum" : [ "Suspend","Resume"]  }
+            }
+          },
+          {
+            "not": { "required" : [ "sS" ] }
+          }
+        ]
+      },
+      "then": { "$ref": "alarm_suspend_resume.json" }
     },
-    "rvs" : {
-      "description" : "Return values",
-      "type" : "array",
-      "items" : {
-        "type" : "object",
-        "properties": {
-          "n" : { "description" : "Unique reference of the value", "type" : "string" },
-          "v" : { "description" : "Value", "type" : "string" }
-        },
-        "required" : [ "n", "v" ],
-        "additionProperties": false
-      }
+    {
+      "if": {
+        "required" : [ "aSp", "sS" ],
+        "properties" : {
+          "aSp" : { "const" : "Suspend" },
+          "sS" : { "enum" : [ "suspended", "notSuspended" ] }
+        }
+      },
+      "then": { "$ref": "alarm_suspended_resumed.json" }
     }
-  },
-  "required" : [ "mId", "cId", "aCId", "xACId", "aSp", "ack", "aS", "aTs", "sS", "cat", "pri", "rvs" ]
+  ]
 }

data/schemas/core_3.1.5/schema/core/alarm_issue.json

@@ -0,0 +1,44 @@
+{
+  "properties" : {
+    "ack" : {
+      "description" : "Acknowledgement",
+      "type" : "string",
+      "enum" : [ "Acknowledged", "notAcknowledged" ]
+    },
+    "aS" : {
+      "description" : "Active status",
+      "type" : "string",
+      "enum" : [ "inActive", "Active" ]
+    },
+    "sS" : {
+      "description" : "Suspend status",
+      "type" : "string",
+      "enum" : [ "suspended", "notSuspended" ]
+    },
+    "aTs" : { "$ref": "definitions.json#/timestamp" },
+    "cat" : {
+      "description" : "Category",
+      "type" : "string",
+      "enum" : [ "T", "D" ]
+    },
+    "pri" : {
+      "description" : "Priority",
+      "type" : "string",
+      "enum" : [ "1", "2", "3" ]
+    },
+    "rvs" : {
+      "description" : "Return values",
+      "type" : "array",
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "v" : { "description" : "Value", "type" : "string" }
+        },
+        "required" : [ "n", "v" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "aCId", "xACId", "aSp", "ack", "aS", "aTs", "sS", "cat", "pri", "rvs" ]
+}

data/schemas/core_3.1.5/schema/core/alarm_suspend_resume.json

@@ -0,0 +1,3 @@
+{
+  "required" : [ "mId", "cId", "aCId", "xACId", "aSp" ]
+}

data/schemas/core_3.1.5/schema/core/alarm_suspended_resumed.json

@@ -0,0 +1,44 @@
+{
+  "properties" : {
+    "ack" : {
+      "description" : "Acknowledgement",
+      "type" : "string",
+      "enum" : [ "Acknowledged", "notAcknowledged" ]
+    },
+    "aS" : {
+      "description" : "Active status",
+      "type" : "string",
+      "enum" : [ "inActive", "Active" ]
+    },
+    "sS" : {
+      "description" : "Suspend status",
+      "type" : "string",
+      "enum" : [ "suspended", "notSuspended" ]
+    },
+    "aTs" : { "$ref": "definitions.json#/timestamp" },
+    "cat" : {
+      "description" : "Category",
+      "type" : "string",
+      "enum" : [ "T", "D" ]
+    },
+    "pri" : {
+      "description" : "Priority",
+      "type" : "string",
+      "enum" : [ "1", "2", "3" ]
+    },
+    "rvs" : {
+      "description" : "Return values",
+      "type" : "array",
+      "items" : {
+        "type" : "object",
+        "properties": {
+          "n" : { "description" : "Unique reference of the value", "type" : "string" },
+          "v" : { "description" : "Value", "type" : "string" }
+        },
+        "required" : [ "n", "v" ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required" : [ "mId", "cId", "aCId", "xACId", "aSp", "ack", "aS", "aTs", "sS", "cat", "pri", "rvs" ]
+}

data/schemas/core_3.1.5/schema/core/command_response.json

@@ -26,7 +26,7 @@
           }
         },
         "required" : [ "cCI", "n", "v", "age" ],
-        "additionProperties": false
+        "additionalProperties": false
       }
     }
   },

data/schemas/core_3.1.5/schema/core/status_response.json

@@ -22,7 +22,7 @@
         }
         },
         "required" : [ "sCI", "n", "s", "q" ],
-        "additionProperties": false
+        "additionalProperties": false
       }
     }
   },

data/schemas/core_3.1.5/schema/core/status_update.json

@@ -22,7 +22,7 @@
         }
         },
         "required" : [ "sCI", "n", "s", "q" ],
-        "additionProperties": false
+        "additionalProperties": false
       }
     }
   },

data/schemas/core_3.1.5/spec/core/alarm_issue_spec.rb

@@ -0,0 +1,299 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+	describe 'Alarm Issue' do
+		let(:message) {{
+			"mType" => "rSMsg",
+			"type" => "Alarm",
+			"mId" => "E68A0010-C336-41ac-BD58-5C80A72C7092",
+			"cId" => "AB+84001=860SG001",
+			"aCId" => "A0001",
+			"xACId" => "Serious lamp error",
+			"aSp" => "Issue",
+			"ack" => "notAcknowledged",
+			"aS" => "Active",
+			"sS" => "notSuspended",
+			"aTs" => "2009-10-01T11:59:31.571Z",
+			"cat" => "D",
+			"pri" => "2",
+			"rvs" => [
+				{
+					"n" => "color",
+					"v" => "red"
+				}
+			]
+		}}
+
+		it 'accepts valid alarm' do
+			expect( validate(message) ).to be_nil
+		end
+
+		it 'catches missing component id' do
+			invalid = message.dup
+			invalid.delete 'cId'
+			expect( validate(invalid) ).to eq([
+				["", "required", {"missing_keys"=>["cId"]}]
+			])
+		end
+
+		it 'catches missing alarm code id' do
+			invalid = message.dup
+			invalid.delete 'aCId'
+			expect( validate(invalid) ).to eq([
+				["", "required", {"missing_keys"=>["aCId"]}]
+			])
+		end
+
+		it 'catches bad alarm code id' do
+			invalid = message.dup
+			invalid['aCId'] = "001"
+			expect( validate(invalid) ).to eq([
+				["/aCId", "pattern"]
+			])
+		end
+
+		it 'catches wrong alarm code id type' do
+			invalid = message.dup
+			invalid['aCId'] = 123
+			expect( validate(invalid) ).to eq([
+				["/aCId", "string"]
+			])
+		end
+
+		it 'catches missing extended alarm code id' do
+			invalid = message.dup
+			invalid.delete 'xACId'
+			expect( validate(invalid) ).to eq([
+				["", "required", {"missing_keys"=>["xACId"]}]
+			])
+		end
+
+		it 'catches wrong extended alarm code id type' do
+			invalid = message.dup
+			invalid['xACId'] = 123
+			expect( validate(invalid) ).to eq([
+				["/xACId", "string"]
+			])
+		end
+
+		it 'catches missing specialization' do
+			invalid = message.dup
+			invalid.delete 'aSp'
+			expect( validate(invalid) ).to eq([
+				["", "required", {"missing_keys"=>["aSp"]}]
+			])
+		end
+
+		it 'catches bad specialization' do
+			invalid = message.dup
+			invalid['aSp'] = "Bad"
+			expect( validate(invalid) ).to eq([
+				["/aSp", "enum"]
+			])
+		end
+
+		it 'catches wrong specialization type' do
+			invalid = message.dup
+			invalid['aSp'] = 123
+			expect( validate(invalid) ).to eq([
+				["/aSp", "enum"],
+				["/aSp", "string"]
+			])
+		end
+
+		it 'catches missing alarm active status' do
+			invalid = message.dup
+			invalid.delete 'aS'
+			expect( validate(invalid) ).to eq([
+				["", "required", {"missing_keys"=>["aS"]}]
+			])
+		end
+
+		it 'catches bad alarm active status' do
+			invalid = message.dup
+			invalid['aS'] = "Bad"
+			expect( validate(invalid) ).to eq([
+				["/aS", "enum"]
+			])
+		end
+
+		it 'catches wrong alarm active status' do
+			invalid = message.dup
+			invalid['aS'] = 123
+			expect( validate(invalid) ).to eq([
+				["/aS", "enum"],
+				["/aS", "string"]
+			])
+		end
+
+		it 'catches missing alarm suspend status' do
+			invalid = message.dup
+			invalid.delete 'sS'
+			expect( validate(invalid) ).to eq([
+				["", "required", {"missing_keys"=>["sS"]}]
+			])
+		end
+
+		it 'catches bad alarm code id' do
+			invalid = message.dup
+			invalid['sS'] = "Bad"
+			expect( validate(invalid) ).to eq([
+				["/sS", "enum"]
+			])
+		end
+
+		it 'catches wrong alarm code id type' do
+			invalid = message.dup
+			invalid['sS'] = 123
+			expect( validate(invalid) ).to eq([
+				["/sS", "enum"],
+				["/sS", "string"]
+			])
+		end
+
+		it 'catches missing alarm code id' do
+			invalid = message.dup
+			invalid.delete 'ack'
+			expect( validate(invalid) ).to eq([
+				["", "required", {"missing_keys"=>["ack"]}]
+			])
+		end
+
+		it 'catches bad alarm code id' do
+			invalid = message.dup
+			invalid['ack'] = "Bad"
+			expect( validate(invalid) ).to eq([
+				["/ack", "enum"]
+			])
+		end
+
+		it 'catches wrong alarm code id type' do
+			invalid = message.dup
+			invalid['ack'] = 123
+			expect( validate(invalid) ).to eq([
+				["/ack", "enum"],
+				["/ack", "string"]
+			])
+		end
+
+		it 'catches missing category' do
+			invalid = message.dup
+			invalid.delete 'cat'
+			expect( validate(invalid) ).to eq([
+				["", "required", {"missing_keys"=>["cat"]}]
+			])
+		end
+
+		it 'catches bad category' do
+			invalid = message.dup
+			invalid['cat'] = "A"
+			expect( validate(invalid) ).to eq([
+				["/cat", "enum"]
+			])
+		end
+
+		it 'catches wrong category' do
+			invalid = message.dup
+			invalid['cat'] = 123
+			expect( validate(invalid) ).to eq([
+				["/cat", "enum"],
+				["/cat", "string"]
+			])
+		end
+
+		it 'catches missing priority' do
+			invalid = message.dup
+			invalid.delete 'pri'
+			expect( validate(invalid) ).to eq([
+				["", "required", {"missing_keys"=>["pri"]}]
+			])
+		end
+
+		it 'catches bad priority' do
+			invalid = message.dup
+			invalid['pri'] = "4"
+			expect( validate(invalid) ).to eq([
+				["/pri", "enum"]
+			])
+		end
+
+		it 'catches wrong priority' do
+			invalid = message.dup
+			invalid['pri'] = 1
+			expect( validate(invalid) ).to eq([
+				["/pri", "enum"],
+				["/pri", "string"]
+			])
+		end
+
+		it 'catches missing timestamp' do
+			invalid = message.dup
+			invalid.delete 'aTs'
+			expect( validate(invalid) ).to eq([
+				["", "required", {"missing_keys"=>["aTs"]}]
+			])
+		end
+
+		it 'catches bad timestamp' do
+			invalid = message.dup
+			invalid['aTs'] = "yesterday"
+			expect( validate(invalid) ).to eq([
+				["/aTs", "pattern"]
+			])
+		end
+
+		it 'catches wrong timestamp type' do
+			invalid = message.dup
+			invalid['aTs'] = 123
+			expect( validate(invalid) ).to eq([
+				["/aTs", "string"]
+			])
+		end
+
+		it 'catches missing rvs' do
+			invalid = message.dup
+			invalid.delete 'rvs'
+			expect( validate(invalid) ).to eq([
+				["", "required", {"missing_keys"=>["rvs"]}]
+			])
+		end
+
+		it 'catches bad rvs type' do
+			invalid = message.dup
+			invalid["rvs"] = {}
+			expect( validate(invalid) ).to eq([
+				["/rvs", "array"]
+			])
+		end
+
+		it 'catches missing alarm name' do
+			invalid = message.dup
+			invalid["rvs"].first.delete 'n'
+			expect( validate(invalid) ).to eq([
+				["/rvs/0", "required", {"missing_keys"=>["n"]}]
+			])
+		end
+
+		it 'catches bad alarm name' do
+			invalid = message.dup
+			invalid["rvs"].first['n'] = 3
+			expect( validate(invalid) ).to eq([
+				["/rvs/0/n", "string"]
+			])
+		end
+
+		it 'catches missing alarm value' do
+			invalid = message.dup
+			invalid["rvs"].first.delete 'v'
+			expect( validate(invalid) ).to eq([
+				["/rvs/0", "required", {"missing_keys"=>["v"]}]
+			])
+		end
+
+		it 'catches bad alarm value' do
+			invalid = message.dup
+			invalid["rvs"].first['v'] = 3
+			expect( validate(invalid) ).to eq([
+				["/rvs/0/v", "string"]
+			])
+		end
+	end
+end

data/schemas/core_3.1.5/spec/core/alarm_resume_spec.rb

@@ -0,0 +1,93 @@
+RSpec.describe "Traffic Light Controller RSMP SXL Schema validation" do
+	describe 'Alarm Resume' do
+		let(:message) {{
+			"mType" => "rSMsg",
+			"type" => "Alarm",
+			"mId" => "2a744145-403a-423f-ba80-f38e283a778e",
+			"ntsOId" => "",
+			"xNId" => "",
+			"cId" => "AB+84001=860VA001",
+			"aCId" => "A0004",
+			"xACId" => "",
+			"xNACId" => "",
+			"aSp" => "Resume"
+		}}
+
+	  it 'accepts valid alarm resume' do
+		  expect( validate(message) ).to be_nil
+	  end
+
+	  it 'catches missing component id' do
+			invalid = message.dup
+			invalid.delete 'cId'
+		  expect( validate(invalid) ).to eq([
+		  	["", "required", {"missing_keys"=>["cId"]}]
+		  ])
+	  end
+
+	  it 'catches missing alarm code id' do
+			invalid = message.dup
+			invalid.delete 'aCId'
+		  expect( validate(invalid) ).to eq([
+		  	["", "required", {"missing_keys"=>["aCId"]}]
+		  ])
+	  end
+
+	  it 'catches bad alarm code id' do
+			invalid = message.dup
+			invalid['aCId'] = "001"
+		  expect( validate(invalid) ).to eq([
+		  	["/aCId", "pattern"]
+		  ])
+		end
+
+	  it 'catches wrong alarm code id type' do
+			invalid = message.dup
+			invalid['aCId'] = 123
+		  expect( validate(invalid) ).to eq([
+		  	["/aCId", "string"]
+		  ])
+	  end
+
+	  it 'catches missing extended alarm code id' do
+			invalid = message.dup
+			invalid.delete 'xACId'
+		  expect( validate(invalid) ).to eq([
+		  	["", "required", {"missing_keys"=>["xACId"]}]
+		  ])
+	  end
+
+	  it 'catches wrong extended alarm code id type' do
+			invalid = message.dup
+			invalid['xACId'] = 123
+		  expect( validate(invalid) ).to eq([
+		  	["/xACId", "string"]
+		  ])
+	  end
+
+	  it 'catches missing specialization' do
+			invalid = message.dup
+			invalid.delete 'aSp'
+		  expect( validate(invalid) ).to eq([
+		  	["", "required", {"missing_keys"=>["aSp"]}]
+		  ])
+	  end
+
+	  it 'catches bad specialization' do
+			invalid = message.dup
+			invalid['aSp'] = "Bad"
+		  expect( validate(invalid) ).to eq([
+		  	["/aSp", "enum"]
+		  ])
+		end
+
+	  it 'catches wrong specialization type' do
+			invalid = message.dup
+			invalid['aSp'] = 123
+		  expect( validate(invalid) ).to eq([
+		  	["/aSp", "enum"],
+		  	["/aSp", "string"]
+		  ])
+	  end
+	end
+end