Merge pull request #35 from RUB-NDS/xmlPrettyPrintingFix

Xml pretty printing fix

Author: ic0ns

.travis.yml

@@ -1,5 +1,5 @@
 language: java
-
+dist: trusty
 sudo: false
 
 jdk:

pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>de.rub.nds</groupId>
     <artifactId>ModifiableVariable</artifactId>
-    <version>2.5</version>
+    <version>2.6</version>
     <packaging>jar</packaging>
 
     <name>ModifiableVariable</name>

src/main/java/de/rub/nds/modifiablevariable/ModifiableVariable.java

@@ -10,22 +10,25 @@
 
 import java.io.Serializable;
 import javax.xml.bind.annotation.XmlAnyElement;
+import javax.xml.bind.annotation.XmlAttribute;
 import javax.xml.bind.annotation.XmlRootElement;
 import javax.xml.bind.annotation.XmlTransient;
 
 /**
  * The base abstract class for modifiable variables, including the getValue
  * function.
- * 
+ *
  * The class needs to be defined transient to allow propOrder definition in
  * subclasses, see:
  * http://blog.bdoughan.com/2011/06/ignoring-inheritance-with-xmltransient.html
- * 
+ *
  */
 @XmlRootElement
 @XmlTransient
 public abstract class ModifiableVariable<E> implements Serializable {
 
+    protected Boolean autoformat = null;
+
     private VariableModification<E> modification = null;
 
     private boolean createRandomModification;
@@ -36,6 +39,15 @@ public ModifiableVariable() {
 
     }
 
+    @XmlAttribute(required = false)
+    public Boolean getAutoformat() {
+        return autoformat;
+    }
+
+    public void setAutoformat(Boolean autoformat) {
+        this.autoformat = autoformat;
+    }
+
     public void setModification(VariableModification<E> modification) {
         this.modification = modification;
     }

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

@@ -26,6 +26,10 @@
 @XmlType(propOrder = { "originalValue", "modification", "assertEquals" })
 public class ModifiableByteArray extends ModifiableVariable<byte[]> implements Serializable {
 
+    public ModifiableByteArray() {
+        autoformat = true;
+    }
+
     private byte[] originalValue;
 
     @Override
@@ -88,10 +92,12 @@ public String toString() {
 
     @Override
     public boolean equals(Object o) {
-        if (this == o)
+        if (this == o) {
             return true;
-        if (!(o instanceof ModifiableByteArray))
+        }
+        if (!(o instanceof ModifiableByteArray)) {
             return false;
+        }
 
         ModifiableByteArray that = (ModifiableByteArray) o;
 

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

@@ -0,0 +1,29 @@
+/**
+ * ModifiableVariable - A Variable Concept for Runtime Modifications
+ *
+ * Copyright 2014-2017 Ruhr University Bochum / Hackmanit GmbH
+ *
+ * Licensed under Apache License 2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
+ */
+package de.rub.nds.modifiablevariable.util;
+
+import javax.xml.bind.annotation.adapters.XmlAdapter;
+
+/**
+ *
+ */
+public class UnformattedByteArrayAdapter extends XmlAdapter<String, byte[]> {
+
+    @Override
+    public byte[] unmarshal(String value) {
+
+        value = value.replaceAll("\\s", "");
+        return ArrayConverter.hexStringToByteArray(value);
+    }
+
+    @Override
+    public String marshal(byte[] value) {
+        return ArrayConverter.bytesToHexString(value, false, false);
+    }
+}

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

@@ -27,6 +27,9 @@
 import javax.xml.xpath.XPathFactory;
 import javax.xml.xpath.XPathFactoryConfigurationException;
 import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.NamedNodeMap;
+import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;
@@ -40,6 +43,20 @@ public class XMLPrettyPrinter {
 
     public static int IDENT_AMOUNT = 4;
 
+    /**
+     * This function formats all tags (and their children) which are marked with
+     * the autoformat="true" attribute and removes this attribute.
+     *
+     * @param input
+     * @return
+     * @throws TransformerConfigurationException
+     * @throws ParserConfigurationException
+     * @throws SAXException
+     * @throws IOException
+     * @throws TransformerException
+     * @throws XPathExpressionException
+     * @throws XPathFactoryConfigurationException
+     */
     public static String prettyPrintXML(String input) throws TransformerConfigurationException,
             ParserConfigurationException, SAXException, IOException, TransformerException, XPathExpressionException,
             XPathFactoryConfigurationException {
@@ -50,24 +67,25 @@ public static String prettyPrintXML(String input) throws TransformerConfiguratio
         StreamResult result = new StreamResult(new StringWriter());
         Document doc = DocumentBuilderFactory.newInstance().newDocumentBuilder()
                 .parse(new InputSource(new StringReader(input)));
-        XPathExpression xpath = XPathFactory.newInstance().newXPath().compile("//*[count(./*) = 0]");
         XPathExpression xpathDepth = XPathFactory.newInstance().newXPath().compile("count(ancestor-or-self::*)");
-
-        NodeList textNodes = (NodeList) xpath.evaluate(doc, XPathConstants.NODESET);
-
+        XPathExpression toBeFormatted = XPathFactory.newInstance().newXPath().compile("//*[@autoformat = \'true\']/*");
+        NodeList textNodes = (NodeList) toBeFormatted.evaluate(doc, XPathConstants.NODESET);
         for (int i = 0; i < textNodes.getLength(); i++) {
-            String content = textNodes.item(i).getTextContent();
+            Node node = textNodes.item(i);
+            String content = node.getTextContent();
             double doubleDepth = (Double) xpathDepth.evaluate(textNodes.item(i), XPathConstants.NUMBER);
             int depth = (int) doubleDepth;
             String emptyString = createEmptyString(depth);
             String newContent = content.replaceAll("\n", ("\n" + emptyString));
-            if (newContent.length() > content.length()) {
+            if (newContent.length() > content.length()
+                    && newContent.substring(newContent.length() - IDENT_AMOUNT, newContent.length()).trim().equals("")) {
                 newContent = newContent.substring(0, newContent.length() - IDENT_AMOUNT);
             }
-            textNodes.item(i).setTextContent(newContent);
+            node.setTextContent(newContent);
+            Element element = (Element) node.getParentNode();
+            element.removeAttribute("autoformat");
 
         }
-
         DOMSource source = new DOMSource(doc);
         transformer.transform(source, result);
         return result.getWriter().toString();

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

@@ -11,8 +11,11 @@
 import de.rub.nds.modifiablevariable.ModifiableVariableFactory;
 import de.rub.nds.modifiablevariable.bytearray.ModifiableByteArray;
 import java.math.BigInteger;
+import java.util.Random;
+import org.hamcrest.core.IsEqual;
 import static org.junit.Assert.assertArrayEquals;
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertThat;
 import org.junit.Test;
 
 public class ArrayConverterTest {
@@ -247,4 +250,26 @@ public void testReverseByteOrder() {
         assertArrayEquals("Testing byte order reversion", new byte[] { 0x04, 0x03, 0x02, 0x01, 0x00 },
                 ArrayConverter.reverseByteOrder(array));
     }
+
+    @Test
+    public void testBigIntegerReconversion() {
+        Random r = new Random(0);
+        for (int i = 0; i < 10000; i++) {
+            BigInteger b = new BigInteger(1024 + r.nextInt(1000), r);
+            byte[] bigIntegerToByteArray = ArrayConverter.bigIntegerToByteArray(b);
+            BigInteger c = new BigInteger(1, bigIntegerToByteArray);
+            assertEquals(b, c);
+        }
+    }
+
+    @Test
+    public void testIntegerReconversion() {
+        Random r = new Random(0);
+        for (int i = 0; i < 10000; i++) {
+            Integer b = r.nextInt();
+            byte[] intBytes = ArrayConverter.intToBytes(b, 4);
+            Integer c = ArrayConverter.bytesToInt(intBytes);
+            assertEquals(b, c);
+        }
+    }
 }

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

@@ -21,14 +21,13 @@ public class XMLPrettyPrinterTest {
      */
     @Test
     public void testPrettyPrintXML() throws Exception {
-        String input = "<modifiableByteArray>\n" + "    <originalValue>\n"
+        String input = "<modifiableByteArray autoformat=\"true\">\n" + "    <originalValue>\n"
                 + "FF 01 02 03 FF 01 02 03  FF 01 02 03 FF 01 02 03\n" + "FF 01 02 03\n" + "</originalValue>\n"
                 + "</modifiableByteArray>";
         String expected = "<modifiableByteArray>\n" + "    <originalValue>\n"
                 + "        FF 01 02 03 FF 01 02 03  FF 01 02 03 FF 01 02 03\n" + "        FF 01 02 03\n"
                 + "    </originalValue>\n" + "</modifiableByteArray>";
         String result = XMLPrettyPrinter.prettyPrintXML(input);
-
         assertEquals(expected.trim(), result.trim());
     }
 }