Separate validation report from result -- state vs. event (faucetsdn#433

)

.gencode_hash.txt

@@ -1,22 +1,29 @@
+52e5e736587cb4d9615b5b48dda53d385fb4c7091864e5d7ebaf804a46519852  gencode/docs/cloud_iot_config.html
+36842bbf9d023a83a3e8958fc3ae607424f4ada5b1e72be35fe2ac443cfd31cc  gencode/docs/command_discovery.html
 a9cf25fa459ab0122be8df276ab4d95c6b1f2ed2256e1cf202f18c178e6906c0  gencode/docs/config.html
+62a5f579661625c0fa53320557be47711e289566b14bd0399b45395cea87ae27  gencode/docs/config_pointset.html
+34e05b6966c611afd4591bdb2f1a606123326c922b0747a3b0861383d68c1177  gencode/docs/configuration_endpoint.html
 90679d3d866579501e7aa00b515af05d42fc9fe399eafacaacf297d1e4a22884  gencode/docs/envelope.html
-80bbcb648a4ebe8f1b5dbb363e1654dd6db0cec2d67ac2c642f2bddc69d5a6ff  gencode/docs/event_discovery.html
+c17060843155c5605e02572a28a02c2c8272028a9874d754894a34d69ee4916f  gencode/docs/event_discovery.html
 8133e380e40f27c56accbffc665b2eeb56ec84a4da3b52ba7aa5e439c9c40572  gencode/docs/event_pointset.html
-cd7622cc8f952aa5aa8b243ef266f1a7d6a311886913f884ffd80cfbcd97daa7  gencode/docs/event_system.html
-77f401d6ad8958cd299072b42d3714f3b71512680e4f948d197795da9c2baa44  gencode/docs/event_validation.html
-f48026471ae3cd7867bce416dc21c2fb728f48d8476a8d6e95f6acaf1d8b6cf3  gencode/docs/index.html
+095f4d562634f91fa895ae7d8b5b2faf02d4100af39c19d7527dec78566bc019  gencode/docs/event_system.html
+aaf67e935fd0c99f6e4d108733e1e184c84c0c55aa03fbfd1ba31ecc9c9f0d95  gencode/docs/event_validation.html
+f09d46f93fcfe0ef2ecf981bab3f9a4981da6327fb4a3b35bf12b82db2f07e56  gencode/docs/index.html
 6d5081d04c86f8bd444efb41cd788826aa66802d37e8f98e93b6b75425542d5e  gencode/docs/metadata.html
+a5263284652e52822c82a863fc27db765eb55861f96316f07836619376323bce  gencode/docs/model_pointset.html
 741b880216be3743f6747800a042f2dbd89f3b0344c6b0a965f4bc010f03a930  gencode/docs/schema_doc.css
 878ea88206c974f40643c3cc430875f9c4e8c5e3fd6bcd6358bd3eb6d48699a9  gencode/docs/schema_doc.min.js
 7ed934930aee763e0beebc349725ba3909115e8d346bb762f28bcbe745bb163a  gencode/docs/schema_extras.js
-9b1f7c10c78d58acf650d8f500e8d972af17fce409189652cb62a1774760cd27  gencode/docs/state.html
+d1cf0d9d652d7004ec60cb67fbee92dcc0b3529affafd6543ae93e8ee428cd8e  gencode/docs/state.html
+01e2b72dd4f3599bffc589a97c328a7069a6716a3271fde3eeacdd8cfc2e7d03  gencode/docs/state_pointset.html
+f4fca4557ef479f363644fe0603fddc943f6de4f1908b3cc5e2bb8d7c79f66c7  gencode/docs/state_validation.html
 d39d7fe37a41c74a40080af7b0a429d201ab1fdff7444428c4b98eb7b38c332b  gencode/java/udmi/schema/Asset.java
 0825a5cec83003bb0a6488c4ed7010a04ae0d3848ef36fe01bb4e6718ba7b96d  gencode/java/udmi/schema/Aux.java
 1f2757c67215cf657297a009a01288108a04daeea919713871a2d34ea903b5f9  gencode/java/udmi/schema/BlobBlobsetConfig.java
 a7c57d119adcd0cf6363cc5301ce562004222522242e8ffd1d0cd7010f235ae1  gencode/java/udmi/schema/BlobBlobsetState.java
 b9f903444ab08907e41eb123286434ff3207b1edd01397af3ddefb8475bbdadc  gencode/java/udmi/schema/BlobsetConfig.java
 fcbed49f1af8b791d8c52bcbe18f65521a79d9ac3eb33ec3afd9b342ab2bfc56  gencode/java/udmi/schema/BlobsetState.java
-2f7cf83f8f46080c011eb4bebcb3b4a2125303f52d91def194a6818cdb944198  gencode/java/udmi/schema/Category.java
+c13c6cf8a5712fbfe8e4b10f19c1e74f1a09f13e1a0a4c8458469d5d46cb0735  gencode/java/udmi/schema/Category.java
 d6875f63ce67d1b945a0b75a4a660bd083cc52492371a7350c4109f6bf54968b  gencode/java/udmi/schema/CloudIotConfig.java
 a2eeff86f4302272736d84602e2ca36a64d27c8ef6761cc05ffb8ad17b030d4d  gencode/java/udmi/schema/CloudModel.java
 ff79de9390aa25bb45fb3e2ebb682c865ccab764f56d9644377d9d28c0ab10e4  gencode/java/udmi/schema/Config.java
@@ -73,11 +80,12 @@ b2274107ce0e4e663b2a35e2ca284e492ec683bd687f6b8d8b014d5f8be67233  gencode/java/u
 7d6dd13e368e7f073738fee69c15e18652a9b7d7ac63bde0a200f747e3aa1b1d  gencode/java/udmi/schema/TargetTestingModel.java
 d3968b92497e83a63f18cc0e74484a9807f1bb92db0c92d556ec2caaa143d645  gencode/java/udmi/schema/TestingModel.java
 8a7dd590b84944de25392b1437184608edd2f8305a183eced8b1b40eae27c6d2  gencode/java/udmi/schema/TestingSystemConfig.java
-347da3d586ff6e5dcf3ce8ec0c800ec0efd5fed4e0c80eef35de65ad92ae48bf  gencode/java/udmi/schema/ValidationEvent.java
+ac6f8fd87c8986cce01e872460c15ff6fe71e3816f9bde610acfe25f7d38c8d4  gencode/java/udmi/schema/ValidationEvent.java
+f7d117dc8b9764acf0c95a13a2bfdfbdf31d1a8ec83a707448aa4d7391ef07e2  gencode/java/udmi/schema/ValidationState.java
 e007ddd1ceeae3603c85110c33e1bb4a418ff9c7a791ca0df25b7ea3caeafd36  gencode/java/udmi/schema/ValidationSummary.java
-1da7c14bbcbb4bd957259de271ed9585af915b3cebc4d3cf84b52a8f1b55d2a7  gencode/python/udmi/schema/__init__.py
+8db92d02ed31738ac46969a7a24dbd23d330f7855afced2a84abd9e8f44fdcc2  gencode/python/udmi/schema/__init__.py
 4b25dd95f863059b761269f93adcae7049507924a1c6e74d6856849203c179db  gencode/python/udmi/schema/ancillary_properties.py
-30962f693f0065565f8f6610db934aa8ade58b7c9c978b6e0921d86336e3e1f2  gencode/python/udmi/schema/category.py
+8783e8235fb51ae3d13b241967219c6d4160627b8d62f7bfe7f0658b2a9bdcb5  gencode/python/udmi/schema/category.py
 a61b1c5732f01b7efda41a773d5786fad755f371193ce4478b458387ca2a8fe8  gencode/python/udmi/schema/cloud_iot_config.py
 6578d68f65b87b781086e72566de910db4bef365599fe3188862d4d8a81e84fb  gencode/python/udmi/schema/command_discovery.py
 c5a62f92328e2ede167fc1f53bece6e48696a0ab0e37e3a41f65cd98494ba0d7  gencode/python/udmi/schema/common.py
@@ -103,7 +111,7 @@ abe4044d2e3be6693ed39edc8ccaed4eee4eb8acad991e820b21d6ecf3812dd9  gencode/python
 ddf849bfeb2b87d071cefd5e6feacabc57375a7fff6d72b6d42ffb89f33c859b  gencode/python/udmi/schema/event_pointset.py
 44aff1bc930dbdbadd51ac3fe0e7d9c83ad84a6a9f9d1c809b3fce66cbcd5e00  gencode/python/udmi/schema/event_pointset_point.py
 c3bf9959c821ccc8d0847a2e022e847ac3da8309dc6d35681af3d20148464ee4  gencode/python/udmi/schema/event_system.py
-24b7f3e103024c904e7eb8be52239d6a282221d5e080cf9c0be02a6aade4357d  gencode/python/udmi/schema/event_validation.py
+fb8a8a0e09eca4bb061c6cb2ff91b8eee77203e6ea353d3356e411692e1e4f2a  gencode/python/udmi/schema/event_validation.py
 2bb36986f805c2127f0c300de07bce07897c0c6d8f504bddec6e201d0f0ab1bf  gencode/python/udmi/schema/event_validation_device.py
 42f3429edf4a187be6ebfe9760f5e14821a25afa8f7c65b69e0e34fb29a7932e  gencode/python/udmi/schema/metadata.py
 b2227a48f21594f78c07c427de64e7ce51dc0ecd4b8091601d739a5f5038a2c9  gencode/python/udmi/schema/model_cloud.py
@@ -131,3 +139,4 @@ a58f8c98e837a5b56126ca0f410e02f1e9cfcd80a8cb429e0ef522defab1f690  gencode/python
 837ecc89c477abe3a1faf837733ca05475774891b55353d84ca231d90a1fbf31  gencode/python/udmi/schema/state_pointset_point.py
 8184e783f3e2da5a6d3fb7e7fac105aaeb28106a7c146e82b610049554abf184  gencode/python/udmi/schema/state_system.py
 791006619518fd7b38adb532879bcacd6f3f8795026cd75e10d3434a177757ac  gencode/python/udmi/schema/state_system_hardware.py
+231479e4dd7d961d59149580aba6a99cd466cea553400f338e9da2bf3ffbe78c  gencode/python/udmi/schema/state_validation.py

bin/gencode_docs

@@ -103,7 +103,8 @@ find $TMP_DIR -type f -exec sed -i 's/file://' {} \;
 # is one level down
 find $TMP_DIR -type f -exec sed -i 's;(../docs/;(../../docs/;' {} \;
 
-schemas="state event_system event_pointset event_discovery event_validation config metadata envelope"
+schemas=$((cd tests/; ls -d *.tests) | sed s/.tests//)
+echo Processing schemas $schemas
 
 for schema in $schemas; do
     echo == Processing $schema.json
@@ -133,3 +134,5 @@ find $OUTPUT_DIR -type f -exec sed -i -E "s;</head>;<script src=\"schema_extras.
 
 find $OUTPUT_DIR -type f -exec sed -i -E "s/<body onload=\"anchorOnLoad\(\);\"/\
     <body onload=\"anchorOnLoad\(\);removedHostedMDExtensions\(\);\"/" {} \;
+
+echo Done with $0

docs/specs/categories.md

@@ -44,3 +44,9 @@ implicit expected `level` values, indicated by '(**LEVEL**)' in the hierarchy be
     * _receive_: (**DEBUG**) About receiving a blob update
     * _fetch_: (**DEBUG**) Fetching a blob update
     * _apply_: (**NOTICE**) Applying a blob update
+* _validation_: Handling validation pipeline messages
+  * _device_: Conditions specific to processing a given device message.
+    * _receive_: (**DEBUG**) Receiving/processing a message for validation.
+    * _result_: (**INFO**) Regarging the actual validation results.
+  * _summary_: Conditions specific to an overall site summary.
+    * _report_: (**INFO**) The validation summary report.

docs/specs/validation.md

@@ -14,11 +14,12 @@ seen, or never seen, etc...). This capability is an extension of the basic
 The validation agent runs autonomously, consumes messages, and injects _result_ or _report_ messages as needed.
 All validation messages are defined by the
 [validation event schema](../../schema/event_validation.json)([_🧬View_](../../gencode/docs/event_validation.html)).
-
+and
+[validation state schema](../../schema/state_validation.json)([_🧬View_](../../gencode/docs/state_validation.html)).
 schema, and are instantiated in two flavors:
 
 * _result_: Validation results for an individual device [example](../../tests/event_validation.tests/simple_ok.json).
-* _report_: Validation report for an entire site [example](../../tests/event_validation.tests/report.json).
+* _report_: Validation report for an entire site [example](../../tests/state_validation.tests/report.json).
 
 ## Message Channel
 
@@ -46,11 +47,10 @@ Sending validation updates to projects/bos-udmi-dev/topics/udmi_reflect
 
 ## Verifying Output
 
-If everything worked as intended, there should be periodic validation events that show up on the `udmi_target`
-topic.
+If everything worked as intended, there should be periodic validation messages that show up on the `udmi_target` topic:
 
 <pre>
   attribute.subFolder = 'validation'
-  attribute.subType = 'event'
-  attribute.deviceId = '_validator' or <i>deviceId of validated device</i>
+  attribute.subType = 'event' <i>or</i> 'state'
+  attribute.deviceId = deviceId <i>or</i> '_validator'
 </pre>