mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-31 17:39:05 +00:00
add tests for File Action
This commit is contained in:
Rodica Sutu
@@ -0,0 +1,56 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Records Management Module
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2017 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.model.fileplancomponents;
|
||||
|
||||
import com.fasterxml.jackson.annotation.JsonProperty;
|
||||
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Builder;
|
||||
import lombok.Data;
|
||||
import lombok.EqualsAndHashCode;
|
||||
import lombok.NoArgsConstructor;
|
||||
import org.alfresco.utility.model.TestModel;
|
||||
|
||||
/**
|
||||
* POJO for File records
|
||||
*
|
||||
* @author Rodica Sutu
|
||||
* @since 2.6
|
||||
*/
|
||||
@Builder
|
||||
@Data
|
||||
@EqualsAndHashCode (callSuper = true)
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
public class RecordBodyFile extends TestModel
|
||||
{
|
||||
@JsonProperty
|
||||
private String targetParentId;
|
||||
|
||||
@JsonProperty
|
||||
private String relativePath;
|
||||
}
|
||||
@@ -28,13 +28,20 @@ package org.alfresco.rest.rm.community.requests.igCoreAPI;
|
||||
|
||||
import static com.jayway.restassured.RestAssured.given;
|
||||
|
||||
import static org.alfresco.rest.core.RestRequest.requestWithBody;
|
||||
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryObject;
|
||||
import static org.alfresco.rest.rm.community.util.ParameterCheck.mandatoryString;
|
||||
import static org.alfresco.rest.rm.community.util.PojoUtility.toJson;
|
||||
import static org.apache.commons.lang3.StringUtils.EMPTY;
|
||||
import static org.springframework.http.HttpMethod.POST;
|
||||
|
||||
import com.jayway.restassured.response.Response;
|
||||
|
||||
import org.alfresco.rest.core.RMRestWrapper;
|
||||
import org.alfresco.rest.core.RestRequest;
|
||||
import org.alfresco.rest.model.RestHtmlResponse;
|
||||
import org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponent;
|
||||
import org.alfresco.rest.rm.community.model.fileplancomponents.RecordBodyFile;
|
||||
import org.alfresco.rest.rm.community.requests.RMModelRequest;
|
||||
import org.springframework.context.annotation.Scope;
|
||||
import org.springframework.http.HttpMethod;
|
||||
@@ -84,7 +91,7 @@ public class RecordsAPI extends RMModelRequest
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the html content for the electronic record
|
||||
* Get the html response for the electronic record
|
||||
*
|
||||
* @param recordId The id of the electronic record
|
||||
* @return The content for the given record id
|
||||
@@ -102,4 +109,61 @@ public class RecordsAPI extends RMModelRequest
|
||||
RestRequest request = RestRequest.simpleRequest(HttpMethod.GET, "records/{recordId}/content", recordId);
|
||||
return getRMRestWrapper().processHtmlResponse(request);
|
||||
}
|
||||
|
||||
/**
|
||||
* File the record recordId into file plan structure based on the location sent via the request body
|
||||
*
|
||||
* @param recordBodyFile The properties where to file the record
|
||||
* @param recordId The id of the record to file
|
||||
* @return The {@link FilePlanComponent} with the given properties
|
||||
* @throws Exception for the following cases:
|
||||
* <ul>
|
||||
* <li>{@code fileplanComponentId} is not a valid format</li>
|
||||
* <li>authentication fails</li>
|
||||
* <li>current user does not have permission to add children to {@code fileplanComponentId}</li>
|
||||
* <li>{@code fileplanComponentId} does not exist</li>
|
||||
* <li>new name clashes with an existing node in the current parent container</li>
|
||||
* <li>model integrity exception, including node name with invalid characters</li>
|
||||
* </ul>
|
||||
*/
|
||||
public FilePlanComponent fileRecord(RecordBodyFile recordBodyFile, String recordId) throws Exception
|
||||
{
|
||||
mandatoryObject("recordBodyFile", recordBodyFile);
|
||||
mandatoryString("recordId", recordId);
|
||||
|
||||
return fileRecord(recordBodyFile, recordId, EMPTY);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a file plan component with the given properties under the parent node with the given id
|
||||
*
|
||||
* @param filePlanComponentModel The properties of the file plan component to be created
|
||||
* @param parameters The URL parameters to add
|
||||
* @param parentId The id of the parent where the new file plan component should be created
|
||||
* @return The {@link FilePlanComponent} with the given properties
|
||||
* @throws Exception for the following cases:
|
||||
* <ul>
|
||||
* <li>{@code fileplanComponentId} is not a valid format</li>
|
||||
* <li>authentication fails</li>
|
||||
* <li>current user does not have permission to add children to {@code fileplanComponentId}</li>
|
||||
* <li>{@code fileplanComponentId} does not exist</li>
|
||||
* <li>new name clashes with an existing node in the current parent container</li>
|
||||
* <li>model integrity exception, including node name with invalid characters</li>
|
||||
* </ul>
|
||||
*/
|
||||
public FilePlanComponent fileRecord(RecordBodyFile recordBodyFile, String recordId, String parameters) throws Exception
|
||||
{
|
||||
mandatoryObject("requestBodyFile", recordBodyFile);
|
||||
mandatoryString("recordId", recordId);
|
||||
|
||||
return getRMRestWrapper().processModel(FilePlanComponent.class, requestWithBody(
|
||||
POST,
|
||||
toJson(recordBodyFile),
|
||||
"/records/{recordId}/file?{parameters}",
|
||||
recordId,
|
||||
parameters
|
||||
));
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
@@ -110,16 +110,23 @@ public interface TestData
|
||||
public static String CATEGORY_TITLE = "CATEGORY TITLE" + getRandomAlphanumeric();
|
||||
|
||||
/**
|
||||
* The default FOLDER name used when creating categories
|
||||
* The default FOLDER name used when creating folders
|
||||
*/
|
||||
public static String FOLDER_NAME = "FOLDER NAME" + getRandomAlphanumeric();
|
||||
|
||||
/**
|
||||
* The default FOLDER title used when creating categories
|
||||
* The default FOLDER title used when creating folders
|
||||
*/
|
||||
public static String FOLDER_TITLE = "FOLDER TITLE" + getRandomAlphanumeric();
|
||||
|
||||
|
||||
/**
|
||||
* The default electronic record name used when creating electronic records
|
||||
*/
|
||||
public static String ELECTRONIC_RECORD_NAME = "Record electronic" + getRandomAlphanumeric();
|
||||
/**
|
||||
* The default Non electronic record name used when creating non-electronic records
|
||||
*/
|
||||
public static String NONELECTRONIC_RECORD_NAME = "Record nonelectronic" + getRandomAlphanumeric();
|
||||
/**
|
||||
* Data Provider with:
|
||||
* with the object types not allowed as children for a record category
|
||||
|
||||
@@ -0,0 +1,223 @@
|
||||
package org.alfresco.rest.rm.community.fileplancomponents;
|
||||
|
||||
import static org.alfresco.rest.rm.community.base.TestData.ELECTRONIC_RECORD_NAME;
|
||||
import static org.alfresco.rest.rm.community.base.TestData.NONELECTRONIC_RECORD_NAME;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAlias.UNFILED_RECORDS_CONTAINER_ALIAS;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType.CONTENT_TYPE;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentType.NON_ELECTRONIC_RECORD_TYPE;
|
||||
import static org.springframework.http.HttpStatus.CREATED;
|
||||
import static org.springframework.http.HttpStatus.FORBIDDEN;
|
||||
import static org.testng.Assert.assertEquals;
|
||||
import static org.testng.Assert.assertFalse;
|
||||
import static org.testng.AssertJUnit.assertTrue;
|
||||
|
||||
import org.alfresco.rest.rm.community.base.BaseRMRestTest;
|
||||
import org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponent;
|
||||
import org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentContent;
|
||||
import org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentProperties;
|
||||
import org.alfresco.rest.rm.community.model.fileplancomponents.RecordBodyFile;
|
||||
import org.testng.annotations.Test;
|
||||
|
||||
/**
|
||||
* This class contains the tests for
|
||||
* File Unfiled Record Action REST API
|
||||
*
|
||||
* @author Rodica Sutu
|
||||
* @since 2.6
|
||||
*/
|
||||
public class FileRecordsTests extends BaseRMRestTest
|
||||
{
|
||||
private FilePlanComponent electronicRecord = FilePlanComponent.builder()
|
||||
.name(ELECTRONIC_RECORD_NAME)
|
||||
.nodeType(CONTENT_TYPE.toString())
|
||||
.content(FilePlanComponentContent.builder().mimeType("text/plain").build())
|
||||
.build();
|
||||
|
||||
private FilePlanComponent nonelectronicRecord = FilePlanComponent.builder()
|
||||
.properties(FilePlanComponentProperties.builder()
|
||||
.description(NONELECTRONIC_RECORD_NAME)
|
||||
.title("Title")
|
||||
.build())
|
||||
.name(NONELECTRONIC_RECORD_NAME)
|
||||
.nodeType(NON_ELECTRONIC_RECORD_TYPE.toString())
|
||||
.build();
|
||||
/**
|
||||
* Given an unfiled record in the root unfiled record container or a unfiled record folder
|
||||
* And an open record folder
|
||||
* When I file the unfiled record into the record folder
|
||||
* Then the record is filed
|
||||
*/
|
||||
@Test
|
||||
public void fileRecordIntoExistingFolder() throws Exception
|
||||
{
|
||||
//create a record folder
|
||||
String folderId = createCategoryFolderInFilePlan().getId();
|
||||
|
||||
//create records
|
||||
FilePlanComponent recordElectronic = getRestAPIFactory().getFilePlanComponentsAPI().createElectronicRecord(electronicRecord, createTempFile(ELECTRONIC_RECORD_NAME, ELECTRONIC_RECORD_NAME), UNFILED_RECORDS_CONTAINER_ALIAS);
|
||||
FilePlanComponent recordNonElectId = getRestAPIFactory().getFilePlanComponentsAPI().createFilePlanComponent(nonelectronicRecord, UNFILED_RECORDS_CONTAINER_ALIAS);
|
||||
|
||||
//file the record into the folder created
|
||||
RecordBodyFile recordBodyFile = RecordBodyFile.builder().targetParentId(folderId).build();
|
||||
FilePlanComponent recordFiled =getRestAPIFactory().getRecordsAPI().fileRecord(recordBodyFile, recordElectronic.getId());
|
||||
//check the response status
|
||||
assertStatusCode(CREATED);
|
||||
//check the parent id for the record returned
|
||||
assertEquals(recordFiled.getParentId(),folderId);
|
||||
//check the record is filed into the record folder
|
||||
assertTrue(getRestAPIFactory().getFilePlanComponentsAPI().listChildComponents(folderId)
|
||||
.getEntries().stream()
|
||||
.anyMatch(c->c.getFilePlanComponentModel().getId()
|
||||
.equals(recordElectronic.getId())
|
||||
)
|
||||
);
|
||||
//check the record doesn't exist into unfiled record container
|
||||
assertFalse(getRestAPIFactory().getFilePlanComponentsAPI().listChildComponents(UNFILED_RECORDS_CONTAINER_ALIAS)
|
||||
.getEntries().stream()
|
||||
.anyMatch(c -> c.getFilePlanComponentModel().getId()
|
||||
.equals(recordElectronic.getId())
|
||||
)
|
||||
);
|
||||
//file the non-electronic record into the folder created
|
||||
FilePlanComponent nonElectRecordFiled = getRestAPIFactory().getRecordsAPI().fileRecord(recordBodyFile, recordNonElectId.getId());
|
||||
//check the response status code
|
||||
assertStatusCode(CREATED);
|
||||
//check the parent id for the record returned
|
||||
assertEquals(nonElectRecordFiled.getParentId(), folderId);
|
||||
//check the record is added into the record folder
|
||||
assertTrue(getRestAPIFactory().getFilePlanComponentsAPI().listChildComponents(folderId)
|
||||
.getEntries().stream()
|
||||
.anyMatch(c -> c.getFilePlanComponentModel().getId()
|
||||
.equals(recordNonElectId.getId())
|
||||
)
|
||||
);
|
||||
//check the record doesn't exist into unfiled record container
|
||||
assertFalse(getRestAPIFactory().getFilePlanComponentsAPI().listChildComponents(UNFILED_RECORDS_CONTAINER_ALIAS)
|
||||
.getEntries().stream()
|
||||
.anyMatch(c -> c.getFilePlanComponentModel().getId()
|
||||
.equals(recordNonElectId.getId())
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Given an unfiled record in the root unfiled record container or a unfiled record folder
|
||||
* And a closed record folder
|
||||
* When I file the unfiled record into the record folder
|
||||
* Then I get an unsupported operation exception
|
||||
*
|
||||
*/
|
||||
@Test
|
||||
public void fileRecordIntoCloseFolder() throws Exception
|
||||
{
|
||||
//create a record folder
|
||||
String folderId = createCategoryFolderInFilePlan().getId();
|
||||
closeFolder(folderId);
|
||||
//create records
|
||||
FilePlanComponent recordElectronic = getRestAPIFactory().getFilePlanComponentsAPI().createElectronicRecord(electronicRecord, createTempFile(ELECTRONIC_RECORD_NAME, ELECTRONIC_RECORD_NAME), UNFILED_RECORDS_CONTAINER_ALIAS);
|
||||
FilePlanComponent recordNonElectId = getRestAPIFactory().getFilePlanComponentsAPI().createFilePlanComponent(nonelectronicRecord, UNFILED_RECORDS_CONTAINER_ALIAS);
|
||||
|
||||
//file the record into the folder created
|
||||
RecordBodyFile recordBodyFile = RecordBodyFile.builder().targetParentId(folderId).build();
|
||||
getRestAPIFactory().getRecordsAPI().fileRecord(recordBodyFile, recordElectronic.getId());
|
||||
//check the response status
|
||||
assertStatusCode(FORBIDDEN);
|
||||
|
||||
//check the record is filed into the record folder
|
||||
assertFalse(getRestAPIFactory().getFilePlanComponentsAPI().listChildComponents(folderId)
|
||||
.getEntries().stream()
|
||||
.anyMatch(c -> c.getFilePlanComponentModel().getId()
|
||||
.equals(recordElectronic.getId())
|
||||
)
|
||||
);
|
||||
//check the record doesn't exist into unfiled record container
|
||||
assertTrue(getRestAPIFactory().getFilePlanComponentsAPI().listChildComponents(UNFILED_RECORDS_CONTAINER_ALIAS)
|
||||
.getEntries().stream()
|
||||
.anyMatch(c -> c.getFilePlanComponentModel().getId()
|
||||
.equals(recordElectronic.getId())
|
||||
)
|
||||
);
|
||||
//file the non-electronic record into the folder created
|
||||
FilePlanComponent nonElectRecordFiled = getRestAPIFactory().getRecordsAPI().fileRecord(recordBodyFile, recordNonElectId.getId());
|
||||
//check the response status code
|
||||
assertStatusCode(FORBIDDEN);
|
||||
//check the record is added into the record folder
|
||||
assertFalse(getRestAPIFactory().getFilePlanComponentsAPI().listChildComponents(folderId)
|
||||
.getEntries().stream()
|
||||
.anyMatch(c -> c.getFilePlanComponentModel().getId()
|
||||
.equals(recordNonElectId.getId())
|
||||
)
|
||||
);
|
||||
//check the record doesn't exist into unfiled record container
|
||||
assertTrue(getRestAPIFactory().getFilePlanComponentsAPI().listChildComponents(UNFILED_RECORDS_CONTAINER_ALIAS)
|
||||
.getEntries().stream()
|
||||
.anyMatch(c -> c.getFilePlanComponentModel().getId()
|
||||
.equals(recordNonElectId.getId())
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a filed record in a record folder
|
||||
* And an open record folder
|
||||
* When I file the filed record into the record folder
|
||||
* Then the record is filed in both locations
|
||||
*/
|
||||
@Test
|
||||
public void linkRecordInto() throws Exception
|
||||
{
|
||||
//create a record folder
|
||||
String parentFolderId = createCategoryFolderInFilePlan().getId();
|
||||
|
||||
//create records
|
||||
FilePlanComponent recordElectronic = getRestAPIFactory().getFilePlanComponentsAPI().createElectronicRecord(electronicRecord, createTempFile(ELECTRONIC_RECORD_NAME, ELECTRONIC_RECORD_NAME), UNFILED_RECORDS_CONTAINER_ALIAS);
|
||||
FilePlanComponent recordNonElect = getRestAPIFactory().getFilePlanComponentsAPI().createFilePlanComponent(nonelectronicRecord, UNFILED_RECORDS_CONTAINER_ALIAS);
|
||||
|
||||
//file the record into the folder created
|
||||
RecordBodyFile recordBodyFile = RecordBodyFile.builder().targetParentId(parentFolderId).build();
|
||||
FilePlanComponent recordFiled = getRestAPIFactory().getRecordsAPI().fileRecord(recordBodyFile, recordElectronic.getId());
|
||||
FilePlanComponent nonElectronicFiled = getRestAPIFactory().getRecordsAPI().fileRecord(recordBodyFile, recordNonElect.getId());
|
||||
//check the response status
|
||||
assertStatusCode(CREATED);
|
||||
|
||||
//create the second folder
|
||||
String folderToLink = createCategoryFolderInFilePlan().getId();
|
||||
recordBodyFile = RecordBodyFile.builder().targetParentId(folderToLink).build();
|
||||
|
||||
//check the response status
|
||||
assertStatusCode(CREATED);
|
||||
//link the electronic record
|
||||
FilePlanComponent recordLink = getRestAPIFactory().getRecordsAPI().fileRecord(recordBodyFile, recordElectronic.getId());
|
||||
assertTrue(recordLink.getParentId().equals(parentFolderId));
|
||||
//check the response status code
|
||||
assertStatusCode(CREATED);
|
||||
//link the nonelectronic record
|
||||
FilePlanComponent nonElectronicLink = getRestAPIFactory().getRecordsAPI().fileRecord(recordBodyFile, recordNonElect.getId());
|
||||
assertStatusCode(CREATED);
|
||||
assertTrue(recordLink.getParentId().equals(parentFolderId));
|
||||
|
||||
//check the record is added into the record folder
|
||||
assertTrue(getRestAPIFactory().getFilePlanComponentsAPI().listChildComponents(parentFolderId)
|
||||
.getEntries().stream()
|
||||
.anyMatch(c -> c.getFilePlanComponentModel().getId()
|
||||
.equals(recordFiled.getId())&& c.getFilePlanComponentModel().getParentId().equals(parentFolderId)
|
||||
)
|
||||
);
|
||||
//check the record doesn't exist into unfiled record container
|
||||
assertTrue(getRestAPIFactory().getFilePlanComponentsAPI().listChildComponents(folderToLink)
|
||||
.getEntries().stream()
|
||||
.anyMatch(c -> c.getFilePlanComponentModel().getId()
|
||||
.equals(recordFiled.getId()) && c.getFilePlanComponentModel().getParentId().equals(parentFolderId)
|
||||
)
|
||||
);
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Given an unfiled or filed record
|
||||
* And a container that is NOT a record folder
|
||||
* When I file the unfiled or filed record to the container
|
||||
* Then I get an unsupported operation exception
|
||||
*/
|
||||
|
||||
}
|
||||
@@ -357,7 +357,8 @@ public class ReadRecordTests extends BaseRMRestTest
|
||||
assertTrue(filePlanComponent.getName().startsWith(createdComponent.getName()));
|
||||
assertEquals(createdComponent.getNodeType(), filePlanComponent.getNodeType());
|
||||
|
||||
} catch (NoSuchElementException e)
|
||||
}
|
||||
catch (NoSuchElementException e)
|
||||
{
|
||||
fail("No child element for " + filePlanComponent.getId());
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user