gemfire-core/src/test/java/com/gemstone/gemfire/cache/query/internal/index/RangeIndexAPIJUnitTest.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.index;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

import java.util.HashSet;
import java.util.List;
import java.util.Set;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.experimental.categories.Category;

import com.gemstone.gemfire.cache.Region;
import com.gemstone.gemfire.cache.query.AmbiguousNameException;
import com.gemstone.gemfire.cache.query.CacheUtils;
import com.gemstone.gemfire.cache.query.IndexType;
import com.gemstone.gemfire.cache.query.NameResolutionException;
import com.gemstone.gemfire.cache.query.QueryService;
import com.gemstone.gemfire.cache.query.TypeMismatchException;
import com.gemstone.gemfire.cache.query.data.Portfolio;
import com.gemstone.gemfire.cache.query.internal.CompiledIteratorDef;
import com.gemstone.gemfire.cache.query.internal.DefaultQuery;
import com.gemstone.gemfire.cache.query.internal.ExecutionContext;
import com.gemstone.gemfire.cache.query.internal.QCompiler;
import com.gemstone.gemfire.cache.query.internal.QueryExecutionContext;
import com.gemstone.gemfire.cache.query.internal.RuntimeIterator;
import com.gemstone.gemfire.cache.query.internal.parse.OQLLexerTokenTypes;
import com.gemstone.gemfire.test.junit.categories.IntegrationTest;

/**
 * @author asif
 *
 */
@Category(IntegrationTest.class)
public class RangeIndexAPIJUnitTest {
  private Region region = null;
  
  @Before
  public void setUp() throws java.lang.Exception {
    CacheUtils.startCache();
    region = CacheUtils.createRegion("portfolios", Portfolio.class);
    for (int i = 0; i < 12; i++) {
      //CacheUtils.log(new Portfolio(i));
      //make status of 10 and 11 as null
      Portfolio pf = new Portfolio(i);
      if (i == 10 || i == 11) {
        pf.status = null;
      }
      region.put(new Integer(i), pf);
    }

  }

  @After
  public void tearDown() throws java.lang.Exception {
    CacheUtils.closeCache();
  }

  @Test
  public void testQueryMethod_1() throws Exception {
    QueryService qs;
    qs = CacheUtils.getQueryService();
    AbstractIndex i1 = (AbstractIndex)qs.createIndex("idIndex", IndexType.FUNCTIONAL, "ID",
        "/portfolios");
    AbstractIndex i2 = (AbstractIndex)qs.createIndex("statusIndex", IndexType.FUNCTIONAL, "status",
    "/portfolios");
    AbstractIndex i3 = (AbstractIndex)qs.createIndex("status.toString()", IndexType.FUNCTIONAL, "status.toString",
    "/portfolios");

    Set results = new HashSet();
    DefaultQuery q = new DefaultQuery("select * from /portfolios", CacheUtils.getCache(), false);
    q.setRemoteQuery(false);
    ExecutionContext context = new QueryExecutionContext(null, CacheUtils.getCache(),  q);
    bindIterators(context, "/portfolios");
    i1.query(new Integer(1),OQLLexerTokenTypes.TOK_EQ, results, context);
    assertEquals(1,results.size());
    assertTrue(results.iterator().next()==region.get(new Integer(1)));
    results.clear();
    i1.query(new Integer(1),OQLLexerTokenTypes.TOK_GT, results, context);
    assertEquals(10,results.size());
    for (int i=2;i <12;++i) {
      assertTrue( results.contains(region.get(new Integer(i))));
    }
    results.clear();
    i2.query(new String("active"),OQLLexerTokenTypes.TOK_NE, results, context);
    assertEquals(7,results.size());
    for (int i=1;i <12;) {
      assertTrue( results.contains(region.get(new Integer(i))));
      if( i >= 9) {
        ++i;
      }else {
        i += 2;
      }
    }
    
    results.clear();
    i3.query(QueryService.UNDEFINED,OQLLexerTokenTypes.TOK_EQ, results, context);
    assertEquals(2,results.size());
    assertTrue(results.contains(region.get(new Integer(11))));
    assertTrue(results.contains(region.get(new Integer(10))));
    
  }

  /**
   * The keysToRemove set will never contain null or UNDEFINED as those
   * conditions never form part of RangeJunctionCondnEvaluator. Such null or 
   * undefined conditions are treated as separate filter operands.
   * This test checks the query method of Index which takes a set of keys 
   * which need to be removed from the set
   * @throws Exception
   */
  @Test
  public void testQueryMethod_2() throws Exception {
    QueryService qs;
    qs = CacheUtils.getQueryService();
    AbstractIndex i1 = (AbstractIndex)qs.createIndex("idIndex", IndexType.FUNCTIONAL, "ID",
        "/portfolios");
    AbstractIndex i2 = (AbstractIndex)qs.createIndex("statusIndex", IndexType.FUNCTIONAL, "status",
    "/portfolios");
    AbstractIndex i3 = (AbstractIndex)qs.createIndex("status.toString()", IndexType.FUNCTIONAL, "status.toString",
    "/portfolios");
   
    Set results = new HashSet();
    DefaultQuery q = new DefaultQuery("select * from /portfolios  ", CacheUtils.getCache(), false);
    q.setRemoteQuery(false);
    ExecutionContext context = new QueryExecutionContext(null, CacheUtils.getCache(), q);
    bindIterators(context, "/portfolios");
    Set keysToRemove = new HashSet();    
    i1.query(new Integer(1),OQLLexerTokenTypes.TOK_EQ, results, context);
    assertEquals(1,results.size());
    assertTrue(results.iterator().next()==region.get(new Integer(1)));
    results.clear();    
    keysToRemove.clear();
    keysToRemove.add(new Integer(1));
    try {
       i1.query(new Integer(1),OQLLexerTokenTypes.TOK_EQ, results, keysToRemove,context);
      fail ("A condition having an  equal will be identified at RangeJunction level itself, so this type of condition should throw error in RangeIndex where along with an equal there happens not equal conditions");
    }catch( AssertionError error) {
      //pass
    }
    keysToRemove.clear();  
    results.clear();
    keysToRemove.add(new Integer(9));
    i1.query(new Integer(1),OQLLexerTokenTypes.TOK_GT, results, keysToRemove,context);
    assertEquals(9,results.size());
    for (int i=2;i <12;) {
      if( i!=9  ) {
        assertTrue( results.contains(region.get(new Integer(i))));
      }
      ++i;      
    }
    
    keysToRemove.clear();  
    results.clear();
    keysToRemove.add(new Integer(1));
    keysToRemove.add(new Integer(10));
    i1.query(new Integer(1),OQLLexerTokenTypes.TOK_GE, results, keysToRemove,context);
    assertEquals(9,results.size());
    for (int i=2;i <12;) {
      if( i!=10  ) {
        assertTrue( results.contains(region.get(new Integer(i))));
      }
      ++i;      
    }
    
    keysToRemove.clear();  
    results.clear();
    keysToRemove.add(new Integer(8));
    keysToRemove.add(new Integer(11));
    i1.query(new Integer(11),OQLLexerTokenTypes.TOK_LT, results, keysToRemove,context);
    assertEquals(10,results.size());
    for (int i=0;i <11;) {
      if( i!=8  ) {
        assertTrue( results.contains(region.get(new Integer(i))));
      }
      ++i;      
    } 
    
    keysToRemove.clear();  
    results.clear();
    keysToRemove.add(new Integer(8));
    keysToRemove.add(new Integer(11));
    i1.query(new Integer(11),OQLLexerTokenTypes.TOK_LE, results, keysToRemove,context);
    assertEquals(10,results.size());
    for (int i=0;i <11;) {
      if( i!=8  ) {
        assertTrue( results.contains(region.get(new Integer(i))));
      }
      ++i;      
    }
    
    keysToRemove.clear();  
    results.clear();
    keysToRemove.add(new Integer(1));
    keysToRemove.add(new Integer(10));
    i1.query(new Integer(1),OQLLexerTokenTypes.TOK_GT, results, keysToRemove,context);
    assertEquals(9,results.size());
    for (int i=2;i <12;) {
      if( i!=10  ) {
        assertTrue( results.contains(region.get(new Integer(i))));
      }
      ++i;      
    }    
  } 
  /**
   * Tests the query method of RangeIndex with takes a bound defined ( lower 
   * as well as upper) & may contain NotEqaul Keys
   */
  @Test
  public void testQueryMethod_3() throws Exception {
    QueryService qs;
    qs = CacheUtils.getQueryService();
    AbstractIndex i1 = (AbstractIndex)qs.createIndex("idIndex", IndexType.FUNCTIONAL, "ID",
        "/portfolios");
    AbstractIndex i2 = (AbstractIndex)qs.createIndex("statusIndex", IndexType.FUNCTIONAL, "status",
    "/portfolios");
    AbstractIndex i3 = (AbstractIndex)qs.createIndex("status.toString()", IndexType.FUNCTIONAL, "status.toString",
    "/portfolios");
    
    Set results = new HashSet();
    DefaultQuery q = new DefaultQuery("select * from /portfolios", CacheUtils.getCache(), false);
    q.setRemoteQuery(false);
    ExecutionContext context = new QueryExecutionContext(null, CacheUtils.getCache(), q);
    bindIterators(context, "/portfolios");
    Set keysToRemove = new HashSet();    
    i1.query(new Integer(5), OQLLexerTokenTypes.TOK_GT,new Integer(10),OQLLexerTokenTypes.TOK_LT,results,null,
        context);
    assertEquals(4,results.size());
    for (int i=6;i <10;) {     
      assertTrue( results.contains(region.get(new Integer(i))));     
      ++i;      
    }
    
    results.clear();    
    keysToRemove.clear();
    keysToRemove.add(new Integer(10));
    keysToRemove.add(new Integer(9));
    i1.query(new Integer(5), OQLLexerTokenTypes.TOK_GT,new Integer(10),OQLLexerTokenTypes.TOK_LT,results,keysToRemove
        ,     context);
    assertEquals(3,results.size());
    for (int i=6;i <9;) {     
      assertTrue( results.contains(region.get(new Integer(i))));     
      ++i;      
    }
    
    results.clear();    
    keysToRemove.clear();
    keysToRemove.add(new Integer(10));
    i1.query(new Integer(5), OQLLexerTokenTypes.TOK_GT,new Integer(10),OQLLexerTokenTypes.TOK_LE,results,keysToRemove,
        context);
    assertEquals(4,results.size());
    for (int i=6;i <10;) {     
      assertTrue( results.contains(region.get(new Integer(i))));     
      ++i;      
    }   
    results.clear();    
    keysToRemove.clear();
    i1.query(new Integer(5), OQLLexerTokenTypes.TOK_GT,new Integer(10),OQLLexerTokenTypes.TOK_LE,results,null,
        context);
    assertEquals(5,results.size());
    for (int i=6;i <11;) {     
      assertTrue( results.contains(region.get(new Integer(i))));     
      ++i;      
    }
    
    results.clear();    
    keysToRemove.clear();
    i1.query(new Integer(5), OQLLexerTokenTypes.TOK_GE,new Integer(10),OQLLexerTokenTypes.TOK_LE,results,null,
        context);
    assertEquals(6,results.size());
    for (int i=5;i <11;) {     
      assertTrue( results.contains(region.get(new Integer(i))));     
      ++i;      
    }
    
    results.clear();    
    keysToRemove.clear();
    keysToRemove.add(new Integer(5));
    i1.query(new Integer(5), OQLLexerTokenTypes.TOK_GE,new Integer(10),OQLLexerTokenTypes.TOK_LE,results,keysToRemove,
        context);
    assertEquals(5,results.size());
    for (int i=6;i <11;) {     
      assertTrue( results.contains(region.get(new Integer(i))));     
      ++i;      
    }
    
    results.clear();    
    keysToRemove.clear();
    keysToRemove.add(new Integer(5));
    keysToRemove.add(new Integer(10));
    keysToRemove.add(new Integer(7));
    i1.query(new Integer(5), OQLLexerTokenTypes.TOK_GE,new Integer(10),OQLLexerTokenTypes.TOK_LE,results,keysToRemove,
        context);
    assertEquals(3,results.size());
    assertTrue( results.contains(region.get(new Integer(6))));     
    assertTrue( results.contains(region.get(new Integer(8))));
    assertTrue( results.contains(region.get(new Integer(9))));    
  }
  
  /**
   * Tests the query method of RangeIndex which just contains not equal keys.
   * That is if the where clause looks like a != 7 and a != 8 & a!=9
   */
  @Test
  public void testQueryMethod_4() throws Exception {
    QueryService qs;
    qs = CacheUtils.getQueryService();
    AbstractIndex i1 = (AbstractIndex)qs.createIndex("idIndex", IndexType.FUNCTIONAL, "ID",
        "/portfolios");
    AbstractIndex i2 = (AbstractIndex)qs.createIndex("statusIndex", IndexType.FUNCTIONAL, "status",
    "/portfolios");
    AbstractIndex i3 = (AbstractIndex)qs.createIndex("status.toString()", IndexType.FUNCTIONAL, "status.toString",
    "/portfolios");
    Set results = new HashSet();
    DefaultQuery q = new DefaultQuery("select * from /portfolios", CacheUtils.getCache(), false);
    q.setRemoteQuery(false);
    ExecutionContext context = new QueryExecutionContext(null, CacheUtils.getCache(), q);
    bindIterators(context, "/portfolios");
    
    Set keysToRemove = new HashSet();
    keysToRemove.add(new Integer(5));
    i1.query(results,keysToRemove,context);
    assertEquals(11,results.size());
    for (int i=0;i <12;) {
      if( i != 5) {
        assertTrue( results.contains(region.get(new Integer(i))));
      }
      ++i;      
    }
    
    results.clear();    
    keysToRemove.clear();
    keysToRemove.add(new Integer(5));
    keysToRemove.add(new Integer(8));
    i1.query(results,keysToRemove,context);
    assertEquals(10,results.size());
    for (int i=0;i <12;) {
      if( i != 5 &&  i != 8 ) {
        assertTrue( results.contains(region.get(new Integer(i))));
      }
      ++i;      
    }
    
    results.clear();    
    keysToRemove.clear();
    keysToRemove.add("active");
    keysToRemove.add("inactive");
    i2.query(results,keysToRemove,context);
    assertEquals(2,results.size());
    for (int i=10;i <12;) {      
      assertTrue( results.contains(region.get(new Integer(i))));      
      ++i;      
    }
    
  }  

  private void bindIterators(ExecutionContext context, String string) throws AmbiguousNameException, TypeMismatchException, NameResolutionException {
    QCompiler compiler = new QCompiler();
    List compilerItrDefs = compiler.compileFromClause(string);
    context.newScope(0);
    for (Object itrDef : compilerItrDefs) {
      CompiledIteratorDef iterDef = (CompiledIteratorDef) itrDef;
      RuntimeIterator rIter = iterDef.getRuntimeIterator(context);
      context.bindIterator(rIter);
    }
  }

}