mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-31 17:39:05 +00:00
Merge branch 'master' of https://gitlab.alfresco.com/records-management/records-management into feature/RM-4396_Lombok_UseModelInsteadJsonObject
# Conflicts: # rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/rm/community/model/fileplancomponents/FilePlanComponent.java # rm-automation/rm-automation-community-rest-api/src/main/java/org/alfresco/rest/rm/community/model/fileplancomponents/FilePlanComponentProperties.java
This commit is contained in:
Rodica Sutu
@@ -30,11 +30,15 @@ import static java.lang.Integer.parseInt;
|
||||
|
||||
import static org.alfresco.rest.rm.community.base.TestData.CATEGORY_TITLE;
|
||||
import static org.alfresco.rest.rm.community.base.TestData.FOLDER_TITLE;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAlias.FILE_PLAN_ALIAS;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAlias.UNFILED_RECORDS_CONTAINER_ALIAS;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType.RECORD_CATEGORY_TYPE;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType.RECORD_FOLDER_TYPE;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType.UNFILED_RECORD_FOLDER_TYPE;
|
||||
import static org.alfresco.rest.rm.community.model.site.RMSiteCompliance.STANDARD;
|
||||
import static org.alfresco.utility.data.RandomData.getRandomAlphanumeric;
|
||||
import static org.springframework.http.HttpStatus.CREATED;
|
||||
import static org.springframework.http.HttpStatus.OK;
|
||||
|
||||
import com.jayway.restassured.RestAssured;
|
||||
|
||||
@@ -47,11 +51,13 @@ import org.alfresco.rest.rm.community.model.site.RMSite;
|
||||
import org.alfresco.rest.rm.community.requests.FilePlanComponentAPI;
|
||||
import org.alfresco.rest.rm.community.requests.RMSiteAPI;
|
||||
import org.alfresco.utility.data.DataUser;
|
||||
import org.alfresco.utility.model.UserModel;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.beans.factory.annotation.Value;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.context.annotation.PropertySource;
|
||||
import org.testng.annotations.BeforeClass;
|
||||
import org.testng.annotations.DataProvider;
|
||||
|
||||
/**
|
||||
* Base class for all IG REST API Tests
|
||||
@@ -83,7 +89,7 @@ public class BaseRestTest extends RestTest
|
||||
|
||||
@Autowired
|
||||
private RMSiteAPI rmSiteAPI;
|
||||
|
||||
|
||||
@Autowired
|
||||
private DataUser dataUser;
|
||||
|
||||
@@ -95,6 +101,19 @@ public class BaseRestTest extends RestTest
|
||||
public static final String RM_TITLE = "Records Management";
|
||||
public static final String RM_DESCRIPTION = "Records Management Site";
|
||||
|
||||
/** Valid root containers where electronic and non-electronic records can be created */
|
||||
@DataProvider(name = "validRootContainers")
|
||||
public Object[][] getValidRootContainers() throws Exception {
|
||||
return new Object[][] {
|
||||
// an arbitrary record folder
|
||||
{ createCategoryFolderInFilePlan(dataUser.getAdminUser(), FILE_PLAN_ALIAS.toString()) },
|
||||
// unfiled records root
|
||||
{ getFilePlanComponentAsUser(dataUser.getAdminUser(), UNFILED_RECORDS_CONTAINER_ALIAS.toString()) },
|
||||
// an arbitrary unfiled records folder
|
||||
{ createUnfiledRecordsFolder(UNFILED_RECORDS_CONTAINER_ALIAS.toString(), "Unfiled Folder " + getRandomAlphanumeric()) }
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* @see org.alfresco.rest.RestTest#checkServerHealth()
|
||||
*/
|
||||
@@ -196,4 +215,55 @@ public class BaseRestTest extends RestTest
|
||||
return fpc;
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method to close folder
|
||||
* @param folderToClose
|
||||
* @return
|
||||
* @throws Exception
|
||||
*/
|
||||
public FilePlanComponent closeFolder(String folderId) throws Exception
|
||||
{
|
||||
RestWrapper restWrapper = filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
||||
|
||||
// build fileplan component + properties for update request
|
||||
FilePlanComponentProperties properties = new FilePlanComponentProperties();
|
||||
properties.setIsClosed(true);
|
||||
FilePlanComponent filePlanComponent = new FilePlanComponent();
|
||||
filePlanComponent.setProperties(properties);
|
||||
|
||||
FilePlanComponent updatedComponent = filePlanComponentAPI.updateFilePlanComponent(filePlanComponent, folderId);
|
||||
restWrapper.assertStatusCodeIs(OK);
|
||||
return updatedComponent;
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method to create a randomly-named <category>/<folder> structure in fileplan
|
||||
* @param user user under whose privileges this structure is going to be created
|
||||
* @param parentId parent container id
|
||||
* @return record folder
|
||||
* @throws Exception on failed creation
|
||||
*/
|
||||
public FilePlanComponent createCategoryFolderInFilePlan(UserModel user, String parentId) throws Exception
|
||||
{
|
||||
filePlanComponentAPI.usingRestWrapper().authenticateUser(user);
|
||||
|
||||
// create root category
|
||||
FilePlanComponent recordCategory = createCategory(parentId, "Category " + getRandomAlphanumeric());
|
||||
|
||||
// and return a folder underneath
|
||||
return createFolder(recordCategory.getId(), "Folder " + getRandomAlphanumeric());
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method to retieve a fileplan component with user's privilege
|
||||
* @param user user under whose privileges a component is to be read
|
||||
* @param componentId id of the component to read
|
||||
* @return {@link FilePlanComponent} for given componentId
|
||||
* @throws Exception if user doesn't have sufficient privileges
|
||||
*/
|
||||
public FilePlanComponent getFilePlanComponentAsUser(UserModel user, String componentId) throws Exception
|
||||
{
|
||||
filePlanComponentAPI.usingRestWrapper().authenticateUser(user);
|
||||
return filePlanComponentAPI.getFilePlanComponent(componentId);
|
||||
}
|
||||
}
|
||||
@@ -50,7 +50,7 @@ import org.testng.annotations.DataProvider;
|
||||
* @since 2.6
|
||||
*/
|
||||
public interface TestData
|
||||
{
|
||||
{
|
||||
/**
|
||||
* A user with ALFRESCO_ADMINISTRATORS role.
|
||||
* <p>"GROUP_ANOTHER_ADMIN_EXISTS" The ANOTHER_ADMIN user has been created.
|
||||
@@ -141,5 +141,4 @@ public interface TestData
|
||||
{ CONTENT_TYPE.toString()}
|
||||
};
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -0,0 +1,232 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Records Management Module
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2016 Alfresco Software Limited
|
||||
* %%
|
||||
* This file is part of the Alfresco software.
|
||||
* -
|
||||
* If the software was purchased under a paid Alfresco license, the terms of
|
||||
* the paid license agreement will prevail. Otherwise, the software is
|
||||
* provided under the following open source license terms:
|
||||
* -
|
||||
* 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/>.
|
||||
* #L%
|
||||
*/
|
||||
package org.alfresco.rest.rm.community.fileplancomponents;
|
||||
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAlias.FILE_PLAN_ALIAS;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAlias.HOLDS_ALIAS;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAlias.TRANSFERS_ALIAS;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType.CONTENT_TYPE;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType.RECORD_FOLDER_TYPE;
|
||||
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
|
||||
import static org.alfresco.utility.data.RandomData.getRandomAlphanumeric;
|
||||
import static org.springframework.http.HttpStatus.BAD_REQUEST;
|
||||
import static org.springframework.http.HttpStatus.CREATED;
|
||||
import static org.springframework.http.HttpStatus.UNPROCESSABLE_ENTITY;
|
||||
import static org.testng.Assert.assertFalse;
|
||||
import static org.testng.Assert.assertTrue;
|
||||
|
||||
import org.alfresco.rest.rm.community.base.BaseRestTest;
|
||||
import org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponent;
|
||||
import org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentProperties;
|
||||
import org.alfresco.rest.rm.community.requests.FilePlanComponentAPI;
|
||||
import org.alfresco.utility.data.DataUser;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.testng.annotations.DataProvider;
|
||||
import org.testng.annotations.Test;
|
||||
|
||||
/**
|
||||
* Create/File electronic records tests
|
||||
* <br>
|
||||
* These tests only test the creation and filing of electronic records, update at
|
||||
* present isn't implemented in the API under test.
|
||||
* <p>
|
||||
* @author Kristijan Conkas
|
||||
* @since 2.6
|
||||
*/
|
||||
public class ElectronicRecordTests extends BaseRestTest
|
||||
{
|
||||
@Autowired
|
||||
private FilePlanComponentAPI filePlanComponentAPI;
|
||||
|
||||
@Autowired
|
||||
private DataUser dataUser;
|
||||
|
||||
/** image resource file to be used for records body */
|
||||
private static final String IMAGE_FILE = "money.JPG";
|
||||
|
||||
/** Valid root containers where electronic records can be created */
|
||||
@DataProvider(name = "invalidParentContainers")
|
||||
public Object[][] invalidContainers() throws Exception {
|
||||
return new Object[][] {
|
||||
// record category
|
||||
{ getFilePlanComponentAsUser(dataUser.getAdminUser(),
|
||||
createCategoryFolderInFilePlan(dataUser.getAdminUser(), FILE_PLAN_ALIAS.toString()).getParentId()) },
|
||||
// file plan root
|
||||
{ getFilePlanComponentAsUser(dataUser.getAdminUser(), FILE_PLAN_ALIAS.toString()) },
|
||||
// transfers
|
||||
{ getFilePlanComponentAsUser(dataUser.getAdminUser(), TRANSFERS_ALIAS.toString()) },
|
||||
// holds
|
||||
{ getFilePlanComponentAsUser(dataUser.getAdminUser(), HOLDS_ALIAS.toString()) },
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* <pre>
|
||||
* Given a parent container that is NOT a record folder or an unfiled record folder
|
||||
* When I try to create an electronic record within the parent container
|
||||
* Then nothing happens
|
||||
* And an error is reported
|
||||
* </pre>
|
||||
* @param container
|
||||
* @throws Exception
|
||||
*/
|
||||
@Test
|
||||
(
|
||||
dataProvider = "invalidParentContainers",
|
||||
description = "Electronic records can't be created in invalid parent containers"
|
||||
)
|
||||
public void cantCreateElectronicRecordsInInvalidContainers(FilePlanComponent container) throws Exception
|
||||
{
|
||||
filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
||||
|
||||
FilePlanComponent record = new FilePlanComponent("Record " + getRandomAlphanumeric(), CONTENT_TYPE.toString(),
|
||||
new FilePlanComponentProperties());
|
||||
filePlanComponentAPI.createElectronicRecord(record, IMAGE_FILE, container.getId());
|
||||
|
||||
// verify the create request status code
|
||||
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(UNPROCESSABLE_ENTITY);
|
||||
}
|
||||
|
||||
/**
|
||||
* <pre>
|
||||
* Given a parent container that is a record folder
|
||||
* And the record folder is closed
|
||||
* When I try to create an electronic record within the parent container
|
||||
* Then nothing happens
|
||||
* And an error is reported
|
||||
* </pre>
|
||||
* @throws Exception
|
||||
*/
|
||||
@Test(description = "Electronic record can't be created in closed record folder")
|
||||
public void cantCreateElectronicRecordInClosedFolder() throws Exception
|
||||
{
|
||||
filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
||||
FilePlanComponent recordFolder = createCategoryFolderInFilePlan(dataUser.getAdminUser(), FILE_PLAN_ALIAS.toString());
|
||||
|
||||
// the folder should be open
|
||||
assertFalse(recordFolder.getProperties().getIsClosed());
|
||||
|
||||
// close the folder
|
||||
closeFolder(recordFolder.getId());
|
||||
|
||||
// try to create it, this should fail
|
||||
FilePlanComponent record = new FilePlanComponent("Record " + getRandomAlphanumeric(), CONTENT_TYPE.toString(),
|
||||
new FilePlanComponentProperties());
|
||||
filePlanComponentAPI.createElectronicRecord(record, IMAGE_FILE, recordFolder.getId());
|
||||
|
||||
// verify the status code
|
||||
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(UNPROCESSABLE_ENTITY);
|
||||
}
|
||||
|
||||
/**
|
||||
* <pre>
|
||||
* Given a parent container that is a record folder
|
||||
* And the record folder is open
|
||||
* When I try to create an electronic record within the parent container
|
||||
* And I do not provide all the required mandatory property values
|
||||
* Then nothing happens
|
||||
* And an error is reported
|
||||
* </pre>
|
||||
* and
|
||||
* <pre>
|
||||
* Given a parent container that is an unfiled record folder or the root unfiled record container
|
||||
* When I try to create an electronic record within the parent container
|
||||
* And I do not provide all the required mandatory property values
|
||||
* Then nothing happens
|
||||
* And an error is reported
|
||||
* </pre>
|
||||
* @param container
|
||||
* @throws Exception
|
||||
*/
|
||||
@Test
|
||||
(
|
||||
dataProvider = "validRootContainers",
|
||||
description = "Electronic record can only be created if all mandatory properties are given"
|
||||
)
|
||||
public void canCreateElectronicRecordOnlyWithMandatoryProperties(FilePlanComponent container) throws Exception
|
||||
{
|
||||
filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
||||
|
||||
logger.info("Root container:\n" + toJson(container));
|
||||
if (container.getNodeType().equals(RECORD_FOLDER_TYPE.toString()))
|
||||
{
|
||||
// only record folders can be open or closed
|
||||
assertFalse(container.getProperties().getIsClosed());
|
||||
}
|
||||
|
||||
// component without name
|
||||
FilePlanComponent record = new FilePlanComponent();
|
||||
record.setNodeType(CONTENT_TYPE.toString());
|
||||
record.setProperties(new FilePlanComponentProperties());
|
||||
|
||||
// try to create it
|
||||
filePlanComponentAPI.createFilePlanComponent(record, container.getId());
|
||||
|
||||
// verify the status code is BAD_REQUEST
|
||||
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(BAD_REQUEST);
|
||||
}
|
||||
|
||||
/**
|
||||
* <pre>
|
||||
* Given a parent container that is a record folder
|
||||
* And the record folder is open
|
||||
* When I try to create an electronic record within the parent container
|
||||
* Then the electronic record is created
|
||||
* And the details of the new record are returned
|
||||
* </pre>
|
||||
* and
|
||||
* <pre>
|
||||
* Given a parent container that is an unfiled record folder or the root unfiled record container
|
||||
* When I try to create an electronic record within the parent container
|
||||
* Then the electronic record is created
|
||||
* And the details of the new record are returned
|
||||
* </pre>
|
||||
* @throws Exception
|
||||
*/
|
||||
@Test
|
||||
(
|
||||
dataProvider = "validRootContainers",
|
||||
description = "Electronic records can be created in unfiled record folder or unfiled record root"
|
||||
)
|
||||
public void canCreateElectronicRecordsInValidContainers(FilePlanComponent container) throws Exception
|
||||
{
|
||||
filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
||||
|
||||
FilePlanComponent record = new FilePlanComponent("Record " + getRandomAlphanumeric(), CONTENT_TYPE.toString(),
|
||||
new FilePlanComponentProperties());
|
||||
String newRecordId = filePlanComponentAPI.createElectronicRecord(record, IMAGE_FILE, container.getId()).getId();
|
||||
|
||||
// verify the create request status code
|
||||
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(CREATED);
|
||||
|
||||
// get newly created electonic record and verify its properties
|
||||
FilePlanComponent electronicRecord = filePlanComponentAPI.getFilePlanComponent(newRecordId);
|
||||
// record will have record identifier inserted in its name but will for sure start with file name
|
||||
// and end with its extension
|
||||
assertTrue(electronicRecord.getName().startsWith(IMAGE_FILE.substring(0, IMAGE_FILE.indexOf("."))));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,384 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Records Management Module
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2016 Alfresco Software Limited
|
||||
* %%
|
||||
* This file is part of the Alfresco software.
|
||||
* -
|
||||
* If the software was purchased under a paid Alfresco license, the terms of
|
||||
* the paid license agreement will prevail. Otherwise, the software is
|
||||
* provided under the following open source license terms:
|
||||
* -
|
||||
* 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/>.
|
||||
* #L%
|
||||
*/
|
||||
package org.alfresco.rest.rm.community.fileplancomponents;
|
||||
|
||||
import static java.util.Arrays.asList;
|
||||
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAlias.FILE_PLAN_ALIAS;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAlias.HOLDS_ALIAS;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAlias.TRANSFERS_ALIAS;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType.NON_ELECTRONIC_RECORD_TYPE;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType.RECORD_CATEGORY_TYPE;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType.RECORD_FOLDER_TYPE;
|
||||
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
|
||||
import static org.alfresco.utility.data.RandomData.getRandomAlphanumeric;
|
||||
import static org.springframework.http.HttpStatus.BAD_REQUEST;
|
||||
import static org.springframework.http.HttpStatus.CREATED;
|
||||
import static org.springframework.http.HttpStatus.FORBIDDEN;
|
||||
import static org.springframework.http.HttpStatus.UNPROCESSABLE_ENTITY;
|
||||
import static org.testng.Assert.assertEquals;
|
||||
import static org.testng.Assert.assertFalse;
|
||||
|
||||
import java.util.Random;
|
||||
|
||||
import org.alfresco.rest.rm.community.base.BaseRestTest;
|
||||
import org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponent;
|
||||
import org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentProperties;
|
||||
import org.alfresco.rest.rm.community.requests.FilePlanComponentAPI;
|
||||
import org.alfresco.rest.rm.community.requests.RMSiteAPI;
|
||||
import org.alfresco.utility.constants.UserRole;
|
||||
import org.alfresco.utility.data.DataUser;
|
||||
import org.alfresco.utility.model.SiteModel;
|
||||
import org.alfresco.utility.model.UserModel;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.testng.annotations.Test;
|
||||
|
||||
/**
|
||||
* Create/File Non-Electronic Record into Unfiled Record Container/Record Folder ReST API tests
|
||||
*
|
||||
* @author Kristijan Conkas
|
||||
* @since 2.6
|
||||
*/
|
||||
public class NonElectronicRecordTests extends BaseRestTest
|
||||
{
|
||||
@Autowired
|
||||
private FilePlanComponentAPI filePlanComponentAPI;
|
||||
|
||||
@Autowired
|
||||
private DataUser dataUser;
|
||||
|
||||
@Autowired
|
||||
private RMSiteAPI rmSiteAPI;
|
||||
|
||||
/**
|
||||
* <pre>
|
||||
* Given a parent container that is NOT a record folder or an unfiled record folder
|
||||
* When I try to create a non-electronic record within the parent container
|
||||
* Then nothing happens
|
||||
* And an error is reported
|
||||
* </pre>
|
||||
* @throws Exception if prerequisites can't be created
|
||||
*/
|
||||
@Test(description = "Non-electronic record can't be created as a child of invalid parent Id")
|
||||
public void cantCreateForInvalidParentIds() throws Exception
|
||||
{
|
||||
filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
||||
|
||||
// non-electronic record object to be used for create tests
|
||||
FilePlanComponent nonElectronicRecord = new FilePlanComponent(
|
||||
"Record " + getRandomAlphanumeric(),
|
||||
NON_ELECTRONIC_RECORD_TYPE.toString(),
|
||||
new FilePlanComponentProperties());
|
||||
|
||||
// create record category, non-electronic records can't be its children
|
||||
FilePlanComponent recordCategory = filePlanComponentAPI.createFilePlanComponent(
|
||||
new FilePlanComponent("Category " + getRandomAlphanumeric(),
|
||||
RECORD_CATEGORY_TYPE.toString(),
|
||||
new FilePlanComponentProperties()),
|
||||
FILE_PLAN_ALIAS.toString());
|
||||
|
||||
// iterate through all invalid parent containers and try to create/file an electronic record
|
||||
asList(FILE_PLAN_ALIAS.toString(), TRANSFERS_ALIAS.toString(), HOLDS_ALIAS.toString(), recordCategory.getId())
|
||||
.stream()
|
||||
.forEach(id ->
|
||||
{
|
||||
try
|
||||
{
|
||||
filePlanComponentAPI.createFilePlanComponent(nonElectronicRecord, id);
|
||||
}
|
||||
catch (Exception error)
|
||||
{
|
||||
}
|
||||
|
||||
// Verify the status code
|
||||
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(UNPROCESSABLE_ENTITY);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* <pre>
|
||||
* Given a parent container that is a record folder
|
||||
* And the record folder is open
|
||||
* When I try to create a non-electronic record within the parent container
|
||||
* Then the non-electronic record is created
|
||||
* And the details of the new record are returned
|
||||
* <pre>
|
||||
* and
|
||||
* <pre>
|
||||
* Given a parent container that is an unfiled record folder or the root unfiled record container
|
||||
* When I try to create a non-electronic record within the parent container
|
||||
* Then the non-electronic record is created
|
||||
* And the details of the new record are returned
|
||||
* </pre>
|
||||
* @throws Exception if record can't be created
|
||||
*/
|
||||
@Test
|
||||
(
|
||||
dataProvider = "validRootContainers",
|
||||
description = "Non-electronic records can be created in valid containers"
|
||||
)
|
||||
public void canCreateInValidContainers(FilePlanComponent container) throws Exception
|
||||
{
|
||||
filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
||||
|
||||
logger.info("Root container:\n" + toJson(container));
|
||||
if (container.getNodeType().equals(RECORD_FOLDER_TYPE.toString()))
|
||||
{
|
||||
// only record folders can be open or closed
|
||||
assertFalse(container.getProperties().getIsClosed());
|
||||
}
|
||||
|
||||
// use these properties for non-electronic record to be created
|
||||
String title = "Title " + getRandomAlphanumeric();
|
||||
String description = "Description " + getRandomAlphanumeric();
|
||||
String box = "Box "+ getRandomAlphanumeric();
|
||||
String file = "File " + getRandomAlphanumeric();
|
||||
String shelf = "Shelf " + getRandomAlphanumeric();
|
||||
String location = "Location " + getRandomAlphanumeric();
|
||||
|
||||
Random random = new Random();
|
||||
Integer copies = random.nextInt(Integer.MAX_VALUE);
|
||||
Integer size = random.nextInt(Integer.MAX_VALUE);
|
||||
|
||||
// set values of all available properties
|
||||
FilePlanComponentProperties properties = new FilePlanComponentProperties(title, description);
|
||||
properties.setBox(box);
|
||||
properties.setFile(file);
|
||||
properties.setShelf(shelf);
|
||||
properties.setLocation(location);
|
||||
properties.setNumberOfCopies(copies);
|
||||
properties.setPhysicalSize(size);
|
||||
|
||||
// create non-electronic record
|
||||
String nonElectronicId = filePlanComponentAPI.createFilePlanComponent(
|
||||
new FilePlanComponent("Record " + getRandomAlphanumeric(),
|
||||
NON_ELECTRONIC_RECORD_TYPE.toString(),
|
||||
properties),
|
||||
container.getId()).getId();
|
||||
|
||||
// verify the create request status code
|
||||
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(CREATED);
|
||||
|
||||
// get newly created non-electonic record and verify its properties
|
||||
FilePlanComponent nonElectronicRecord = filePlanComponentAPI.getFilePlanComponent(nonElectronicId);
|
||||
|
||||
assertEquals(title, nonElectronicRecord.getProperties().getTitle());
|
||||
assertEquals(description, nonElectronicRecord.getProperties().getDescription());
|
||||
assertEquals(box, nonElectronicRecord.getProperties().getBox());
|
||||
assertEquals(file, nonElectronicRecord.getProperties().getFile());
|
||||
assertEquals(shelf, nonElectronicRecord.getProperties().getShelf());
|
||||
assertEquals(location, nonElectronicRecord.getProperties().getLocation());
|
||||
assertEquals(copies, nonElectronicRecord.getProperties().getNumberOfCopies());
|
||||
assertEquals(size, nonElectronicRecord.getProperties().getPhysicalSize());
|
||||
}
|
||||
|
||||
/**
|
||||
* <pre>
|
||||
* Given a parent container that is a record folder
|
||||
* And the record folder is closed
|
||||
* When I try to create a non-electronic record within the parent container
|
||||
* Then nothing happens
|
||||
* And an error is reported
|
||||
* </pre>
|
||||
* @throws Exception if prerequisites can't be created
|
||||
*/
|
||||
@Test(description = "Non-electronic record can't be created in closed record folder")
|
||||
public void cantCreateInClosedFolder() throws Exception
|
||||
{
|
||||
filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
||||
FilePlanComponent recordFolder = createCategoryFolderInFilePlan(dataUser.getAdminUser(), FILE_PLAN_ALIAS.toString());
|
||||
|
||||
// the folder should be open
|
||||
assertFalse(recordFolder.getProperties().getIsClosed());
|
||||
|
||||
// close the folder
|
||||
closeFolder(recordFolder.getId());
|
||||
|
||||
// try to create it, this should fail and throw an exception
|
||||
|
||||
filePlanComponentAPI.createFilePlanComponent(
|
||||
new FilePlanComponent("Record " + getRandomAlphanumeric(),
|
||||
NON_ELECTRONIC_RECORD_TYPE.toString(),
|
||||
new FilePlanComponentProperties()),
|
||||
recordFolder.getId()).getId();
|
||||
|
||||
// verify the status code
|
||||
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(UNPROCESSABLE_ENTITY);
|
||||
}
|
||||
|
||||
/**
|
||||
* <pre>
|
||||
* Given a parent container that is a record folder
|
||||
* And the record folder is open
|
||||
* When I try to create a non-electronic record within the parent container
|
||||
* And I do not provide all the required mandatory property values
|
||||
* Then nothing happens
|
||||
* And an error is reported
|
||||
* </pre>
|
||||
* and
|
||||
* <pre>
|
||||
* Given a parent container that is an unfiled record folder or the root unfiled record container
|
||||
* When I try to create a non-electronic record within the parent container
|
||||
* And I do not provide all the required mandatory property values
|
||||
* Then nothing happens
|
||||
* And an error is reported
|
||||
* </pre>
|
||||
* @throws Exception if prerequisites can't be created
|
||||
*/
|
||||
@Test
|
||||
(
|
||||
dataProvider = "validRootContainers",
|
||||
description = "Non-electronic record can only be created if all mandatory properties are given"
|
||||
)
|
||||
public void allMandatoryPropertiesRequired(FilePlanComponent container) throws Exception
|
||||
{
|
||||
filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
||||
|
||||
logger.info("Root container:\n" + toJson(container));
|
||||
if (container.getNodeType().equals(RECORD_FOLDER_TYPE.toString()))
|
||||
{
|
||||
// only record folders can be open or closed
|
||||
assertFalse(container.getProperties().getIsClosed());
|
||||
}
|
||||
|
||||
// component without name and title
|
||||
FilePlanComponent noNameOrTitle = getDummyNonElectronicRecord();
|
||||
|
||||
// component with title only
|
||||
FilePlanComponent titleOnly = getDummyNonElectronicRecord();
|
||||
FilePlanComponentProperties properties = new FilePlanComponentProperties();
|
||||
properties.setTitle("Title " + getRandomAlphanumeric());
|
||||
titleOnly.setProperties(properties);
|
||||
|
||||
// try to create invalid components
|
||||
asList(noNameOrTitle, titleOnly).stream().forEach(c ->
|
||||
{
|
||||
try
|
||||
{
|
||||
logger.info("Creating non-electronic record with body:\n" + toJson(c));
|
||||
}
|
||||
catch (Exception error)
|
||||
{
|
||||
}
|
||||
|
||||
// this should fail and throw an exception
|
||||
try
|
||||
{
|
||||
filePlanComponentAPI.createFilePlanComponent(c, container.getId());
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
}
|
||||
|
||||
// verify the status code is BAD_REQUEST
|
||||
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(BAD_REQUEST);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* <pre>
|
||||
* Given that I am a user without RM privileges
|
||||
* When I try to create a non-electronic record
|
||||
* Then nothing happens
|
||||
* And an error is reported
|
||||
* </pre>
|
||||
* @throws Exception
|
||||
*/
|
||||
@Test
|
||||
(
|
||||
dataProvider = "validRootContainers",
|
||||
description = "Non-electronic record can't be created if user doesn't have RM privileges"
|
||||
)
|
||||
public void cantCreateIfNoRmPrivileges(FilePlanComponent container) throws Exception
|
||||
{
|
||||
String username = "zzzuser";
|
||||
UserModel user = createUserWithRole(username, UserRole.SiteManager);
|
||||
|
||||
filePlanComponentAPI.usingRestWrapper().authenticateUser(user);
|
||||
|
||||
// try to create a fileplan component
|
||||
FilePlanComponent record = new FilePlanComponent("Record Name", NON_ELECTRONIC_RECORD_TYPE.toString(),
|
||||
new FilePlanComponentProperties("Name", "Title"));
|
||||
|
||||
// this should fail and throw an exception
|
||||
try
|
||||
{
|
||||
filePlanComponentAPI.createFilePlanComponent(record, container.getId());
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
}
|
||||
|
||||
// user who isn't an RM site member can't access the container path
|
||||
filePlanComponentAPI.usingRestWrapper().assertStatusCodeIs(FORBIDDEN);
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper function to return an empty FilePlanComponent for non-electronic record
|
||||
* @return
|
||||
*/
|
||||
private FilePlanComponent getDummyNonElectronicRecord()
|
||||
{
|
||||
FilePlanComponent component = new FilePlanComponent();
|
||||
component.setNodeType(NON_ELECTRONIC_RECORD_TYPE.toString());
|
||||
return component;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create user with given role and add it to RM site
|
||||
* <br>
|
||||
* Checks whether the user exists in RM site and creates it if required, with password identical
|
||||
* to username. Note the role is a Core API role, not an RM role.
|
||||
* <br>
|
||||
* For already existing users, no site membership or role verification is performed.
|
||||
* <p>
|
||||
* @param userName username to add
|
||||
* @param userRole user's role
|
||||
* @throws Exception
|
||||
*/
|
||||
private UserModel createUserWithRole(String userName, UserRole userRole) throws Exception
|
||||
{
|
||||
rmSiteAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
||||
String siteId = rmSiteAPI.getSite().getId();
|
||||
|
||||
// check if user exists
|
||||
UserModel user = new UserModel();
|
||||
user.setUsername(userName);
|
||||
user.setPassword(userName);
|
||||
|
||||
if (!dataUser.isUserInRepo(userName))
|
||||
{
|
||||
// user doesn't exist, create it
|
||||
user = dataUser.createUser(userName, userName);
|
||||
user.setUserRole(userRole);
|
||||
|
||||
dataUser.addUserToSite(user, new SiteModel(siteId), userRole);
|
||||
}
|
||||
|
||||
return user;
|
||||
}
|
||||
}
|
||||
@@ -100,7 +100,7 @@ public class UnfiledRecordsFolderTests extends BaseRestTest
|
||||
public void createRootUnfiledRecordsFolder() throws Exception
|
||||
{
|
||||
// Authenticate with admin user
|
||||
RestWrapper restWrapper = filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
||||
filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
||||
|
||||
String folderName = "Folder " + getRandomAlphanumeric();
|
||||
String folderTitle = folderName + " Title";
|
||||
@@ -148,7 +148,7 @@ public class UnfiledRecordsFolderTests extends BaseRestTest
|
||||
)
|
||||
public void onlyRecordFoldersCanBeCreatedAtUnfiledRecordsRoot(FilePlanComponentType componentType)
|
||||
{
|
||||
RestWrapper restWrapper = filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
||||
filePlanComponentAPI.usingRestWrapper().authenticateUser(dataUser.getAdminUser());
|
||||
|
||||
String folderName = "Folder " + getRandomAlphanumeric();
|
||||
String folderTitle = folderName + " Title";
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 528 KiB |
Reference in New Issue
Block a user