Merge pull request #9 from RUB-NDS/mvToHex

Implemented a toString method for ModifiableByteArray and made a new …

Author: ic0ns

src/main/java/de/rub/nds/modifiablevariable/bytearray/ModifiableByteArray.java

@@ -10,6 +10,7 @@
 
 import de.rub.nds.modifiablevariable.ModifiableVariable;
 import de.rub.nds.modifiablevariable.VariableModification;
+import de.rub.nds.modifiablevariable.util.ArrayConverter;
 import de.rub.nds.modifiablevariable.util.ByteArrayAdapter;
 import java.io.Serializable;
 import java.util.Arrays;
@@ -19,8 +20,9 @@
 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
 
 /**
- * 
+ *
  * @author Juraj Somorovsky - juraj.somorovsky@rub.de
+ * @author Matthias Terlinde - <matthias.terlinde@rub.de>
  */
 @XmlRootElement
 @XmlSeeAlso({ ByteArrayDeleteModification.class, ByteArrayExplicitValueModification.class,
@@ -71,4 +73,21 @@ public boolean validateAssertions() {
         }
         return valid;
     }
-}
+
+    @Override
+    public String toString() {
+        StringBuilder result = new StringBuilder();
+        if (this.isOriginalValueModified()) {
+            result.append("Actual byte value is: ");
+            result.append(ArrayConverter.bytesToHexString(this));
+            result.append("\nOriginal value was: ");
+            result.append(ArrayConverter.bytesToHexString(this.getOriginalValue()));
+        } else {
+            result.append("Original byte value is: ");
+            result.append(ArrayConverter.bytesToHexString(this.getOriginalValue()));
+        }
+        return result.toString();
+
+    }
+
+}

src/main/java/de/rub/nds/modifiablevariable/util/ArrayConverter.java

@@ -8,12 +8,14 @@
  */
 package de.rub.nds.modifiablevariable.util;
 
+import de.rub.nds.modifiablevariable.bytearray.ModifiableByteArray;
 import java.lang.reflect.Array;
 import java.math.BigInteger;
 import java.util.List;
 
 /**
  * @author Juraj Somorovsky <juraj.somorovsky@rub.de>
+ * @author Matthias Terlinde <matthias.terlinde@rub.de>
  */
 public class ArrayConverter {
 
@@ -179,6 +181,19 @@ public static String bytesToRawHexString(byte[] array) {
         return result.toString();
     }
 
+    public static String bytesToHexString(ModifiableByteArray array) {
+        return bytesToHexString(array.getValue());
+    }
+
+    public static String bytesToHexString(ModifiableByteArray array, boolean usePrettyPrinting) {
+
+        return bytesToHexString(array.getValue(), usePrettyPrinting, true);
+    }
+
+    public static String bytesToHexString(ModifiableByteArray array, boolean usePrettyPrinting, boolean initialNewLine) {
+        return bytesToHexString(array.getValue(), usePrettyPrinting, initialNewLine);
+    }
+
     @SafeVarargs
     public static <T> T[] concatenate(final T[]... arrays) {
         if (arrays == null || arrays.length == 0) {

src/main/java/de/rub/nds/modifiablevariable/util/BadFixedRandom.java

@@ -11,8 +11,8 @@
 import java.util.Random;
 
 /**
- * A fake random number generator for testing. 
- * This generator will always return the byte "retVal" passed to the constructor. 
+ * A fake random number generator for testing. This generator will always return
+ * the byte "retVal" passed to the constructor.
  * 
  */
 public class BadFixedRandom extends Random {
@@ -24,9 +24,10 @@ public BadFixedRandom(byte retVal) {
     }
 
     /**
-     * Fills a user-supplied byte array with the fixed byte given at object initialization.
-     * The number of "random" bytes produced is equal to the length of the byte array.
-     */    
+     * Fills a user-supplied byte array with the fixed byte given at object
+     * initialization. The number of "random" bytes produced is equal to the
+     * length of the byte array.
+     */
     @Override
     public void nextBytes(byte[] bytes) {
         for (int i = 0, len = bytes.length; i < len;)

src/test/java/de/rub/nds/modifiablevariable/bytearray/ModifiableByteArrayTest.java

@@ -8,13 +8,13 @@
  */
 package de.rub.nds.modifiablevariable.bytearray;
 
-import de.rub.nds.modifiablevariable.bytearray.ModifiableByteArray;
-import de.rub.nds.modifiablevariable.bytearray.ByteArrayModificationFactory;
+import de.rub.nds.modifiablevariable.ModifiableVariableFactory;
 import de.rub.nds.modifiablevariable.VariableModification;
 import de.rub.nds.modifiablevariable.util.ArrayConverter;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import static org.junit.Assert.assertArrayEquals;
+import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertTrue;
@@ -26,6 +26,7 @@
  * @author Juraj Somorovsky <juraj.somorovsky@rub.de>
  */
 public class ModifiableByteArrayTest {
+
     private static final Logger LOGGER = LogManager.getLogger(ModifiableByteArray.class);
 
     private ModifiableByteArray start;
@@ -430,4 +431,17 @@ public void testShuffle() {
         result = new byte[] { 6, 0, 3, 2, 5, 4, 1 };
         assertArrayEquals(result, start.getValue());
     }
+
+    @Test
+    public void toStringTest() {
+        ModifiableByteArray toTest = new ModifiableByteArray();
+        toTest = ModifiableVariableFactory.safelySetValue(toTest, new byte[] { 0x00, 0x11, 0x22, 0x33, 0x44 });
+        assertEquals("Original byte value is: 00 11 22 33 44", toTest.toString());
+
+        VariableModification modificatoin = new ByteArrayExplicitValueModification(new byte[] { 0x00, 0x01, 0x02, 0x03,
+                0x04, 0x05, 0x06, 0x07, 0x08 });
+        toTest.setModification(modificatoin);
+        assertEquals("Actual byte value is: 00 01 02 03 04 05 06 07 08\nOriginal value was: 00 11 22 33 44",
+                toTest.toString());
+    }
 }

src/test/java/de/rub/nds/modifiablevariable/util/ArrayConverterTest.java

@@ -8,14 +8,16 @@
  */
 package de.rub.nds.modifiablevariable.util;
 
+import de.rub.nds.modifiablevariable.ModifiableVariableFactory;
+import de.rub.nds.modifiablevariable.bytearray.ModifiableByteArray;
 import java.math.BigInteger;
 import static org.junit.Assert.assertArrayEquals;
 import static org.junit.Assert.assertEquals;
 import org.junit.Test;
 
 /**
  * @author Juraj Somorovsky - juraj.somorovsky@rub.de
- * @author Florian Pfützenreuter <Florian.Pfuetzenreuter@rub.de>
+ * @author Florian Pfuetzenreuter <Florian.Pfuetzenreuter@rub.de>
  * @author Matthias Terlinde <matthias.terlinde@rub.de>
  */
 public class ArrayConverterTest {
@@ -208,4 +210,36 @@ public void testLongToUint48Bytes() {
 
         assertArrayEquals("Assert correct output", expectedResult, ArrayConverter.longToUint48Bytes(testValue));
     }
+
+    /**
+     * Test of bytesToHexString method, of class ArrayConverter. Differences in
+     * the overloaded methods should be visible in the other tests since the
+     * methods just pass the .getValue().
+     */
+    @Test
+    public void testBytesToHexString_ModifiableByteArray() {
+        ModifiableByteArray toTest = new ModifiableByteArray();
+        toTest = ModifiableVariableFactory.safelySetValue(toTest, new byte[] { 0x00, 0x11, 0x22, 0x33, 0x44 });
+        assertEquals("00 11 22 33 44", ArrayConverter.bytesToHexString(toTest));
+
+        toTest = ModifiableVariableFactory.safelySetValue(toTest, new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05,
+                0x06, 0x07, 0x08 });
+        assertEquals("00 01 02 03 04 05 06 07 08", ArrayConverter.bytesToHexString(toTest));
+
+        toTest = ModifiableVariableFactory.safelySetValue(toTest, new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05,
+                0x06, 0x07, 0x08, 0x09, 0x10 });
+        assertEquals("00 01 02 03 04 05 06 07 08 09 10", ArrayConverter.bytesToHexString(toTest));
+
+        toTest = ModifiableVariableFactory.safelySetValue(toTest, new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05,
+                0x06, 0x07, 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, });
+        assertEquals("\n00 01 02 03 04 05 06 07  00 01 02 03 04 05 06 07", ArrayConverter.bytesToHexString(toTest));
+
+        toTest = ModifiableVariableFactory.safelySetValue(toTest, new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05,
+                0x06, 0x07, 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06,
+                0x07, 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, });
+        assertEquals(
+                "\n00 01 02 03 04 05 06 07  00 01 02 03 04 05 06 07\n00 01 02 03 04 05 06 07  00 01 02 03 04 05 06 07",
+                ArrayConverter.bytesToHexString(toTest));
+    }
+
 }