Merge pull request #525 from icraggs-sparkplug/develop

3 Commits to bring develop in line with 3.x

Author: wes-johnson

tck/src/main/java/org/eclipse/sparkplug/tck/test/edge/PrimaryHostTest.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2021, 2023 Ian Craggs
+ * Copyright (c) 2021, 2024 Ian Craggs
  *
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
@@ -47,6 +47,7 @@
 import static org.eclipse.sparkplug.tck.test.common.Requirements.OPERATIONAL_BEHAVIOR_EDGE_NODE_TERMINATION_HOST_OFFLINE_RECONNECT;
 import static org.eclipse.sparkplug.tck.test.common.Requirements.OPERATIONAL_BEHAVIOR_EDGE_NODE_TERMINATION_HOST_OFFLINE_TIMESTAMP;
 
+import java.nio.ByteBuffer;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -62,6 +63,7 @@
 import org.eclipse.sparkplug.tck.test.TCKTest;
 import org.eclipse.sparkplug.tck.test.common.Constants;
 import org.eclipse.sparkplug.tck.test.common.Constants.TestStatus;
+import org.eclipse.sparkplug.tck.test.common.SparkplugBProto;
 import org.eclipse.sparkplug.tck.test.common.Utils;
 import org.jboss.test.audit.annotations.SpecAssertion;
 import org.jboss.test.audit.annotations.SpecVersion;
@@ -83,6 +85,7 @@ public class PrimaryHostTest extends TCKTest {
 
 	private static final @NotNull Logger logger = LoggerFactory.getLogger("Sparkplug");
 	public static final String PROPERTY_KEY_QUALITY = "Quality";
+	private static final String BD_SEQ = "bdSeq";
 
 	public static final @NotNull List<String> testIds = List.of(ID_MESSAGE_FLOW_EDGE_NODE_BIRTH_PUBLISH_PHID_WAIT,
 			ID_MESSAGE_FLOW_EDGE_NODE_BIRTH_PUBLISH_PHID_WAIT_ID,
@@ -101,6 +104,7 @@ public class PrimaryHostTest extends TCKTest {
 	private @NotNull String edgeNodeId;
 	private @NotNull String hostApplicationId;
 	private @NotNull long seqUnassigned = -1;
+	private @NotNull long birthSeq = -1; // record the nbirth seq to check for matching ndeath
 	private Utilities utilities = null;
 
 	private TestStatus state = TestStatus.NONE;
@@ -350,6 +354,18 @@ public void subscribe(final @NotNull String clientId, final @NotNull SubscribePa
 		// TODO Auto-generated method stub
 	}
 
+	private long getBdSeq(final ByteBuffer payload) {
+		final SparkplugBProto.PayloadOrBuilder inboundPayload = Utils.decode(payload);
+		if (inboundPayload != null) {
+			for (SparkplugBProto.Payload.Metric m : inboundPayload.getMetricsList()) {
+				if (m.getName().equals(BD_SEQ)) {
+					return m.getLongValue();
+				}
+			}
+		}
+		return -1L;
+	}
+
 	@SpecAssertion(
 			section = Sections.OPERATIONAL_BEHAVIOR_EDGE_NODE_SESSION_ESTABLISHMENT,
 			id = ID_MESSAGE_FLOW_EDGE_NODE_BIRTH_PUBLISH_PHID_WAIT)
@@ -387,6 +403,10 @@ public void publish(final @NotNull String clientId, final @NotNull PublishPacket
 
 		if (topic.equals(Constants.TOPIC_ROOT_SP_BV_1_0 + "/" + groupId + "/" + Constants.TOPIC_PATH_NBIRTH + "/"
 				+ edgeNodeId)) {
+
+			ByteBuffer payload = packet.getPayload().orElseGet(null);
+			birthSeq = getBdSeq(payload);
+
 			// found the edge NBIRTH
 			if (state == TestStatus.WRONG_HOST_ONLINE) {
 				// received NBIRTH for wrong host
@@ -466,20 +486,25 @@ public void publish(final @NotNull String clientId, final @NotNull PublishPacket
 			}
 		} else if (topic.equals(Constants.TOPIC_ROOT_SP_BV_1_0 + "/" + groupId + "/" + Constants.TOPIC_PATH_NDEATH + "/"
 				+ edgeNodeId)) {
+			ByteBuffer payload = packet.getPayload().orElseGet(null);
+			long deathSeq = getBdSeq(payload);
 
-			logger.info("Received NDEATH in state " + state.name());
-			Utils.setResultIfNotFail(testResults, state == TestStatus.EXPECT_DEATHS || state == TestStatus.HOST_OFFLINE,
-					ID_OPERATIONAL_BEHAVIOR_EDGE_NODE_TERMINATION_HOST_OFFLINE,
-					OPERATIONAL_BEHAVIOR_EDGE_NODE_TERMINATION_HOST_OFFLINE);
+			logger.info("Received NDEATH in state " + state.name() + " with bdseq " + deathSeq + " (birthSeq " + birthSeq + ")");
 
-			Utils.setResultIfNotFail(testResults, state == TestStatus.EXPECT_DEATHS || state == TestStatus.HOST_OFFLINE,
-					ID_MESSAGE_FLOW_EDGE_NODE_BIRTH_PUBLISH_PHID_OFFLINE,
-					MESSAGE_FLOW_EDGE_NODE_BIRTH_PUBLISH_PHID_OFFLINE);
+			if (deathSeq == birthSeq) { // ignore ndeaths from different births
+				Utils.setResultIfNotFail(testResults, state == TestStatus.EXPECT_DEATHS || state == TestStatus.HOST_OFFLINE,
+						ID_OPERATIONAL_BEHAVIOR_EDGE_NODE_TERMINATION_HOST_OFFLINE,
+						OPERATIONAL_BEHAVIOR_EDGE_NODE_TERMINATION_HOST_OFFLINE);
 
-			if (state == TestStatus.DONT_EXPECT_DEATHS) {
-				Utils.setResult(testResults, false,
-						ID_OPERATIONAL_BEHAVIOR_EDGE_NODE_TERMINATION_HOST_OFFLINE_TIMESTAMP,
-						OPERATIONAL_BEHAVIOR_EDGE_NODE_TERMINATION_HOST_OFFLINE_TIMESTAMP);
+				Utils.setResultIfNotFail(testResults, state == TestStatus.EXPECT_DEATHS || state == TestStatus.HOST_OFFLINE,
+						ID_MESSAGE_FLOW_EDGE_NODE_BIRTH_PUBLISH_PHID_OFFLINE,
+						MESSAGE_FLOW_EDGE_NODE_BIRTH_PUBLISH_PHID_OFFLINE);
+
+				if (state == TestStatus.DONT_EXPECT_DEATHS) {
+					Utils.setResult(testResults, false,
+							ID_OPERATIONAL_BEHAVIOR_EDGE_NODE_TERMINATION_HOST_OFFLINE_TIMESTAMP,
+							OPERATIONAL_BEHAVIOR_EDGE_NODE_TERMINATION_HOST_OFFLINE_TIMESTAMP);
+				}
 			}
 
 		} else if (topic.equals(Constants.TOPIC_ROOT_SP_BV_1_0 + "/" + groupId + "/" + Constants.TOPIC_PATH_DDEATH + "/"

tck/src/main/java/org/eclipse/sparkplug/tck/test/edge/SendComplexDataTest.java

@@ -1,6 +1,6 @@
 
 /**
- * Copyright (c) 2022, 2023 Anja Helmbrecht-Schaar, Ian Craggs
+ * Copyright (c) 2022, 2024 Anja Helmbrecht-Schaar, Ian Craggs
  * <p>
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
@@ -341,9 +341,11 @@ public void checkSequenceNumberIncluded(final @NotNull PublishPacket packet, Str
 			isValid = false;
 			logger.error("Check req set for : {}", ID_PAYLOADS_SEQUENCE_NUM_ALWAYS_INCLUDED);
 		} else {
-			if (result.getSeq() >= 0) {
-				isValid = true;
-			} else if (result.getSeq() == seqUnassigned && topic.contains(TOPIC_PATH_NDEATH)) {
+			if (result.hasSeq()) {
+				if (result.getSeq() >= 0 && result.getSeq() <= 255) {
+					isValid = true;
+				}
+			} else if (topic.contains(TOPIC_PATH_NDEATH)) {
 				isValid = true;
 			}
 		}

tck/src/main/java/org/eclipse/sparkplug/tck/test/edge/SendDataTest.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2021, 2023 Ian Craggs
+ * Copyright (c) 2021, 2024 Ian Craggs
  *
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
@@ -511,7 +511,7 @@ private Boolean[] checkValidPayload(PayloadOrBuilder payload) {
 		if (payload != null) {
 			long seqNum = payload.getSeq();
 			bValidPayload[0] = true;
-			bValidPayload[1] = (seqNum >= 0 && seqNum <= 255);
+			bValidPayload[1] = payload.hasSeq() && (seqNum >= 0 && seqNum <= 255);
 			bValidPayload[2] = payload.hasTimestamp();
 			bValidPayload[3] = payload.hasTimestamp();
 			List<Metric> metrics = payload.getMetricsList();

tck/src/main/java/org/eclipse/sparkplug/tck/test/edge/SessionEstablishmentTest.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2021, 2023 Ian Craggs
+ * Copyright (c) 2021, 2024 Ian Craggs
  *
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
@@ -611,14 +611,15 @@ public void checkNBirth(final @NotNull PublishPacket packet) {
 			logger.debug("Check Req: NBIRTH message must have Qos set to 0.");
 			logger.debug(
 					"Check Req: Every NBIRTH message MUST include a sequence number and it MUST have a value of 0.");
+			boolean hasSeq = sparkplugPayload.hasSeq();
 			seq = sparkplugPayload.getSeq();
-			testResults.put(ID_PAYLOADS_NBIRTH_SEQ, setResult((seq == 0), PAYLOADS_NBIRTH_SEQ));
-			testResults.put(ID_TOPICS_NBIRTH_SEQ_NUM, setResult((seq == 0), TOPICS_NBIRTH_SEQ_NUM));
+			testResults.put(ID_PAYLOADS_NBIRTH_SEQ, setResult((hasSeq && seq == 0), PAYLOADS_NBIRTH_SEQ));
+			testResults.put(ID_TOPICS_NBIRTH_SEQ_NUM, setResult((hasSeq && seq == 0), TOPICS_NBIRTH_SEQ_NUM));
 			testResults.put(ID_PAYLOADS_SEQUENCE_NUM_REQ_NBIRTH,
-					setResult((seq >= 0 && seq <= 255), PAYLOADS_SEQUENCE_NUM_REQ_NBIRTH));
+					setResult((hasSeq && (seq >= 0 && seq <= 255)), PAYLOADS_SEQUENCE_NUM_REQ_NBIRTH));
 
 			testResults.put(ID_MESSAGE_FLOW_EDGE_NODE_BIRTH_PUBLISH_NBIRTH_PAYLOAD_SEQ,
-					setResult((seq >= 0 && seq <= 255), MESSAGE_FLOW_EDGE_NODE_BIRTH_PUBLISH_NBIRTH_PAYLOAD_SEQ));
+					setResult((hasSeq && (seq >= 0 && seq <= 255)), MESSAGE_FLOW_EDGE_NODE_BIRTH_PUBLISH_NBIRTH_PAYLOAD_SEQ));
 
 			// receivedBirthTime::making sure that the payload timestamp is greater than (receivedBirthTime - 5 min) and
 			// less than the
@@ -843,9 +844,8 @@ public void checkDBirth(final @NotNull PublishPacket packet) {
 			logger.debug("Check Req: DBIRTH must include a sequence number");
 			prevResult = testResults.getOrDefault(ID_PAYLOADS_DBIRTH_SEQ, NOT_EXECUTED);
 			if (!prevResult.contains(FAIL)) {
-				boolean bContains = (sparkplugPayload.getSeq() != -1);
 				if (prevResult.equals(NOT_EXECUTED)) {
-					testResults.put(ID_PAYLOADS_DBIRTH_SEQ, setResult(bContains, PAYLOADS_DBIRTH_SEQ));
+					testResults.put(ID_PAYLOADS_DBIRTH_SEQ, setResult(sparkplugPayload.hasSeq(), PAYLOADS_DBIRTH_SEQ));
 				}
 			}
 
@@ -856,12 +856,12 @@ public void checkDBirth(final @NotNull PublishPacket packet) {
 			if (!prevResult.contains(FAIL)) {
 				boolean bSeqValid = false;
 				if (seq != 255) {
-					if (sparkplugPayload.getSeq() == (seq + 1)) {
+					if (sparkplugPayload.hasSeq() && (sparkplugPayload.getSeq() == (seq + 1))) {
 						bSeqValid = true;
 						seq = sparkplugPayload.getSeq();
 					}
 				} else {
-					if (sparkplugPayload.getSeq() == 0) {
+					if (sparkplugPayload.hasSeq() && (sparkplugPayload.getSeq() == 0)) {
 						bSeqValid = true;
 						seq = sparkplugPayload.getSeq();
 					}