gemfire-core/src/test/java/com/gemstone/gemfire/cache/query/internal/QueryObjectSerializationJUnitTest.java

/*=========================================================================
 * Copyright (c) 2010-2014 Pivotal Software, Inc. All Rights Reserved.
 * This product is protected by U.S. and international copyright
 * and intellectual property laws. Pivotal products are covered by
 * one or more patents listed at http://www.pivotal.io/patents.
 *=========================================================================
 */
package com.gemstone.gemfire.cache.query.internal;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.DataInput;
import java.io.DataInputStream;
import java.io.DataOutput;
import java.io.DataOutputStream;
import java.io.IOException;
import java.io.Serializable;
import java.util.Collection;

import junit.framework.TestCase;

import org.junit.experimental.categories.Category;

import com.gemstone.gemfire.DataSerializer;
import com.gemstone.gemfire.cache.query.QueryService;
import com.gemstone.gemfire.cache.query.types.ObjectType;
import com.gemstone.gemfire.internal.cache.CachePerfStats;
import com.gemstone.gemfire.test.junit.categories.UnitTest;

/**
 * Tests the Serialization of the Query related class.
 *
 * @author kbanks
 * @since 3.0
 */
@Category(UnitTest.class)
public class QueryObjectSerializationJUnitTest extends TestCase implements Serializable {
  
  /** A <code>ByteArrayOutputStream</code> that data is serialized to */
  private transient ByteArrayOutputStream baos;

  public QueryObjectSerializationJUnitTest(String name) {
    super(name);
  }

  ////////  Helper Class
  public static class SimpleObjectType implements ObjectType {
   public SimpleObjectType() {}
   public boolean isCollectionType() { return false; }
   public boolean isMapType() { return false; }
   public boolean isStructType() { return false; }
   public String getSimpleClassName() { return "java.lang.Object"; }
   public Class resolveClass() { return Object.class; }
   public void toData(DataOutput out) {}
   public void fromData(DataInput in) {}
   public boolean equals(Object o) { return o instanceof SimpleObjectType; }
  }

  /**
   * Creates a new <code>ByteArrayOutputStream</code> for this test to
   * work with.
   */
  public void setUp() {
    this.baos = new ByteArrayOutputStream();
  }

  public void tearDown() {
    this.baos = null;
  }

  /**
   * Returns a <code>DataOutput</code> to write to
   */
  protected DataOutputStream getDataOutput() {
    return new DataOutputStream(this.baos);
  }

  /**
   * Returns a <code>DataInput</code> to read from
   */
  protected DataInputStream getDataInput() {
    ByteArrayInputStream bais = new ByteArrayInputStream(this.baos.toByteArray());
    return new DataInputStream(bais);
  }

  /**
   * Data serializes and then data de-serializes the given object and
   * asserts that the two objects satisfy o1.equals(o2)
   */
  private void checkRoundTrip(Object o1) throws IOException, ClassNotFoundException {

    DataOutputStream out = getDataOutput();
    DataSerializer.writeObject(o1, out);
    out.flush();
    DataInput in = getDataInput();
    assertEquals(o1, DataSerializer.<Object>readObject(in));
    this.baos = new ByteArrayOutputStream();
  }

  /**
   * Tests the serialization of many, but not all of the possible ResultSets
   */
  public void testSerializationOfQueryResults() throws IOException, ClassNotFoundException {
    Collection data = new java.util.ArrayList();
    data.add(null);
    data.add(null);
    data.add("some string");
    data.add(Long.MAX_VALUE);
    data.add(45);
    data.add(QueryService.UNDEFINED);

    ObjectType elementType = new SimpleObjectType();
    // Undefined
    checkRoundTrip(QueryService.UNDEFINED); 
    //ResultsBag
    ResultsBag rbWithoutData = new ResultsBag(); 
    rbWithoutData.setElementType(elementType); //avoid NPE in equals
    checkRoundTrip(rbWithoutData); 
    ResultsBag rbWithData = new ResultsBag(data, (CachePerfStats)null); 
    rbWithData.setElementType(elementType); //avoid NPE in equals
    checkRoundTrip(rbWithData); 
    /*
    Set rbWithoutDataAsSet = new ResultsBag().asSet(); 
    ResultsCollectionWrapper rcw = new ResultsCollectionWrapper(elementType, rbWithoutDataAsSet, -1);
    checkRoundTrip(rcw); 
    Set rbWithDataAsSet = new ResultsBag(data, (CachePerfStats)null).asSet(); 
    ResultsCollectionWrapper rcwWithData = new ResultsCollectionWrapper(elementType, rbWithDataAsSet, -1);
    checkRoundTrip(rcwWithData); 
    */
    //SortedResultSet
    SortedResultSet srsWithoutData = new SortedResultSet();
    srsWithoutData.setElementType(elementType); //avoid NPE in equals
    checkRoundTrip(srsWithoutData); 
    SortedResultSet srsWithData = new SortedResultSet();
    srsWithData.setElementType(elementType); //avoid NPE in equals
    checkRoundTrip(srsWithData); 

    //SortedStructSet
    //SortedStructSet sssWithoutData = new SortedStructSet();
    //checkRoundTrip(sssWithoutData); 
  }
}