src/test/java/org/openecomp/sa/searchdbabstraction/searchapi/SearchStatementTest.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017 Amdocs
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *       http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  */
  23 package org.openecomp.sa.searchdbabstraction.searchapi;
  24
  25 import com.fasterxml.jackson.core.JsonParseException;
  26 import com.fasterxml.jackson.databind.JsonMappingException;
  27 import com.fasterxml.jackson.databind.ObjectMapper;
  28 import org.junit.Test;
  29 import org.openecomp.sa.rest.TestUtils;
  30
  31 import java.io.File;
  32 import java.io.IOException;
  33
  34 import static org.junit.Assert.*;
  35
  36 public class SearchStatementTest {
  37
  38   @Test
  39   public void simpleQueryTest() throws JsonParseException, JsonMappingException, IOException {
  40
  41     String field = "searchTags";
  42     String queryString = "aai3255";
  43     String queryJson =
  44         "{"
  45             + "\"queries\": ["
  46             + "{\"may\": {\"parsed-query\": {"
  47             + "\"field\": \"" + field + "\","
  48             + "\"query-string\": \"" + queryString + "\"}}}"
  49             + "]"
  50             + "}"
  51             + "}";
  52
  53     String queryES =
  54         "{"
  55             + "\"version\": true,"
  56             + "\"query\": {"
  57             + "\"bool\": {"
  58             + "\"must\": [], "
  59             + "\"should\": ["
  60             + "{\"query_string\": {\"default_field\": \"searchTags\", \"query\": \"aai3255\"}}"
  61             + "],"
  62             + "\"must_not\": []}"
  63             + "}"
  64             + "}";
  65
  66     // Marshal our simple query JSON to a SearchStatement object.
  67     ObjectMapper mapper = new ObjectMapper();
  68     SearchStatement ss = mapper.readValue(queryJson, SearchStatement.class);
  69
  70     // We expect to have a search statement with one query.
  71     assertEquals("Unexpected number of queries in marshalled result",
  72         1, ss.getQueries().length);
  73
  74     // Validate that the query is of the expected type and contains the
  75     // expected values.
  76     QueryStatement query = ss.getQueries()[0].getQueryStatement();
  77     assertNotNull("Expected marshalled statement to contain a 'parsed query'",
  78         query.getParsedQuery());
  79     assertTrue("Unexpected field name in marshalled query.  Expected: " + field + " Actual: " + query.getParsedQuery().getField(),
  80         field.equals(query.getParsedQuery().getField()));
  81     assertTrue("Unexpected query string in marshalled query.  Expected: " + queryString + " Actual: " + query.getParsedQuery().getQueryString(),
  82         queryString.equals(query.getParsedQuery().getQueryString()));
  83
  84     // Validate that we are able to produce the expected ElasticSearch
  85     // query syntax from the search statement.
  86     assertTrue("Unexpected ElasticSearch syntax.  Expected: " + queryES + " Actual: " + ss.toElasticSearch(),
  87         queryES.equals(ss.toElasticSearch()));
  88   }
  89
  90
  91   @Test
  92   public void simpleSortedQueryTest() throws JsonParseException, JsonMappingException, IOException {
  93
  94     String field = "searchTags";
  95     String queryString = "aai3255";
  96     String queryJson =
  97         "{"
  98             + "\"queries\": ["
  99             + "{\"may\": {\"parsed-query\": {"
 100             + "\"field\": \"" + field + "\","
 101             + "\"query-string\": \"" + queryString + "\"}}}"
 102             + "],"
 103             + "\"sort\": { \"field\": \"date\", \"order\": \"ascending\" }"
 104             + "}";
 105
 106
 107     String queryES =
 108         "{"
 109             + "\"version\": true,"
 110             + "\"query\": {"
 111             + "\"bool\": {"
 112             + "\"must\": [], "
 113             + "\"should\": ["
 114             + "{\"query_string\": {\"default_field\": \"searchTags\", \"query\": \"aai3255\"}}"
 115             + "],"
 116             + "\"must_not\": []"
 117             + "}"
 118             + "}, "
 119             + "\"sort\": { \"date\": { \"order\": \"asc\"}}"
 120             + "}";
 121
 122     // Marshal our simple query JSON to a SearchStatement object.
 123     ObjectMapper mapper = new ObjectMapper();
 124     SearchStatement ss = mapper.readValue(queryJson, SearchStatement.class);
 125
 126     // We expect to have a search statement with one query.
 127     assertEquals("Unexpected number of queries in marshalled result",
 128         1, ss.getQueries().length);
 129
 130     // Validate that the query is of the expected type and contains the
 131     // expected values.
 132     QueryStatement query = ss.getQueries()[0].getQueryStatement();
 133     assertNotNull("Expected marshalled statement to contain a 'parsed query'",
 134         query.getParsedQuery());
 135     assertTrue("Unexpected field name in marshalled query.  Expected: " + field + " Actual: " + query.getParsedQuery().getField(),
 136         field.equals(query.getParsedQuery().getField()));
 137     assertTrue("Unexpected query string in marshalled query.  Expected: " + queryString + " Actual: " + query.getParsedQuery().getQueryString(),
 138         queryString.equals(query.getParsedQuery().getQueryString()));
 139     System.out.println("GDF: ES = " + ss.toElasticSearch());
 140     // Validate that we are able to produce the expected ElasticSearch
 141     // query syntax from the search statement.
 142     assertTrue("Unexpected ElasticSearch syntax.  Expected: " + queryES + " Actual: " + ss.toElasticSearch(),
 143         queryES.equals(ss.toElasticSearch()));
 144     assertNull(ss.getAggregations());
 145   }
 146
 147   @Test
 148   public void filteredQueryTest() throws JsonParseException, JsonMappingException, IOException {
 149
 150     String filterField1 = "field1";
 151     String filterField2 = "field2";
 152     String filterField3 = "field3";
 153     String filterValue1 = "a";
 154     String filterValue2 = "b";
 155     String filterValue3 = "string";
 156     String filterJson = "{ \"any\": [ "
 157         + "{\"match\": {\"field\": \"" + filterField1 + "\", \"value\": \"" + filterValue1 + "\"}},"
 158         + "{\"match\": {\"field\": \"" + filterField2 + "\", \"value\": \"" + filterValue2 + "\"}}"
 159         + "],"
 160         + "\"all\": ["
 161         + "{\"parsed-query\": {\"field\": \"" + filterField3 + "\", \"query-string\": \"" + filterValue3 + "\"}}"
 162         + "]"
 163         + "}";
 164
 165     String filterStanzaJson = "\"filter\": " + filterJson;
 166
 167     String queryStanzaJson = "\"queries\": [ "
 168         + "{\"may\": {\"match\": {\"field\": \"searchTags\", \"value\": \"a\"}}},"
 169         + "{\"may\": {\"match\": {\"field\": \"searchTags\", \"value\": \"b\"}}},"
 170         + "{\"may\": {\"parsed-query\": {\"field\": \"fieldname\", \"query-string\": \"string\"}}}"
 171         + "]";
 172
 173     String queryES =
 174         "{"
 175             + "\"version\": true,"
 176             + "\"query\": {"
 177             + "\"bool\": {"
 178             + "\"must\": [], "
 179             + "\"should\": ["
 180             + "{\"term\": {\"searchTags\" : \"a\"}}, "
 181             + "{\"term\": {\"searchTags\" : \"b\"}}, "
 182             + "{\"query_string\": {\"default_field\": \"fieldname\", \"query\": \"string\"}}"
 183             + "],"
 184             + "\"must_not\": [], "
 185             + "\"filter\": {"
 186             + "\"bool\": {"
 187             + "\"must\": ["
 188             + "{\"query_string\": {\"default_field\": \"field3\", \"query\": \"string\"}}"
 189             + "],"
 190             + "\"must_not\": [],"
 191             + "\"should\": ["
 192             + "{\"term\": {\"field1\" : \"a\"}}, "
 193             + "{\"term\": {\"field2\" : \"b\"}}"
 194             + "],"
 195             + "\"must_not\": []"
 196             + "}"
 197             + "}"
 198             + "}"
 199             + "}"
 200             + "}";
 201
 202     StringBuilder sb = new StringBuilder();
 203     sb.append("{");
 204     sb.append(filterStanzaJson).append(", ");
 205     sb.append(queryStanzaJson);
 206     sb.append("}");
 207
 208     ObjectMapper mapper = new ObjectMapper();
 209     SearchStatement ss = mapper.readValue(sb.toString(), SearchStatement.class);
 210
 211     assertEquals("Unexpected number of queries in the 'any' list for this statement's filter",
 212         2, ss.getFilter().getAny().length);
 213     assertEquals("Unexpected number of queries in the 'all' list for this statement's filter",
 214         1, ss.getFilter().getAll().length);
 215
 216     assertTrue("Unexpected ElasticSearch syntax.  Expected: " + queryES + " Actual: " + ss.toElasticSearch(),
 217         queryES.equals(ss.toElasticSearch()));
 218
 219     assertNull(ss.getAggregations());
 220   }
 221
 222   @Test
 223   public void aggregationTest() {
 224     String input = "{\r\n  \"queries\": [\r\n    {\r\n      \"must\": {\r\n        \"match\": {\r\n          \"field\": \"searchTags\",\r\n          \"value\": \"a\"\r\n        }\r\n      }\r\n    }\r\n  ],\r\n  \"aggregations\": [\r\n    {\r\n      \"name\": \"byDate\",\r\n      \"aggregation\": {\r\n        \"date-range\": {\r\n          \"field\": \"mydate\",\r\n          \"ranges\": [\r\n            {\r\n              \"from\": \"2016-12-19T00:00:00.738-05:00\",\r\n              \"to\": \"2016-12-23T23:59:59.738-05:00\"\r\n            }\r\n          ]\r\n        },\r\n        \"sub-aggregations\": [\r\n          {\r\n            \"name\": \"byTerm\",\r\n            \"aggregation\": {\r\n              \"group-by\": {\r\n                \"field\": \"myterm\"\r\n              }\r\n            }\r\n          },\r\n          {\r\n            \"name\": \"byDate\",\r\n            \"aggregation\": {\r\n              \"date-histogram\": {\r\n                \"field\": \"myDate\",\r\n                \"interval\": \"myInterval\"\r\n              }\r\n            }\r\n          }\r\n        ]\r\n      }\r\n    },\r\n    {\r\n      \"name\": \"2nd\",\r\n      \"aggregation\": {\r\n        \"group-by\": {\r\n          \"field\": \"anotherTerm\"\r\n        }\r\n      }\r\n    }\r\n  ]\r\n}";
 225
 226     ObjectMapper mapper = new ObjectMapper();
 227     try {
 228       SearchStatement ss = mapper.readValue(input, SearchStatement.class);
 229       Aggregation[] aggs = ss.getAggregations();
 230       assertNotNull(aggs);
 231       assertEquals("Unexpected number aggregations", 2, aggs.length);
 232       assertEquals("byDate", aggs[0].getName());
 233       assertNotNull(aggs[0].getStatement().getDateRange());
 234       assertEquals("mydate", aggs[0].getStatement().getDateRange().getField());
 235       assertNotNull(aggs[0].getStatement().getSubAggregations());
 236       assertEquals(2, aggs[0].getStatement().getSubAggregations().length);
 237       assertEquals("byTerm", aggs[0].getStatement().getSubAggregations()[0].getName());
 238       assertEquals("byDate", aggs[0].getStatement().getSubAggregations()[1].getName());
 239       assertNull(aggs[0].getStatement().getGroupBy());
 240       assertEquals("2nd", aggs[1].getName());
 241       assertNotNull(aggs[1].getStatement().getGroupBy());
 242       assertEquals("anotherTerm", aggs[1].getStatement().getGroupBy().getField());
 243       assertNull(aggs[1].getStatement().getDateRange());
 244       assertNull(aggs[1].getStatement().getSubAggregations());
 245
 246     } catch (Exception e) {
 247       fail("Encountered exception: " + e.getMessage());
 248     }
 249   }
 250
 251   @Test
 252   public void resultSetRangeTest() throws IOException {
 253
 254     // Simple query with a result set subrange specified.
 255     File queryWithSubrangeFile = new File("src/test/resources/json/queries/query-with-subrange.json");
 256     String queryWithSubrangeStr = TestUtils.readFileToString(queryWithSubrangeFile);
 257     String queryWithSubrangeExpectedESString =
 258         "{\"version\": true,\"from\": 0, \"size\": 10, \"query\": {\"bool\": {\"must\": [{\"term\": {\"field1\" : \"Bob\"}}], \"should\": [],\"must_not\": []}}}";
 259
 260     ObjectMapper mapper = new ObjectMapper();
 261     SearchStatement ss = mapper.readValue(queryWithSubrangeStr, SearchStatement.class);
 262
 263     assertEquals("Unexpected index for result set start", ss.getFrom(), (Integer) 0);
 264     assertEquals("Unexpected value for result set size", ss.getSize(), (Integer) 10);
 265     assertTrue("Unexpected elastic search query generated from search statement",
 266         ss.toElasticSearch().equals(queryWithSubrangeExpectedESString));
 267   }
 268 }