mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-14 17:58:59 +00:00
d45f80e0c7
129178 mmuller: Merged RETURN-OF-THE-API (5.2.0) to 5.2.N (5.2.1)
128608 jvonka: V1 REST API: cleanup and rationalise new api tests (re: remotable helpers & runAs user / admin) - round 4
REPO-113 (also relates to REPO-28, REPO-114, REPO-825)
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@129352 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
763 lines
29 KiB
Java
763 lines
29 KiB
Java
/*
|
|
* #%L
|
|
* Alfresco Remote API
|
|
* %%
|
|
* 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.api.tests;
|
|
|
|
import static org.alfresco.rest.api.tests.util.RestApiUtil.toJsonAsString;
|
|
import static org.alfresco.rest.api.tests.util.RestApiUtil.toJsonAsStringNonNull;
|
|
import static org.junit.Assert.assertEquals;
|
|
import static org.junit.Assert.assertNotNull;
|
|
import static org.junit.Assert.assertNull;
|
|
import static org.junit.Assert.fail;
|
|
|
|
import org.alfresco.repo.security.authentication.AuthenticationUtil;
|
|
import org.alfresco.repo.tenant.TenantService;
|
|
import org.alfresco.repo.transaction.RetryingTransactionHelper;
|
|
import org.alfresco.rest.api.Nodes;
|
|
import org.alfresco.rest.api.model.Site;
|
|
import org.alfresco.rest.api.nodes.NodesEntityResource;
|
|
import org.alfresco.rest.api.tests.RepoService.TestNetwork;
|
|
import org.alfresco.rest.api.tests.RepoService.TestPerson;
|
|
import org.alfresco.rest.api.tests.client.HttpResponse;
|
|
import org.alfresco.rest.api.tests.client.PublicApiClient;
|
|
import org.alfresco.rest.api.tests.client.PublicApiHttpClient.BinaryPayload;
|
|
import org.alfresco.rest.api.tests.client.PublicApiHttpClient.RequestBuilder;
|
|
import org.alfresco.rest.api.tests.client.RequestContext;
|
|
import org.alfresco.rest.api.tests.client.data.ContentInfo;
|
|
import org.alfresco.rest.api.tests.client.data.Document;
|
|
import org.alfresco.rest.api.tests.client.data.Folder;
|
|
import org.alfresco.rest.api.tests.client.data.Node;
|
|
import org.alfresco.rest.api.tests.client.data.Rendition;
|
|
import org.alfresco.rest.api.tests.client.data.SiteMember;
|
|
import org.alfresco.rest.api.tests.client.data.SiteRole;
|
|
import org.alfresco.rest.api.tests.util.MultiPartBuilder;
|
|
import org.alfresco.rest.api.tests.util.RestApiUtil;
|
|
import org.alfresco.service.cmr.security.MutableAuthenticationService;
|
|
import org.alfresco.service.cmr.security.PersonService;
|
|
import org.alfresco.service.cmr.site.SiteVisibility;
|
|
import org.alfresco.util.TempFileProvider;
|
|
import org.json.simple.JSONObject;
|
|
import org.junit.After;
|
|
import org.junit.Before;
|
|
import org.springframework.util.ResourceUtils;
|
|
|
|
import java.io.ByteArrayInputStream;
|
|
import java.io.File;
|
|
import java.io.FileNotFoundException;
|
|
import java.io.IOException;
|
|
import java.net.URL;
|
|
import java.util.ArrayList;
|
|
import java.util.Collections;
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
|
|
/**
|
|
* Generic methods for calling the Api (originally taken and adapted from BaseCustomModelApiTest)
|
|
*
|
|
* @author Jamal Kaabi-Mofrad
|
|
* @author janv
|
|
* @author gethin
|
|
*/
|
|
public abstract class AbstractBaseApiTest extends EnterpriseTestApi
|
|
{
|
|
public static final String LAST_MODIFIED_HEADER = "Last-Modified";
|
|
public static final String IF_MODIFIED_SINCE_HEADER = "If-Modified-Since";
|
|
|
|
private static final String RESOURCE_PREFIX = "publicapi/upload/";
|
|
|
|
protected static final String URL_NODES = "nodes";
|
|
|
|
private static final String URL_RENDITIONS = "renditions";
|
|
private static final String URL_CHILDREN = "children";
|
|
private static final String URL_CONTENT = "content";
|
|
|
|
protected static final String TYPE_CM_FOLDER = "cm:folder";
|
|
protected static final String TYPE_CM_CONTENT = "cm:content";
|
|
protected static final String TYPE_CM_OBJECT = "cm:cmobject";
|
|
|
|
protected static final String ASPECT_CM_PREFERENCES = "cm:preferences";
|
|
protected static final String ASSOC_TYPE_CM_PREFERENCE_IMAGE = "cm:preferenceImage";
|
|
|
|
protected static final String ASSOC_TYPE_CM_CONTAINS = "cm:contains";
|
|
|
|
// TODO improve admin-related tests, including ability to override default admin un/pw
|
|
protected static final String DEFAULT_ADMIN = "admin";
|
|
private static final String DEFAULT_ADMIN_PWD = "admin";
|
|
|
|
protected TestNetwork networkOne;
|
|
|
|
/**
|
|
* User one from network one
|
|
*/
|
|
protected TestPerson userOneN1;
|
|
|
|
/**
|
|
* User two from network one
|
|
*/
|
|
protected TestPerson userTwoN1;
|
|
protected String userOneN1SiteId;
|
|
|
|
protected String user1;
|
|
protected String user2;
|
|
|
|
protected List<String> users = new ArrayList<>();
|
|
|
|
protected MutableAuthenticationService authenticationService;
|
|
protected PersonService personService;
|
|
|
|
protected final String RUNID = System.currentTimeMillis()+"";
|
|
|
|
|
|
@Before
|
|
public void setup() throws Exception
|
|
{
|
|
// note: createUser currently relies on repoService
|
|
user1 = createUser("user1-" + RUNID, "user1Password", null);
|
|
user2 = createUser("user2-" + RUNID, "user2Password", null);
|
|
|
|
// to enable admin access via test calls - eg. via PublicApiClient -> AbstractTestApi -> findUserByUserName
|
|
getOrCreateUser("admin", "admin");
|
|
|
|
// used-by teardown to cleanup
|
|
authenticationService = applicationContext.getBean("authenticationService", MutableAuthenticationService.class);
|
|
personService = applicationContext.getBean("personService", PersonService.class);
|
|
users.add(user1);
|
|
users.add(user2);
|
|
|
|
// TODO this causes createTestData to be called
|
|
networkOne = getTestFixture().getRandomNetwork();
|
|
userOneN1 = networkOne.createUser();
|
|
userTwoN1 = networkOne.createUser();
|
|
|
|
setRequestContext(networkOne.getId(), userOneN1.getId(), null);
|
|
|
|
userOneN1SiteId = createSite("TestSite A - " + System.currentTimeMillis(), SiteVisibility.PRIVATE).getId();
|
|
|
|
setRequestContext(null);
|
|
}
|
|
|
|
@After
|
|
public void tearDown() throws Exception
|
|
{
|
|
if ((networkOne != null) && (userOneN1 != null) && (userOneN1SiteId != null))
|
|
{
|
|
setRequestContext(networkOne.getId(), userOneN1.getId(), null);
|
|
deleteSite(userOneN1SiteId, 204);
|
|
}
|
|
|
|
AuthenticationUtil.setAdminUserAsFullyAuthenticatedUser();
|
|
for (final String user : users)
|
|
{
|
|
transactionHelper.doInTransaction(new RetryingTransactionHelper.RetryingTransactionCallback<Void>()
|
|
{
|
|
@Override
|
|
public Void execute() throws Throwable
|
|
{
|
|
if (personService.personExists(user))
|
|
{
|
|
authenticationService.deleteAuthentication(user);
|
|
personService.deletePerson(user);
|
|
}
|
|
return null;
|
|
}
|
|
});
|
|
}
|
|
users.clear();
|
|
AuthenticationUtil.clearCurrentSecurityContext();
|
|
}
|
|
|
|
/**
|
|
* The api scope. either public or private
|
|
*
|
|
* @return public or private
|
|
*/
|
|
public abstract String getScope();
|
|
|
|
protected HttpResponse post(String url, String body, int expectedStatus) throws Exception
|
|
{
|
|
HttpResponse response = publicApiClient.post(getScope(), url, null, null, null, body);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
|
|
return response;
|
|
}
|
|
|
|
protected HttpResponse post(String url, String body, Map<String, String> params, Map<String, String> headers, String apiName, int expectedStatus) throws Exception
|
|
{
|
|
RequestBuilder requestBuilder = httpClient.new PostRequestBuilder()
|
|
.setBodyAsString(body)
|
|
.setRequestContext(publicApiClient.getRequestContext())
|
|
.setScope(getScope())
|
|
.setApiName(apiName)
|
|
.setEntityCollectionName(url)
|
|
.setHeaders(headers)
|
|
.setParams(params);
|
|
HttpResponse response = publicApiClient.execute(requestBuilder);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
|
|
return response;
|
|
}
|
|
|
|
protected HttpResponse post(String url, String body, String queryString, int expectedStatus) throws Exception
|
|
{
|
|
if (queryString != null)
|
|
{
|
|
url += queryString;
|
|
}
|
|
HttpResponse response = publicApiClient.post(getScope(), url, null, null, null, body);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
|
|
return response;
|
|
}
|
|
|
|
protected HttpResponse post(String url, String body, String queryString, String contentType, int expectedStatus) throws Exception
|
|
{
|
|
if (queryString != null)
|
|
{
|
|
url += queryString;
|
|
}
|
|
HttpResponse response = publicApiClient.post(getScope(), url, null, null, null, body, contentType);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
|
|
return response;
|
|
}
|
|
|
|
protected HttpResponse post(String url, byte[] body, String queryString, String contentType, int expectedStatus) throws Exception
|
|
{
|
|
if (queryString != null)
|
|
{
|
|
url += queryString;
|
|
}
|
|
HttpResponse response = publicApiClient.post(getScope(), url, null, null, null, body, contentType);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
|
|
return response;
|
|
}
|
|
|
|
protected HttpResponse post(String entityCollectionName, String entityId, String relationCollectionName, byte[] body, String queryString, String contentType, int expectedStatus) throws Exception
|
|
{
|
|
HttpResponse response = publicApiClient.post(getScope(), entityCollectionName, entityId, relationCollectionName, null, body, contentType);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
|
|
return response;
|
|
}
|
|
|
|
protected HttpResponse getAll(String url, PublicApiClient.Paging paging, int expectedStatus) throws Exception
|
|
{
|
|
return getAll(url, paging, null, expectedStatus);
|
|
}
|
|
|
|
protected HttpResponse getAll(String url, PublicApiClient.Paging paging, Map<String, String> otherParams, int expectedStatus) throws Exception
|
|
{
|
|
Map<String, String> params = createParams(paging, otherParams);
|
|
|
|
HttpResponse response = publicApiClient.get(getScope(), url, null, null, null, params);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
|
|
return response;
|
|
}
|
|
|
|
protected HttpResponse getAll(Class<?> entityResource, PublicApiClient.Paging paging, Map<String, String> otherParams, int expectedStatus) throws Exception
|
|
{
|
|
HttpResponse response = publicApiClient.get(entityResource, null, null, otherParams);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
|
|
return response;
|
|
}
|
|
|
|
protected HttpResponse getAll(String url, PublicApiClient.Paging paging, Map<String, String> otherParams, Map<String, String> headers, int expectedStatus) throws Exception
|
|
{
|
|
return getAll(url, paging, otherParams, headers, null, expectedStatus);
|
|
}
|
|
|
|
protected HttpResponse getAll(String url, PublicApiClient.Paging paging, Map<String, String> otherParams, Map<String, String> headers, String apiName, int expectedStatus) throws Exception
|
|
{
|
|
Map<String, String> params = createParams(paging, otherParams);
|
|
RequestBuilder requestBuilder = httpClient.new GetRequestBuilder()
|
|
.setRequestContext(publicApiClient.getRequestContext())
|
|
.setScope(getScope())
|
|
.setApiName(apiName)
|
|
.setEntityCollectionName(url)
|
|
.setParams(params)
|
|
.setHeaders(headers);
|
|
|
|
HttpResponse response = publicApiClient.execute(requestBuilder);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
|
|
return response;
|
|
}
|
|
|
|
protected HttpResponse getSingle(String url, String entityId, int expectedStatus) throws Exception
|
|
{
|
|
return getSingle(url, entityId, null, expectedStatus);
|
|
}
|
|
|
|
protected HttpResponse getSingle(String url, String entityId, Map<String, String> params, int expectedStatus) throws Exception
|
|
{
|
|
HttpResponse response = publicApiClient.get(getScope(), url, entityId, null, null, params);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
|
|
return response;
|
|
}
|
|
|
|
protected HttpResponse getSingle(Class<?> entityResource, String entityId, Map<String, String> params, int expectedStatus) throws Exception
|
|
{
|
|
HttpResponse response = publicApiClient.get(entityResource, entityId, null, params);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
|
|
return response;
|
|
}
|
|
|
|
protected HttpResponse getSingle(String url, String entityId, Map<String, String> params, Map<String, String> headers, int expectedStatus) throws Exception
|
|
{
|
|
return getSingle(url, entityId, params, headers, null, expectedStatus);
|
|
}
|
|
|
|
protected HttpResponse getSingle(String url, String entityId, Map<String, String> params, Map<String, String> headers, String apiName, int expectedStatus) throws Exception
|
|
{
|
|
RequestBuilder requestBuilder = httpClient.new GetRequestBuilder()
|
|
.setRequestContext(publicApiClient.getRequestContext())
|
|
.setScope(getScope())
|
|
.setApiName(apiName)
|
|
.setEntityCollectionName(url)
|
|
.setEntityId(entityId)
|
|
.setParams(params)
|
|
.setHeaders(headers);
|
|
|
|
HttpResponse response = publicApiClient.execute(requestBuilder);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
|
|
return response;
|
|
}
|
|
|
|
protected HttpResponse getSingleWithDelayRetry(String url, String entityId, Map<String, String> params,
|
|
Map<String, String> headers, int repeat, long pauseInMillisecond, int expectedStatus) throws Exception
|
|
{
|
|
int retryCount = 0;
|
|
while (retryCount < repeat)
|
|
{
|
|
try
|
|
{
|
|
return getSingle(url, entityId, params, headers, expectedStatus);
|
|
}
|
|
catch (AssertionError ex)
|
|
{
|
|
retryCount++;
|
|
Thread.sleep(pauseInMillisecond);
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
protected HttpResponse put(String url, String entityId, String body, String queryString, int expectedStatus) throws Exception
|
|
{
|
|
if (queryString != null)
|
|
{
|
|
entityId += queryString;
|
|
}
|
|
HttpResponse response = publicApiClient.put(getScope(), url, entityId, null, null, body, null);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
|
|
return response;
|
|
}
|
|
|
|
protected HttpResponse putBinary(String url, int version, BinaryPayload payload, String queryString, Map<String, String> params,
|
|
int expectedStatus) throws Exception
|
|
{
|
|
if (queryString != null)
|
|
{
|
|
url += queryString;
|
|
}
|
|
|
|
HttpResponse response = publicApiClient.putBinary(getScope(), version, url, null, null, null, payload, params);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
|
|
return response;
|
|
}
|
|
|
|
protected HttpResponse putBinary(String url, BinaryPayload payload, String queryString, Map<String, String> params,
|
|
int expectedStatus) throws Exception
|
|
{
|
|
return putBinary(url, 1, payload, queryString, params, expectedStatus);
|
|
}
|
|
|
|
protected HttpResponse delete(String url, String entityId, int expectedStatus) throws Exception
|
|
{
|
|
return delete(url, entityId, null, expectedStatus);
|
|
}
|
|
|
|
protected HttpResponse delete(String url, String entityId, Map<String, String> params, int expectedStatus) throws Exception
|
|
{
|
|
HttpResponse response = publicApiClient.delete(getScope(), 1, url, entityId, null, null, params);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
|
|
return response;
|
|
}
|
|
|
|
protected HttpResponse delete(String url, String entityId, Map<String, String> params, Map<String, String> headers, String apiName, int expectedStatus) throws Exception
|
|
{
|
|
RequestBuilder requestBuilder = httpClient.new DeleteRequestBuilder()
|
|
.setRequestContext(publicApiClient.getRequestContext())
|
|
.setScope(getScope())
|
|
.setApiName(apiName)
|
|
.setEntityCollectionName(url)
|
|
.setEntityId(entityId)
|
|
.setParams(params)
|
|
.setHeaders(headers);
|
|
|
|
HttpResponse response = publicApiClient.execute(requestBuilder);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
|
|
return response;
|
|
}
|
|
|
|
protected String createUser(String username)
|
|
{
|
|
return createUser(username, "password", null);
|
|
}
|
|
|
|
/**
|
|
* TODO implement as remote api call
|
|
*/
|
|
protected String createUser(String username, String password, TestNetwork network)
|
|
{
|
|
PersonInfo personInfo = new PersonInfo(username, username, username, password, null, null, null, null, null, null, null);
|
|
RepoService.TestPerson person = repoService.createUser(personInfo, username, network);
|
|
return person.getId();
|
|
}
|
|
|
|
/**
|
|
* TODO implement as remote api call
|
|
*/
|
|
protected String getOrCreateUser(String username, String password)
|
|
{
|
|
PersonInfo personInfo = new PersonInfo(username, username, username, password, null, null, null, null, null, null, null);
|
|
RepoService.TestPerson person = repoService.getOrCreateUser(personInfo, username, null);
|
|
return person.getId();
|
|
}
|
|
|
|
protected SiteMember addSiteMember(String siteId, String userId, final SiteRole siteRole) throws Exception
|
|
{
|
|
SiteMember siteMember = new SiteMember(userId, siteRole.name());
|
|
HttpResponse response = publicApiClient.post(getScope(), "sites", siteId, "members", null, siteMember.postJSON().toString());
|
|
checkStatus(201, response.getStatusCode());
|
|
return SiteMember.parseSiteMember(siteMember.getSiteId(), (JSONObject)response.getJsonResponse().get("entry"));
|
|
}
|
|
|
|
protected Site createSite(String siteTitle, SiteVisibility siteVisibility) throws Exception
|
|
{
|
|
return createSite(null, siteTitle, siteVisibility);
|
|
}
|
|
|
|
protected Site createSite(String siteId, String siteTitle, SiteVisibility siteVisibility) throws Exception
|
|
{
|
|
Site site = new Site();
|
|
site.setId(siteId);
|
|
site.setTitle(siteTitle);
|
|
site.setVisibility(siteVisibility);
|
|
|
|
HttpResponse response = publicApiClient.post(getScope(), "sites", null, null, null, toJsonAsStringNonNull(site));
|
|
return RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Site.class);
|
|
}
|
|
|
|
protected HttpResponse deleteSite(String siteId, int expectedStatus) throws Exception
|
|
{
|
|
HttpResponse response = publicApiClient.delete(getScope(), "sites", siteId, null, null);
|
|
checkStatus(expectedStatus, response.getStatusCode());
|
|
return response;
|
|
}
|
|
|
|
/**
|
|
* Helper: to get site container id (see also RepoService.getContainerNodeRef -> SiteService.getContainer)
|
|
* <p>
|
|
* GET /nodes/-root?relativePath=/Sites/siteId/documentLibrary
|
|
* <p>
|
|
* alternatively:
|
|
* <p>
|
|
* GET /nodes/siteNodeId?relativePath=documentLibrary
|
|
*/
|
|
protected String getSiteContainerNodeId(String siteId, String containerNameId) throws Exception
|
|
{
|
|
Map<String, String> params = Collections.singletonMap(Nodes.PARAM_RELATIVE_PATH, "/Sites/" + siteId + "/" + containerNameId);
|
|
|
|
HttpResponse response = publicApiClient.get(NodesEntityResource.class, Nodes.PATH_ROOT, null, params);
|
|
checkStatus(200, response.getStatusCode());
|
|
|
|
Node node = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Node.class);
|
|
return node.getId();
|
|
}
|
|
|
|
protected void checkStatus(int expectedStatus, int actualStatus)
|
|
{
|
|
if (expectedStatus > 0 && expectedStatus != actualStatus)
|
|
{
|
|
fail("Status code " + actualStatus + " returned, but expected " + expectedStatus);
|
|
}
|
|
}
|
|
|
|
protected void setRequestContext(String runAsUser)
|
|
{
|
|
String password = null;
|
|
if ((runAsUser != null) && runAsUser.equals(DEFAULT_ADMIN))
|
|
{
|
|
// TODO improve "admin" related tests
|
|
password = DEFAULT_ADMIN_PWD;
|
|
}
|
|
|
|
setRequestContext(null, runAsUser, password);
|
|
}
|
|
|
|
protected void setRequestContext(String runAsNetwork, String runAsUser, String password)
|
|
{
|
|
if ((runAsNetwork == null) || TenantService.DEFAULT_DOMAIN.equals(runAsNetwork))
|
|
{
|
|
runAsNetwork = "-default-";
|
|
}
|
|
else if (runAsUser.equals(DEFAULT_ADMIN))
|
|
{
|
|
runAsUser = runAsUser+"@"+runAsNetwork;
|
|
}
|
|
|
|
publicApiClient.setRequestContext(new RequestContext(runAsNetwork, runAsUser, password));
|
|
}
|
|
|
|
// -root- (eg. Company Home for on-prem)
|
|
protected String getRootNodeId() throws Exception
|
|
{
|
|
HttpResponse response = getSingle(NodesEntityResource.class, Nodes.PATH_ROOT, null, 200);
|
|
Node node = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Node.class);
|
|
return node.getId();
|
|
}
|
|
|
|
// -my- (eg. User's Home for on-prem)
|
|
protected String getMyNodeId() throws Exception
|
|
{
|
|
HttpResponse response = getSingle(NodesEntityResource.class, Nodes.PATH_MY, null, 200);
|
|
Node node = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Node.class);
|
|
return node.getId();
|
|
}
|
|
|
|
// -shared- (eg. "Shared" folder for on-prem)
|
|
protected String getSharedNodeId() throws Exception
|
|
{
|
|
HttpResponse response = getSingle(NodesEntityResource.class, Nodes.PATH_SHARED, null, 200);
|
|
Node node = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Node.class);
|
|
return node.getId();
|
|
}
|
|
|
|
protected Folder createFolder(String parentId, String folderName) throws Exception
|
|
{
|
|
return createFolder(parentId, folderName, null);
|
|
}
|
|
|
|
protected Folder createFolder(String parentId, String folderName, Map<String, Object> props) throws Exception
|
|
{
|
|
return createNode(parentId, folderName, TYPE_CM_FOLDER, props, Folder.class);
|
|
}
|
|
|
|
protected Node createNode(String parentId, String nodeName, String nodeType, Map<String, Object> props) throws Exception
|
|
{
|
|
return createNode(parentId, nodeName, nodeType, props, Node.class);
|
|
}
|
|
|
|
protected <T> T createNode(String parentId, String nodeName, String nodeType, Map<String, Object> props, Class<T> returnType)
|
|
throws Exception
|
|
{
|
|
Node n = new Node();
|
|
n.setName(nodeName);
|
|
n.setNodeType(nodeType);
|
|
n.setProperties(props);
|
|
|
|
// create node
|
|
HttpResponse response = post(getNodeChildrenUrl(parentId), RestApiUtil.toJsonAsStringNonNull(n), 201);
|
|
|
|
return RestApiUtil.parseRestApiEntry(response.getJsonResponse(), returnType);
|
|
}
|
|
|
|
protected void deleteNode(String nodeId) throws Exception
|
|
{
|
|
deleteNode(nodeId, 204);
|
|
}
|
|
|
|
protected void deleteNode(String nodeId, int expectedStatus) throws Exception
|
|
{
|
|
deleteNode(nodeId, false, expectedStatus);
|
|
}
|
|
|
|
protected void deleteNode(String nodeId, boolean permanent, int expectedStatus) throws Exception
|
|
{
|
|
Map params = null;
|
|
if (permanent == true)
|
|
{
|
|
params = Collections.singletonMap("permanent", "true");
|
|
}
|
|
|
|
delete(URL_NODES, nodeId, params, expectedStatus);
|
|
}
|
|
|
|
protected Document createTextFile(String parentId, String fileName, String textContent) throws IOException, Exception
|
|
{
|
|
return createTextFile(parentId, fileName, textContent, "UTF-8", null);
|
|
}
|
|
|
|
protected Document createTextFile(String parentId, String fileName, String textContent, String encoding, Map<String, String> props) throws IOException, Exception
|
|
{
|
|
return createTextFile(parentId, fileName, textContent, encoding, props, 201);
|
|
}
|
|
|
|
protected Document createTextFile(String parentId, String fileName, String textContent, String encoding, Map<String, String> props, int expectedStatus) throws IOException, Exception
|
|
{
|
|
if (props == null)
|
|
{
|
|
props = Collections.EMPTY_MAP;
|
|
|
|
}
|
|
|
|
ByteArrayInputStream inputStream = new ByteArrayInputStream(textContent.getBytes());
|
|
File txtFile = TempFileProvider.createTempFile(inputStream, getClass().getSimpleName(), ".txt");
|
|
|
|
MultiPartBuilder.MultiPartRequest reqBody = MultiPartBuilder.create()
|
|
.setFileData(new MultiPartBuilder.FileData(fileName, txtFile))
|
|
.setProperties(props)
|
|
.build();
|
|
|
|
HttpResponse response = post(getNodeChildrenUrl(parentId), reqBody.getBody(), null, reqBody.getContentType(), expectedStatus);
|
|
|
|
if (response.getJsonResponse().get("error") != null)
|
|
{
|
|
return null;
|
|
}
|
|
|
|
return RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Document.class);
|
|
}
|
|
|
|
protected Document createEmptyTextFile(Folder parentFolder, String docName) throws Exception
|
|
{
|
|
Document d1 = new Document();
|
|
d1.setName(docName);
|
|
d1.setNodeType("cm:content");
|
|
ContentInfo ci = new ContentInfo();
|
|
ci.setMimeType("text/plain");
|
|
d1.setContent(ci);
|
|
|
|
// create empty file
|
|
HttpResponse response = post(getNodeChildrenUrl(parentFolder.getId()), toJsonAsStringNonNull(d1), 201);
|
|
return RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Document.class);
|
|
}
|
|
|
|
protected Document updateTextFile(String contentId, String textContent, Map<String, String> parameters) throws IOException, Exception
|
|
{
|
|
ByteArrayInputStream inputStream = new ByteArrayInputStream(textContent.getBytes());
|
|
File txtFile = TempFileProvider.createTempFile(inputStream, getClass().getSimpleName(), ".txt");
|
|
BinaryPayload payload = new BinaryPayload(txtFile);
|
|
|
|
HttpResponse response = putBinary(getNodeContentUrl(contentId), payload, null, parameters, 200);
|
|
return RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Document.class);
|
|
}
|
|
|
|
protected File getResourceFile(String fileName) throws FileNotFoundException
|
|
{
|
|
URL url = NodeApiTest.class.getClassLoader().getResource(RESOURCE_PREFIX + fileName);
|
|
if (url == null)
|
|
{
|
|
fail("Cannot get the resource: " + fileName);
|
|
}
|
|
return ResourceUtils.getFile(url);
|
|
}
|
|
|
|
protected static final long PAUSE_TIME = 5000; //millisecond
|
|
protected static final int MAX_RETRY = 20;
|
|
|
|
protected Rendition waitAndGetRendition(String sourceNodeId, String renditionId) throws Exception
|
|
{
|
|
int retryCount = 0;
|
|
while (retryCount < MAX_RETRY)
|
|
{
|
|
try
|
|
{
|
|
HttpResponse response = getSingle(getNodeRenditionsUrl(sourceNodeId), renditionId, 200);
|
|
Rendition rendition = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Rendition.class);
|
|
assertNotNull(rendition);
|
|
assertEquals(Rendition.RenditionStatus.CREATED, rendition.getStatus());
|
|
return rendition;
|
|
}
|
|
catch (AssertionError ex)
|
|
{
|
|
// If the asynchronous create rendition action is not finished yet,
|
|
// wait for 'PAUSE_TIME' and try again.
|
|
retryCount++;
|
|
|
|
System.out.println("waitAndGetRendition: "+retryCount);
|
|
Thread.sleep(PAUSE_TIME);
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
protected Rendition createAndGetRendition(String sourceNodeId, String renditionId) throws Exception
|
|
{
|
|
Rendition renditionRequest = new Rendition();
|
|
renditionRequest.setId(renditionId);
|
|
|
|
int retryCount = 0;
|
|
while (retryCount < MAX_RETRY)
|
|
{
|
|
try
|
|
{
|
|
HttpResponse res = post(getNodeRenditionsUrl(sourceNodeId), toJsonAsString(renditionRequest), 202);
|
|
assertNull(res.getJsonResponse());
|
|
break;
|
|
}
|
|
catch (AssertionError ex)
|
|
{
|
|
// If no transformer is currently available,
|
|
// wait for 'PAUSE_TIME' and try again.
|
|
retryCount++;
|
|
|
|
System.out.println("waitAndGetRendition: "+retryCount);
|
|
Thread.sleep(PAUSE_TIME);
|
|
}
|
|
}
|
|
|
|
return waitAndGetRendition(sourceNodeId, renditionId);
|
|
}
|
|
|
|
protected String getNodeRenditionsUrl(String nodeId)
|
|
{
|
|
return URL_NODES + "/" + nodeId + "/" + URL_RENDITIONS;
|
|
}
|
|
|
|
protected String getNodeChildrenUrl(String nodeId)
|
|
{
|
|
return URL_NODES + "/" + nodeId + "/" + URL_CHILDREN;
|
|
}
|
|
|
|
protected String getNodeContentUrl(String nodeId)
|
|
{
|
|
return URL_NODES + "/" + nodeId + "/" + URL_CONTENT;
|
|
}
|
|
}
|
|
|