ObjectFieldSelectIT.java

/*
 *    Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License").
 *    You may not use this file except in compliance with the License.
 *    A copy of the License is located at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *    or in the "license" file accompanying this file. This file 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.amazon.opendistroforelasticsearch.sql.esintgtest;

import static com.amazon.opendistroforelasticsearch.sql.esintgtest.TestsConstants.TEST_INDEX_DEEP_NESTED;
import static com.amazon.opendistroforelasticsearch.sql.util.MatcherUtils.rows;
import static com.amazon.opendistroforelasticsearch.sql.util.MatcherUtils.schema;
import static com.amazon.opendistroforelasticsearch.sql.util.MatcherUtils.verifyDataRows;
import static com.amazon.opendistroforelasticsearch.sql.util.MatcherUtils.verifySchema;

import com.amazon.opendistroforelasticsearch.sql.utils.StringUtils;
import org.json.JSONArray;
import org.json.JSONObject;
import org.junit.Test;

/**
 * Integration test for Elasticsearch object field (and nested field).
 * This class is focused on simple SELECT-FROM query to ensure right column
 * number and value is returned.
 */
public class ObjectFieldSelectIT extends SQLIntegTestCase {

  @Override
  protected void init() throws Exception {
    loadIndex(Index.DEEP_NESTED);
  }

  @Test
  public void testSelectObjectFieldItself() {
    JSONObject response = new JSONObject(query("SELECT city FROM %s"));

    verifySchema(response, schema("city", null, "object"));

    // Expect object field itself is returned in a single cell
    verifyDataRows(response,
        rows(new JSONObject(
            "{\n"
                + "  \"name\": \"Seattle\",\n"
                + "  \"location\": {\"latitude\": 10.5}\n"
                + "}")
        )
    );
  }

  @Test
  public void testSelectObjectInnerFields() {
    JSONObject response = new JSONObject(query(
        "SELECT city.location, city.location.latitude FROM %s"));

    verifySchema(response,
        schema("city.location", null, "object"),
        schema("city.location.latitude", null, "double")
    );

    // Expect inner regular or object field returned in its single cell
    verifyDataRows(response,
        rows(
            new JSONObject("{\"latitude\": 10.5}"),
            10.5
        )
    );
  }

  @Test
  public void testSelectNestedFieldItself() {
    JSONObject response = new JSONObject(query("SELECT projects FROM %s"));

    // Nested field is absent in ES Get Field Mapping response either hence "object" used
    verifySchema(response, schema("projects", null, "object"));

    // Expect nested field itself is returned in a single cell
    verifyDataRows(response,
        rows(new JSONArray(
            "[\n"
                + "  {\"name\": \"AWS Redshift Spectrum querying\"},\n"
                + "  {\"name\": \"AWS Redshift security\"},\n"
                + "  {\"name\": \"AWS Aurora security\"}\n"
                + "]")
        )
    );
  }

  @Test
  public void testSelectObjectFieldOfArrayValuesItself() {
    JSONObject response = new JSONObject(query("SELECT accounts FROM %s"));

    // Expect the entire list of values is returned just like a nested field
    verifyDataRows(response,
        rows(new JSONArray(
            "[\n"
                + "  {\"id\": 1},\n"
                + "  {\"id\": 2}\n"
                + "]")
        )
    );
  }

  @Test
  public void testSelectObjectFieldOfArrayValuesInnerFields() {
    JSONObject response = new JSONObject(query("SELECT accounts.id FROM %s"));

    // We don't support flatten object field of list value so expect null returned
    verifyDataRows(response, rows(JSONObject.NULL));
  }

  private String query(String sql) {
    return executeQuery(
        StringUtils.format(sql, TEST_INDEX_DEEP_NESTED),
        "jdbc"
    );
  }

}