Fix #39

Author: cowtowncoder

pom.xml

@@ -3,7 +3,7 @@
   <parent>
     <groupId>com.fasterxml.jackson</groupId>
     <artifactId>jackson-base</artifactId>
-    <version>2.9.2</version>
+    <version>2.9.3-SNAPSHOT</version>
   </parent>
   <groupId>com.fasterxml.jackson.dataformat</groupId>
   <artifactId>jackson-dataformats-text</artifactId>

release-notes/VERSION

@@ -14,6 +14,8 @@ Modules:
  (contributed by frankgrimes97@github)
 #51 (csv): Set of custom objects with `IGNORE_UNKNOWN` brokes silently csv
  (reported by Simone L)
+#39 (yamk): Binary data not recognized by YAML parser
+ (repoted by tmoschou@github)
 
 2.9.2 (14-Oct-2017)
 

yaml/src/main/java/com/fasterxml/jackson/dataformat/yaml/YAMLParser.java

@@ -7,18 +7,17 @@
 
 import org.yaml.snakeyaml.error.Mark;
 import org.yaml.snakeyaml.events.*;
+import org.yaml.snakeyaml.external.biz.base64Coder.Base64Coder;
 import org.yaml.snakeyaml.nodes.NodeId;
 import org.yaml.snakeyaml.nodes.Tag;
 import org.yaml.snakeyaml.parser.ParserImpl;
 import org.yaml.snakeyaml.reader.StreamReader;
+import org.yaml.snakeyaml.resolver.Resolver;
 
 import com.fasterxml.jackson.core.*;
 import com.fasterxml.jackson.core.base.ParserBase;
 import com.fasterxml.jackson.core.io.IOContext;
 import com.fasterxml.jackson.core.util.BufferRecycler;
-import com.fasterxml.jackson.core.util.ByteArrayBuilder;
-
-import org.yaml.snakeyaml.resolver.Resolver;
 
 /**
  * {@link JsonParser} implementation used to expose YAML documents
@@ -441,7 +440,7 @@ public JsonToken nextToken() throws IOException
         }
     }
 
-    protected JsonToken _decodeScalar(ScalarEvent scalar)
+    protected JsonToken _decodeScalar(ScalarEvent scalar) throws IOException
     {
         String value = scalar.getValue();
         _textValue = value;
@@ -451,7 +450,6 @@ protected JsonToken _decodeScalar(ScalarEvent scalar)
 
         if (typeTag == null || typeTag.equals("!")) { // no, implicit
             Tag nodeTag = _yamlResolver.resolve(NodeId.scalar, value, scalar.getImplicit().canOmitTagInPlainScalar());
-
             if (nodeTag == Tag.STR) {
                 return JsonToken.VALUE_STRING;
             }
@@ -480,6 +478,14 @@ protected JsonToken _decodeScalar(ScalarEvent scalar)
                     typeTag = typeTag.split(",")[0];
                 }
             }
+            // [dataformats-text#39]: support binary type
+            if ("binary".equals(typeTag)) {
+                // 29-Nov-2017, tatu: two choices for base64 codecs (or 3 with Java 8):
+                //   Jackson's own or SnakeYAML. Former is faster, but maybe makes sense
+                //   to use latter for sake of consistency.
+                _binaryValue = Base64Coder.decodeLines(value);
+                return JsonToken.VALUE_EMBEDDED_OBJECT;
+            }
             // canonical values by YAML are actually 'y' and 'n'; but plenty more unofficial:
             if ("bool".equals(typeTag)) { // must be "true" or "false"
                 Boolean B = _matchYAMLBoolean(value, len);
@@ -645,23 +651,21 @@ public int getText(Writer writer) throws IOException
 
     @Override
     public Object getEmbeddedObject() throws IOException {
+        if (_currToken == JsonToken.VALUE_EMBEDDED_OBJECT ) {
+            return _binaryValue;
+        }
         return null;
     }
 
-    // TODO: can remove from 2.9 or so (base impl added in 2.8)
-    @SuppressWarnings("resource")
+    // Base impl from `ParserBase` works fine here:
+//    public byte[] getBinaryValue(Base64Variant variant) throws IOException
+
     @Override
-    public byte[] getBinaryValue(Base64Variant variant) throws IOException
+    public int readBinaryValue(Base64Variant b64variant, OutputStream out) throws IOException
     {
-        if (_binaryValue == null) {
-            if (_currToken != JsonToken.VALUE_STRING) {
-                _reportError("Current token ("+_currToken+") not VALUE_STRING, can not access as binary");
-            }
-            ByteArrayBuilder builder = _getByteArrayBuilder();
-            _decodeBase64(getText(), builder, variant);
-            _binaryValue = builder.toByteArray();
-        }
-        return _binaryValue;
+        byte[] b = getBinaryValue(b64variant);
+        out.write(b);
+        return b.length;
     }
 
     /*

yaml/src/test/java/com/fasterxml/jackson/dataformat/yaml/DatabindAdvancedTest.java

@@ -137,7 +137,7 @@ public Image(String uri, String title, int w, int h, Size s)
 
     public void testBasic() throws Exception
     {
-        ObjectMapper mapper = mapperForYAML();
+        ObjectMapper mapper = newObjectMapper();
         String YAML =
 "---\n"
 +"content:\n"

yaml/src/test/java/com/fasterxml/jackson/dataformat/yaml/ExceptionConversionTest.java

@@ -10,7 +10,7 @@ public class ExceptionConversionTest extends ModuleTestBase
 {
     public void testSimpleParsingLeakage() throws Exception
     {
-        YAMLMapper mapper = mapperForYAML();
+        YAMLMapper mapper = newObjectMapper();
         try {
              mapper.readTree("foo:\nbar: true\n  baz: false");
              fail("Should not pass with invalid YAML");

yaml/src/test/java/com/fasterxml/jackson/dataformat/yaml/GeneratorFeatureTest.java

@@ -21,7 +21,7 @@ public Words(String... w) {
     /**********************************************************
      */
 
-    private final ObjectMapper MAPPER = mapperForYAML();
+    private final ObjectMapper MAPPER = newObjectMapper();
 
     public void testArrayIndentation() throws Exception
     {
@@ -39,7 +39,7 @@ public void testArrayIndentation() throws Exception
         // 14-Mar-2017, tatu: Note that we can not, alas, dynamically change
         //    features via ObjectWriter yet as they are bound at YAMLGenerator
         //    construction time.
-        final YAMLMapper indentingMapper = mapperForYAML();
+        final YAMLMapper indentingMapper = newObjectMapper();
         indentingMapper.getFactory().enable(YAMLGenerator.Feature.INDENT_ARRAYS);
 
         yaml = indentingMapper.writeValueAsString(input);

yaml/src/test/java/com/fasterxml/jackson/dataformat/yaml/ModuleTestBase.java

@@ -67,8 +67,8 @@ protected ModuleTestBase() { }
     /* Helper methods, setup
     /**********************************************************************
      */
-    
-    protected YAMLMapper mapperForYAML()
+
+    protected YAMLMapper newObjectMapper()
     {
         return new YAMLMapper();
     }

yaml/src/test/java/com/fasterxml/jackson/dataformat/yaml/ObjectIdTest.java

@@ -109,7 +109,7 @@ public ObjectIdGenerator.IdKey key(Object key) {
             +"  next: 1"
             ;
 
-    private final ObjectMapper MAPPER = mapperForYAML();
+    private final ObjectMapper MAPPER = newObjectMapper();
 
     public void testNativeSerialization() throws Exception
     {

yaml/src/test/java/com/fasterxml/jackson/dataformat/yaml/SimpleDatabindTest.java

@@ -33,7 +33,7 @@ static class Name {
     /**********************************************************
      */
 
-    private final ObjectMapper MAPPER = mapperForYAML();
+    private final ObjectMapper MAPPER = newObjectMapper();
 
     public void testSimpleNested() throws Exception
     {

yaml/src/test/java/com/fasterxml/jackson/dataformat/yaml/SimpleGenerationTest.java

@@ -75,7 +75,7 @@ public void testStreamingNested() throws Exception
 
     public void testBasicPOJO() throws Exception
     {
-        ObjectMapper mapper = mapperForYAML();
+        ObjectMapper mapper = newObjectMapper();
         FiveMinuteUser user = new FiveMinuteUser("Bob", "Dabolito", false,
                 FiveMinuteUser.Gender.MALE, new byte[] { 1, 3, 13, 79 });
         String yaml = mapper.writeValueAsString(user).trim();
@@ -105,7 +105,7 @@ public void testWithFile() throws Exception
     {
         File f = File.createTempFile("test", ".yml");
         f.deleteOnExit();
-        ObjectMapper mapper = mapperForYAML();
+        ObjectMapper mapper = newObjectMapper();
         Map<String,Integer> map = new HashMap<String,Integer>();
         map.put("a", 3);
         mapper.writeValue(f, map);
@@ -127,7 +127,7 @@ public void testWithFile2() throws Exception
     {
         File f = File.createTempFile("test", ".yml");
         f.deleteOnExit();
-        ObjectMapper mapper = mapperForYAML();
+        ObjectMapper mapper = newObjectMapper();
         ObjectNode root = mapper.createObjectNode();
         root.put("name", "Foobar");
         mapper.writeValue(f, root);