ACS-9023 Implement PUT method - Preferences API (#3075)

* ACS-9023 Implement PUT method - Preferences API

* ACS-9023 Fix testUserPreferences

* ACS-9023 Add override

* ACS-9023 Update license header
This commit is contained in:
Damian Ujma
2024-12-10 09:51:56 +01:00
committed by GitHub
parent c7bbb1f74b
commit 5a1c8334c8
9 changed files with 3872 additions and 3764 deletions

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* alfresco-tas-restapi * alfresco-tas-restapi
* %% * %%
* Copyright (C) 2005 - 2022 Alfresco Software Limited * Copyright (C) 2005 - 2024 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of * If the software was purchased under a paid Alfresco license, the terms of
@@ -29,6 +29,12 @@ import static io.restassured.RestAssured.given;
import java.io.File; import java.io.File;
import io.restassured.RestAssured;
import io.restassured.http.ContentType;
import io.restassured.response.ValidatableResponse;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.alfresco.rest.core.JsonBodyGenerator; import org.alfresco.rest.core.JsonBodyGenerator;
import org.alfresco.rest.core.RestRequest; import org.alfresco.rest.core.RestRequest;
import org.alfresco.rest.core.RestResponse; import org.alfresco.rest.core.RestResponse;
@@ -56,12 +62,6 @@ import org.alfresco.utility.model.FileModel;
import org.alfresco.utility.model.FolderModel; import org.alfresco.utility.model.FolderModel;
import org.alfresco.utility.model.SiteModel; import org.alfresco.utility.model.SiteModel;
import org.alfresco.utility.model.UserModel; import org.alfresco.utility.model.UserModel;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import io.restassured.RestAssured;
import io.restassured.http.ContentType;
import io.restassured.response.ValidatableResponse;
/** /**
* Declares all Rest API under the /people path * Declares all Rest API under the /people path
@@ -97,9 +97,7 @@ public class People extends ModelRequest<People>
} }
/** /**
* Retrieve list of activities for a specific person using GET call on "people/{personId}/activities" * Retrieve list of activities for a specific person using GET call on "people/{personId}/activities" Please note that it retries to get the list of activities several times before returning the empty list. The list of activities are not displayed as they are created.
* Please note that it retries to get the list of activities several times before returning the empty list. The list of activities are not displayed as
* they are created.
*/ */
public RestActivityModelsCollection getPersonActivitiesUntilEntriesCountIs(int expectedNoOfEntries) public RestActivityModelsCollection getPersonActivitiesUntilEntriesCountIs(int expectedNoOfEntries)
{ {
@@ -173,6 +171,15 @@ public class People extends ModelRequest<People>
return restWrapper.processModel(RestPreferenceModel.class, request); return restWrapper.processModel(RestPreferenceModel.class, request);
} }
/**
* Updates a specific preference of a specific person using PUT call on "people/{personId}/preferences/{preferenceName}"
*/
public RestPreferenceModel updatePersonPreferenceInformation(String preferenceName, RestPreferenceModel preferenceModel)
{
RestRequest request = RestRequest.requestWithBody(HttpMethod.PUT, preferenceModel.toJson(), "people/{personId}/preferences/{preferenceName}", this.person.getUsername(), preferenceName);
return restWrapper.processModel(RestPreferenceModel.class, request);
}
/** /**
* Remove a specific site from favorite sites list of a person using DELETE call on "people/{personId}/favorite-sites/{siteId}" * Remove a specific site from favorite sites list of a person using DELETE call on "people/{personId}/favorite-sites/{siteId}"
*/ */
@@ -379,7 +386,7 @@ public class People extends ModelRequest<People>
public RestNetworkModel getNetwork(UserModel tenant) public RestNetworkModel getNetwork(UserModel tenant)
{ {
Utility.checkObjectIsInitialized(tenant.getDomain(), "tenant.getDomain()"); Utility.checkObjectIsInitialized(tenant.getDomain(), "tenant.getDomain()");
String personId = tenant.getUsername().contains("-me-@")? "-me-" : tenant.getUsername(); String personId = tenant.getUsername().contains("-me-@") ? "-me-" : tenant.getUsername();
RestRequest request = RestRequest.simpleRequest(HttpMethod.GET, "people/{personId}/networks/{networkId}?{parameters}", personId, tenant.getDomain(), restWrapper.getParameters()); RestRequest request = RestRequest.simpleRequest(HttpMethod.GET, "people/{personId}/networks/{networkId}?{parameters}", personId, tenant.getDomain(), restWrapper.getParameters());
return restWrapper.processModel(RestNetworkModel.class, request); return restWrapper.processModel(RestNetworkModel.class, request);
} }
@@ -412,8 +419,7 @@ public class People extends ModelRequest<People>
} }
/** /**
* Get people avatar image using GET call on '/people/{personId}/avatar Please note that it retries to get the * Get people avatar image using GET call on '/people/{personId}/avatar Please note that it retries to get the renditions response several times because on the alfresco server the rendition can take a while to be created.
* renditions response several times because on the alfresco server the rendition can take a while to be created.
*/ */
public RestResponse downloadAvatarContent() public RestResponse downloadAvatarContent()
{ {
@@ -456,17 +462,8 @@ public class People extends ModelRequest<People>
return new WhereClause(this); return new WhereClause(this);
} }
/** /**
* Construct the Where clause of getFavorites * Construct the Where clause of getFavorites You can use the where parameter to restrict the list in the response to entries of a specific kind. The where parameter takes a value. The value is a single predicate that can include one or more EXISTS conditions. The EXISTS condition uses a single operand to limit the list to include entries that include that one property. The property values are:- target/file target/folder target/site Usage: where.. targetFileExist().or().targetSiteExist().filterAnd().getFavorites(...) At this point this method is working only with @link {@link RestFavoritesApi#getFavorites(UserModel) method.
* You can use the where parameter to restrict the list in the response to entries of a specific kind. The where parameter takes a value. The value is a
* single predicate that can include one or more EXISTS conditions. The EXISTS condition uses a single operand to limit the list to include entries that
* include that one property. The property values are:-
* target/file
* target/folder
* target/site
* Usage:
* where.. targetFileExist().or().targetSiteExist().filterAnd().getFavorites(...)
* At this point this method is working only with @link {@link RestFavoritesApi#getFavorites(UserModel) method.
* *
* @author paul.brodner * @author paul.brodner
*/ */

View File

@@ -1,5 +1,11 @@
package org.alfresco.rest.people.preferences; package org.alfresco.rest.people.preferences;
import java.nio.file.Paths;
import org.springframework.http.HttpStatus;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
import org.alfresco.rest.RestTest; import org.alfresco.rest.RestTest;
import org.alfresco.rest.model.RestErrorModel; import org.alfresco.rest.model.RestErrorModel;
import org.alfresco.rest.model.RestPreferenceModel; import org.alfresco.rest.model.RestPreferenceModel;
@@ -9,11 +15,6 @@ import org.alfresco.utility.model.*;
import org.alfresco.utility.report.Bug; import org.alfresco.utility.report.Bug;
import org.alfresco.utility.testrail.ExecutionType; import org.alfresco.utility.testrail.ExecutionType;
import org.alfresco.utility.testrail.annotation.TestRail; import org.alfresco.utility.testrail.annotation.TestRail;
import org.springframework.http.HttpStatus;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
import java.nio.file.Paths;
public class GetPeoplePreferenceFullTests extends RestTest public class GetPeoplePreferenceFullTests extends RestTest
{ {
@@ -29,8 +30,8 @@ public class GetPeoplePreferenceFullTests extends RestTest
dataSite.usingUser(userModel).usingSite(siteModel).addSiteToFavorites(); dataSite.usingUser(userModel).usingSite(siteModel).addSiteToFavorites();
} }
@Test(groups = { TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.REGRESSION }) @Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.REGRESSION})
@TestRail(section = { TestGroup.REST_API, TestGroup.PEOPLE,TestGroup.PREFERENCES }, executionType = ExecutionType.REGRESSION, @TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.REGRESSION,
description = "Check that properties parameter is applied") description = "Check that properties parameter is applied")
public void propertiesParameterIsAppliedWhenRetrievingPreference() throws Exception public void propertiesParameterIsAppliedWhenRetrievingPreference() throws Exception
{ {
@@ -47,8 +48,8 @@ public class GetPeoplePreferenceFullTests extends RestTest
.and().field("value").is("true"); .and().field("value").is("true");
} }
@Test(groups = { TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.REGRESSION }) @Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.REGRESSION})
@TestRail(section = { TestGroup.REST_API, TestGroup.PEOPLE,TestGroup.PREFERENCES }, executionType = ExecutionType.REGRESSION, @TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.REGRESSION,
description = "Validate ID element in get site preference response") description = "Validate ID element in get site preference response")
public void validateIdElementInGetSitePreferenceResponse() throws Exception public void validateIdElementInGetSitePreferenceResponse() throws Exception
{ {
@@ -58,8 +59,8 @@ public class GetPeoplePreferenceFullTests extends RestTest
.and().field("value").is("true"); .and().field("value").is("true");
} }
@Test(groups = { TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.REGRESSION }) @Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.REGRESSION})
@TestRail(section = { TestGroup.REST_API,TestGroup.PEOPLE, TestGroup.PREFERENCES }, executionType = ExecutionType.REGRESSION, @TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.REGRESSION,
description = "Validate ID element in get folder preference response") description = "Validate ID element in get folder preference response")
public void validateIdElementInGetFolderPreferenceResponse() throws Exception public void validateIdElementInGetFolderPreferenceResponse() throws Exception
{ {
@@ -73,8 +74,8 @@ public class GetPeoplePreferenceFullTests extends RestTest
.and().field("value").is(Utility.removeLastSlash(Utility.buildPath("workspace://SpacesStore", folderFavorite.getNodeRef()))); .and().field("value").is(Utility.removeLastSlash(Utility.buildPath("workspace://SpacesStore", folderFavorite.getNodeRef())));
} }
@Test(groups = { TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.REGRESSION }) @Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.REGRESSION})
@TestRail(section = { TestGroup.REST_API,TestGroup.PEOPLE, TestGroup.PREFERENCES }, executionType = ExecutionType.REGRESSION, @TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.REGRESSION,
description = "Validate ID element in get file preference response") description = "Validate ID element in get file preference response")
public void validateIdElementInGetFilePreferenceResponse() throws Exception public void validateIdElementInGetFilePreferenceResponse() throws Exception
{ {
@@ -88,8 +89,8 @@ public class GetPeoplePreferenceFullTests extends RestTest
.and().field("value").is(Utility.removeLastSlash(Utility.buildPath("workspace://SpacesStore", fileFavorite.getNodeRefWithoutVersion()))); .and().field("value").is(Utility.removeLastSlash(Utility.buildPath("workspace://SpacesStore", fileFavorite.getNodeRefWithoutVersion())));
} }
@Test(groups = { TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.REGRESSION }) @Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.REGRESSION})
@TestRail(section = { TestGroup.REST_API, TestGroup.PEOPLE,TestGroup.PREFERENCES }, executionType = ExecutionType.REGRESSION, @TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.REGRESSION,
description = "Get preference of an user that has no preferences") description = "Get preference of an user that has no preferences")
public void getPreferenceForUserWithoutPreferences() throws Exception public void getPreferenceForUserWithoutPreferences() throws Exception
{ {
@@ -114,8 +115,8 @@ public class GetPeoplePreferenceFullTests extends RestTest
PreferenceName.SITES_FAVORITES_PREFIX.toString())); PreferenceName.SITES_FAVORITES_PREFIX.toString()));
} }
@Test(groups = { TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.REGRESSION }) @Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.REGRESSION})
@TestRail(section = { TestGroup.REST_API, TestGroup.PEOPLE,TestGroup.PREFERENCES }, executionType = ExecutionType.REGRESSION, @TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.REGRESSION,
description = "Change one preference for an user then perform get call") description = "Change one preference for an user then perform get call")
@Bug(id = "REPO-1922") @Bug(id = "REPO-1922")
public void changePreferenceThenPerformGetPreferenceCall() throws Exception public void changePreferenceThenPerformGetPreferenceCall() throws Exception
@@ -162,8 +163,8 @@ public class GetPeoplePreferenceFullTests extends RestTest
PreferenceName.FOLDERS_FAVORITES_PREFIX.toString())); PreferenceName.FOLDERS_FAVORITES_PREFIX.toString()));
} }
@Test(groups = { TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.REGRESSION }) @Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.REGRESSION})
@TestRail(section = { TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES }, executionType = ExecutionType.REGRESSION, @TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.REGRESSION,
description = "Verify admin is able to get preference of another user") description = "Verify admin is able to get preference of another user")
public void adminIsAbleToGetOtherUserPreference() throws Exception public void adminIsAbleToGetOtherUserPreference() throws Exception
{ {
@@ -173,8 +174,8 @@ public class GetPeoplePreferenceFullTests extends RestTest
restPreferenceModel.assertThat().field("id").is(String.format(PreferenceName.SITES_FAVORITES_PREFIX.toString(), siteModel.getId())).and().field("value").is("true"); restPreferenceModel.assertThat().field("id").is(String.format(PreferenceName.SITES_FAVORITES_PREFIX.toString(), siteModel.getId())).and().field("value").is("true");
} }
@Test(groups = { TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.REGRESSION }) @Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.REGRESSION})
@TestRail(section = { TestGroup.REST_API, TestGroup.PEOPLE,TestGroup.PREFERENCES }, executionType = ExecutionType.REGRESSION, @TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.REGRESSION,
description = "Verify regular user is not able to get preference of admin user") description = "Verify regular user is not able to get preference of admin user")
public void regularUserIsNotAbleToGetAdminPreference() throws Exception public void regularUserIsNotAbleToGetAdminPreference() throws Exception
{ {
@@ -186,4 +187,48 @@ public class GetPeoplePreferenceFullTests extends RestTest
restClient.assertStatusCodeIs(HttpStatus.FORBIDDEN); restClient.assertStatusCodeIs(HttpStatus.FORBIDDEN);
restClient.assertLastError().containsSummary(RestErrorModel.PERMISSION_WAS_DENIED); restClient.assertLastError().containsSummary(RestErrorModel.PERMISSION_WAS_DENIED);
} }
@Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.REGRESSION})
@TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.REGRESSION,
description = "Verify regular user is able to change own preferences")
public void regularUserIsAbleToChangeOwnPreference() throws Exception
{
var newUser = dataUser.createRandomTestUser();
var newSite = dataSite.usingUser(newUser).createPublicRandomSite();
var preferenceId = String.format(PreferenceName.SITES_FAVORITES_PREFIX.toString(), newSite.getId());
var updatedPreferenceModel = new RestPreferenceModel();
updatedPreferenceModel.setId(preferenceId);
updatedPreferenceModel.setValue("");
dataSite.usingUser(newUser).usingSite(newSite).addSiteToFavorites();
restClient.authenticateUser(newUser).withCoreAPI().usingAuthUser()
.getPersonPreferenceInformation(preferenceId);
restClient.assertStatusCodeIs(HttpStatus.OK);
restClient.authenticateUser(newUser).withCoreAPI().usingAuthUser().updatePersonPreferenceInformation(preferenceId, updatedPreferenceModel);
restClient.assertStatusCodeIs(HttpStatus.OK);
var personPreferences = restClient.authenticateUser(newUser).withCoreAPI().usingAuthUser().getPersonPreferences();
personPreferences.assertThat().entriesListDoesNotContain("id", preferenceId);
}
@Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.REGRESSION})
@TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.REGRESSION,
description = "Verify admin is not able to change regular user preferences")
public void adminIsNotAbleToChangeRegularUserPreference() throws Exception
{
var newUser = dataUser.createRandomTestUser();
var newSite = dataSite.usingUser(newUser).createPublicRandomSite();
var preferenceId = String.format(PreferenceName.SITES_FAVORITES_PREFIX.toString(), newSite.getId());
var updatedPreferenceModel = new RestPreferenceModel();
updatedPreferenceModel.setId(preferenceId);
updatedPreferenceModel.setValue("");
dataSite.usingUser(newUser).usingSite(newSite).addSiteToFavorites();
restClient.authenticateUser(newUser).withCoreAPI().usingAuthUser()
.getPersonPreferenceInformation(preferenceId);
restClient.assertStatusCodeIs(HttpStatus.OK);
restClient.authenticateUser(dataUser.getAdminUser()).withCoreAPI().usingUser(newUser).updatePersonPreferenceInformation(preferenceId, updatedPreferenceModel);
restClient.assertStatusCodeIs(HttpStatus.NOT_FOUND);
}
} }

View File

@@ -1,7 +1,10 @@
package org.alfresco.rest.people.preferences; package org.alfresco.rest.people.preferences;
import org.springframework.http.HttpStatus;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
import org.alfresco.rest.RestTest; import org.alfresco.rest.RestTest;
import org.alfresco.rest.model.RestErrorModel;
import org.alfresco.rest.model.RestPreferenceModel; import org.alfresco.rest.model.RestPreferenceModel;
import org.alfresco.utility.constants.PreferenceName; import org.alfresco.utility.constants.PreferenceName;
import org.alfresco.utility.constants.UserRole; import org.alfresco.utility.constants.UserRole;
@@ -10,9 +13,6 @@ import org.alfresco.utility.model.TestGroup;
import org.alfresco.utility.model.UserModel; import org.alfresco.utility.model.UserModel;
import org.alfresco.utility.testrail.ExecutionType; import org.alfresco.utility.testrail.ExecutionType;
import org.alfresco.utility.testrail.annotation.TestRail; import org.alfresco.utility.testrail.annotation.TestRail;
import org.springframework.http.HttpStatus;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
/** /**
* Tests for Get a Peference (/people/{personId}/preferences/{preferenceName}) RestAPI call * Tests for Get a Peference (/people/{personId}/preferences/{preferenceName}) RestAPI call
@@ -33,8 +33,8 @@ public class GetPeoplePreferenceSanityTests extends RestTest
siteModel = dataSite.usingUser(userModel).createPublicRandomSite(); siteModel = dataSite.usingUser(userModel).createPublicRandomSite();
} }
@Test(groups = { TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.SANITY }) @Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.SANITY})
@TestRail(section = { TestGroup.REST_API, TestGroup.PEOPLE,TestGroup.PREFERENCES }, executionType = ExecutionType.SANITY, description = "Verify manager user gets a specific preference with Rest API and response is successful (200)") @TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.SANITY, description = "Verify manager user gets a specific preference with Rest API and response is successful (200)")
public void managerUserGetsAPreferenceWithSuccess() throws Exception public void managerUserGetsAPreferenceWithSuccess() throws Exception
{ {
UserModel managerUser = dataUser.usingAdmin().createRandomTestUser(); UserModel managerUser = dataUser.usingAdmin().createRandomTestUser();
@@ -47,8 +47,8 @@ public class GetPeoplePreferenceSanityTests extends RestTest
restPreferenceModel.assertThat().field("id").is(String.format(PreferenceName.SITES_FAVORITES_PREFIX.toString(), siteModel.getId())).and().field("value").is("true"); restPreferenceModel.assertThat().field("id").is(String.format(PreferenceName.SITES_FAVORITES_PREFIX.toString(), siteModel.getId())).and().field("value").is("true");
} }
@Test(groups = { TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.SANITY }) @Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.SANITY})
@TestRail(section = { TestGroup.REST_API, TestGroup.PEOPLE,TestGroup.PREFERENCES }, executionType = ExecutionType.SANITY, description = "Verify collaborator user gets a specific preference with Rest API and response is successful (200)") @TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.SANITY, description = "Verify collaborator user gets a specific preference with Rest API and response is successful (200)")
public void collaboratorUserGetsAPreferenceWithSuccess() throws Exception public void collaboratorUserGetsAPreferenceWithSuccess() throws Exception
{ {
UserModel collaboratorUser = dataUser.usingAdmin().createRandomTestUser(); UserModel collaboratorUser = dataUser.usingAdmin().createRandomTestUser();
@@ -61,8 +61,24 @@ public class GetPeoplePreferenceSanityTests extends RestTest
restPreferenceModel.assertThat().field("id").is(String.format(PreferenceName.SITES_FAVORITES_PREFIX.toString(), siteModel.getId())).and().field("value").is("true"); restPreferenceModel.assertThat().field("id").is(String.format(PreferenceName.SITES_FAVORITES_PREFIX.toString(), siteModel.getId())).and().field("value").is("true");
} }
@Test(groups = { TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.SANITY }) @Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.SANITY})
@TestRail(section = { TestGroup.REST_API, TestGroup.PEOPLE,TestGroup.PREFERENCES }, executionType = ExecutionType.SANITY, description = "Verify contributor user gets a specific preference with Rest API and response is successful (200)") @TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.SANITY, description = "Verify collaborator user gets a specific preference with Rest API and response is successful (200)")
public void collaboratorUserUpdatesAPreferenceWithSuccess() throws Exception
{
UserModel collaboratorUser = dataUser.usingAdmin().createRandomTestUser();
var updatedRestPreferenceModel = new RestPreferenceModel();
updatedRestPreferenceModel.setId("user.preference");
updatedRestPreferenceModel.setValue("user.value");
restPreferenceModel = restClient.authenticateUser(collaboratorUser).withCoreAPI().usingAuthUser()
.updatePersonPreferenceInformation(updatedRestPreferenceModel.getId(), updatedRestPreferenceModel);
restClient.assertStatusCodeIs(HttpStatus.OK);
restPreferenceModel.assertThat().field("id").is("user.preference").and().field("value").is("user.value");
}
@Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.SANITY})
@TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.SANITY, description = "Verify contributor user gets a specific preference with Rest API and response is successful (200)")
public void contributorUserGetsAPreferenceWithSuccess() throws Exception public void contributorUserGetsAPreferenceWithSuccess() throws Exception
{ {
UserModel contributorUser = dataUser.usingAdmin().createRandomTestUser(); UserModel contributorUser = dataUser.usingAdmin().createRandomTestUser();
@@ -75,8 +91,8 @@ public class GetPeoplePreferenceSanityTests extends RestTest
restPreferenceModel.assertThat().field("id").is(String.format(PreferenceName.SITES_FAVORITES_PREFIX.toString(), siteModel.getId())).and().field("value").is("true"); restPreferenceModel.assertThat().field("id").is(String.format(PreferenceName.SITES_FAVORITES_PREFIX.toString(), siteModel.getId())).and().field("value").is("true");
} }
@Test(groups = { TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.SANITY }) @Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.SANITY})
@TestRail(section = { TestGroup.REST_API,TestGroup.PEOPLE, TestGroup.PREFERENCES }, executionType = ExecutionType.SANITY, description = "Verify consumer user gets a specific preference with Rest API and response is successful (200)") @TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.SANITY, description = "Verify consumer user gets a specific preference with Rest API and response is successful (200)")
public void consumerUserGetsAPreferenceWithSuccess() throws Exception public void consumerUserGetsAPreferenceWithSuccess() throws Exception
{ {
UserModel consumerUser = dataUser.usingAdmin().createRandomTestUser(); UserModel consumerUser = dataUser.usingAdmin().createRandomTestUser();
@@ -84,13 +100,13 @@ public class GetPeoplePreferenceSanityTests extends RestTest
dataSite.usingUser(consumerUser).usingSite(siteModel).addSiteToFavorites(); dataSite.usingUser(consumerUser).usingSite(siteModel).addSiteToFavorites();
restPreferenceModel = restClient.authenticateUser(consumerUser).withCoreAPI().usingAuthUser() restPreferenceModel = restClient.authenticateUser(consumerUser).withCoreAPI().usingAuthUser()
.getPersonPreferenceInformation(String.format(PreferenceName.SITES_FAVORITES_PREFIX.toString(),siteModel.getId())); .getPersonPreferenceInformation(String.format(PreferenceName.SITES_FAVORITES_PREFIX.toString(), siteModel.getId()));
restClient.assertStatusCodeIs(HttpStatus.OK); restClient.assertStatusCodeIs(HttpStatus.OK);
restPreferenceModel.assertThat().field("id").is(String.format(PreferenceName.SITES_FAVORITES_PREFIX.toString(),siteModel.getId())).and().field("value").is("true"); restPreferenceModel.assertThat().field("id").is(String.format(PreferenceName.SITES_FAVORITES_PREFIX.toString(), siteModel.getId())).and().field("value").is("true");
} }
@Test(groups = { TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.SANITY }) @Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.SANITY})
@TestRail(section = { TestGroup.REST_API, TestGroup.PEOPLE,TestGroup.PREFERENCES }, executionType = ExecutionType.SANITY, description = "Verify admin user gets a specific preference with Rest API and response is successful (200)") @TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.SANITY, description = "Verify admin user gets a specific preference with Rest API and response is successful (200)")
public void adminUserGetsAPreferenceWithSuccess() throws Exception public void adminUserGetsAPreferenceWithSuccess() throws Exception
{ {
UserModel adminUser = dataUser.getAdminUser(); UserModel adminUser = dataUser.getAdminUser();
@@ -102,9 +118,9 @@ public class GetPeoplePreferenceSanityTests extends RestTest
restPreferenceModel.assertThat().field("id").is(String.format(PreferenceName.SITES_FAVORITES_PREFIX.toString(), siteModel.getId())).and().field("value").is("true"); restPreferenceModel.assertThat().field("id").is(String.format(PreferenceName.SITES_FAVORITES_PREFIX.toString(), siteModel.getId())).and().field("value").is("true");
} }
@Test(groups = { TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.SANITY }) @Test(groups = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES, TestGroup.SANITY})
@TestRail(section = { TestGroup.REST_API, TestGroup.PEOPLE,TestGroup.PREFERENCES }, executionType = ExecutionType.SANITY, description = "Verify manager user is NOT Authorized to get a specific preference with Rest API when authentication fails (401)") @TestRail(section = {TestGroup.REST_API, TestGroup.PEOPLE, TestGroup.PREFERENCES}, executionType = ExecutionType.SANITY, description = "Verify manager user is NOT Authorized to get a specific preference with Rest API when authentication fails (401)")
// @Bug(id = "MNT-16904", description = "fails only on environment with tenants") // @Bug(id = "MNT-16904", description = "fails only on environment with tenants")
public void managerUserNotAuthorizedFailsToGetsAPreference() throws Exception public void managerUserNotAuthorizedFailsToGetsAPreference() throws Exception
{ {
UserModel managerUser = dataUser.usingAdmin().createRandomTestUser(); UserModel managerUser = dataUser.usingAdmin().createRandomTestUser();

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Remote API * Alfresco Remote API
* %% * %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited * Copyright (C) 2005 - 2024 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of * If the software was purchased under a paid Alfresco license, the terms of
@@ -31,6 +31,9 @@ import org.alfresco.rest.framework.resource.parameters.Paging;
public interface Preferences public interface Preferences
{ {
public Preference getPreference(String personId, String preferenceName); Preference getPreference(String personId, String preferenceName);
public CollectionWithPagingInfo<Preference> getPreferences(String personId, Paging paging);
CollectionWithPagingInfo<Preference> getPreferences(String personId, Paging paging);
Preference updatePreference(String personId, Preference preference);
} }

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Remote API * Alfresco Remote API
* %% * %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited * Copyright (C) 2005 - 2024 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of * If the software was purchased under a paid Alfresco license, the terms of
@@ -27,7 +27,9 @@ package org.alfresco.rest.api.impl;
import java.io.Serializable; import java.io.Serializable;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map;
import org.alfresco.query.PagingResults; import org.alfresco.query.PagingResults;
import org.alfresco.rest.api.People; import org.alfresco.rest.api.People;
@@ -60,11 +62,12 @@ public class PreferencesImpl implements Preferences
this.preferenceService = preferenceService; this.preferenceService = preferenceService;
} }
@Override
public Preference getPreference(String personId, String preferenceName) public Preference getPreference(String personId, String preferenceName)
{ {
personId = people.validatePerson(personId); personId = people.validatePerson(personId);
Serializable preferenceValue = preferenceService.getPreference(personId, preferenceName); Serializable preferenceValue = preferenceService.getPreference(personId, preferenceName);
if(preferenceValue != null) if (preferenceValue != null)
{ {
return new Preference(preferenceName, preferenceValue); return new Preference(preferenceName, preferenceValue);
} }
@@ -74,13 +77,14 @@ public class PreferencesImpl implements Preferences
} }
} }
@Override
public CollectionWithPagingInfo<Preference> getPreferences(String personId, Paging paging) public CollectionWithPagingInfo<Preference> getPreferences(String personId, Paging paging)
{ {
personId = people.validatePerson(personId); personId = people.validatePerson(personId);
PagingResults<Pair<String, Serializable>> preferences = preferenceService.getPagedPreferences(personId, null, Util.getPagingRequest(paging)); PagingResults<Pair<String, Serializable>> preferences = preferenceService.getPagedPreferences(personId, null, Util.getPagingRequest(paging));
List<Preference> ret = new ArrayList<Preference>(preferences.getPage().size()); List<Preference> ret = new ArrayList<>(preferences.getPage().size());
for(Pair<String, Serializable> prefEntity : preferences.getPage()) for (Pair<String, Serializable> prefEntity : preferences.getPage())
{ {
Preference pref = new Preference(prefEntity.getFirst(), prefEntity.getSecond()); Preference pref = new Preference(prefEntity.getFirst(), prefEntity.getSecond());
ret.add(pref); ret.add(pref);
@@ -88,4 +92,23 @@ public class PreferencesImpl implements Preferences
return CollectionWithPagingInfo.asPaged(paging, ret, preferences.hasMoreItems(), preferences.getTotalResultCount().getFirst()); return CollectionWithPagingInfo.asPaged(paging, ret, preferences.hasMoreItems(), preferences.getTotalResultCount().getFirst());
} }
@Override
public Preference updatePreference(String personId, Preference preference)
{
personId = people.validatePerson(personId, true);
final Map<String, Serializable> preferencesToSet;
if (preference.getValue() == null || "".equals(preference.getValue()))
{
preferencesToSet = new HashMap<>(1);
preferencesToSet.put(preference.getName(), null);
}
else
{
preferencesToSet = Map.of(preference.getName(), preference.getValue());
}
preferenceService.setPreferences(personId, preferencesToSet);
return new Preference(preference.getName(), preferenceService.getPreference(personId, preference.getName()));
}
} }

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Remote API * Alfresco Remote API
* %% * %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited * Copyright (C) 2005 - 2024 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of * If the software was purchased under a paid Alfresco license, the terms of
@@ -25,20 +25,22 @@
*/ */
package org.alfresco.rest.api.people; package org.alfresco.rest.api.people;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.factory.InitializingBean;
import org.alfresco.rest.api.Preferences; import org.alfresco.rest.api.Preferences;
import org.alfresco.rest.api.model.Preference; import org.alfresco.rest.api.model.Preference;
import org.alfresco.rest.framework.WebApiDescription; import org.alfresco.rest.framework.WebApiDescription;
import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
import org.alfresco.rest.framework.resource.RelationshipResource; import org.alfresco.rest.framework.resource.RelationshipResource;
import org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction; import org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction;
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo; import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
import org.alfresco.rest.framework.resource.parameters.Parameters; import org.alfresco.rest.framework.resource.parameters.Parameters;
import org.alfresco.util.ParameterCheck; import org.alfresco.util.ParameterCheck;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.factory.InitializingBean;
@RelationshipResource(name = "preferences", entityResource = PeopleEntityResource.class, title = "Person Preferences") @RelationshipResource(name = "preferences", entityResource = PeopleEntityResource.class, title = "Person Preferences")
public class PersonPreferencesRelation implements RelationshipResourceAction.Read<Preference>, RelationshipResourceAction.ReadById<Preference>, InitializingBean public class PersonPreferencesRelation implements RelationshipResourceAction.Read<Preference>, RelationshipResourceAction.ReadById<Preference>, RelationshipResourceAction.Update<Preference>, InitializingBean
{ {
private static final Log logger = LogFactory.getLog(PersonPreferencesRelation.class); private static final Log logger = LogFactory.getLog(PersonPreferencesRelation.class);
@@ -82,7 +84,8 @@ public class PersonPreferencesRelation implements RelationshipResourceAction.Rea
{ {
// fix for REPO-855 // fix for REPO-855
String url = parameters.getRequest().getURL(); String url = parameters.getRequest().getURL();
if(url.matches(".*workspace://SpacesStore/.*")){ if (url.matches(".*workspace://SpacesStore/.*"))
{
preferenceName += url.substring(url.indexOf("//SpacesStore/")); preferenceName += url.substring(url.indexOf("//SpacesStore/"));
} }
// //
@@ -90,4 +93,13 @@ public class PersonPreferencesRelation implements RelationshipResourceAction.Rea
return preferences.getPreference(personId, preferenceName); return preferences.getPreference(personId, preferenceName);
} }
@Override
public Preference update(String personId, Preference preference, Parameters parameters)
{
if (preference.getName() == null || preference.getName().isBlank())
{
throw new InvalidArgumentException();
}
return preferences.updatePreference(personId, preference);
}
} }

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Remote API * Alfresco Remote API
* %% * %%
* Copyright (C) 2005 - 2020 Alfresco Software Limited * Copyright (C) 2005 - 2024 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of * If the software was purchased under a paid Alfresco license, the terms of
@@ -30,6 +30,15 @@ import java.io.InputStream;
import java.util.Locale; import java.util.Locale;
import java.util.Map; import java.util.Map;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.extensions.webscripts.WebScriptRequest;
import org.springframework.extensions.webscripts.WrappingWebScriptRequest;
import org.springframework.extensions.webscripts.servlet.WebScriptServletRequest;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.alfresco.repo.content.MimetypeMap; import org.alfresco.repo.content.MimetypeMap;
import org.alfresco.rest.framework.core.ResourceLocator; import org.alfresco.rest.framework.core.ResourceLocator;
import org.alfresco.rest.framework.core.ResourceMetadata; import org.alfresco.rest.framework.core.ResourceMetadata;
@@ -47,14 +56,7 @@ import org.alfresco.rest.framework.resource.parameters.Params;
import org.alfresco.rest.framework.resource.parameters.Params.RecognizedParams; import org.alfresco.rest.framework.resource.parameters.Params.RecognizedParams;
import org.alfresco.rest.framework.tools.RecognizedParamsExtractor; import org.alfresco.rest.framework.tools.RecognizedParamsExtractor;
import org.alfresco.rest.framework.tools.RequestReader; import org.alfresco.rest.framework.tools.RequestReader;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.extensions.webscripts.WebScriptRequest;
import org.springframework.extensions.webscripts.WrappingWebScriptRequest;
import org.springframework.extensions.webscripts.servlet.WebScriptServletRequest;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
/** /**
* Handles the HTTP PUT for a Resource, equivalent to CRUD Update * Handles the HTTP PUT for a Resource, equivalent to CRUD Update
* *
@@ -64,7 +66,7 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
RecognizedParamsExtractor, RequestReader RecognizedParamsExtractor, RequestReader
{ {
private static Log logger = LogFactory.getLog(ResourceWebScriptPut.class); private static final Log logger = LogFactory.getLog(ResourceWebScriptPut.class);
public ResourceWebScriptPut() public ResourceWebScriptPut()
{ {
@@ -90,11 +92,12 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
if (StringUtils.isBlank(entityId)) if (StringUtils.isBlank(entityId))
{ {
throw new UnsupportedResourceOperationException("PUT is executed against the instance URL"); throw new UnsupportedResourceOperationException("PUT is executed against the instance URL");
} else }
else
{ {
Object putEnt = extractJsonContent(req, assistant.getJsonHelper(), resourceMeta.getObjectType(operation)); Object putEnt = extractJsonContent(req, assistant.getJsonHelper(), resourceMeta.getObjectType(operation));
return Params.valueOf(entityId,params,putEnt, req); return Params.valueOf(entityId, params, putEnt, req);
} }
case RELATIONSHIP: case RELATIONSHIP:
if (StringUtils.isBlank(relationshipId)) if (StringUtils.isBlank(relationshipId))
@@ -110,8 +113,8 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
} }
else else
{ {
ResourceWebScriptHelper.setUniqueId(putRel,relationshipId); ResourceWebScriptHelper.setUniqueId(putRel, relationshipId);
return Params.valueOf(entityId, params, putRel, req); return Params.valueOf(entityId, relationshipId, params, putRel, req);
} }
case PROPERTY: case PROPERTY:
final String resourceName = resourceVars.get(ResourceLocator.RELATIONSHIP_RESOURCE); final String resourceName = resourceVars.get(ResourceLocator.RELATIONSHIP_RESOURCE);
@@ -129,7 +132,7 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
} }
} }
//Fall through to unsupported. // Fall through to unsupported.
default: default:
throw new UnsupportedResourceOperationException("PUT not supported for this request."); throw new UnsupportedResourceOperationException("PUT not supported for this request.");
} }
@@ -137,10 +140,13 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
/** /**
* Returns the basic content info from the request. * Returns the basic content info from the request.
* @param req WebScriptRequest *
* @param req
* WebScriptRequest
* @return BasicContentInfo * @return BasicContentInfo
*/ */
private BasicContentInfo getContentInfo(WebScriptRequest req) { private BasicContentInfo getContentInfo(WebScriptRequest req)
{
String encoding = "UTF-8"; String encoding = "UTF-8";
String contentType = MimetypeMap.MIMETYPE_BINARY; String contentType = MimetypeMap.MIMETYPE_BINARY;
@@ -148,7 +154,7 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
if (StringUtils.isNotEmpty(req.getContentType())) if (StringUtils.isNotEmpty(req.getContentType()))
{ {
MediaType media = MediaType.parseMediaType(req.getContentType()); MediaType media = MediaType.parseMediaType(req.getContentType());
contentType = media.getType()+'/'+media.getSubtype(); contentType = media.getType() + '/' + media.getSubtype();
if (media.getCharset() != null) if (media.getCharset() != null)
{ {
encoding = media.getCharset().toString(); encoding = media.getCharset().toString();
@@ -160,7 +166,9 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
/** /**
* Returns the input stream for the request * Returns the input stream for the request
* @param req WebScriptRequest *
* @param req
* WebScriptRequest
* @return InputStream * @return InputStream
*/ */
private InputStream getStream(WebScriptRequest req) private InputStream getStream(WebScriptRequest req)
@@ -189,8 +197,11 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
/** /**
* Executes the action on the resource * Executes the action on the resource
* @param resource ResourceWithMetadata *
* @param params parameters to use * @param resource
* ResourceWithMetadata
* @param params
* parameters to use
* @return anObject the result of the execute * @return anObject the result of the execute
*/ */
@Override @Override
@@ -203,7 +214,7 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
{ {
if (resource.getMetaData().isDeleted(EntityResourceAction.Update.class)) if (resource.getMetaData().isDeleted(EntityResourceAction.Update.class))
{ {
throw new DeletedResourceException("(UPDATE) "+resource.getMetaData().getUniqueId()); throw new DeletedResourceException("(UPDATE) " + resource.getMetaData().getUniqueId());
} }
EntityResourceAction.Update<Object> updateEnt = (EntityResourceAction.Update<Object>) resource.getResource(); EntityResourceAction.Update<Object> updateEnt = (EntityResourceAction.Update<Object>) resource.getResource();
Object result = updateEnt.update(params.getEntityId(), params.getPassedIn(), params); Object result = updateEnt.update(params.getEntityId(), params.getPassedIn(), params);
@@ -213,7 +224,7 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
{ {
if (resource.getMetaData().isDeleted(EntityResourceAction.UpdateWithResponse.class)) if (resource.getMetaData().isDeleted(EntityResourceAction.UpdateWithResponse.class))
{ {
throw new DeletedResourceException("(UPDATE) "+resource.getMetaData().getUniqueId()); throw new DeletedResourceException("(UPDATE) " + resource.getMetaData().getUniqueId());
} }
EntityResourceAction.UpdateWithResponse<Object> updateEnt = (EntityResourceAction.UpdateWithResponse<Object>) resource.getResource(); EntityResourceAction.UpdateWithResponse<Object> updateEnt = (EntityResourceAction.UpdateWithResponse<Object>) resource.getResource();
Object result = updateEnt.update(params.getEntityId(), params.getPassedIn(), params, withResponse); Object result = updateEnt.update(params.getEntityId(), params.getPassedIn(), params, withResponse);
@@ -224,7 +235,7 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
{ {
if (resource.getMetaData().isDeleted(RelationshipResourceAction.UpdateWithResponse.class)) if (resource.getMetaData().isDeleted(RelationshipResourceAction.UpdateWithResponse.class))
{ {
throw new DeletedResourceException("(UPDATE) "+resource.getMetaData().getUniqueId()); throw new DeletedResourceException("(UPDATE) " + resource.getMetaData().getUniqueId());
} }
RelationshipResourceAction.UpdateWithResponse<Object> relationUpdater = (RelationshipResourceAction.UpdateWithResponse<Object>) resource.getResource(); RelationshipResourceAction.UpdateWithResponse<Object> relationUpdater = (RelationshipResourceAction.UpdateWithResponse<Object>) resource.getResource();
Object relResult = relationUpdater.update(params.getEntityId(), params.getPassedIn(), params, withResponse); Object relResult = relationUpdater.update(params.getEntityId(), params.getPassedIn(), params, withResponse);
@@ -234,7 +245,7 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
{ {
if (resource.getMetaData().isDeleted(RelationshipResourceAction.Update.class)) if (resource.getMetaData().isDeleted(RelationshipResourceAction.Update.class))
{ {
throw new DeletedResourceException("(UPDATE) "+resource.getMetaData().getUniqueId()); throw new DeletedResourceException("(UPDATE) " + resource.getMetaData().getUniqueId());
} }
RelationshipResourceAction.Update<Object> relationUpdater = (RelationshipResourceAction.Update<Object>) resource.getResource(); RelationshipResourceAction.Update<Object> relationUpdater = (RelationshipResourceAction.Update<Object>) resource.getResource();
Object relResult = relationUpdater.update(params.getEntityId(), params.getPassedIn(), params); Object relResult = relationUpdater.update(params.getEntityId(), params.getPassedIn(), params);
@@ -245,7 +256,7 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
{ {
if (resource.getMetaData().isDeleted(BinaryResourceAction.Update.class)) if (resource.getMetaData().isDeleted(BinaryResourceAction.Update.class))
{ {
throw new DeletedResourceException("(UPDATE) "+resource.getMetaData().getUniqueId()); throw new DeletedResourceException("(UPDATE) " + resource.getMetaData().getUniqueId());
} }
BinaryResourceAction.Update<Object> binUpdater = (BinaryResourceAction.Update<Object>) resource.getResource(); BinaryResourceAction.Update<Object> binUpdater = (BinaryResourceAction.Update<Object>) resource.getResource();
return binUpdater.updateProperty(params.getEntityId(), params.getContentInfo(), params.getStream(), params); return binUpdater.updateProperty(params.getEntityId(), params.getContentInfo(), params.getStream(), params);
@@ -254,7 +265,7 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
{ {
if (resource.getMetaData().isDeleted(BinaryResourceAction.UpdateWithResponse.class)) if (resource.getMetaData().isDeleted(BinaryResourceAction.UpdateWithResponse.class))
{ {
throw new DeletedResourceException("(UPDATE) "+resource.getMetaData().getUniqueId()); throw new DeletedResourceException("(UPDATE) " + resource.getMetaData().getUniqueId());
} }
BinaryResourceAction.UpdateWithResponse<Object> binUpdater = (BinaryResourceAction.UpdateWithResponse<Object>) resource.getResource(); BinaryResourceAction.UpdateWithResponse<Object> binUpdater = (BinaryResourceAction.UpdateWithResponse<Object>) resource.getResource();
return binUpdater.updateProperty(params.getEntityId(), params.getContentInfo(), params.getStream(), params, withResponse); return binUpdater.updateProperty(params.getEntityId(), params.getContentInfo(), params.getStream(), params, withResponse);
@@ -263,7 +274,7 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
{ {
if (resource.getMetaData().isDeleted(RelationshipResourceBinaryAction.Update.class)) if (resource.getMetaData().isDeleted(RelationshipResourceBinaryAction.Update.class))
{ {
throw new DeletedResourceException("(UPDATE) "+resource.getMetaData().getUniqueId()); throw new DeletedResourceException("(UPDATE) " + resource.getMetaData().getUniqueId());
} }
RelationshipResourceBinaryAction.Update<Object> binUpdater = (RelationshipResourceBinaryAction.Update<Object>) resource.getResource(); RelationshipResourceBinaryAction.Update<Object> binUpdater = (RelationshipResourceBinaryAction.Update<Object>) resource.getResource();
return binUpdater.updateProperty(params.getEntityId(), params.getRelationshipId(), params.getContentInfo(), params.getStream(), params); return binUpdater.updateProperty(params.getEntityId(), params.getRelationshipId(), params.getContentInfo(), params.getStream(), params);
@@ -272,7 +283,7 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
{ {
if (resource.getMetaData().isDeleted(RelationshipResourceBinaryAction.UpdateWithResponse.class)) if (resource.getMetaData().isDeleted(RelationshipResourceBinaryAction.UpdateWithResponse.class))
{ {
throw new DeletedResourceException("(UPDATE) "+resource.getMetaData().getUniqueId()); throw new DeletedResourceException("(UPDATE) " + resource.getMetaData().getUniqueId());
} }
RelationshipResourceBinaryAction.UpdateWithResponse<Object> binUpdater = (RelationshipResourceBinaryAction.UpdateWithResponse<Object>) resource.getResource(); RelationshipResourceBinaryAction.UpdateWithResponse<Object> binUpdater = (RelationshipResourceBinaryAction.UpdateWithResponse<Object>) resource.getResource();
return binUpdater.updateProperty(params.getEntityId(), params.getRelationshipId(), params.getContentInfo(), params.getStream(), params, withResponse); return binUpdater.updateProperty(params.getEntityId(), params.getRelationshipId(), params.getContentInfo(), params.getStream(), params, withResponse);

View File

@@ -2,7 +2,7 @@
* #%L * #%L
* Alfresco Remote API * Alfresco Remote API
* %% * %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited * Copyright (C) 2005 - 2024 Alfresco Software Limited
* %% * %%
* This file is part of the Alfresco software. * This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of * If the software was purchased under a paid Alfresco license, the terms of
@@ -31,6 +31,9 @@ import static org.junit.Assert.fail;
import java.util.*; import java.util.*;
import org.apache.commons.httpclient.HttpStatus;
import org.junit.Test;
import org.alfresco.repo.tenant.TenantUtil; import org.alfresco.repo.tenant.TenantUtil;
import org.alfresco.repo.tenant.TenantUtil.TenantRunAsWork; import org.alfresco.repo.tenant.TenantUtil.TenantRunAsWork;
import org.alfresco.rest.api.tests.RepoService.TestNetwork; import org.alfresco.rest.api.tests.RepoService.TestNetwork;
@@ -42,8 +45,6 @@ import org.alfresco.rest.api.tests.client.PublicApiException;
import org.alfresco.rest.api.tests.client.RequestContext; import org.alfresco.rest.api.tests.client.RequestContext;
import org.alfresco.rest.api.tests.client.data.Preference; import org.alfresco.rest.api.tests.client.data.Preference;
import org.alfresco.util.GUID; import org.alfresco.util.GUID;
import org.apache.commons.httpclient.HttpStatus;
import org.junit.Test;
public class TestUserPreferences extends EnterpriseTestApi public class TestUserPreferences extends EnterpriseTestApi
{ {
@@ -59,8 +60,7 @@ public class TestUserPreferences extends EnterpriseTestApi
final List<TestPerson> people = new ArrayList<TestPerson>(3); final List<TestPerson> people = new ArrayList<TestPerson>(3);
// create users and some preferences // create users and some preferences
TenantUtil.runAsSystemTenant(new TenantRunAsWork<Void>() TenantUtil.runAsSystemTenant(new TenantRunAsWork<Void>() {
{
@Override @Override
public Void doWork() throws Exception public Void doWork() throws Exception
{ {
@@ -72,8 +72,7 @@ public class TestUserPreferences extends EnterpriseTestApi
} }
}, network1.getId()); }, network1.getId());
TenantUtil.runAsSystemTenant(new TenantRunAsWork<Void>() TenantUtil.runAsSystemTenant(new TenantRunAsWork<Void>() {
{
@Override @Override
public Void doWork() throws Exception public Void doWork() throws Exception
{ {
@@ -95,12 +94,11 @@ public class TestUserPreferences extends EnterpriseTestApi
// new preference name for issue REPO-855 // new preference name for issue REPO-855
expectedPreferences.add(new Preference("org.alfresco.ext.folders.favourites.workspace://SpacesStore/4e3d0779-388a-4b94-91e1-eab588a7da3d.createdAt", String.valueOf(true))); expectedPreferences.add(new Preference("org.alfresco.ext.folders.favourites.workspace://SpacesStore/4e3d0779-388a-4b94-91e1-eab588a7da3d.createdAt", String.valueOf(true)));
TenantUtil.runAsUserTenant(new TenantRunAsWork<Void>() TenantUtil.runAsUserTenant(new TenantRunAsWork<Void>() {
{
@Override @Override
public Void doWork() throws Exception public Void doWork() throws Exception
{ {
for(Preference pref : expectedPreferences) for (Preference pref : expectedPreferences)
{ {
// TODO add preferences thru api // TODO add preferences thru api
repoService.addPreference(person1.getId(), pref.getId(), pref.getValue()); repoService.addPreference(person1.getId(), pref.getId(), pref.getValue());
@@ -128,7 +126,7 @@ public class TestUserPreferences extends EnterpriseTestApi
fail(); fail();
} }
catch(PublicApiException e) catch (PublicApiException e)
{ {
assertEquals(HttpStatus.SC_NOT_FOUND, e.getHttpResponse().getStatusCode()); assertEquals(HttpStatus.SC_NOT_FOUND, e.getHttpResponse().getStatusCode());
} }
@@ -172,7 +170,7 @@ public class TestUserPreferences extends EnterpriseTestApi
peopleProxy.getPreferences("invalid.user", createParams(paging, null)); peopleProxy.getPreferences("invalid.user", createParams(paging, null));
fail(""); fail("");
} }
catch(PublicApiException e) catch (PublicApiException e)
{ {
assertEquals(HttpStatus.SC_NOT_FOUND, e.getHttpResponse().getStatusCode()); assertEquals(HttpStatus.SC_NOT_FOUND, e.getHttpResponse().getStatusCode());
} }
@@ -184,12 +182,12 @@ public class TestUserPreferences extends EnterpriseTestApi
int maxItems = 2; int maxItems = 2;
publicApiClient.setRequestContext(new RequestContext(network1.getId(), person3.getId())); publicApiClient.setRequestContext(new RequestContext(network1.getId(), person3.getId()));
Paging paging = getPaging(skipCount, maxItems, expectedPreferences.size(), expectedPreferences.size()); Paging paging = getPaging(skipCount, maxItems, expectedPreferences.size(), expectedPreferences.size());
// ListResponse<Preference> resp = peopleProxy.getPreferences(person1.getId(), createParams(paging, null)); // ListResponse<Preference> resp = peopleProxy.getPreferences(person1.getId(), createParams(paging, null));
// checkList(expectedPreferences.subList(skipCount, skipCount + paging.getExpectedPaging().getCount()), paging.getExpectedPaging(), resp); // checkList(expectedPreferences.subList(skipCount, skipCount + paging.getExpectedPaging().getCount()), paging.getExpectedPaging(), resp);
peopleProxy.getPreferences(person1.getId(), createParams(paging, null)); peopleProxy.getPreferences(person1.getId(), createParams(paging, null));
fail(); fail();
} }
catch(PublicApiException e) catch (PublicApiException e)
{ {
assertEquals(e.getHttpResponse().getStatusCode(), HttpStatus.SC_UNAUTHORIZED); assertEquals(e.getHttpResponse().getStatusCode(), HttpStatus.SC_UNAUTHORIZED);
} }
@@ -204,7 +202,7 @@ public class TestUserPreferences extends EnterpriseTestApi
peopleProxy.getPreferences(person1.getId(), createParams(paging, null)); peopleProxy.getPreferences(person1.getId(), createParams(paging, null));
fail(); fail();
} }
catch(PublicApiException e) catch (PublicApiException e)
{ {
assertEquals(HttpStatus.SC_FORBIDDEN, e.getHttpResponse().getStatusCode()); assertEquals(HttpStatus.SC_FORBIDDEN, e.getHttpResponse().getStatusCode());
} }
@@ -227,7 +225,7 @@ public class TestUserPreferences extends EnterpriseTestApi
peopleProxy.getPreference(GUID.generate(), pref.getId()); peopleProxy.getPreference(GUID.generate(), pref.getId());
fail(); fail();
} }
catch(PublicApiException e) catch (PublicApiException e)
{ {
assertEquals(HttpStatus.SC_NOT_FOUND, e.getHttpResponse().getStatusCode()); assertEquals(HttpStatus.SC_NOT_FOUND, e.getHttpResponse().getStatusCode());
} }
@@ -239,7 +237,7 @@ public class TestUserPreferences extends EnterpriseTestApi
peopleProxy.getPreference(person1.getId(), GUID.generate()); peopleProxy.getPreference(person1.getId(), GUID.generate());
fail(); fail();
} }
catch(PublicApiException e) catch (PublicApiException e)
{ {
assertEquals(HttpStatus.SC_NOT_FOUND, e.getHttpResponse().getStatusCode()); assertEquals(HttpStatus.SC_NOT_FOUND, e.getHttpResponse().getStatusCode());
} }
@@ -254,22 +252,19 @@ public class TestUserPreferences extends EnterpriseTestApi
peopleProxy.create("people", person1.getId(), "preferences", pref.getId(), pref.toJSON().toString(), "Unable to POST to a preference"); peopleProxy.create("people", person1.getId(), "preferences", pref.getId(), pref.toJSON().toString(), "Unable to POST to a preference");
fail(); fail();
} }
catch(PublicApiException e) catch (PublicApiException e)
{ {
assertEquals(HttpStatus.SC_METHOD_NOT_ALLOWED, e.getHttpResponse().getStatusCode()); assertEquals(HttpStatus.SC_METHOD_NOT_ALLOWED, e.getHttpResponse().getStatusCode());
} }
try
{ {
Preference pref = expectedPreferences.get(0); Preference updatedPref = new Preference("preference.to.update", "updated.value");
publicApiClient.setRequestContext(new RequestContext(network1.getId(), person1.getId())); publicApiClient.setRequestContext(new RequestContext(network1.getId(), person1.getId()));
peopleProxy.update("people", person1.getId(), "preferences", pref.getId(), pref.toJSON().toString(), "Unable to PUT a preference"); Preference response = peopleProxy.updatePreference(person1.getId(), updatedPref);
fail();
} assertEquals(updatedPref.getId(), response.getId());
catch(PublicApiException e) assertEquals(updatedPref.getValue(), response.getValue());
{
assertEquals(HttpStatus.SC_METHOD_NOT_ALLOWED, e.getHttpResponse().getStatusCode());
} }
try try
@@ -280,7 +275,7 @@ public class TestUserPreferences extends EnterpriseTestApi
peopleProxy.remove("people", person1.getId(), "preferences", pref.getId(), "Unable to DELETE a preference"); peopleProxy.remove("people", person1.getId(), "preferences", pref.getId(), "Unable to DELETE a preference");
fail(); fail();
} }
catch(PublicApiException e) catch (PublicApiException e)
{ {
assertEquals(HttpStatus.SC_METHOD_NOT_ALLOWED, e.getHttpResponse().getStatusCode()); assertEquals(HttpStatus.SC_METHOD_NOT_ALLOWED, e.getHttpResponse().getStatusCode());
} }
@@ -293,7 +288,7 @@ public class TestUserPreferences extends EnterpriseTestApi
peopleProxy.create("people", person1.getId(), "preferences", null, pref.toJSON().toString(), "Unable to POST to preferences"); peopleProxy.create("people", person1.getId(), "preferences", null, pref.toJSON().toString(), "Unable to POST to preferences");
fail(); fail();
} }
catch(PublicApiException e) catch (PublicApiException e)
{ {
assertEquals(HttpStatus.SC_METHOD_NOT_ALLOWED, e.getHttpResponse().getStatusCode()); assertEquals(HttpStatus.SC_METHOD_NOT_ALLOWED, e.getHttpResponse().getStatusCode());
} }
@@ -306,7 +301,7 @@ public class TestUserPreferences extends EnterpriseTestApi
peopleProxy.update("people", person1.getId(), "preferences", null, pref.toJSON().toString(), "Unable to PUT preferences"); peopleProxy.update("people", person1.getId(), "preferences", null, pref.toJSON().toString(), "Unable to PUT preferences");
fail(); fail();
} }
catch(PublicApiException e) catch (PublicApiException e)
{ {
assertEquals(HttpStatus.SC_METHOD_NOT_ALLOWED, e.getHttpResponse().getStatusCode()); assertEquals(HttpStatus.SC_METHOD_NOT_ALLOWED, e.getHttpResponse().getStatusCode());
} }
@@ -317,7 +312,7 @@ public class TestUserPreferences extends EnterpriseTestApi
peopleProxy.remove("people", person1.getId(), "preferences", null, "Unable to DELETE preferences"); peopleProxy.remove("people", person1.getId(), "preferences", null, "Unable to DELETE preferences");
fail(); fail();
} }
catch(PublicApiException e) catch (PublicApiException e)
{ {
assertEquals(HttpStatus.SC_METHOD_NOT_ALLOWED, e.getHttpResponse().getStatusCode()); assertEquals(HttpStatus.SC_METHOD_NOT_ALLOWED, e.getHttpResponse().getStatusCode());
} }