TestOverrunStreamingJsonParser.java

/*
 * Copyright 2017 StreamSets Inc.
 *
 * Licensed under 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 com.streamsets.pipeline.lib.parser.json;

import com.google.common.base.Strings;
import com.google.common.collect.ImmutableList;
import com.streamsets.pipeline.api.OnRecordError;
import com.streamsets.pipeline.api.Stage;
import com.streamsets.pipeline.api.ext.io.CountingReader;
import com.streamsets.pipeline.api.ext.io.ObjectLengthException;
import com.streamsets.pipeline.api.ext.io.OverrunException;
import com.streamsets.pipeline.api.ext.io.OverrunReader;
import com.streamsets.pipeline.api.ext.json.Mode;
import com.streamsets.pipeline.lib.json.OverrunStreamingJsonParser;
import com.streamsets.pipeline.lib.json.StreamingJsonParser;
import com.streamsets.pipeline.sdk.ContextInfoCreator;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;

import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.StringReader;
import java.util.Collections;
import java.util.List;

public class TestOverrunStreamingJsonParser {

  @Before
  public void setUp() {
    System.getProperties().remove(OverrunReader.READ_LIMIT_SYS_PROP);
  }

  @After
  public void cleanUp() {
    setUp();
  }

  private CountingReader getJsonReader(String name) throws Exception {
    InputStream is = Thread.currentThread().getContextClassLoader().getResourceAsStream(name);
    return (is != null) ? new CountingReader(new InputStreamReader(is)) : null;
  }

  private Stage.Context getContext() {
    return ContextInfoCreator.createSourceContext("i", false, OnRecordError.TO_ERROR,
        Collections.emptyList());
  }

  // Parser level overrun, Array

  @Test
  public void testArrayOfObjects() throws Exception {
    StreamingJsonParser parser = new OverrunStreamingJsonParser(
        getContext(),
        getJsonReader("TestOverrunStreamingJsonParser-arrayOfObjects.json"), Mode.ARRAY_OBJECTS,
        50);
    List a1 = (List) parser.read();
    Assert.assertNotNull(a1);
    try {
      parser.read();
      Assert.fail();
    } catch (ObjectLengthException ex) {
      //NOP
    }
    List a2 = (List) parser.read();
    Assert.assertNotNull(a2);
    Assert.assertNull(parser.read());
    Assert.assertEquals(ImmutableList.of("a", "A"), a1);
    Assert.assertEquals(ImmutableList.of("b", "B"), a2);
  }

  // Parser level overrun, Objects

  @Test
  public void testMultipleObjects() throws Exception {
    StreamingJsonParser parser = new OverrunStreamingJsonParser(
        getContext(),
        getJsonReader("TestOverrunStreamingJsonParser-multipleObjects.json"), Mode.MULTIPLE_OBJECTS,
        50);
    List a1 = (List) parser.read();
    Assert.assertNotNull(a1);
    try {
      parser.read();
      Assert.fail();
    } catch (ObjectLengthException ex) {
      //NOP
    }
    List a2 = (List) parser.read();
    Assert.assertNotNull(a2);
    Assert.assertNull(parser.read());
    Assert.assertEquals(ImmutableList.of("a", "A"), a1);
    Assert.assertEquals(ImmutableList.of("b", "B"), a2);
  }

  // Stream level overrun, Array

  public void testStreamLevelOverrunArray(boolean attemptNextRead) throws Exception {
    System.setProperty(OverrunReader.READ_LIMIT_SYS_PROP, "10000");
    String json = "[[\"a\"],[\"" + Strings.repeat("a", 20000) + "\"],[\"b\"]]";
    StreamingJsonParser parser = new OverrunStreamingJsonParser(getContext(), new CountingReader(new StringReader(json)),
                                                                Mode.ARRAY_OBJECTS, 50);
    List a1 = (List) parser.read();
    Assert.assertNotNull(a1);
    Assert.assertEquals(ImmutableList.of("a"), a1);

    if (!attemptNextRead) {
      parser.read();
    } else {
      try {
        parser.read();
      } catch (OverrunException ex) {
        //NOP
      }
      parser.read();
    }
  }

  @Test(expected = OverrunException.class)
  public void testStreamLevelOverrunArray() throws Exception {
    testStreamLevelOverrunArray(false);
  }

  @Test(expected = IllegalStateException.class)
  public void testStreamLevelOverrunArrayAttemptNextRead() throws Exception {
    testStreamLevelOverrunArray(true);
  }

  // Stream level overrun, Object

  public void testStreamLevelOverrunMultipleObjects(boolean attemptNextRead) throws Exception {
    System.setProperty(OverrunReader.READ_LIMIT_SYS_PROP, "10000");
    String json = "[\"a\"][\"" + Strings.repeat("a", 20000) + "\"][\"b\"]";
    StreamingJsonParser parser = new OverrunStreamingJsonParser(getContext(), new CountingReader(new StringReader(json)),
                                                                Mode.MULTIPLE_OBJECTS, 50);
    List a1 = (List) parser.read();
    Assert.assertNotNull(a1);
    Assert.assertEquals(ImmutableList.of("a"), a1);

    if (!attemptNextRead) {
      parser.read();
    } else {
      try {
        parser.read();
      } catch (OverrunException ex) {
        //NOP
      }
      parser.read();
    }
  }

  @Test(expected = OverrunException.class)
  public void testStreamLevelOverrunMultipleObjects() throws Exception {
    testStreamLevelOverrunMultipleObjects(false);
  }

  @Test(expected = IllegalStateException.class)
  public void testStreamLevelOverrunMultipleObjectsAttemptNextRead() throws Exception {
    testStreamLevelOverrunMultipleObjects(true);
  }


  @Test
  public void testFastForwardBeyondOverrunMultipleObjects() throws Exception {
    System.setProperty(OverrunReader.READ_LIMIT_SYS_PROP, "10000");
    String json = "[\"a\"][\"" + Strings.repeat("a", 10000) + "\"][\"b\"]";
    json += "[\"a\"][\"" + Strings.repeat("a", 20000) + "\"][\"b\"]";
    int initialPos = json.length();
    json += "[\"x\"]";
    StreamingJsonParser parser = new OverrunStreamingJsonParser(getContext(), new CountingReader(new StringReader(json)), initialPos,
                                                                Mode.MULTIPLE_OBJECTS, 50);
    List a1 = (List) parser.read();
    Assert.assertNotNull(a1);
    Assert.assertEquals(ImmutableList.of("x"), a1);
  }

  @Test
  public void testArrayPositionable() throws Exception {
    StreamingJsonParser parser = new OverrunStreamingJsonParser(
        getContext(),
      getJsonReader("TestOverrunStreamingJsonParser-arrayOfObjects.json"), Mode.ARRAY_OBJECTS, 50);
    List l1 = (List) parser.read();
    long firstObjectPos = parser.getReaderPosition();
    Assert.assertNotNull(l1);
    try {
      parser.read();
      Assert.fail();
    } catch (ObjectLengthException ex) {
      //NOP
    }
    List l2 = (List) parser.read();
    long secondObjectPos = parser.getReaderPosition();
    Assert.assertNotNull(l1);
    Assert.assertNotNull(l2);
    long lastObjectPos = parser.getReaderPosition();
    Assert.assertNotNull(l1);
    Assert.assertNull(parser.read());
    long endPos = parser.getReaderPosition();
    Assert.assertNotNull(l1);

    parser = new OverrunStreamingJsonParser(getContext(), getJsonReader("TestOverrunStreamingJsonParser-arrayOfObjects.json"),
                                            firstObjectPos, Mode.ARRAY_OBJECTS, 50);
    Assert.assertEquals(firstObjectPos, parser.getReaderPosition());
    try {
      parser.read();
      Assert.fail();
    } catch (ObjectLengthException ex) {
      //NOP
    }
    List l2a = (List) parser.read();
    Assert.assertEquals(l2, l2a);
    Assert.assertEquals(lastObjectPos, parser.getReaderPosition());
    Assert.assertNull(parser.read());
    Assert.assertEquals(endPos, parser.getReaderPosition());

    parser = new OverrunStreamingJsonParser(getContext(), getJsonReader("TestOverrunStreamingJsonParser-arrayOfObjects.json"),
                                            secondObjectPos, Mode.ARRAY_OBJECTS, 50);
    Assert.assertEquals(secondObjectPos, parser.getReaderPosition());
    Assert.assertEquals(l2, l2a);
    Assert.assertEquals(lastObjectPos, parser.getReaderPosition());
    Assert.assertNull(parser.read());
    Assert.assertEquals(endPos, parser.getReaderPosition());

    parser = new OverrunStreamingJsonParser(getContext(), getJsonReader("TestOverrunStreamingJsonParser-arrayOfObjects.json"),
                                            lastObjectPos, Mode.ARRAY_OBJECTS, 50);
    Assert.assertEquals(lastObjectPos, parser.getReaderPosition());
    Assert.assertNull(parser.read());
    Assert.assertEquals(endPos, parser.getReaderPosition());

    parser = new OverrunStreamingJsonParser(getContext(), getJsonReader("TestOverrunStreamingJsonParser-arrayOfObjects.json"),
                                            endPos, Mode.ARRAY_OBJECTS, 50);
    Assert.assertEquals(endPos, parser.getReaderPosition());
    Assert.assertNull(parser.read());
    Assert.assertEquals(endPos, parser.getReaderPosition());
  }

  @Test
  public void testMultipleObjectsPositionable() throws Exception {
    StreamingJsonParser parser = new OverrunStreamingJsonParser(getContext(),
        getJsonReader("TestOverrunStreamingJsonParser-multipleObjects.json"), Mode.MULTIPLE_OBJECTS,
        50);
    List l1 = (List) parser.read();
    long firstObjectPos = parser.getReaderPosition();
    Assert.assertNotNull(l1);
    try {
      parser.read();
      Assert.fail();
    } catch (ObjectLengthException ex) {
      //NOP
    }
    List l2 = (List) parser.read();
    long secondObjectPos = parser.getReaderPosition();    Assert.assertNotNull(l1);
    Assert.assertNotNull(l2);
    long lastObjectPos = parser.getReaderPosition();    Assert.assertNotNull(l1);

    parser = new OverrunStreamingJsonParser(getContext(), getJsonReader("TestOverrunStreamingJsonParser-multipleObjects.json"),
                                            firstObjectPos, Mode.MULTIPLE_OBJECTS, 50);
    Assert.assertEquals(firstObjectPos, parser.getReaderPosition());
    try {
      parser.read();
      Assert.fail();
    } catch (ObjectLengthException ex) {
      //NOP
    }
    List l2a = (List) parser.read();
    Assert.assertEquals(secondObjectPos, parser.getReaderPosition());
    Assert.assertEquals(l2, l2a);
    Assert.assertEquals(lastObjectPos, parser.getReaderPosition());
    Assert.assertNull(parser.read());

    parser = new OverrunStreamingJsonParser(getContext(), getJsonReader("TestOverrunStreamingJsonParser-multipleObjects.json"),
                                            secondObjectPos, Mode.MULTIPLE_OBJECTS, 50);
    Assert.assertEquals(secondObjectPos, parser.getReaderPosition());
    Assert.assertEquals(l2, l2a);
    Assert.assertEquals(lastObjectPos, parser.getReaderPosition());
    Assert.assertNull(parser.read());

    parser = new OverrunStreamingJsonParser(getContext(), getJsonReader("TestOverrunStreamingJsonParser-multipleObjects.json"),
                                            lastObjectPos, Mode.MULTIPLE_OBJECTS, 50);
    Assert.assertEquals(lastObjectPos, parser.getReaderPosition());
    Assert.assertNull(parser.read());
  }

}