mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-07 17:49:17 +00:00
303 lines
12 KiB
Java
303 lines
12 KiB
Java
/*
|
|
* #%L
|
|
* Alfresco Records Management Module
|
|
* %%
|
|
* Copyright (C) 2005 - 2016 Alfresco Software Limited
|
|
* %%
|
|
* 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.
|
|
* #L%
|
|
*/
|
|
package org.alfresco.rest.fileplancomponents;
|
|
|
|
import static java.util.Arrays.asList;
|
|
|
|
import static org.alfresco.rest.base.AllowableOperations.CREATE;
|
|
import static org.alfresco.rest.base.AllowableOperations.DELETE;
|
|
import static org.alfresco.rest.base.AllowableOperations.UPDATE;
|
|
import static org.alfresco.rest.model.fileplancomponents.FilePlanComponentAlias.FILE_PLAN_ALIAS;
|
|
import static org.alfresco.rest.model.fileplancomponents.FilePlanComponentFields.NAME;
|
|
import static org.alfresco.rest.model.fileplancomponents.FilePlanComponentFields.NODE_TYPE;
|
|
import static org.alfresco.rest.model.fileplancomponents.FilePlanComponentFields.PROPERTIES;
|
|
import static org.alfresco.rest.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_DESCRIPTION;
|
|
import static org.alfresco.rest.model.fileplancomponents.FilePlanComponentFields.PROPERTIES_TITLE;
|
|
import static org.alfresco.utility.data.RandomData.getRandomAlphanumeric;
|
|
import static org.jglue.fluentjson.JsonBuilderFactory.buildObject;
|
|
import static org.springframework.http.HttpStatus.FORBIDDEN;
|
|
import static org.springframework.http.HttpStatus.NOT_FOUND;
|
|
import static org.springframework.http.HttpStatus.OK;
|
|
import static org.testng.Assert.assertEquals;
|
|
import static org.testng.Assert.assertFalse;
|
|
import static org.testng.Assert.assertTrue;
|
|
|
|
import com.google.gson.JsonObject;
|
|
|
|
import org.alfresco.rest.base.BaseRestTest;
|
|
import org.alfresco.rest.base.TestData;
|
|
import org.alfresco.rest.model.fileplancomponents.FilePlanComponent;
|
|
import org.alfresco.rest.model.fileplancomponents.FilePlanComponentAlias;
|
|
import org.alfresco.rest.model.fileplancomponents.FilePlanComponentType;
|
|
import org.alfresco.rest.requests.FilePlanComponentAPI;
|
|
import org.alfresco.rest.requests.RMSiteAPI;
|
|
import org.alfresco.utility.data.DataUser;
|
|
import org.alfresco.utility.model.UserModel;
|
|
import org.alfresco.utility.report.Bug;
|
|
import org.springframework.beans.factory.annotation.Autowired;
|
|
import org.testng.annotations.Test;
|
|
|
|
/**
|
|
* This class contains the tests for
|
|
* the File Plan CRUD API
|
|
*
|
|
* @author Rodica Sutu
|
|
* @since 1.0
|
|
*/
|
|
public class FilePlanTests extends BaseRestTest
|
|
{
|
|
@Autowired
|
|
private FilePlanComponentAPI filePlanComponentAPI;
|
|
|
|
@Autowired
|
|
private RMSiteAPI rmSiteAPI;
|
|
|
|
@Autowired
|
|
private DataUser dataUser;
|
|
|
|
/**
|
|
* Given that the RM site doesn't exist
|
|
* When I use the API to get the File Plan/Holds/Unfiled Records Container/Transfers
|
|
* Then I get the 404 response code
|
|
*/
|
|
@Test
|
|
(
|
|
description = "Check the GET response code when the RM site doesn't exist",
|
|
dataProviderClass = TestData.class,
|
|
dataProvider = "getContainers"
|
|
)
|
|
public void getFilePlanComponentWhenRMIsNotCreated(String filePlanAlias) throws Exception
|
|
{
|
|
// Check RM Site Exist
|
|
if (siteRMExists())
|
|
{
|
|
// Delete RM Site
|
|
rmSiteAPI.deleteRMSite();
|
|
}
|
|
|
|
// Authenticate with admin user
|
|
filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
|
|
|
// Get the file plan component
|
|
filePlanComponentAPI.getFilePlanComponent(filePlanAlias.toString());
|
|
|
|
//check the response code is NOT_FOUND
|
|
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(NOT_FOUND);
|
|
}
|
|
|
|
/**
|
|
* Given that a file plan exists
|
|
* When I ask the API for the details of the file plan
|
|
* Then I am given the details of the file plan
|
|
*/
|
|
@Test
|
|
(
|
|
description = "Check the GET response for special file plan components when the RM site exit",
|
|
dataProviderClass = TestData.class,
|
|
dataProvider = "getContainersAndTypes"
|
|
)
|
|
public void getFilePlanComponentWhenRMIsCreated(FilePlanComponentAlias filePlanAlias, FilePlanComponentType rmType) throws Exception
|
|
{
|
|
// Create RM Site if doesn't exist
|
|
createRMSiteIfNotExists();
|
|
|
|
// Authenticate with admin user
|
|
filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
|
|
|
// Get the file plan special container
|
|
FilePlanComponent filePlanComponent = filePlanComponentAPI.getFilePlanComponent(filePlanAlias.toString());
|
|
|
|
// Check the response code
|
|
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(OK);
|
|
|
|
// Check the response contains the right node type
|
|
assertEquals(filePlanComponent.getNodeType(), rmType.toString());
|
|
}
|
|
|
|
/**
|
|
* Given that a file plan exists
|
|
* When I ask the API for the details of the file plan to include the allowableOperations property
|
|
* Then I am given the allowableOperations property with the update and create operations.
|
|
*/
|
|
@Test
|
|
(
|
|
description = "Check the allowableOperations list returned ",
|
|
dataProviderClass = TestData.class,
|
|
dataProvider = "getContainers"
|
|
)
|
|
public void includeAllowableOperations(String specialContainerAlias) throws Exception
|
|
{
|
|
// Create RM Site if doesn't exist
|
|
createRMSiteIfNotExists();
|
|
|
|
// Authenticate with admin user
|
|
filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
|
|
|
// Get the file plan special containers with the optional parameter allowableOperations
|
|
FilePlanComponent filePlanComponent = filePlanComponentAPI.withParams("include=allowableOperations").getFilePlanComponent(specialContainerAlias);
|
|
|
|
// Check the list of allowableOperations returned
|
|
assertTrue(filePlanComponent.getAllowableOperations().containsAll(asList(UPDATE, CREATE)),
|
|
"Wrong list of the allowable operations is return" + filePlanComponent.getAllowableOperations().toString());
|
|
|
|
// Check the list of allowableOperations doesn't contains DELETE operation
|
|
assertFalse(filePlanComponent.getAllowableOperations().contains(DELETE),
|
|
"The list of allowable operations contains delete option" + filePlanComponent.getAllowableOperations().toString());
|
|
}
|
|
|
|
/**
|
|
* Given that a file plan exists
|
|
* When I ask the API to modify the details of the file plan
|
|
* Then the details of the file are modified
|
|
* Note: the details of the file plan are limited to title and description.
|
|
*/
|
|
@Test
|
|
@Bug (id = "RM-4295")
|
|
public void updateFilePlan() throws Exception
|
|
{
|
|
String FILE_PLAN_DESCRIPTION = "Description updated " + getRandomAlphanumeric();
|
|
String FILE_PLAN_TITLE = "Title updated " + getRandomAlphanumeric();
|
|
|
|
// Create RM Site if doesn't exist
|
|
createRMSiteIfNotExists();
|
|
|
|
// Authenticate with admin user
|
|
filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
|
|
|
// Build the file plan root properties
|
|
JsonObject filePlanProperties = buildObject()
|
|
.addObject(PROPERTIES)
|
|
.add(PROPERTIES_TITLE, FILE_PLAN_TITLE)
|
|
.add(PROPERTIES_DESCRIPTION, FILE_PLAN_DESCRIPTION)
|
|
.end()
|
|
.getJson();
|
|
|
|
// Update the record category
|
|
FilePlanComponent renamedFilePlanComponent = filePlanComponentAPI.updateFilePlanComponent(filePlanProperties,FILE_PLAN_ALIAS.toString());
|
|
|
|
// Verify the response status code
|
|
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(OK);
|
|
|
|
// Verify the returned description field for the file plan component
|
|
assertEquals(renamedFilePlanComponent.getProperties().getDescription(), FILE_PLAN_DESCRIPTION);
|
|
|
|
// Verify the returned title field for the file plan component
|
|
assertEquals(renamedFilePlanComponent.getProperties().getTitle(), FILE_PLAN_TITLE);
|
|
}
|
|
|
|
/**
|
|
* Given that a file plan exists
|
|
* When I ask the API to delete the file plan
|
|
* Then the 403 response code is returned.
|
|
*/
|
|
@Test
|
|
(
|
|
description = "Check the response code when deleting the special file plan components",
|
|
dataProviderClass = TestData.class,
|
|
dataProvider = "getContainers"
|
|
)
|
|
public void deleteFilePlanSpecialComponents(String filePlanAlias) throws Exception
|
|
{
|
|
// Create RM Site if doesn't exist
|
|
createRMSiteIfNotExists();
|
|
|
|
// Authenticate with admin user
|
|
filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
|
|
|
// Delete the file plan component
|
|
filePlanComponentAPI.deleteFilePlanComponent(filePlanAlias.toString());
|
|
|
|
// Check the DELETE response status code
|
|
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(FORBIDDEN);
|
|
}
|
|
|
|
/**
|
|
* Given that RM site exists
|
|
* When I ask to create the file plan
|
|
* Then the 403 response code is returned.
|
|
*/
|
|
@Test
|
|
(
|
|
description = "Check the response code when creating the special file plan components",
|
|
dataProviderClass = TestData.class,
|
|
dataProvider = "getContainersAndTypes"
|
|
)
|
|
@Bug(id="RM-4296")
|
|
public void createFilePlanSpecialContainerWhenExists(FilePlanComponentAlias filePlanAlias, FilePlanComponentType rmType) throws Exception
|
|
{
|
|
// Create RM Site if doesn't exist
|
|
createRMSiteIfNotExists();
|
|
|
|
// Authenticate with admin user
|
|
rmSiteAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
|
// Get the RM site ID
|
|
String rmSiteId = rmSiteAPI.getSite().getGuid();
|
|
|
|
String name = filePlanAlias + getRandomAlphanumeric();
|
|
|
|
// Build the file plan root properties
|
|
JsonObject componentProperties = buildObject()
|
|
.add(NAME, name)
|
|
.add(NODE_TYPE, rmType.toString())
|
|
.getJson();
|
|
|
|
// Authenticate with admin user
|
|
filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
|
// Create the special containers into RM site - parent folder
|
|
filePlanComponentAPI.createFilePlanComponent(componentProperties, rmSiteId);
|
|
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(FORBIDDEN);
|
|
|
|
// Create the special containers into RM site - parent folder
|
|
filePlanComponentAPI.createFilePlanComponent(componentProperties, FILE_PLAN_ALIAS.toString());
|
|
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(FORBIDDEN);
|
|
|
|
// Create the special containers into the root of special containers containers
|
|
filePlanComponentAPI.createFilePlanComponent(componentProperties, filePlanAlias.toString());
|
|
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(FORBIDDEN);
|
|
}
|
|
|
|
/**
|
|
* Given that RM site exists
|
|
* When a non-RM user ask the API for the details of the file plan
|
|
* Then the status code 403 (Permission denied) is return
|
|
*/
|
|
@Test
|
|
(
|
|
description = "Check the response code when the RM site containers are get with non rm users",
|
|
dataProviderClass = TestData.class,
|
|
dataProvider = "getContainers"
|
|
)
|
|
public void getSpecialFilePlanComponentsWithNonRMuser(String filePlanAlias) throws Exception
|
|
{
|
|
// Create RM Site if doesn't exist
|
|
createRMSiteIfNotExists();
|
|
|
|
// Disconnect user from REST API session
|
|
rmSiteAPI.usingRestWrapper().disconnect();
|
|
|
|
// Authenticate admin user to Alfresco REST API
|
|
restClient.authenticateUser(dataUser.getAdminUser());
|
|
|
|
// Create a random user
|
|
UserModel nonRMuser = dataUser.createRandomTestUser("testUser");
|
|
|
|
// Authenticate using the random user
|
|
filePlanComponentAPI.usingRestWrapper().authenticateUser(nonRMuser);
|
|
|
|
// Get the special file plan components
|
|
filePlanComponentAPI.getFilePlanComponent(filePlanAlias.toString());
|
|
|
|
// Check the response status code is FORBIDDEN
|
|
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(FORBIDDEN);
|
|
}
|
|
}
|