You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by sr...@apache.org on 2022/11/07 12:32:43 UTC
[plc4x] branch develop updated: test(plc4j): added HexDiff for easier identification of hex drifts
This is an automated email from the ASF dual-hosted git repository.
sruehl pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/plc4x.git
The following commit(s) were added to refs/heads/develop by this push:
new 22368ddc9f test(plc4j): added HexDiff for easier identification of hex drifts
22368ddc9f is described below
commit 22368ddc9f47bfb32b0da0fb6a29fd010000c677
Author: Sebastian Rühl <sr...@apache.org>
AuthorDate: Mon Nov 7 13:32:35 2022 +0100
test(plc4j): added HexDiff for easier identification of hex drifts
---
.../plc4x/java/bacnetip/RandomPackagesTest.java | 9 ++++-
.../java/org/apache/plc4x/test/hex/HexDiff.java | 45 ++++++++++++++++++++++
.../ParserSerializerTestsuiteRunner.java | 23 +++--------
3 files changed, 57 insertions(+), 20 deletions(-)
diff --git a/plc4j/drivers/bacnet/src/test/java/org/apache/plc4x/java/bacnetip/RandomPackagesTest.java b/plc4j/drivers/bacnet/src/test/java/org/apache/plc4x/java/bacnetip/RandomPackagesTest.java
index baa9039505..e7c03127d9 100644
--- a/plc4j/drivers/bacnet/src/test/java/org/apache/plc4x/java/bacnetip/RandomPackagesTest.java
+++ b/plc4j/drivers/bacnet/src/test/java/org/apache/plc4x/java/bacnetip/RandomPackagesTest.java
@@ -24,9 +24,12 @@ import org.apache.commons.lang3.ArrayUtils;
import org.apache.plc4x.java.bacnetip.readwrite.*;
import org.apache.plc4x.java.spi.generation.*;
import org.apache.plc4x.java.spi.utils.Serializable;
+import org.apache.plc4x.java.spi.utils.ascii.AsciiBox;
+import org.apache.plc4x.java.spi.utils.ascii.AsciiBoxWriter;
import org.apache.plc4x.java.spi.utils.hex.Hex;
import org.apache.plc4x.test.RequireAllTestsFlag;
import org.apache.plc4x.test.RequirePcapNg;
+import org.apache.plc4x.test.hex.HexDiff;
import org.assertj.core.api.InstanceOfAssertFactories;
import org.assertj.core.presentation.HexadecimalRepresentation;
import org.junit.jupiter.api.*;
@@ -3654,7 +3657,7 @@ public class RandomPackagesTest {
() -> assertThat(baos.toByteArray())
.satisfies(bytes -> {
LOGGER.info("Trying to parse\n{}", Hex.dump(bytes));
- BACnetServiceAckAtomicReadFile baCnetServiceAck = (BACnetServiceAckAtomicReadFile) BACnetServiceAckAtomicReadFile.staticParse(new ReadBufferByteBased(bytes), bytes.length);
+ BACnetServiceAckAtomicReadFile baCnetServiceAck = (BACnetServiceAckAtomicReadFile) BACnetServiceAckAtomicReadFile.staticParse(new ReadBufferByteBased(bytes), (long) bytes.length);
assertThat(baCnetServiceAck)
.isNotNull()
.extracting(BACnetServiceAckAtomicReadFile::getAccessMethod)
@@ -6055,9 +6058,11 @@ public class RandomPackagesTest {
@SuppressWarnings("redundant")
byte[] expectedBytes = rawData;
byte[] actualBytes = writeBuffer.getBytes();
+ // This goes to std out on purpose to preserve coloring
+ System.out.println(HexDiff.diffHex(expectedBytes, actualBytes));
assertThat(actualBytes)
.withRepresentation(HexadecimalRepresentation.HEXA_REPRESENTATION)
- .describedAs("re-serialized output doesn't match original bytes:%s", bvlc)
+ .describedAs("re-serialized output doesn't match original bytes:%s\n", bvlc)
.isEqualTo(expectedBytes);
}
} else {
diff --git a/plc4j/utils/test-utils/src/main/java/org/apache/plc4x/test/hex/HexDiff.java b/plc4j/utils/test-utils/src/main/java/org/apache/plc4x/test/hex/HexDiff.java
new file mode 100644
index 0000000000..6628970d1f
--- /dev/null
+++ b/plc4j/utils/test-utils/src/main/java/org/apache/plc4x/test/hex/HexDiff.java
@@ -0,0 +1,45 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.plc4x.test.hex;
+
+import org.apache.plc4x.java.spi.utils.ascii.AsciiBox;
+import org.apache.plc4x.java.spi.utils.ascii.AsciiBoxWriter;
+
+import java.util.LinkedList;
+import java.util.List;
+
+public class HexDiff {
+ public static AsciiBox diffHex(byte[] expectedBytes, byte[] actualBytes) {
+ int numBytes = Math.min(expectedBytes.length, actualBytes.length);
+ int brokenAt = -1;
+ List<Integer> diffIndexes = new LinkedList<>();
+ for (int i = 0; i < numBytes; i++) {
+ if (expectedBytes[i] != actualBytes[i]) {
+ if (brokenAt < 0) {
+ brokenAt = i;
+ }
+ diffIndexes.add(i);
+ }
+ }
+ String expectedHex = org.apache.plc4x.java.spi.utils.hex.Hex.dump(expectedBytes, 46, diffIndexes.stream().mapToInt(integer -> integer).toArray());
+ String actialHex = org.apache.plc4x.java.spi.utils.hex.Hex.dump(actualBytes, 46, diffIndexes.stream().mapToInt(integer -> integer).toArray());
+ return AsciiBoxWriter.DEFAULT.boxSideBySide(AsciiBoxWriter.DEFAULT.boxString("expected", expectedHex, 0), AsciiBoxWriter.DEFAULT.boxString("actual", actialHex, 0));
+ }
+}
diff --git a/plc4j/utils/test-utils/src/main/java/org/apache/plc4x/test/parserserializer/ParserSerializerTestsuiteRunner.java b/plc4j/utils/test-utils/src/main/java/org/apache/plc4x/test/parserserializer/ParserSerializerTestsuiteRunner.java
index f981d52928..103885ba2d 100644
--- a/plc4j/utils/test-utils/src/main/java/org/apache/plc4x/test/parserserializer/ParserSerializerTestsuiteRunner.java
+++ b/plc4j/utils/test-utils/src/main/java/org/apache/plc4x/test/parserserializer/ParserSerializerTestsuiteRunner.java
@@ -27,6 +27,7 @@ import org.apache.plc4x.test.XmlTestsuiteLoader;
import org.apache.plc4x.test.dom4j.LocationAwareDocumentFactory;
import org.apache.plc4x.test.dom4j.LocationAwareElement;
import org.apache.plc4x.test.dom4j.LocationAwareSAXReader;
+import org.apache.plc4x.test.hex.HexDiff;
import org.apache.plc4x.test.migration.MessageResolver;
import org.apache.plc4x.test.migration.MessageValidatorAndMigrator;
import org.apache.plc4x.test.parserserializer.exceptions.ParserSerializerTestsuiteException;
@@ -165,7 +166,7 @@ public class ParserSerializerTestsuiteRunner extends XmlTestsuiteLoader {
// In this case no reference xml has been provided
// (This is usually during development)
- if(testcase.getXml().elements().size() == 0) {
+ if (testcase.getXml().elements().size() == 0) {
WriteBufferXmlBased writeBufferXmlBased = new WriteBufferXmlBased();
parsedOutput.serialize(writeBufferXmlBased);
String xmlString = writeBufferXmlBased.getXmlString();
@@ -209,24 +210,10 @@ public class ParserSerializerTestsuiteRunner extends XmlTestsuiteLoader {
////////////////////////////////////////////////////////////////////////////////////////////////////////////
if (!Arrays.equals(testcaseRaw, data)) {
- int numBytes = Math.min(data.length, testcaseRaw.length);
- int brokenAt = -1;
- List<Integer> diffIndexes = new LinkedList<>();
- for (int i = 0; i < numBytes; i++) {
- if (data[i] != testcaseRaw[i]) {
- if (brokenAt < 0) {
- brokenAt = i;
- }
- diffIndexes.add(i);
- }
- }
- String rawHex = org.apache.plc4x.java.spi.utils.hex.Hex.dump(testcaseRaw, 46, diffIndexes.stream().mapToInt(integer -> integer).toArray());
- String dataHex = org.apache.plc4x.java.spi.utils.hex.Hex.dump(data, 46, diffIndexes.stream().mapToInt(integer -> integer).toArray());
- AsciiBox compareBox = AsciiBoxWriter.DEFAULT.boxSideBySide(AsciiBoxWriter.DEFAULT.boxString("expected", rawHex, 0), AsciiBoxWriter.DEFAULT.boxString("actual", dataHex, 0));
- LOGGER.error("Diff\n{}", compareBox);
+ // This goes to std out on purpose to preserve coloring
+ System.out.println(HexDiff.diffHex(testcaseRaw, data));
throw new ParserSerializerTestsuiteException("Differences were found after serializing.\nExpected: " +
- Hex.encodeHexString(testcaseRaw) + "\nBut Got: " + Hex.encodeHexString(data) +
- "\n " + String.join("", Collections.nCopies(brokenAt, "--")) + "^");
+ Hex.encodeHexString(testcaseRaw) + "\nBut Got: " + Hex.encodeHexString(data) + "");
}
} catch (SerializationException | ParseException e) {
throw new ParserSerializerTestsuiteException("Unable to parse message", e);