mirror of
https://github.com/Alfresco/SearchServices.git
synced 2026-09-16 18:12:56 +00:00
473 lines
21 KiB
Java
473 lines
21 KiB
Java
/*
|
|
* Copyright (C) 2018 Alfresco Software Limited.
|
|
*
|
|
* This file is part of Alfresco
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
package org.alfresco.rest.search;
|
|
|
|
import java.util.ArrayList;
|
|
import java.util.List;
|
|
|
|
import javax.json.Json;
|
|
import javax.json.JsonObject;
|
|
|
|
import org.alfresco.utility.model.FileModel;
|
|
import org.alfresco.utility.model.FileType;
|
|
import org.alfresco.utility.model.FolderModel;
|
|
import org.alfresco.utility.model.TestGroup;
|
|
import org.alfresco.utility.model.UserModel;
|
|
import org.alfresco.utility.testrail.ExecutionType;
|
|
import org.alfresco.utility.testrail.annotation.TestRail;
|
|
import org.testng.Assert;
|
|
import org.testng.TestException;
|
|
import org.testng.annotations.Test;
|
|
|
|
/**
|
|
* Faceted search test.
|
|
* @author Michael Suzuki
|
|
*
|
|
*/
|
|
public class FacetedSearchTest extends AbstractSearchTest
|
|
{
|
|
|
|
/**
|
|
* Perform the below facet query.
|
|
* {
|
|
* "query": {
|
|
* "query": "cars",
|
|
* "language": "afts"
|
|
* },
|
|
* "facetQueries": [
|
|
* {"query": "content.size:[o TO 102400]", "label": "small"},
|
|
* {"query": "content.size:[102400 TO 1048576]", "label": "medium"},
|
|
* {"query": "content.size:[1048576 TO 16777216]", "label": "large"}
|
|
* ],
|
|
* "facetFields": {"facets": [{"field": "'content.size'"}]}
|
|
* }
|
|
*
|
|
* Expected response
|
|
* {"list": {
|
|
* "entries": [... All the results],
|
|
* "pagination": {
|
|
* "maxItems": 100,
|
|
* "hasMoreItems": false,
|
|
* "totalItems": 61,
|
|
* "count": 61,
|
|
* "skipCount": 0
|
|
* },
|
|
* "facetsFields": [
|
|
* {
|
|
* "type": "query",
|
|
* "label": "foo",
|
|
* "buckets": [
|
|
* {
|
|
* "label": "small",
|
|
* "filterQuery": "content.size:[0 TO 102400]",
|
|
* "display": 1
|
|
* },
|
|
* {
|
|
* "label": "large",
|
|
* "filterQuery": "content.size:[1048576 TO 16777216]",
|
|
* "metrics": [
|
|
* {
|
|
* "type": "count",
|
|
* "value": {
|
|
* "count": 0
|
|
* }
|
|
* }
|
|
* ]
|
|
* },
|
|
* }}
|
|
* @throws Exception
|
|
*/
|
|
|
|
@Test(groups = { TestGroup.REST_API, TestGroup.SEARCH, TestGroup.ASS_1 })
|
|
@TestRail(section = { TestGroup.REST_API, TestGroup.SEARCH,
|
|
TestGroup.ASS_1 }, executionType = ExecutionType.REGRESSION, description = "Checks facet queries for the Search api")
|
|
public void searchWithQueryFaceting() throws Exception
|
|
{
|
|
SearchRequest query = new SearchRequest();
|
|
RestRequestQueryModel queryReq = new RestRequestQueryModel();
|
|
queryReq.setQuery("cars");
|
|
query.setQuery(queryReq);
|
|
|
|
List<FacetQuery> facets = new ArrayList<FacetQuery>();
|
|
facets.add(new FacetQuery("content.size:[0 TO 102400]", "small"));
|
|
facets.add(new FacetQuery("content.size:[102400 TO 1048576]", "medium"));
|
|
facets.add(new FacetQuery("content.size:[1048576 TO 16777216]", "large"));
|
|
query.setFacetQueries(facets);
|
|
RestRequestFacetFieldsModel facetFields = new RestRequestFacetFieldsModel();
|
|
List<RestRequestFacetFieldModel> list = new ArrayList<>();
|
|
list.add(new RestRequestFacetFieldModel("'content.size'"));
|
|
facetFields.setFacets(list);
|
|
query.setFacetFields(facetFields);
|
|
query.setIncludeRequest(true);
|
|
|
|
SearchResponse response = query(query);
|
|
|
|
response.assertThat().entriesListIsNotEmpty();
|
|
response.getContext().assertThat().field("facetQueries").isNotEmpty();
|
|
|
|
FacetFieldBucket facet = response.getContext().getFacetQueries().get(0);
|
|
facet.assertThat().field("label").contains("small").and().field("count").isGreaterThan(0);
|
|
facet.assertThat().field("label").contains("small").and().field("filterQuery").is("content.size:[0 TO 102400]");
|
|
response.getContext().getFacetQueries().get(1).assertThat().field("label").contains("large")
|
|
.and().field("count").isLessThan(1)
|
|
.and().field("filterQuery").is("content.size:[1048576 TO 16777216]");
|
|
response.getContext().getFacetQueries().get(2).assertThat().field("label").contains("medium")
|
|
.and().field("count").isLessThan(1)
|
|
.and().field("filterQuery").is("content.size:[102400 TO 1048576]");
|
|
//We don't expect to see the FacetFields if group is being used.
|
|
Assert.assertNull(response.getContext().getFacetsFields());
|
|
Assert.assertNull(response.getContext().getFacets());
|
|
}
|
|
@Test(groups = { TestGroup.REST_API, TestGroup.SEARCH , TestGroup.ASS_1})
|
|
@TestRail(section = {TestGroup.REST_API, TestGroup.SEARCH ,TestGroup.ASS_1 }, executionType = ExecutionType.REGRESSION,
|
|
description = "Checks facet queries for the Search api")
|
|
/**
|
|
* * Perform a group by faceting, below test groups the facet by group name foo.
|
|
* {
|
|
* "query": {
|
|
* "query": "cars",
|
|
* "language": "afts"
|
|
* },
|
|
* "facetQueries": [
|
|
* {"query": "content.size:[o TO 102400]", "label": "small","group":"foo"},
|
|
* {"query": "content.size:[102400 TO 1048576]", "label": "medium","group":"foo"},
|
|
* {"query": "content.size:[1048576 TO 16777216]", "label": "large","group":"foo"}
|
|
* ],
|
|
* "facetFields": {"facets": [{"field": "'content.size'"}]}
|
|
* }
|
|
*
|
|
* Expected response
|
|
* {"list": {
|
|
* "entries": [... All the results],
|
|
* "pagination": {
|
|
* "maxItems": 100,
|
|
* "hasMoreItems": false,
|
|
* "totalItems": 61,
|
|
* "count": 61,
|
|
* "skipCount": 0
|
|
* },
|
|
* "context": {
|
|
* "consistency": {"lastTxId": 512},
|
|
* //Added below as part of SEARCH-374
|
|
* "facets": [
|
|
* { "label": "foo",
|
|
* "buckets": [
|
|
* { "label": "small", "count": 61, "filterQuery": "content.size:[o TO 102400]"},
|
|
* { "label": "large", "count": 0, "filterQuery": "content.size:[1048576 TO 16777216]"},
|
|
* { "label": "medium", "count": 61, "filterQuery": "content.size:[102400 TO 1048576]"}
|
|
* ]
|
|
* }
|
|
* }
|
|
* }}
|
|
*
|
|
*
|
|
* @throws Exception
|
|
*/
|
|
public void searchQueryFacetingWithGroup() throws Exception
|
|
{
|
|
SearchRequest query = new SearchRequest();
|
|
RestRequestQueryModel queryReq = new RestRequestQueryModel();
|
|
queryReq.setQuery("cars");
|
|
query.setQuery(queryReq);
|
|
|
|
List<FacetQuery> facets = new ArrayList<FacetQuery>();
|
|
facets.add(new FacetQuery("content.size:[0 TO 102400]", "small", "foo"));
|
|
facets.add(new FacetQuery("content.size:[102400 TO 1048576]", "medium", "foo"));
|
|
facets.add(new FacetQuery("content.size:[1048576 TO 16777216]", "large", "foo"));
|
|
query.setFacetQueries(facets);
|
|
|
|
RestRequestFacetFieldsModel facetFields = new RestRequestFacetFieldsModel();
|
|
List<RestRequestFacetFieldModel> list = new ArrayList<>();
|
|
list.add(new RestRequestFacetFieldModel("'content.size'"));
|
|
facetFields.setFacets(list);
|
|
query.setFacetFields(facetFields);
|
|
|
|
SearchResponse response = query(query);
|
|
|
|
// We don't expect to see the FacetQueries if group is being used.
|
|
Assert.assertTrue(response.getContext().getFacetQueries() == null);
|
|
// Validate the facet field structure is correct.
|
|
Assert.assertFalse(response.getContext().getFacets().isEmpty());
|
|
Assert.assertEquals(response.getContext().getFacets().get(0).getLabel(), "foo");
|
|
|
|
RestGenericBucketModel bucket = response.getContext().getFacets().get(0).getBuckets().get(0);
|
|
bucket.assertThat().field("label").isNotEmpty();
|
|
Assert.assertEquals(bucket.getMetrics().get(0).getType(), "count");
|
|
Assert.assertNotEquals(bucket.getMetrics().get(0).getValue(), "");
|
|
bucket.assertThat().field("filterQuery").isNotEmpty();
|
|
response.getContext().getFacets().get(0).getBuckets().forEach(action -> {
|
|
switch (action.getLabel())
|
|
{
|
|
case "small":
|
|
Assert.assertEquals(action.getFilterQuery(), "content.size:[0 TO 102400]");
|
|
break;
|
|
case "medium":
|
|
Assert.assertEquals(action.getFilterQuery(), "content.size:[102400 TO 1048576]");
|
|
break;
|
|
case "large":
|
|
Assert.assertEquals(action.getFilterQuery(), "content.size:[1048576 TO 16777216]");
|
|
break;
|
|
|
|
default:
|
|
throw new TestException("Unexpected value returned");
|
|
}
|
|
});
|
|
|
|
}
|
|
|
|
@Test
|
|
/**
|
|
* {
|
|
* "query": {
|
|
* "query": "*"
|
|
* },
|
|
* "facetFields": {
|
|
* "facets": [{"field": "cm:mimetype"},{"field": "modifier"}]
|
|
* }
|
|
* }
|
|
*/
|
|
public void searchWithFactedFields() throws Exception
|
|
{
|
|
SearchRequest query = new SearchRequest();
|
|
RestRequestQueryModel queryReq = new RestRequestQueryModel();
|
|
queryReq.setQuery(unique_searchString);
|
|
query.setQuery(queryReq);
|
|
|
|
RestRequestFacetFieldsModel facetFields = new RestRequestFacetFieldsModel();
|
|
List<RestRequestFacetFieldModel> facets = new ArrayList<RestRequestFacetFieldModel>();
|
|
facets.add(new RestRequestFacetFieldModel("cm:mimetype"));
|
|
facets.add(new RestRequestFacetFieldModel("modifier"));
|
|
facetFields.setFacets(facets);
|
|
query.setFacetFields(facetFields);
|
|
|
|
SearchResponse response = query(query);
|
|
|
|
Assert.assertFalse(response.getContext().getFacetsFields().isEmpty());
|
|
Assert.assertNull(response.getContext().getFacetQueries());
|
|
Assert.assertNull(response.getContext().getFacets());
|
|
|
|
RestResultBucketsModel model = response.getContext().getFacetsFields().get(0);
|
|
Assert.assertEquals(model.getLabel(), "modifier");
|
|
|
|
model.assertThat().field("label").is("modifier");
|
|
FacetFieldBucket bucket1 = model.getBuckets().get(0);
|
|
bucket1.assertThat().field("label").is(userModel.getUsername());
|
|
bucket1.assertThat().field("display").is(userModel.getUsername() + " FirstName LN-" + userModel.getUsername());
|
|
bucket1.assertThat().field("filterQuery").is("modifier:\"" + userModel.getUsername() + "\"");
|
|
bucket1.assertThat().field("count").is(1);
|
|
}
|
|
|
|
@Test
|
|
/**
|
|
* Test that items returned are in the format of generic facets.
|
|
* {
|
|
* "query": {
|
|
* "query": "*"
|
|
* },
|
|
* "facetFields": {
|
|
* "facets": [{"field": "cm:mimetype"},{"field": "modifier"}]
|
|
* },
|
|
* "facetFormat":"V2"
|
|
* }
|
|
*/
|
|
public void searchWithFactedFieldsFacetFormatV2() throws Exception
|
|
{
|
|
SearchRequest query = new SearchRequest();
|
|
RestRequestQueryModel queryReq = new RestRequestQueryModel();
|
|
queryReq.setQuery(unique_searchString);
|
|
query.setQuery(queryReq);
|
|
query.setFacetFormat("V2");
|
|
RestRequestFacetFieldsModel facetFields = new RestRequestFacetFieldsModel();
|
|
List<RestRequestFacetFieldModel> facets = new ArrayList<RestRequestFacetFieldModel>();
|
|
facets.add(new RestRequestFacetFieldModel("cm:mimetype"));
|
|
facets.add(new RestRequestFacetFieldModel("modifier"));
|
|
facetFields.setFacets(facets);
|
|
query.setFacetFields(facetFields);
|
|
|
|
SearchResponse response = query(query);
|
|
|
|
Assert.assertNull(response.getContext().getFacetsFields());
|
|
Assert.assertNull(response.getContext().getFacetQueries());
|
|
Assert.assertFalse(response.getContext().getFacets().isEmpty());
|
|
RestGenericFacetResponseModel model = response.getContext().getFacets().get(0);
|
|
Assert.assertEquals(model.getLabel(), "modifier");
|
|
|
|
model.assertThat().field("label").is("modifier");
|
|
RestGenericBucketModel bucket1 = model.getBuckets().get(0);
|
|
bucket1.assertThat().field("label").is(userModel.getUsername());
|
|
bucket1.assertThat().field("display").is(userModel.getUsername() + " FirstName LN-" + userModel.getUsername());
|
|
bucket1.assertThat().field("filterQuery").is("modifier:\"" + userModel.getUsername() + "\"");
|
|
bucket1.assertThat().field("metrics").is("[{entry=null, type=count, value={count=1}}]");
|
|
}
|
|
|
|
@Test(groups = { TestGroup.REST_API, TestGroup.SEARCH, TestGroup.ASS_13 })
|
|
public void searchWithFactedFieldsWithACLs() throws Exception
|
|
{
|
|
String fname = unique_searchString + "facet";
|
|
|
|
// Create another user who would not have access to the Private Site created by userModel
|
|
UserModel user2 = dataUser.createRandomTestUser("UserSearch2");
|
|
UserModel user3 = dataUser.createRandomTestUser("UserSearch3");
|
|
|
|
// Create a folder and a file as test User
|
|
FolderModel folder = new FolderModel(fname);
|
|
dataContent.usingUser(userModel).usingSite(siteModel).createFolder(folder);
|
|
|
|
FileModel file = new FileModel(fname + "-1.txt", fname, fname, FileType.TEXT_PLAIN, fname + " file for search ");
|
|
dataContent.usingUser(userModel).usingSite(siteModel).createContent(file);
|
|
|
|
FileModel file2 = new FileModel(fname + "-2.html", fname, fname, FileType.HTML, fname + " file 2 for search ");
|
|
dataContent.usingUser(userModel).usingSite(siteModel).createContent(file2);
|
|
|
|
// Set Node Permissions to allow access for user3 user for text File
|
|
JsonObject userPermission = Json.createObjectBuilder()
|
|
.add("permissions", Json.createObjectBuilder().add("isInheritanceEnabled", false)
|
|
.add("locallySet",Json.createObjectBuilder().add("authorityId", user3.getUsername())
|
|
.add("name", "SiteConsumer").add("accessStatus", "ALLOWED")))
|
|
.build();
|
|
String putBody = userPermission.toString();
|
|
|
|
restClient.authenticateUser(userModel).withCoreAPI().usingNode(file).updateNode(putBody);
|
|
|
|
waitForIndexing(file.getName(), true);
|
|
|
|
// FacetField: Site Name
|
|
|
|
SearchRequest query = new SearchRequest();
|
|
RestRequestQueryModel queryReq = new RestRequestQueryModel();
|
|
queryReq.setQuery("name:" + fname);
|
|
query.setQuery(queryReq);
|
|
|
|
RestRequestFacetFieldsModel facetFields = new RestRequestFacetFieldsModel();
|
|
List<RestRequestFacetFieldModel> facets = new ArrayList<RestRequestFacetFieldModel>();
|
|
|
|
RestRequestFacetFieldModel facetName = new RestRequestFacetFieldModel("SITE");
|
|
facetName.setLabel("SEARCH.FACET_FIELDS.SITE");
|
|
facetName.setMincount(0); // MinCount = 0
|
|
facets.add(facetName);
|
|
|
|
facetName = new RestRequestFacetFieldModel("cm:content.mimetype");
|
|
facetName.setLabel("Mimetype");
|
|
facetName.setMincount(2); // MinCount = 2
|
|
facets.add(facetName);
|
|
|
|
facetFields.setFacets(facets);
|
|
query.setFacetFields(facetFields);
|
|
|
|
// Search query using user who created site: Expect Only 1 Facet bucket to be retrieved
|
|
SearchResponse response = query(query);
|
|
|
|
Assert.assertFalse(response.getContext().getFacetsFields().isEmpty());
|
|
Assert.assertEquals(response.getContext().getFacetsFields().size(), 1);
|
|
|
|
RestResultBucketsModel facetFieldList = response.getContext().getFacetsFields().get(0);
|
|
Assert.assertEquals(facetFieldList.getLabel(), "SEARCH.FACET_FIELDS.SITE");
|
|
Assert.assertEquals(facetFieldList.getBuckets().size(), 1); //MimeType bucket won't be shown as minCount = 2 won't be reached
|
|
|
|
FacetFieldBucket bucket1 = facetFieldList.getBuckets().get(0);
|
|
bucket1.assertThat().field("label").is(siteModel.getId());
|
|
bucket1.assertThat().field("filterQuery").contains(siteModel.getId());
|
|
bucket1.assertThat().field("count").is(3); //One folder and 2 files created above
|
|
|
|
// MinCount 1 or not set: Defaults to 1
|
|
query = new SearchRequest();
|
|
queryReq = new RestRequestQueryModel();
|
|
queryReq.setQuery("name:" + fname);
|
|
query.setQuery(queryReq);
|
|
|
|
facetFields = new RestRequestFacetFieldsModel();
|
|
facets = new ArrayList<RestRequestFacetFieldModel>();
|
|
|
|
facetName = new RestRequestFacetFieldModel("SITE");
|
|
facetName.setLabel("SEARCH.FACET_FIELD1.SITE");
|
|
// MinCount Not set
|
|
facets.add(facetName);
|
|
|
|
facetName = new RestRequestFacetFieldModel("cm:content.mimetype");
|
|
facetName.setLabel("SEARCH.FACET_FIELD2.Mimetype");
|
|
facetName.setMincount(1); // MinCount = 1
|
|
facets.add(facetName);
|
|
|
|
facetFields.setFacets(facets);
|
|
query.setFacetFields(facetFields);
|
|
|
|
// Search query using user who created site: Expect 2 Facet buckets to be retrieved
|
|
response = query(query);
|
|
|
|
Assert.assertFalse(response.getContext().getFacetsFields().isEmpty());
|
|
Assert.assertEquals(response.getContext().getFacetsFields().size(), 2);
|
|
|
|
List<RestResultBucketsModel> facetFieldBucketsList = response.getContext().getFacetsFields();
|
|
facetFieldList = facetFieldBucketsList.get(0);
|
|
Assert.assertEquals(facetFieldList.getLabel(), "SEARCH.FACET_FIELD1.SITE");
|
|
|
|
bucket1 = facetFieldList.getBuckets().get(0);
|
|
bucket1.assertThat().field("label").is(siteModel.getId());
|
|
bucket1.assertThat().field("filterQuery").contains(siteModel.getId());
|
|
bucket1.assertThat().field("count").is(3);
|
|
|
|
facetFieldList = facetFieldBucketsList.get(1);
|
|
Assert.assertEquals(facetFieldList.getLabel(), "SEARCH.FACET_FIELD2.Mimetype");
|
|
Assert.assertEquals(facetFieldList.getBuckets().size(), 2); //MimeType bucket will be shown with 2 buckets
|
|
|
|
bucket1 = facetFieldList.getBuckets().get(0);
|
|
bucket1.assertThat().field("label").is("text/html");
|
|
bucket1.assertThat().field("filterQuery").contains("text/html");
|
|
bucket1.assertThat().field("count").is(1);
|
|
bucket1.assertThat().field("display").is("HTML");
|
|
|
|
bucket1 = facetFieldList.getBuckets().get(1);
|
|
bucket1.assertThat().field("label").is("text/plain");
|
|
bucket1.assertThat().field("filterQuery").contains("text/plain");
|
|
bucket1.assertThat().field("count").is(1);
|
|
bucket1.assertThat().field("display").is("Plain Text");
|
|
|
|
// Search query using other user: No access hence no buckets expected
|
|
response = restClient.authenticateUser(user2).withSearchAPI().search(query);
|
|
Assert.assertNull(response.getContext().getFacetsFields());
|
|
|
|
// Search query using user3
|
|
response = restClient.authenticateUser(user3).withSearchAPI().search(query);
|
|
Assert.assertFalse(response.getContext().getFacetsFields().isEmpty());
|
|
Assert.assertEquals(response.getContext().getFacetsFields().size(), 2);
|
|
|
|
facetFieldBucketsList = response.getContext().getFacetsFields();
|
|
facetFieldList = facetFieldBucketsList.get(0);
|
|
|
|
Assert.assertEquals(facetFieldList.getLabel(), "SEARCH.FACET_FIELD1.SITE");
|
|
|
|
bucket1 = facetFieldList.getBuckets().get(0);
|
|
bucket1.assertThat().field("label").is(siteModel.getId());
|
|
bucket1.assertThat().field("filterQuery").contains(siteModel.getId());
|
|
bucket1.assertThat().field("count").is(1);
|
|
|
|
facetFieldList = facetFieldBucketsList.get(1);
|
|
Assert.assertEquals(facetFieldList.getLabel(), "SEARCH.FACET_FIELD2.Mimetype");
|
|
Assert.assertEquals(facetFieldList.getBuckets().size(), 1); //MimeType bucket will be shown with 1 bucket only
|
|
|
|
bucket1 = facetFieldList.getBuckets().get(0);
|
|
bucket1.assertThat().field("label").is("text/plain");
|
|
bucket1.assertThat().field("label").isNot("text/html");
|
|
bucket1.assertThat().field("filterQuery").contains("text/plain");
|
|
bucket1.assertThat().field("count").is(1);
|
|
bucket1.assertThat().field("display").is("Plain Text");
|
|
}
|
|
|
|
}
|