mirror of
https://github.com/Alfresco/SearchServices.git
synced 2026-09-16 18:12:56 +00:00
SEARCH-1348 Add basic automated tests for search services using a RM site and a basic file plan.
This commit is contained in:
Cristina Diaconu
+216
@@ -0,0 +1,216 @@
|
||||
/*
|
||||
* Copyright 2019 Alfresco Software, Ltd. All rights reserved.
|
||||
* License rights for this program may be obtained from Alfresco Software, Ltd.
|
||||
* pursuant to a written agreement and any use of this program without such an
|
||||
* agreement is prohibited.
|
||||
*/
|
||||
|
||||
package org.alfresco.service.search.e2e;
|
||||
|
||||
import static org.alfresco.rest.rm.community.utils.FilePlanComponentsUtil.createRecordCategoryChildModel;
|
||||
import static org.alfresco.rest.rm.community.utils.FilePlanComponentsUtil.createRecordCategoryModel;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import org.alfresco.dataprep.SiteService.RMSiteCompliance;
|
||||
import org.alfresco.rest.core.RestAPIFactory;
|
||||
import org.alfresco.rest.rm.community.model.record.Record;
|
||||
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategory;
|
||||
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryChild;
|
||||
import org.alfresco.rest.rm.community.requests.gscore.api.RMSiteAPI;
|
||||
import org.alfresco.rest.rm.community.requests.gscore.api.RecordFolderAPI;
|
||||
import org.alfresco.rest.rm.community.requests.gscore.api.RecordsAPI;
|
||||
import org.alfresco.utility.model.SiteModel;
|
||||
import org.alfresco.utility.model.UserModel;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.testng.Assert;
|
||||
|
||||
/**
|
||||
* Base test class for RM tests.
|
||||
*
|
||||
* @author Cristina Diaconu
|
||||
*/
|
||||
public class AbstractRMSearchServiceE2E extends AbstractSearchServiceE2E
|
||||
{
|
||||
protected static final String FILE_PLAN_ALIAS = "-filePlan-";
|
||||
protected static final String RECORD_TYPE = "rma:record";
|
||||
protected static final String RECORD_FOLDER_TYPE = "rma:recordFolder";
|
||||
protected static final String RECORD_CATEGORY_TYPE = "rma:recordCategory";
|
||||
protected static final String CONTENT_TYPE = "cm:content";
|
||||
protected static final String ASPECTS_COMPLETED_RECORD = "rma:declaredRecord";
|
||||
protected static final String NON_ELECTRONIC_RECORD_TYPE = "rma:nonElectronicDocument";
|
||||
protected static final String RECORD_CATEGORY_TITLE = "RM_CATEGORY_TITLE";
|
||||
|
||||
@Autowired
|
||||
protected RestAPIFactory restAPIFactory;
|
||||
|
||||
/**
|
||||
* Create a new RM Site. If the site already exists then remove it and create a new one.
|
||||
*/
|
||||
public SiteModel createRMSite() throws Exception
|
||||
{
|
||||
RMSiteAPI rmSiteAPI = restAPIFactory.getRMSiteAPI();
|
||||
|
||||
if (rmSiteAPI.existsRMSite())
|
||||
{
|
||||
rmSiteAPI.deleteRMSite();
|
||||
}
|
||||
|
||||
return dataSite.createRMSite(RMSiteCompliance.STANDARD);
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method to create root category as the admin user
|
||||
*
|
||||
* @param categoryName The name of the category
|
||||
* @return The created category
|
||||
* @throws Exception on unsuccessful component creation
|
||||
*/
|
||||
public RecordCategory createRootCategory(String categoryName) throws Exception
|
||||
{
|
||||
return createRootCategory(dataUser.getAdminUser(), categoryName, RECORD_CATEGORY_TITLE);
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method to create root category
|
||||
*
|
||||
* @param userModel The user under whose privileges this structure is going to be created
|
||||
* @param categoryName The name of the category
|
||||
* @param categoryTitle The title of the category
|
||||
* @return The created category
|
||||
* @throws Exception on unsuccessful component creation
|
||||
*/
|
||||
public RecordCategory createRootCategory(UserModel userModel, String categoryName, String categoryTitle)
|
||||
throws Exception
|
||||
{
|
||||
RecordCategory recordCategoryModel = createRecordCategoryModel(categoryName, categoryTitle);
|
||||
return restAPIFactory.getFilePlansAPI(userModel).createRootRecordCategory(recordCategoryModel, FILE_PLAN_ALIAS);
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method to create a record category as the admin user
|
||||
*
|
||||
* @param recordCategoryId The id of the record category
|
||||
* @param name The name of the record category child
|
||||
* @return The created child category
|
||||
* @throws Exception on unsuccessful component creation
|
||||
*/
|
||||
public RecordCategoryChild createRecordCategoryChild(String recordCategoryId, String name) throws Exception
|
||||
{
|
||||
return createRecordCategoryChild(dataUser.getAdminUser(), recordCategoryId, name, RECORD_CATEGORY_TYPE);
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method to create a record category child
|
||||
*
|
||||
* @param user The user under whose privileges the node is going to be created
|
||||
* @param recordCategoryId The id of the record category
|
||||
* @param name The name of the record category child
|
||||
* @param type The type of the record category child
|
||||
* @return The created child category
|
||||
* @throws Exception on unsuccessful component creation
|
||||
*/
|
||||
public RecordCategoryChild createRecordCategoryChild(UserModel user, String recordCategoryId, String name,
|
||||
String type) throws Exception
|
||||
{
|
||||
RecordCategoryChild recordCategoryChildModel = createRecordCategoryChildModel(name, type);
|
||||
return restAPIFactory.getRecordCategoryAPI(user).createRecordCategoryChild(recordCategoryChildModel,
|
||||
recordCategoryId);
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method to create a record folder as the admin user
|
||||
*
|
||||
* @param recordCategoryId The id of the record category
|
||||
* @param name The name of the record category child
|
||||
* @return The created record folder.
|
||||
* @throws Exception on unsuccessful component creation
|
||||
*/
|
||||
public RecordCategoryChild createRecordFolder(String recordCategoryId, String name) throws Exception
|
||||
{
|
||||
return createRecordCategoryChild(dataUser.getAdminUser(), recordCategoryId, name, RECORD_FOLDER_TYPE);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an electronic record
|
||||
*
|
||||
* @param parentId The id of the parent
|
||||
* @param name The name of the record
|
||||
* @return The created record
|
||||
* @throws Exception on unsuccessful component creation
|
||||
*/
|
||||
public Record createElectronicRecord(String parentId, String name) throws Exception
|
||||
{
|
||||
return createElectronicRecord(parentId, name, null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an electronic record
|
||||
*
|
||||
* @param parentId The id of the parent
|
||||
* @param name The name of the record
|
||||
* @return The created electronic record
|
||||
* @throws Exception on unsuccessful component creation
|
||||
*/
|
||||
public Record createElectronicRecord(String parentId, String name, UserModel user) throws Exception
|
||||
{
|
||||
RecordFolderAPI recordFolderAPI = restAPIFactory.getRecordFolderAPI(user);
|
||||
Record recordModel = Record.builder().name(name).nodeType(CONTENT_TYPE).build();
|
||||
return recordFolderAPI.createRecord(recordModel, parentId);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a non-electronic record
|
||||
*
|
||||
* @param parentId The id of the parent
|
||||
* @param name The name of the record
|
||||
* @return The created non electronic record
|
||||
* @throws Exception on unsuccessful component creation
|
||||
*/
|
||||
public Record createNonElectronicRecord(String parentId, String name) throws Exception
|
||||
{
|
||||
return createNonElectronicRecord(parentId, name, null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a non-electronic record
|
||||
*
|
||||
* @param parentId The id of the parent
|
||||
* @param name The name of the record
|
||||
* @param user The user who creates the non-electronic record
|
||||
* @return The created non electronic record
|
||||
* @throws Exception on unsuccessful component creation
|
||||
*/
|
||||
public Record createNonElectronicRecord(String parentId, String name, UserModel user) throws Exception
|
||||
{
|
||||
RecordFolderAPI recordFolderAPI = restAPIFactory.getRecordFolderAPI(user);
|
||||
Record recordModel = Record.builder().name(name).nodeType(NON_ELECTRONIC_RECORD_TYPE).build();
|
||||
return recordFolderAPI.createRecord(recordModel, parentId);
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method to complete record
|
||||
*
|
||||
* @param recordId The id of the record to complete
|
||||
* @return The completed record
|
||||
* @throws Exception on unsuccessful component creation
|
||||
*/
|
||||
public Record completeRecord(String recordId) throws Exception
|
||||
{
|
||||
RecordsAPI recordsAPI = restAPIFactory.getRecordsAPI();
|
||||
List<String> aspects = recordsAPI.getRecord(recordId).getAspectNames();
|
||||
|
||||
// this operation is only valid for records
|
||||
Assert.assertTrue(aspects.contains(RECORD_TYPE));
|
||||
// a record mustn't be completed
|
||||
Assert.assertFalse(aspects.contains(ASPECTS_COMPLETED_RECORD));
|
||||
// add completed record aspect
|
||||
aspects.add(ASPECTS_COMPLETED_RECORD);
|
||||
|
||||
Record updateRecord = recordsAPI.updateRecord(Record.builder().aspectNames(aspects).build(), recordId);
|
||||
restAPIFactory.getRmRestWrapper().assertStatusCodeIs(HttpStatus.OK);
|
||||
|
||||
return updateRecord;
|
||||
}
|
||||
}
|
||||
@@ -454,4 +454,20 @@ public abstract class AbstractSearchServiceE2E extends AbstractTestNGSpringConte
|
||||
searchRequest.setQuery(queryModel);
|
||||
return restClient.authenticateUser(user).withSearchAPI().search(searchRequest);
|
||||
}
|
||||
|
||||
/**
|
||||
* Run a search as given user and return the response
|
||||
*
|
||||
* @param user: UserModel for the user you wish to run the query as
|
||||
* @param queryModel: The queryModel to search for, containing the query
|
||||
* @return the search response from the API
|
||||
* @throws Exception
|
||||
*/
|
||||
public SearchResponse queryAsUser(UserModel user, RestRequestQueryModel queryModel) throws Exception
|
||||
{
|
||||
SearchRequest searchRequest = new SearchRequest();
|
||||
searchRequest.setQuery(queryModel);
|
||||
|
||||
return restClient.authenticateUser(user).withSearchAPI().search(searchRequest);
|
||||
}
|
||||
}
|
||||
|
||||
+112
@@ -0,0 +1,112 @@
|
||||
/*
|
||||
* Copyright 2019 Alfresco Software, Ltd. All rights reserved.
|
||||
* License rights for this program may be obtained from Alfresco Software, Ltd.
|
||||
* pursuant to a written agreement and any use of this program without such an
|
||||
* agreement is prohibited.
|
||||
*/
|
||||
|
||||
package org.alfresco.service.search.e2e.rm.searchServices;
|
||||
|
||||
import org.alfresco.rest.rm.community.model.record.Record;
|
||||
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategory;
|
||||
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryChild;
|
||||
import org.alfresco.rest.search.RestRequestQueryModel;
|
||||
import org.alfresco.rest.search.SearchResponse;
|
||||
import org.alfresco.service.search.e2e.AbstractRMSearchServiceE2E;
|
||||
import org.alfresco.utility.model.TestGroup;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.testng.Assert;
|
||||
import org.testng.annotations.AfterClass;
|
||||
import org.testng.annotations.BeforeClass;
|
||||
import org.testng.annotations.Test;
|
||||
|
||||
/**
|
||||
* The purpose of this test is to create basic queries using a RM site and a basic file plan.
|
||||
*
|
||||
* @author Cristina Diaconu
|
||||
*/
|
||||
public class SearchServicesRME2ETest extends AbstractRMSearchServiceE2E
|
||||
{
|
||||
private static final String ROOT_CATEGORY_NAME = "RM_root_category";
|
||||
private static final String CATEGORY1 = "RM_child_category_1";
|
||||
private static final String CATEGORY2 = "RM_child_category_2";
|
||||
private static final String FOLDER1 = "RM_folder_1";
|
||||
private static final String FOLDER2 = "RM_folder_2";
|
||||
private static final String ELECTRONIC_FILE = "RM_electonic_file";
|
||||
private static final String NON_ELECTRONIC_FILE = "RM_nonelectonic_file";
|
||||
private static final String SEARCH_LANGUAGE = "cmis";
|
||||
|
||||
@BeforeClass(alwaysRun = true)
|
||||
public void dataPreparation() throws Exception
|
||||
{
|
||||
|
||||
serverHealth.assertServerIsOnline();
|
||||
|
||||
testSite = createRMSite();
|
||||
|
||||
// create the Root category
|
||||
RecordCategory rootCategory = createRootCategory(ROOT_CATEGORY_NAME);
|
||||
Assert.assertNotNull(rootCategory, "Root category was not created!");
|
||||
|
||||
// Add two children (categories) on Root category
|
||||
RecordCategoryChild childCategory1 = createRecordCategoryChild(rootCategory.getId(), CATEGORY1);
|
||||
Assert.assertNotNull(childCategory1, "Child category 1 was not created!");
|
||||
|
||||
RecordCategoryChild childCategory2 = createRecordCategoryChild(rootCategory.getId(), CATEGORY2);
|
||||
Assert.assertNotNull(childCategory2, "Child category 2 was not created!");
|
||||
|
||||
// Create two folders with records (electronic and nonElectronic files) on Child category 1
|
||||
RecordCategoryChild folder1 = createRecordFolder(childCategory1.getId(), FOLDER1);
|
||||
RecordCategoryChild folder2 = createRecordFolder(childCategory1.getId(), FOLDER2);
|
||||
|
||||
// Create two folders on Child Category2
|
||||
createRecordFolder(childCategory2.getId(), FOLDER1);
|
||||
createRecordFolder(childCategory2.getId(), FOLDER2);
|
||||
|
||||
// Complete a file
|
||||
Record electronicRecord = createElectronicRecord(folder1.getId(), ELECTRONIC_FILE);
|
||||
completeRecord(electronicRecord.getId());
|
||||
createNonElectronicRecord(folder1.getId(), NON_ELECTRONIC_FILE);
|
||||
|
||||
// Add an electronic record on folder2
|
||||
createElectronicRecord(folder2.getId(), ELECTRONIC_FILE);
|
||||
}
|
||||
|
||||
@AfterClass(alwaysRun = true)
|
||||
public void cleanupEnvironment()
|
||||
{
|
||||
// dataSite.deleteSite(testSite);
|
||||
}
|
||||
|
||||
@Test(priority = 1, groups = { TestGroup.ASS_14 })
|
||||
public void testBasicSearch() throws Exception
|
||||
{
|
||||
|
||||
// Search for a folder name
|
||||
String query = "select * from cmis:folder where cmis:name='" + FOLDER1 + "'";
|
||||
|
||||
RestRequestQueryModel queryModel = new RestRequestQueryModel();
|
||||
queryModel.setQuery(query);
|
||||
queryModel.setLanguage(SEARCH_LANGUAGE);
|
||||
|
||||
SearchResponse response = queryAsUser(dataUser.getAdminUser(), queryModel);
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
|
||||
Assert.assertEquals(response.getPagination().getCount(), 2,
|
||||
"Wrong number of search elements, expected two folders.");
|
||||
|
||||
// Search for a file name
|
||||
query = "select * from cmis:document where cmis:name like '" + NON_ELECTRONIC_FILE + "%'";
|
||||
|
||||
queryModel = new RestRequestQueryModel();
|
||||
queryModel.setQuery(query);
|
||||
queryModel.setLanguage(SEARCH_LANGUAGE);
|
||||
|
||||
response = queryAsUser(dataUser.getAdminUser(), queryModel);
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
|
||||
Assert.assertEquals(response.getPagination().getCount(), 1,
|
||||
"Wrong number of search elements, expected 1 non electronic file");
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user