[bugfix] xs:hexBinary must support both upper and lower-case [a-f] characters (XQTS: prod-OrderByClause)

Author: adamretter

exist-core/src/main/java/org/exist/util/io/HexOutputStream.java

@@ -39,9 +39,20 @@ public class HexOutputStream extends org.apache.commons.codec.binary.Base16Outpu
      * Creates a HexOutputStream such that all data written is Hex-encoded to the original provided OutputStream.
      *
      * @param out the OutputStream to wrap.
-     * @param doEncode true to encode
+     * @param doEncode true to encode.
      */
     public HexOutputStream(final OutputStream out, final boolean doEncode) {
-        super(out, doEncode, true, CodecPolicy.STRICT);
+        this(out, doEncode, true);
+    }
+
+    /**
+     * Creates a HexOutputStream such that all data written is Hex-encoded to the original provided OutputStream.
+     *
+     * @param out the OutputStream to wrap.
+     * @param doEncode true to encode.
+     * @param lowerCase true to use lower case, or false for upper case.
+     */
+    public HexOutputStream(final OutputStream out, final boolean doEncode, final boolean lowerCase) {
+        super(out, doEncode, lowerCase, CodecPolicy.STRICT);
     }
 }

exist-core/src/main/java/org/exist/xquery/value/BinaryValueFromBinaryString.java

@@ -52,7 +52,7 @@ public BinaryValueFromBinaryString(BinaryValueType binaryValueType, String value
         this(null, binaryValueType, value);
     }
 
-    public BinaryValueFromBinaryString(final Expression expression, BinaryValueType binaryValueType, String value) throws XPathException {
+    public BinaryValueFromBinaryString(final Expression expression, final BinaryValueType binaryValueType, final String value) throws XPathException {
         super(expression, null, binaryValueType);
         this.value = binaryValueType.verifyAndFormatString(value);
     }

exist-core/src/main/java/org/exist/xquery/value/HexBinaryValueType.java

@@ -31,14 +31,14 @@
 import java.util.regex.Pattern;
 
 /**
- * @author <a href="mailto:adam@existsolutions.com">Adam Retter</a>
+ * @author <a href="mailto:adam@evolvedbinary.com">Adam Retter</a>
  */
 public class HexBinaryValueType extends BinaryValueType<HexOutputStream> {
 
     private final static Pattern hexPattern = Pattern.compile("[A-Fa-f0-9]*");
 
     public HexBinaryValueType() {
-        super(Type.HEX_BINARY, HexOutputStream::new);
+        super(Type.HEX_BINARY, (outputStream, doEncode) -> new HexOutputStream(outputStream, doEncode, false));
     }
 
     private Matcher getMatcher(final String toMatch) {

exist-core/src/test/java/org/exist/xquery/value/BinaryValueFromBinaryStringTest.java

@@ -27,13 +27,17 @@
 import org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream;
 import org.exist.xquery.XPathException;
 import java.io.IOException;
-import org.junit.Test;
-import static org.junit.Assert.assertArrayEquals;
-import static org.junit.Assert.assertEquals;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+
+import static org.junit.jupiter.api.Assertions.assertArrayEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 /**
  *
- * @author <a href="mailto:adam@existsolutions.com">Adam Retter</a>
+ * @author <a href="mailto:adam@evolvedbinary.com">Adam Retter</a>
  */
 public class BinaryValueFromBinaryStringTest {
 
@@ -43,38 +47,68 @@ public void getInputStream() throws XPathException, IOException {
         final String testData = "test data";
         final String base64TestData = Base64.encodeBase64String(testData.getBytes()).trim();
 
-        BinaryValue binaryValue = new BinaryValueFromBinaryString(new Base64BinaryValueType(), base64TestData);
-
 
-        try (final InputStream is = binaryValue.getInputStream();
+        try (final BinaryValue binaryValue = new BinaryValueFromBinaryString(new Base64BinaryValueType(), base64TestData);
+             final InputStream is = binaryValue.getInputStream();
              final UnsynchronizedByteArrayOutputStream baos = new UnsynchronizedByteArrayOutputStream()) {
             baos.write(is);
             assertArrayEquals(testData.getBytes(), baos.toByteArray());
         }
     }
 
     @Test
-    public void cast_base64_to_hexBinary() throws XPathException {
+    public void cast_base64_to_hexBinary() throws XPathException, IOException {
 
         final String testData = "testdata";
         final String expectedResult = Hex.encodeHexString(testData.getBytes()).trim();
 
-        BinaryValue binaryValue = new BinaryValueFromBinaryString(new Base64BinaryValueType(), Base64.encodeBase64String(testData.getBytes()));
+        try (final BinaryValue binaryValue = new BinaryValueFromBinaryString(new Base64BinaryValueType(), Base64.encodeBase64String(testData.getBytes()))) {
 
-        final AtomicValue result = binaryValue.convertTo(new HexBinaryValueType());
+            final AtomicValue result = binaryValue.convertTo(new HexBinaryValueType());
 
-        assertEquals(expectedResult, result.getStringValue());
+            assertEquals(expectedResult, result.getStringValue());
+        }
     }
 
     @Test
-    public void cast_hexBinary_to_base64() throws XPathException {
+    public void cast_hexBinary_to_base64() throws XPathException, IOException {
         final String testData = "testdata";
         final String expectedResult = Base64.encodeBase64String(testData.getBytes()).trim();
 
-        BinaryValue binaryValue = new BinaryValueFromBinaryString(new HexBinaryValueType(), Hex.encodeHexString(testData.getBytes()));
+        try (final BinaryValue binaryValue = new BinaryValueFromBinaryString(new HexBinaryValueType(), Hex.encodeHexString(testData.getBytes()))) {
+
+            final AtomicValue result = binaryValue.convertTo(new Base64BinaryValueType());
 
-        final AtomicValue result = binaryValue.convertTo(new Base64BinaryValueType());
+            assertEquals(expectedResult, result.getStringValue());
+        }
+    }
+
+    @Test
+    public void base64StreamBinaryTo() throws XPathException, IOException {
+        try (final BinaryValue binaryValue = new BinaryValueFromBinaryString(new Base64BinaryValueType(), "yv4=");
+            final UnsynchronizedByteArrayOutputStream baos = new UnsynchronizedByteArrayOutputStream()) {
 
-        assertEquals(expectedResult, result.getStringValue());
+            binaryValue.streamBinaryTo(baos);
+
+            final byte[] data = baos.toByteArray();
+            assertEquals(2, data.length);
+            assertEquals(0xCA, data[0] & 0xFF);
+            assertEquals(0xFE, data[1] & 0xFF);
+        }
+    }
+
+    @ParameterizedTest
+    @ValueSource(strings = {"CAFE", "cafe"})
+    public void hexStreamBinaryTo(final String hexString) throws XPathException, IOException {
+        try (final BinaryValue binaryValue = new BinaryValueFromBinaryString(new HexBinaryValueType(), hexString);
+             final UnsynchronizedByteArrayOutputStream baos = new UnsynchronizedByteArrayOutputStream()) {
+
+            binaryValue.streamBinaryTo(baos);
+
+            final byte[] data = baos.toByteArray();
+            assertEquals(2, data.length);
+            assertEquals(0xCA, data[0] & 0xFF);
+            assertEquals(0xFE, data[1] & 0xFF);
+        }
     }
-}
+}