mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-21 18:09:20 +00:00
Merged HEAD-QA to HEAD (4.2) (including moving test classes into separate folders)
51903 to 54309 git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@54310 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Samuel Langlois
@@ -0,0 +1,41 @@
|
||||
/*
|
||||
* Copyright (C) 2005-2010 Alfresco Software Limited.
|
||||
*
|
||||
* This file is part of Alfresco
|
||||
*
|
||||
* 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/>.
|
||||
*/
|
||||
package org.alfresco.repo.web.scripts.rating;
|
||||
|
||||
import org.alfresco.repo.rating.RatingServiceIntegrationTest;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.junit.runners.Suite;
|
||||
|
||||
/**
|
||||
* This class is a holder for the various test classes associated with the Rating Service.
|
||||
* It is not (at the time of writing) intended to be incorporated into the automatic build
|
||||
* which will find the various test classes and run them individually.
|
||||
*
|
||||
* @author Neil McErlean
|
||||
* @since 3.4
|
||||
*/
|
||||
@RunWith(Suite.class)
|
||||
@Suite.SuiteClasses({
|
||||
RatingServiceIntegrationTest.class,
|
||||
RatingRestApiTest.class
|
||||
})
|
||||
public class AllRatingTests
|
||||
{
|
||||
// Intentionally empty
|
||||
}
|
||||
@@ -0,0 +1,382 @@
|
||||
/*
|
||||
* Copyright (C) 2005-2010 Alfresco Software Limited.
|
||||
*
|
||||
* This file is part of Alfresco
|
||||
*
|
||||
* 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/>.
|
||||
*/
|
||||
package org.alfresco.repo.web.scripts.rating;
|
||||
|
||||
import java.text.MessageFormat;
|
||||
|
||||
import org.alfresco.model.ContentModel;
|
||||
import org.alfresco.repo.model.Repository;
|
||||
import org.alfresco.repo.security.authentication.AuthenticationUtil;
|
||||
import org.alfresco.repo.transaction.RetryingTransactionHelper;
|
||||
import org.alfresco.repo.web.scripts.BaseWebScriptTest;
|
||||
import org.alfresco.service.cmr.repository.ChildAssociationRef;
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
import org.alfresco.service.cmr.repository.NodeService;
|
||||
import org.alfresco.service.cmr.security.MutableAuthenticationService;
|
||||
import org.alfresco.service.cmr.security.PersonService;
|
||||
import org.alfresco.util.PropertyMap;
|
||||
import org.json.JSONArray;
|
||||
import org.json.JSONObject;
|
||||
import org.json.JSONStringer;
|
||||
import org.json.JSONTokener;
|
||||
import org.springframework.extensions.webscripts.TestWebScriptServer.DeleteRequest;
|
||||
import org.springframework.extensions.webscripts.TestWebScriptServer.GetRequest;
|
||||
import org.springframework.extensions.webscripts.TestWebScriptServer.PostRequest;
|
||||
import org.springframework.extensions.webscripts.TestWebScriptServer.Response;
|
||||
|
||||
/**
|
||||
* This class tests the ReST API of the {@link RatingService}.
|
||||
*
|
||||
* @author Neil McErlean
|
||||
* @since 3.4
|
||||
*/
|
||||
public class RatingRestApiTest extends BaseWebScriptTest
|
||||
{
|
||||
// Miscellaneous constants used throughout this test class.
|
||||
private static final String FIVE_STAR_RATING_SCHEME = "fiveStarRatingScheme";
|
||||
private static final String LIKES_RATING_SCHEME = "likesRatingScheme";
|
||||
|
||||
private static final String USER_ONE = "UserOne";
|
||||
private static final String USER_TWO = "UserTwo";
|
||||
|
||||
private static final String RATING_SCHEMES = "ratingSchemes";
|
||||
private static final String NAME = "name";
|
||||
private static final String MIN_RATING = "minRating";
|
||||
private static final String MAX_RATING = "maxRating";
|
||||
private static final String RATINGS = "ratings";
|
||||
private static final String NODE_REF = "nodeRef";
|
||||
private static final String DATA = "data";
|
||||
private static final String RATINGS_TOTAL = "ratingsTotal";
|
||||
private static final String RATINGS_COUNT = "ratingsCount";
|
||||
private static final String AVERAGE_RATING = "averageRating";
|
||||
private static final String NODE_STATISTICS = "nodeStatistics";
|
||||
|
||||
private final static String NODE_RATINGS_URL_FORMAT = "/api/node/{0}/ratings";
|
||||
private final static String GET_RATING_DEFS_URL = "/api/rating/schemedefinitions";
|
||||
|
||||
private static final String APPLICATION_JSON = "application/json";
|
||||
|
||||
private NodeRef testNode;
|
||||
|
||||
private MutableAuthenticationService authenticationService;
|
||||
private NodeService nodeService;
|
||||
private PersonService personService;
|
||||
private Repository repositoryHelper;
|
||||
private RetryingTransactionHelper transactionHelper;
|
||||
|
||||
@Override
|
||||
protected void setUp() throws Exception
|
||||
{
|
||||
super.setUp();
|
||||
authenticationService = (MutableAuthenticationService) getServer().getApplicationContext().getBean("AuthenticationService");
|
||||
nodeService = (NodeService) getServer().getApplicationContext().getBean("NodeService");
|
||||
personService = (PersonService) getServer().getApplicationContext().getBean("PersonService");
|
||||
repositoryHelper = (Repository) getServer().getApplicationContext().getBean("repositoryHelper");
|
||||
transactionHelper = (RetryingTransactionHelper)getServer().getApplicationContext().getBean("retryingTransactionHelper");
|
||||
|
||||
AuthenticationUtil.setFullyAuthenticatedUser(AuthenticationUtil.getSystemUserName());
|
||||
|
||||
// Create some users to rate each other's content
|
||||
// and a test node which we will rate.
|
||||
// It doesn't matter that it has no content.
|
||||
testNode = transactionHelper.doInTransaction(new RetryingTransactionHelper.RetryingTransactionCallback<NodeRef>()
|
||||
{
|
||||
public NodeRef execute() throws Throwable
|
||||
{
|
||||
createUser(USER_ONE);
|
||||
createUser(USER_TWO);
|
||||
|
||||
ChildAssociationRef result = nodeService.createNode(repositoryHelper.getCompanyHome(),
|
||||
ContentModel.ASSOC_CONTAINS, ContentModel.ASSOC_CONTAINS,
|
||||
ContentModel.TYPE_CONTENT, null);
|
||||
return result.getChildRef();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
@Override
|
||||
public void tearDown() throws Exception
|
||||
{
|
||||
super.tearDown();
|
||||
|
||||
AuthenticationUtil.setFullyAuthenticatedUser(AuthenticationUtil.getSystemUserName());
|
||||
|
||||
transactionHelper.doInTransaction(new RetryingTransactionHelper.RetryingTransactionCallback<Void>()
|
||||
{
|
||||
public Void execute() throws Throwable
|
||||
{
|
||||
if (testNode != null && nodeService.exists(testNode))
|
||||
{
|
||||
nodeService.deleteNode(testNode);
|
||||
deleteUser(USER_ONE);
|
||||
deleteUser(USER_TWO);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
public void testGetRatingSchemeDefinitions() throws Exception
|
||||
{
|
||||
final int expectedStatus = 200;
|
||||
Response rsp = sendRequest(new GetRequest(GET_RATING_DEFS_URL), expectedStatus);
|
||||
|
||||
JSONObject jsonRsp = new JSONObject(new JSONTokener(rsp.getContentAsString()));
|
||||
|
||||
JSONObject dataObj = (JSONObject)jsonRsp.get(DATA);
|
||||
assertNotNull("JSON 'data' object was null", dataObj);
|
||||
|
||||
JSONArray ratingSchemesArray = (JSONArray)dataObj.get(RATING_SCHEMES);
|
||||
assertNotNull("JSON 'ratingSchemesArray' object was null", ratingSchemesArray);
|
||||
assertEquals(2, ratingSchemesArray.length());
|
||||
|
||||
JSONObject scheme1 = ratingSchemesArray.getJSONObject(0);
|
||||
JSONObject scheme2 = ratingSchemesArray.getJSONObject(1);
|
||||
|
||||
assertEquals(LIKES_RATING_SCHEME, scheme1.getString(NAME));
|
||||
assertEquals(1.0, scheme1.getDouble(MIN_RATING));
|
||||
assertEquals(1.0, scheme1.getDouble(MAX_RATING));
|
||||
assertTrue(scheme1.getBoolean("selfRatingAllowed"));
|
||||
assertEquals(FIVE_STAR_RATING_SCHEME, scheme2.getString(NAME));
|
||||
assertEquals(1.0, scheme2.getDouble(MIN_RATING));
|
||||
assertEquals(5.0, scheme2.getDouble(MAX_RATING));
|
||||
assertFalse(scheme2.getBoolean("selfRatingAllowed"));
|
||||
}
|
||||
|
||||
public void testGetRatingsFromUnratedNodeRef() throws Exception
|
||||
{
|
||||
// GET ratings
|
||||
String ratingUrl = getRatingUrl(testNode);
|
||||
|
||||
final int expectedStatus = 200;
|
||||
Response rsp = sendRequest(new GetRequest(ratingUrl), expectedStatus);
|
||||
|
||||
JSONObject jsonRsp = new JSONObject(new JSONTokener(rsp.getContentAsString()));
|
||||
|
||||
JSONObject dataObj = (JSONObject)jsonRsp.get(DATA);
|
||||
assertNotNull("JSON 'data' object was null", dataObj);
|
||||
|
||||
assertEquals(testNode.toString(), dataObj.getString(NODE_REF));
|
||||
final JSONObject ratingsObject = dataObj.getJSONObject(RATINGS);
|
||||
assertEquals(0, ratingsObject.length());
|
||||
|
||||
// Unrated content
|
||||
JSONObject statsObject = dataObj.getJSONObject(NODE_STATISTICS);
|
||||
JSONObject likesStats = statsObject.getJSONObject(LIKES_RATING_SCHEME);
|
||||
assertEquals("Average rating was wrong.", -1.0, likesStats.getDouble(AVERAGE_RATING));
|
||||
assertEquals("Ratings count rating was wrong.", 0, likesStats.getInt(RATINGS_COUNT));
|
||||
assertEquals("Ratings total was wrong.", 0.0, likesStats.getDouble(RATINGS_TOTAL));
|
||||
|
||||
JSONObject fiveStarStats = statsObject.getJSONObject(FIVE_STAR_RATING_SCHEME);
|
||||
assertEquals("Average rating was wrong.", -1.0, fiveStarStats.getDouble(AVERAGE_RATING));
|
||||
assertEquals("Ratings count rating was wrong.", 0, fiveStarStats.getInt(RATINGS_COUNT));
|
||||
assertEquals("Ratings total was wrong.", 0.0, fiveStarStats.getDouble(RATINGS_TOTAL));
|
||||
}
|
||||
|
||||
/**
|
||||
* This test method applies ratings from multiple users in a single rating
|
||||
* scheme to a single test node. It then retrieves those ratings to ensure they
|
||||
* were persisted correctly.
|
||||
*/
|
||||
public void testApplyRatingsAsMultipleUsersAndRetrieve() throws Exception
|
||||
{
|
||||
// POST a new rating to the testNode - as User One.
|
||||
AuthenticationUtil.setFullyAuthenticatedUser(USER_ONE);
|
||||
|
||||
final String testNodeRatingUrl = getRatingUrl(testNode);
|
||||
|
||||
final float userOneRatingValue = 4.5f;
|
||||
String jsonString = new JSONStringer().object()
|
||||
.key("rating").value(userOneRatingValue)
|
||||
.key("ratingScheme").value(FIVE_STAR_RATING_SCHEME)
|
||||
.endObject()
|
||||
.toString();
|
||||
|
||||
Response postRsp = sendRequest(new PostRequest(testNodeRatingUrl,
|
||||
jsonString, APPLICATION_JSON), 200);
|
||||
|
||||
String postRspString = postRsp.getContentAsString();
|
||||
|
||||
// Get the returned URL and validate
|
||||
JSONObject jsonRsp = new JSONObject(new JSONTokener(postRspString));
|
||||
|
||||
JSONObject dataObj = (JSONObject)jsonRsp.get(DATA);
|
||||
assertNotNull("JSON 'data' object was null", dataObj);
|
||||
String returnedUrl = dataObj.getString("ratedNodeUrl");
|
||||
assertEquals(testNodeRatingUrl, returnedUrl);
|
||||
assertEquals(FIVE_STAR_RATING_SCHEME, dataObj.getString("ratingScheme"));
|
||||
assertEquals(userOneRatingValue, (float)dataObj.getDouble("rating"));
|
||||
assertEquals(userOneRatingValue, (float)dataObj.getDouble("averageRating"));
|
||||
assertEquals(userOneRatingValue, (float)dataObj.getDouble("ratingsTotal"));
|
||||
assertEquals(1, dataObj.getInt("ratingsCount"));
|
||||
|
||||
// And a second rating
|
||||
jsonString = new JSONStringer().object()
|
||||
.key("rating").value(1)
|
||||
.key("ratingScheme").value(LIKES_RATING_SCHEME)
|
||||
.endObject()
|
||||
.toString();
|
||||
|
||||
sendRequest(new PostRequest(testNodeRatingUrl, jsonString, APPLICATION_JSON), 200);
|
||||
|
||||
|
||||
// Now GET the ratings via that returned URL
|
||||
Response getRsp = sendRequest(new GetRequest(testNodeRatingUrl), 200);
|
||||
String getRspString = getRsp.getContentAsString();
|
||||
|
||||
jsonRsp = new JSONObject(new JSONTokener(getRspString));
|
||||
|
||||
dataObj = (JSONObject)jsonRsp.get(DATA);
|
||||
assertNotNull("JSON 'data' object was null", dataObj);
|
||||
|
||||
// There should be two ratings in there.
|
||||
final JSONObject ratingsObject = dataObj.getJSONObject(RATINGS);
|
||||
assertEquals(2, ratingsObject.length());
|
||||
JSONObject recoveredRating = ratingsObject.getJSONObject(FIVE_STAR_RATING_SCHEME);
|
||||
assertEquals(userOneRatingValue, (float)recoveredRating.getDouble("rating"));
|
||||
|
||||
// As well as the average, total ratings.
|
||||
JSONObject statsObject = dataObj.getJSONObject(NODE_STATISTICS);
|
||||
JSONObject fiveStarStats = statsObject.getJSONObject(FIVE_STAR_RATING_SCHEME);
|
||||
assertEquals("Average rating was wrong.", userOneRatingValue, (float)fiveStarStats.getDouble(AVERAGE_RATING));
|
||||
assertEquals("Ratings count rating was wrong.", 1, fiveStarStats.getInt(RATINGS_COUNT));
|
||||
assertEquals("Ratings total was wrong.", userOneRatingValue, (float)fiveStarStats.getDouble(RATINGS_TOTAL));
|
||||
|
||||
JSONObject likesStats = statsObject.getJSONObject(LIKES_RATING_SCHEME);
|
||||
assertEquals("Average rating was wrong.", 1f, (float)likesStats.getDouble(AVERAGE_RATING));
|
||||
assertEquals("Ratings count rating was wrong.", 1, likesStats.getInt(RATINGS_COUNT));
|
||||
assertEquals("Ratings total was wrong.", 1f, (float)likesStats.getDouble(RATINGS_TOTAL));
|
||||
|
||||
|
||||
// Now POST a second new rating to the testNode - as User Two.
|
||||
AuthenticationUtil.setFullyAuthenticatedUser(USER_TWO);
|
||||
|
||||
final float userTwoRatingValue = 3.5f;
|
||||
jsonString = new JSONStringer().object()
|
||||
.key("rating").value(userTwoRatingValue)
|
||||
.key("ratingScheme").value(FIVE_STAR_RATING_SCHEME)
|
||||
.endObject()
|
||||
.toString();
|
||||
|
||||
postRsp = sendRequest(new PostRequest(testNodeRatingUrl,
|
||||
jsonString, APPLICATION_JSON), 200);
|
||||
postRspString = postRsp.getContentAsString();
|
||||
|
||||
// Get the returned URL and validate
|
||||
jsonRsp = new JSONObject(new JSONTokener(postRspString));
|
||||
|
||||
dataObj = (JSONObject)jsonRsp.get(DATA);
|
||||
assertNotNull("JSON 'data' object was null", dataObj);
|
||||
returnedUrl = dataObj.getString("ratedNodeUrl");
|
||||
|
||||
assertEquals((userOneRatingValue + userTwoRatingValue) / 2, (float)dataObj.getDouble("averageRating"));
|
||||
assertEquals(userOneRatingValue + userTwoRatingValue, (float)dataObj.getDouble("ratingsTotal"));
|
||||
assertEquals(2, dataObj.getInt("ratingsCount"));
|
||||
|
||||
// Again GET the ratings via that returned URL
|
||||
getRsp = sendRequest(new GetRequest(returnedUrl), 200);
|
||||
getRspString = getRsp.getContentAsString();
|
||||
|
||||
jsonRsp = new JSONObject(new JSONTokener(getRspString));
|
||||
|
||||
dataObj = (JSONObject)jsonRsp.get(DATA);
|
||||
assertNotNull("JSON 'data' object was null", dataObj);
|
||||
|
||||
// There should still only be the one rating in the results - because we're running
|
||||
// as UserTwo and should not see UserOne's rating.
|
||||
final JSONObject userTwoRatings = dataObj.getJSONObject(RATINGS);
|
||||
assertEquals(1, userTwoRatings.length());
|
||||
JSONObject secondRating = (JSONObject)userTwoRatings.getJSONObject(FIVE_STAR_RATING_SCHEME);
|
||||
assertEquals(userTwoRatingValue, (float)secondRating.getDouble("rating"));
|
||||
|
||||
// Now the average should have changed.
|
||||
statsObject = dataObj.getJSONObject(NODE_STATISTICS);
|
||||
fiveStarStats = statsObject.getJSONObject(FIVE_STAR_RATING_SCHEME);
|
||||
assertEquals("Average rating was wrong.", (userOneRatingValue + userTwoRatingValue) / 2.0,
|
||||
fiveStarStats.getDouble(AVERAGE_RATING));
|
||||
assertEquals("Ratings count rating was wrong.", 2, fiveStarStats.getInt(RATINGS_COUNT));
|
||||
assertEquals("Ratings total was wrong.", userOneRatingValue + userTwoRatingValue,
|
||||
(float)fiveStarStats.getDouble(RATINGS_TOTAL));
|
||||
|
||||
|
||||
// Now DELETE user two's rating.
|
||||
AuthenticationUtil.setFullyAuthenticatedUser(USER_TWO);
|
||||
sendRequest(new DeleteRequest(testNodeRatingUrl + "/" + FIVE_STAR_RATING_SCHEME), 200);
|
||||
|
||||
// GET the ratings again. Although user_one's rating will still be there,
|
||||
// user two can't see it and so we should see zero ratings.
|
||||
getRsp = sendRequest(new GetRequest(returnedUrl), 200);
|
||||
getRspString = getRsp.getContentAsString();
|
||||
|
||||
jsonRsp = new JSONObject(new JSONTokener(getRspString));
|
||||
|
||||
dataObj = (JSONObject)jsonRsp.get(DATA);
|
||||
assertNotNull("JSON 'data' object was null", dataObj);
|
||||
|
||||
final JSONObject remainingRatings = dataObj.getJSONObject(RATINGS);
|
||||
assertEquals(0, remainingRatings.length());
|
||||
|
||||
// Now the average should have changed.
|
||||
statsObject = dataObj.getJSONObject(NODE_STATISTICS);
|
||||
fiveStarStats = statsObject.getJSONObject(FIVE_STAR_RATING_SCHEME);
|
||||
assertEquals("Average rating was wrong.", userOneRatingValue,
|
||||
(float)fiveStarStats.getDouble(AVERAGE_RATING));
|
||||
assertEquals("Ratings count rating was wrong.", 1, fiveStarStats.getInt(RATINGS_COUNT));
|
||||
assertEquals("Ratings total was wrong.", userOneRatingValue,
|
||||
(float)fiveStarStats.getDouble(RATINGS_TOTAL));
|
||||
}
|
||||
|
||||
/**
|
||||
* This method gives the 'ratings' URL for the specified NodeRef.
|
||||
*/
|
||||
private String getRatingUrl(NodeRef nodeRef)
|
||||
{
|
||||
String nodeUrl = nodeRef.toString().replace("://", "/");
|
||||
String ratingUrl = MessageFormat.format(NODE_RATINGS_URL_FORMAT, nodeUrl);
|
||||
return ratingUrl;
|
||||
}
|
||||
|
||||
private void createUser(String userName)
|
||||
{
|
||||
if (! authenticationService.authenticationExists(userName))
|
||||
{
|
||||
authenticationService.createAuthentication(userName, "PWD".toCharArray());
|
||||
}
|
||||
|
||||
if (! personService.personExists(userName))
|
||||
{
|
||||
PropertyMap ppOne = new PropertyMap(4);
|
||||
ppOne.put(ContentModel.PROP_USERNAME, userName);
|
||||
ppOne.put(ContentModel.PROP_FIRSTNAME, "firstName");
|
||||
ppOne.put(ContentModel.PROP_LASTNAME, "lastName");
|
||||
ppOne.put(ContentModel.PROP_EMAIL, "email@email.com");
|
||||
ppOne.put(ContentModel.PROP_JOBTITLE, "jobTitle");
|
||||
|
||||
personService.createPerson(ppOne);
|
||||
}
|
||||
}
|
||||
|
||||
private void deleteUser(String userName)
|
||||
{
|
||||
if (personService.personExists(userName))
|
||||
{
|
||||
personService.deletePerson(userName);
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user