Correct writeback_state sequence test (#450)

.gitattributes

@@ -1 +1,4 @@
 /gencode/** linguist-generated=true
+validator/sequences/**/*.json linguist-generated=true
+validator/sequences/**/*.attr linguist-generated=true
+validator/sequences/**/*.log linguist-generated=true

.github/workflows/testing.yml

@@ -111,6 +111,9 @@ jobs:
           more /tmp/sequencer.out
           diff -u /tmp/sequencer.out etc/sequencer.out
           diff -u /tmp/generated.md docs/specs/sequences/generated.md
+          ls -1 sites/udmi_site_model/out/devices/AHU-1/tests/ | xargs -I% diff -u \
+              sites/udmi_site_model/out/devices/AHU-1/tests/%/sequence.md \
+              validator/sequences/%/sequence.md
       - name: telemetry validator
         env:
           GCP_TARGET_PROJECT: ${{ secrets.GCP_TARGET_PROJECT }}

bin/clone_model

@@ -5,7 +5,7 @@ mkdir -p $ROOT_DIR/sites
 cd $ROOT_DIR/sites 
 
 MODEL_DIR=udmi_site_model
-MODEL_VER=1.7
+MODEL_VER=1.8
 TEST_SITE_GIT=https://github.com/faucetsdn/$MODEL_DIR.git
 MODEL_REPO=origin
 

docs/specs/sequences/generated.md

@@ -71,7 +71,7 @@ Check that the device MQTT-acknowledges a sent config.
 Push endpoint config message to device that results in a connection error.
 
 1. Update config:
-    * Add `blobset` = { "blobs": {  } }
+    * Add `blobset` = { "blobs": { "_iot_endpoint_config": { "phase": `final`, "content_type": `application/json`, "base64": `eyAgICJwcm90b2NvbCI6ICJtcXR0IiwKICAiY2xpZW50X2lkIjogInRlc3RfcHJvamVjdC9kZXZpY2UiLAogICJob3N0bmFtZSI6ICJsb2NhbGhvc3QiCn0=` } } }
 1. Wait for blobset entry config status is error
 
 ## extra_config
@@ -101,6 +101,8 @@ Check that the device correctly handles an extra out-of-schema field
 1. Update config:
     * Add `discovery` = { "families": {  } }
 1. Wait for all scans not active
+1. Update config:
+    * Add `discovery.families.virtual` = { "generation": _family generation_, "scan_interval_sec": `10`, "enumerate": `true` }
 1. Wait for scan iterations
 
 ## self_enumeration
@@ -116,6 +118,8 @@ Check that the device correctly handles an extra out-of-schema field
 1. Update config:
     * Add `discovery` = { "families": {  } }
 1. Wait for all scans not active
+1. Update config:
+    * Add `discovery.families.virtual` = { "generation": _family generation_, "enumerate": `true` }
 1. Wait for scheduled scan start
 1. Wait for scan activation
 1. Wait for scan completed
@@ -143,4 +147,13 @@ Check that the min log-level config is honored by the device.
 
 ## writeback_states
 
-1. Test failed: Missing 'invalid' target specification
+1. Wait for point filter_differential_pressure_sensor to have value_state default (null)
+1. Wait for point filter_alarm_pressure_status to have value_state default (null)
+1. Wait for point filter_differential_pressure_setpoint to have value_state default (null)
+1. Update config:
+    * Add `pointset.points.filter_alarm_pressure_status.set_value` = `false`
+    * Set `pointset.points.filter_differential_pressure_setpoint.set_value` = `60`
+    * Add `pointset.points.filter_differential_pressure_sensor.set_value` = `15`
+1. Wait for point filter_differential_pressure_sensor to have value_state invalid
+1. Wait for point filter_alarm_pressure_status to have value_state failure
+1. Wait for point filter_differential_pressure_setpoint to have value_state applied

etc/sequencer.out

@@ -11,4 +11,4 @@ RESULT pass valid_serial_no Sequence complete
 RESULT pass valid_serial_no Sequence complete
 RESULT pass valid_serial_no Sequence complete
 RESULT pass valid_serial_no Sequence complete
-RESULT skip writeback_states Missing 'invalid' target specification
+RESULT pass writeback_states Sequence complete

validator/bin/build

@@ -19,7 +19,7 @@ fi
 
 export JAVA_HOME=$JAVA_HOME_11_X64
 
-echo Building validataor in $PWD
+echo Building validator in $PWD
 
 rm -rf build
 ./gradlew shadow $check $*

validator/sequences/endpoint_config_connection_error/sequence.md

@@ -0,0 +1,8 @@
+
+## endpoint_config_connection_error
+
+Push endpoint config message to device that results in a connection error.
+
+1. Update config:
+    * Add `blobset` = { "blobs": { "_iot_endpoint_config": { "phase": `final`, "content_type": `application/json`, "base64": `eyAgICJwcm90b2NvbCI6ICJtcXR0IiwKICAiY2xpZW50X2lkIjogInRlc3RfcHJvamVjdC9kZXZpY2UiLAogICJob3N0bmFtZSI6ICJsb2NhbGhvc3QiCn0=` } } }
+1. Wait for blobset entry config status is error

validator/sequences/periodic_scan/sequence.md

@@ -4,4 +4,6 @@
 1. Update config:
     * Add `discovery` = { "families": {  } }
 1. Wait for all scans not active
+1. Update config:
+    * Add `discovery.families.virtual` = { "generation": _family generation_, "scan_interval_sec": `10`, "enumerate": `true` }
 1. Wait for scan iterations

validator/sequences/single_scan/sequence.md

@@ -4,6 +4,8 @@
 1. Update config:
     * Add `discovery` = { "families": {  } }
 1. Wait for all scans not active
+1. Update config:
+    * Add `discovery.families.virtual` = { "generation": _family generation_, "enumerate": `true` }
 1. Wait for scheduled scan start
 1. Wait for scan activation
 1. Wait for scan completed

validator/sequences/writeback_states/sequence.md

@@ -1,4 +1,13 @@
 
 ## writeback_states
 
-1. Test failed: Missing 'invalid' target specification
+1. Wait for point filter_differential_pressure_sensor to have value_state default (null)
+1. Wait for point filter_alarm_pressure_status to have value_state default (null)
+1. Wait for point filter_differential_pressure_setpoint to have value_state default (null)
+1. Update config:
+    * Add `pointset.points.filter_alarm_pressure_status.set_value` = `false`
+    * Set `pointset.points.filter_differential_pressure_setpoint.set_value` = `60`
+    * Add `pointset.points.filter_differential_pressure_sensor.set_value` = `15`
+1. Wait for point filter_differential_pressure_sensor to have value_state invalid
+1. Wait for point filter_alarm_pressure_status to have value_state failure
+1. Wait for point filter_differential_pressure_setpoint to have value_state applied

validator/src/main/java/com/google/daq/mqtt/sequencer/sequences/DiscoverySequences.java

@@ -44,7 +44,8 @@ public void self_enumeration() {
     Date startTime = SemanticDate.describe("generation start time", CleanDateFormat.cleanDate());
     deviceConfig.discovery = new DiscoveryConfig();
     deviceConfig.discovery.enumeration = new FamilyDiscoveryConfig();
-    deviceConfig.discovery.enumeration.generation = startTime;
+    deviceConfig.discovery.enumeration.generation =
+        SemanticDate.describe("generation start time", startTime);
     info("Starting enumeration at " + JsonUtil.getTimestamp(startTime));
     updateConfig("discovery generation");
     untilTrue("enumeration generation",
@@ -137,7 +138,7 @@ private void initializeDiscovery() {
   private void scheduleScan(Date startTime, Integer scanIntervalSec, boolean enumerate) {
     info("Scan start scheduled for " + startTime);
     families.forEach(family -> {
-      getConfigFamily(family).generation = startTime;
+      getConfigFamily(family).generation = SemanticDate.describe("family generation", startTime);
       getConfigFamily(family).enumerate = enumerate;
       getConfigFamily(family).scan_interval_sec = scanIntervalSec;
     });

validator/src/main/java/com/google/daq/mqtt/sequencer/sequences/WritebackSequences.java

@@ -56,13 +56,14 @@ public void writeback_states() {
     deviceConfig.pointset.points.get(failurePoint).set_value = failureTarget.target_value;
     deviceConfig.pointset.points.get(appliedPoint).set_value = appliedTarget.target_value;
     updateConfig();
+
     untilTrue(expectedValueState(invalidPoint, INVALID_STATE),
         () -> valueStateIs(invalidPoint, INVALID_STATE)
     );
-    untilTrue(expectedValueState(invalidPoint, FAILURE_STATE),
+    untilTrue(expectedValueState(failurePoint, FAILURE_STATE),
         () -> valueStateIs(failurePoint, FAILURE_STATE)
     );
-    untilTrue(expectedValueState(invalidPoint, APPLIED_STATE),
+    untilTrue(expectedValueState(appliedPoint, APPLIED_STATE),
         () -> valueStateIs(appliedPoint, APPLIED_STATE)
     );
   }

validator/src/main/java/com/google/daq/mqtt/util/ConfigDiffEngine.java

@@ -1,7 +1,5 @@
 package com.google.daq.mqtt.util;
 
-import static com.google.common.base.Preconditions.checkNotNull;
-
 import com.google.common.base.Joiner;
 import com.google.common.collect.ImmutableMap;
 import com.google.daq.mqtt.sequencer.semantic.SemanticValue;
@@ -25,8 +23,7 @@ public ConfigDiffEngine() {
   }
 
   /**
-   * Compute the changes in a config object from the previous config, as
-   * stored in the class.
+   * Compute the changes in a config object from the previous config, as stored in the class.
    *
    * @param deviceConfig new config
    * @return list of differences against the previous config
@@ -40,16 +37,24 @@ public List<String> computeChanges(Config deviceConfig) {
     return configUpdates;
   }
 
+  @SuppressWarnings("unchecked")
   private Map<String, Object> convertSemantics(Object thing) {
-    return thing == null ? ImmutableMap.of() :
-        Arrays.stream(thing.getClass().getFields())
-            .filter(field -> isNotNull(thing, field)).collect(
-                Collectors.toMap(Field::getName, field -> convertSemantics(thing, field)));
+    if (thing == null) {
+      return ImmutableMap.of();
+    }
+    if (thing instanceof Map) {
+      Map<String, Object> asMap = (Map<String, Object>) thing;
+      return asMap.keySet().stream()
+          .collect(Collectors.toMap(key -> key, key -> convertSemantics(asMap.get(key))));
+    }
+    return Arrays.stream(thing.getClass().getFields())
+        .filter(field -> isNotNull(thing, field)).collect(
+            Collectors.toMap(Field::getName, field -> convertSemantics(thing, field)));
   }
 
   private Object convertSemantics(Object thing, Field field) {
     try {
-      if (isBaseType(field)) {
+      if (isBaseType(field) || isBaseType(field.get(thing))) {
         return field.get(thing);
       } else {
         return convertSemantics(field.get(thing));
@@ -69,7 +74,10 @@ private boolean isNotNull(Object thing, Field field) {
 
   private boolean isBaseType(Object value) {
     Class<?> type = value instanceof Field ? ((Field) value).getType() : value.getClass();
-    return Integer.class.isAssignableFrom(type)
+    return type.isPrimitive()
+        || type.isEnum()
+        || Boolean.class.isAssignableFrom(type)
+        || Integer.class.isAssignableFrom(type)
         || String.class.isAssignableFrom(type)
         || Date.class.isAssignableFrom(type);
   }