mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-09-10 14:11:58 +00:00
Compare commits
320 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
71a88870bd | ||
|
6bcf33d672 | ||
|
81f2bd7018 | ||
|
b3968bcd9e | ||
|
307eaff896 | ||
|
0cfedbc979 | ||
|
89522ba09d | ||
|
86761bd408 | ||
|
4d6b4c2ecf | ||
|
98cb7762c4 | ||
|
ee01595f31 | ||
|
75acf5110e | ||
|
3a5971e267 | ||
|
99ef570054 | ||
|
9649324d33 | ||
|
ad96f85251 | ||
|
7ac48f8a99 | ||
|
aa38bcf9df | ||
|
86d1d36ffe | ||
|
b557a0d0f1 | ||
|
1f81a50677 | ||
|
855e2522f2 | ||
|
f342b27c74 | ||
|
b00f01d385 | ||
|
ce68c4bf8b | ||
|
2544885f5e | ||
|
1f7b272e57 | ||
|
df92ff9328 | ||
|
b262c8fb92 | ||
|
0254323de5 | ||
|
89e8f7ff66 | ||
|
5735a41a40 | ||
|
68b9a0e8a6 | ||
|
39f4a2179e | ||
|
440f0568e3 | ||
|
67f7fff0b7 | ||
|
1a08480f22 | ||
|
8afd06a57f | ||
|
5e82555269 | ||
|
3682ddf652 | ||
|
6747e300af | ||
|
4bb2f67a48 | ||
|
c5c6b45f17 | ||
|
1d9823d2e9 | ||
|
bfae9dd78d | ||
|
86af67a435 | ||
|
7ce6c121ef | ||
|
d0061fb530 | ||
|
1c91452ee9 | ||
|
f707906943 | ||
|
af7e9f97aa | ||
|
e9105f0f0c | ||
|
282186b877 | ||
|
5ab44f4f35 | ||
|
bf855c5965 | ||
|
d02f88eed4 | ||
|
e487061e96 | ||
|
615406d5a1 | ||
|
548fc9e64a | ||
|
e7cc9ba008 | ||
|
e10e9fe1c5 | ||
|
d5a33e3f03 | ||
|
b62dfc1d76 | ||
|
3711be4e80 | ||
|
33297757bf | ||
|
5f9c8fc499 | ||
|
119ff309ac | ||
|
a93dd27674 | ||
|
609ffdcbf0 | ||
|
85baa164db | ||
|
8776109582 | ||
|
c8cf52baef | ||
|
9d82828959 | ||
|
d475c74707 | ||
|
cc3ea3167b | ||
|
36f1c7083c | ||
|
22a158a1ee | ||
|
2a75a304a9 | ||
|
472b3d044f | ||
|
e2db0aab11 | ||
|
031efe67d7 | ||
|
e22b5fff86 | ||
|
91e2421d7c | ||
|
529f6b31e8 | ||
|
4bc36ae18d | ||
|
47187ee12e | ||
|
520b9e7fcb | ||
|
73518a0342 | ||
|
cc1682c209 | ||
|
c9d7d0993e | ||
|
ec13ac08c4 | ||
|
e0df4e8831 | ||
|
dffdb59b05 | ||
|
1d03f3aaa6 | ||
|
21e444da9f | ||
|
a512c3443c | ||
|
e4f9c5539b | ||
|
2a5df0dd7c | ||
|
be7d4be636 | ||
|
d40ed346a7 | ||
|
8c556eeaca | ||
|
d0eea6835e | ||
|
031dde6293 | ||
|
819f0c9921 | ||
|
0b2e9e0a97 | ||
|
09ce322111 | ||
|
49cedfc40c | ||
|
dcc739db76 | ||
|
0aa4b5de9c | ||
|
f196de23b0 | ||
|
59901e44fe | ||
|
964cd86e00 | ||
|
636ef33cc0 | ||
|
0d3ab4d921 | ||
|
02a0454055 | ||
|
653f685dc9 | ||
|
2362ef986b | ||
|
dc5404b8c2 | ||
|
125b35e11c | ||
|
a77584a398 | ||
|
541bf63d80 | ||
|
19a061dc04 | ||
|
b1282cba89 | ||
|
d137dd89ec | ||
|
9c8f98c12f | ||
|
e0d52f98ae | ||
|
c4d432b136 | ||
|
e0844d72e1 | ||
|
857771593b | ||
|
a80ac51b5d | ||
|
d7d50d0a67 | ||
|
11dd5307a7 | ||
|
a038f068ab | ||
|
cc1c539a4c | ||
|
3407899f20 | ||
|
1c69cd2e61 | ||
|
02ba54ab3a | ||
|
4116cae611 | ||
|
c300affa6d | ||
|
dba0dc9083 | ||
|
2c43a64fd0 | ||
|
af2b00cc6b | ||
|
767f6a6af2 | ||
|
4990a8b316 | ||
|
af348eac49 | ||
|
e56b97a6fb | ||
|
f32e554eb7 | ||
|
e0cdf1b3fe | ||
|
1517ff6e85 | ||
|
ea8481ca98 | ||
|
5a8e73c03e | ||
|
c89969422e | ||
|
4e2f8fb8e6 | ||
|
e84481d7f3 | ||
|
6ea0f9b189 | ||
|
8def39fe6c | ||
|
d290c129bc | ||
|
15ba054b16 | ||
|
3e54162fcc | ||
|
d24baf9ecd | ||
|
2223f845bb | ||
|
ee40a2140e | ||
|
c01147f2b7 | ||
|
2d69902c25 | ||
|
ff3da00a40 | ||
|
2cd96b1522 | ||
|
38300fbac3 | ||
|
9031ed139f | ||
|
298283cf7a | ||
|
8026af1706 | ||
|
20ec3351b3 | ||
|
e79b434c54 | ||
|
163add3bfd | ||
|
ba2367bf92 | ||
|
84857e1a71 | ||
|
cda1c682ae | ||
|
c11b951e57 | ||
|
fc5a7f5838 | ||
|
3fde3cbadb | ||
|
ac1a77156e | ||
|
e66263a5a8 | ||
|
a410dbe538 | ||
|
48f53d204d | ||
|
b589d574ea | ||
|
a04f743318 | ||
|
d4aa429643 | ||
|
ebdc01300d | ||
|
977681ba9b | ||
|
e457a8b7c7 | ||
|
772109d629 | ||
|
ee8adb45fb | ||
|
7daf864168 | ||
|
9744b1da4d | ||
|
033a00075f | ||
|
2a48160442 | ||
|
64955658fc | ||
|
bec0ac0236 | ||
|
b22595058e | ||
|
742a4c89dd | ||
|
09db0fcad3 | ||
|
9c989c424f | ||
|
c338001de2 | ||
|
c6519c2a3f | ||
|
c7559ba8b1 | ||
|
c5fcce20f1 | ||
|
0a97d98271 | ||
|
83cd90c85e | ||
|
6186757322 | ||
|
27344421e0 | ||
|
a8f9d4df81 | ||
|
366cea6e33 | ||
|
eb9792339f | ||
|
fcb7ec339f | ||
|
110a21cf27 | ||
|
bfc9fdc802 | ||
|
ff8e95e1cf | ||
|
8e5a259204 | ||
|
f993a9c904 | ||
|
4cd63227ae | ||
|
f42e8b2e82 | ||
|
fff66fea81 | ||
|
451736a9b4 | ||
|
7c2ae622ad | ||
|
2d34b3579b | ||
|
78d98bba49 | ||
|
d8085b463f | ||
|
1ff9c13985 | ||
|
f23c013950 | ||
|
e7f6d7aa15 | ||
|
7d00b5a965 | ||
|
78df8e8f18 | ||
|
56fca4f248 | ||
|
7646714e3a | ||
|
68948a568a | ||
|
c10c522a00 | ||
|
a6fb00721c | ||
|
b07a96a289 | ||
|
fb58ef512e | ||
|
99d4b52ccb | ||
|
6946969ab9 | ||
|
e1dbd1d4fe | ||
|
0723852ac3 | ||
|
3dbcbfa535 | ||
|
163c938848 | ||
|
e334c60d7a | ||
|
f159e66c1b | ||
|
83e4ace76f | ||
|
c60f940cc1 | ||
|
81abbf55b4 | ||
|
f97a9605f2 | ||
|
0c81885ea0 | ||
|
248830e77f | ||
|
9c950f767f | ||
|
13b23ad55f | ||
|
01f19d717b | ||
|
4aeffd2647 | ||
|
03f02a7687 | ||
|
d70555e60a | ||
|
255c6c8e8a | ||
|
961b336c11 | ||
|
ec79172479 | ||
|
47de5d9e0a | ||
|
4cb843024c | ||
|
b8cb5d89a6 | ||
|
d61e5826f7 | ||
|
8238947ee0 | ||
|
129dac1916 | ||
|
cb5548914a | ||
|
32b66fad2b | ||
|
475dd43a32 | ||
|
178ae7375a | ||
|
d935b7fc2e | ||
|
5bb26afe91 | ||
|
8c121889ae | ||
|
e241c2a4ec | ||
|
da1fd787e7 | ||
|
0cf76c6d3f | ||
|
347c05c855 | ||
|
440a3640a9 | ||
|
9d4c92bedf | ||
|
e5655effee | ||
|
cf6495a22c | ||
|
f917f67a00 | ||
|
f33e7b9555 | ||
|
cfec11a246 | ||
|
c066e42152 | ||
|
d2ab9a7998 | ||
|
15dea80d0a | ||
|
28ef5fa32c | ||
|
7da7544c37 | ||
|
98bc091adc | ||
|
8839ed7027 | ||
|
3ee1db50f8 | ||
|
3fbbf5a891 | ||
|
fb7e03b02f | ||
|
e6e1245a7a | ||
|
2e499fb377 | ||
|
b25dbeb608 | ||
|
8fba004f83 | ||
|
47b391315b | ||
|
deade9c64c | ||
|
ffe1d0a158 | ||
|
1cd2352dc9 | ||
|
a27871e7a7 | ||
|
030363d7c0 | ||
|
0af021b469 | ||
|
0dc4f3fbf7 | ||
|
988846e1df | ||
|
67e366def2 | ||
|
a673102baf | ||
|
652c0784d5 | ||
|
5ca5e96b7e | ||
|
ed39b9a114 | ||
|
35e543f37d | ||
|
a8585b55cb | ||
|
3ffb350567 | ||
|
4d2073e4c5 | ||
|
19ebec0320 | ||
|
0c23a3fa4b | ||
|
3c2269f51c |
10
.travis.yml
10
.travis.yml
@@ -264,6 +264,7 @@ jobs:
|
||||
- ${TAS_SCRIPTS}/start-compose.sh ${TAS_ENVIRONMENT}/docker-compose-minimal+transforms.yml
|
||||
- ${TAS_SCRIPTS}/wait-for-alfresco-start.sh "http://localhost:8082/alfresco"
|
||||
script: travis_wait 60 mvn -B verify -f packaging/tests/tas-restapi/pom.xml -Pall-tas-tests,run-restapi-part1 -Denvironment=default -DrunBugs=false
|
||||
after_failure: ${TAS_SCRIPTS}/output_logs_for_failures.sh "packaging/tests/tas-restapi"
|
||||
|
||||
- name: "REST API TAS tests part2"
|
||||
if: (branch =~ /(release\/.*$|master)/ AND commit_message !~ /\[skip tas\]/) OR commit_message =~ /\[tas\]/
|
||||
@@ -272,6 +273,7 @@ jobs:
|
||||
- ${TAS_SCRIPTS}/start-compose.sh ${TAS_ENVIRONMENT}/docker-compose-minimal+transforms.yml
|
||||
- ${TAS_SCRIPTS}/wait-for-alfresco-start.sh "http://localhost:8082/alfresco"
|
||||
script: travis_wait 60 mvn -B verify -f packaging/tests/tas-restapi/pom.xml -Pall-tas-tests,run-restapi-part2 -Denvironment=default -DrunBugs=false
|
||||
after_failure: ${TAS_SCRIPTS}/output_logs_for_failures.sh "packaging/tests/tas-restapi"
|
||||
|
||||
- name: "REST API TAS tests part3"
|
||||
if: (branch =~ /(release\/.*$|master)/ AND commit_message !~ /\[skip tas\]/) OR commit_message =~ /\[tas\]/
|
||||
@@ -280,6 +282,7 @@ jobs:
|
||||
- ${TAS_SCRIPTS}/start-compose.sh ${TAS_ENVIRONMENT}/docker-compose-minimal+transforms.yml
|
||||
- ${TAS_SCRIPTS}/wait-for-alfresco-start.sh "http://localhost:8082/alfresco"
|
||||
script: travis_wait 60 mvn -B verify -f packaging/tests/tas-restapi/pom.xml -Pall-tas-tests,run-restapi-part3 -Denvironment=default -DrunBugs=false
|
||||
after_failure: ${TAS_SCRIPTS}/output_logs_for_failures.sh "packaging/tests/tas-restapi"
|
||||
|
||||
- name: "CMIS TAS tests - BROWSER binding"
|
||||
if: (branch =~ /(release\/.*$|master)/ AND commit_message !~ /\[skip tas\]/) OR commit_message =~ /\[tas\]/
|
||||
@@ -288,6 +291,7 @@ jobs:
|
||||
- ${TAS_SCRIPTS}/start-compose.sh ${TAS_ENVIRONMENT}/docker-compose-minimal+transforms.yml
|
||||
- ${TAS_SCRIPTS}/wait-for-alfresco-start.sh "http://localhost:8082/alfresco"
|
||||
script: travis_wait 40 mvn -B verify -f packaging/tests/tas-cmis/pom.xml -Pall-tas-tests,run-cmis-browser -Denvironment=default -DrunBugs=false
|
||||
after_failure: ${TAS_SCRIPTS}/output_logs_for_failures.sh "packaging/tests/tas-cmis"
|
||||
|
||||
- name: "CMIS TAS tests - ATOM binding"
|
||||
if: (branch =~ /(release\/.*$|master)/ AND commit_message !~ /\[skip tas\]/) OR commit_message =~ /\[tas\]/
|
||||
@@ -296,6 +300,7 @@ jobs:
|
||||
- ${TAS_SCRIPTS}/start-compose.sh ${TAS_ENVIRONMENT}/docker-compose-minimal+transforms.yml
|
||||
- ${TAS_SCRIPTS}/wait-for-alfresco-start.sh "http://localhost:8082/alfresco"
|
||||
script: travis_wait 40 mvn -B verify -f packaging/tests/tas-cmis/pom.xml -Pall-tas-tests,run-cmis-atom -Denvironment=default -DrunBugs=false
|
||||
after_failure: ${TAS_SCRIPTS}/output_logs_for_failures.sh "packaging/tests/tas-cmis"
|
||||
|
||||
- name: "CMIS TAS tests - WEBSERVICES binding"
|
||||
if: (branch =~ /(release\/.*$|master)/ AND commit_message !~ /\[skip tas\]/) OR commit_message =~ /\[tas\]/
|
||||
@@ -304,6 +309,7 @@ jobs:
|
||||
- ${TAS_SCRIPTS}/start-compose.sh ${TAS_ENVIRONMENT}/docker-compose-minimal+transforms.yml
|
||||
- ${TAS_SCRIPTS}/wait-for-alfresco-start.sh "http://localhost:8082/alfresco"
|
||||
script: travis_wait 40 mvn -B verify -f packaging/tests/tas-cmis/pom.xml -Pall-tas-tests,run-cmis-webservices -Denvironment=default -DrunBugs=false
|
||||
after_failure: ${TAS_SCRIPTS}/output_logs_for_failures.sh "packaging/tests/tas-cmis"
|
||||
|
||||
- name: "Email TAS tests"
|
||||
if: (branch =~ /(release\/.*$|master)/ AND commit_message !~ /\[skip tas\]/) OR commit_message =~ /\[tas\]/
|
||||
@@ -312,6 +318,7 @@ jobs:
|
||||
- ${TAS_SCRIPTS}/start-compose.sh ${TAS_ENVIRONMENT}/docker-compose-minimal.yml
|
||||
- ${TAS_SCRIPTS}/wait-for-alfresco-start.sh "http://localhost:8082/alfresco"
|
||||
script: travis_wait 30 mvn -B verify -f packaging/tests/tas-email/pom.xml -Pall-tas-tests -Denvironment=default -DrunBugs=false
|
||||
after_failure: ${TAS_SCRIPTS}/output_logs_for_failures.sh "packaging/tests/tas-email"
|
||||
|
||||
- name: "WebDAV TAS tests"
|
||||
if: (branch =~ /(release\/.*$|master)/ AND commit_message !~ /\[skip tas\]/) OR commit_message =~ /\[tas\]/
|
||||
@@ -320,6 +327,7 @@ jobs:
|
||||
- ${TAS_SCRIPTS}/start-compose.sh ${TAS_ENVIRONMENT}/docker-compose-minimal.yml
|
||||
- ${TAS_SCRIPTS}/wait-for-alfresco-start.sh "http://localhost:8082/alfresco"
|
||||
script: travis_wait 30 mvn -B verify -f packaging/tests/tas-webdav/pom.xml -Pall-tas-tests -Denvironment=default -DrunBugs=false
|
||||
after_failure: ${TAS_SCRIPTS}/output_logs_for_failures.sh "packaging/tests/tas-webdav"
|
||||
|
||||
- name: "Integration TAS tests"
|
||||
if: (branch =~ /(release\/.*$|master)/ AND commit_message !~ /\[skip tas\]/) OR commit_message =~ /\[tas\]/
|
||||
@@ -327,7 +335,9 @@ jobs:
|
||||
before_script:
|
||||
- ${TAS_SCRIPTS}/start-compose.sh ${TAS_ENVIRONMENT}/docker-compose-minimal.yml
|
||||
- ${TAS_SCRIPTS}/wait-for-alfresco-start.sh "http://localhost:8082/alfresco"
|
||||
- travis_retry travis_wait 40 mvn install -pl :alfresco-community-repo-integration-test -am -DskipTests -Pall-tas-tests
|
||||
script: travis_wait 30 mvn -B verify -f packaging/tests/tas-integration/pom.xml -Pall-tas-tests -Denvironment=default -DrunBugs=false
|
||||
after_failure: ${TAS_SCRIPTS}/output_logs_for_failures.sh "packaging/tests/tas-integration"
|
||||
|
||||
- name: "Share Services - ShareServicesTestSuite"
|
||||
if: commit_message !~ /\[skip repo\]/
|
||||
|
@@ -7,7 +7,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo-amps</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<modules>
|
||||
|
@@ -7,7 +7,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-governance-services-community-parent</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<modules>
|
||||
|
@@ -7,7 +7,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-governance-services-automation-community-repo</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<build>
|
||||
|
@@ -0,0 +1,73 @@
|
||||
/*-
|
||||
* #%L
|
||||
* Alfresco Records Management Module
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2022 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.v0;
|
||||
|
||||
import org.alfresco.rest.core.v0.BaseAPI;
|
||||
import org.apache.http.HttpResponse;
|
||||
import org.json.JSONArray;
|
||||
import org.json.JSONObject;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import java.io.UnsupportedEncodingException;
|
||||
import java.net.URLEncoder;
|
||||
import java.text.MessageFormat;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* Methods to make API requests using v0 API for Linking Records
|
||||
*
|
||||
* @author Kavit Shah
|
||||
* @since 3.2
|
||||
*/
|
||||
@Component
|
||||
public class LinksAPI extends BaseAPI {
|
||||
|
||||
private static final String LINK_API = "{0}doclib/action/rm-link/site/rm/documentLibrary/{1}";
|
||||
|
||||
/**
|
||||
* Creates the Link
|
||||
*
|
||||
* @param user The username of the user to use.
|
||||
* @param password The password of the user.
|
||||
* @param expectedStatusCode The expected return status code.
|
||||
* @param sourcePath The Source of link the record. This should be in the format
|
||||
* "{site}/{container}/{path}", "{site}/{container}", "{store_type}/{store_id}/{id}/{path}",
|
||||
* "{store_type}/{store_id}/{id}" or "{store_type}/{store_id}".
|
||||
* @param nodeRefs The Node that needs to be linked.
|
||||
* @return The HTTP Response.
|
||||
* @throws AssertionError If the API didn't return the expected status code.
|
||||
*/
|
||||
public HttpResponse linkRecord(String user, String password, int expectedStatusCode, String sourcePath, List<String> nodeRefs) throws UnsupportedEncodingException {
|
||||
JSONObject requestParams = new JSONObject();
|
||||
requestParams.put("nodeRefs", new JSONArray(nodeRefs));
|
||||
|
||||
return doSlingshotPostJsonRequest(user, password, expectedStatusCode, requestParams,
|
||||
MessageFormat.format(LINK_API, "{0}", sourcePath));
|
||||
}
|
||||
|
||||
}
|
@@ -52,7 +52,7 @@ public class RecordCategoriesAPI extends BaseAPI
|
||||
private static final String RM_ACTIONS_API = "{0}rma/actions/ExecutionQueue";
|
||||
private static final String DISPOSITION_ACTIONS_API = "{0}node/{1}/dispositionschedule/dispositionactiondefinitions";
|
||||
private static final String DISPOSITION_SCHEDULE_API = "{0}node/{1}/dispositionschedule";
|
||||
|
||||
private static final String NEXT_DISPOSITION_ACTIONS_API = "{0}node/{1}/nextdispositionaction";
|
||||
|
||||
/**
|
||||
* Creates a retention schedule for the category given as parameter
|
||||
@@ -191,4 +191,19 @@ public class RecordCategoriesAPI extends BaseAPI
|
||||
retentionProperties.put(RETENTION_SCHEDULE.RETENTION_INSTRUCTIONS, instructions);
|
||||
return retentionProperties;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Next Disposition Action
|
||||
*
|
||||
* @param user
|
||||
* @param password
|
||||
* @param recordId
|
||||
* @return the next disposition schedule action
|
||||
*/
|
||||
public JSONObject getNextDispositionAction(String user, String password, String recordId)
|
||||
{
|
||||
String nodeRef = NODE_PREFIX + recordId;
|
||||
JSONObject nextDispositionAction = doGetRequest(user, password, MessageFormat.format(NEXT_DISPOSITION_ACTIONS_API, "{0}", nodeRef));
|
||||
return nextDispositionAction;
|
||||
}
|
||||
}
|
||||
|
@@ -72,6 +72,7 @@ import org.testng.annotations.AfterClass;
|
||||
import org.testng.annotations.BeforeClass;
|
||||
import org.testng.annotations.BeforeMethod;
|
||||
import org.testng.annotations.DataProvider;
|
||||
import org.testng.annotations.Ignore;
|
||||
import org.testng.annotations.Test;
|
||||
import org.alfresco.utility.model.TestGroup;
|
||||
|
||||
@@ -259,6 +260,7 @@ public class DeclareAndFileDocumentAsRecordTests extends BaseRMRestTest
|
||||
* And the document is not declared as a record
|
||||
*/
|
||||
@Test (dataProvider = "invalidDestinationPaths",groups = { TestGroup.NOT_SUPPORTED_ON_SINGLE_PIPELINE })
|
||||
@Ignore
|
||||
public void declareAndFileToInvalidLocationUsingActionsAPI(String containerPath, String expectedException) throws Exception
|
||||
{
|
||||
STEP("Declare document as record with an invalid location parameter value");
|
||||
|
@@ -61,6 +61,7 @@ import org.testng.annotations.AfterClass;
|
||||
import org.testng.annotations.BeforeClass;
|
||||
import org.testng.annotations.BeforeMethod;
|
||||
import org.testng.annotations.DataProvider;
|
||||
import org.testng.annotations.Ignore;
|
||||
import org.testng.annotations.Test;
|
||||
import org.alfresco.utility.model.TestGroup;
|
||||
|
||||
@@ -209,6 +210,7 @@ public class FileVersionAsRecordTests extends BaseRMRestTest
|
||||
* And the document is not declared as a version record
|
||||
*/
|
||||
@Test (dataProvider = "invalidDestinationPaths", groups = { TestGroup.NOT_SUPPORTED_ON_SINGLE_PIPELINE })
|
||||
@Ignore
|
||||
public void declareVersionAndFileToInvalidLocationUsingActionsAPI(String containerPath, String expectedException) throws Exception
|
||||
{
|
||||
STEP("Declare document as record version with an invalid location parameter value");
|
||||
|
@@ -0,0 +1,311 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Records Management Module
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2022 Alfresco Software Limited
|
||||
* %%
|
||||
* This file is part of the Alfresco software.
|
||||
* -
|
||||
* If the software was purchased under a paid Alfresco license, the terms of
|
||||
* the paid license agreement will prevail. Otherwise, the software is
|
||||
* provided under the following open source license terms:
|
||||
* -
|
||||
* Alfresco is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
* -
|
||||
* Alfresco is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
* -
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
||||
* #L%
|
||||
*/
|
||||
|
||||
package org.alfresco.rest.rm.community.records;
|
||||
|
||||
import org.alfresco.dataprep.CMISUtil;
|
||||
import org.alfresco.rest.rm.community.base.BaseRMRestTest;
|
||||
import org.alfresco.rest.rm.community.model.record.Record;
|
||||
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategory;
|
||||
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryChild;
|
||||
import org.alfresco.rest.rm.community.model.rules.ActionsOnRule;
|
||||
import org.alfresco.rest.rm.community.model.rules.RuleDefinition;
|
||||
import org.alfresco.rest.rm.community.model.unfiledcontainer.UnfiledContainer;
|
||||
import org.alfresco.rest.rm.community.model.unfiledcontainer.UnfiledContainerChildCollection;
|
||||
import org.alfresco.rest.v0.RMRolesAndActionsAPI;
|
||||
import org.alfresco.rest.v0.RecordsAPI;
|
||||
import org.alfresco.rest.v0.RulesAPI;
|
||||
import org.alfresco.rest.v0.service.DispositionScheduleService;
|
||||
import org.alfresco.test.AlfrescoTest;
|
||||
import org.alfresco.utility.constants.UserRole;
|
||||
import org.alfresco.utility.model.FileModel;
|
||||
import org.alfresco.utility.model.FolderModel;
|
||||
import org.alfresco.utility.model.SiteModel;
|
||||
import org.alfresco.utility.model.UserModel;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.testng.Assert;
|
||||
import org.testng.annotations.AfterClass;
|
||||
import org.testng.annotations.BeforeClass;
|
||||
import org.testng.annotations.Test;
|
||||
import static java.util.Arrays.asList;
|
||||
import static org.alfresco.rest.core.v0.BaseAPI.NODE_PREFIX;
|
||||
import static org.alfresco.rest.core.v0.BaseAPI.RM_SITE_ID;
|
||||
import static org.alfresco.rest.rm.community.base.TestData.DEFAULT_PASSWORD;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAlias.UNFILED_RECORDS_CONTAINER_ALIAS;
|
||||
import static org.alfresco.rest.rm.community.model.recordcategory.RetentionPeriodProperty.CREATED_DATE;
|
||||
import static org.alfresco.rest.rm.community.model.user.UserPermissions.PERMISSION_READ_RECORDS;
|
||||
import static org.alfresco.rest.rm.community.requests.gscore.api.FilesAPI.PARENT_ID_PARAM;
|
||||
import static org.alfresco.rest.rm.community.util.CommonTestUtils.generateTestPrefix;
|
||||
import static org.alfresco.utility.report.log.Step.STEP;
|
||||
import static org.junit.Assert.assertTrue;
|
||||
import static org.springframework.http.HttpStatus.CREATED;
|
||||
|
||||
public class DeclareInPlaceRecordsTestLevel2 extends BaseRMRestTest {
|
||||
private final String TEST_PREFIX = generateTestPrefix(DeclareInPlaceRecordsTestLevel2.class);
|
||||
private final String RM_ADMIN = TEST_PREFIX + "rm_admin";
|
||||
private final String RECORDS_CATEGORY_ONE = TEST_PREFIX + "category";
|
||||
public static final String RECORD_FOLDER_ONE = "record-folder-one";
|
||||
public static final String RECORD_CATEGORY_TWO = "record-category-two" + System.currentTimeMillis();
|
||||
public static final String RECORD_FOLDER_TWO = "record-folder-two";
|
||||
private final String RULE_NAME = TEST_PREFIX + "rule unfiled";
|
||||
private String unfiledRecordsNodeRef;
|
||||
private RecordCategory RecordCategoryOne, RecordCategoryTwo;
|
||||
private RecordCategoryChild recordFolder;
|
||||
private UnfiledContainer unfiledContainer;
|
||||
private FolderModel testFolder;
|
||||
private SiteModel testSite;
|
||||
private SiteModel privateSite;
|
||||
private UserModel testUser;
|
||||
@Autowired
|
||||
private DispositionScheduleService dispositionScheduleService;
|
||||
@Autowired
|
||||
private RulesAPI rulesAPI;
|
||||
/**
|
||||
* data prep services
|
||||
*/
|
||||
@Autowired
|
||||
private RMRolesAndActionsAPI rmRolesAndActionsAPI;
|
||||
@Autowired
|
||||
private RecordsAPI recordsAPI;
|
||||
|
||||
@BeforeClass(alwaysRun = true)
|
||||
public void preConditions() {
|
||||
STEP("Create RM Site");
|
||||
createRMSiteIfNotExists();
|
||||
privateSite = dataSite.usingAdmin().createPrivateRandomSite();
|
||||
}
|
||||
|
||||
/**
|
||||
* Given that a user is the owner of a document
|
||||
* And that user has been deleted
|
||||
* When admin tries to declare the document as a record
|
||||
* Then the document becomes an inplace record
|
||||
*/
|
||||
@Test
|
||||
@AlfrescoTest(jira="RM-2584")
|
||||
public void DeclareRecordOwnerDeleted() throws Exception {
|
||||
|
||||
createTestPrecondition();
|
||||
|
||||
// Upload document in a folder in a collaboration site
|
||||
FileModel uploadedDoc = dataContent.usingSite(testSite)
|
||||
.usingUser(testUser)
|
||||
.usingResource(testFolder)
|
||||
.createContent(CMISUtil.DocumentType.TEXT_PLAIN);
|
||||
|
||||
// delete the test user
|
||||
dataUser.deleteUser(testUser);
|
||||
|
||||
// declare uploadedDocument as record
|
||||
getRestAPIFactory().getFilesAPI(getDataUser().getAdminUser()).declareAsRecord(uploadedDoc.getNodeRefWithoutVersion());
|
||||
assertStatusCode(CREATED);
|
||||
|
||||
// assert that the document is now a record
|
||||
assertTrue(hasRecordAspect(uploadedDoc));
|
||||
}
|
||||
/**
|
||||
* Given that a user is the owner of a document
|
||||
* And that user declare the document as a record
|
||||
* When admin files the record to a category that has a disposition schedule applied on records and a cut off step
|
||||
* And admin completes the record so the pending record action is now Cut off
|
||||
* Then user is still able to see the in place record in original share site location
|
||||
*/
|
||||
@Test
|
||||
@AlfrescoTest(jira="MNT-18558")
|
||||
public void inPlaceRecordVisibilityAfterFilingToCategoryWithCutOffStep() throws Exception {
|
||||
|
||||
// create test precondition
|
||||
createTestPrecondition(RECORDS_CATEGORY_ONE);
|
||||
|
||||
//create a disposition schedule on Records level with a cut off step
|
||||
dispositionScheduleService.createCategoryRetentionSchedule(RECORDS_CATEGORY_ONE, true);
|
||||
dispositionScheduleService.addCutOffAfterPeriodStep(RECORDS_CATEGORY_ONE, "day|2", CREATED_DATE);
|
||||
|
||||
//create a folder in category
|
||||
recordFolder = createFolder(getAdminUser(),RecordCategoryOne.getId(),RECORD_FOLDER_ONE);
|
||||
|
||||
// create a File to record folder rule applied on Unfiled Records container
|
||||
fileToRuleAppliedOnUnfiledRecords();
|
||||
|
||||
//create a new test user
|
||||
UserModel testUser = createSiteManager();
|
||||
|
||||
// upload a new document as the user and declare the document as record
|
||||
FileModel uploadedDoc = dataContent.usingSite(privateSite)
|
||||
.usingUser(testUser)
|
||||
.createContent(CMISUtil.DocumentType.TEXT_PLAIN);
|
||||
|
||||
Record uploadedRecord = getRestAPIFactory().getFilesAPI(getDataUser().getAdminUser()).declareAsRecord(uploadedDoc.getNodeRefWithoutVersion());
|
||||
assertStatusCode(CREATED);
|
||||
|
||||
//Complete the record as admin to be sure that pending action is now Cut off
|
||||
recordsAPI.completeRecord(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), uploadedRecord.getName());
|
||||
|
||||
// As test user navigate to collaboration site documents library and check that the record is still visible
|
||||
dataContent.usingAdmin().usingSite(privateSite).assertContentExist();
|
||||
}
|
||||
/**
|
||||
* Create a user called test
|
||||
* Create a collaboration site
|
||||
* Add the user to the collaboration site as consumer
|
||||
* Create an RM site
|
||||
* In RM, create a new categories under file plan with a cut off step set after an event happens
|
||||
* Under the previously created category create a folder
|
||||
* Set READ-ONLY permission for test user for the folder previously created (the user does not have Read
|
||||
* permissions to the category containing the folder)
|
||||
* In the collaboration site create two files
|
||||
* File as record the first file
|
||||
* Log in with test user and check if he can still see the two files in the collaboration site
|
||||
*/
|
||||
@Test
|
||||
@AlfrescoTest (jira = "MNT-22138")
|
||||
public void filesVisibilityAfterFilingToCategoryWithCutOffAfterEventStep() throws Exception {
|
||||
|
||||
//create a category
|
||||
RecordCategoryTwo = createRootCategory(RECORD_CATEGORY_TWO);
|
||||
|
||||
//create a disposition schedule on Records level with a cut off step
|
||||
dispositionScheduleService.createCategoryRetentionSchedule(RECORD_CATEGORY_TWO, true);
|
||||
dispositionScheduleService.addCutOffAfterPeriodStep(RECORD_CATEGORY_TWO, "day|2", CREATED_DATE);
|
||||
|
||||
//create a folder in category
|
||||
recordFolder = createFolder(getAdminUser(),RecordCategoryTwo.getId(),RECORD_FOLDER_TWO);
|
||||
|
||||
//create a new test user
|
||||
UserModel siteConsumer = getDataUser().createRandomTestUser();
|
||||
getDataUser().addUserToSite(siteConsumer,privateSite,UserRole.SiteConsumer);
|
||||
|
||||
// give read permissions to test user
|
||||
getRestAPIFactory().getRMUserAPI().addUserPermission(recordFolder.getId(), siteConsumer, PERMISSION_READ_RECORDS);
|
||||
|
||||
// create two documents
|
||||
FileModel testFile = dataContent.usingSite(new SiteModel(privateSite.getTitle()))
|
||||
.usingAdmin()
|
||||
.createContent(CMISUtil.DocumentType.TEXT_PLAIN);
|
||||
|
||||
FileModel testFileNotFiled = dataContent.usingSite(new SiteModel(privateSite.getTitle()))
|
||||
.usingAdmin()
|
||||
.createContent(CMISUtil.DocumentType.TEXT_PLAIN);
|
||||
|
||||
// file one of the documents as record
|
||||
getRestAPIFactory().getFilesAPI()
|
||||
.usingParams(String.format("%s=%s", PARENT_ID_PARAM, recordFolder.getId()))
|
||||
.declareAsRecord(testFile.getNodeRefWithoutVersion());
|
||||
getRestAPIFactory().getRmRestWrapper().assertStatusCodeIs(CREATED);
|
||||
|
||||
// As test user navigate to collaboration site documents library and check that both of the documents are
|
||||
// visible
|
||||
STEP("Verify the document in collaboration site is now a record");
|
||||
Assert.assertTrue(hasRecordAspect(testFile), "File should have record aspect");
|
||||
Assert.assertFalse(hasRecordAspect(testFileNotFiled), "File should not have record aspect");
|
||||
}
|
||||
|
||||
private void createTestPrecondition(String categoryName) {
|
||||
|
||||
// create "rm admin" user if it does not exist and assign it to RM Administrator role
|
||||
rmRolesAndActionsAPI.createUserAndAssignToRole(
|
||||
getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(),
|
||||
RM_ADMIN, DEFAULT_PASSWORD, "Administrator");
|
||||
|
||||
// create category
|
||||
STEP("Create category");
|
||||
RecordCategoryOne = createRootCategory(categoryName,"Title");
|
||||
|
||||
unfiledContainer = getRestAPIFactory().getUnfiledContainersAPI().getUnfiledContainer(UNFILED_RECORDS_CONTAINER_ALIAS);
|
||||
|
||||
unfiledRecordsNodeRef = NODE_PREFIX + unfiledContainer.getId();
|
||||
}
|
||||
private void createTestPrecondition() {
|
||||
STEP("Create collab_user user");
|
||||
testUser = getDataUser().createRandomTestUser();
|
||||
testSite = dataSite.usingAdmin().createPublicRandomSite();
|
||||
|
||||
// invite collab_user to Collaboration site with Contributor role
|
||||
getDataUser().addUserToSite(testUser, testSite, UserRole.SiteContributor);
|
||||
|
||||
testFolder = dataContent.usingSite(testSite).usingUser(testUser).createFolder();
|
||||
}
|
||||
private void fileToRuleAppliedOnUnfiledRecords() {
|
||||
unfiledRecordsRuleTeardown();
|
||||
|
||||
// create a rule
|
||||
RuleDefinition ruleDefinition = RuleDefinition.createNewRule().title(RULE_NAME)
|
||||
.description(RULE_NAME)
|
||||
.createRecordPath(false)
|
||||
.path("/" + RECORDS_CATEGORY_ONE + "/" + RECORD_FOLDER_ONE)
|
||||
.runInBackground(true)
|
||||
.actions(asList(ActionsOnRule.FILE_TO.getActionValue()));
|
||||
|
||||
// create a rule on unfiledRecords
|
||||
rulesAPI.createRule(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), unfiledRecordsNodeRef, ruleDefinition);
|
||||
}
|
||||
private void unfiledRecordsRuleTeardown() {
|
||||
rulesAPI.deleteAllRulesOnContainer(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), unfiledRecordsNodeRef);
|
||||
}
|
||||
public UserModel createSiteManager() {
|
||||
UserModel siteManager = getDataUser().createRandomTestUser();
|
||||
getDataUser().addUserToSite(siteManager, privateSite, UserRole.SiteManager);
|
||||
return siteManager;
|
||||
}
|
||||
@AfterClass
|
||||
public void cleanupCategory() {
|
||||
unfiledRecordsRuleTeardown();
|
||||
rmRolesAndActionsAPI.deleteAllItemsInContainer(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), RM_SITE_ID, RECORD_FOLDER_ONE);
|
||||
rmRolesAndActionsAPI.deleteAllItemsInContainer(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), RM_SITE_ID, RecordCategoryOne.getName());
|
||||
deleteRecordCategory(RecordCategoryOne.getId());
|
||||
|
||||
rmRolesAndActionsAPI.deleteAllItemsInContainer(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), RM_SITE_ID, RECORD_FOLDER_TWO);
|
||||
rmRolesAndActionsAPI.deleteAllItemsInContainer(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), RM_SITE_ID, RecordCategoryTwo.getName());
|
||||
deleteRecordCategory(RecordCategoryTwo.getId());
|
||||
|
||||
dataSite.usingAdmin().deleteSite(privateSite);
|
||||
dataSite.usingAdmin().deleteSite(testSite);
|
||||
|
||||
UnfiledContainerChildCollection unfiledContainerChildCollection = getRestAPIFactory()
|
||||
.getUnfiledContainersAPI().getUnfiledContainerChildren(unfiledContainer.getId());
|
||||
|
||||
unfiledContainerChildCollection.getEntries().forEach(unfiledChild ->
|
||||
{
|
||||
if (unfiledChild.getEntry().getIsRecord())
|
||||
{
|
||||
getRestAPIFactory().getRecordsAPI().deleteRecord(unfiledChild.getEntry().getId());
|
||||
}
|
||||
else
|
||||
{
|
||||
getRestAPIFactory().getUnfiledRecordFoldersAPI().deleteUnfiledRecordFolder(unfiledChild.getEntry().getId());
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
@@ -75,6 +75,7 @@ import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.testng.annotations.AfterClass;
|
||||
import org.testng.annotations.BeforeClass;
|
||||
import org.testng.annotations.DataProvider;
|
||||
import org.testng.annotations.Ignore;
|
||||
import org.testng.annotations.Test;
|
||||
|
||||
/**
|
||||
@@ -102,7 +103,7 @@ public class DeleteRecordTests extends BaseRMRestTest
|
||||
testSite = dataSite.usingAdmin().createPublicRandomSite();
|
||||
recordFolder = createCategoryFolderInFilePlan();
|
||||
unfiledRecordFolder = createUnfiledContainerChild(UNFILED_RECORDS_CONTAINER_ALIAS, getRandomName("Unfiled Folder "),
|
||||
UNFILED_RECORD_FOLDER_TYPE);
|
||||
UNFILED_RECORD_FOLDER_TYPE);
|
||||
}
|
||||
|
||||
/** Data provider with electronic and non-electronic records to be deleted */
|
||||
@@ -133,10 +134,10 @@ public class DeleteRecordTests extends BaseRMRestTest
|
||||
* </pre>
|
||||
*/
|
||||
@Test
|
||||
(
|
||||
dataProvider = "recordsToBeDeleted",
|
||||
description = "Admin user can delete records"
|
||||
)
|
||||
(
|
||||
dataProvider = "recordsToBeDeleted",
|
||||
description = "Admin user can delete records"
|
||||
)
|
||||
@AlfrescoTest(jira="RM-4363")
|
||||
public void adminCanDeleteRecords(String recordId)
|
||||
{
|
||||
@@ -154,17 +155,17 @@ public class DeleteRecordTests extends BaseRMRestTest
|
||||
* </pre>
|
||||
*/
|
||||
@Test
|
||||
(
|
||||
description = "User without write permissions can't delete a record"
|
||||
)
|
||||
(
|
||||
description = "User without write permissions can't delete a record"
|
||||
)
|
||||
@AlfrescoTest(jira="RM-4363")
|
||||
public void userWithoutWritePermissionsCantDeleteRecord()
|
||||
{
|
||||
// Create a non-electronic record in unfiled records
|
||||
UnfiledContainerChild nonElectronicRecord = UnfiledContainerChild.builder()
|
||||
.name("Record " + RandomData.getRandomAlphanumeric())
|
||||
.nodeType(NON_ELECTRONIC_RECORD_TYPE)
|
||||
.build();
|
||||
.name("Record " + RandomData.getRandomAlphanumeric())
|
||||
.nodeType(NON_ELECTRONIC_RECORD_TYPE)
|
||||
.build();
|
||||
UnfiledContainerChild newRecord = getRestAPIFactory().getUnfiledContainersAPI().createUnfiledContainerChild(nonElectronicRecord, UNFILED_RECORDS_CONTAINER_ALIAS);
|
||||
|
||||
assertStatusCode(CREATED);
|
||||
@@ -187,9 +188,9 @@ public class DeleteRecordTests extends BaseRMRestTest
|
||||
* </pre>
|
||||
*/
|
||||
@Test
|
||||
(
|
||||
description = "User without delete records capability can't delete a record"
|
||||
)
|
||||
(
|
||||
description = "User without delete records capability can't delete a record"
|
||||
)
|
||||
@AlfrescoTest(jira="RM-4363")
|
||||
public void userWithoutDeleteRecordsCapabilityCantDeleteRecord()
|
||||
{
|
||||
@@ -234,7 +235,7 @@ public class DeleteRecordTests extends BaseRMRestTest
|
||||
|
||||
STEP("Create a record in first folder and copy it into second folder.");
|
||||
String recordId = getRestAPIFactory().getRecordFolderAPI()
|
||||
.createRecord(createElectronicRecordModel(), recordFolder.getId(), getFile(IMAGE_FILE)).getId();
|
||||
.createRecord(createElectronicRecordModel(), recordFolder.getId(), getFile(IMAGE_FILE)).getId();
|
||||
String copyId = copyNode(recordId, recordFolderB.getId()).getId();
|
||||
assertStatusCode(CREATED);
|
||||
|
||||
@@ -318,14 +319,14 @@ public class DeleteRecordTests extends BaseRMRestTest
|
||||
RecordCategoryChild recFolder = createFolder(recordCategory.getId(), getRandomName("recFolder"));
|
||||
RecordBodyFile recordBodyFile = RecordBodyFile.builder().targetParentId(recFolder.getId()).build();
|
||||
Record recordFiled = getRestAPIFactory().getRecordsAPI().fileRecord(recordBodyFile, testFile.getNodeRefWithoutVersion());
|
||||
getRestAPIFactory().getRecordsAPI().completeRecord(recordFiled.getId());
|
||||
assertStatusCode(CREATED);
|
||||
completeRecord(recordFiled.getId());
|
||||
assertStatusCode(OK);
|
||||
|
||||
STEP("Execute the disposition schedule steps.");
|
||||
rmRolesAndActionsAPI.executeAction(getAdminUser().getUsername(), getAdminUser().getUsername(), recordFiled.getName(),
|
||||
RM_ACTIONS.CUT_OFF);
|
||||
RM_ACTIONS.CUT_OFF);
|
||||
rmRolesAndActionsAPI.executeAction(getAdminUser().getUsername(), getAdminUser().getUsername(), recordFiled.getName(),
|
||||
RM_ACTIONS.DESTROY);
|
||||
RM_ACTIONS.DESTROY);
|
||||
|
||||
STEP("Check that it's possible to load the copy content.");
|
||||
getNodeContent(copy.getId());
|
||||
@@ -348,14 +349,14 @@ public class DeleteRecordTests extends BaseRMRestTest
|
||||
|
||||
STEP("Declare file version as record.");
|
||||
recordsAPI.declareDocumentVersionAsRecord(getAdminUser().getUsername(), getAdminUser().getPassword(), testSite.getId(),
|
||||
testFile.getName());
|
||||
testFile.getName());
|
||||
UnfiledContainerChild unfiledContainerChild = getRestAPIFactory().getUnfiledContainersAPI()
|
||||
.getUnfiledContainerChildren(UNFILED_RECORDS_CONTAINER_ALIAS)
|
||||
.getEntries().stream()
|
||||
.filter(child -> child.getEntry().getName()
|
||||
.startsWith(testFile.getName().substring(0, testFile.getName().indexOf("."))))
|
||||
.findFirst()
|
||||
.get().getEntry();
|
||||
.getUnfiledContainerChildren(UNFILED_RECORDS_CONTAINER_ALIAS)
|
||||
.getEntries().stream()
|
||||
.filter(child -> child.getEntry().getName()
|
||||
.startsWith(testFile.getName().substring(0, testFile.getName().indexOf("."))))
|
||||
.findFirst()
|
||||
.get().getEntry();
|
||||
|
||||
STEP("Delete the record.");
|
||||
deleteAndVerify(unfiledContainerChild.getId());
|
||||
|
@@ -0,0 +1,128 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Records Management Module
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2022 Alfresco Software Limited
|
||||
* %%
|
||||
* This file is part of the Alfresco software.
|
||||
* -
|
||||
* If the software was purchased under a paid Alfresco license, the terms of
|
||||
* the paid license agreement will prevail. Otherwise, the software is
|
||||
* provided under the following open source license terms:
|
||||
* -
|
||||
* Alfresco is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
* -
|
||||
* Alfresco is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
* -
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
||||
* #L%
|
||||
*/
|
||||
|
||||
package org.alfresco.rest.rm.community.records;
|
||||
|
||||
import org.alfresco.dataprep.ContentService;
|
||||
import org.alfresco.rest.rm.community.base.BaseRMRestTest;
|
||||
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategory;
|
||||
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryChild;
|
||||
import org.alfresco.rest.v0.RMRolesAndActionsAPI;
|
||||
import org.alfresco.rest.v0.RecordsAPI;
|
||||
import org.alfresco.test.AlfrescoTest;
|
||||
import org.apache.commons.httpclient.HttpStatus;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.testng.annotations.AfterClass;
|
||||
import org.testng.annotations.Test;
|
||||
|
||||
import static org.alfresco.rest.core.v0.BaseAPI.RM_SITE_ID;
|
||||
import static org.alfresco.rest.rm.community.util.CommonTestUtils.generateTestPrefix;
|
||||
import static org.testng.AssertJUnit.assertEquals;
|
||||
import static org.testng.AssertJUnit.assertFalse;
|
||||
|
||||
/**
|
||||
* Tests to cover share action for records
|
||||
* @author Kavit Shah
|
||||
*/
|
||||
public class ShareRecordsTest extends BaseRMRestTest {
|
||||
|
||||
/** data prep services*/
|
||||
@Autowired
|
||||
private RecordsAPI service;
|
||||
@Autowired
|
||||
private ContentService contentService;
|
||||
@Autowired
|
||||
private RMRolesAndActionsAPI rmRolesAndActionsAPI;
|
||||
/** Constants*/
|
||||
private final String TEST_PREFIX = generateTestPrefix(ShareRecordsTest.class);
|
||||
private final String CATEGORY = "CategoryWithSharedRecords" + TEST_PREFIX;
|
||||
private final String FOLDER = "FolderWithSharedRecords" + TEST_PREFIX;
|
||||
private final String ELECTRONIC_RECORD = "ELECTRONIC_RECORD" + TEST_PREFIX;
|
||||
private final String NONELECTRONIC_REC = "NON_ELECTRONIC_RECORD" + TEST_PREFIX;
|
||||
private RecordCategory category;
|
||||
private RecordCategoryChild recordCategoryChild;
|
||||
/**
|
||||
* Given a record
|
||||
* When admin tries to share it via API
|
||||
* Then the record can't be shared
|
||||
*/
|
||||
@Test
|
||||
@AlfrescoTest(jira = "RM-5308")
|
||||
public void shareRecordViaApi()
|
||||
{
|
||||
//create RM Site
|
||||
createRMSiteIfNotExists();
|
||||
|
||||
//create a category
|
||||
category = createRootCategory(CATEGORY);
|
||||
|
||||
//create folder
|
||||
recordCategoryChild = createFolder(category.getId(),FOLDER);
|
||||
|
||||
createNonElectronicRecord(recordCategoryChild.getId(),NONELECTRONIC_REC);
|
||||
|
||||
// create record to be shared
|
||||
createElectronicRecord(recordCategoryChild.getId(),ELECTRONIC_RECORD);
|
||||
|
||||
//get the node id for the ELECTRONIC_RECORD created
|
||||
String nodeRefRec1= contentService.getNodeRefByPath(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(),
|
||||
"/Sites/" + RM_SITE_ID + "/documentLibrary/" + CATEGORY + "/" + FOLDER + "/" + service.getRecordFullName(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), FOLDER, ELECTRONIC_RECORD));
|
||||
//check record can't be shared
|
||||
assertFalse("The record has been succesfully shared",
|
||||
service.shareDocument(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(),nodeRefRec1 ).getKey());
|
||||
//check the error code when trying to share a record
|
||||
assertEquals("The API response code is not " + HttpStatus.SC_INTERNAL_SERVER_ERROR, service.shareDocument(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), nodeRefRec1).getValue(),
|
||||
String.valueOf( HttpStatus.SC_INTERNAL_SERVER_ERROR));
|
||||
|
||||
//get the node id for NONELECTRONIC_REC created
|
||||
String nodeRefRec2 = contentService.getNodeRefByPath(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(),
|
||||
"/Sites/" + RM_SITE_ID + "/documentLibrary/" + CATEGORY + "/" + FOLDER + "/" + service.getRecordFullName(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), FOLDER, NONELECTRONIC_REC));
|
||||
//check record can't be shared
|
||||
assertFalse("The record has been succesfully shared",
|
||||
service.shareDocument(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), nodeRefRec2).getKey());
|
||||
//check the error code when trying to share a record
|
||||
assertEquals("The API response code is not " + HttpStatus.SC_INTERNAL_SERVER_ERROR, service.shareDocument(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), nodeRefRec2).getValue(),
|
||||
String.valueOf(HttpStatus.SC_INTERNAL_SERVER_ERROR));
|
||||
}
|
||||
|
||||
@AfterClass
|
||||
public void cleanupCategory() {
|
||||
rmRolesAndActionsAPI.deleteAllItemsInContainer(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), RM_SITE_ID, recordCategoryChild.getName());
|
||||
rmRolesAndActionsAPI.deleteAllItemsInContainer(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), RM_SITE_ID, category.getName());
|
||||
deleteRecordCategory(category.getId());
|
||||
}
|
||||
}
|
@@ -0,0 +1,121 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Records Management Module
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2022 Alfresco Software Limited
|
||||
* %%
|
||||
* This file is part of the Alfresco software.
|
||||
* -
|
||||
* If the software was purchased under a paid Alfresco license, the terms of
|
||||
* the paid license agreement will prevail. Otherwise, the software is
|
||||
* provided under the following open source license terms:
|
||||
* -
|
||||
* Alfresco is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
* -
|
||||
* Alfresco is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
* -
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
||||
* #L%
|
||||
*/
|
||||
package org.alfresco.rest.rm.community.smoke;
|
||||
|
||||
import org.alfresco.rest.rm.community.base.BaseRMRestTest;
|
||||
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategory;
|
||||
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryChild;
|
||||
import org.alfresco.rest.v0.RMRolesAndActionsAPI;
|
||||
import org.alfresco.rest.v0.RecordFoldersAPI;
|
||||
import org.alfresco.rest.v0.service.DispositionScheduleService;
|
||||
import org.alfresco.test.AlfrescoTest;
|
||||
import org.json.JSONObject;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.testng.annotations.AfterMethod;
|
||||
import org.testng.annotations.BeforeClass;
|
||||
import org.testng.annotations.BeforeMethod;
|
||||
import org.testng.annotations.Test;
|
||||
|
||||
import static org.alfresco.rest.rm.community.model.recordcategory.RetentionPeriodProperty.CREATED_DATE;
|
||||
import static org.alfresco.rest.rm.community.model.recordcategory.RetentionPeriodProperty.CUT_OFF_DATE;
|
||||
import static org.alfresco.rest.rm.community.util.CommonTestUtils.generateTestPrefix;
|
||||
import static org.alfresco.rest.rm.community.utils.CoreUtil.createBodyForMoveCopy;
|
||||
import static org.alfresco.rest.rm.community.utils.CoreUtil.toContentModel;
|
||||
import static org.alfresco.utility.data.RandomData.getRandomName;
|
||||
import static org.alfresco.utility.report.log.Step.STEP;
|
||||
import static org.springframework.http.HttpStatus.OK;
|
||||
import static org.testng.AssertJUnit.assertNotNull;
|
||||
|
||||
|
||||
public class DestroyRecordFolderActionsTest extends BaseRMRestTest {
|
||||
|
||||
private RecordCategory Category1,CATEGORY_TO_MOVE;
|
||||
@Autowired
|
||||
private DispositionScheduleService dispositionScheduleService;
|
||||
@Autowired
|
||||
private RecordFoldersAPI recordFoldersAPI;
|
||||
private final String TEST_PREFIX = generateTestPrefix(DestroyRecordFolderActionsTest.class);
|
||||
private final String folderDisposition = TEST_PREFIX + "RM-2937 folder ghosting";
|
||||
|
||||
|
||||
@BeforeClass(alwaysRun = true)
|
||||
private void setUp(){
|
||||
|
||||
STEP("Create the RM site if doesn't exist");
|
||||
createRMSiteIfNotExists();
|
||||
|
||||
STEP("Create two record category");
|
||||
Category1 = createRootCategory(getRandomName("Category1"));
|
||||
CATEGORY_TO_MOVE = createRootCategory(getRandomName("CATEGORY_TO_MOVE"));
|
||||
|
||||
//create retention schedule
|
||||
dispositionScheduleService.createCategoryRetentionSchedule(Category1.getName(), false);
|
||||
|
||||
// add cut off step
|
||||
dispositionScheduleService.addCutOffAfterPeriodStep(Category1.getName(), "day|2", CREATED_DATE);
|
||||
|
||||
// add destroy step with ghosting
|
||||
dispositionScheduleService.addDestroyWithGhostingImmediatelyAfterCutOff(Category1.getName());
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
@AlfrescoTest (jira = "RM-1621")
|
||||
public void moveOnCutOffDestroyFolders() throws Exception {
|
||||
|
||||
//create folders
|
||||
RecordCategoryChild FOLDER_DESTROY = createFolder(getAdminUser(),Category1.getId(),folderDisposition);
|
||||
|
||||
// edit disposition date
|
||||
recordFoldersAPI.postFolderAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),editDispositionDateJson(),FOLDER_DESTROY.getName());
|
||||
|
||||
// cut off the FOLDER_DESTROY
|
||||
recordFoldersAPI.postFolderAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),new JSONObject().put("name","cutoff"),FOLDER_DESTROY.getName());
|
||||
|
||||
|
||||
// Destroy the FOLDER_DESTROY
|
||||
recordFoldersAPI.postFolderAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),new JSONObject().put("name","destroy"),FOLDER_DESTROY.getName());
|
||||
|
||||
|
||||
//Move the FOLDER_DESTROY within the CATEGORY_TO_MOVE.");
|
||||
getRestAPIFactory().getNodeAPI(toContentModel(FOLDER_DESTROY.getId())).move(createBodyForMoveCopy(CATEGORY_TO_MOVE.getId()));
|
||||
assertStatusCode(OK);
|
||||
|
||||
}
|
||||
|
||||
@AfterMethod(alwaysRun = true)
|
||||
private void deletePreconditions() {
|
||||
|
||||
deleteRecordCategory(Category1.getId());
|
||||
deleteRecordCategory(CATEGORY_TO_MOVE.getId());
|
||||
|
||||
}
|
||||
|
||||
}
|
@@ -0,0 +1,425 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Records Management Module
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2022 Alfresco Software Limited
|
||||
* %%
|
||||
* This file is part of the Alfresco software.
|
||||
* -
|
||||
* If the software was purchased under a paid Alfresco license, the terms of
|
||||
* the paid license agreement will prevail. Otherwise, the software is
|
||||
* provided under the following open source license terms:
|
||||
* -
|
||||
* Alfresco is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
* -
|
||||
* Alfresco is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
* -
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
||||
* #L%
|
||||
*/
|
||||
package org.alfresco.rest.rm.community.smoke;
|
||||
|
||||
import org.alfresco.rest.core.v0.RMEvents;
|
||||
import org.alfresco.rest.model.RestNodeBodyMoveCopyModel;
|
||||
import org.alfresco.rest.model.RestNodeModel;
|
||||
import org.alfresco.rest.requests.Node;
|
||||
import org.alfresco.rest.rm.community.base.BaseRMRestTest;
|
||||
import org.alfresco.rest.rm.community.model.fileplan.FilePlan;
|
||||
import org.alfresco.rest.rm.community.model.record.Record;
|
||||
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategory;
|
||||
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryChild;
|
||||
import org.alfresco.rest.rm.community.model.user.UserRoles;
|
||||
import org.alfresco.rest.v0.LinksAPI;
|
||||
import org.alfresco.rest.v0.RMRolesAndActionsAPI;
|
||||
import org.alfresco.rest.v0.RecordFoldersAPI;
|
||||
import org.alfresco.rest.v0.RecordsAPI;
|
||||
import org.alfresco.rest.v0.service.DispositionScheduleService;
|
||||
import org.alfresco.test.AlfrescoTest;
|
||||
import org.alfresco.utility.model.RepoTestModel;
|
||||
import org.alfresco.utility.model.UserModel;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
import org.apache.http.HttpEntity;
|
||||
import org.apache.http.HttpResponse;
|
||||
import org.apache.http.HttpStatus;
|
||||
import org.apache.http.util.EntityUtils;
|
||||
import org.json.JSONObject;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.testng.AssertJUnit;
|
||||
import org.testng.annotations.BeforeClass;
|
||||
import org.testng.annotations.Test;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.UnsupportedEncodingException;
|
||||
import java.time.Instant;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
import static org.alfresco.rest.core.v0.BaseAPI.NODE_REF_WORKSPACE_SPACES_STORE;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAlias.FILE_PLAN_ALIAS;
|
||||
import static org.alfresco.rest.rm.community.model.fileplancomponents.FilePlanComponentAspects.CUT_OFF_ASPECT;
|
||||
import static org.alfresco.rest.rm.community.model.recordcategory.RetentionPeriodProperty.*;
|
||||
import static org.alfresco.rest.rm.community.util.CommonTestUtils.generateTestPrefix;
|
||||
import static org.alfresco.utility.data.RandomData.getRandomName;
|
||||
import static org.alfresco.utility.report.log.Step.STEP;
|
||||
import static org.junit.Assert.assertNull;
|
||||
import static org.junit.Assert.assertTrue;
|
||||
import static org.springframework.http.HttpStatus.NO_CONTENT;
|
||||
|
||||
public class DispositionScheduleLinkedRecordsTest extends BaseRMRestTest {
|
||||
@Autowired
|
||||
private RMRolesAndActionsAPI rmRolesAndActionsAPI;
|
||||
@Autowired
|
||||
private DispositionScheduleService dispositionScheduleService;
|
||||
@Autowired
|
||||
private LinksAPI linksAPI;
|
||||
@Autowired
|
||||
private RecordsAPI recordsAPI;
|
||||
@Autowired
|
||||
private RecordFoldersAPI recordFoldersAPI;
|
||||
private final static String TEST_PREFIX = generateTestPrefix(DispositionScheduleLinkedRecordsTest.class);
|
||||
private RecordCategory Category1,catsameLevel1,catsameLevel2;
|
||||
private RecordCategoryChild CopyCatFolder,folder1,CatFolder,folder2;
|
||||
private static final String categoryRM3077 = TEST_PREFIX + "RM-3077_manager_sees_me";
|
||||
private static final String copyCategoryRM3077 = "Copy_of_" + categoryRM3077;
|
||||
private static final String folderRM3077 = "RM-3077_folder_"+ categoryRM3077;
|
||||
private static final String copyFolderRM3077 = "Copy_of_" + folderRM3077;
|
||||
private final String electronicRecord = "RM-2937 electronic 2 record";
|
||||
private final String folder = TEST_PREFIX + "RM-2937 folder ghosting";
|
||||
private static final String categoryRecordsRM2526 = TEST_PREFIX + "RM-2526_category_records_immediately";
|
||||
private static final String category2RecordsRM2526 = TEST_PREFIX + "RM-2526_category_2_records_1_day";
|
||||
private static final String firstCategoryRM3060 = TEST_PREFIX + "RM-3060_category_record";
|
||||
private static final String secondCategoryRM3060 = "Copy_of_" + firstCategoryRM3060;
|
||||
private static final String firstFolderRM3060 = TEST_PREFIX + "RM-3060_folder";
|
||||
private static final String secondFolderRM3060 = TEST_PREFIX + "RM-3060_disposition_on_Record_Level";
|
||||
private static final String electronicRecordRM3060 = TEST_PREFIX + "RM-3060_electronic_1_record";
|
||||
private static final String nonElectronicRecordRM3060 = TEST_PREFIX + "RM-3060_non-electronic_record";
|
||||
private static final String TRANSFER_LOCATION = TEST_PREFIX + "RM-3060_transferred_records";
|
||||
public static final String TRANSFER_TYPE = "rma:transferred";
|
||||
private FilePlan filePlanModel;
|
||||
private UserModel rmAdmin, rmManager;
|
||||
@BeforeClass(alwaysRun = true)
|
||||
public void setupDispositionScheduleLinkedRecordsTest() {
|
||||
createRMSiteIfNotExists();
|
||||
//get file plan
|
||||
filePlanModel = getRestAPIFactory().getFilePlansAPI().getFilePlan(FILE_PLAN_ALIAS);
|
||||
|
||||
// create "rm admin" user if it does not exist and assign it to RM Administrator role
|
||||
rmAdmin = getDataUser().createRandomTestUser();
|
||||
rmRolesAndActionsAPI.assignRoleToUser(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(),rmAdmin.getUsername(),
|
||||
UserRoles.ROLE_RM_ADMIN.roleId);
|
||||
|
||||
// create "rm Manager" user if it does not exist and assign it to RM Administrator role
|
||||
rmManager = getDataUser().createRandomTestUser();
|
||||
rmRolesAndActionsAPI.assignRoleToUser(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(),rmManager.getUsername(),
|
||||
UserRoles.ROLE_RM_MANAGER.roleId);
|
||||
}
|
||||
/**
|
||||
* Disposition Schedule on Record Folder with linked records test
|
||||
* <p>
|
||||
* Precondition:
|
||||
* <p>
|
||||
* Create rm_manager user that would have RM Managers role, rm_admin that would have RM Administrator role.
|
||||
* Log in with admin user, create a category "manager sees me", give rm_manager read&file permission over it.
|
||||
* Create a disposition schedule for it that would cut off folders after 1 day from created date. Copy the category.
|
||||
* <p>
|
||||
* <p/> TestRail Test C775<p/>
|
||||
**/
|
||||
@Test
|
||||
@AlfrescoTest(jira = "RM-1622")
|
||||
public void dispositionScheduleLinkedRecords() throws UnsupportedEncodingException {
|
||||
STEP("Create record category");
|
||||
Category1 = createRootCategory(categoryRM3077);
|
||||
|
||||
//create retention schedule
|
||||
dispositionScheduleService.createCategoryRetentionSchedule(Category1.getName(), false);
|
||||
|
||||
// add cut off step
|
||||
dispositionScheduleService.addCutOffAfterPeriodStep(Category1.getName(), "day|2", CREATED_DATE);
|
||||
|
||||
//create a copy of the category recordsCategory
|
||||
String CopyCategoryId = copyCategory(getAdminUser(),Category1.getId(), copyCategoryRM3077);
|
||||
|
||||
// create folders in both categories
|
||||
CatFolder = createRecordFolder(Category1.getId(), folderRM3077);
|
||||
CopyCatFolder = createRecordFolder(CopyCategoryId, copyFolderRM3077);
|
||||
|
||||
// create record files
|
||||
String electronicRecord = "RM-2801 electronic record";
|
||||
Record elRecord = createElectronicRecord(CatFolder.getId(), electronicRecord);
|
||||
String elRecordFullName = recordsAPI.getRecordFullName(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), CatFolder.getName(), electronicRecord);
|
||||
|
||||
String nonElectronicRecord = "RM-2801 non-electronic record";
|
||||
Record nonElRecord = createNonElectronicRecord(CatFolder.getId(), nonElectronicRecord);
|
||||
String nonElRecordFullName = recordsAPI.getRecordFullName(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), CatFolder.getName(), nonElectronicRecord);
|
||||
|
||||
// link the records to copy folder, then complete them
|
||||
List<String> recordLists = new ArrayList<>();
|
||||
recordLists.add(NODE_REF_WORKSPACE_SPACES_STORE + elRecord.getId());
|
||||
recordLists.add(NODE_REF_WORKSPACE_SPACES_STORE + nonElRecord.getId());
|
||||
|
||||
linksAPI.linkRecord(getDataUser().getAdminUser().getUsername(),
|
||||
getDataUser().getAdminUser().getPassword(), HttpStatus.SC_OK,copyCategoryRM3077 + "/" +
|
||||
copyFolderRM3077, recordLists);
|
||||
recordsAPI.completeRecord(rmAdmin.getUsername(), rmAdmin.getPassword(), elRecordFullName);
|
||||
recordsAPI.completeRecord(rmAdmin.getUsername(), rmAdmin.getPassword(), nonElRecordFullName);
|
||||
|
||||
// edit disposition date
|
||||
recordFoldersAPI.postFolderAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),editDispositionDateJson(),CatFolder.getName());
|
||||
|
||||
// cut off the Folder
|
||||
recordFoldersAPI.postFolderAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),new JSONObject().put("name","cutoff"),CatFolder.getName());
|
||||
|
||||
// Verify the Content
|
||||
Node electronicNode = getNode(elRecord.getId());
|
||||
assertTrue("The content of " + electronicRecord + " is available",
|
||||
StringUtils.isEmpty(electronicNode.getNodeContent().getResponse().getBody().asString()));
|
||||
|
||||
// verify the Properties
|
||||
AssertJUnit.assertNull("The properties are present even after cutting off the record.", elRecord.getProperties().getTitle());
|
||||
|
||||
// delete precondition
|
||||
deleteRecordCategory(Category1.getId());
|
||||
deleteRecordCategory(CopyCategoryId);
|
||||
}
|
||||
/**
|
||||
* Test covering RM-3060
|
||||
* Check the disposition steps for a record can be executed
|
||||
* When the record is linked to a folder with the same disposition schedule
|
||||
* */
|
||||
@Test
|
||||
@AlfrescoTest (jira = "RM-3060")
|
||||
public void sameDispositionScheduleLinkedRecords() throws UnsupportedEncodingException {
|
||||
|
||||
// create a category with retention applied on records level
|
||||
RecordCategory recordCategory = getRestAPIFactory().getFilePlansAPI(rmAdmin)
|
||||
.createRootRecordCategory(RecordCategory.builder().name(firstCategoryRM3060).build(),
|
||||
RecordCategory.DEFAULT_FILE_PLAN_ALIAS);
|
||||
dispositionScheduleService.createCategoryRetentionSchedule(firstCategoryRM3060, true);
|
||||
dispositionScheduleService.addCutOffAfterPeriodStep(firstCategoryRM3060, "week|1", DATE_FILED);
|
||||
dispositionScheduleService.addTransferAfterEventStep(firstCategoryRM3060, TRANSFER_LOCATION, RMEvents.CASE_CLOSED.getEventName());
|
||||
dispositionScheduleService.addDestroyWithoutGhostingAfterPeriodStep(firstCategoryRM3060, "week|1", CUT_OFF_DATE);
|
||||
|
||||
// make a copy of the category created
|
||||
String categorySecondId = copyCategory(getAdminUser(), recordCategory.getId(), secondCategoryRM3060);
|
||||
|
||||
// create a folder on the category firstCategoryRM3060 with a complete electronic record
|
||||
RecordCategoryChild firstFolderRecordCategoryChild = createRecordFolder(recordCategory.getId(),firstFolderRM3060);
|
||||
Record firstElectronicRecord = createElectronicRecord(firstFolderRecordCategoryChild.getId(),electronicRecordRM3060);
|
||||
|
||||
String elRecordFullName = recordsAPI.getRecordFullName(getDataUser().getAdminUser().getUsername(),
|
||||
getDataUser().getAdminUser().getPassword(),firstFolderRM3060, electronicRecordRM3060);
|
||||
String elRecordNameNodeRef = recordsAPI.getRecordNodeRef(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), elRecordFullName, "/" + firstCategoryRM3060 + "/" + firstFolderRM3060);
|
||||
|
||||
recordsAPI.completeRecord(getDataUser().getAdminUser().getUsername(),
|
||||
getDataUser().getAdminUser().getPassword(), elRecordFullName);
|
||||
|
||||
// create a folder on the category secondCategoryRM3060 with a non electronic record
|
||||
RecordCategoryChild secondFolderRecordCategoryChild = createRecordFolder(categorySecondId,secondFolderRM3060);
|
||||
Record secondNonElectronicRecord = createNonElectronicRecord(secondFolderRecordCategoryChild.getId(),nonElectronicRecordRM3060);
|
||||
|
||||
// link the nonElectronicRecordRM3060 to firstFolderRM3060
|
||||
List<String> recordLists = new ArrayList<>();
|
||||
recordLists.add(NODE_REF_WORKSPACE_SPACES_STORE + secondNonElectronicRecord.getId());
|
||||
|
||||
linksAPI.linkRecord(getDataUser().getAdminUser().getUsername(),
|
||||
getDataUser().getAdminUser().getPassword(), HttpStatus.SC_OK,secondCategoryRM3060 + "/" +
|
||||
secondFolderRM3060, recordLists);
|
||||
String nonElRecordFullName = recordsAPI.getRecordFullName(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), secondFolderRM3060, secondNonElectronicRecord.getName());
|
||||
String nonElRecordNameNodeRef = recordsAPI.getRecordNodeRef(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), nonElRecordFullName, "/" + secondCategoryRM3060 + "/" + secondFolderRM3060);
|
||||
|
||||
// complete records and cut them off
|
||||
recordsAPI.completeRecord(getDataUser().getAdminUser().getUsername(),
|
||||
getDataUser().getAdminUser().getPassword(), nonElRecordFullName);
|
||||
|
||||
// edit the disposition date
|
||||
recordFoldersAPI.postRecordAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),editDispositionDateJson(),nonElRecordNameNodeRef);
|
||||
|
||||
// cut off the record
|
||||
recordFoldersAPI.postRecordAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),new JSONObject().put("name","cutoff"),nonElRecordNameNodeRef);
|
||||
|
||||
//check the record is cut off
|
||||
AssertJUnit.assertTrue("The file " + nonElectronicRecordRM3060 + " has not been successfully cut off.", getRestAPIFactory().getRecordsAPI().getRecord(secondNonElectronicRecord.getId()).getAspectNames().contains(CUT_OFF_ASPECT));
|
||||
|
||||
// link the electronic record to secondFolderRM3060
|
||||
recordLists.clear();
|
||||
recordLists.add(NODE_REF_WORKSPACE_SPACES_STORE + secondNonElectronicRecord.getId());
|
||||
linksAPI.linkRecord(getDataUser().getAdminUser().getUsername(),
|
||||
getDataUser().getAdminUser().getPassword(), HttpStatus.SC_OK,secondCategoryRM3060 + "/" +
|
||||
secondFolderRM3060, recordLists);
|
||||
|
||||
// edit the disposition date and cut off the record
|
||||
recordFoldersAPI.postRecordAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),editDispositionDateJson(),elRecordNameNodeRef);
|
||||
recordFoldersAPI.postRecordAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),new JSONObject().put("name","cutoff"),elRecordNameNodeRef);
|
||||
|
||||
AssertJUnit.assertTrue("The file " + electronicRecordRM3060 + " has not been successfully cut off.", getRestAPIFactory().getRecordsAPI().getRecord(firstElectronicRecord.getId()).getAspectNames().contains(CUT_OFF_ASPECT));
|
||||
|
||||
// open the record and complete the disposition schedule event
|
||||
rmRolesAndActionsAPI.completeEvent(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(), elRecordFullName, RMEvents.CASE_CLOSED, Instant.now());
|
||||
rmRolesAndActionsAPI.completeEvent(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(), nonElRecordFullName, RMEvents.CASE_CLOSED, Instant.now());
|
||||
|
||||
// transfer the files & complete transfers
|
||||
HttpResponse nonElRecordNameHttpResponse = recordFoldersAPI.postRecordAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),new JSONObject().put("name","transfer"),recordsAPI.getRecordNodeRef(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), nonElRecordFullName, "/" + secondCategoryRM3060 + "/" + secondFolderRM3060));
|
||||
|
||||
String nonElRecordNameTransferId = getTransferId(nonElRecordNameHttpResponse,nonElRecordNameNodeRef);
|
||||
recordFoldersAPI.postRecordAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),new JSONObject().put("name","transferComplete"),nonElRecordNameTransferId);
|
||||
|
||||
HttpResponse elRecordNameHttpResponse = recordFoldersAPI.postRecordAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),new JSONObject().put("name","transfer"),recordsAPI.getRecordNodeRef(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), elRecordFullName, "/" + firstCategoryRM3060 + "/" + firstFolderRM3060));
|
||||
|
||||
String elRecordNameTransferId = getTransferId(elRecordNameHttpResponse,elRecordNameNodeRef);
|
||||
recordFoldersAPI.postRecordAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),new JSONObject().put("name","transferComplete"),elRecordNameTransferId);
|
||||
|
||||
AssertJUnit.assertTrue("The file " + electronicRecordRM3060 + " has not been successfully transferred", getRestAPIFactory().getRecordsAPI().getRecord(firstElectronicRecord.getId()).getAspectNames().contains(TRANSFER_TYPE));
|
||||
AssertJUnit.assertTrue("The file " + nonElectronicRecordRM3060 + " has not been successfully transferred.", getRestAPIFactory().getRecordsAPI().getRecord(secondNonElectronicRecord.getId()).getAspectNames().contains(TRANSFER_TYPE));
|
||||
|
||||
// edit the disposition date for nonElectronicRecordRM3060 & electronicRecordRM3060
|
||||
recordFoldersAPI.postRecordAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),editDispositionDateJson(),nonElRecordNameNodeRef);
|
||||
recordFoldersAPI.postRecordAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),editDispositionDateJson(),elRecordNameNodeRef);
|
||||
|
||||
// destroy nonElectronicRecordRM3060 & electronicRecordRM3060 records
|
||||
recordFoldersAPI.postRecordAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),new JSONObject().put("name","destroy"),nonElRecordNameNodeRef);
|
||||
recordFoldersAPI.postRecordAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),new JSONObject().put("name","destroy"),elRecordNameNodeRef);
|
||||
|
||||
// check the file is not displayed
|
||||
assertNull("The file " + nonElectronicRecordRM3060 + " has not been successfully destroyed.", secondNonElectronicRecord.getContent());
|
||||
assertNull("The file " + electronicRecordRM3060 + " has not been successfully destroyed.", firstElectronicRecord.getContent());
|
||||
|
||||
// delete precondition
|
||||
deleteRecordCategory(recordCategory.getId());
|
||||
deleteRecordCategory(categorySecondId);
|
||||
}
|
||||
private String copyCategory(UserModel user, String categoryId, String copyName) {
|
||||
RepoTestModel repoTestModel = new RepoTestModel() {};
|
||||
repoTestModel.setNodeRef(categoryId);
|
||||
RestNodeModel restNodeModel;
|
||||
|
||||
RestNodeBodyMoveCopyModel copyDestinationInfo = new RestNodeBodyMoveCopyModel();
|
||||
copyDestinationInfo.setTargetParentId(filePlanModel.getId());
|
||||
copyDestinationInfo.setName(copyName);
|
||||
|
||||
try
|
||||
{
|
||||
restNodeModel = getRestAPIFactory().getNodeAPI(user, repoTestModel).copy(copyDestinationInfo);
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
throw new RuntimeException("Problem copying category.", e);
|
||||
}
|
||||
return restNodeModel.getId();
|
||||
}
|
||||
|
||||
private Node getNode(String recordId)
|
||||
{
|
||||
RepoTestModel repoTestModel = new RepoTestModel() {};
|
||||
repoTestModel.setNodeRef(recordId);
|
||||
return getRestAPIFactory().getNodeAPI(repoTestModel);
|
||||
}
|
||||
|
||||
private String getTransferId(HttpResponse httpResponse,String nodeRef) {
|
||||
HttpEntity entity = httpResponse.getEntity();
|
||||
String responseString = null;
|
||||
try {
|
||||
responseString = EntityUtils.toString(entity, "UTF-8");
|
||||
} catch (IOException e) {
|
||||
throw new RuntimeException(e);
|
||||
}
|
||||
JSONObject result = new JSONObject(responseString);
|
||||
return result
|
||||
.getJSONObject("results")
|
||||
.get(nodeRef)
|
||||
.toString();
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
@AlfrescoTest(jira = "RM-1622")
|
||||
public void sameLevelDispositionScheduleStepsPeriodsCalculation() throws Exception {
|
||||
|
||||
// create a category with retention applied on records level
|
||||
RecordCategory catsameLevel1 = getRestAPIFactory().getFilePlansAPI(rmAdmin)
|
||||
.createRootRecordCategory(RecordCategory.builder().name(firstCategoryRM3060).build(),
|
||||
RecordCategory.DEFAULT_FILE_PLAN_ALIAS);
|
||||
RecordCategory catsameLevel2 = getRestAPIFactory().getFilePlansAPI(rmAdmin)
|
||||
.createRootRecordCategory(RecordCategory.builder().name(secondCategoryRM3060).build(),
|
||||
RecordCategory.DEFAULT_FILE_PLAN_ALIAS);
|
||||
|
||||
// create retention schedule applied on records for category 1
|
||||
dispositionScheduleService.createCategoryRetentionSchedule(firstCategoryRM3060, true);
|
||||
|
||||
// with retain immediately after record creation date and cut 1 day after record creation date
|
||||
dispositionScheduleService.addCutOffAfterPeriodStep(firstCategoryRM3060, "day|1", DATE_FILED);
|
||||
|
||||
|
||||
// create a folder on the category firstCategoryRM3060 with a complete electronic record
|
||||
RecordCategoryChild firstFolderRecordCategoryChild = createRecordFolder(catsameLevel1.getId(),firstFolderRM3060);
|
||||
Record firstElectronicRecord = createElectronicRecord(firstFolderRecordCategoryChild.getId(),electronicRecordRM3060);
|
||||
|
||||
String elRecordFullName = recordsAPI.getRecordFullName(getDataUser().getAdminUser().getUsername(),
|
||||
getDataUser().getAdminUser().getPassword(),firstFolderRM3060, electronicRecordRM3060);
|
||||
String elRecordNameNodeRef = recordsAPI.getRecordNodeRef(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), elRecordFullName, "/" + firstCategoryRM3060 + "/" + firstFolderRM3060);
|
||||
|
||||
recordsAPI.completeRecord(getDataUser().getAdminUser().getUsername(),
|
||||
getDataUser().getAdminUser().getPassword(), elRecordFullName);
|
||||
|
||||
// create a folder on the category secondCategoryRM3060 with a non electronic record
|
||||
RecordCategoryChild secondFolderRecordCategoryChild = createRecordFolder(catsameLevel2.getId(),secondFolderRM3060);
|
||||
String elRecordNameNodeRefs = recordsAPI.getRecordNodeRef(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), elRecordFullName, "/" + firstCategoryRM3060 + "/" + firstFolderRM3060);
|
||||
|
||||
|
||||
// link it to the folder in second category through the details page
|
||||
List<String> recordLists = new ArrayList<>();
|
||||
recordLists.add(NODE_REF_WORKSPACE_SPACES_STORE + firstElectronicRecord.getId());
|
||||
|
||||
linksAPI.linkRecord(getDataUser().getAdminUser().getUsername(),
|
||||
getDataUser().getAdminUser().getPassword(), HttpStatus.SC_OK,secondCategoryRM3060 + "/" +
|
||||
secondFolderRM3060, recordLists);
|
||||
|
||||
// edit disposition date
|
||||
recordFoldersAPI.postRecordAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),editDispositionDateJson(),elRecordNameNodeRefs);
|
||||
|
||||
|
||||
}
|
||||
|
||||
@Test (dependsOnMethods = {"sameLevelDispositionScheduleStepsPeriodsCalculation" })
|
||||
public void deleteLongestPeriodTestPrecondition() {
|
||||
// Delete the RM site
|
||||
getRestAPIFactory().getRMSiteAPI().deleteRMSite();
|
||||
|
||||
// Verify the status code
|
||||
assertStatusCode(NO_CONTENT);
|
||||
}
|
||||
}
|
@@ -0,0 +1,138 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Records Management Module
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2022 Alfresco Software Limited
|
||||
* %%
|
||||
* This file is part of the Alfresco software.
|
||||
* -
|
||||
* If the software was purchased under a paid Alfresco license, the terms of
|
||||
* the paid license agreement will prevail. Otherwise, the software is
|
||||
* provided under the following open source license terms:
|
||||
* -
|
||||
* Alfresco is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
* -
|
||||
* Alfresco is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
* -
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
||||
* #L%
|
||||
*/
|
||||
|
||||
package org.alfresco.rest.rm.community.smoke;
|
||||
|
||||
import org.alfresco.dataprep.CMISUtil;
|
||||
import org.alfresco.rest.rm.community.base.BaseRMRestTest;
|
||||
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategory;
|
||||
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryChild;
|
||||
import org.alfresco.rest.rm.community.model.recordfolder.RecordFolderCollection;
|
||||
import org.alfresco.rest.rm.community.model.user.UserRoles;
|
||||
import org.alfresco.rest.rm.community.records.FileUnfiledRecordsTests;
|
||||
import org.alfresco.rest.v0.RMRolesAndActionsAPI;
|
||||
import org.alfresco.rest.v0.RecordCategoriesAPI;
|
||||
import org.alfresco.rest.v0.RecordsAPI;
|
||||
import org.alfresco.rest.v0.service.RoleService;
|
||||
import org.alfresco.test.AlfrescoTest;
|
||||
import org.alfresco.utility.Utility;
|
||||
import org.alfresco.utility.data.DataContent;
|
||||
import org.alfresco.utility.data.DataSite;
|
||||
import org.alfresco.utility.model.FileModel;
|
||||
import org.alfresco.utility.model.FileType;
|
||||
import org.alfresco.utility.model.SiteModel;
|
||||
import org.alfresco.utility.model.UserModel;
|
||||
import org.json.JSONObject;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.testng.Assert;
|
||||
import org.testng.annotations.BeforeClass;
|
||||
import org.testng.annotations.Test;
|
||||
|
||||
import java.util.concurrent.atomic.AtomicReference;
|
||||
|
||||
import static org.alfresco.rest.rm.community.model.user.UserPermissions.PERMISSION_FILING;
|
||||
import static org.alfresco.rest.rm.community.util.CommonTestUtils.generateTestPrefix;
|
||||
import static org.alfresco.utility.data.RandomData.getRandomName;
|
||||
import static org.alfresco.utility.report.log.Step.STEP;
|
||||
import static org.springframework.test.util.AssertionErrors.assertTrue;
|
||||
import static org.testng.Assert.assertEquals;
|
||||
import static org.testng.Assert.fail;
|
||||
|
||||
public class FileVersionAsRecordTests extends BaseRMRestTest {
|
||||
|
||||
private UserModel nonRMuser,rmManager;
|
||||
private SiteModel testSite;
|
||||
private FileModel document, documentDeclared;
|
||||
private RecordCategory category_manager, category_admin;
|
||||
private RecordCategoryChild folder_admin, folder_manager ;
|
||||
private static final String CATEGORY_MANAGER = "catManager" + generateTestPrefix(FileAsRecordTests.class);
|
||||
private static final String CATEGORY_ADMIN = "catAdmin" + generateTestPrefix(FileAsRecordTests.class);
|
||||
private static final String FOLDER_MANAGER = "recordFolder" + generateTestPrefix(FileAsRecordTests.class);
|
||||
private static final String FOLDER_ADMIN = "recordFolder" + generateTestPrefix(FileAsRecordTests.class);
|
||||
|
||||
@Autowired
|
||||
private DataSite dataSite;
|
||||
@Autowired
|
||||
private DataContent dataContent;
|
||||
@Autowired
|
||||
private RoleService roleService;
|
||||
|
||||
@BeforeClass(alwaysRun = true)
|
||||
public void preconditionForFileVersionAsRecordTests()
|
||||
{
|
||||
STEP("Create the RM site if doesn't exist");
|
||||
createRMSiteIfNotExists();
|
||||
|
||||
STEP("Create a user");
|
||||
nonRMuser = dataUser.createRandomTestUser("testUser");
|
||||
|
||||
STEP("Create a collaboration site");
|
||||
testSite = dataSite.usingUser(nonRMuser).createPublicRandomSite();
|
||||
|
||||
STEP("Create a document with the user without RM role");
|
||||
document = dataContent.usingSite(testSite)
|
||||
.usingUser(nonRMuser)
|
||||
.createContent(CMISUtil.DocumentType.TEXT_PLAIN);
|
||||
|
||||
STEP("Create two categories with two folders");
|
||||
category_manager = createRootCategory(CATEGORY_MANAGER);
|
||||
category_admin = createRootCategory(CATEGORY_ADMIN);
|
||||
folder_admin = createFolder(category_admin.getId(),FOLDER_ADMIN);
|
||||
folder_manager = createFolder(category_manager.getId(),FOLDER_MANAGER);
|
||||
|
||||
STEP("Create an rm user and give filling permission over CATEGORY_MANAGER record category");
|
||||
RecordCategory recordCategory = new RecordCategory().builder()
|
||||
.id(category_manager.getId())
|
||||
.build();
|
||||
rmManager = roleService.createCollaboratorWithRMRoleAndPermission(testSite, recordCategory,
|
||||
UserRoles.ROLE_RM_MANAGER, PERMISSION_FILING);
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
@AlfrescoTest (jira = "APPS-1625")
|
||||
public void fileVersionAsRecordToUnfiledRecordContainer() throws Exception
|
||||
{
|
||||
|
||||
AtomicReference<RecordFolderCollection> apiChildren = new AtomicReference<>();
|
||||
|
||||
STEP("Create a document with the user without RM role");
|
||||
FileModel inplaceRecord = dataContent.usingSite(testSite).usingUser(rmManager)
|
||||
.createContent(new FileModel("declareAndFileToIntoUnfiledRecordFolder",
|
||||
FileType.TEXT_PLAIN));
|
||||
|
||||
STEP("Click on Declare and file without selecting a record folder");
|
||||
getRestAPIFactory().getActionsAPI(rmManager).declareAndFile(inplaceRecord,"");
|
||||
|
||||
STEP("Check the file is declared in unfiled record folder");
|
||||
Assert.assertTrue(isMatchingRecordInUnfiledRecords(inplaceRecord), "Record should be filed to Unfiled Records folder");
|
||||
|
||||
|
||||
}
|
||||
|
||||
|
||||
}
|
@@ -0,0 +1,156 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Records Management Module
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2022 Alfresco Software Limited
|
||||
* %%
|
||||
* This file is part of the Alfresco software.
|
||||
* -
|
||||
* If the software was purchased under a paid Alfresco license, the terms of
|
||||
* the paid license agreement will prevail. Otherwise, the software is
|
||||
* provided under the following open source license terms:
|
||||
* -
|
||||
* Alfresco is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
* -
|
||||
* Alfresco is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
* -
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
||||
* #L%
|
||||
*/
|
||||
|
||||
package org.alfresco.rest.rm.community.smoke;
|
||||
|
||||
import org.alfresco.rest.core.v0.BaseAPI;
|
||||
import org.alfresco.rest.rm.community.base.BaseRMRestTest;
|
||||
import org.alfresco.rest.rm.community.model.record.Record;
|
||||
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategory;
|
||||
import org.alfresco.rest.rm.community.model.recordcategory.RecordCategoryChild;
|
||||
import org.alfresco.rest.v0.RMRolesAndActionsAPI;
|
||||
import org.alfresco.rest.v0.RecordCategoriesAPI;
|
||||
import org.alfresco.rest.v0.RecordFoldersAPI;
|
||||
import org.alfresco.rest.v0.RecordsAPI;
|
||||
import org.alfresco.rest.v0.service.DispositionScheduleService;
|
||||
import org.alfresco.test.AlfrescoTest;
|
||||
import org.apache.commons.lang3.time.DateUtils;
|
||||
import org.json.JSONObject;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.testng.annotations.AfterClass;
|
||||
import org.testng.annotations.Test;
|
||||
import java.text.SimpleDateFormat;
|
||||
import java.util.Date;
|
||||
import java.util.HashMap;
|
||||
import static org.alfresco.rest.rm.community.base.TestData.DEFAULT_PASSWORD;
|
||||
import static org.alfresco.rest.rm.community.util.CommonTestUtils.generateTestPrefix;
|
||||
import static org.alfresco.utility.report.log.Step.STEP;
|
||||
import static org.testng.Assert.assertTrue;
|
||||
|
||||
public class RecordRetentionAsOfDateTest extends BaseRMRestTest {
|
||||
|
||||
/** data prep 6services */
|
||||
@Autowired
|
||||
private RMRolesAndActionsAPI rmRolesAndActionsAPI;
|
||||
@Autowired
|
||||
private RecordsAPI recordsAPI;
|
||||
@Autowired
|
||||
private RecordFoldersAPI recordFoldersAPI;
|
||||
@Autowired
|
||||
private RecordCategoriesAPI recordCategoriesAPI;
|
||||
@Autowired
|
||||
private DispositionScheduleService dispositionScheduleService;
|
||||
private RecordCategory Category1;
|
||||
private final String TEST_PREFIX = generateTestPrefix(RecordRetentionAsOfDateTest.class);
|
||||
private final String RM_ADMIN = TEST_PREFIX + "rm_admin";
|
||||
private final String recordsCategory = TEST_PREFIX + "RM-5733 category";
|
||||
private final String folderDisposition = TEST_PREFIX + "RM-5733 folder";
|
||||
|
||||
private static final String YEAR_MONTH_DAY = "yyyy-MM-dd";
|
||||
|
||||
@Test
|
||||
@AlfrescoTest (jira = "RM-5733,RM-5799")
|
||||
public void checkRetentionAsOfDateForTransferStepWithRetentionAction() {
|
||||
|
||||
// create test precondition
|
||||
createTestPrecondition(recordsCategory);
|
||||
|
||||
// create disposition schedule
|
||||
dispositionScheduleService.createCategoryRetentionSchedule(Category1.getName(), true);
|
||||
|
||||
// add cut off step
|
||||
dispositionScheduleService.addCutOffImmediatelyStep(Category1.getName());
|
||||
|
||||
// add transfer step
|
||||
HashMap<BaseAPI.RETENTION_SCHEDULE, String> transferStep = new HashMap<>();
|
||||
transferStep.put(BaseAPI.RETENTION_SCHEDULE.RETENTION_PERIOD, "day|1");
|
||||
transferStep.put(BaseAPI.RETENTION_SCHEDULE.NAME, "transfer");
|
||||
transferStep.put(BaseAPI.RETENTION_SCHEDULE.RETENTION_PERIOD_PROPERTY, "rma:cutOffDate");
|
||||
transferStep.put(BaseAPI.RETENTION_SCHEDULE.COMBINE_DISPOSITION_STEP_CONDITIONS, "false");
|
||||
transferStep.put(BaseAPI.RETENTION_SCHEDULE.RETENTION_ELIGIBLE_FIRST_EVENT, "true");
|
||||
transferStep.put(BaseAPI.RETENTION_SCHEDULE.RETENTION_GHOST, "on");
|
||||
transferStep.put(BaseAPI.RETENTION_SCHEDULE.DESCRIPTION, "Transfer after 1 day");
|
||||
recordCategoriesAPI.addDispositionScheduleSteps(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(), Category1.getName(), transferStep);
|
||||
|
||||
// create a folder and an electronic and a non-electronic record in it
|
||||
RecordCategoryChild FOLDER = createFolder(getAdminUser(),Category1.getId(),folderDisposition);
|
||||
|
||||
String nonElectronicRecord = TEST_PREFIX + "RM-5733 non-electronic record";
|
||||
Record nonElRecord = createNonElectronicRecord(FOLDER.getId(), nonElectronicRecord);
|
||||
|
||||
// complete records and cut them off
|
||||
String nonElRecordName = recordsAPI.getRecordFullName(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(), folderDisposition, nonElectronicRecord);
|
||||
|
||||
// complete records and cut them off
|
||||
completeRecord(nonElRecord.getId());
|
||||
|
||||
String nonElRecordNameNodeRef = recordsAPI.getRecordNodeRef(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(), nonElRecordName, "/" + Category1.getName() + "/" + folderDisposition);
|
||||
recordFoldersAPI.postRecordAction(getAdminUser().getUsername(),
|
||||
getAdminUser().getPassword(),new JSONObject().put("name","cutoff"),nonElRecordNameNodeRef);
|
||||
|
||||
JSONObject nextDispositionActionJson = recordCategoriesAPI.getNextDispositionAction(getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(),nonElRecord.getId());
|
||||
|
||||
assertTrue(getAsOfDate(nextDispositionActionJson).startsWith(getTomorrow()),
|
||||
"The retention as of date is not set to tomorrow.");
|
||||
}
|
||||
|
||||
@AfterClass(alwaysRun = true)
|
||||
public void cleanUp() {
|
||||
// delete category
|
||||
deleteRecordCategory(Category1.getId());
|
||||
}
|
||||
|
||||
private void createTestPrecondition(String categoryName) {
|
||||
createRMSiteIfNotExists();
|
||||
|
||||
// create "rm admin" user if it does not exist and assign it to RM Administrator role
|
||||
rmRolesAndActionsAPI.createUserAndAssignToRole(
|
||||
getDataUser().usingAdmin().getAdminUser().getUsername(),
|
||||
getDataUser().usingAdmin().getAdminUser().getPassword(),
|
||||
RM_ADMIN, DEFAULT_PASSWORD, "Administrator");
|
||||
|
||||
// create category
|
||||
STEP("Create category");
|
||||
Category1 = createRootCategory(categoryName,"Title");
|
||||
}
|
||||
|
||||
private String getAsOfDate(JSONObject nextDispositionActionJson) {
|
||||
return nextDispositionActionJson.getJSONObject("data").get("asOf").toString();
|
||||
}
|
||||
|
||||
private static String getTomorrow() {
|
||||
Date today = new Date();
|
||||
Date tomorrow = DateUtils.addDays(today, 1);
|
||||
SimpleDateFormat dateFormat = new SimpleDateFormat(YEAR_MONTH_DAY);
|
||||
return dateFormat.format(tomorrow);
|
||||
}
|
||||
|
||||
}
|
@@ -7,7 +7,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-governance-services-community-parent</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<modules>
|
||||
|
@@ -109,6 +109,10 @@ rm.completerecord.mandatorypropertiescheck.enabled=true
|
||||
#
|
||||
rm.patch.v22.convertToStandardFilePlan=false
|
||||
|
||||
#
|
||||
# Max Batch size for adding the associations between the frozen nodes and the hold
|
||||
rm.patch.v35.holdNewChildAssocPatch.batchSize=1000
|
||||
|
||||
# Permission mapping
|
||||
# these take a comma separated string of permissions from org.alfresco.service.cmr.security.PermissionService
|
||||
# read maps to ReadRecords and write to FileRecords
|
||||
|
@@ -17,5 +17,6 @@
|
||||
<property name="filePlanService" ref="filePlanService" />
|
||||
<property name="holdService" ref="holdService" />
|
||||
<property name="nodeService" ref="nodeService" />
|
||||
<property name="batchSize" value="${rm.patch.v35.holdNewChildAssocPatch.batchSize}" />
|
||||
</bean>
|
||||
</beans>
|
||||
|
@@ -8,7 +8,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-governance-services-community-repo-parent</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<properties>
|
||||
|
@@ -38,9 +38,12 @@ import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.alfresco.model.ContentModel;
|
||||
import org.alfresco.module.org_alfresco_module_rm.capability.CapabilityService;
|
||||
import org.alfresco.module.org_alfresco_module_rm.capability.impl.ViewRecordsCapability;
|
||||
import org.alfresco.module.org_alfresco_module_rm.disposition.DispositionAction;
|
||||
import org.alfresco.module.org_alfresco_module_rm.disposition.DispositionActionDefinition;
|
||||
import org.alfresco.module.org_alfresco_module_rm.disposition.DispositionService;
|
||||
import org.alfresco.module.org_alfresco_module_rm.event.EventCompletionDetails;
|
||||
import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanComponentKind;
|
||||
@@ -76,6 +79,7 @@ import org.json.simple.JSONObject;
|
||||
*
|
||||
* @author Roy Wetherall
|
||||
*/
|
||||
@Slf4j
|
||||
public class JSONConversionComponent extends org.alfresco.repo.jscript.app.JSONConversionComponent
|
||||
implements NodeServicePolicies.OnDeleteNodePolicy,
|
||||
NodeServicePolicies.OnCreateNodePolicy
|
||||
@@ -515,17 +519,25 @@ public class JSONConversionComponent extends org.alfresco.repo.jscript.app.JS
|
||||
|
||||
AuthenticationUtil.runAsSystem((RunAsWork<Void>) () -> {
|
||||
//Add details of the next incomplete event in the disposition schedule
|
||||
if (dispositionService.getNextDispositionAction(nodeRef) != null)
|
||||
DispositionAction nextDispositionAction = dispositionService.getNextDispositionAction(nodeRef);
|
||||
if (nextDispositionAction != null)
|
||||
{
|
||||
for (EventCompletionDetails details : dispositionService.getNextDispositionAction(nodeRef).getEventCompletionDetails())
|
||||
for (EventCompletionDetails details : nextDispositionAction.getEventCompletionDetails())
|
||||
{
|
||||
if (!details.isEventComplete())
|
||||
{
|
||||
DispositionActionDefinition dispositionActionDefinition = nextDispositionAction.getDispositionActionDefinition();
|
||||
HashMap properties = (HashMap) rmNodeValues.get("properties");
|
||||
properties.put("combineDispositionStepConditions", nodeService.getProperty(dispositionService.getNextDispositionAction(nodeRef).getDispositionActionDefinition().getNodeRef(), PROP_COMBINE_DISPOSITION_STEP_CONDITIONS));
|
||||
properties.put("incompleteDispositionEvent", details.getEventName());
|
||||
properties.put("dispositionEventCombination", nodeService.getProperty(dispositionService.getNextDispositionAction(nodeRef).getDispositionActionDefinition().getNodeRef(), PROP_DISPOSITION_EVENT_COMBINATION));
|
||||
|
||||
if(dispositionActionDefinition == null)
|
||||
{
|
||||
log.debug("Disposition action definition for disposition action "+ nextDispositionAction.getName() +" has been removed or never exist");
|
||||
}
|
||||
else
|
||||
{
|
||||
properties.put("combineDispositionStepConditions", nodeService.getProperty(dispositionActionDefinition.getNodeRef(), PROP_COMBINE_DISPOSITION_STEP_CONDITIONS));
|
||||
properties.put("dispositionEventCombination", nodeService.getProperty(dispositionActionDefinition.getNodeRef(), PROP_DISPOSITION_EVENT_COMBINATION));
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
@@ -30,6 +30,9 @@ import static org.alfresco.model.ContentModel.ASSOC_CONTAINS;
|
||||
import static org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementCustomModel.RM_CUSTOM_URI;
|
||||
import static org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel.ASSOC_FROZEN_CONTENT;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collection;
|
||||
import java.util.Iterator;
|
||||
import java.util.List;
|
||||
|
||||
import org.alfresco.model.ContentModel;
|
||||
@@ -37,11 +40,14 @@ import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanService;
|
||||
import org.alfresco.module.org_alfresco_module_rm.hold.HoldService;
|
||||
import org.alfresco.module.org_alfresco_module_rm.patch.AbstractModulePatch;
|
||||
import org.alfresco.repo.policy.BehaviourFilter;
|
||||
import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
|
||||
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.namespace.QName;
|
||||
import org.alfresco.service.namespace.RegexQNamePattern;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
/**
|
||||
* Patch to create new hold child association to link the record to the hold
|
||||
@@ -52,8 +58,15 @@ import org.alfresco.service.namespace.RegexQNamePattern;
|
||||
*/
|
||||
public class RMv35HoldNewChildAssocPatch extends AbstractModulePatch
|
||||
{
|
||||
/** logger */
|
||||
protected static final Logger LOGGER = LoggerFactory.getLogger(RMv35HoldNewChildAssocPatch.class);
|
||||
|
||||
/** A name for the associations created by this patch. */
|
||||
protected static final QName PATCH_ASSOC_NAME = QName.createQName(RM_CUSTOM_URI, RMv35HoldNewChildAssocPatch.class.getSimpleName());
|
||||
protected static final QName PATCH_ASSOC_NAME = QName.createQName(RM_CUSTOM_URI,
|
||||
RMv35HoldNewChildAssocPatch.class.getSimpleName());
|
||||
|
||||
/** The batch size for processing frozen nodes. */
|
||||
private int batchSize = 1000;
|
||||
|
||||
/**
|
||||
* File plan service interface
|
||||
@@ -75,7 +88,8 @@ public class RMv35HoldNewChildAssocPatch extends AbstractModulePatch
|
||||
/**
|
||||
* Setter for fileplanservice
|
||||
*
|
||||
* @param filePlanService File plan service interface
|
||||
* @param filePlanService
|
||||
* File plan service interface
|
||||
*/
|
||||
public void setFilePlanService(FilePlanService filePlanService)
|
||||
{
|
||||
@@ -85,7 +99,8 @@ public class RMv35HoldNewChildAssocPatch extends AbstractModulePatch
|
||||
/**
|
||||
* Setter for hold service
|
||||
*
|
||||
* @param holdService Hold service interface.
|
||||
* @param holdService
|
||||
* Hold service interface.
|
||||
*/
|
||||
public void setHoldService(HoldService holdService)
|
||||
{
|
||||
@@ -95,7 +110,8 @@ public class RMv35HoldNewChildAssocPatch extends AbstractModulePatch
|
||||
/**
|
||||
* Setter for node service
|
||||
*
|
||||
* @param nodeService Interface for public and internal node and store operations.
|
||||
* @param nodeService
|
||||
* Interface for public and internal node and store operations.
|
||||
*/
|
||||
public void setNodeService(NodeService nodeService)
|
||||
{
|
||||
@@ -112,33 +128,49 @@ public class RMv35HoldNewChildAssocPatch extends AbstractModulePatch
|
||||
this.behaviourFilter = behaviourFilter;
|
||||
}
|
||||
|
||||
/**
|
||||
* Setter for maximum batch size
|
||||
*
|
||||
* @param maxBatchSize
|
||||
* The max amount of associations to be created between the frozen nodes and the hold in a transaction
|
||||
*/
|
||||
public void setBatchSize(int batchSize)
|
||||
{
|
||||
this.batchSize = batchSize;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void applyInternal()
|
||||
{
|
||||
behaviourFilter.disableBehaviour(ContentModel.ASPECT_AUDITABLE);
|
||||
behaviourFilter.disableBehaviour(ContentModel.ASPECT_VERSIONABLE);
|
||||
|
||||
try
|
||||
{
|
||||
int patchedNodesCounter = 0;
|
||||
|
||||
for (NodeRef filePlan : filePlanService.getFilePlans())
|
||||
{
|
||||
for (NodeRef hold : holdService.getHolds(filePlan))
|
||||
{
|
||||
List<ChildAssociationRef> frozenAssoc = nodeService.getChildAssocs(hold, ASSOC_FROZEN_CONTENT, RegexQNamePattern.MATCH_ALL);
|
||||
for (ChildAssociationRef ref : frozenAssoc)
|
||||
LOGGER.debug("Analyzing hold {}", hold.getId());
|
||||
|
||||
BatchWorker batchWorker = new BatchWorker(hold);
|
||||
|
||||
LOGGER.debug("Hold has {} items to be analyzed", batchWorker.getWorkSize());
|
||||
|
||||
while (batchWorker.hasMoreResults())
|
||||
{
|
||||
NodeRef childNodeRef = ref.getChildRef();
|
||||
// In testing we found that this was returning more than just "contains" associations.
|
||||
// Possibly this is due to the code in Node2ServiceImpl.getParentAssocs not using the second parameter.
|
||||
List<ChildAssociationRef> parentAssocs = nodeService.getParentAssocs(childNodeRef, ASSOC_CONTAINS, RegexQNamePattern.MATCH_ALL);
|
||||
boolean childContainedByHold =
|
||||
parentAssocs.stream().anyMatch(entry -> entry.getParentRef().equals(hold) && entry.getTypeQName().equals(ASSOC_CONTAINS));
|
||||
if (!childContainedByHold)
|
||||
{
|
||||
nodeService.addChild(hold, childNodeRef, ASSOC_CONTAINS, PATCH_ASSOC_NAME);
|
||||
}
|
||||
processBatch(hold, batchWorker);
|
||||
}
|
||||
|
||||
LOGGER.debug("Patched {} items in hold", batchWorker.getTotalPatchedNodes());
|
||||
|
||||
patchedNodesCounter += batchWorker.getTotalPatchedNodes();
|
||||
}
|
||||
}
|
||||
|
||||
LOGGER.debug("Patch applied to {} children across all holds", patchedNodesCounter);
|
||||
}
|
||||
finally
|
||||
{
|
||||
@@ -146,4 +178,92 @@ public class RMv35HoldNewChildAssocPatch extends AbstractModulePatch
|
||||
behaviourFilter.enableBehaviour(ContentModel.ASPECT_VERSIONABLE);
|
||||
}
|
||||
}
|
||||
|
||||
private void processBatch(NodeRef hold, BatchWorker batch)
|
||||
{
|
||||
transactionService.getRetryingTransactionHelper().doInTransaction(() -> {
|
||||
|
||||
Collection<ChildAssociationRef> childRefs = batch.getNextWork();
|
||||
|
||||
LOGGER.debug("Processing batch of {} children in hold", childRefs.size());
|
||||
|
||||
for (ChildAssociationRef child : childRefs)
|
||||
{
|
||||
NodeRef childNodeRef = child.getChildRef();
|
||||
|
||||
if (!isChildContainedByHold(hold, childNodeRef))
|
||||
{
|
||||
nodeService.addChild(hold, childNodeRef, ASSOC_CONTAINS, PATCH_ASSOC_NAME);
|
||||
batch.countPatchedNode();
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}, false, true);
|
||||
}
|
||||
|
||||
private boolean isChildContainedByHold(NodeRef hold, NodeRef child)
|
||||
{
|
||||
// In testing we found that this was returning more than just "contains" associations.
|
||||
// Possibly this is due to the code in Node2ServiceImpl.getParentAssocs not using the second
|
||||
// parameter.
|
||||
List<ChildAssociationRef> parentAssocs = nodeService.getParentAssocs(child, ASSOC_CONTAINS, RegexQNamePattern.MATCH_ALL);
|
||||
return parentAssocs.stream()
|
||||
.anyMatch(entry -> entry.getParentRef().equals(hold) && entry.getTypeQName().equals(ASSOC_CONTAINS));
|
||||
}
|
||||
|
||||
private class BatchWorker
|
||||
{
|
||||
NodeRef hold;
|
||||
int totalPatchedNodes = 0;
|
||||
int workSize;
|
||||
Iterator<ChildAssociationRef> iterator;
|
||||
|
||||
public BatchWorker(NodeRef hold)
|
||||
{
|
||||
this.hold = hold;
|
||||
setupHold();
|
||||
}
|
||||
|
||||
public boolean hasMoreResults()
|
||||
{
|
||||
return iterator == null ? true : iterator.hasNext();
|
||||
}
|
||||
|
||||
public void countPatchedNode()
|
||||
{
|
||||
this.totalPatchedNodes += 1;
|
||||
}
|
||||
|
||||
public int getTotalPatchedNodes()
|
||||
{
|
||||
return totalPatchedNodes;
|
||||
}
|
||||
|
||||
public int getWorkSize()
|
||||
{
|
||||
return workSize;
|
||||
}
|
||||
|
||||
public void setupHold()
|
||||
{
|
||||
// Get child assocs without preloading
|
||||
List<ChildAssociationRef> holdChildren = nodeService.getChildAssocs(hold, ASSOC_FROZEN_CONTENT,
|
||||
RegexQNamePattern.MATCH_ALL, Integer.MAX_VALUE, false);
|
||||
this.iterator = holdChildren.listIterator();
|
||||
this.workSize = holdChildren.size();
|
||||
}
|
||||
|
||||
public Collection<ChildAssociationRef> getNextWork()
|
||||
{
|
||||
List<ChildAssociationRef> frozenNodes = new ArrayList<ChildAssociationRef>(batchSize);
|
||||
while (iterator.hasNext() && frozenNodes.size() < batchSize)
|
||||
{
|
||||
frozenNodes.add(iterator.next());
|
||||
}
|
||||
return frozenNodes;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
@@ -34,7 +34,9 @@ import static org.alfresco.model.ContentModel.ASSOC_CONTAINS;
|
||||
import static org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel.ASSOC_FROZEN_CONTENT;
|
||||
import static org.alfresco.module.org_alfresco_module_rm.patch.v35.RMv35HoldNewChildAssocPatch.PATCH_ASSOC_NAME;
|
||||
import static org.mockito.ArgumentMatchers.any;
|
||||
import static org.mockito.ArgumentMatchers.anyBoolean;
|
||||
import static org.mockito.ArgumentMatchers.anyMap;
|
||||
import static org.mockito.Mockito.doAnswer;
|
||||
import static org.mockito.Mockito.doReturn;
|
||||
import static org.mockito.Mockito.never;
|
||||
import static org.mockito.Mockito.times;
|
||||
@@ -51,16 +53,21 @@ import java.util.Set;
|
||||
import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanService;
|
||||
import org.alfresco.module.org_alfresco_module_rm.hold.HoldService;
|
||||
import org.alfresco.repo.policy.BehaviourFilter;
|
||||
import org.alfresco.repo.transaction.RetryingTransactionHelper;
|
||||
import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
|
||||
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.namespace.QName;
|
||||
import org.alfresco.service.namespace.RegexQNamePattern;
|
||||
import org.alfresco.service.transaction.TransactionService;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
import org.mockito.InjectMocks;
|
||||
import org.mockito.Mock;
|
||||
import org.mockito.MockitoAnnotations;
|
||||
import org.mockito.invocation.InvocationOnMock;
|
||||
import org.mockito.stubbing.Answer;
|
||||
|
||||
/**
|
||||
* RM V3.5 Create new hold child association to link the record to the hold
|
||||
@@ -81,6 +88,12 @@ public class RMv35HoldNewChildAssocPatchUnitTest
|
||||
@Mock
|
||||
private BehaviourFilter mockBehaviourFilter;
|
||||
|
||||
@Mock
|
||||
private TransactionService mockTransactionService;
|
||||
|
||||
@Mock
|
||||
private RetryingTransactionHelper mockRetryingTransactionHelper;
|
||||
|
||||
@InjectMocks
|
||||
private RMv35HoldNewChildAssocPatch patch;
|
||||
|
||||
@@ -112,25 +125,63 @@ public class RMv35HoldNewChildAssocPatchUnitTest
|
||||
/**
|
||||
* Test secondary associations are created for held items so that they are "contained" in the hold.
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
@Test
|
||||
public void testAddChildDuringUpgrade()
|
||||
{
|
||||
when(mockFilePlanService.getFilePlans()).thenReturn(fileplans);
|
||||
when(mockHoldService.getHolds(filePlanRef)).thenReturn(holds);
|
||||
when(mockNodeService.getChildAssocs(holdRef, ASSOC_FROZEN_CONTENT, RegexQNamePattern.MATCH_ALL)).thenReturn(childAssocs);
|
||||
when(mockNodeService.getChildAssocs(holdRef, ASSOC_FROZEN_CONTENT, RegexQNamePattern.MATCH_ALL, Integer.MAX_VALUE, false))
|
||||
.thenReturn(childAssocs);
|
||||
when(childAssociationRef.getChildRef()).thenReturn(heldItemRef);
|
||||
|
||||
// setup retrying transaction helper
|
||||
Answer<Object> doInTransactionAnswer = new Answer<Object>()
|
||||
{
|
||||
@SuppressWarnings("rawtypes")
|
||||
@Override
|
||||
public Object answer(InvocationOnMock invocation) throws Throwable
|
||||
{
|
||||
RetryingTransactionCallback callback = (RetryingTransactionCallback) invocation.getArguments()[0];
|
||||
// when(childAssociationRef.getChildRef()).thenReturn(heldItemRef);
|
||||
return callback.execute();
|
||||
}
|
||||
};
|
||||
doAnswer(doInTransactionAnswer).when(mockRetryingTransactionHelper)
|
||||
.<Object> doInTransaction(any(RetryingTransactionCallback.class), anyBoolean(), anyBoolean());
|
||||
|
||||
when(mockTransactionService.getRetryingTransactionHelper()).thenReturn(mockRetryingTransactionHelper);
|
||||
|
||||
patch.applyInternal();
|
||||
|
||||
verify(mockNodeService, times(1)).addChild(holdRef, heldItemRef, ASSOC_CONTAINS, PATCH_ASSOC_NAME);
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
@Test
|
||||
public void patchRunWithSuccessWhenNoHeldChildren()
|
||||
{
|
||||
when(mockFilePlanService.getFilePlans()).thenReturn(fileplans);
|
||||
when(mockHoldService.getHolds(filePlanRef)).thenReturn(holds);
|
||||
when(mockNodeService.getChildAssocs(holdRef, ASSOC_FROZEN_CONTENT, RegexQNamePattern.MATCH_ALL)).thenReturn(emptyList());
|
||||
when(mockNodeService.getChildAssocs(holdRef, ASSOC_FROZEN_CONTENT, RegexQNamePattern.MATCH_ALL, Integer.MAX_VALUE, false))
|
||||
.thenReturn(emptyList());
|
||||
|
||||
// setup retrying transaction helper
|
||||
Answer<Object> doInTransactionAnswer = new Answer<Object>()
|
||||
{
|
||||
@SuppressWarnings("rawtypes")
|
||||
@Override
|
||||
public Object answer(InvocationOnMock invocation) throws Throwable
|
||||
{
|
||||
RetryingTransactionCallback callback = (RetryingTransactionCallback) invocation.getArguments()[0];
|
||||
when(childAssociationRef.getChildRef()).thenReturn(heldItemRef);
|
||||
return callback.execute();
|
||||
}
|
||||
};
|
||||
doAnswer(doInTransactionAnswer).when(mockRetryingTransactionHelper)
|
||||
.<Object> doInTransaction(any(RetryingTransactionCallback.class), anyBoolean(), anyBoolean());
|
||||
|
||||
when(mockTransactionService.getRetryingTransactionHelper()).thenReturn(mockRetryingTransactionHelper);
|
||||
|
||||
patch.applyInternal();
|
||||
|
||||
|
@@ -7,7 +7,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-governance-services-community-repo-parent</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<build>
|
||||
|
@@ -7,7 +7,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<modules>
|
||||
|
@@ -8,7 +8,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo-amps</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<properties>
|
||||
|
@@ -7,7 +7,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<dependencies>
|
||||
|
@@ -21,6 +21,7 @@ package org.alfresco.httpclient;
|
||||
import java.io.IOException;
|
||||
import java.util.Map;
|
||||
|
||||
import org.apache.commons.httpclient.Header;
|
||||
import org.apache.commons.httpclient.HostConfiguration;
|
||||
import org.apache.commons.httpclient.HttpClient;
|
||||
import org.apache.commons.httpclient.HttpException;
|
||||
@@ -57,7 +58,12 @@ public class RequestHeadersHttpClient extends HttpClient
|
||||
if (defaultHeaders != null)
|
||||
{
|
||||
defaultHeaders.forEach((k,v) -> {
|
||||
method.addRequestHeader(k, v);
|
||||
Header h = method.getRequestHeader(k);
|
||||
boolean add = h == null || h.getValue() == null || !h.getValue().equals(v);
|
||||
if (add)
|
||||
{
|
||||
method.addRequestHeader(k, v);
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
@@ -7,7 +7,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<properties>
|
||||
@@ -134,7 +134,7 @@
|
||||
<dependency>
|
||||
<groupId>com.fasterxml.woodstox</groupId>
|
||||
<artifactId>woodstox-core</artifactId>
|
||||
<version>6.3.0</version>
|
||||
<version>6.3.1</version>
|
||||
</dependency>
|
||||
|
||||
<!-- the cxf libs were updated, see dependencyManagement section -->
|
||||
|
@@ -346,7 +346,7 @@ public class FTSQueryParser
|
||||
}
|
||||
constraints.add(constraint);
|
||||
}
|
||||
if (constraints.size() == 1 && Occur.EXCLUDE != constraints.get(0).getOccur())
|
||||
if (constraints.size() == 1)
|
||||
{
|
||||
return constraints.get(0);
|
||||
}
|
||||
|
@@ -69,21 +69,20 @@ public class LuceneDisjunction<Q, S, E extends Throwable> extends BaseDisjunctio
|
||||
@SuppressWarnings("unchecked")
|
||||
LuceneQueryBuilderComponent<Q, S, E> luceneQueryBuilderComponent = (LuceneQueryBuilderComponent<Q, S, E>) constraint;
|
||||
Q constraintQuery = luceneQueryBuilderComponent.addComponent(selectors, functionArgs, luceneContext, functionContext);
|
||||
queriestoDisjoin.add(new Pair<Constraint, Q>(constraint, constraintQuery));
|
||||
queriestoDisjoin.add(new Pair<>(constraint, constraintQuery));
|
||||
if (constraintQuery != null)
|
||||
{
|
||||
switch (constraint.getOccur())
|
||||
{
|
||||
case DEFAULT:
|
||||
case MANDATORY:
|
||||
case OPTIONAL:
|
||||
expressionBuilder.addOptional(constraintQuery, constraint.getBoost());
|
||||
break;
|
||||
case MANDATORY:
|
||||
expressionBuilder.addRequired(constraintQuery, constraint.getBoost());
|
||||
break;
|
||||
case EXCLUDE:
|
||||
QueryParserExpressionAdaptor<Q, E> subExpressionBuilder = luceneContext.getLuceneQueryParserAdaptor().getExpressionAdaptor();
|
||||
subExpressionBuilder.addRequired(luceneContext.getLuceneQueryParserAdaptor().getMatchAllNodesQuery());
|
||||
subExpressionBuilder.addExcluded(constraintQuery);
|
||||
expressionBuilder.addOptional(subExpressionBuilder.getQuery(), constraint.getBoost());
|
||||
expressionBuilder.addExcluded(constraintQuery, constraint.getBoost());
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
@@ -7,7 +7,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<dependencies>
|
||||
|
@@ -9,6 +9,6 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo-packaging</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
</project>
|
||||
|
@@ -1,6 +1,6 @@
|
||||
# Fetch image based on Tomcat 9.0, Java 17 and Rocky Linux 8
|
||||
# More infos about this image: https://github.com/Alfresco/alfresco-docker-base-tomcat
|
||||
FROM alfresco/alfresco-base-tomcat:tomcat9-jre17-rockylinux8-202205140719
|
||||
FROM alfresco/alfresco-base-tomcat:tomcat9-jre17-rockylinux8-202209261711
|
||||
|
||||
# Set default docker_context.
|
||||
ARG resource_path=target
|
||||
|
@@ -7,7 +7,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo-packaging</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<properties>
|
||||
|
@@ -7,7 +7,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<modules>
|
||||
|
@@ -6,7 +6,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo-packaging</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<modules>
|
||||
|
12
packaging/tests/scripts/output_logs_for_failures.sh
Executable file
12
packaging/tests/scripts/output_logs_for_failures.sh
Executable file
@@ -0,0 +1,12 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
TAS_DIRECTORY=$1
|
||||
|
||||
cd ${TAS_DIRECTORY}
|
||||
|
||||
failures=$(grep 'status="FAIL"' target/surefire-reports/testng-results.xml | sed 's|^.*[ ]name="\([^"]*\)".*$|\1|g')
|
||||
|
||||
for failure in ${failures}
|
||||
do
|
||||
cat target/reports/alfresco-tas.log | sed '/STARTING Test: \['${failure}'\]/,/ENDING Test: \['${failure}'\]/!d;/ENDING Test: \['${failure}'\]/q'
|
||||
done
|
495
packaging/tests/tas-cmis/README.md
Normal file
495
packaging/tests/tas-cmis/README.md
Normal file
@@ -0,0 +1,495 @@
|
||||

|
||||
|
||||
:paw_prints: Back to [TAS Master Documentation](https://gitlab.alfresco.com/tas/documentation/wikis/home)
|
||||
|
||||
---
|
||||
## Table of Contents
|
||||
* [Synopsis](#synopsis)
|
||||
* [Prerequisite](#prerequisite)
|
||||
* [Installation](#installation-if-you-want-to-contribute)
|
||||
* [Package Presentation](#package-presentation)
|
||||
* [Sample Usage](#sample-usage)
|
||||
* [How to write a test](#how-to-write-a-test)
|
||||
* [How to run tests?](#how-to-run-tests)
|
||||
* [from IDE](#from-ide)
|
||||
* [from command line](#from-command-line)
|
||||
* [Perform CMIS Queries](#perform-cmis-queries)
|
||||
* [Listeners](#listeners)
|
||||
* [Test Results](#test-results)
|
||||
* [Test Rail Integration](#test-rail-integration)
|
||||
* [Configuration](#configuration)
|
||||
* [How to enable Test Rail Integration?](#how-to-enable-test-rail-integration)
|
||||
* [Change Log](docs/CHANGELOG.md) :glowing_star:
|
||||
* [Reference](#reference)
|
||||
* [Releasing](#releasing)
|
||||
* [Contributors](#contributors)
|
||||
* [License](#license)
|
||||
|
||||
## Synopsis
|
||||
|
||||
**TAS**( **T**est **A**utomation **S**ystem)- **CMIS** is the project that handles the automated tests related only to CMIS API integrated with Alfresco One [Alfresco CMIS API](http://docs.alfresco.com/5.1/pra/1/topics/cmis-welcome.html).
|
||||
|
||||
It is based on Apache Maven, compatible with major IDEs and is using also Spring capabilities for dependency injection.
|
||||
|
||||
As a high level overview, this project makes use of the following functionality useful in automation testing as:
|
||||
* reading/defining test environment settings (e.g. alfresco server details, authentication, etc.)
|
||||
* managing resource (i.e. creating files and folders)
|
||||
* test data generators (for site, users, content, etc)
|
||||
* helpers (i.e. randomizers, test environment information)
|
||||
* test logging generated on runtime and test reporting capabilities
|
||||
* test management tool integration (at this point we support integration with [Test Rail](https://alfresco.testrail.net) (v5.2.1)
|
||||
* health checks (verify if server is reachable, if server is online)
|
||||
* generic Internal-DSL (Domain Specific Language)
|
||||
|
||||
Using Nexus -Release Repository, everyone will be able to use individual interfaces in their projects by extending the automation core functionalities.
|
||||
|
||||
**[Back to Top ^](#table-of-contents)**
|
||||
|
||||
## Prerequisite
|
||||
(tested on unix/non-unix distribution)
|
||||
* [Java SE 1.8](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
|
||||
* [Maven 3.3](https://maven.apache.org/download.cgi) installed and configure according to [Windows OS](https://maven.apache.org/guides/getting-started/windows-prerequisites.html) or [Mac OS](https://maven.apache.org/install.html).
|
||||
* Configure Maven to use Alfresco alfresco-internal repository following this [Guide](https://ts.alfresco.com/share/page/site/eng/wiki-page?title=Maven_Setup).
|
||||
* Your favorite IDE as [Eclipse](https://eclipse.org/downloads/) or [IntelliJ](https://www.jetbrains.com/idea).
|
||||
* Access to [Nexus](https://nexus.alfresco.com/nexus/) repository.
|
||||
* Access to GitLab [TAS](https://gitlab.alfresco.com/tas/) repository.
|
||||
* GitLab client for your operating system. (we recommend [SourceTree](https://www.sourcetreeapp.com) - use your google account for initial setup).
|
||||
* Getting familiar with [Basic Git Commands](http://docs.gitlab.com/ee/gitlab-basics/basic-git-commands.html).
|
||||
* Getting familiar with [Maven](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html).
|
||||
* Getting familiar with [Spring](http://docs.spring.io).
|
||||
* Getting familiar with [TestNG](http://testng.org/doc/index.html)
|
||||
|
||||
**[Back to Top ^](#table-of-contents)**
|
||||
|
||||
## Installation (if you want to contribute)
|
||||
|
||||
* Open your GitLab client and clone the repository of this project.
|
||||
* You can do this also from command line (or in your terminal) adding:
|
||||
|
||||
```bash
|
||||
$ git clone https://gitlab.alfresco.com/tas/alfresco-tas-cmis-test.git
|
||||
# this clone will have the latest changes from repository. If you want to checkout a specific version released, take a look at the [Change Log](docs/CHANGELOG.md) page
|
||||
$ cd alfresco-tas-cmis-test
|
||||
# this command will checkout the remove v1.0.0 tagged repository and create locally a new branch v1.0.0
|
||||
$ git checkout tags/v1.0.0 -b v1.0.0
|
||||
```
|
||||
|
||||
* Install and check if all dependencies are downloaded
|
||||
|
||||
```bash
|
||||
$ mvn clean install -DskipTests
|
||||
# you should see one [INFO] BUILD SUCCESS message displayed
|
||||
```
|
||||
**[Back to Top ^](#table-of-contents)**
|
||||
|
||||
## Package Presentation
|
||||
|
||||
The project uses a maven layout [archetype](https://maven.apache.org/plugins-archives/maven-archetype-plugin-1.0-alpha-7/examples/simple.html):
|
||||
```ruby
|
||||
├── pom.xml
|
||||
├── src
|
||||
│ ├── main
|
||||
│ │ └── java
|
||||
│ │ └── org
|
||||
│ │ └── alfresco
|
||||
│ │ └── cmis
|
||||
│ │ ├── (...)
|
||||
│ │ ├── CmisProperties.java #handles all properties from default.properties
|
||||
│ │ ├── CmisWrapper.java #wrapper around CMIS API
|
||||
│ │ └── exception
|
||||
│ │ └── (...)
|
||||
│ ├── test
|
||||
│ │ ├── java
|
||||
│ │ │ └── org
|
||||
│ │ │ └── alfresco
|
||||
│ │ │ └── cmis
|
||||
│ │ │ ├── CmisDemoTests.java #demo example
|
||||
│ │ │ └── CmisTest.java #abstract base class that should be inherited by all tests
|
||||
│ │ └── resources
|
||||
│ │ ├── alfresco-cmis-context.xml #spring configuration
|
||||
│ │ ├── default.properties #all settings related to environment, protocol
|
||||
│ │ ├── log4j.properties
|
||||
│ │ └── sanity-cmis.xml # default suite of tests
|
||||
```
|
||||
|
||||
**[Back to Top ^](#table-of-contents)**
|
||||
|
||||
## Sample Usage
|
||||
|
||||
Following the standard layout for Maven projects, the application sources locate in src/main/java and test sources locate in src/test/java.
|
||||
Application sources consist in defining the CMIS object that simulates the API calls.
|
||||
The tests are based on an abstract object: CmisTest.java that handles the common behavior: checking the health status of the test server, configuration settings, getting the general properties, etc.
|
||||
|
||||
Please take a look at [CmisDemoTests.java](src/test/java/org/alfresco/cmis/CmisDemoTests.java) class for an example.
|
||||
|
||||
Common configuration settings required for this project are stored in properties file, see [default.properties](src/test/resources/default.properties).
|
||||
Please analyze and update it accordingly with Alfresco test server IP, port, credentials, etc.
|
||||
|
||||
Example:
|
||||
```java
|
||||
# Alfresco HTTP Server Settings
|
||||
alfresco.scheme=http
|
||||
alfresco.server=<add-here-the-ip-of-your-test-server>
|
||||
alfresco.port=<default-port-for-alfresco-not-share>
|
||||
```
|
||||
|
||||
* optional update the logging level in [log4j](src/test/resources/log4j.properties) file (you can increase/decrease the deails of the [logging file](https://logging.apache.org/log4j/1.2/manual.html), setting the ```log4j.rootLogger=DEBUG``` if you want.)
|
||||
* go to [running](#how-to-run-tests) section for more information on how to run this tests.
|
||||
|
||||
**[Back to Top ^](#table-of-contents)**
|
||||
|
||||
### How to write a test
|
||||
|
||||
* Tests are organized in java classes and located on src/test/java as per maven layout.
|
||||
* One test class should contain the tests that cover one functionality as we want to have a clear separation of test scope: tests for sanity/core/full, tests that verify manage of folder/files etc.
|
||||
* These are the conventions that need to follow when you write a test:
|
||||
* The test class has @Test annotation with the group defined: protocols, cmis. You can add more groups like sanity, regression
|
||||
|
||||
```java
|
||||
@Test(groups={ "sanity"}
|
||||
```
|
||||
|
||||
* The test has @TestRail annotation in order to assure that the details and results will be submitted on TestRail. The fields for TestRail annotation will be explained on next chapter.
|
||||
|
||||
|
||||
```java
|
||||
@TestRail(section = { "cmis-api" }, executionType=ExecutionType.SANITY,
|
||||
description = "Verify admin user creates folder in DocumentLibrary with CMIS")
|
||||
public void adminShouldCreateFolderInSite() throws Exception
|
||||
{ cmisApi.usingSite(testSite).createFolder(testFolder).assertExistsInRepo(); }
|
||||
|
||||
```
|
||||
|
||||
* Use Spring capabilities to initialize the objects(Models, Wrappers) with @Autowired
|
||||
* We followed Builder pattern to develop specific DSL for simple and clear usage of protocol client in test:
|
||||
|
||||
```java
|
||||
cmisApi.usingSite(testSite) .createFolder(testFolder) .assertExistsInRepo();
|
||||
```
|
||||
* To view a simple class that is using this utility, just browse on [CmisDemoTests.java](src/test/java/org/alfresco/cmis/CmisDemoTests.java)
|
||||
Notice the class definition and inheritance value:
|
||||
|
||||
```java
|
||||
public class CmisDemoTests extends CmisTest
|
||||
```
|
||||
|
||||
* as a convention, before running your test, check if the test environment is reachable and your alfresco test server is online.
|
||||
(this will stop the test if the server defined in your property file is not healthy - method available in parent class)
|
||||
|
||||
```java
|
||||
@BeforeClass(alwaysRun = true)
|
||||
public void setupCmisTest() throws Exception {
|
||||
serverHealth.assertServerIsOnline();
|
||||
}
|
||||
```
|
||||
* the test name are self explanatory:
|
||||
|
||||
```java
|
||||
@TestRail(section = { "cmis-api" }, executionType=ExecutionType.SANITY, description = "Verify admin user creates folder in DocumentLibrary with CMIS")
|
||||
public void adminShouldCreateFolderInSite() throws Exception
|
||||
{
|
||||
cmisApi.usingSite(testSite)
|
||||
.createFolder(testFolder)
|
||||
.assertExistsInRepo();
|
||||
}
|
||||
```
|
||||
|
||||
```java
|
||||
@TestRail(section = { "cmis-api" }, executionType=ExecutionType.SANITY, description = "Verify admin user creates and renames folder in DocumentLibrary with CMIS")
|
||||
public void adminShouldRenameFolderInSite() throws Exception
|
||||
{
|
||||
cmisApi.usingSite(testSite).createFolder(testFolder)
|
||||
.and().rename("renamed")
|
||||
.assertExistsInRepo();
|
||||
}
|
||||
```
|
||||
|
||||
**[Back to Top ^](#table-of-contents)**
|
||||
|
||||
### How to run tests
|
||||
|
||||
#### from IDE
|
||||
|
||||
* The project can be imported into a development environment tool (Eclipse or IntelliJ). You have the possibility to execute tests or suite of tests using [TestNG plugin](http://testng.org/doc/eclipse.html) previously installed in IDE.
|
||||
From Eclipse, just right click on the testNG class (something similar to [CmisDemoTests.java](src/test/java/org/alfresco/cmis/CmisDemoTests.java)), select Run As - TestNG Test
|
||||
You should see your test passed.
|
||||
|
||||
* In case you are using the default settings that points to localhost (127.0.0.1) and you don't have Alfresco installed on your machine, you will see one exception thrown (as expected):
|
||||
```java
|
||||
org.alfresco.utility.exception.ServerUnreachableException: Server {127.0.0.1} is unreachable.
|
||||
```
|
||||
|
||||
#### from command line
|
||||
|
||||
* In terminal or CMD, navigate (with CD) to root folder of your project (you can use the sample project):
|
||||
|
||||
|
||||
|
||||
The tests can be executed on command line/terminal using Maven command
|
||||
|
||||
```bash
|
||||
mvn test
|
||||
```
|
||||
|
||||
This command with trigger the tests specified in the default testNG suite from POM file: <suiteXmlFile>src/main/resources/shared-resources/cmis-suites.xml</suiteXmlFile>
|
||||
|
||||
You can use -Dtest parameter to run the test/suites through command line (http://maven.apache.org/surefire/maven-surefire-plugin/examples/single-test.html).
|
||||
|
||||
You can also specify a different suiteXMLFile like:
|
||||
|
||||
```bash
|
||||
mvn test -DsuiteXmlFile=src/resources/your-custom-suite.xml
|
||||
```
|
||||
|
||||
Or even a single test:
|
||||
|
||||
```bash
|
||||
mvn test -Dtest=org.alfresco.cmis.CmisDemoTests
|
||||
```
|
||||
But pay attention that you will not have enabled all the [listeners](#listeners) in this case (the Reporting listener or TestRail integration one)
|
||||
|
||||
### Perform CMIS Queries
|
||||
(:glowing_star: please notice that at this point we assert only the results count returned by the query: we plan to extend the functionality to assert on QueryResult iterable objects also: simple modification on [QueryExecutor.java](src/main/java/org/alfresco/cmis/dsl/QueryExecutor.java)
|
||||
|
||||
There are a couple of ways to test the results count after performing CMIS queries, choose the one that you like the most:
|
||||
|
||||
a) direct queries using a simple TestNG test:
|
||||
|
||||
(see example [here](src/test/java/org/alfresco/cmis/search/SorlSearchSimpleQueryTests.java))
|
||||
```java
|
||||
public class SorlSearchSimpleQueryTests extends CmisTest
|
||||
{
|
||||
@Test
|
||||
public void simpleQueryOnFolderDesc() throws Exception
|
||||
{
|
||||
// create here multiple folder as data preparation
|
||||
cmisApi.authenticateUser(dataUser.getAdminUser())
|
||||
.withQuery("SELECT * FROM cmis:folder ORDER BY cmis:createdBy DESC").assertResultsCount().isLowerThan(101);
|
||||
}
|
||||
}
|
||||
```
|
||||
- just extend CmisTest
|
||||
- authenticate with your UserModel and perform the query. The DSL will allow you to assert the result count if is equal, lower or greater than to a particular value. You can update the methods in [QueryResultAssertion](src/main/java/org/alfresco/cmis/dsl/QueryExecutor.java) class.
|
||||
|
||||
b) define one set of test data (folders, files, etc. ) that you will search in all tests then execute all CMIS queris from one common XML file
|
||||
- see test class [SolrSearchInFolderTests](src/test/java/org/alfresco/cmis/search/SolrSearchInFolderTests.java)
|
||||
- see [XML test data](src/main/resources/shared-resources/testdata/search-in-folder.xml) used in [SolrSearchInFolderTests](src/test/java/org/alfresco/cmis/search/SolrSearchInFolderTests.java) into one DataProvider. Notice that XML file has two parameter: the query that will be executed and the expected result count returned.
|
||||
|
||||
c) define test data (user, sites, folder, files, aspects, comments, custom models, etc) all into one XML file with all cmis queries related.
|
||||
- see example on [SolrSearchByIdTests](https://gitlab.alfresco.com/tas/alfresco-tas-cmis-test/blob/master/src/test/java/org/alfresco/cmis/search/SolrSearchByIdTests.java)
|
||||
- notice the 'NODE_REF[x]'; 'NODE_REF[y]' keywords that will dynamically take the test data identified by id: x, y (you will figure it out based on examples).
|
||||
|
||||
**Info**: all search test queries are found [org.alfresco.cmis.search](src/test/java/org/alfresco/cmis/search) package.
|
||||
|
||||
**[Back to Top ^](#table-of-contents)**
|
||||
|
||||
## Listeners
|
||||
|
||||
With the help of Listeners we can modify the behaviour of TestNG framework. There are a lot of testNG listener interfaces that we can override in order to provide new functionalities.
|
||||
The tas framework provides out of the box a couple of listeners that you could use. These could be enabled and added at the class level or suite level.
|
||||
|
||||
### a) org.alfresco.utility.report.ReportListenerAdapter
|
||||
|
||||
* if added at the class level:
|
||||
|
||||
```java
|
||||
@Listeners(value=ReportListenerAdapter.class)
|
||||
public class MyTestClass extends CmisTest
|
||||
{
|
||||
(...)
|
||||
}
|
||||
```
|
||||
|
||||
* or suite xml level
|
||||
|
||||
```java
|
||||
<suite name="Your Suite test" parallel="classes">
|
||||
<listeners>
|
||||
<listener class-name="org.alfresco.utility.report.ReportListenerAdapter"></listener>
|
||||
</listeners>
|
||||
(...)
|
||||
</suite>
|
||||
```
|
||||
It will automatically generate one html named "report.html" in ./target/report folder.
|
||||
Please also take a look at [Test Results](#test-results) section.
|
||||
|
||||
### b) org.alfresco.utility.testrail.TestRailExecutorListener
|
||||
It will automatically update Test Rail application with the test cases that you've automated.
|
||||
Please take a look at [Test Rail Integration](#test-rail-integration) section for more details.
|
||||
|
||||
### c) org.alfresco.utility.report.log.LogsListener
|
||||
This is a new listener that will generate further details in one XML format of the automated test steps that you will write.
|
||||
|
||||
Example:
|
||||
|
||||
```java
|
||||
public void myDSLMethod1()
|
||||
{
|
||||
STEP("Lorem ipsum dolor sit amet");
|
||||
//code for first step
|
||||
|
||||
STEP("consectetur adipiscing elit");
|
||||
//code for the next description
|
||||
}
|
||||
|
||||
public void myDSLMethod2()
|
||||
{
|
||||
STEP("sed do eiusmod tempor incididunt ut labore");
|
||||
//code for first step
|
||||
|
||||
STEP("et dolore magna aliqua");
|
||||
//code for the next description
|
||||
}
|
||||
```
|
||||
|
||||
If these methods will be executed insite a test method, all those steps will be automatically logged in the XML report generated.
|
||||
Example:
|
||||
|
||||
```java
|
||||
@Test
|
||||
public void adminShouldCreateFileInSite()
|
||||
{
|
||||
myDSLMethod1();
|
||||
myDSLMethod2()
|
||||
}
|
||||
```
|
||||
|
||||
So if "testingSomething" will be executed this is what you will see on the XML file generated. (please take a look at [Test Results](#test-results) section for defining the defaul location)
|
||||
|
||||
Here is one example of XML file generated with these steps:
|
||||
|
||||

|
||||
|
||||
**[Back to Top ^](#table-of-contents)**
|
||||
|
||||
## Test Results
|
||||
We already executed a couple of tests using command line as indicated above. Sweet! Please take a look at [sanity-cmis.xml](src/test/resources/sanity-cmis.xml) one more time.
|
||||
You will see there that we have one listener added:
|
||||
|
||||
```java
|
||||
<listener class-name="org.alfresco.utility.report.ReportListenerAdapter"></listener>
|
||||
```
|
||||
This will tell our framework, after we run all tests, to generate one HTML report file with graphs and metrics.
|
||||
|
||||
Take a look at the target/reports folder (created after running the tests) and open the report.html file.
|
||||
|
||||

|
||||
|
||||
Playing with this report, you will notice that you will be able to:
|
||||
* search tests cases by name
|
||||
* filter test cases by errors, labels, groups, test types, date when it was executed, protocol used, etc.
|
||||
* view overall pass/fail metrics of current test suite, history of tests execution, etc.
|
||||
|
||||
The report path can be configured in default.properties):
|
||||
|
||||
```
|
||||
# The location of the reports path
|
||||
reports.path=your-new-location-of-reports
|
||||
```
|
||||
|
||||
**[Back to Top ^](#table-of-contents)**
|
||||
|
||||
## Test Rail Integration
|
||||
|
||||
Alfresco is using now https://alfresco.testrail.net (v5.3.0.3601).
|
||||
|
||||
We aim to accelerate the delivery of automated test by minimizing the interaction with the test management tool - TestRail. In this scope we developed the following capabilities:
|
||||
* creating automatically the manual tests in TestRail
|
||||
* submitting the test results (with stack trace) after each execution into TestRail Test Runs
|
||||
* adding the test steps for each test.
|
||||
|
||||
### Configuration
|
||||
In order to use Test Rail Integration you will need to add a couple of information in [default.properties](src/test/resources/default.properties) file:
|
||||
(the document is pretty self explanatory)
|
||||
|
||||
```java
|
||||
# Example of configuration:
|
||||
# ------------------------------------------------------
|
||||
# testManagement.endPoint=https://alfresco.testrail.com/
|
||||
# testManagement.username=<yourusername-that-you-connect-to-testrail>
|
||||
# testManagement.apiKey=<api-key>
|
||||
# testManagement.project=<id-of-your-project
|
||||
# testManagement.testRun=<test-run-name>
|
||||
```
|
||||
!This settings are already defined in default.properties for you.
|
||||
|
||||
|
||||
For generating a new API Key take a look at the official documentation, TestRail [APIv2](http://docs.gurock.com/testrail-api2)
|
||||
* _testManagement.project= **<id-of-your-project**_ this is the ID of the project where you want to store your test cases.
|
||||
If you want to use [Alfresco ONE](https://alfresco.testrail.net/index.php?/projects/overview/1) project in TestRail, open that project and notice the URL, after "/overview/**1**" link you will see the ID of the project (1 in this case)
|
||||
If you want to use [TAS Project](https://alfresco.testrail.net/index.php?/projects/overview/7) you will notice the ID 7, so _"testManagement.project=7"_
|
||||
* "_testManagement.testRun=<test-run-name>_" this represents the name of the Test Run from your project.
|
||||
* In Test Rail, navigating to Test Runs & Results, create a new Test Run and include all/particular test cases. If this test run name is "Automation", update _testManagement.testRun= **Automation**_.
|
||||
All test results will be updated only on this test run at runtime as each test is executed by TAS framework.
|
||||
|
||||
### How to enable Test Rail Integration?
|
||||
|
||||
We wanted to simplify the Test Rail integration, so we used listeners in order to enable/disable the integration of Test Rail.
|
||||
* first configure your default.properties as indicated above
|
||||
|
||||
* now on your TestNG test, add the @TestRail annotation, so let's say you will have this test:
|
||||
|
||||
```java
|
||||
@Test(groups="sample-tests")
|
||||
public void thisAutomatedTestWillBePublishedInTestRail()
|
||||
{
|
||||
}
|
||||
```
|
||||
add now @TestRail integration with mandatory field ```section```. This means that this tests annotated, will be uploaded in TestRail:
|
||||
|
||||
```java
|
||||
@Test(groups="sample-tests")
|
||||
@TestRail(section = { "protocols", "TBD" })
|
||||
public void thisAutomatedTestWillBePublishedInTestRail()
|
||||
{
|
||||
}
|
||||
```
|
||||
The section field, represents an array of strings, the hierarchy of sections that SHOULD be found on TestRail under the project you've selected in default.properties. Follow the TestRail [user-guide](http://docs.gurock.com/testrail-userguide/start) for more information regarding sections.
|
||||
In our example we created in Test Rail one root section "protocols" with a child section: "TBD" (you can go further and add multiple section as you wish)
|
||||
|
||||
* now, lets add the listener, the TestRailExecutorListener that will handle this TC Management interaction.
|
||||
This listener can be added at the class level or suite level (approach that we embrace)
|
||||
Take a look at [sanity-cmis.xml](src/test/resources/sanity-cmis.xml) for further example.
|
||||
|
||||
```xml
|
||||
<listeners>
|
||||
<listener class-name="org.alfresco.utility.testrail.TestRailExecutorListener"></listener>
|
||||
(...)
|
||||
</listeners>
|
||||
```
|
||||
|
||||
Right click on cmis-suites.xml file and run it, or just "mvn test" from root if this sample project.
|
||||
After everything passes, go in Test Rail, open your project and navigate to "Test Cases" section. Notice that under protocols/TBD section, you will see your test case published.
|
||||
|
||||
If you defined also the "testManagement.testRun" correctly, you will see under Test Runs, the status of this case marked as passed.
|
||||
|
||||
The @TestRail annotation offers also other options like:
|
||||
- "description" this is the description that will be updated in Test Rail for your test case
|
||||
- "testType", the default value is set to Functional test
|
||||
- "executionType", default value is set to ExecutionType.REGRESSION, but you can also use ExecutionType.SMOKE, ExecutionType.SANITY, etc
|
||||
|
||||
Take a look at the demo scenarios in this project for further examples.
|
||||
|
||||
**[Back to Top ^](#table-of-contents)**
|
||||
|
||||
## Reference
|
||||
|
||||
* For any improvements, bugs, please use Jira - [TAS](https://issues.alfresco.com/jira/browse/TAS) project.
|
||||
* Setup the environment using [docker](https://gitlab.alfresco.com/tas/alfresco-docker-provisioning/blob/master/Readme.md).
|
||||
* [Bamboo Test Plan](https://bamboo.alfresco.com/bamboo/browse/TAS-CMIS)
|
||||
|
||||
## Contributors
|
||||
|
||||
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other... [more](CODE_OF_CONDUCT.md)
|
||||
|
||||
## Releasing
|
||||
|
||||
Any commit done on this project should be automatically executed by [TAS Build Plan](https://bamboo.alfresco.com/bamboo/browse/TAS-TAS)
|
||||
If the build passes, then you didn't broke anything.
|
||||
|
||||
If you want to perform a release, open [TAS-CMIS](https://bamboo.alfresco.com/bamboo/browse/TAS-CMIS) Bamboo Build.
|
||||
Run the Default stage and if it passes, then manually perform the Release stage (this will auto-increment the version in pom.xml)
|
||||
|
||||
## License
|
||||
|
||||
TBD
|
20
packaging/tests/tas-cmis/docs/CHANGELOG.md
Normal file
20
packaging/tests/tas-cmis/docs/CHANGELOG.md
Normal file
@@ -0,0 +1,20 @@
|
||||
:paw_prints: Back to Utility [README](README.md).
|
||||
|
||||
---
|
||||
# Change Log
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
Each tag bellow has a corresponded version released in [Nexus](https://nexus.alfresco.com/nexus/#welcome).
|
||||
Currently we are testing [CMIS v1.1](http://docs.oasis-open.org/cmis/CMIS/v1.1/CMIS-v1.1.html) with Alfresco One.
|
||||
|
||||
(if you need to update/polish tests please branch from the release tags)
|
||||
|
||||
## [[v5.2.0-1] - 2016-12-12](/tas/alfresco-tas-cmis-test/commits/v5.2.0-1)
|
||||
### TBD
|
||||
|
||||
## [[v5.2.0-0] - 2016-12-12](/tas/alfresco-tas-cmis-test/commits/v5.2.0-0)
|
||||
- works with 5.2 alfresco
|
||||
- 100% Core tests for CMIS
|
||||
- 100% Sanity test for CMIS
|
||||
- use released v1.0.7 utility
|
||||
|
BIN
packaging/tests/tas-cmis/docs/pics/html-report-sample.JPG
Normal file
BIN
packaging/tests/tas-cmis/docs/pics/html-report-sample.JPG
Normal file
Binary file not shown.
After Width: | Height: | Size: 56 KiB |
BIN
packaging/tests/tas-cmis/docs/pics/html-report-sample.png
Normal file
BIN
packaging/tests/tas-cmis/docs/pics/html-report-sample.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 116 KiB |
BIN
packaging/tests/tas-cmis/docs/pics/xml-steps-report.JPG
Normal file
BIN
packaging/tests/tas-cmis/docs/pics/xml-steps-report.JPG
Normal file
Binary file not shown.
After Width: | Height: | Size: 45 KiB |
@@ -1,27 +1,27 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<?xml version="1.0"?>
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<groupId>org.alfresco.tas</groupId>
|
||||
<artifactId>alfresco-community-repo-cmis-test</artifactId>
|
||||
<name>cmis test</name>
|
||||
<packaging>jar</packaging>
|
||||
|
||||
<artifactId>cmis</artifactId>
|
||||
<name>alfresco-tas-cmis</name>
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo-tests</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<developers>
|
||||
<developer>
|
||||
<name>Paul Brodner</name>
|
||||
<roles>
|
||||
<role>Test Automation Architect</role>
|
||||
</roles>
|
||||
</developer>
|
||||
</developers>
|
||||
<organization>
|
||||
<name>Alfresco Software</name>
|
||||
<url>http://www.alfresco.com/</url>
|
||||
</organization>
|
||||
|
||||
<properties>
|
||||
<maven.build.sourceVersion>11</maven.build.sourceVersion>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<chemistry-opencmis-commons-api>1.1.0</chemistry-opencmis-commons-api>
|
||||
<maven-jar-plugin.version>3.1.1</maven-jar-plugin.version>
|
||||
<maven-release.version>2.5.3</maven-release.version>
|
||||
<java.version>11</java.version>
|
||||
<suiteXmlFile>${project.basedir}/src/test/resources/cmis-suite.xml</suiteXmlFile>
|
||||
<cmis.binding />
|
||||
<cmis.basePath />
|
||||
@@ -58,10 +58,29 @@
|
||||
</profiles>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.jboss.resteasy</groupId>
|
||||
<artifactId>resteasy-jackson2-provider</artifactId>
|
||||
<version>4.7.1.Final</version>
|
||||
</dependency>
|
||||
|
||||
<!-- alfresco tester settings -->
|
||||
<dependency>
|
||||
<groupId>org.alfresco.tas</groupId>
|
||||
<artifactId>cmis</artifactId>
|
||||
<scope>test</scope>
|
||||
<artifactId>utility</artifactId>
|
||||
<exclusions>
|
||||
<exclusion>
|
||||
<groupId>mysql</groupId>
|
||||
<artifactId>mysql-connector-java</artifactId>
|
||||
</exclusion>
|
||||
</exclusions>
|
||||
</dependency>
|
||||
|
||||
<!-- open cmis settings -->
|
||||
<dependency>
|
||||
<groupId>org.apache.chemistry.opencmis</groupId>
|
||||
<artifactId>chemistry-opencmis-commons-api</artifactId>
|
||||
<version>${chemistry-opencmis-commons-api}</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
|
@@ -0,0 +1,130 @@
|
||||
package org.alfresco.cmis;
|
||||
|
||||
import org.alfresco.utility.data.AisToken;
|
||||
import org.alfresco.utility.data.auth.DataAIS;
|
||||
import org.alfresco.utility.model.UserModel;
|
||||
import org.apache.chemistry.opencmis.commons.SessionParameter;
|
||||
import org.keycloak.authorization.client.util.HttpResponseException;
|
||||
import org.keycloak.representations.AccessTokenResponse;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Service;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import java.util.function.Function;
|
||||
|
||||
import static org.alfresco.utility.report.log.Step.STEP;
|
||||
|
||||
@Service
|
||||
public class AuthParameterProviderFactory
|
||||
{
|
||||
public static String STEP_PREFIX = "CMIS AuthParameterProvider:";
|
||||
|
||||
@Autowired
|
||||
private DataAIS dataAIS;
|
||||
|
||||
@Autowired
|
||||
private CmisProperties cmisProperties;
|
||||
|
||||
/**
|
||||
*
|
||||
* The default provider uses AIS if support for Alfresco Identity Service is enabled.
|
||||
* Otherwise a provider which uses Basic authentication is returned.
|
||||
*
|
||||
* @return Function which takes a {@link UserModel} and returns a map of
|
||||
* authentication parameters to be used with {@link CmisWrapper#authenticateUser(UserModel, Function)}
|
||||
*/
|
||||
public Function<UserModel, Map<String, String>> getDefaultProvider()
|
||||
{
|
||||
if (dataAIS.isEnabled())
|
||||
{
|
||||
STEP(String.format("%s Retrieved default AIS auth parameter provider.", STEP_PREFIX));
|
||||
return new AisAuthParameterProvider();
|
||||
}
|
||||
else
|
||||
{
|
||||
STEP(String.format("%s Retrieved default Basic auth parameter provider.", STEP_PREFIX));
|
||||
return new BasicAuthParameterProvider();
|
||||
}
|
||||
}
|
||||
|
||||
public Function<UserModel, Map<String, String>> getAISProvider()
|
||||
{
|
||||
return new AisAuthParameterProvider();
|
||||
}
|
||||
|
||||
public Function<UserModel, Map<String, String>> getBasicProvider()
|
||||
{
|
||||
return new BasicAuthParameterProvider();
|
||||
}
|
||||
|
||||
private class BasicAuthParameterProvider implements Function<UserModel, Map<String, String>>
|
||||
{
|
||||
@Override
|
||||
public Map<String, String> apply(UserModel userModel)
|
||||
{
|
||||
STEP(String.format("%s Using Basic auth parameter provider.", STEP_PREFIX));
|
||||
Map<String, String> parameters = new HashMap<>();
|
||||
parameters.put(SessionParameter.USER, userModel.getUsername());
|
||||
parameters.put(SessionParameter.PASSWORD, userModel.getPassword());
|
||||
return parameters;
|
||||
}
|
||||
}
|
||||
|
||||
private class AisAuthParameterProvider implements Function<UserModel, Map<String, String>>
|
||||
{
|
||||
@Override
|
||||
public Map<String, String> apply(UserModel userModel)
|
||||
{
|
||||
Map<String, String> parameters = new HashMap<>();
|
||||
|
||||
STEP(String.format("%s Using AIS auth parameter provider.", STEP_PREFIX));
|
||||
AisToken aisToken = getAisAccessToken(userModel);
|
||||
|
||||
parameters.put(SessionParameter.AUTHENTICATION_PROVIDER_CLASS, "org.apache.chemistry.opencmis.client.bindings.spi.OAuthAuthenticationProvider");
|
||||
parameters.put(SessionParameter.OAUTH_ACCESS_TOKEN, aisToken.getToken());
|
||||
parameters.put(SessionParameter.OAUTH_REFRESH_TOKEN, aisToken.getRefreshToken());
|
||||
parameters.put(SessionParameter.OAUTH_EXPIRATION_TIMESTAMP, String.valueOf(System.currentTimeMillis()
|
||||
+ (aisToken.getExpiresIn() * 1000))); // getExpiresIn is in seconds
|
||||
parameters.put(SessionParameter.OAUTH_TOKEN_ENDPOINT, cmisProperties.aisProperty().getAdapterConfig().getAuthServerUrl()
|
||||
+ "/realms/alfresco/protocol/openid-connect/token");
|
||||
parameters.put(SessionParameter.OAUTH_CLIENT_ID, cmisProperties.aisProperty().getAdapterConfig().getResource());
|
||||
return parameters;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a valid access token for valid user credentials in userModel.
|
||||
* An invalid access token is returned for invalid user credentials,
|
||||
* which can be used for tests involving non existing or unauthorized users.
|
||||
* @param userModel
|
||||
* @return
|
||||
*/
|
||||
private AisToken getAisAccessToken(UserModel userModel)
|
||||
{
|
||||
String badToken = "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJUazFPZ2JqVlo1UEw2bmtsNWFvTUlacTZ4cW9PZzc5WGtzdnJTTUcxLUFZIn0.eyJqdGkiOiI3NTVkMGZiOS03NzI5LTQ1NzYtYWM4Ny1hZWZjZWNiZDE0ZGEiLCJleHAiOjE1NTM2MjQ1NDgsIm5iZiI6MCwiaWF0IjoxNTUzNjI0MjQ4LCJpc3MiOiJodHRwOi8vbG9jYWxob3N0L2F1dGgvcmVhbG1zL2FsZnJlc2NvIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6Ijk4NDE0Njg4LTUwMDUtNDVmOS05YTVjLTlkMDRlODMyYTNkMiIsInR5cCI6IkJlYXJlciIsImF6cCI6ImFsZnJlc2NvIiwiYXV0aF90aW1lIjowLCJzZXNzaW9uX3N0YXRlIjoiNjJlN2U5YzktZmFlNS00N2RhLTk5MDItMTZjYTJhZWUwMWMwIiwiYWNyIjoiMSIsImFsbG93ZWQtb3JpZ2lucyI6WyJodHRwOi8vbG9jYWxob3N0KiIsImh0dHBzOi8vbG9jYWxob3N0KiJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoicHJvZmlsZSBlbWFpbCIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwicHJlZmVycmVkX3VzZXJuYW1lIjoidXNlci12eGlrcXd3cG5jYmpzeHgifQ.PeLGCNCzj-P2m0knwUU9Vfx4dzLLQER9IdV7GyLel9LRN-3J9nh7GBDRQsyDJ0pqhObQyMg4V3wSsrsXRQ6gKhmUyDemmD-w1YMC2a2HKX6GlxsTEF_f1K_R15lIQOawNVErlWjZWORJGCvCYZOJ99SOmeOC6PGY79zLL94MMnf6dXcegePPMOKG-59eNjBkOylTipYebvM40nbbKrS5vzNHQlvUh4ALFeBoMSKGnLSjQd06Dj4SWojG0p1BrxurqDjW0zz6pQlEAm4vcWApRZ6qBLZcMH8adYix07zCDb87GOn1pmfEBWpwd3BEgC_LLu06guaCPHC9tpeIaDTHLg";
|
||||
String badRefreshToken = "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJmM2YyMjhjYS1jMzg5LTQ5MGUtOGU1Zi02YWI1MmJhZDVjZGEifQ.eyJqdGkiOiIyNmExZWNhYy00Zjk0LTQwYzctYjJjNS04NTlhZmQ3NjBiYWMiLCJleHAiOjE1NTM2MjYwNDgsIm5iZiI6MCwiaWF0IjoxNTUzNjI0MjQ4LCJpc3MiOiJodHRwOi8vbG9jYWxob3N0L2F1dGgvcmVhbG1zL2FsZnJlc2NvIiwiYXVkIjoiaHR0cDovL2xvY2FsaG9zdC9hdXRoL3JlYWxtcy9hbGZyZXNjbyIsInN1YiI6Ijk4NDE0Njg4LTUwMDUtNDVmOS05YTVjLTlkMDRlODMyYTNkMiIsInR5cCI6IlJlZnJlc2giLCJhenAiOiJhbGZyZXNjbyIsImF1dGhfdGltZSI6MCwic2Vzc2lvbl9zdGF0ZSI6IjYyZTdlOWM5LWZhZTUtNDdkYS05OTAyLTE2Y2EyYWVlMDFjMCIsInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJvZmZsaW5lX2FjY2VzcyIsInVtYV9hdXRob3JpemF0aW9uIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJwcm9maWxlIGVtYWlsIn0.lRBJQc7tj0rk7JBC0zpM0dDdZgDKjm9wcxP8nzLnXe4";
|
||||
|
||||
AisToken aisToken;
|
||||
try
|
||||
{
|
||||
// Attempt to get an access token for userModel from AIS
|
||||
aisToken = dataAIS.perform().getAccessToken(userModel);
|
||||
}
|
||||
catch (HttpResponseException e)
|
||||
{
|
||||
// Trying to authenticate with invalid user credentials so return an invalid access token
|
||||
if (e.getStatusCode() == 401)
|
||||
{
|
||||
STEP(String.format("%s Invalid user credentials were provided %s:%s. Using invalid token for reqest.",
|
||||
STEP_PREFIX, userModel.getUsername(), userModel.getPassword()));
|
||||
aisToken = new AisToken(badToken, badRefreshToken, System.currentTimeMillis(), 300000);
|
||||
}
|
||||
else
|
||||
{
|
||||
throw e;
|
||||
}
|
||||
}
|
||||
return aisToken;
|
||||
}
|
||||
}
|
||||
}
|
@@ -0,0 +1,64 @@
|
||||
package org.alfresco.cmis;
|
||||
|
||||
import org.alfresco.utility.TasAisProperties;
|
||||
import org.alfresco.utility.TasProperties;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.beans.factory.annotation.Value;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.context.annotation.PropertySource;
|
||||
import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;
|
||||
|
||||
@Configuration
|
||||
@PropertySource("classpath:default.properties")
|
||||
@PropertySource(value = "classpath:${environment}.properties", ignoreResourceNotFound = true)
|
||||
public class CmisProperties
|
||||
{
|
||||
@Autowired
|
||||
private TasProperties properties;
|
||||
|
||||
@Autowired
|
||||
private TasAisProperties aisProperties;
|
||||
|
||||
public TasProperties envProperty()
|
||||
{
|
||||
return properties;
|
||||
}
|
||||
|
||||
public TasAisProperties aisProperty()
|
||||
{
|
||||
return aisProperties;
|
||||
}
|
||||
|
||||
@Bean
|
||||
public static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer()
|
||||
{
|
||||
return new PropertySourcesPlaceholderConfigurer();
|
||||
}
|
||||
|
||||
@Value("${cmis.binding}")
|
||||
private String cmisBinding;
|
||||
|
||||
@Value("${cmis.basePath}")
|
||||
private String basePath;
|
||||
|
||||
public String getCmisBinding()
|
||||
{
|
||||
return cmisBinding;
|
||||
}
|
||||
|
||||
public String getBasePath()
|
||||
{
|
||||
return basePath;
|
||||
}
|
||||
|
||||
public void setBasePath(String basePath)
|
||||
{
|
||||
this.basePath = basePath;
|
||||
}
|
||||
|
||||
public void setCmisBinding(String cmisBinding)
|
||||
{
|
||||
this.cmisBinding = cmisBinding;
|
||||
}
|
||||
}
|
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,185 @@
|
||||
package org.alfresco.cmis.dsl;
|
||||
|
||||
import static org.alfresco.utility.report.log.Step.STEP;
|
||||
|
||||
import java.util.Iterator;
|
||||
import java.util.List;
|
||||
|
||||
import org.alfresco.cmis.CmisWrapper;
|
||||
import org.alfresco.utility.LogFactory;
|
||||
import org.apache.chemistry.opencmis.client.api.ItemIterable;
|
||||
import org.apache.chemistry.opencmis.client.api.ObjectType;
|
||||
import org.apache.chemistry.opencmis.client.api.Tree;
|
||||
import org.apache.chemistry.opencmis.client.runtime.objecttype.ObjectTypeHelper;
|
||||
import org.apache.commons.lang3.builder.ToStringBuilder;
|
||||
import org.apache.commons.lang3.builder.ToStringStyle;
|
||||
import org.slf4j.Logger;
|
||||
import org.testng.Assert;
|
||||
|
||||
/**
|
||||
* DSL for preparing calls on getting the type children of a type.
|
||||
*/
|
||||
public class BaseObjectType
|
||||
{
|
||||
private CmisWrapper cmisAPI;
|
||||
private String baseTypeID;
|
||||
private boolean includePropertyDefinition = false;
|
||||
private Logger LOG = LogFactory.getLogger();
|
||||
|
||||
public BaseObjectType(CmisWrapper cmisAPI, String baseTypeID)
|
||||
{
|
||||
this.cmisAPI = cmisAPI;
|
||||
this.baseTypeID = baseTypeID;
|
||||
}
|
||||
|
||||
public BaseObjectType withPropertyDefinitions()
|
||||
{
|
||||
this.includePropertyDefinition = true;
|
||||
return this;
|
||||
}
|
||||
|
||||
public BaseObjectType withoutPropertyDefinitions()
|
||||
{
|
||||
this.includePropertyDefinition = false;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Example of objectTypeID:
|
||||
* "D:trx:transferReport" - see {@link ObjectTypeHelper} "D:trx:tempTransferStore"
|
||||
* "D:imap:imapAttach"
|
||||
*
|
||||
* @param objectTypeID
|
||||
*/
|
||||
public PropertyDefinitionObject hasChildren(String objectTypeID)
|
||||
{
|
||||
return checkChildren(objectTypeID, true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Example of objectTypeID:
|
||||
* "D:trx:transferReport" - see {@link ObjectTypeHelper} "D:trx:tempTransferStore"
|
||||
* "D:imap:imapAttach"
|
||||
*
|
||||
* @param objectTypeID
|
||||
*/
|
||||
public CmisWrapper doesNotHaveChildren(String objectTypeID)
|
||||
{
|
||||
checkChildren(objectTypeID, false);
|
||||
return cmisAPI;
|
||||
}
|
||||
|
||||
/**
|
||||
* Example of objectTypeID:
|
||||
* "D:trx:transferReport" - see {@link ObjectTypeHelper} "D:trx:tempTransferStore"
|
||||
* "D:imap:imapAttach"
|
||||
*
|
||||
* @param objectTypeID
|
||||
*/
|
||||
private PropertyDefinitionObject checkChildren(String objectTypeID, boolean exist)
|
||||
{
|
||||
ItemIterable<ObjectType> values = cmisAPI.withCMISUtil().getTypeChildren(this.baseTypeID, includePropertyDefinition);
|
||||
boolean foundChild = false;
|
||||
PropertyDefinitionObject propDefinition = null;
|
||||
for (Iterator<ObjectType> iterator = values.iterator(); iterator.hasNext();)
|
||||
{
|
||||
ObjectType type = (ObjectType) iterator.next();
|
||||
LOG.info("Found child Object Type: {}", ToStringBuilder.reflectionToString(type, ToStringStyle.MULTI_LINE_STYLE));
|
||||
if (type.getId().equals(objectTypeID))
|
||||
{
|
||||
foundChild = true;
|
||||
propDefinition = new PropertyDefinitionObject(type);
|
||||
break;
|
||||
}
|
||||
}
|
||||
Assert.assertEquals(foundChild, exist,
|
||||
String.format("Object Type with ID[%s] is found as children for Parent Type: [%s]", objectTypeID, this.baseTypeID));
|
||||
return propDefinition;
|
||||
}
|
||||
|
||||
public class PropertyDefinitionObject
|
||||
{
|
||||
ObjectType type;
|
||||
|
||||
public PropertyDefinitionObject(ObjectType type)
|
||||
{
|
||||
this.type = type;
|
||||
}
|
||||
|
||||
public PropertyDefinitionObject propertyDefinitionIsEmpty()
|
||||
{
|
||||
STEP(String.format("%s Verify that property definitions map is empty.", CmisWrapper.STEP_PREFIX));
|
||||
Assert.assertTrue(type.getPropertyDefinitions().isEmpty(), "Property definitions is empty.");
|
||||
return this;
|
||||
}
|
||||
|
||||
public PropertyDefinitionObject propertyDefinitionIsNotEmpty()
|
||||
{
|
||||
STEP(String.format("%s Verify that property definitions map is not empty.", CmisWrapper.STEP_PREFIX));
|
||||
Assert.assertFalse(type.getPropertyDefinitions().isEmpty(), "Property definitions is not empty.");
|
||||
return this;
|
||||
}
|
||||
}
|
||||
|
||||
private CmisWrapper checkDescendents(int depth, boolean exist, String... objectTypeIDs)
|
||||
{
|
||||
List<Tree<ObjectType>> values = cmisAPI.withCMISUtil().getTypeDescendants(this.baseTypeID, depth, includePropertyDefinition);
|
||||
for (String objectTypeID : objectTypeIDs)
|
||||
{
|
||||
boolean foundChild = false;
|
||||
for (Tree<ObjectType> tree : values)
|
||||
{
|
||||
if (tree.getItem().getId().equals(objectTypeID))
|
||||
{
|
||||
foundChild = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
Assert.assertEquals(foundChild, exist,
|
||||
String.format("Assert %b: Descendant [%s] is found as descendant for Type: [%s]", exist, objectTypeID, this.baseTypeID));
|
||||
|
||||
if (foundChild)
|
||||
{
|
||||
STEP(String.format("%s Cmis object '%s' is found as descendant.", CmisWrapper.STEP_PREFIX, objectTypeID));
|
||||
}
|
||||
else
|
||||
{
|
||||
STEP(String.format("%s Cmis object '%s' is NOT found as descendant.", CmisWrapper.STEP_PREFIX, objectTypeID));
|
||||
}
|
||||
}
|
||||
return cmisAPI;
|
||||
}
|
||||
|
||||
/**
|
||||
* Assert that specified descendantType is present in the depth of tree
|
||||
* Depth can be -1 or >= 1
|
||||
* Example of objectTypeID:
|
||||
* "D:trx:transferReport" - see {@link ObjectTypeHelper} "D:trx:tempTransferStore"
|
||||
* "D:imap:imapAttach"
|
||||
*
|
||||
* @param objectTypeID
|
||||
* @param depth
|
||||
* @return
|
||||
*/
|
||||
public CmisWrapper hasDescendantType(int depth, String... objectTypeIDs)
|
||||
{
|
||||
return checkDescendents(depth, true, objectTypeIDs);
|
||||
}
|
||||
|
||||
/**
|
||||
* Assert that specified descendantType is NOT present in the depth of tree
|
||||
* Depth can be -1 or >= 1
|
||||
* Example of objectTypeID:
|
||||
* "D:trx:transferReport" - see {@link ObjectTypeHelper} "D:trx:tempTransferStore"
|
||||
* "D:imap:imapAttach"
|
||||
*
|
||||
* @param objectTypeID
|
||||
* @param depth
|
||||
* @return
|
||||
*/
|
||||
public CmisWrapper doesNotHaveDescendantType(int depth, String... objectTypeIDs)
|
||||
{
|
||||
checkDescendents(depth, false, objectTypeIDs);
|
||||
return cmisAPI;
|
||||
}
|
||||
}
|
@@ -0,0 +1,78 @@
|
||||
package org.alfresco.cmis.dsl;
|
||||
|
||||
import org.alfresco.cmis.CmisWrapper;
|
||||
import org.alfresco.utility.Utility;
|
||||
import org.apache.chemistry.opencmis.client.api.Document;
|
||||
import org.apache.chemistry.opencmis.commons.data.ContentStream;
|
||||
import org.apache.chemistry.opencmis.commons.exceptions.CmisStorageException;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* DSL pertaining only to check in a {@link Document}
|
||||
*/
|
||||
public class CheckIn
|
||||
{
|
||||
private CmisWrapper cmisWrapper;
|
||||
private boolean version;
|
||||
private Map<String, ?> properties;
|
||||
private String content;
|
||||
private String comment;
|
||||
|
||||
public CheckIn(CmisWrapper cmisWrapper)
|
||||
{
|
||||
this.cmisWrapper = cmisWrapper;
|
||||
}
|
||||
|
||||
public CheckIn withMajorVersion()
|
||||
{
|
||||
this.version = true;
|
||||
return this;
|
||||
}
|
||||
|
||||
public CheckIn withMinorVersion()
|
||||
{
|
||||
this.version = false;
|
||||
return this;
|
||||
}
|
||||
|
||||
public CheckIn withContent(String content)
|
||||
{
|
||||
this.content = content;
|
||||
return this;
|
||||
}
|
||||
|
||||
public CheckIn withoutComment()
|
||||
{
|
||||
this.comment = null;
|
||||
return this;
|
||||
}
|
||||
|
||||
public CheckIn withComment(String comment)
|
||||
{
|
||||
this.comment = comment;
|
||||
return this;
|
||||
}
|
||||
|
||||
public CmisWrapper checkIn() throws Exception
|
||||
{
|
||||
return checkIn(properties);
|
||||
}
|
||||
|
||||
public CmisWrapper checkIn(Map<String, ?> properties) throws Exception
|
||||
{
|
||||
ContentStream contentStream = cmisWrapper.withCMISUtil().getContentStream(content);
|
||||
try
|
||||
{
|
||||
Document pwc = cmisWrapper.withCMISUtil().getPWCDocument();
|
||||
pwc.refresh();
|
||||
Utility.waitToLoopTime(2);
|
||||
pwc.checkIn(version, properties, contentStream, comment);
|
||||
}
|
||||
catch(CmisStorageException st)
|
||||
{
|
||||
cmisWrapper.withCMISUtil().getPWCDocument().checkIn(version, properties, contentStream, comment);
|
||||
}
|
||||
return cmisWrapper;
|
||||
}
|
||||
}
|
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,761 @@
|
||||
package org.alfresco.cmis.dsl;
|
||||
|
||||
import org.alfresco.cmis.CmisWrapper;
|
||||
import org.alfresco.cmis.exception.InvalidCmisObjectException;
|
||||
import org.alfresco.utility.LogFactory;
|
||||
import org.alfresco.utility.Utility;
|
||||
import org.alfresco.utility.constants.UserRole;
|
||||
import org.alfresco.utility.exception.IORuntimeException;
|
||||
import org.alfresco.utility.model.ContentModel;
|
||||
import org.alfresco.utility.model.FileModel;
|
||||
import org.alfresco.utility.model.FolderModel;
|
||||
import org.alfresco.utility.model.GroupModel;
|
||||
import org.alfresco.utility.model.UserModel;
|
||||
import org.apache.chemistry.opencmis.client.api.CmisObject;
|
||||
import org.apache.chemistry.opencmis.client.api.Document;
|
||||
import org.apache.chemistry.opencmis.client.api.FileableCmisObject;
|
||||
import org.apache.chemistry.opencmis.client.api.Folder;
|
||||
import org.apache.chemistry.opencmis.client.api.ItemIterable;
|
||||
import org.apache.chemistry.opencmis.client.api.ObjectType;
|
||||
import org.apache.chemistry.opencmis.client.api.OperationContext;
|
||||
import org.apache.chemistry.opencmis.client.api.Property;
|
||||
import org.apache.chemistry.opencmis.client.api.QueryResult;
|
||||
import org.apache.chemistry.opencmis.client.api.Rendition;
|
||||
import org.apache.chemistry.opencmis.client.api.SecondaryType;
|
||||
import org.apache.chemistry.opencmis.client.api.Tree;
|
||||
import org.apache.chemistry.opencmis.commons.PropertyIds;
|
||||
import org.apache.chemistry.opencmis.commons.data.Ace;
|
||||
import org.apache.chemistry.opencmis.commons.data.Acl;
|
||||
import org.apache.chemistry.opencmis.commons.data.AclCapabilities;
|
||||
import org.apache.chemistry.opencmis.commons.data.ContentStream;
|
||||
import org.apache.chemistry.opencmis.commons.data.PermissionMapping;
|
||||
import org.apache.chemistry.opencmis.commons.data.PropertyData;
|
||||
import org.apache.chemistry.opencmis.commons.data.RepositoryInfo;
|
||||
import org.apache.chemistry.opencmis.commons.enums.Action;
|
||||
import org.apache.chemistry.opencmis.commons.enums.BaseTypeId;
|
||||
import org.apache.chemistry.opencmis.commons.enums.BindingType;
|
||||
import org.apache.chemistry.opencmis.commons.exceptions.CmisRuntimeException;
|
||||
import org.apache.chemistry.opencmis.commons.exceptions.CmisVersioningException;
|
||||
import org.apache.commons.io.IOUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.testng.collections.Lists;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import static org.alfresco.utility.report.log.Step.STEP;
|
||||
|
||||
/**
|
||||
* DSL utility for managing CMIS objects
|
||||
*/
|
||||
public class CmisUtil
|
||||
{
|
||||
private CmisWrapper cmisAPI;
|
||||
private Logger LOG = LogFactory.getLogger();
|
||||
|
||||
public CmisUtil(CmisWrapper cmisAPI)
|
||||
{
|
||||
this.cmisAPI = cmisAPI;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get cmis object by object id
|
||||
*
|
||||
* @param objectId cmis object id
|
||||
* @return CmisObject cmis object
|
||||
*/
|
||||
public CmisObject getCmisObjectById(String objectId)
|
||||
{
|
||||
LOG.debug("Get CMIS object by ID {}", objectId);
|
||||
if (cmisAPI.getSession() == null)
|
||||
{
|
||||
throw new CmisRuntimeException("Please authenticate user, call: cmisAPI.authenticate(..)!");
|
||||
}
|
||||
if (objectId == null)
|
||||
{
|
||||
throw new InvalidCmisObjectException("Invalid content id");
|
||||
}
|
||||
return cmisAPI.getSession().getObject(objectId);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get cmis object by object id with OperationContext
|
||||
*
|
||||
* @param objectId cmis object id
|
||||
* @param context OperationContext
|
||||
* @return CmisObject cmis object
|
||||
*/
|
||||
public CmisObject getCmisObjectById(String objectId, OperationContext context)
|
||||
{
|
||||
if (cmisAPI.getSession() == null)
|
||||
{
|
||||
throw new CmisRuntimeException("Please authenticate user, call: cmisAPI.authenticate(..)!");
|
||||
}
|
||||
if (objectId == null)
|
||||
{
|
||||
throw new InvalidCmisObjectException("Invalid content id");
|
||||
}
|
||||
return cmisAPI.getSession().getObject(objectId, context);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get cmis object by path
|
||||
*
|
||||
* @param pathToItem String path to item
|
||||
* @return CmisObject cmis object
|
||||
*/
|
||||
public CmisObject getCmisObject(String pathToItem)
|
||||
{
|
||||
if (cmisAPI.getSession() == null)
|
||||
{
|
||||
throw new CmisRuntimeException("Please authenticate user, call: cmisAPI.authenticate(..)!");
|
||||
}
|
||||
if (pathToItem == null)
|
||||
{
|
||||
throw new InvalidCmisObjectException("Invalid path set for content");
|
||||
}
|
||||
CmisObject cmisObject = cmisAPI.getSession().getObjectByPath(Utility.removeLastSlash(pathToItem));
|
||||
if (cmisObject instanceof Document)
|
||||
{
|
||||
if (!((Document) cmisObject).getVersionLabel().contentEquals("pwc"))
|
||||
{
|
||||
// get last version of document
|
||||
cmisObject = ((Document) cmisObject).getObjectOfLatestVersion(false);
|
||||
}
|
||||
else
|
||||
{
|
||||
// get pwc document
|
||||
cmisObject = cmisAPI.getSession().getObject(((Document) cmisObject).getObjectOfLatestVersion(false).getVersionSeriesCheckedOutId());
|
||||
}
|
||||
}
|
||||
return cmisObject;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get cmis object by path with context
|
||||
*
|
||||
* @param pathToItem String path to item
|
||||
* @param context OperationContext
|
||||
* @return CmisObject cmis object
|
||||
*/
|
||||
public CmisObject getCmisObject(String pathToItem, OperationContext context)
|
||||
{
|
||||
if (cmisAPI.getSession() == null)
|
||||
{
|
||||
throw new CmisRuntimeException("Please authenticate user!");
|
||||
}
|
||||
if (pathToItem == null)
|
||||
{
|
||||
throw new InvalidCmisObjectException("Invalid path set for content");
|
||||
}
|
||||
CmisObject cmisObject = cmisAPI.getSession().getObjectByPath(Utility.removeLastSlash(pathToItem), context);
|
||||
if (cmisObject instanceof Document)
|
||||
{
|
||||
if (!((Document) cmisObject).getVersionLabel().contentEquals("pwc"))
|
||||
{
|
||||
// get last version of document
|
||||
cmisObject = ((Document) cmisObject).getObjectOfLatestVersion(false, context);
|
||||
}
|
||||
else
|
||||
{
|
||||
// get pwc document
|
||||
cmisObject = cmisAPI.getSession().getObject(((Document) cmisObject).getObjectOfLatestVersion(false, context).getVersionSeriesCheckedOutId());
|
||||
}
|
||||
}
|
||||
return cmisObject;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Document object for a file
|
||||
*
|
||||
* @param path String path to document
|
||||
* @return {@link Document} object
|
||||
*/
|
||||
public Document getCmisDocument(final String path)
|
||||
{
|
||||
LOG.debug("Get CMIS Document by path {}", path);
|
||||
Document d = null;
|
||||
CmisObject docObj = getCmisObject(path);
|
||||
if (docObj instanceof Document)
|
||||
{
|
||||
d = (Document) docObj;
|
||||
}
|
||||
else if (docObj instanceof Folder)
|
||||
{
|
||||
throw new InvalidCmisObjectException("Content at " + path + " is not a file");
|
||||
}
|
||||
return d;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Folder object for a folder
|
||||
*
|
||||
* @param path String path to folder
|
||||
* @return {@link Folder} object
|
||||
*/
|
||||
public Folder getCmisFolder(final String path)
|
||||
{
|
||||
Folder f = null;
|
||||
CmisObject folderObj = getCmisObject(path);
|
||||
if (folderObj instanceof Folder)
|
||||
{
|
||||
f = (Folder) folderObj;
|
||||
}
|
||||
else if (folderObj instanceof Document)
|
||||
{
|
||||
throw new InvalidCmisObjectException("Content at " + path + " is not a folder");
|
||||
}
|
||||
return f;
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method to get the contents of a stream
|
||||
*
|
||||
* @param stream
|
||||
* @return
|
||||
* @throws IORuntimeException
|
||||
*/
|
||||
protected String getContentAsString(ContentStream stream)
|
||||
{
|
||||
LOG.debug("Get Content as String {}", stream);
|
||||
InputStream inputStream = stream.getStream();
|
||||
String result;
|
||||
try
|
||||
{
|
||||
result = IOUtils.toString(inputStream, StandardCharsets.UTF_8);
|
||||
}
|
||||
catch (IOException e)
|
||||
{
|
||||
throw new IORuntimeException(e);
|
||||
}
|
||||
IOUtils.closeQuietly(inputStream);
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Copy all the children of the source folder to the target folder
|
||||
*
|
||||
* @param sourceFolder
|
||||
* @param targetFolder
|
||||
*/
|
||||
protected void copyChildrenFromFolder(Folder sourceFolder, Folder targetFolder)
|
||||
{
|
||||
for (Tree<FileableCmisObject> t : sourceFolder.getDescendants(-1))
|
||||
{
|
||||
CmisObject obj = t.getItem();
|
||||
if (obj instanceof Document)
|
||||
{
|
||||
Document d = (Document) obj;
|
||||
d.copy(targetFolder);
|
||||
}
|
||||
else if (obj instanceof Folder)
|
||||
{
|
||||
copyFolder((Folder) obj, targetFolder);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Copy folder with all children
|
||||
*
|
||||
* @param sourceFolder source folder
|
||||
* @param targetFolder target folder
|
||||
* @return CmisObject of new created folder
|
||||
*/
|
||||
public CmisObject copyFolder(Folder sourceFolder, Folder targetFolder)
|
||||
{
|
||||
Map<String, Object> folderProperties = new HashMap<String, Object>(2);
|
||||
folderProperties.put(PropertyIds.NAME, sourceFolder.getName());
|
||||
folderProperties.put(PropertyIds.OBJECT_TYPE_ID, sourceFolder.getBaseTypeId().value());
|
||||
Folder newFolder = targetFolder.createFolder(folderProperties);
|
||||
copyChildrenFromFolder(sourceFolder, newFolder);
|
||||
return newFolder;
|
||||
}
|
||||
|
||||
protected boolean isPrivateWorkingCopy()
|
||||
{
|
||||
boolean result;
|
||||
try
|
||||
{
|
||||
result = getPWCDocument().isVersionSeriesPrivateWorkingCopy();
|
||||
}
|
||||
catch (CmisVersioningException cmisVersioningException)
|
||||
{
|
||||
result = false;
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the PWC (private working copy) ID of the document version series
|
||||
*/
|
||||
public Document getPWCDocument()
|
||||
{
|
||||
Document document = getCmisDocument(cmisAPI.getLastResource());
|
||||
String pwcId = document.getVersionSeriesCheckedOutId();
|
||||
if (pwcId != null)
|
||||
{
|
||||
return (Document) cmisAPI.getSession().getObject(pwcId);
|
||||
}
|
||||
else
|
||||
{
|
||||
throw new CmisVersioningException(String.format("Document %s is not checked out", document.getName()));
|
||||
}
|
||||
}
|
||||
|
||||
public FileModel getPWCFileModel()
|
||||
{
|
||||
Document document = getPWCDocument();
|
||||
String[] pathTokens = cmisAPI.getLastResource().split("/");
|
||||
String path = "";
|
||||
for (int i = 0; i < pathTokens.length - 1; i++)
|
||||
path = Utility.buildPath(path, pathTokens[i]);
|
||||
path = Utility.buildPath(path, document.getName());
|
||||
|
||||
FileModel fileModel = new FileModel();
|
||||
fileModel.setName(document.getName());
|
||||
fileModel.setCmisLocation(path);
|
||||
return fileModel;
|
||||
}
|
||||
|
||||
protected Folder getFolderParent()
|
||||
{
|
||||
return getCmisFolder(cmisAPI.getLastResource()).getFolderParent();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return List<Action> of allowable actions for the current object
|
||||
*/
|
||||
protected List<Action> getAllowableActions()
|
||||
{
|
||||
return Lists.newArrayList(getCmisObject(cmisAPI.getLastResource()).getAllowableActions().getAllowableActions());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the requested property. If the property is not available, null is returned
|
||||
*
|
||||
* @param propertyId
|
||||
* @return CMIS Property
|
||||
*/
|
||||
protected <T> Property<T> getProperty(String propertyId)
|
||||
{
|
||||
CmisObject cmisObject = getCmisObject(cmisAPI.getLastResource());
|
||||
return cmisObject.getProperty(propertyId);
|
||||
}
|
||||
|
||||
protected List<Rendition> getRenditions()
|
||||
{
|
||||
OperationContext operationContext = cmisAPI.getSession().createOperationContext();
|
||||
operationContext.setRenditionFilterString("*");
|
||||
CmisObject obj = cmisAPI.getSession().getObjectByPath(cmisAPI.getLastResource(), operationContext);
|
||||
obj.refresh();
|
||||
List<Rendition> renditions = obj.getRenditions();
|
||||
int retry = 0;
|
||||
while ((renditions == null || renditions.isEmpty()) && retry < Utility.retryCountSeconds)
|
||||
{
|
||||
Utility.waitToLoopTime(1);
|
||||
obj.refresh();
|
||||
renditions = obj.getRenditions();
|
||||
retry++;
|
||||
}
|
||||
return obj.getRenditions();
|
||||
}
|
||||
|
||||
protected List<SecondaryType> getSecondaryTypes()
|
||||
{
|
||||
CmisObject obj = getCmisObject(cmisAPI.getLastResource());
|
||||
obj.refresh();
|
||||
return obj.getSecondaryTypes();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the children from a parent folder
|
||||
*
|
||||
* @return Map<ContentModel, ObjectType>
|
||||
*/
|
||||
public Map<ContentModel, ObjectType> getChildren()
|
||||
{
|
||||
String folderParent = cmisAPI.getLastResource();
|
||||
ItemIterable<CmisObject> children = cmisAPI.withCMISUtil().getCmisFolder(folderParent).getChildren();
|
||||
Map<ContentModel, ObjectType> contents = new HashMap<ContentModel, ObjectType>();
|
||||
for (CmisObject o : children)
|
||||
{
|
||||
ContentModel content = new ContentModel(o.getName());
|
||||
content.setNodeRef(o.getId());
|
||||
content.setDescription(o.getDescription());
|
||||
content.setCmisLocation(Utility.buildPath(folderParent, o.getName()));
|
||||
contents.put(content, o.getType());
|
||||
}
|
||||
return contents;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the folder descendants starting with the current folder
|
||||
*
|
||||
* @param depth level of the tree that you want to go to
|
||||
* - currentFolder
|
||||
* -- file1.txt
|
||||
* -- file2.txt
|
||||
* -- folderB
|
||||
* --- file3.txt
|
||||
* --- file4.txt
|
||||
* e.g. A depth of 1 will give you just the current folder descendants (file1.txt, file2.txt, folder1)
|
||||
* e.g. A depth of -1 will return all the descendants (file1.txt, file2.txt, folder1, file3.txt and file4.txt)
|
||||
*/
|
||||
public List<CmisObject> getFolderDescendants(int depth)
|
||||
{
|
||||
return getFolderTreeCmisObjects(getCmisFolder(cmisAPI.getLastResource()).getDescendants(depth));
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a list of Cmis objects for the provided Content Models
|
||||
*
|
||||
* @param contentModels
|
||||
*/
|
||||
public List<CmisObject> getCmisObjectsFromContentModels(ContentModel... contentModels)
|
||||
{
|
||||
List<CmisObject> cmisObjects = new ArrayList<>();
|
||||
for (ContentModel contentModel : contentModels)
|
||||
cmisObjects.add(getCmisObject(contentModel.getCmisLocation()));
|
||||
return cmisObjects;
|
||||
}
|
||||
|
||||
public ContentStream getContentStream(String content)
|
||||
{
|
||||
String fileName = getCmisDocument(cmisAPI.getLastResource()).getName();
|
||||
|
||||
return cmisAPI.getDataContentService().getContentStream(fileName, content);
|
||||
}
|
||||
|
||||
public Acl getAcls()
|
||||
{
|
||||
OperationContext context = cmisAPI.getSession().createOperationContext();
|
||||
context.setIncludeAcls(true);
|
||||
return getCmisObject(cmisAPI.getLastResource(), context).getAcl();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets only the folder descendants for the {@link #getLastResource()} folder
|
||||
*
|
||||
* @param depth level of the tree that you want to go to
|
||||
* - currentFolder
|
||||
* -- folderB
|
||||
* -- folderC
|
||||
* --- folderD
|
||||
* e.g. A depth of 1 will give you just the current folder descendants (folderB, folderC)
|
||||
* e.g. A depth of -1 will return all the descendants (folderB, folderC, folderD)
|
||||
*/
|
||||
public List<CmisObject> getFolderTree(int depth)
|
||||
{
|
||||
return getFolderTreeCmisObjects(getCmisFolder(cmisAPI.getLastResource()).getFolderTree(depth));
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method for getFolderTree and getFolderDescendants that cycles threw the folder descendants and returns List<CmisObject>
|
||||
*/
|
||||
private List<CmisObject> getFolderTreeCmisObjects(List<Tree<FileableCmisObject>> descendants)
|
||||
{
|
||||
List<CmisObject> cmisObjectList = new ArrayList<>();
|
||||
for (Tree<FileableCmisObject> descendant : descendants)
|
||||
{
|
||||
cmisObjectList.add(descendant.getItem());
|
||||
cmisObjectList.addAll(descendant.getChildren().stream().map(Tree::getItem).collect(Collectors.toList()));
|
||||
}
|
||||
return cmisObjectList;
|
||||
}
|
||||
|
||||
protected List<Document> getAllDocumentVersions()
|
||||
{
|
||||
return getCmisDocument(cmisAPI.getLastResource()).getAllVersions();
|
||||
}
|
||||
|
||||
public List<Document> getAllDocumentVersionsBy(OperationContext context)
|
||||
{
|
||||
return getCmisDocument(cmisAPI.getLastResource()).getAllVersions(context);
|
||||
}
|
||||
|
||||
public List<Document> getCheckedOutDocumentsFromSession()
|
||||
{
|
||||
return com.google.common.collect.Lists.newArrayList(cmisAPI.getSession().getCheckedOutDocs());
|
||||
}
|
||||
|
||||
public List<Document> getCheckedOutDocumentsFromSession(OperationContext context)
|
||||
{
|
||||
return com.google.common.collect.Lists.newArrayList(cmisAPI.getSession().getCheckedOutDocs(context));
|
||||
}
|
||||
|
||||
public List<Document> getCheckedOutDocumentsFromFolder()
|
||||
{
|
||||
Folder folder = cmisAPI.withCMISUtil().getCmisFolder(cmisAPI.getLastResource());
|
||||
return com.google.common.collect.Lists.newArrayList(folder.getCheckedOutDocs());
|
||||
}
|
||||
|
||||
public List<Document> getCheckedOutDocumentsFromFolder(OperationContext context)
|
||||
{
|
||||
Folder folder = cmisAPI.withCMISUtil().getCmisFolder(cmisAPI.getLastResource());
|
||||
return com.google.common.collect.Lists.newArrayList(folder.getCheckedOutDocs(context));
|
||||
}
|
||||
|
||||
protected boolean isCmisObjectContainedInCmisCheckedOutDocumentsList(CmisObject cmisObject, List<Document> cmisCheckedOutDocuments)
|
||||
{
|
||||
for (Document cmisCheckedOutDocument : cmisCheckedOutDocuments)
|
||||
if (cmisObject.getId().split(";")[0].equals(cmisCheckedOutDocument.getId().split(";")[0]))
|
||||
return true;
|
||||
return false;
|
||||
}
|
||||
|
||||
public Map<String, Object> getProperties(ContentModel contentModel, String baseTypeId)
|
||||
{
|
||||
|
||||
Map<String, Object> properties = new HashMap<String, Object>();
|
||||
properties.put(PropertyIds.OBJECT_TYPE_ID, baseTypeId);
|
||||
properties.put(PropertyIds.NAME, contentModel.getName());
|
||||
|
||||
// WebServices binding does not have SecondaryTypes and cannot be added to Object.
|
||||
// cm:title and cm:description Policies
|
||||
if (cmisAPI.getSession().getBinding().getBindingType().value().equals(BindingType.WEBSERVICES.value()))
|
||||
{
|
||||
return properties;
|
||||
}
|
||||
|
||||
List<Object> aspects = new ArrayList<Object>();
|
||||
aspects.add("P:cm:titled");
|
||||
properties.put(PropertyIds.SECONDARY_OBJECT_TYPE_IDS, aspects);
|
||||
properties.put("cm:title", contentModel.getTitle());
|
||||
properties.put("cm:description", contentModel.getDescription());
|
||||
return properties;
|
||||
}
|
||||
|
||||
public OperationContext setIncludeAclContext()
|
||||
{
|
||||
OperationContext context = cmisAPI.getSession().createOperationContext();
|
||||
context.setIncludeAcls(true);
|
||||
return context;
|
||||
}
|
||||
|
||||
public List<Ace> createAce(UserModel user, UserRole role)
|
||||
{
|
||||
List<String> addPermission = new ArrayList<String>();
|
||||
addPermission.add(role.getRoleId());
|
||||
Ace addAce = cmisAPI.getSession().getObjectFactory().createAce(user.getUsername(), addPermission);
|
||||
List<Ace> addAces = new ArrayList<Ace>();
|
||||
addAces.add(addAce);
|
||||
return addAces;
|
||||
}
|
||||
|
||||
public List<Ace> createAce(GroupModel group, UserRole role)
|
||||
{
|
||||
List<String> addPermission = new ArrayList<String>();
|
||||
addPermission.add(role.getRoleId());
|
||||
Ace addAce = cmisAPI.getSession().getObjectFactory().createAce(group.getDisplayName(), addPermission);
|
||||
List<Ace> addAces = new ArrayList<Ace>();
|
||||
addAces.add(addAce);
|
||||
return addAces;
|
||||
}
|
||||
|
||||
public List<Ace> createAce(UserModel user, String... permissions)
|
||||
{
|
||||
List<Ace> addAces = new ArrayList<Ace>();
|
||||
RepositoryInfo repositoryInfo = cmisAPI.getSession().getRepositoryInfo();
|
||||
AclCapabilities aclCapabilities = repositoryInfo.getAclCapabilities();
|
||||
Map<String, PermissionMapping> permissionMappings = aclCapabilities.getPermissionMapping();
|
||||
for (String perm : permissions)
|
||||
{
|
||||
STEP(String.format("%s Add permission '%s' for user %s ", CmisWrapper.STEP_PREFIX, perm, user.getUsername()));
|
||||
PermissionMapping permissionMapping = permissionMappings.get(perm);
|
||||
List<String> permissionsList = permissionMapping.getPermissions();
|
||||
Ace addAce = cmisAPI.getSession().getObjectFactory().createAce(user.getUsername(), permissionsList);
|
||||
addAces.add(addAce);
|
||||
}
|
||||
return addAces;
|
||||
}
|
||||
|
||||
public ObjectType getTypeDefinition()
|
||||
{
|
||||
CmisObject cmisObject = cmisAPI.withCMISUtil().getCmisObject(cmisAPI.getLastResource());
|
||||
return cmisAPI.getSession().getTypeDefinition(cmisObject.getBaseTypeId().value());
|
||||
}
|
||||
|
||||
public ItemIterable<ObjectType> getTypeChildren(String baseType, boolean includePropertyDefinitions)
|
||||
{
|
||||
STEP(String.format("%s Get type children for '%s' and includePropertyDefinitions set to '%s'", CmisWrapper.STEP_PREFIX, baseType,
|
||||
includePropertyDefinitions));
|
||||
return cmisAPI.getSession().getTypeChildren(baseType, includePropertyDefinitions);
|
||||
}
|
||||
|
||||
public List<Tree<ObjectType>> getTypeDescendants(String baseTypeId, int depth, boolean includePropertyDefinitions)
|
||||
{
|
||||
STEP(String.format("%s Get type descendants for '%s' with depth set to %d and includePropertyDefinitions set to '%s'", CmisWrapper.STEP_PREFIX,
|
||||
baseTypeId, depth, includePropertyDefinitions));
|
||||
return cmisAPI.getSession().getTypeDescendants(baseTypeId, depth, includePropertyDefinitions);
|
||||
}
|
||||
|
||||
public String getObjectId(String pathToObject)
|
||||
{
|
||||
return getCmisObject(pathToObject).getId();
|
||||
}
|
||||
|
||||
/**
|
||||
* Update property for last resource cmis object
|
||||
*
|
||||
* @param propertyName String property name (e.g. cmis:name)
|
||||
* @param propertyValue Object property value
|
||||
*/
|
||||
public void updateProperties(String propertyName, Object propertyValue)
|
||||
{
|
||||
Map<String, Object> props = new HashMap<String, Object>();
|
||||
props.put(propertyName, propertyValue);
|
||||
getCmisObject(cmisAPI.getLastResource()).updateProperties(props);
|
||||
}
|
||||
|
||||
protected boolean isFolderInList(FolderModel folderModel, List<FolderModel> folders)
|
||||
{
|
||||
for (FolderModel folder : folders)
|
||||
{
|
||||
if (folderModel.getName().equals(folder.getName()))
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
protected boolean isFileInList(FileModel fileModel, List<FileModel> files)
|
||||
{
|
||||
for (FileModel file : files)
|
||||
{
|
||||
if (fileModel.getName().equals(file.getName()))
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
protected boolean isContentInList(ContentModel contentModel, List<ContentModel> contents)
|
||||
{
|
||||
for (ContentModel content : contents)
|
||||
{
|
||||
if (content.getName().equals(content.getName()))
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get children folders from a parent folder
|
||||
*
|
||||
* @return List<FolderModel>
|
||||
*/
|
||||
public List<FolderModel> getFolders()
|
||||
{
|
||||
STEP(String.format("%s Get the folder children from '%s'", CmisWrapper.STEP_PREFIX, cmisAPI.getLastResource()));
|
||||
Map<ContentModel, ObjectType> children = getChildren();
|
||||
List<FolderModel> folders = new ArrayList<FolderModel>();
|
||||
for (Map.Entry<ContentModel, ObjectType> entry : children.entrySet())
|
||||
{
|
||||
if (entry.getValue().getId().equals(BaseTypeId.CMIS_FOLDER.value()))
|
||||
{
|
||||
FolderModel folder = new FolderModel(entry.getKey().getName());
|
||||
folder.setNodeRef(entry.getKey().getNodeRef());
|
||||
folder.setDescription(entry.getKey().getDescription());
|
||||
folder.setCmisLocation(entry.getKey().getCmisLocation());
|
||||
folder.setProtocolLocation(entry.getKey().getCmisLocation());
|
||||
folders.add(folder);
|
||||
}
|
||||
}
|
||||
return folders;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get children documents from a parent folder
|
||||
*
|
||||
* @return List<FolderModel>
|
||||
*/
|
||||
public List<FileModel> getFiles()
|
||||
{
|
||||
STEP(String.format("%s Get the file children from '%s'", CmisWrapper.STEP_PREFIX, cmisAPI.getLastResource()));
|
||||
Map<ContentModel, ObjectType> children = getChildren();
|
||||
List<FileModel> files = new ArrayList<FileModel>();
|
||||
for (Map.Entry<ContentModel, ObjectType> entry : children.entrySet())
|
||||
{
|
||||
if (entry.getValue().getId().equals(BaseTypeId.CMIS_DOCUMENT.value()))
|
||||
{
|
||||
FileModel file = new FileModel(entry.getKey().getName());
|
||||
file.setNodeRef(entry.getKey().getNodeRef());
|
||||
file.setDescription(entry.getKey().getDescription());
|
||||
file.setCmisLocation(entry.getKey().getCmisLocation());
|
||||
file.setProtocolLocation(entry.getKey().getCmisLocation());
|
||||
files.add(file);
|
||||
}
|
||||
}
|
||||
return files;
|
||||
}
|
||||
|
||||
/*
|
||||
* Get document(set as last resource) content
|
||||
*/
|
||||
public String getDocumentContent()
|
||||
{
|
||||
Utility.waitToLoopTime(2);
|
||||
Document lastVersion = getCmisDocument(cmisAPI.getLastResource());
|
||||
lastVersion.refresh();
|
||||
LOG.info(String.format("Get the content from %s - node: %s", lastVersion.getName(), lastVersion.getId()));
|
||||
ContentStream contentStream = lastVersion.getContentStream();
|
||||
String actualContent = "";
|
||||
if (contentStream != null)
|
||||
{
|
||||
actualContent = getContentAsString(contentStream);
|
||||
}
|
||||
else
|
||||
{
|
||||
lastVersion = getCmisDocument(cmisAPI.getLastResource());
|
||||
lastVersion.refresh();
|
||||
LOG.info(String.format("Retry get content stream for %s node: %s", lastVersion.getName(), lastVersion.getId()));
|
||||
contentStream = lastVersion.getContentStream();
|
||||
if (contentStream != null)
|
||||
{
|
||||
actualContent = getContentAsString(contentStream);
|
||||
}
|
||||
}
|
||||
if(actualContent.isEmpty())
|
||||
{
|
||||
Utility.waitToLoopTime(2);
|
||||
Document retryDoc = getCmisDocument(cmisAPI.getLastResource());
|
||||
retryDoc.refresh();
|
||||
LOG.info(String.format("Retry get content stream for %s node: %s", retryDoc.getName(), retryDoc.getId()));
|
||||
contentStream = retryDoc.getContentStream();
|
||||
if (contentStream != null)
|
||||
{
|
||||
actualContent = getContentAsString(contentStream);
|
||||
}
|
||||
}
|
||||
return actualContent;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get user noderef
|
||||
*
|
||||
* @param user {@link UserModel}
|
||||
*/
|
||||
public String getUserNodeRef(UserModel user)
|
||||
{
|
||||
String objectId = "";
|
||||
ItemIterable<QueryResult> results = cmisAPI.getSession().query("select cmis:objectId from cm:person where cm:userName = '" + user.getUsername() + "'",
|
||||
false);
|
||||
for (QueryResult qResult : results)
|
||||
{
|
||||
PropertyData<?> propData = qResult.getPropertyById("cmis:objectId");
|
||||
objectId = (String) propData.getFirstValue();
|
||||
}
|
||||
return objectId;
|
||||
}
|
||||
}
|
@@ -0,0 +1,137 @@
|
||||
package org.alfresco.cmis.dsl;
|
||||
|
||||
import static org.alfresco.utility.report.log.Step.STEP;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
|
||||
import org.alfresco.cmis.CmisWrapper;
|
||||
import org.apache.chemistry.opencmis.client.api.CmisObject;
|
||||
import org.apache.chemistry.opencmis.client.api.Document;
|
||||
import org.apache.chemistry.opencmis.client.api.OperationContext;
|
||||
import org.testng.Assert;
|
||||
|
||||
/**
|
||||
* DSL utility for verifying a document version {@link Document}
|
||||
*/
|
||||
public class DocumentVersioning
|
||||
{
|
||||
private CmisWrapper cmisWrapper;
|
||||
private CmisObject cmisObject;
|
||||
private boolean majorVersion;
|
||||
private Object versionLabel;
|
||||
private List<Object> versions;
|
||||
|
||||
public DocumentVersioning(CmisWrapper cmisWrapper, CmisObject cmisObject)
|
||||
{
|
||||
this.cmisWrapper = cmisWrapper;
|
||||
this.cmisObject = cmisObject;
|
||||
}
|
||||
|
||||
private DocumentVersioning withLatestMajorVersion()
|
||||
{
|
||||
this.majorVersion = true;
|
||||
return this;
|
||||
}
|
||||
|
||||
private DocumentVersioning withLatestMinorVersion()
|
||||
{
|
||||
this.majorVersion = false;
|
||||
return this;
|
||||
}
|
||||
|
||||
private Document getVersionOfDocument()
|
||||
{
|
||||
Document document = (Document) cmisObject;
|
||||
if (versionLabel != null)
|
||||
{
|
||||
List<Document> documents = document.getAllVersions();
|
||||
for (Document documentVersion : documents)
|
||||
if (documentVersion.getVersionLabel().equals(versionLabel.toString()))
|
||||
return documentVersion;
|
||||
}
|
||||
else
|
||||
{
|
||||
return document.getObjectOfLatestVersion(majorVersion);
|
||||
}
|
||||
return document;
|
||||
}
|
||||
|
||||
private List<Object> getDocumentVersions(List<Document> documentList)
|
||||
{
|
||||
List<Object> versions = new ArrayList<Object>();
|
||||
for (Document document : documentList)
|
||||
{
|
||||
versions.add(document.getVersionLabel());
|
||||
}
|
||||
return versions;
|
||||
}
|
||||
|
||||
public CmisWrapper assertVersionIs(Double expectedVersion)
|
||||
{
|
||||
STEP(String.format("%s Verify if document '%s' has version '%s'", cmisWrapper.getProtocolName(), cmisObject.getName(), expectedVersion));
|
||||
Assert.assertEquals(getVersionOfDocument().getVersionLabel(), expectedVersion.toString(), "File has version");
|
||||
return cmisWrapper;
|
||||
}
|
||||
|
||||
public CmisWrapper assertLatestMajorVersionIs(Double expectedVersion)
|
||||
{
|
||||
STEP(String.format("%s Verify if latest major version of document '%s' is '%s'", cmisWrapper.getProtocolName(), cmisObject.getName(), expectedVersion));
|
||||
Assert.assertEquals(withLatestMajorVersion().getVersionOfDocument().getVersionLabel(), expectedVersion.toString(), "File has version");
|
||||
return cmisWrapper;
|
||||
}
|
||||
|
||||
public CmisWrapper assertLatestMinorVersionIs(Double expectedVersion)
|
||||
{
|
||||
STEP(String.format("%s Verify if latest minor version of document '%s' is '%s'", cmisWrapper.getProtocolName(), cmisObject.getName(), expectedVersion));
|
||||
Assert.assertEquals(withLatestMinorVersion().getVersionOfDocument().getVersionLabel(), expectedVersion.toString(), "File has version");
|
||||
return cmisWrapper;
|
||||
}
|
||||
|
||||
public DocumentVersioning getAllDocumentVersions()
|
||||
{
|
||||
setVersions(getDocumentVersions(cmisWrapper.withCMISUtil().getAllDocumentVersions()));
|
||||
return this;
|
||||
}
|
||||
|
||||
public CmisWrapper assertHasVersions(Object... versions)
|
||||
{
|
||||
setVersions(getDocumentVersions(cmisWrapper.withCMISUtil().getAllDocumentVersions()));
|
||||
List<Object> documentVersions = getVersions();
|
||||
for (Object version : versions)
|
||||
{
|
||||
STEP(String.format("%s Verify if document '%s' has version '%s'", cmisWrapper.getProtocolName(), cmisObject.getName(), version));
|
||||
Assert.assertTrue(documentVersions.contains(version.toString()),
|
||||
String.format("Document %s does not have version %s", cmisObject.getName(), version));
|
||||
}
|
||||
return cmisWrapper;
|
||||
}
|
||||
|
||||
public DocumentVersioning getAllDocumentVersionsBy(OperationContext context)
|
||||
{
|
||||
setVersions(getDocumentVersions(cmisWrapper.withCMISUtil().getAllDocumentVersionsBy(context)));
|
||||
return this;
|
||||
}
|
||||
|
||||
public CmisWrapper assertHasVersionsInOrder(Object... versions)
|
||||
{
|
||||
List<Object> documentVersions = getVersions();
|
||||
List<Object> expectedVersions = Arrays.asList(versions);
|
||||
STEP(String.format("%s Verify if document '%s' has versions in this order '%s'", cmisWrapper.getProtocolName(), cmisObject.getName(),
|
||||
Arrays.toString(expectedVersions.toArray())));
|
||||
Assert.assertTrue(documentVersions.toString().equals(expectedVersions.toString()),
|
||||
String.format("Document %s does not have versions in this order %s", cmisObject.getName(), Arrays.toString(expectedVersions.toArray())));
|
||||
return cmisWrapper;
|
||||
}
|
||||
|
||||
public List<Object> getVersions()
|
||||
{
|
||||
return versions;
|
||||
}
|
||||
|
||||
public void setVersions(List<Object> versions)
|
||||
{
|
||||
this.versions = versions;
|
||||
}
|
||||
}
|
@@ -0,0 +1,39 @@
|
||||
package org.alfresco.cmis.dsl;
|
||||
|
||||
import org.alfresco.cmis.CmisWrapper;
|
||||
import org.alfresco.utility.network.Jmx;
|
||||
import org.alfresco.utility.network.JmxClient;
|
||||
import org.alfresco.utility.network.JmxJolokiaProxyClient;
|
||||
|
||||
/**
|
||||
* DSL for interacting with JMX (using direct JMX call see {@link JmxClient} or {@link JmxJolokiaProxyClient}
|
||||
*/
|
||||
public class JmxUtil
|
||||
{
|
||||
@SuppressWarnings("unused")
|
||||
private CmisWrapper cmisWrapper;
|
||||
private Jmx jmx;
|
||||
private final String jmxAuditObjectName = "Alfresco:Type=Configuration,Category=Audit,id1=default";
|
||||
|
||||
public JmxUtil(CmisWrapper cmisWrapper, Jmx jmx)
|
||||
{
|
||||
this.cmisWrapper = cmisWrapper;
|
||||
this.jmx = jmx;
|
||||
}
|
||||
|
||||
public void enableCMISAudit() throws Exception
|
||||
{
|
||||
if(jmx.readProperty(jmxAuditObjectName, "audit.enabled").equals(String.valueOf(false)))
|
||||
{
|
||||
jmx.writeProperty(jmxAuditObjectName, "audit.enabled", String.valueOf(true));
|
||||
}
|
||||
jmx.writeProperty(jmxAuditObjectName, "audit.cmischangelog.enabled", String.valueOf(true));
|
||||
jmx.writeProperty(jmxAuditObjectName, "audit.alfresco-access.enabled", String.valueOf(true));
|
||||
}
|
||||
|
||||
public void disableCMISAudit() throws Exception
|
||||
{
|
||||
jmx.writeProperty(jmxAuditObjectName, "audit.cmischangelog.enabled", String.valueOf(false));
|
||||
jmx.writeProperty(jmxAuditObjectName, "audit.alfresco-access.enabled", String.valueOf(false));
|
||||
}
|
||||
}
|
@@ -0,0 +1,287 @@
|
||||
package org.alfresco.cmis.dsl;
|
||||
|
||||
import static java.util.stream.Collectors.joining;
|
||||
import static java.util.stream.Collectors.toList;
|
||||
import static java.util.stream.Collectors.toSet;
|
||||
|
||||
import static org.alfresco.utility.Utility.checkObjectIsInitialized;
|
||||
import static org.alfresco.utility.report.log.Step.STEP;
|
||||
|
||||
import java.math.BigDecimal;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
import java.util.Set;
|
||||
import java.util.function.Function;
|
||||
import java.util.stream.StreamSupport;
|
||||
|
||||
import org.alfresco.cmis.CmisWrapper;
|
||||
import org.alfresco.utility.LogFactory;
|
||||
import org.alfresco.utility.data.provider.XMLTestData;
|
||||
import org.alfresco.utility.exception.TestConfigurationException;
|
||||
import org.alfresco.utility.model.FileModel;
|
||||
import org.alfresco.utility.model.FolderModel;
|
||||
import org.alfresco.utility.model.SiteModel;
|
||||
import org.alfresco.utility.model.TestModel;
|
||||
import org.apache.chemistry.opencmis.client.api.ItemIterable;
|
||||
import org.apache.chemistry.opencmis.client.api.QueryResult;
|
||||
import org.apache.chemistry.opencmis.client.api.Session;
|
||||
import org.apache.chemistry.opencmis.commons.data.PropertyData;
|
||||
import org.slf4j.Logger;
|
||||
import org.testng.Assert;
|
||||
|
||||
/**
|
||||
* DSL for CMIS Queries
|
||||
* This will also handle execution of CMIS queries
|
||||
*/
|
||||
public class QueryExecutor
|
||||
{
|
||||
static Logger LOG = LogFactory.getLogger();
|
||||
|
||||
CmisWrapper cmisWrapper;
|
||||
private long resultCount = -1;
|
||||
private String currentQuery = "";
|
||||
private List<QueryResult> results;
|
||||
|
||||
public QueryExecutor(CmisWrapper cmisWrapper, String query)
|
||||
{
|
||||
this.cmisWrapper = cmisWrapper;
|
||||
currentQuery = query;
|
||||
}
|
||||
|
||||
public QueryResultAssertion assertResultsCount()
|
||||
{
|
||||
resultCount = executeQuery(currentQuery).getPageNumItems();
|
||||
return new QueryResultAssertion();
|
||||
}
|
||||
|
||||
public QueryResultAssertion assertColumnIsOrdered()
|
||||
{
|
||||
return assertValues();
|
||||
}
|
||||
|
||||
public QueryResultAssertion assertColumnValuesRange()
|
||||
{
|
||||
return assertValues();
|
||||
}
|
||||
|
||||
public QueryResultAssertion assertValues()
|
||||
{
|
||||
STEP("Sending query " + currentQuery);
|
||||
results = StreamSupport.stream(executeQuery(currentQuery).spliterator(), false)
|
||||
.collect(toList());
|
||||
resultCount = results.size();
|
||||
STEP("Received results " + results.stream().map(this::resultToString).collect(toList()));
|
||||
return new QueryResultAssertion();
|
||||
}
|
||||
|
||||
/** Try to return a useful string representation of the CMIS query result. */
|
||||
private String resultToString(QueryResult result)
|
||||
{
|
||||
if (result == null || result.getProperties() == null)
|
||||
{
|
||||
return "null";
|
||||
}
|
||||
Optional<PropertyData<?>> idProperty = result.getProperties().stream()
|
||||
.filter(propertyData -> propertyData.getId().equals("cmis:objectId"))
|
||||
.findFirst();
|
||||
return idProperty.map(PropertyData::getValues)
|
||||
.map(values -> values.stream().map(Object::toString).collect(joining(",")))
|
||||
.orElse(result.getProperties().toString());
|
||||
}
|
||||
|
||||
private ItemIterable<QueryResult> executeQuery(String query)
|
||||
{
|
||||
Session session = cmisWrapper.getSession();
|
||||
checkObjectIsInitialized(session, "You need to authenticate first using <cmisWrapper.authenticateUser(UserModel userModel)>");
|
||||
|
||||
return session.query(query, false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Call getNodeRef on each test data item used in test and replace that with NODE_REF keywords in your Query
|
||||
*
|
||||
* @param testData
|
||||
* @return
|
||||
*/
|
||||
public QueryExecutor applyNodeRefsFrom(XMLTestData testData)
|
||||
{
|
||||
List<String> dataItems = extractKeywords("NODE_REF");
|
||||
if (dataItems.isEmpty())
|
||||
return this;
|
||||
|
||||
List<String> nodeRefs = new ArrayList<String>();
|
||||
for (String dataItemName : dataItems)
|
||||
{
|
||||
currentQuery = currentQuery.replace(String.format("NODE_REF[%s]", dataItemName), "%s");
|
||||
TestModel model = testData.getTestDataItemWithId(dataItemName).getModel();
|
||||
if (model == null)
|
||||
throw new TestConfigurationException("No TestData with ID: " + dataItemName + " found in your XML file.");
|
||||
|
||||
if (model instanceof SiteModel)
|
||||
{
|
||||
nodeRefs.add(cmisWrapper.getDataContentService().usingAdmin().usingSite((SiteModel) model).getNodeRef());
|
||||
}
|
||||
else if (model instanceof FolderModel)
|
||||
{
|
||||
nodeRefs.add(((FolderModel) model).getNodeRef());
|
||||
}
|
||||
else if (model instanceof FileModel)
|
||||
{
|
||||
nodeRefs.add(((FileModel) model).getNodeRef());
|
||||
}
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
currentQuery = String.format(currentQuery, nodeRefs.toArray());
|
||||
LOG.info("Injecting nodeRef IDs \n\tQuery: [{}]", currentQuery);
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
throw new TestConfigurationException(
|
||||
"You passed multiple keywords to your search query, please re-analyze your query search format: " + e.getMessage());
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* if you have in your search 'SELECT * from cmis:document where workspace://SpacesStore/NODE_REF[site1] or workspace://SpacesStore/NODE_REF[site2]'
|
||||
* and pass key="NODE_REF" this method will get "site1" and "site2" as values
|
||||
*
|
||||
* @param key
|
||||
* @return
|
||||
* @throws TestConfigurationException
|
||||
*/
|
||||
private List<String> extractKeywords(String key) throws TestConfigurationException
|
||||
{
|
||||
String[] lines = currentQuery.split(key);
|
||||
List<String> keywords = new ArrayList<String>();
|
||||
|
||||
for (int i = 0; i < lines.length; i++)
|
||||
{
|
||||
if (lines[i].startsWith("["))
|
||||
{
|
||||
String keyValue = "";
|
||||
for (int j = 1; j < lines[i].length() - 1; j++)
|
||||
{
|
||||
String tmp = Character.toString(lines[i].charAt(j));
|
||||
if (tmp.equals("]"))
|
||||
break;
|
||||
keyValue += tmp;
|
||||
}
|
||||
keywords.add(keyValue);
|
||||
}
|
||||
}
|
||||
return keywords;
|
||||
}
|
||||
|
||||
public class QueryResultAssertion
|
||||
{
|
||||
public QueryResultAssertion hasLength(long expectedValue)
|
||||
{
|
||||
STEP(String.format("Verify that query: '%s' has %d results count returned", currentQuery, expectedValue));
|
||||
Assert.assertEquals(resultCount, expectedValue, showErrorMessage());
|
||||
return this;
|
||||
}
|
||||
|
||||
public QueryResultAssertion isGreaterThan(long expectedValue)
|
||||
{
|
||||
STEP(String.format("Verify that query: '%s' has more than %d results count returned", currentQuery, expectedValue));
|
||||
if (expectedValue <= resultCount)
|
||||
Assert.fail(String.format("%s expected to have more than %d results, but found %d", showErrorMessage(), expectedValue, resultCount));
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
public QueryResultAssertion isLowerThan(long expectedValue)
|
||||
{
|
||||
STEP(String.format("Verify that query: '%s' has more than %d results count returned", currentQuery, expectedValue));
|
||||
if (resultCount >= expectedValue)
|
||||
Assert.fail(String.format("%s expected to have less than %d results, but found %d", showErrorMessage(), expectedValue, resultCount));
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
public QueryResultAssertion isOrderedAsc(String queryName)
|
||||
{
|
||||
STEP(String.format("Verify that query: '%s' is returning ascending ordered values for column %s", currentQuery, queryName));
|
||||
List<Object> columnValues = new ArrayList<>();
|
||||
results.forEach((r) -> {
|
||||
columnValues.add(r.getPropertyValueByQueryName(queryName));
|
||||
});
|
||||
List<Object> orderedColumnValues = columnValues.stream().sorted().collect(toList());
|
||||
Assert.assertEquals(columnValues, orderedColumnValues,
|
||||
String.format("%s column values expected to be in ascendent order, but found %s", queryName, columnValues.toString()));
|
||||
|
||||
return this;
|
||||
|
||||
}
|
||||
|
||||
public QueryResultAssertion isOrderedDesc(String queryName)
|
||||
{
|
||||
STEP(String.format("Verify that query: '%s' is returning descending ordered values for column %s", currentQuery, queryName));
|
||||
List<Object> columnValues = new ArrayList<>();
|
||||
results.forEach((r) -> {
|
||||
columnValues.add(r.getPropertyValueByQueryName(queryName));
|
||||
});
|
||||
List<Object> reverseOrderedColumnValues = columnValues.stream().sorted(Collections.reverseOrder()).collect(toList());
|
||||
Assert.assertEquals(columnValues, reverseOrderedColumnValues,
|
||||
String.format("%s column values expected to be in descendent order, but found %s", queryName, columnValues.toString()));
|
||||
|
||||
return this;
|
||||
|
||||
}
|
||||
|
||||
public QueryResultAssertion isReturningValuesInRange(String queryName, BigDecimal minValue, BigDecimal maxValue)
|
||||
{
|
||||
STEP(String.format("Verify that query: '%s' is returning values for column %s in range from %.4f to %.4f", currentQuery, queryName, minValue, maxValue));
|
||||
results.forEach((r) -> {
|
||||
BigDecimal value = (BigDecimal) r.getPropertyValueByQueryName(queryName);
|
||||
if (value.compareTo(minValue) < 0 || value.compareTo(maxValue) > 0)
|
||||
{
|
||||
Assert.fail(String.format("%s column values expected to be in range from %.4f to %.4f, but found %.4f", queryName, minValue, maxValue, value));
|
||||
}
|
||||
});
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
public <T> QueryResultAssertion isReturningValues(String queryName, Set<T> values)
|
||||
{
|
||||
return isReturningValues(queryName, values, false);
|
||||
}
|
||||
|
||||
public <T> QueryResultAssertion isReturningValues(String queryName, Set<T> values, boolean multivalue)
|
||||
{
|
||||
STEP(String.format("Verify that query: '%s' returns the values from %s for column %s", currentQuery, values, queryName));
|
||||
Function<QueryResult, Object> extractValue = (multivalue ? (r -> r.getPropertyMultivalueById(queryName)) : r -> r.getPropertyValueById(queryName));
|
||||
Set<Object> resultSet = results.stream().map(extractValue).collect(toSet());
|
||||
Assert.assertEquals(resultSet, values, "Values did not match - expected " + values + " got " + resultSet);
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
public <T> QueryResultAssertion isReturningOrderedValues(String queryName, List<T> values)
|
||||
{
|
||||
return isReturningOrderedValues(queryName, values, false);
|
||||
}
|
||||
|
||||
public <T> QueryResultAssertion isReturningOrderedValues(String queryName, List<T> values, boolean multivalue)
|
||||
{
|
||||
STEP(String.format("Verify that query: '%s' returns the values from %s for column %s", currentQuery, values, queryName));
|
||||
Function<QueryResult, Object> extractValue = (multivalue ? (r -> r.getPropertyMultivalueById(queryName)) : r -> r.getPropertyValueById(queryName));
|
||||
List<Object> resultList = results.stream().map(extractValue).collect(toList());
|
||||
// Include both lists in assertion message as TestNG does not provide this information.
|
||||
Assert.assertEquals(resultList, values, "Values did not match expected " + values + " but found " + resultList);
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
private String showErrorMessage()
|
||||
{
|
||||
return String.format("Returned results count of Query [%s] is not the expected one:", currentQuery);
|
||||
}
|
||||
}
|
||||
}
|
@@ -0,0 +1,10 @@
|
||||
package org.alfresco.cmis.exception;
|
||||
|
||||
public class InvalidCmisObjectException extends RuntimeException
|
||||
{
|
||||
private static final long serialVersionUID = 1L;
|
||||
public InvalidCmisObjectException(String reason)
|
||||
{
|
||||
super(reason);
|
||||
}
|
||||
}
|
@@ -0,0 +1,12 @@
|
||||
package org.alfresco.cmis.exception;
|
||||
|
||||
public class UnrecognizedBinding extends Exception
|
||||
{
|
||||
private static final long serialVersionUID = 1L;
|
||||
private static final String DEFAULT_MESSAGE = "Unrecognized CMIS Binding [%s]. Available binding options: BROWSER or ATOM";
|
||||
|
||||
public UnrecognizedBinding(String binding)
|
||||
{
|
||||
super(String.format(DEFAULT_MESSAGE, binding));
|
||||
}
|
||||
}
|
@@ -0,0 +1,16 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<beans xmlns="http://www.springframework.org/schema/beans"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
|
||||
xsi:schemaLocation="http://www.springframework.org/schema/context
|
||||
http://www.springframework.org/schema/context/spring-context-3.0.xsd
|
||||
http://www.springframework.org/schema/beans
|
||||
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">
|
||||
|
||||
<context:annotation-config />
|
||||
<context:component-scan base-package="org.alfresco" />
|
||||
|
||||
<import resource="classpath:dataprep-context.xml" />
|
||||
<import resource="classpath*:alfresco-tester-context.xml" />
|
||||
|
||||
</beans>
|
||||
|
@@ -0,0 +1,76 @@
|
||||
# dataprep related
|
||||
alfresco.scheme=http
|
||||
alfresco.server=localhost
|
||||
alfresco.port=8081
|
||||
|
||||
# credentials
|
||||
admin.user=admin
|
||||
admin.password=admin
|
||||
|
||||
solrWaitTimeInSeconds=30
|
||||
|
||||
# in containers we cannot access directly JMX, so we will use http://jolokia.org agent
|
||||
# disabling this we will use direct JMX calls to server
|
||||
jmx.useJolokiaAgent=false
|
||||
|
||||
# Server Health section
|
||||
# in ServerHealth#isServerReachable() - could also be shown.
|
||||
# enable this option to view if on server there are tenants or not
|
||||
serverHealth.showTenants=true
|
||||
|
||||
# set CMIS binding to 'browser' or 'atom'
|
||||
cmis.binding=browser
|
||||
cmis.basePath=/alfresco/api/-default-/public/cmis/versions/1.1/${cmis.binding}
|
||||
|
||||
# TEST MANAGEMENT SECTION - Test Rail
|
||||
#
|
||||
# (currently supporting Test Rail v5.2.1.3472 integration)
|
||||
#
|
||||
# Example of configuration:
|
||||
# ------------------------------------------------------
|
||||
# if testManagement.enabled=true we enabled TestRailExecutorListener (if used in your suite xml file)
|
||||
# testManagement.updateTestExecutionResultsOnly=true (this will just update the results of a test: no step will be updated - good for performance)
|
||||
# testManagement.endPoint=https://alfresco.testrail.com/
|
||||
# testManagement.username=<username>
|
||||
# testManagement.apiKey=<api-key>
|
||||
# testManagement.project=<id-of-your-project
|
||||
# testManagement.testRun=<test-run-name>
|
||||
# testManagement.includeOnlyTestCasesExecuted=true #if you want to include in your run ONLY the test cases that you run, then set this value to false
|
||||
# testManagement.rateLimitInSeconds=1 #is the default rate limit after what minimum time, should we upload the next request. http://docs.gurock.com/testrail-api2/introduction #Rate Limit
|
||||
# testManagement.suiteId=23 (the id of the Master suite)
|
||||
# ------------------------------------------------------
|
||||
testManagement.enabled=false
|
||||
testManagement.endPoint=
|
||||
testManagement.username=
|
||||
testManagement.apiKey=
|
||||
testManagement.project=7
|
||||
testManagement.includeOnlyTestCasesExecuted=true
|
||||
testManagement.rateLimitInSeconds=1
|
||||
testManagement.testRun=MyTestRunInTestRail
|
||||
testManagement.suiteId=12
|
||||
|
||||
# The location of the reports path
|
||||
reports.path=./target/reports
|
||||
|
||||
#
|
||||
# Database Section
|
||||
# You should provide here the database URL, that can be a differed server as alfresco.
|
||||
# https://docs.oracle.com/javase/tutorial/jdbc/basics/connecting.html
|
||||
#
|
||||
# Current supported db.url:
|
||||
#
|
||||
# MySQL:
|
||||
# db.url = jdbc:mysql://${alfresco.server}:3306/alfresco
|
||||
#
|
||||
# PostgreSQL:
|
||||
# db.url = jdbc:postgresql://<your-DB-IP>:3306/alfresco
|
||||
#
|
||||
# Oracle:
|
||||
# db.url = jdbc:oracle://<your-DB-IP>:3306/alfresco
|
||||
#
|
||||
# MariaDB:
|
||||
# db.url = jdbc:mariadb://<your-DB-IP>:3306/alfresco
|
||||
#
|
||||
db.url = jdbc:mysql://${alfresco.server}:3306/alfresco
|
||||
db.username = alfresco
|
||||
db.password = alfresco
|
26
packaging/tests/tas-cmis/src/main/resources/log4j.properties
Normal file
26
packaging/tests/tas-cmis/src/main/resources/log4j.properties
Normal file
@@ -0,0 +1,26 @@
|
||||
# Root logger option
|
||||
log4j.rootLogger=INFO, file, stdout
|
||||
|
||||
# Direct log messages to a log file
|
||||
log4j.appender.file=org.apache.log4j.RollingFileAppender
|
||||
log4j.appender.file.File=./target/reports/alfresco-tas.log
|
||||
log4j.appender.file.MaxBackupIndex=10
|
||||
log4j.appender.file.layout=org.apache.log4j.PatternLayout
|
||||
log4j.appender.file.layout.ConversionPattern=[%t] %d{HH:mm:ss} %-5p %c{1}:%L - %m%n
|
||||
|
||||
# Direct log messages to stdout
|
||||
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
|
||||
log4j.appender.stdout.Target=System.out
|
||||
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
|
||||
log4j.appender.stdout.layout.ConversionPattern=[%t] %d{HH:mm:ss} %-5p %c{1}:%L - %m%n
|
||||
|
||||
# TestRail particular log file
|
||||
# Direct log messages to a log file
|
||||
log4j.appender.testrailLog=org.apache.log4j.RollingFileAppender
|
||||
log4j.appender.testrailLog.File=./target/reports/alfresco-testrail.log
|
||||
log4j.appender.testrailLog.MaxBackupIndex=10
|
||||
log4j.appender.testrailLog.layout=org.apache.log4j.PatternLayout
|
||||
log4j.appender.testrailLog.layout.ConversionPattern=%d{HH:mm:ss} %-5p %c{1}:%L - %m%n
|
||||
|
||||
log4j.category.testrail=INFO, testrailLog
|
||||
log4j.additivity.testrail=false
|
@@ -1,9 +1,21 @@
|
||||
package org.alfresco.cmis.search;
|
||||
|
||||
import static java.util.stream.Collectors.toList;
|
||||
import static java.util.stream.Collectors.toSet;
|
||||
|
||||
import static org.alfresco.utility.report.log.Step.STEP;
|
||||
|
||||
import java.lang.reflect.Method;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
import java.util.function.Consumer;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import org.alfresco.cmis.CmisProperties;
|
||||
import org.alfresco.cmis.dsl.QueryExecutor.QueryResultAssertion;
|
||||
import org.alfresco.utility.Utility;
|
||||
import org.alfresco.utility.model.ContentModel;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
@@ -45,32 +57,76 @@ public abstract class AbstractCmisE2ETest extends AbstractE2EFunctionalTest
|
||||
/**
|
||||
* Repeat Elastic Query till results count returns expectedCountResults
|
||||
* @param query CMIS Query to be executed
|
||||
* @param expectedCountResults Number of results expected
|
||||
* @param expectedResultsCount Number of results expected
|
||||
* @return true when results count is equals to expectedCountResults
|
||||
*/
|
||||
protected boolean waitForIndexing(String query, long expectedCountResults)
|
||||
protected boolean waitForIndexing(String query, long expectedResultsCount)
|
||||
{
|
||||
|
||||
for (int searchCount = 1; searchCount <= SEARCH_MAX_ATTEMPTS; searchCount++)
|
||||
try
|
||||
{
|
||||
waitForIndexing(query, execution -> execution.hasLength(expectedResultsCount));
|
||||
return true;
|
||||
}
|
||||
catch (AssertionError ae)
|
||||
{
|
||||
STEP("Received assertion error for query '" + query + "': " + ae);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Repeat Elastic Query until we get the expected results or we hit the retry limit.
|
||||
*
|
||||
* @param query CMIS Query to be executed
|
||||
* @param expectedResults The expected results (unordered).
|
||||
*/
|
||||
protected void waitForIndexing(String query, ContentModel... expectedResults)
|
||||
{
|
||||
Set<String> expectedNames = Arrays.stream(expectedResults).map(ContentModel::getName).collect(toSet());
|
||||
waitForIndexing(query, execution -> execution.isReturningValues("cmis:name", expectedNames));
|
||||
}
|
||||
|
||||
/**
|
||||
* Repeat Elastic Query until we get the expected results in the given order or we hit the retry limit.
|
||||
*
|
||||
* @param query CMIS Query to be executed
|
||||
* @param expectedResults The expected results (ordered).
|
||||
*/
|
||||
protected void waitForIndexingOrdered(String query, ContentModel... expectedResults)
|
||||
{
|
||||
List<String> expectedNames = Arrays.stream(expectedResults).map(ContentModel::getName).collect(toList());
|
||||
waitForIndexing(query, execution -> execution.isReturningOrderedValues("cmis:name", expectedNames));
|
||||
}
|
||||
|
||||
/**
|
||||
* Repeat Elastic Query until we get the expected results or we hit the retry limit.
|
||||
*
|
||||
* @param query CMIS Query to be executed
|
||||
* @param assertionMethod A method that will be called to check the response and which will throw an AssertionError if they aren't what we want.
|
||||
*/
|
||||
protected void waitForIndexing(String query, Consumer<QueryResultAssertion> assertionMethod)
|
||||
{
|
||||
int searchCount = 0;
|
||||
while (true)
|
||||
{
|
||||
try
|
||||
{
|
||||
cmisApi.withQuery(query).assertResultsCount().equals(expectedCountResults);
|
||||
return true;
|
||||
assertionMethod.accept(cmisApi.withQuery(query).assertValues());
|
||||
return;
|
||||
}
|
||||
catch (AssertionError ae)
|
||||
{
|
||||
LOGGER.info(String.format("WaitForIndexing in Progress: %s", ae));
|
||||
searchCount++;
|
||||
if (searchCount < SEARCH_MAX_ATTEMPTS)
|
||||
{
|
||||
LOGGER.info(String.format("WaitForIndexing in Progress: %s", ae));
|
||||
Utility.waitToLoopTime(getElasticWaitTimeInSeconds(), "Wait For Indexing");
|
||||
}
|
||||
else
|
||||
{
|
||||
throw ae;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Utility.waitToLoopTime(getElasticWaitTimeInSeconds(), "Wait For Indexing");
|
||||
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
@@ -1,12 +1,12 @@
|
||||
package org.alfresco.cmis.search;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
|
||||
import org.alfresco.utility.Utility;
|
||||
import org.alfresco.utility.data.provider.XMLDataConfig;
|
||||
import org.alfresco.utility.data.provider.XMLTestDataProvider;
|
||||
import org.alfresco.utility.model.FileModel;
|
||||
import org.alfresco.utility.model.FileType;
|
||||
import org.alfresco.utility.model.FolderModel;
|
||||
import org.alfresco.utility.model.QueryModel;
|
||||
import org.testng.Assert;
|
||||
import org.testng.annotations.AfterClass;
|
||||
import org.testng.annotations.BeforeClass;
|
||||
@@ -17,6 +17,21 @@ public class SearchInFolderTests extends AbstractCmisE2ETest
|
||||
private FolderModel parentFolder, subFolder1, subFolder2, subFolder3;
|
||||
private FileModel subFile1, subFile2, subFile3, subFile4, subFile5;
|
||||
|
||||
/**
|
||||
* Create test data in the following format:
|
||||
* <pre>
|
||||
* testSite
|
||||
* +- parentFolder
|
||||
* +- subFile5 (fifthFile.txt: "fifthFile content")
|
||||
* +- subFolder1
|
||||
* +- subFolder2
|
||||
* +- subFolder3 (subFolder)
|
||||
* +- subFile1 (firstFile.xls)
|
||||
* +- subFile2 (.pptx)
|
||||
* +- subFile3 (.txt)
|
||||
* +- subFile4 (fourthFile.docx: "fourthFileTitle", "fourthFileDescription")
|
||||
* </pre>
|
||||
*/
|
||||
@BeforeClass(alwaysRun = true)
|
||||
public void createTestData() throws Exception
|
||||
{
|
||||
@@ -51,12 +66,164 @@ public class SearchInFolderTests extends AbstractCmisE2ETest
|
||||
dataContent.deleteSite(testSite);
|
||||
}
|
||||
|
||||
@Test(dataProviderClass = XMLTestDataProvider.class, dataProvider = "getQueriesData")
|
||||
@XMLDataConfig(file = "src/test/resources/search-in-folder.xml")
|
||||
public void executeCMISQuery(QueryModel query)
|
||||
@Test
|
||||
public void executeCMISQuery_selectFieldsFromFolder()
|
||||
{
|
||||
String currentQuery = String.format(query.getValue(), parentFolder.getNodeRef());
|
||||
String query = "SELECT cmis:name, cmis:parentId, cmis:path, cmis:allowedChildObjectTypeIds" +
|
||||
" FROM cmis:folder where IN_FOLDER('%s') AND cmis:name = 'subFolder'";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
Assert.assertTrue(waitForIndexing(currentQuery, query.getResults()), String.format("Result count not as expected for query: %s", currentQuery));
|
||||
waitForIndexing(currentQuery, subFolder3);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void executeCMISQuery_selectFieldsFromDocument()
|
||||
{
|
||||
String query = "SELECT cmis:name, cmis:objectId, cmis:lastModifiedBy, cmis:creationDate, cmis:contentStreamFileName" +
|
||||
" FROM cmis:document where IN_FOLDER('%s') AND cmis:name = 'fourthFile'";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
waitForIndexing(currentQuery, subFile4);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void executeCMISQuery_selectParentId()
|
||||
{
|
||||
String query = "SELECT cmis:parentId FROM cmis:folder where IN_FOLDER('%s')";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
// Expect to get the same parent for each of the three matches.
|
||||
String parentId = parentFolder.getNodeRef();
|
||||
List<String> expectedParentIds = List.of(parentId, parentId, parentId);
|
||||
waitForIndexing(currentQuery, execution -> execution.isReturningOrderedValues("cmis:parentId", expectedParentIds));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void executeCMISQuery_inFolder()
|
||||
{
|
||||
String query = "SELECT * FROM cmis:document where IN_FOLDER('%s')";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
waitForIndexing(currentQuery, subFile1, subFile2, subFile3, subFile4, subFile5);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void executeCMISQuery_orderByNameAsc()
|
||||
{
|
||||
String query = "SELECT * FROM cmis:document where IN_FOLDER('%s') AND cmis:name NOT LIKE 'file%%' ORDER BY cmis:name ASC";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
waitForIndexingOrdered(currentQuery, subFile5, subFile1, subFile4);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void executeCMISQuery_orderByNameDesc()
|
||||
{
|
||||
String query = "SELECT * FROM cmis:document where IN_FOLDER('%s') AND cmis:name NOT LIKE 'file%%' ORDER BY cmis:name DESC";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
waitForIndexingOrdered(currentQuery, subFile4, subFile1, subFile5);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void executeCMISQuery_orderByLastModifiedAsc()
|
||||
{
|
||||
String query = "SELECT * FROM cmis:folder where IN_FOLDER('%s') ORDER BY cmis:lastModificationDate ASC";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
waitForIndexingOrdered(currentQuery, subFolder1, subFolder2, subFolder3);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void executeCMISQuery_orderByLastModifiedDesc()
|
||||
{
|
||||
String query = "SELECT * FROM cmis:folder where IN_FOLDER('%s') ORDER BY cmis:lastModificationDate DESC";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
waitForIndexingOrdered(currentQuery, subFolder3, subFolder2, subFolder1);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void executeCMISQuery_orderByCreatedBy()
|
||||
{
|
||||
String query = "SELECT * FROM cmis:document where IN_FOLDER('%s') ORDER BY cmis:createdBy DESC";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
// All the results were created by the same user, so we can't assert anything about the order.
|
||||
waitForIndexing(currentQuery, subFile5, subFile1, subFile2, subFile3, subFile4);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void executeCMISQuery_documentNameNotNull()
|
||||
{
|
||||
String query = "SELECT * FROM cmis:document where IN_FOLDER('%s') AND cmis:name IS NOT NULL";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
waitForIndexing(currentQuery, subFile1, subFile2, subFile3, subFile4, subFile5);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void executeCMISQuery_folderNameNotNull()
|
||||
{
|
||||
String query = "SELECT * FROM cmis:folder where IN_FOLDER('%s') AND cmis:name IS NOT NULL";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
waitForIndexing(currentQuery, subFolder1, subFolder2, subFolder3);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void executeCMISQuery_nameLike()
|
||||
{
|
||||
String query = "SELECT * FROM cmis:document where IN_FOLDER('%s') AND cmis:name LIKE 'fourthFile'";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
waitForIndexingOrdered(currentQuery, subFile4);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void executeCMISQuery_doubleNegative()
|
||||
{
|
||||
String query = "SELECT * FROM cmis:folder where IN_FOLDER('%s') AND NOT(cmis:name NOT IN ('subFolder'))";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
waitForIndexingOrdered(currentQuery, subFolder3);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void executeCMISQuery_nameInList()
|
||||
{
|
||||
String query = "SELECT * FROM cmis:document where IN_FOLDER('%s') AND cmis:name IN ('fourthFile', 'fifthFile.txt')";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
waitForIndexing(currentQuery, subFile4, subFile5);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void executeCMISQuery_nameNotInList()
|
||||
{
|
||||
String query = "SELECT * FROM cmis:document where IN_FOLDER('%s') AND cmis:name NOT IN ('fourthFile', 'fifthFile.txt')";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
waitForIndexing(currentQuery, subFile1, subFile2, subFile3);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void executeCMISQuery_nameDifferentFrom()
|
||||
{
|
||||
String query = "SELECT * FROM cmis:folder where IN_FOLDER('%s') AND cmis:name <> 'subFolder'";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
waitForIndexing(currentQuery, subFolder1, subFolder2);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void executeCMISQuery_selectSecondaryObjectTypeIds()
|
||||
{
|
||||
String query = "SELECT cmis:secondaryObjectTypeIds FROM cmis:folder where IN_FOLDER('%s') AND cmis:name = 'subFolder'";
|
||||
String currentQuery = String.format(query, parentFolder.getNodeRef());
|
||||
cmisApi.authenticateUser(testUser);
|
||||
Set<List<String>> expectedSecondaryObjectTypeIds = Set.of(List.of("P:cm:titled", "P:sys:localized"));
|
||||
waitForIndexing(currentQuery, execution -> execution.isReturningValues("cmis:secondaryObjectTypeIds", expectedSecondaryObjectTypeIds, true));
|
||||
Assert.assertTrue(waitForIndexing(currentQuery, 1), String.format("Result count not as expected for query: %s", currentQuery));
|
||||
}
|
||||
}
|
||||
|
@@ -9,7 +9,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo-tests</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<developers>
|
||||
|
@@ -9,7 +9,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo-tests</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<developers>
|
||||
@@ -73,6 +73,7 @@
|
||||
<dependency>
|
||||
<groupId>org.alfresco.tas</groupId>
|
||||
<artifactId>cmis</artifactId>
|
||||
<version>${project.version}</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
|
||||
|
@@ -9,7 +9,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo-tests</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<developers>
|
||||
|
@@ -2,10 +2,13 @@ package org.alfresco.rest.actions;
|
||||
|
||||
import static org.testng.Assert.assertFalse;
|
||||
|
||||
import com.google.common.collect.ImmutableMap;
|
||||
import java.util.List;
|
||||
|
||||
import com.google.common.collect.ImmutableMap;
|
||||
import org.alfresco.dataprep.CMISUtil;
|
||||
import org.alfresco.rest.RestTest;
|
||||
import org.alfresco.rest.model.RestActionConstraintDataModel;
|
||||
import org.alfresco.rest.model.RestActionConstraintModel;
|
||||
import org.alfresco.rest.model.RestActionDefinitionModel;
|
||||
import org.alfresco.rest.model.RestActionDefinitionModelsCollection;
|
||||
import org.alfresco.rest.model.RestNodeModel;
|
||||
@@ -148,4 +151,66 @@ public class ActionsTests extends RestTest
|
||||
restActionDefinition.getDescription().equals("This will add an aspect to the matched item.");
|
||||
restActionDefinition.getTitle().equals("Add aspect");
|
||||
}
|
||||
|
||||
@TestRail(section = {TestGroup.REST_API, TestGroup.ACTIONS}, executionType = ExecutionType.SANITY,
|
||||
description = "Sanity test for ACTIONS endpoint GET action-conditions/{actionConstraintName}")
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.ACTIONS, TestGroup.SANITY})
|
||||
public void testGetSingleActionConstraint()
|
||||
{
|
||||
final UserModel testUser = dataUser.createRandomTestUser();
|
||||
restClient.authenticateUser(testUser);
|
||||
|
||||
final String compareOperationsName = "ac-compare-operations";
|
||||
final RestActionConstraintModel actionConstraintCompareOperations =
|
||||
restClient.withCoreAPI().usingActions().getActionConstraintByName(compareOperationsName);
|
||||
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
|
||||
final RestActionConstraintModel expectedComparatorConstraints = new RestActionConstraintModel();
|
||||
expectedComparatorConstraints.setConstraintName(compareOperationsName);
|
||||
expectedComparatorConstraints.setConstraintValues(getComparatorConstraints());
|
||||
actionConstraintCompareOperations.assertThat().isEqualTo(expectedComparatorConstraints);
|
||||
}
|
||||
|
||||
@TestRail(section = {TestGroup.REST_API, TestGroup.ACTIONS}, executionType = ExecutionType.SANITY,
|
||||
description = "Sanity test for ACTIONS endpoint GET action-conditions/{actionConstraintName} - non existing constraint name")
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.ACTIONS, TestGroup.SANITY})
|
||||
public void testGetSingleNonExistingActionConstraint()
|
||||
{
|
||||
final UserModel testUser = dataUser.createRandomTestUser();
|
||||
restClient.authenticateUser(testUser);
|
||||
restClient.withCoreAPI().usingActions().getActionConstraintByName("dummy-name");
|
||||
|
||||
restClient.assertStatusCodeIs(HttpStatus.NOT_FOUND);
|
||||
}
|
||||
|
||||
private List<RestActionConstraintDataModel> getComparatorConstraints()
|
||||
{
|
||||
final RestActionConstraintDataModel equalsConstraint = new RestActionConstraintDataModel();
|
||||
equalsConstraint.setValue("EQUALS");
|
||||
equalsConstraint.setLabel("Equals");
|
||||
final RestActionConstraintDataModel containsConstraint = new RestActionConstraintDataModel();
|
||||
containsConstraint.setValue("CONTAINS");
|
||||
containsConstraint.setLabel("Contains");
|
||||
final RestActionConstraintDataModel beginsConstraint = new RestActionConstraintDataModel();
|
||||
beginsConstraint.setValue("BEGINS");
|
||||
beginsConstraint.setLabel("Begins With");
|
||||
final RestActionConstraintDataModel endsConstraint = new RestActionConstraintDataModel();
|
||||
endsConstraint.setValue("ENDS");
|
||||
endsConstraint.setLabel("Ends With");
|
||||
final RestActionConstraintDataModel greaterThanConstraint = new RestActionConstraintDataModel();
|
||||
greaterThanConstraint.setValue("GREATER_THAN");
|
||||
greaterThanConstraint.setLabel("Greater Than");
|
||||
final RestActionConstraintDataModel greaterThanEqualConstraint = new RestActionConstraintDataModel();
|
||||
greaterThanEqualConstraint.setValue("GREATER_THAN_EQUAL");
|
||||
greaterThanEqualConstraint.setLabel("Greater Than Or Equal To");
|
||||
final RestActionConstraintDataModel lessThanConstraint = new RestActionConstraintDataModel();
|
||||
lessThanConstraint.setValue("LESS_THAN");
|
||||
lessThanConstraint.setLabel("Less Than");
|
||||
final RestActionConstraintDataModel lessThanEqualConstraint = new RestActionConstraintDataModel();
|
||||
lessThanEqualConstraint.setValue("LESS_THAN_EQUAL");
|
||||
lessThanEqualConstraint.setLabel("Less Than Or Equal To");
|
||||
return List.of(equalsConstraint, containsConstraint, beginsConstraint, endsConstraint, greaterThanConstraint,
|
||||
greaterThanEqualConstraint, lessThanConstraint, lessThanEqualConstraint);
|
||||
}
|
||||
}
|
||||
|
@@ -1,21 +1,20 @@
|
||||
package org.alfresco.rest.actions.access;
|
||||
|
||||
import org.alfresco.rest.RestTest;
|
||||
import org.alfresco.utility.model.FolderModel;
|
||||
import org.alfresco.utility.model.UserModel;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.testng.annotations.BeforeClass;
|
||||
import org.testng.annotations.Test;
|
||||
|
||||
import org.alfresco.rest.core.RestWrapper;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
|
||||
import static org.alfresco.rest.actions.access.AccessRestrictionUtil.ERROR_MESSAGE_ACCESS_RESTRICTED;
|
||||
import static org.alfresco.rest.actions.access.AccessRestrictionUtil.MAIL_ACTION;
|
||||
import static org.alfresco.rest.actions.access.AccessRestrictionUtil.createMailParameters;
|
||||
import static org.hamcrest.Matchers.notNullValue;
|
||||
import static org.hamcrest.Matchers.nullValue;
|
||||
|
||||
import org.alfresco.rest.RestTest;
|
||||
import org.alfresco.rest.core.RestWrapper;
|
||||
import org.alfresco.utility.model.FolderModel;
|
||||
import org.alfresco.utility.model.UserModel;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.testng.annotations.BeforeClass;
|
||||
import org.testng.annotations.Test;
|
||||
|
||||
public class V1AdminAccessRestrictionTest extends RestTest {
|
||||
|
||||
private UserModel adminUser;
|
||||
@@ -45,7 +44,7 @@ public class V1AdminAccessRestrictionTest extends RestTest {
|
||||
.executeAction(MAIL_ACTION, testFolder, createMailParameters(adminUser, testUser));
|
||||
|
||||
restClient.onResponse()
|
||||
.assertThat().statusCode(HttpStatus.INTERNAL_SERVER_ERROR.value())
|
||||
.assertThat().statusCode(HttpStatus.FORBIDDEN.value())
|
||||
.assertThat().body("entry.id", nullValue());
|
||||
restClient.assertLastError().containsSummary(ERROR_MESSAGE_ACCESS_RESTRICTED);
|
||||
}
|
||||
|
@@ -26,8 +26,21 @@
|
||||
package org.alfresco.rest.rules;
|
||||
|
||||
import static java.util.stream.Collectors.toList;
|
||||
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.*;
|
||||
import static org.alfresco.rest.actions.access.AccessRestrictionUtil.ERROR_MESSAGE_ACCESS_RESTRICTED;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.ID;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.INVERTED;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.IS_SHARED;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.RULE_NAME_DEFAULT;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createAddAudioAspectAction;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createCompositeCondition;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createCustomActionModel;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createRuleModel;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createRuleModelWithDefaultValues;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createRuleModelWithModifiedValues;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createRuleWithPrivateAction;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createSimpleCondition;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createVariousActions;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createVariousConditions;
|
||||
import static org.alfresco.utility.constants.UserRole.SiteCollaborator;
|
||||
import static org.alfresco.utility.constants.UserRole.SiteConsumer;
|
||||
import static org.alfresco.utility.constants.UserRole.SiteContributor;
|
||||
@@ -41,8 +54,6 @@ import static org.springframework.http.HttpStatus.CREATED;
|
||||
import static org.springframework.http.HttpStatus.FORBIDDEN;
|
||||
import static org.springframework.http.HttpStatus.NOT_FOUND;
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.stream.IntStream;
|
||||
@@ -67,8 +78,6 @@ import org.testng.annotations.Test;
|
||||
@Test(groups = {TestGroup.RULES})
|
||||
public class CreateRulesTests extends RestTest
|
||||
{
|
||||
private static final String IGNORE_ID = "id";
|
||||
private static final String IGNORE_IS_SHARED = "isShared";
|
||||
private UserModel user;
|
||||
private SiteModel site;
|
||||
private FolderModel ruleFolder;
|
||||
@@ -95,11 +104,10 @@ public class CreateRulesTests extends RestTest
|
||||
.createSingleRule(ruleModel);
|
||||
|
||||
RestRuleModel expectedRuleModel = createRuleModelWithModifiedValues();
|
||||
expectedRuleModel.setConditions(createEmptyConditionModel());
|
||||
restClient.assertStatusCodeIs(CREATED);
|
||||
rule.assertThat().isEqualTo(expectedRuleModel, IGNORE_ID, IGNORE_IS_SHARED)
|
||||
.assertThat().field("id").isNotNull()
|
||||
.assertThat().field("isShared").isNull();
|
||||
rule.assertThat().isEqualTo(expectedRuleModel, ID, IS_SHARED)
|
||||
.assertThat().field(ID).isNotNull()
|
||||
.assertThat().field(IS_SHARED).isNull();
|
||||
}
|
||||
|
||||
/** Check creating a rule in a non-existent folder returns an error. */
|
||||
@@ -116,7 +124,7 @@ public class CreateRulesTests extends RestTest
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(nonExistentFolder).usingDefaultRuleSet().createSingleRule(ruleModel);
|
||||
|
||||
restClient.assertStatusCodeIs(NOT_FOUND);
|
||||
restClient.assertLastError().containsSummary("fake-id was not found");
|
||||
restClient.assertLastError().containsSummary("Folder with id fake-id was not found");
|
||||
}
|
||||
|
||||
/** Check creating a rule in a non-existent rule set returns an error. */
|
||||
@@ -130,7 +138,7 @@ public class CreateRulesTests extends RestTest
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingRuleSet("fake-id").createSingleRule(ruleModel);
|
||||
|
||||
restClient.assertStatusCodeIs(NOT_FOUND);
|
||||
restClient.assertLastError().containsSummary("fake-id was not found");
|
||||
restClient.assertLastError().containsSummary("Rule set with id fake-id was not found");
|
||||
}
|
||||
|
||||
/** Try to create a rule without a name and check the error. */
|
||||
@@ -355,7 +363,7 @@ public class CreateRulesTests extends RestTest
|
||||
STEP(String.format("Add a user with '%s' role in the private site's folder", userRole.toString()));
|
||||
UserModel userWithRole = dataUser.createRandomTestUser();
|
||||
dataUser.addUserToSite(userWithRole, privateSite, userRole);
|
||||
RestRuleModel ruleModel = createRuleModel("testRule", List.of(createDefaultActionModel()));
|
||||
RestRuleModel ruleModel = createRuleModel("testRule", List.of(createAddAudioAspectAction()));
|
||||
|
||||
return restClient.authenticateUser(userWithRole).withCoreAPI().usingNode(privateFolder).usingDefaultRuleSet().createSingleRule(ruleModel);
|
||||
}
|
||||
@@ -366,31 +374,161 @@ public class CreateRulesTests extends RestTest
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void createRuleWithActions()
|
||||
{
|
||||
final Map<String, Serializable> copyParams =
|
||||
Map.of("destination-folder", "dummy-folder-node", "deep-copy", true);
|
||||
final RestActionBodyExecTemplateModel copyAction = createCustomActionModel("copy", copyParams);
|
||||
final Map<String, Serializable> checkOutParams =
|
||||
Map.of("destination-folder", "dummy-folder-node", "assoc-name", "cm:checkout", "assoc-type",
|
||||
"cm:contains");
|
||||
final RestActionBodyExecTemplateModel checkOutAction = createCustomActionModel("check-out", checkOutParams);
|
||||
final Map<String, Serializable> scriptParams = Map.of("script-ref", "dummy-script-node-id");
|
||||
final RestActionBodyExecTemplateModel scriptAction = createCustomActionModel("script", scriptParams);
|
||||
final RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
ruleModel.setActions(Arrays.asList(copyAction, checkOutAction, scriptAction));
|
||||
|
||||
final UserModel admin = dataUser.getAdminUser();
|
||||
|
||||
final RestRuleModel rule = restClient.authenticateUser(admin).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(ruleModel);
|
||||
.createSingleRule(createVariousActions());
|
||||
|
||||
final RestRuleModel expectedRuleModel = createRuleModelWithDefaultValues();
|
||||
expectedRuleModel.setActions(Arrays.asList(copyAction, checkOutAction, scriptAction));
|
||||
expectedRuleModel.setConditions(createEmptyConditionModel());
|
||||
RestRuleModel expectedRuleModel = createRuleModelWithDefaultValues();
|
||||
expectedRuleModel.setActions(createVariousActions().getActions());
|
||||
expectedRuleModel.setTriggers(List.of("inbound"));
|
||||
|
||||
restClient.assertStatusCodeIs(CREATED);
|
||||
rule.assertThat().isEqualTo(expectedRuleModel, IGNORE_ID, IGNORE_IS_SHARED)
|
||||
.assertThat().field("isShared").isNull();
|
||||
rule.assertThat().isEqualTo(expectedRuleModel, ID, IS_SHARED)
|
||||
.assertThat().field(IS_SHARED).isNull();
|
||||
}
|
||||
|
||||
/** Check that a normal user cannot create rules that use private actions. */
|
||||
@Test
|
||||
public void createRuleWithActions_userCannotUsePrivateAction()
|
||||
{
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(createRuleWithPrivateAction());
|
||||
|
||||
restClient.assertStatusCodeIs(FORBIDDEN)
|
||||
.assertLastError().containsSummary(ERROR_MESSAGE_ACCESS_RESTRICTED);
|
||||
}
|
||||
|
||||
/** Check that an administrator can create rules that use private actions. */
|
||||
@Test
|
||||
public void createRuleWithActions_adminCanUsePrivateAction()
|
||||
{
|
||||
restClient.authenticateUser(dataUser.getAdminUser()).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(createRuleWithPrivateAction());
|
||||
|
||||
restClient.assertStatusCodeIs(CREATED);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we get error when attempt to create a rule without any actions.
|
||||
*/
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void createRuleWithoutActionsShouldFail()
|
||||
{
|
||||
final RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
ruleModel.setActions(null);
|
||||
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(ruleModel);
|
||||
|
||||
restClient.assertStatusCodeIs(BAD_REQUEST);
|
||||
restClient.assertLastError().containsSummary("A rule must have at least one action");
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we get error when attempt to create a rule with invalid action.
|
||||
*/
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void createRuleWithInvalidActionsShouldFail()
|
||||
{
|
||||
final RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
final RestActionBodyExecTemplateModel invalidAction = new RestActionBodyExecTemplateModel();
|
||||
final String actionDefinitionId = "invalid-definition-value";
|
||||
invalidAction.setActionDefinitionId(actionDefinitionId);
|
||||
invalidAction.setParams(Map.of("dummy-key", "dummy-value"));
|
||||
ruleModel.setActions(List.of(invalidAction));
|
||||
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(ruleModel);
|
||||
|
||||
restClient.assertStatusCodeIs(BAD_REQUEST);
|
||||
restClient.assertLastError().containsSummary(String.format("Invalid action definition requested %s", actionDefinitionId));
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we get error when attempt to create a rule with missing action parameters.
|
||||
*/
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void createRuleWithMissingActionParametersShouldFail()
|
||||
{
|
||||
final RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
final RestActionBodyExecTemplateModel invalidAction = new RestActionBodyExecTemplateModel();
|
||||
final String actionDefinitionId = "copy";
|
||||
invalidAction.setActionDefinitionId(actionDefinitionId);
|
||||
ruleModel.setActions(List.of(invalidAction));
|
||||
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(ruleModel);
|
||||
|
||||
restClient.assertStatusCodeIs(BAD_REQUEST);
|
||||
restClient.assertLastError().containsSummary(
|
||||
String.format("Action parameters should not be null or empty for this action. See Action Definition for action of: %s",
|
||||
actionDefinitionId));
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we get error when attempt to create a rule with parameter not fulfilling constraint.
|
||||
*/
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void createRuleWithActionParameterNotFulfillingConstraint()
|
||||
{
|
||||
final RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
final String actionDefinitionId = "script";
|
||||
final String scriptRef = "script-ref";
|
||||
final String scriptNodeId = "dummy-script-node-id";
|
||||
final RestActionBodyExecTemplateModel scriptAction = createCustomActionModel(actionDefinitionId, Map.of(scriptRef, scriptNodeId));
|
||||
ruleModel.setActions(List.of(scriptAction));
|
||||
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(ruleModel);
|
||||
|
||||
restClient.assertStatusCodeIs(BAD_REQUEST);
|
||||
final String acScriptsConstraint = "ac-scripts";
|
||||
restClient.assertLastError().containsSummary(
|
||||
String.format("Action parameter: %s has invalid value (%s). Look up possible values for constraint name %s",
|
||||
scriptRef, scriptNodeId, acScriptsConstraint));
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we get error when attempt to create a rule with action parameter that should not be passed.
|
||||
*/
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void createRuleWithoutInvalidActionParameterShouldFail()
|
||||
{
|
||||
final RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
final RestActionBodyExecTemplateModel invalidAction = new RestActionBodyExecTemplateModel();
|
||||
final String actionDefinitionId = "add-features";
|
||||
invalidAction.setActionDefinitionId(actionDefinitionId);
|
||||
final String invalidParameterKey = "invalidParameterKey";
|
||||
invalidAction.setParams(Map.of(invalidParameterKey,"dummyValue"));
|
||||
ruleModel.setActions(List.of(invalidAction));
|
||||
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(ruleModel);
|
||||
|
||||
restClient.assertStatusCodeIs(BAD_REQUEST);
|
||||
restClient.assertLastError().containsSummary(
|
||||
String.format("Action of definition id: %s must not contain parameter of name: %s", actionDefinitionId, invalidParameterKey));
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we get error when attempt to create a rule with missing mandatory action parameter.
|
||||
*/
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void createRuleWithoutMandatoryActionParametersShouldFail()
|
||||
{
|
||||
final RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
final RestActionBodyExecTemplateModel invalidAction = new RestActionBodyExecTemplateModel();
|
||||
final String actionDefinitionId = "copy";
|
||||
invalidAction.setActionDefinitionId(actionDefinitionId);
|
||||
invalidAction.setParams(Map.of("deep-copy",false));
|
||||
ruleModel.setActions(List.of(invalidAction));
|
||||
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(ruleModel);
|
||||
|
||||
restClient.assertStatusCodeIs(BAD_REQUEST);
|
||||
restClient.assertLastError().containsSummary("Missing action's mandatory parameter: destination-folder");
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -409,7 +547,7 @@ public class CreateRulesTests extends RestTest
|
||||
expectedRuleModel.setConditions(createVariousConditions());
|
||||
expectedRuleModel.setTriggers(List.of("inbound"));
|
||||
restClient.assertStatusCodeIs(CREATED);
|
||||
rule.assertThat().isEqualTo(expectedRuleModel, IGNORE_ID, IGNORE_IS_SHARED);
|
||||
rule.assertThat().isEqualTo(expectedRuleModel, ID, IS_SHARED);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -425,10 +563,9 @@ public class CreateRulesTests extends RestTest
|
||||
.createSingleRule(ruleModel);
|
||||
|
||||
RestRuleModel expectedRuleModel = createRuleModelWithDefaultValues();
|
||||
expectedRuleModel.setConditions(createCompositeCondition(null));
|
||||
expectedRuleModel.setTriggers(List.of("inbound"));
|
||||
restClient.assertStatusCodeIs(CREATED);
|
||||
rule.assertThat().isEqualTo(expectedRuleModel, IGNORE_ID, IGNORE_IS_SHARED);
|
||||
rule.assertThat().isEqualTo(expectedRuleModel, ID, IS_SHARED);
|
||||
}
|
||||
|
||||
/**
|
||||
|
@@ -0,0 +1,306 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Repository
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2022 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.rules;
|
||||
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.AUDIO_ASPECT;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.LOCKABLE_ASPECT;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.RULE_NAME_DEFAULT;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.assertThat;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createAddAspectAction;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createCustomActionModel;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createRuleExecutionRequest;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createRuleModel;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createRuleModelWithDefaultValues;
|
||||
import static org.alfresco.utility.report.log.Step.STEP;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import org.alfresco.dataprep.CMISUtil;
|
||||
import org.alfresco.rest.RestTest;
|
||||
import org.alfresco.rest.model.RestActionBodyExecTemplateModel;
|
||||
import org.alfresco.rest.model.RestNodeModel;
|
||||
import org.alfresco.rest.model.RestRuleExecutionModel;
|
||||
import org.alfresco.rest.model.RestRuleModel;
|
||||
import org.alfresco.utility.constants.UserRole;
|
||||
import org.alfresco.utility.model.FileModel;
|
||||
import org.alfresco.utility.model.FolderModel;
|
||||
import org.alfresco.utility.model.SiteModel;
|
||||
import org.alfresco.utility.model.TestGroup;
|
||||
import org.alfresco.utility.model.UserModel;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.testng.annotations.BeforeClass;
|
||||
import org.testng.annotations.BeforeMethod;
|
||||
import org.testng.annotations.Ignore;
|
||||
import org.testng.annotations.Test;
|
||||
|
||||
/**
|
||||
* Tests for POST /nodes/{nodeId}/rule-executions.
|
||||
*/
|
||||
@Test(groups = { TestGroup.RULES})
|
||||
public class ExecuteRulesTests extends RestTest
|
||||
{
|
||||
|
||||
private UserModel user;
|
||||
private SiteModel site;
|
||||
private FolderModel parentFolder;
|
||||
private FolderModel childFolder;
|
||||
private FileModel parentFolderFile;
|
||||
private FileModel childFolderFile;
|
||||
private RestRuleModel parentFolderRule;
|
||||
private RestRuleModel childFolderRule;
|
||||
|
||||
@BeforeClass(alwaysRun = true)
|
||||
public void dataPreparation()
|
||||
{
|
||||
STEP("Create user and a site");
|
||||
user = dataUser.createRandomTestUser();
|
||||
site = dataSite.usingUser(user).createPublicRandomSite();
|
||||
}
|
||||
|
||||
@BeforeMethod
|
||||
public void setUp()
|
||||
{
|
||||
STEP("Create parent folder, rule folder and file in it");
|
||||
parentFolder = dataContent.usingUser(user).usingSite(site).createFolder();
|
||||
childFolder = dataContent.usingUser(user).usingResource(parentFolder).createFolder();
|
||||
parentFolderFile = dataContent.usingUser(user).usingResource(parentFolder).createContent(CMISUtil.DocumentType.TEXT_PLAIN);
|
||||
childFolderFile = dataContent.usingUser(user).usingResource(childFolder).createContent(CMISUtil.DocumentType.TEXT_PLAIN);
|
||||
|
||||
STEP("Create rules for parent and rule folders");
|
||||
RestActionBodyExecTemplateModel addLockableAspectAction = createAddAspectAction(LOCKABLE_ASPECT);
|
||||
RestRuleModel ruleModel = createRuleModel(RULE_NAME_DEFAULT, List.of(addLockableAspectAction));
|
||||
ruleModel.setIsInheritable(true);
|
||||
parentFolderRule = restClient.authenticateUser(user).withCoreAPI().usingNode(parentFolder).usingDefaultRuleSet().createSingleRule(ruleModel);
|
||||
childFolderRule = restClient.authenticateUser(user).withCoreAPI().usingNode(childFolder).usingDefaultRuleSet().createSingleRule(createRuleModelWithDefaultValues());
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute one rule with one action trying to add audio aspect to a file.
|
||||
*/
|
||||
@Test(groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.ACTIONS, TestGroup.SANITY })
|
||||
public void executeRules_onlyOwnedRules()
|
||||
{
|
||||
STEP("Check if file aspects don't contain Audio one");
|
||||
RestNodeModel fileNode = restClient.authenticateUser(user).withCoreAPI().usingNode(childFolderFile).getNode();
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
assertThat(fileNode).notContainsAspects(AUDIO_ASPECT);
|
||||
|
||||
STEP("Execute rule");
|
||||
RestRuleExecutionModel executionResult = restClient.authenticateUser(user).withCoreAPI().usingNode(childFolder).executeRules(createRuleExecutionRequest());
|
||||
restClient.assertStatusCodeIs(HttpStatus.CREATED);
|
||||
executionResult.assertThat().field("isEachSubFolderIncluded").is(false);
|
||||
|
||||
STEP("Check if only Audio aspect was added");
|
||||
fileNode = restClient.authenticateUser(user).withCoreAPI().usingNode(childFolderFile).getNode();
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
assertThat(fileNode).containsAspects(AUDIO_ASPECT);
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute owned rule adding Audio aspect and inherited rule adding Lockable aspect.
|
||||
*/
|
||||
@Test(groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.ACTIONS, TestGroup.SANITY })
|
||||
public void executeRules_includeInheritedRules()
|
||||
{
|
||||
STEP("Check if file aspects don't contain Audio and Lockable ones");
|
||||
RestNodeModel fileNode = restClient.authenticateUser(user).withCoreAPI().usingNode(childFolderFile).getNode();
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
assertThat(fileNode).notContainsAspects(AUDIO_ASPECT, LOCKABLE_ASPECT);
|
||||
|
||||
STEP("Execute rules including inherited rules");
|
||||
RestRuleExecutionModel ruleExecutionRequest = createRuleExecutionRequest();
|
||||
RestRuleExecutionModel executionResult = restClient.authenticateUser(user).withCoreAPI().usingNode(childFolder).executeRules(ruleExecutionRequest);
|
||||
restClient.assertStatusCodeIs(HttpStatus.CREATED);
|
||||
executionResult.assertThat().field("isEachSubFolderIncluded").is(false);
|
||||
|
||||
STEP("Check if Audio and Lockable aspects were added");
|
||||
fileNode = restClient.authenticateUser(user).withCoreAPI().usingNode(childFolderFile).getNode();
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
assertThat(fileNode).containsAspects(AUDIO_ASPECT, LOCKABLE_ASPECT);
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute rules on parent folder (add Lockable aspect) including sub-folder folders (add Audio aspect).
|
||||
*/
|
||||
@Test(groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.ACTIONS, TestGroup.SANITY })
|
||||
public void executeRules_includeSubFolderRules()
|
||||
{
|
||||
STEP("Check if parent folder's file aspects don't contain Audio and Lockable ones");
|
||||
RestNodeModel fileNode = restClient.authenticateUser(user).withCoreAPI().usingNode(parentFolderFile).getNode();
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
assertThat(fileNode).notContainsAspects(AUDIO_ASPECT, LOCKABLE_ASPECT);
|
||||
|
||||
STEP("Check if child folder's file aspects don't contain Audio and Lockable ones");
|
||||
fileNode = restClient.authenticateUser(user).withCoreAPI().usingNode(childFolderFile).getNode();
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
assertThat(fileNode).notContainsAspects(AUDIO_ASPECT, LOCKABLE_ASPECT);
|
||||
|
||||
STEP("Execute rules on parent folder including sub-folders");
|
||||
RestRuleExecutionModel ruleExecutionRequest = createRuleExecutionRequest();
|
||||
ruleExecutionRequest.setIsEachSubFolderIncluded(true);
|
||||
RestRuleExecutionModel executionResult = restClient.authenticateUser(user).withCoreAPI().usingNode(parentFolder).executeRules(ruleExecutionRequest);
|
||||
restClient.assertStatusCodeIs(HttpStatus.CREATED);
|
||||
executionResult.assertThat().field("isEachSubFolderIncluded").is(true);
|
||||
|
||||
STEP("Check if Lockable aspects was added to parent folder's file");
|
||||
fileNode = restClient.authenticateUser(user).withCoreAPI().usingNode(parentFolderFile).getNode();
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
assertThat(fileNode)
|
||||
.containsAspects(LOCKABLE_ASPECT)
|
||||
.notContainsAspects(AUDIO_ASPECT);
|
||||
|
||||
STEP("Check if Audio and Lockable aspects were added to child folder's file");
|
||||
fileNode = restClient.authenticateUser(user).withCoreAPI().usingNode(childFolderFile).getNode();
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
assertThat(fileNode)
|
||||
.containsAspects(AUDIO_ASPECT, LOCKABLE_ASPECT);
|
||||
}
|
||||
|
||||
/**
|
||||
* Try to execute disabled rule and check if nothing changed.
|
||||
*/
|
||||
@Test(groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.ACTIONS })
|
||||
public void executeRules_disabledRule()
|
||||
{
|
||||
STEP("Disable child rules");
|
||||
RestRuleModel updatedChildRule = createRuleModelWithDefaultValues();
|
||||
updatedChildRule.setIsEnabled(false);
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(childFolder).usingDefaultRuleSet().updateRule(childFolderRule.getId(), updatedChildRule);
|
||||
|
||||
STEP("Check if file aspects don't contain Audio one");
|
||||
RestNodeModel fileNode = restClient.authenticateUser(user).withCoreAPI().usingNode(childFolderFile).getNode();
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
assertThat(fileNode).notContainsAspects(AUDIO_ASPECT);
|
||||
|
||||
STEP("Execute rule");
|
||||
RestRuleExecutionModel executionResult = restClient.authenticateUser(user).withCoreAPI().usingNode(childFolder).executeRules(createRuleExecutionRequest());
|
||||
restClient.assertStatusCodeIs(HttpStatus.CREATED);
|
||||
executionResult.assertThat().field("isEachSubFolderIncluded").is(false);
|
||||
|
||||
STEP("Check if Audio aspect is still missing");
|
||||
fileNode = restClient.authenticateUser(user).withCoreAPI().usingNode(childFolderFile).getNode();
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
assertThat(fileNode).notContainsAspects(AUDIO_ASPECT);
|
||||
}
|
||||
|
||||
/**
|
||||
* Try to execute inherited parent folder's rule which is not inheritable.
|
||||
*/
|
||||
@Test(groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.ACTIONS })
|
||||
public void executeRules_notInheritableRule()
|
||||
{
|
||||
STEP("Set parent rule as not inheritable");
|
||||
RestRuleModel updatedParentRule = createRuleModelWithDefaultValues();
|
||||
updatedParentRule.setIsInheritable(false);
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(parentFolder).usingDefaultRuleSet().updateRule(parentFolderRule.getId(), updatedParentRule);
|
||||
|
||||
STEP("Check if file aspects don't contain Audio and Lockable ones");
|
||||
RestNodeModel fileNode = restClient.authenticateUser(user).withCoreAPI().usingNode(childFolderFile).getNode();
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
assertThat(fileNode).notContainsAspects(AUDIO_ASPECT, LOCKABLE_ASPECT);
|
||||
|
||||
STEP("Execute child folder rules including inherited rules");
|
||||
RestRuleExecutionModel executionResult = restClient.authenticateUser(user).withCoreAPI().usingNode(childFolder).executeRules(createRuleExecutionRequest());
|
||||
restClient.assertStatusCodeIs(HttpStatus.CREATED);
|
||||
executionResult.assertThat().field("isEachSubFolderIncluded").is(false);
|
||||
|
||||
STEP("Check if Audio aspect is present and Lockable is still missing");
|
||||
fileNode = restClient.authenticateUser(user).withCoreAPI().usingNode(childFolderFile).getNode();
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
assertThat(fileNode)
|
||||
.containsAspects(AUDIO_ASPECT)
|
||||
.notContainsAspects(LOCKABLE_ASPECT);
|
||||
}
|
||||
|
||||
/**
|
||||
* Try to execute private folder's rules by user not added to site and receive 403.
|
||||
*/
|
||||
@Test(groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.ACTIONS })
|
||||
public void executeRules_privateFolderResultsWith403()
|
||||
{
|
||||
STEP("Using admin create private site, folder and rule");
|
||||
SiteModel privateSite = dataSite.usingAdmin().createPrivateRandomSite();
|
||||
FolderModel privateFolder = dataContent.usingAdmin().usingSite(privateSite).createFolder();
|
||||
dataContent.usingAdmin().usingResource(privateFolder).createContent(CMISUtil.DocumentType.TEXT_PLAIN);
|
||||
restClient.authenticateUser(dataUser.getAdminUser()).withCoreAPI().usingNode(privateFolder).usingDefaultRuleSet().createSingleRule(createRuleModelWithDefaultValues());
|
||||
|
||||
STEP("Try to execute private folder's rules by user");
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(privateFolder).executeRules(createRuleExecutionRequest());
|
||||
restClient.assertStatusCodeIs(HttpStatus.FORBIDDEN);
|
||||
}
|
||||
|
||||
/**
|
||||
* Try to execute private folder's rules as site contributor and receive 403.
|
||||
*/
|
||||
@Test(groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.ACTIONS })
|
||||
public void executeRules_privateFolderAsContributorResultsWith403()
|
||||
{
|
||||
STEP("Using admin create private site, folder, file in it, rule and add user to site as contributor");
|
||||
UserModel contributor = dataUser.createRandomTestUser();
|
||||
SiteModel privateSite = dataSite.usingAdmin().createPrivateRandomSite();
|
||||
FolderModel privateFolder = dataContent.usingAdmin().usingSite(privateSite).createFolder();
|
||||
dataContent.usingAdmin().usingResource(privateFolder).createContent(CMISUtil.DocumentType.TEXT_PLAIN);
|
||||
restClient.authenticateUser(dataUser.getAdminUser()).withCoreAPI().usingNode(privateFolder).usingDefaultRuleSet().createSingleRule(createRuleModelWithDefaultValues());
|
||||
dataUser.usingAdmin().addUserToSite(contributor, privateSite, UserRole.SiteContributor);
|
||||
|
||||
STEP("Try to execute private folder's rules by contributor");
|
||||
restClient.authenticateUser(contributor).withCoreAPI().usingNode(privateFolder).executeRules(createRuleExecutionRequest());
|
||||
restClient.assertStatusCodeIs(HttpStatus.FORBIDDEN);
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute private folder's rules as site collaborator.
|
||||
*/
|
||||
@Test(groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.ACTIONS })
|
||||
public void executeRules_privateFolderAsCollaborator()
|
||||
{
|
||||
STEP("Using admin create private site, folder, file in it, rule and add user to site as collaborator");
|
||||
UserModel collaborator = dataUser.createRandomTestUser();
|
||||
UserModel admin = dataUser.getAdminUser();
|
||||
SiteModel privateSite = dataSite.usingAdmin().createPrivateRandomSite();
|
||||
FolderModel privateFolder = dataContent.usingAdmin().usingSite(privateSite).createFolder();
|
||||
FileModel privateFile = dataContent.usingAdmin().usingResource(privateFolder).createContent(CMISUtil.DocumentType.TEXT_PLAIN);
|
||||
restClient.authenticateUser(admin).withCoreAPI().usingNode(privateFolder).usingDefaultRuleSet().createSingleRule(createRuleModelWithDefaultValues());
|
||||
dataUser.usingAdmin().addUserToSite(collaborator, privateSite, UserRole.SiteCollaborator);
|
||||
|
||||
STEP("Check if file aspects don't contain Audio one");
|
||||
RestNodeModel fileNode = restClient.authenticateUser(admin).withCoreAPI().usingNode(privateFile).getNode();
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
assertThat(fileNode).notContainsAspects(AUDIO_ASPECT);
|
||||
|
||||
STEP("Execute private folder's rules by collaborator");
|
||||
restClient.authenticateUser(collaborator).withCoreAPI().usingNode(privateFolder).executeRules(createRuleExecutionRequest());
|
||||
restClient.assertStatusCodeIs(HttpStatus.CREATED);
|
||||
|
||||
STEP("Check if Audio aspect is present");
|
||||
fileNode = restClient.authenticateUser(admin).withCoreAPI().usingNode(privateFile).getNode();
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
assertThat(fileNode).containsAspects(AUDIO_ASPECT);
|
||||
}
|
||||
|
||||
//TODO: add test(s) that would cover handling executing broken rule and/or broken rule execution (ACS-3699)
|
||||
}
|
@@ -25,17 +25,28 @@
|
||||
*/
|
||||
package org.alfresco.rest.rules;
|
||||
|
||||
import static org.alfresco.rest.requests.RuleSettings.IS_INHERITANCE_ENABLED;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createRuleModel;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createRuleModelWithDefaultValues;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createRuleModelWithModifiedValues;
|
||||
import static org.alfresco.utility.report.log.Step.STEP;
|
||||
import static org.junit.Assert.assertTrue;
|
||||
import static org.springframework.http.HttpStatus.FORBIDDEN;
|
||||
import static org.springframework.http.HttpStatus.NOT_FOUND;
|
||||
import static org.springframework.http.HttpStatus.OK;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import com.google.common.collect.ImmutableMap;
|
||||
|
||||
import org.alfresco.rest.RestTest;
|
||||
import org.alfresco.rest.model.RestRuleModel;
|
||||
import org.alfresco.rest.model.RestRuleSetLinkModel;
|
||||
import org.alfresco.rest.model.RestRuleSetModel;
|
||||
import org.alfresco.rest.model.RestRuleSetModelsCollection;
|
||||
import org.alfresco.rest.model.RestRuleSettingsModel;
|
||||
import org.alfresco.rest.requests.coreAPI.RestCoreAPI;
|
||||
import org.alfresco.utility.constants.UserRole;
|
||||
import org.alfresco.utility.model.FolderModel;
|
||||
import org.alfresco.utility.model.SiteModel;
|
||||
import org.alfresco.utility.model.TestGroup;
|
||||
@@ -52,6 +63,8 @@ public class GetRuleSetsTests extends RestTest
|
||||
private UserModel user;
|
||||
private SiteModel site;
|
||||
private FolderModel ruleFolder;
|
||||
/** A folder with a rule in a private site owned by admin. */
|
||||
private FolderModel privateFolder;
|
||||
private FolderModel inheritingChildFolder;
|
||||
private FolderModel notInheritingChildFolder;
|
||||
private RestRuleModel rule;
|
||||
@@ -83,6 +96,11 @@ public class GetRuleSetsTests extends RestTest
|
||||
.getListOfRuleSets();
|
||||
ruleSets.assertThat().entriesListCountIs(1);
|
||||
ruleSetId = ruleSets.getEntries().get(0).onModel().getId();
|
||||
|
||||
STEP("Use admin to create a private site containing a rule in a rule set that can be inherited.");
|
||||
SiteModel privateSite = dataSite.usingAdmin().createPrivateRandomSite();
|
||||
privateFolder = dataContent.usingAdmin().usingSite(privateSite).createFolder();
|
||||
coreAPIForAdmin().usingNode(privateFolder).usingDefaultRuleSet().createSingleRule(createRuleModelWithModifiedValues());
|
||||
}
|
||||
|
||||
/** Check we can get an empty list of rule sets. */
|
||||
@@ -125,6 +143,48 @@ public class GetRuleSetsTests extends RestTest
|
||||
restClient.assertStatusCodeIs(NOT_FOUND);
|
||||
}
|
||||
|
||||
/** Check that we get a 403 error when trying to get rule sets for a folder we don't have read access to. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES })
|
||||
public void getRuleSetsWithoutPermission()
|
||||
{
|
||||
STEP("Check a user cannot list rule sets without read access.");
|
||||
coreAPIForUser().usingNode(privateFolder).getListOfRuleSets();
|
||||
restClient.assertStatusCodeIs(FORBIDDEN);
|
||||
}
|
||||
|
||||
/** Check that we can still list some rule sets if we don't have permission to view them all. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES })
|
||||
public void permissionsAreRespectedWhenListingRuleSets()
|
||||
{
|
||||
STEP("Create a public site containing a parent and child folder with rule inheritance enabled.");
|
||||
SiteModel publicSite = dataSite.usingUser(user).createPublicRandomSite();
|
||||
FolderModel parentFolder = dataContent.usingUser(user).usingSite(publicSite).createFolder();
|
||||
FolderModel childFolder = dataContent.usingUser(user).usingResource(parentFolder).createFolder();
|
||||
RestRuleSettingsModel enabled = new RestRuleSettingsModel();
|
||||
enabled.setValue(true);
|
||||
coreAPIForUser().usingNode(parentFolder).usingRuleSetting(IS_INHERITANCE_ENABLED).updateSetting(enabled);
|
||||
|
||||
STEP("Link the parent folder to a private rule set.");
|
||||
RestRuleSetLinkModel linkModel = new RestRuleSetLinkModel();
|
||||
linkModel.setId(privateFolder.getNodeRef());
|
||||
coreAPIForAdmin().usingNode(parentFolder).createRuleLink(linkModel);
|
||||
|
||||
STEP("Create a rule on the child folder.");
|
||||
coreAPIForUser().usingNode(childFolder).usingDefaultRuleSet().createSingleRule(createRuleModelWithDefaultValues());
|
||||
|
||||
STEP("Check admin can view both rule sets.");
|
||||
RestRuleSetModelsCollection adminViewOfRuleSets = coreAPIForAdmin().usingNode(childFolder).getListOfRuleSets();
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
RestRuleSetModel parentRuleSet = adminViewOfRuleSets.getEntries().get(0).onModel();
|
||||
RestRuleSetModel childRuleSet = adminViewOfRuleSets.getEntries().get(1).onModel();
|
||||
|
||||
STEP("Check the normal user can only view the child rule set.");
|
||||
RestRuleSetModelsCollection userViewOfRuleSets = coreAPIForUser().usingNode(childFolder).getListOfRuleSets();
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
userViewOfRuleSets.assertThat().entriesListContains("id", childRuleSet.getId())
|
||||
.and().entriesListDoesNotContain("id", parentRuleSet.getId());
|
||||
}
|
||||
|
||||
/** Check we can get the id of the folder that owns a list of rule sets. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES })
|
||||
public void getRuleSetsAndOwningFolders()
|
||||
@@ -198,7 +258,13 @@ public class GetRuleSetsTests extends RestTest
|
||||
.getRuleSet(ruleSetId);
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
ruleSet.assertThat().field("id").is(ruleSetId);
|
||||
ruleSet.assertThat().field("id").is(ruleSetId)
|
||||
// Also check that the optional fields are not included by default.
|
||||
.assertThat().field("owningFolder").isNull()
|
||||
.assertThat().field("inheritedBy").isNull()
|
||||
.assertThat().field("linkedToBy").isNull()
|
||||
.assertThat().field("isInherited").isNull()
|
||||
.assertThat().field("isLinkedTo").isNull();
|
||||
}
|
||||
|
||||
/** Check we can get a rule set using the "-default-" synonym. */
|
||||
@@ -248,4 +314,284 @@ public class GetRuleSetsTests extends RestTest
|
||||
ruleSet.assertThat().field("owningFolder").is(ruleFolder.getNodeRef())
|
||||
.assertThat().field("id").is(ruleSetId);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we can find out the id of any folders that inherit a rule set.
|
||||
* <p>
|
||||
* The test checks several different situations:
|
||||
* <pre>
|
||||
* folder --[owns]-> rule set
|
||||
* +- publicFolder --[inherits]-> rule set (user has access)
|
||||
* +- privateFolder --[inherits]-> rule set (user does not have access)
|
||||
* +- publicGrandchild --[inherits]-> rule set (user has access again)
|
||||
* +- nonInheritingFolder (inheritance should be prevented)
|
||||
* +- linkingFolder --[links]-> rule set (not inherited)
|
||||
* +- descendantFolder --[inherits]-> rule set (inherited via link)
|
||||
* </pre>
|
||||
*/
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES })
|
||||
public void getRuleSetAndInheritedBy()
|
||||
{
|
||||
STEP("Create a site owned by admin and add user as a contributor");
|
||||
SiteModel siteModel = dataSite.usingAdmin().createPrivateRandomSite();
|
||||
dataUser.addUserToSite(user, siteModel, UserRole.SiteContributor);
|
||||
|
||||
STEP("Create the folder structure");
|
||||
FolderModel folder = dataContent.usingUser(user).usingSite(siteModel).createFolder();
|
||||
FolderModel publicFolder = dataContent.usingUser(user).usingResource(folder).createFolder();
|
||||
FolderModel privateFolder = dataContent.usingAdmin().usingResource(folder).createFolder();
|
||||
dataContent.usingAdmin().usingResource(privateFolder).setInheritPermissions(false);
|
||||
// Create the grandchild with user and use admin to move it under the private folder.
|
||||
FolderModel publicGrandchild = dataContent.usingUser(user).usingSite(siteModel).createFolder();
|
||||
coreAPIForAdmin().usingActions().executeAction("move", publicGrandchild, ImmutableMap.of("destination-folder", "workspace://SpacesStore/" + privateFolder.getNodeRef()));
|
||||
// Create the non-inheriting folder.
|
||||
FolderModel nonInheritingFolder = dataContent.usingUser(user).usingResource(folder).createFolder();
|
||||
RestRuleSettingsModel nonInheriting = new RestRuleSettingsModel();
|
||||
nonInheriting.setKey(IS_INHERITANCE_ENABLED);
|
||||
nonInheriting.setValue(false);
|
||||
coreAPIForUser().usingNode(nonInheritingFolder).usingIsInheritanceEnabledRuleSetting().updateSetting(nonInheriting);
|
||||
// Create a child that will link to the rule and a child of that to inherit via the link.
|
||||
FolderModel linkingFolder = dataContent.usingUser(user).usingResource(nonInheritingFolder).createFolder();
|
||||
FolderModel descendantFolder = dataContent.usingUser(user).usingResource(linkingFolder).createFolder();
|
||||
|
||||
STEP("Create an inheritable rule in the folder and get the rule set id.");
|
||||
RestRuleModel ruleModel = createRuleModelWithModifiedValues();
|
||||
coreAPIForUser().usingNode(folder).usingDefaultRuleSet().createSingleRule(ruleModel);
|
||||
RestRuleSetModelsCollection ruleSets = coreAPIForUser().usingNode(folder).getListOfRuleSets();
|
||||
String ruleSetId = ruleSets.getEntries().get(0).onModel().getId();
|
||||
|
||||
STEP("Create the link to the rule from the linking folder");
|
||||
RestRuleSetLinkModel ruleSetLink = new RestRuleSetLinkModel();
|
||||
ruleSetLink.setId(folder.getNodeRef());
|
||||
coreAPIForUser().usingNode(linkingFolder).createRuleLink(ruleSetLink);
|
||||
|
||||
STEP("Remove the user from the site");
|
||||
dataUser.removeUserFromSite(user, siteModel);
|
||||
|
||||
STEP("Get the rule set and inheriting folders");
|
||||
RestRuleSetModel ruleSet = coreAPIForUser().usingNode(folder)
|
||||
.include("inheritedBy")
|
||||
.getRuleSet(ruleSetId);
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
List<String> expectedInheritors = List.of(publicFolder.getNodeRef(), descendantFolder.getNodeRef(), publicGrandchild.getNodeRef());
|
||||
ruleSet.assertThat().field("inheritedBy").is(expectedInheritors)
|
||||
.assertThat().field("id").is(ruleSetId);
|
||||
}
|
||||
|
||||
/** Check we can get the folders that link to a rule set and that this respects permissions. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES })
|
||||
public void getRuleSetsAndLinkedToBy()
|
||||
{
|
||||
STEP("Create a site owned by admin and add user as a contributor");
|
||||
SiteModel siteModel = dataSite.usingAdmin().createPrivateRandomSite();
|
||||
dataUser.addUserToSite(user, siteModel, UserRole.SiteContributor);
|
||||
|
||||
STEP("Create the folder structure");
|
||||
FolderModel ruleFolder = dataContent.usingUser(user).usingSite(siteModel).createFolder();
|
||||
FolderModel publicFolder = dataContent.usingUser(user).usingSite(siteModel).createFolder();
|
||||
FolderModel privateFolder = dataContent.usingAdmin().usingSite(siteModel).createFolder();
|
||||
dataContent.usingAdmin().usingResource(privateFolder).setInheritPermissions(false);
|
||||
|
||||
STEP("Remove the user from the site");
|
||||
dataUser.removeUserFromSite(user, siteModel);
|
||||
|
||||
STEP("Create a rule in the folder and link to it from the other two.");
|
||||
RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
coreAPIForUser().usingNode(ruleFolder).usingDefaultRuleSet().createSingleRule(ruleModel);
|
||||
RestRuleSetModelsCollection ruleSets = coreAPIForAdmin().usingNode(ruleFolder).getListOfRuleSets();
|
||||
String ruleSetId = ruleSets.getEntries().get(0).onModel().getId();
|
||||
RestRuleSetLinkModel ruleSetLink = new RestRuleSetLinkModel();
|
||||
ruleSetLink.setId(ruleFolder.getNodeRef());
|
||||
coreAPIForUser().usingNode(publicFolder).createRuleLink(ruleSetLink);
|
||||
coreAPIForAdmin().usingNode(privateFolder).createRuleLink(ruleSetLink);
|
||||
|
||||
STEP("Get the rule set and linkedToBy field");
|
||||
RestRuleSetModel ruleSet = coreAPIForUser().usingNode(ruleFolder)
|
||||
.include("linkedToBy")
|
||||
.getRuleSet(ruleSetId);
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
ruleSet.assertThat().field("linkedToBy").is(List.of(publicFolder.getNodeRef()))
|
||||
.assertThat().field("id").is(ruleSetId);
|
||||
}
|
||||
|
||||
/** Check that a user can see that a rule set is inherited even if they don't have permission to view the inheriting folder. */
|
||||
@Test
|
||||
public void getRuleSetAndIsInheritedWithoutPermission()
|
||||
{
|
||||
STEP("Create a site owned by admin and add user as a contributor");
|
||||
SiteModel siteModel = dataSite.usingAdmin().createPrivateRandomSite();
|
||||
dataUser.addUserToSite(user, siteModel, UserRole.SiteContributor);
|
||||
|
||||
STEP("Create a folder with a rule set and a private child folder to inherit it");
|
||||
FolderModel ruleFolder = dataContent.usingUser(user).usingSite(siteModel).createFolder();
|
||||
dataContent.usingAdmin().usingResource(ruleFolder).createFolder();
|
||||
RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
coreAPIForUser().usingNode(ruleFolder).usingDefaultRuleSet().createSingleRule(ruleModel);
|
||||
|
||||
STEP("Remove the user from the site");
|
||||
dataUser.removeUserFromSite(user, siteModel);
|
||||
|
||||
STEP("Get the rule set and isInherited field");
|
||||
RestRuleSetModel ruleSet = coreAPIForUser().usingNode(ruleFolder)
|
||||
.include("isInherited", "inheritedBy")
|
||||
.getDefaultRuleSet();
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
ruleSet.assertThat().field("isInherited").is(true)
|
||||
.assertThat().field("inheritedBy").isEmpty();
|
||||
|
||||
}
|
||||
|
||||
/** Check that the isInherited field includes rule sets which are only inherited via links. */
|
||||
@Test
|
||||
public void getRuleSetAndIsInheritedViaLink()
|
||||
{
|
||||
STEP("Create a site and a folder with a rule");
|
||||
SiteModel siteModel = dataSite.usingUser(user).createPublicRandomSite();
|
||||
FolderModel ruleFolder = dataContent.usingUser(user).usingSite(siteModel).createFolder();
|
||||
RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
coreAPIForUser().usingNode(ruleFolder).usingDefaultRuleSet().createSingleRule(ruleModel);
|
||||
|
||||
STEP("Create a second folder in the site that links to the rule set");
|
||||
FolderModel secondFolder = dataContent.usingUser(user).usingSite(siteModel).createFolder();
|
||||
dataContent.usingUser(user).usingResource(secondFolder).createFolder();
|
||||
RestRuleSetLinkModel ruleSetLink = new RestRuleSetLinkModel();
|
||||
ruleSetLink.setId(ruleFolder.getNodeRef());
|
||||
coreAPIForUser().usingNode(secondFolder).createRuleLink(ruleSetLink);
|
||||
|
||||
STEP("Get the rule set and isInherited field");
|
||||
RestRuleSetModel ruleSet = coreAPIForUser().usingNode(ruleFolder)
|
||||
.include("isInherited")
|
||||
.getDefaultRuleSet();
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
ruleSet.assertThat().field("isInherited").is(true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check that if a rule set is owned and linked to but not inherited then isInherited returns false.
|
||||
*/
|
||||
@Test
|
||||
public void getRuleSetAndIsInheritedCanBeFalse()
|
||||
{
|
||||
STEP("Create a site and a folder with a rule");
|
||||
SiteModel siteModel = dataSite.usingUser(user).createPublicRandomSite();
|
||||
FolderModel ruleFolder = dataContent.usingUser(user).usingSite(siteModel).createFolder();
|
||||
RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
coreAPIForUser().usingNode(ruleFolder).usingDefaultRuleSet().createSingleRule(ruleModel);
|
||||
|
||||
STEP("Create a second folder in the site that links to the rule set");
|
||||
FolderModel secondFolder = dataContent.usingUser(user).usingSite(siteModel).createFolder();
|
||||
RestRuleSetLinkModel ruleSetLink = new RestRuleSetLinkModel();
|
||||
ruleSetLink.setId(ruleFolder.getNodeRef());
|
||||
coreAPIForUser().usingNode(secondFolder).createRuleLink(ruleSetLink);
|
||||
|
||||
STEP("Get the rule set and isInherited field");
|
||||
RestRuleSetModel ruleSet = coreAPIForUser().usingNode(ruleFolder)
|
||||
.include("isInherited")
|
||||
.getDefaultRuleSet();
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
ruleSet.assertThat().field("isInherited").is(false);
|
||||
}
|
||||
|
||||
|
||||
/** Check that a user can see that a rule set is linked to even if they don't have permission to view the linking folder. */
|
||||
@Test
|
||||
public void getRuleSetAndIsLinkedToWithoutPermission()
|
||||
{
|
||||
STEP("Create a site owned by admin and add user as a contributor");
|
||||
SiteModel siteModel = dataSite.usingAdmin().createPrivateRandomSite();
|
||||
dataUser.addUserToSite(user, siteModel, UserRole.SiteContributor);
|
||||
|
||||
STEP("Create a folder with a rule set");
|
||||
FolderModel ruleFolder = dataContent.usingUser(user).usingSite(siteModel).createFolder();
|
||||
RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
coreAPIForUser().usingNode(ruleFolder).usingDefaultRuleSet().createSingleRule(ruleModel);
|
||||
|
||||
STEP("Create a private folder linking to the rule set");
|
||||
FolderModel linkingFolder = dataContent.usingAdmin().usingSite(siteModel).createFolder();
|
||||
RestRuleSetLinkModel linkModel = new RestRuleSetLinkModel();
|
||||
linkModel.setId(ruleFolder.getNodeRef());
|
||||
coreAPIForAdmin().usingNode(linkingFolder).createRuleLink(linkModel);
|
||||
|
||||
STEP("Remove the user from the site");
|
||||
dataUser.removeUserFromSite(user, siteModel);
|
||||
|
||||
STEP("Get the rule set and isLinkedTo field");
|
||||
RestRuleSetModel ruleSet = coreAPIForUser().usingNode(ruleFolder)
|
||||
.include("isLinkedTo", "linkedToBy", "owningFolder")
|
||||
.getDefaultRuleSet();
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
ruleSet.assertThat().field("isLinkedTo").is(true)
|
||||
.assertThat().field("linkedToBy").isEmpty();
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Check that if a rule set is owned and inherited but not linked to then isLinkedTo returns false.
|
||||
*/
|
||||
@Test
|
||||
public void getRuleSetAndIsLinkedToCanBeFalse()
|
||||
{
|
||||
STEP("Create a site, a folder with a rule and a child folder that inherits it");
|
||||
SiteModel siteModel = dataSite.usingUser(user).createPublicRandomSite();
|
||||
FolderModel ruleFolder = dataContent.usingUser(user).usingSite(siteModel).createFolder();
|
||||
RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
coreAPIForUser().usingNode(ruleFolder).usingDefaultRuleSet().createSingleRule(ruleModel);
|
||||
dataContent.usingUser(user).usingResource(ruleFolder).createFolder();
|
||||
|
||||
STEP("Get the rule set and isLinkedTo field");
|
||||
RestRuleSetModel ruleSet = coreAPIForUser().usingNode(ruleFolder)
|
||||
.include("isLinkedTo")
|
||||
.getDefaultRuleSet();
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
ruleSet.assertThat().field("isLinkedTo").is(false);
|
||||
}
|
||||
|
||||
/** Check that we can only view a rule set if have read permission. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES })
|
||||
public void permissionsChecksForFolderWithPrivateAndPublicRuleSets()
|
||||
{
|
||||
STEP("Create a public site containing a parent and child folder with rule inheritance enabled.");
|
||||
SiteModel publicSite = dataSite.usingUser(user).createPublicRandomSite();
|
||||
FolderModel parentFolder = dataContent.usingUser(user).usingSite(publicSite).createFolder();
|
||||
FolderModel childFolder = dataContent.usingUser(user).usingResource(parentFolder).createFolder();
|
||||
RestRuleSettingsModel enabled = new RestRuleSettingsModel();
|
||||
enabled.setValue(true);
|
||||
coreAPIForUser().usingNode(parentFolder).usingRuleSetting(IS_INHERITANCE_ENABLED).updateSetting(enabled);
|
||||
|
||||
STEP("Link the parent folder to a private rule set.");
|
||||
RestRuleSetLinkModel linkModel = new RestRuleSetLinkModel();
|
||||
linkModel.setId(privateFolder.getNodeRef());
|
||||
coreAPIForAdmin().usingNode(parentFolder).createRuleLink(linkModel);
|
||||
|
||||
STEP("Create a rule on the child folder.");
|
||||
coreAPIForUser().usingNode(childFolder).usingDefaultRuleSet().createSingleRule(createRuleModelWithDefaultValues());
|
||||
|
||||
STEP("Use the admin user to get both rule sets.");
|
||||
RestRuleSetModelsCollection adminViewOfRuleSets = coreAPIForAdmin().usingNode(childFolder).getListOfRuleSets();
|
||||
RestRuleSetModel parentRuleSet = adminViewOfRuleSets.getEntries().get(0).onModel();
|
||||
RestRuleSetModel childRuleSet = adminViewOfRuleSets.getEntries().get(1).onModel();
|
||||
|
||||
STEP("Check the normal user can only view the child rule set.");
|
||||
coreAPIForUser().usingNode(childFolder).getRuleSet(parentRuleSet.getId());
|
||||
restClient.assertStatusCodeIs(FORBIDDEN);
|
||||
coreAPIForUser().usingNode(childFolder).getRuleSet(childRuleSet.getId());
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
}
|
||||
|
||||
private RestCoreAPI coreAPIForUser()
|
||||
{
|
||||
return restClient.authenticateUser(user).withCoreAPI();
|
||||
}
|
||||
|
||||
private RestCoreAPI coreAPIForAdmin()
|
||||
{
|
||||
return restClient.authenticateUser(dataUser.getAdminUser()).withCoreAPI();
|
||||
}
|
||||
}
|
||||
|
@@ -2,7 +2,7 @@
|
||||
* #%L
|
||||
* Alfresco Repository
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2016 Alfresco Software Limited
|
||||
* Copyright (C) 2005 - 2022 Alfresco Software Limited
|
||||
* %%
|
||||
* This file is part of the Alfresco software.
|
||||
* If the software was purchased under a paid Alfresco license, the terms of
|
||||
@@ -63,6 +63,8 @@ public class GetRulesTests extends RestTest
|
||||
private RestRuleModel createdRuleA;
|
||||
private static final String IGNORE_ID = "id";
|
||||
private static final String IGNORE_IS_SHARED = "isShared";
|
||||
private static final String ACTIONS = "actions";
|
||||
private static final String CONDITIONS = "conditions";
|
||||
|
||||
@BeforeClass(alwaysRun = true)
|
||||
public void dataPreparation()
|
||||
@@ -150,11 +152,11 @@ public class GetRulesTests extends RestTest
|
||||
rules.getEntries().get(i).onModel()
|
||||
.assertThat().field("isShared").isNotNull()
|
||||
.assertThat().field("description").isNull()
|
||||
.assertThat().field("enabled").is(false)
|
||||
.assertThat().field("cascade").is(false)
|
||||
.assertThat().field("asynchronous").is(false)
|
||||
.assertThat().field("isEnabled").is(true)
|
||||
.assertThat().field("isInheritable").is(false)
|
||||
.assertThat().field("isAsynchronous").is(false)
|
||||
.assertThat().field("errorScript").isNull()
|
||||
.assertThat().field("shared").isNull()
|
||||
.assertThat().field("isShared").is(false)
|
||||
.assertThat().field("triggers").is("[inbound]"));
|
||||
}
|
||||
|
||||
@@ -190,7 +192,6 @@ public class GetRulesTests extends RestTest
|
||||
|
||||
RestRuleModel expectedRuleModel = createRuleModelWithModifiedValues();
|
||||
expectedRuleModel.setTriggers(List.of("update"));
|
||||
expectedRuleModel.setConditions(createEmptyConditionModel());
|
||||
|
||||
restClient.assertStatusCodeIs(CREATED);
|
||||
rule.assertThat().isEqualTo(expectedRuleModel, IGNORE_ID, IGNORE_IS_SHARED)
|
||||
@@ -212,7 +213,6 @@ public class GetRulesTests extends RestTest
|
||||
|
||||
RestRuleModel expectedRuleModel = createRuleModelWithDefaultValues();
|
||||
expectedRuleModel.setTriggers(List.of("inbound"));
|
||||
expectedRuleModel.setConditions(createEmptyConditionModel());
|
||||
|
||||
restClient.assertStatusCodeIs(CREATED);
|
||||
|
||||
@@ -307,4 +307,56 @@ public class GetRulesTests extends RestTest
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
rules.assertThat().entriesListContains("name", "Private site rule");
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we can GET Rule's actions.
|
||||
*/
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void getRuleActions()
|
||||
{
|
||||
STEP("Create a rule with a few actions");
|
||||
FolderModel folder = dataContent.usingUser(user).usingSite(site).createFolder();
|
||||
final RestRuleModel rule = restClient.authenticateUser(user).withCoreAPI().usingNode(folder).usingDefaultRuleSet()
|
||||
.createSingleRule(createVariousActions());
|
||||
|
||||
STEP("Retrieve the created rule via the GET endpoint");
|
||||
final RestRuleModel getRuleBody = restClient.authenticateUser(user).withCoreAPI().usingNode(folder).usingDefaultRuleSet().getSingleRule(rule.getId());
|
||||
|
||||
STEP("Assert that actions are returned as expected from the GET endpoint");
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
getRuleBody.assertThat().field(ACTIONS).contains("actionDefinitionId=copy")
|
||||
.assertThat().field(ACTIONS).contains("destination-folder=dummy-folder-node")
|
||||
.assertThat().field(ACTIONS).contains("deep-copy=true")
|
||||
.assertThat().field(ACTIONS).contains("actionDefinitionId=check-out")
|
||||
.assertThat().field(ACTIONS).contains("destination-folder=fake-folder-node")
|
||||
.assertThat().field(ACTIONS).contains("assoc-name=cm:checkout");
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we can GET rule's conditions.
|
||||
*/
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void getRulesConditions()
|
||||
{
|
||||
STEP("Create a rule with several conditions");
|
||||
RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
ruleModel.setConditions(createVariousConditions());
|
||||
|
||||
FolderModel folder = dataContent.usingUser(user).usingSite(site).createFolder();
|
||||
|
||||
RestRuleModel rule = restClient.authenticateUser(user).withCoreAPI().usingNode(folder).usingDefaultRuleSet()
|
||||
.createSingleRule(ruleModel);
|
||||
|
||||
STEP("Retrieve the created rule via the GET endpoint");
|
||||
final RestRuleModel getRuleBody = restClient.authenticateUser(user).withCoreAPI().usingNode(folder).usingDefaultRuleSet().getSingleRule(rule.getId());
|
||||
|
||||
STEP("Assert that conditions are retrieved using the GET endpoint");
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
getRuleBody.assertThat().field(CONDITIONS).contains("comparator=ends")
|
||||
.assertThat().field(CONDITIONS).contains("field=cm:creator")
|
||||
.assertThat().field(CONDITIONS).contains("parameter=ski")
|
||||
.assertThat().field(CONDITIONS).contains("comparator=begins")
|
||||
.assertThat().field(CONDITIONS).contains("field=cm:modelVersion")
|
||||
.assertThat().field(CONDITIONS).contains("parameter=1.");
|
||||
}
|
||||
}
|
||||
|
@@ -0,0 +1,204 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Repository
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2022 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.rules;
|
||||
|
||||
import static java.util.stream.Collectors.toList;
|
||||
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createRuleModelWithDefaultValues;
|
||||
import static org.alfresco.utility.report.log.Step.STEP;
|
||||
import static org.springframework.http.HttpStatus.FORBIDDEN;
|
||||
import static org.springframework.http.HttpStatus.OK;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.stream.IntStream;
|
||||
|
||||
import com.google.common.collect.Lists;
|
||||
|
||||
import org.alfresco.rest.RestTest;
|
||||
import org.alfresco.rest.model.RestRuleModel;
|
||||
import org.alfresco.rest.model.RestRuleSetModel;
|
||||
import org.alfresco.utility.constants.UserRole;
|
||||
import org.alfresco.utility.model.FolderModel;
|
||||
import org.alfresco.utility.model.SiteModel;
|
||||
import org.alfresco.utility.model.TestGroup;
|
||||
import org.alfresco.utility.model.UserModel;
|
||||
import org.testng.annotations.BeforeClass;
|
||||
import org.testng.annotations.Test;
|
||||
|
||||
@Test (groups = { TestGroup.RULES })
|
||||
public class ReorderRules extends RestTest
|
||||
{
|
||||
private UserModel user;
|
||||
private SiteModel site;
|
||||
|
||||
@BeforeClass (alwaysRun = true)
|
||||
public void dataPreparation()
|
||||
{
|
||||
STEP("Create a user and site.");
|
||||
user = dataUser.createRandomTestUser();
|
||||
site = dataSite.usingUser(user).createPublicRandomSite();
|
||||
}
|
||||
|
||||
/** Check we can get the ordered list of rules in a rule set. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES })
|
||||
public void getOrderedRuleIds()
|
||||
{
|
||||
STEP("Create a folder containing three rules in the existing site");
|
||||
FolderModel folder = dataContent.usingUser(user).usingSite(site).createFolder();
|
||||
List<RestRuleModel> rules = createRulesInFolder(folder, user);
|
||||
|
||||
STEP("Get the default rule set for the folder including the ordered rule ids");
|
||||
RestRuleSetModel ruleSet = restClient.authenticateUser(user).withCoreAPI().usingNode(folder)
|
||||
.include("ruleIds").getDefaultRuleSet();
|
||||
|
||||
List<String> expectedRuleIds = rules.stream().map(RestRuleModel::getId).collect(toList());
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
ruleSet.assertThat().field("ruleIds").is(expectedRuleIds);
|
||||
}
|
||||
|
||||
/** Check that a user can view the order of the rules in a rule set if they only have read permission. */
|
||||
@Test
|
||||
public void getRuleSetAndRuleIdsWithReadOnlyPermission()
|
||||
{
|
||||
STEP("Create a site owned by admin and add user as a consumer");
|
||||
SiteModel siteModel = dataSite.usingAdmin().createPrivateRandomSite();
|
||||
dataUser.addUserToSite(user, siteModel, UserRole.SiteConsumer);
|
||||
|
||||
STEP("Use admin to create a folder with a rule set and three rules in it");
|
||||
FolderModel ruleFolder = dataContent.usingAdmin().usingSite(siteModel).createFolder();
|
||||
dataContent.usingAdmin().usingResource(ruleFolder).createFolder();
|
||||
List<RestRuleModel> rules = createRulesInFolder(ruleFolder, dataUser.getAdminUser());
|
||||
|
||||
STEP("Get the rule set with the ordered list of rules");
|
||||
RestRuleSetModel ruleSet = restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder)
|
||||
.include("ruleIds").getDefaultRuleSet();
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
List<String> ruleIds = rules.stream().map(RestRuleModel::getId).collect(toList());
|
||||
ruleSet.assertThat().field("ruleIds").is(ruleIds);
|
||||
}
|
||||
|
||||
/** Check we can reorder the rules in a rule set. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES })
|
||||
public void reorderRules()
|
||||
{
|
||||
STEP("Create a folder containing three rules in the existing site");
|
||||
FolderModel folder = dataContent.usingUser(user).usingSite(site).createFolder();
|
||||
List<RestRuleModel> rules = createRulesInFolder(folder, user);
|
||||
|
||||
STEP("Reverse the order of the rules within the rule set");
|
||||
List<String> reversedRuleIds = Lists.reverse(rules.stream().map(RestRuleModel::getId).collect(toList()));
|
||||
RestRuleSetModel ruleSetBody = new RestRuleSetModel();
|
||||
ruleSetBody.setId("-default-");
|
||||
ruleSetBody.setRuleIds(reversedRuleIds);
|
||||
RestRuleSetModel ruleSet = restClient.authenticateUser(user).withCoreAPI().usingNode(folder)
|
||||
.include("ruleIds").updateRuleSet(ruleSetBody);
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
ruleSet.assertThat().field("ruleIds").is(reversedRuleIds);
|
||||
}
|
||||
|
||||
/** Check we can reorder the rules in a rule set by editing the response from the GET. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES })
|
||||
public void reorderRulesUsingResponseFromGET()
|
||||
{
|
||||
STEP("Create a folder containing three rules in the existing site");
|
||||
FolderModel folder = dataContent.usingUser(user).usingSite(site).createFolder();
|
||||
List<RestRuleModel> rules = createRulesInFolder(folder, user);
|
||||
|
||||
STEP("Get the rule set with its id.");
|
||||
RestRuleSetModel ruleSetResponse = restClient.authenticateUser(user).withCoreAPI().usingNode(folder)
|
||||
.include("ruleIds").getDefaultRuleSet();
|
||||
|
||||
STEP("Reverse the order of the rules within the rule set");
|
||||
ruleSetResponse.setRuleIds(Lists.reverse(ruleSetResponse.getRuleIds()));
|
||||
RestRuleSetModel ruleSet = restClient.authenticateUser(user).withCoreAPI().usingNode(folder)
|
||||
.include("ruleIds").updateRuleSet(ruleSetResponse);
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
List<String> reversedRuleIds = Lists.reverse(rules.stream().map(RestRuleModel::getId).collect(toList()));
|
||||
ruleSet.assertThat().field("ruleIds").is(reversedRuleIds);
|
||||
}
|
||||
|
||||
/** Check that a user cannot reorder the rules in a rule set if they only have read permission. */
|
||||
@Test
|
||||
public void reorderRulesWithoutPermission()
|
||||
{
|
||||
STEP("Create a site owned by admin and add user as a consumer");
|
||||
SiteModel siteModel = dataSite.usingAdmin().createPrivateRandomSite();
|
||||
dataUser.addUserToSite(user, siteModel, UserRole.SiteContributor);
|
||||
|
||||
STEP("Use admin to create a folder with a rule set and three rules in it");
|
||||
FolderModel ruleFolder = dataContent.usingAdmin().usingSite(siteModel).createFolder();
|
||||
dataContent.usingAdmin().usingResource(ruleFolder).createFolder();
|
||||
List<RestRuleModel> rules = createRulesInFolder(ruleFolder, dataUser.getAdminUser());
|
||||
|
||||
STEP("Try to reorder the rules as the contributor");
|
||||
List<String> reversedRuleIds = Lists.reverse(rules.stream().map(RestRuleModel::getId).collect(toList()));
|
||||
RestRuleSetModel ruleSetBody = new RestRuleSetModel();
|
||||
ruleSetBody.setId("-default-");
|
||||
ruleSetBody.setRuleIds(reversedRuleIds);
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder)
|
||||
.include("ruleIds").updateRuleSet(ruleSetBody);
|
||||
|
||||
restClient.assertStatusCodeIs(FORBIDDEN);
|
||||
}
|
||||
|
||||
/** Check that a user can reorder the rules in a rule set if they have write permission. */
|
||||
@Test
|
||||
public void reorderRulesWithPermission()
|
||||
{
|
||||
STEP("Create a site owned by admin and add user as a collaborator");
|
||||
SiteModel siteModel = dataSite.usingAdmin().createPrivateRandomSite();
|
||||
dataUser.addUserToSite(user, siteModel, UserRole.SiteCollaborator);
|
||||
|
||||
STEP("Use admin to create a folder with a rule set and three rules in it");
|
||||
FolderModel ruleFolder = dataContent.usingAdmin().usingSite(siteModel).createFolder();
|
||||
dataContent.usingAdmin().usingResource(ruleFolder).createFolder();
|
||||
List<RestRuleModel> rules = createRulesInFolder(ruleFolder, dataUser.getAdminUser());
|
||||
|
||||
STEP("Try to reorder the rules as the contributor");
|
||||
List<String> reversedRuleIds = Lists.reverse(rules.stream().map(RestRuleModel::getId).collect(toList()));
|
||||
RestRuleSetModel ruleSetBody = new RestRuleSetModel();
|
||||
ruleSetBody.setId("-default-");
|
||||
ruleSetBody.setRuleIds(reversedRuleIds);
|
||||
RestRuleSetModel ruleSet = restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder)
|
||||
.include("ruleIds").updateRuleSet(ruleSetBody);
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
ruleSet.assertThat().field("ruleIds").is(reversedRuleIds);
|
||||
}
|
||||
|
||||
/** Create three rules in the given folder. */
|
||||
private List<RestRuleModel> createRulesInFolder(FolderModel folder, UserModel user)
|
||||
{
|
||||
return IntStream.range(0, 3).mapToObj(index ->
|
||||
{
|
||||
RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
return restClient.authenticateUser(user).withCoreAPI().usingNode(folder).usingDefaultRuleSet().createSingleRule(ruleModel);
|
||||
}).collect(toList());
|
||||
}
|
||||
}
|
@@ -26,10 +26,15 @@
|
||||
package org.alfresco.rest.rules;
|
||||
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createRuleModel;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createRuleModelWithDefaultValues;
|
||||
import static org.alfresco.utility.constants.UserRole.SiteConsumer;
|
||||
import static org.alfresco.utility.report.log.Step.STEP;
|
||||
import static org.springframework.http.HttpStatus.BAD_REQUEST;
|
||||
import static org.springframework.http.HttpStatus.CREATED;
|
||||
import static org.springframework.http.HttpStatus.FORBIDDEN;
|
||||
import static org.springframework.http.HttpStatus.NOT_FOUND;
|
||||
import static org.springframework.http.HttpStatus.NO_CONTENT;
|
||||
import static org.springframework.http.HttpStatus.OK;
|
||||
|
||||
import org.alfresco.dataprep.CMISUtil;
|
||||
import org.alfresco.rest.RestTest;
|
||||
@@ -169,7 +174,6 @@ public class RuleSetLinksTests extends RestTest
|
||||
.get(0).onModel().assertThat().isEqualTo(expectedRuleSet);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Check we get 404 when linking to a non-existing rule set/folder.
|
||||
*/
|
||||
@@ -310,4 +314,191 @@ public class RuleSetLinksTests extends RestTest
|
||||
.get(0).onModel().assertThat().isEqualTo(expectedRuleSet);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we get an error when trying to link to a rule set that we can't view.
|
||||
*/
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES })
|
||||
public void linkToRuleSetWithoutPermission()
|
||||
{
|
||||
STEP("Use admin to create a private site with a folder containing a rule.");
|
||||
SiteModel privateSite = dataSite.usingAdmin().createPrivateRandomSite();
|
||||
FolderModel privateFolder = dataContent.usingAdmin().usingSite(privateSite).createFolder();
|
||||
restClient.authenticateUser(dataUser.getAdminUser()).withCoreAPI().usingNode(privateFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(createRuleModelWithDefaultValues());
|
||||
|
||||
STEP("Use a normal user to try to link to the rule.");
|
||||
FolderModel publicFolder = dataContent.usingUser(user).usingSite(site).createFolder();
|
||||
RestRuleSetLinkModel request = new RestRuleSetLinkModel();
|
||||
request.setId(privateFolder.getNodeRef());
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(publicFolder).createRuleLink(request);
|
||||
|
||||
restClient.assertStatusCodeIs(FORBIDDEN);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we are able to link to a rule set with only read permission.
|
||||
*/
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES })
|
||||
public void linkToRuleSetWithOnlyReadPermission()
|
||||
{
|
||||
STEP("Use admin to create a private site with a folder containing a rule.");
|
||||
SiteModel privateSite = dataSite.usingAdmin().createPrivateRandomSite();
|
||||
FolderModel privateFolder = dataContent.usingAdmin().usingSite(privateSite).createFolder();
|
||||
restClient.authenticateUser(dataUser.getAdminUser()).withCoreAPI().usingNode(privateFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(createRuleModelWithDefaultValues());
|
||||
|
||||
STEP("Add the normal user as a consumer.");
|
||||
dataUser.usingAdmin().addUserToSite(user, privateSite, SiteConsumer);
|
||||
|
||||
STEP("Use a normal user to try to link to the rule.");
|
||||
FolderModel publicFolder = dataContent.usingUser(user).usingSite(site).createFolder();
|
||||
RestRuleSetLinkModel request = new RestRuleSetLinkModel();
|
||||
request.setId(privateFolder.getNodeRef());
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(publicFolder).createRuleLink(request);
|
||||
|
||||
restClient.assertStatusCodeIs(CREATED);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we can DELETE/unlink a ruleset
|
||||
*
|
||||
* DELETE /nodes/{folderNodeId}/rule-set-links/{ruleSetId}.
|
||||
*/
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void unlinkRuleSet()
|
||||
{
|
||||
STEP("Create folders in existing site");
|
||||
final FolderModel ruleFolder = dataContent.usingUser(user).usingSite(site).createFolder();
|
||||
final FolderModel folder = dataContent.usingUser(user).usingSite(site).createFolder();
|
||||
|
||||
STEP("Create a rule in the rule folder.");
|
||||
RestRuleModel ruleModel = createRuleModel("ruleName");
|
||||
RestRuleModel rule = restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(ruleModel);
|
||||
|
||||
STEP("Get the rule sets for the folder and find the rule set id");
|
||||
final RestRuleSetModelsCollection ruleSets = restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder)
|
||||
.getListOfRuleSets();
|
||||
ruleSets.assertThat().entriesListCountIs(1);
|
||||
final String ruleSetId = ruleSets.getEntries().get(0).onModel().getId();
|
||||
|
||||
STEP("Link to a rule folder");
|
||||
final RestRuleSetLinkModel request = new RestRuleSetLinkModel();
|
||||
request.setId(ruleFolder.getNodeRef());
|
||||
final RestRuleSetLinkModel ruleLink = restClient.authenticateUser(user).withCoreAPI().usingNode(folder).createRuleLink(request);
|
||||
|
||||
STEP("Unlink the rule set");
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(folder).unlinkRuleSet(ruleSetId);
|
||||
|
||||
STEP("Assert unlink result");
|
||||
restClient.assertStatusCodeIs(NO_CONTENT);
|
||||
|
||||
STEP("GET the rule set and isLinkedTo field.");
|
||||
RestRuleSetModel ruleSet = restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder)
|
||||
.include("isLinkedTo", "linkedToBy", "owningFolder")
|
||||
.getDefaultRuleSet();
|
||||
|
||||
STEP("Assert linkedTo is false.");
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
ruleSet.assertThat().field("isLinkedTo").is(false)
|
||||
.assertThat().field("linkedToBy").isEmpty();;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check a 400 is thrown when using folder/content id instead of a ruleSetId.
|
||||
*
|
||||
* DELETE /nodes/{folderNodeId}/rule-set-links/{ruleSetId}
|
||||
*/
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void unlinkUsingDocumentId()
|
||||
{
|
||||
STEP("Create folders in existing site");
|
||||
final FolderModel folder = dataContent.usingUser(user).usingSite(site).createFolder();
|
||||
|
||||
STEP("Attempt to unlink the rule set");
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(folder).unlinkRuleSet(folder.getNodeRef());
|
||||
|
||||
STEP("Assert unlink result");
|
||||
restClient.assertStatusCodeIs(BAD_REQUEST)
|
||||
.assertLastError().containsSummary("NodeId of a rule set is expected!");
|
||||
}
|
||||
|
||||
/**
|
||||
* Check a 404 is thrown when using non-existent id instead of a ruleSetId.
|
||||
*
|
||||
* DELETE /nodes/{folderNodeId}/rule-set-links/{ruleSetId}
|
||||
*/
|
||||
//TODO This test may need to be modified once ACS-3616 is done
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void unlinkUsingRandomId()
|
||||
{
|
||||
STEP("Create folders in existing site");
|
||||
final FolderModel folder = dataContent.usingUser(user).usingSite(site).createFolder();
|
||||
|
||||
STEP("Attempt to unlink the rule set");
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(folder).unlinkRuleSet("non-existent-id");
|
||||
|
||||
STEP("Assert unlink result");
|
||||
restClient.assertStatusCodeIs(NOT_FOUND)
|
||||
.assertLastError().containsSummary("Rule set with id non-existent-id was not found");
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we cannot unlink from a rule set that we can't view.
|
||||
*/
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES })
|
||||
public void unlinkFromRuleSetWithoutPermission()
|
||||
{
|
||||
STEP("Use admin to create a private site with a folder containing a rule.");
|
||||
SiteModel privateSite = dataSite.usingAdmin().createPrivateRandomSite();
|
||||
FolderModel privateFolder = dataContent.usingAdmin().usingSite(privateSite).createFolder();
|
||||
restClient.authenticateUser(dataUser.getAdminUser()).withCoreAPI().usingNode(privateFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(createRuleModelWithDefaultValues());
|
||||
|
||||
STEP("Add the user as a consumer.");
|
||||
dataUser.usingAdmin().addUserToSite(user, privateSite, SiteConsumer);
|
||||
|
||||
STEP("Use the consumer to create a folder with a link to the private rule set.");
|
||||
FolderModel publicFolder = dataContent.usingUser(user).usingSite(site).createFolder();
|
||||
RestRuleSetLinkModel request = new RestRuleSetLinkModel();
|
||||
request.setId(privateFolder.getNodeRef());
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(publicFolder).createRuleLink(request);
|
||||
restClient.assertStatusCodeIs(CREATED);
|
||||
|
||||
STEP("Remove the user from the private site.");
|
||||
dataUser.usingAdmin().removeUserFromSite(user, privateSite);
|
||||
|
||||
STEP("Use the user to try to unlink from the rule set.");
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(publicFolder).unlinkRuleSet("-default-");
|
||||
|
||||
restClient.assertStatusCodeIs(FORBIDDEN);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we can unlink from a rule set if we only have read permission for it.
|
||||
*/
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES })
|
||||
public void unlinkFromRuleSetWithOnlyReadPermission()
|
||||
{
|
||||
STEP("Use admin to create a private site with a folder containing a rule.");
|
||||
SiteModel privateSite = dataSite.usingAdmin().createPrivateRandomSite();
|
||||
FolderModel privateFolder = dataContent.usingAdmin().usingSite(privateSite).createFolder();
|
||||
restClient.authenticateUser(dataUser.getAdminUser()).withCoreAPI().usingNode(privateFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(createRuleModelWithDefaultValues());
|
||||
|
||||
STEP("Add the user as a consumer.");
|
||||
dataUser.usingAdmin().addUserToSite(user, privateSite, SiteConsumer);
|
||||
|
||||
STEP("Use the consumer to create a folder with a link to the private rule set.");
|
||||
FolderModel publicFolder = dataContent.usingUser(user).usingSite(site).createFolder();
|
||||
RestRuleSetLinkModel request = new RestRuleSetLinkModel();
|
||||
request.setId(privateFolder.getNodeRef());
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(publicFolder).createRuleLink(request);
|
||||
restClient.assertStatusCodeIs(CREATED);
|
||||
|
||||
STEP("Use the consumer to try to unlink from the rule set.");
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(publicFolder).unlinkRuleSet("-default-");
|
||||
|
||||
restClient.assertStatusCodeIs(NO_CONTENT);
|
||||
}
|
||||
}
|
||||
|
@@ -25,12 +25,19 @@
|
||||
*/
|
||||
package org.alfresco.rest.rules;
|
||||
|
||||
import static org.alfresco.rest.actions.access.AccessRestrictionUtil.MAIL_ACTION;
|
||||
import static org.alfresco.rest.actions.access.AccessRestrictionUtil.createMailParameters;
|
||||
import static org.alfresco.utility.model.UserModel.getRandomUserModel;
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import org.alfresco.rest.model.RestActionBodyExecTemplateModel;
|
||||
import org.alfresco.rest.model.RestCompositeConditionDefinitionModel;
|
||||
import org.alfresco.rest.model.RestNodeModel;
|
||||
import org.alfresco.rest.model.RestRuleExecutionModel;
|
||||
import org.alfresco.rest.model.RestRuleModel;
|
||||
import org.alfresco.rest.model.RestSimpleConditionDefinitionModel;
|
||||
|
||||
@@ -43,24 +50,37 @@ public class RulesTestsUtils
|
||||
static final boolean RULE_ASYNC_DEFAULT = true;
|
||||
static final boolean RULE_SHARED_DEFAULT = false;
|
||||
static final String RULE_ERROR_SCRIPT_DEFAULT = "error-script";
|
||||
static final List<String> ruleTriggersDefault = List.of("inbound", "update", "outbound");
|
||||
static final String INBOUND = "inbound";
|
||||
static final String UPDATE = "update";
|
||||
static final String OUTBOUND = "outbound";
|
||||
static final List<String> RULE_TRIGGERS_DEFAULT = List.of(INBOUND, UPDATE, OUTBOUND);
|
||||
static final boolean INVERTED = true;
|
||||
static final String AND = "and";
|
||||
static final String ID = "id";
|
||||
static final String IS_SHARED = "isShared";
|
||||
static final String AUDIO_ASPECT = "audio:audio";
|
||||
static final String LOCKABLE_ASPECT = "cm:lockable";
|
||||
|
||||
/**
|
||||
* Create a rule model filled with default values.
|
||||
*
|
||||
* @return The created rule model.
|
||||
*/
|
||||
public static RestRuleModel createRuleModelWithModifiedValues()
|
||||
{
|
||||
RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
return createRuleModelWithModifiedValues(List.of(createAddAudioAspectAction()));
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a rule model filled with custom constant values.
|
||||
*
|
||||
* @param actions - rule's actions.
|
||||
* @return The created rule model.
|
||||
*/
|
||||
public static RestRuleModel createRuleModelWithModifiedValues(List<RestActionBodyExecTemplateModel> actions)
|
||||
{
|
||||
RestRuleModel ruleModel = createRuleModel(RULE_NAME_DEFAULT, actions);
|
||||
ruleModel.setDescription(RULE_DESCRIPTION_DEFAULT);
|
||||
ruleModel.setEnabled(RULE_ENABLED_DEFAULT);
|
||||
ruleModel.setCascade(RULE_CASCADE_DEFAULT);
|
||||
ruleModel.setAsynchronous(RULE_ASYNC_DEFAULT);
|
||||
ruleModel.setIsEnabled(RULE_ENABLED_DEFAULT);
|
||||
ruleModel.setIsInheritable(RULE_CASCADE_DEFAULT);
|
||||
ruleModel.setIsAsynchronous(RULE_ASYNC_DEFAULT);
|
||||
ruleModel.setIsShared(RULE_SHARED_DEFAULT);
|
||||
ruleModel.setTriggers(ruleTriggersDefault);
|
||||
ruleModel.setTriggers(RULE_TRIGGERS_DEFAULT);
|
||||
ruleModel.setErrorScript(RULE_ERROR_SCRIPT_DEFAULT);
|
||||
|
||||
return ruleModel;
|
||||
@@ -68,26 +88,27 @@ public class RulesTestsUtils
|
||||
|
||||
public static RestRuleModel createRuleModelWithDefaultValues()
|
||||
{
|
||||
return createRuleModel(RULE_NAME_DEFAULT, List.of(createDefaultActionModel()));
|
||||
return createRuleModel(RULE_NAME_DEFAULT);
|
||||
}
|
||||
|
||||
public static RestRuleModel createRuleModel(String name)
|
||||
{
|
||||
return createRuleModel(name, List.of(createDefaultActionModel()));
|
||||
return createRuleModel(name, List.of(createAddAudioAspectAction()));
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a rule model.
|
||||
*
|
||||
* @param name The name for the rule.
|
||||
* @param restActionModels Rule's actions.
|
||||
* @param actions Rule's actions.
|
||||
* @return The created rule model.
|
||||
*/
|
||||
public static RestRuleModel createRuleModel(String name, List<RestActionBodyExecTemplateModel> restActionModels)
|
||||
public static RestRuleModel createRuleModel(String name, List<RestActionBodyExecTemplateModel> actions)
|
||||
{
|
||||
RestRuleModel ruleModel = new RestRuleModel();
|
||||
ruleModel.setIsEnabled(true);
|
||||
ruleModel.setName(name);
|
||||
ruleModel.setActions(restActionModels);
|
||||
ruleModel.setActions(actions);
|
||||
return ruleModel;
|
||||
}
|
||||
|
||||
@@ -96,12 +117,14 @@ public class RulesTestsUtils
|
||||
*
|
||||
* @return The created action model.
|
||||
*/
|
||||
public static RestActionBodyExecTemplateModel createDefaultActionModel()
|
||||
public static RestActionBodyExecTemplateModel createAddAudioAspectAction()
|
||||
{
|
||||
RestActionBodyExecTemplateModel restActionModel = new RestActionBodyExecTemplateModel();
|
||||
restActionModel.setActionDefinitionId("set-property-value");
|
||||
restActionModel.setParams(Map.of("aspect-name", "cm:audio"));
|
||||
return restActionModel;
|
||||
return createAddAspectAction(AUDIO_ASPECT);
|
||||
}
|
||||
|
||||
public static RestActionBodyExecTemplateModel createAddAspectAction(String aspect)
|
||||
{
|
||||
return createCustomActionModel("add-features", Map.of("aspect-name", aspect));
|
||||
}
|
||||
|
||||
public static RestActionBodyExecTemplateModel createCustomActionModel(String actionDefinitionId, Map<String, Serializable> params)
|
||||
@@ -133,12 +156,39 @@ public class RulesTestsUtils
|
||||
createSimpleCondition("tag", "equals", "uat")
|
||||
)),
|
||||
createCompositeCondition(INVERTED, List.of(
|
||||
createSimpleCondition("aspect", "equals", "audio:audio"),
|
||||
createSimpleCondition("aspect", "equals", AUDIO_ASPECT),
|
||||
createSimpleCondition("cm:modelVersion", "begins", "1.")
|
||||
))
|
||||
));
|
||||
}
|
||||
|
||||
public static RestRuleModel createVariousActions()
|
||||
{
|
||||
final Map<String, Serializable> copyParams =
|
||||
Map.of("destination-folder", "dummy-folder-node", "deep-copy", true);
|
||||
final RestActionBodyExecTemplateModel copyAction = createCustomActionModel("copy", copyParams);
|
||||
final Map<String, Serializable> checkOutParams =
|
||||
Map.of("destination-folder", "fake-folder-node", "assoc-name", "cm:checkout", "assoc-type",
|
||||
"cm:contains");
|
||||
final RestActionBodyExecTemplateModel checkOutAction = createCustomActionModel("check-out", checkOutParams);
|
||||
// The counter action takes no parameters, so check we can omit the "params" entry.
|
||||
final RestActionBodyExecTemplateModel counterAction = createCustomActionModel("counter", null);
|
||||
final RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
ruleModel.setActions(Arrays.asList(copyAction, checkOutAction, counterAction));
|
||||
|
||||
return ruleModel;
|
||||
}
|
||||
|
||||
public static RestRuleModel createRuleWithPrivateAction()
|
||||
{
|
||||
RestActionBodyExecTemplateModel mailAction = new RestActionBodyExecTemplateModel();
|
||||
mailAction.setActionDefinitionId(MAIL_ACTION);
|
||||
mailAction.setParams(createMailParameters(getRandomUserModel(), getRandomUserModel()));
|
||||
RestRuleModel ruleModel = createRuleModelWithDefaultValues();
|
||||
ruleModel.setActions(Arrays.asList(mailAction));
|
||||
return ruleModel;
|
||||
}
|
||||
|
||||
public static RestSimpleConditionDefinitionModel createSimpleCondition(String field, String comparator, String parameter)
|
||||
{
|
||||
RestSimpleConditionDefinitionModel simpleCondition = new RestSimpleConditionDefinitionModel();
|
||||
@@ -159,6 +209,19 @@ public class RulesTestsUtils
|
||||
return createCompositeCondition(AND, inverted, null, simpleConditions);
|
||||
}
|
||||
|
||||
public static RestRuleExecutionModel createRuleExecutionRequest()
|
||||
{
|
||||
return createRuleExecutionRequest(false);
|
||||
}
|
||||
|
||||
public static RestRuleExecutionModel createRuleExecutionRequest(boolean eachSubFolderIncluded)
|
||||
{
|
||||
RestRuleExecutionModel ruleExecutionBody = new RestRuleExecutionModel();
|
||||
ruleExecutionBody.setIsEachSubFolderIncluded(eachSubFolderIncluded);
|
||||
|
||||
return ruleExecutionBody;
|
||||
}
|
||||
|
||||
private static RestCompositeConditionDefinitionModel createCompositeCondition(String booleanMode, boolean inverted,
|
||||
List<RestCompositeConditionDefinitionModel> compositeConditions, List<RestSimpleConditionDefinitionModel> simpleConditions)
|
||||
{
|
||||
@@ -170,4 +233,31 @@ public class RulesTestsUtils
|
||||
|
||||
return compositeCondition;
|
||||
}
|
||||
|
||||
public static NodeAssertion assertThat(RestNodeModel node)
|
||||
{
|
||||
return new NodeAssertion(node);
|
||||
}
|
||||
|
||||
public static class NodeAssertion
|
||||
{
|
||||
private final RestNodeModel node;
|
||||
|
||||
private NodeAssertion(RestNodeModel node)
|
||||
{
|
||||
this.node = node;
|
||||
}
|
||||
|
||||
public NodeAssertion containsAspects(String ...expectedAspects)
|
||||
{
|
||||
Arrays.stream(expectedAspects).forEach(aspect -> node.assertThat().field("aspectNames").contains(aspect));
|
||||
return this;
|
||||
}
|
||||
|
||||
public NodeAssertion notContainsAspects(String ...unexpectedAspects)
|
||||
{
|
||||
Arrays.stream(unexpectedAspects).forEach(aspect -> node.assertThat().field("aspectNames").notContains(aspect));
|
||||
return this;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@@ -94,7 +94,7 @@ public class SetInheritanceTests extends RestTest
|
||||
.retrieveSetting();
|
||||
|
||||
restClient.assertLastError().statusCodeIs(NOT_FOUND)
|
||||
.containsSummary("The entity with id: fake-id was not found");
|
||||
.containsSummary("Folder with id fake-id was not found");
|
||||
}
|
||||
|
||||
/** Check we get an error when trying to retrieve a non-existent setting. */
|
||||
@@ -188,7 +188,7 @@ public class SetInheritanceTests extends RestTest
|
||||
.updateSetting(updateBody);
|
||||
|
||||
restClient.assertLastError().statusCodeIs(NOT_FOUND)
|
||||
.containsSummary("The entity with id: fake-id was not found");
|
||||
.containsSummary("Folder with id fake-id was not found");
|
||||
}
|
||||
|
||||
/** Check we get an error when trying to set a non-existent setting. */
|
||||
|
@@ -25,21 +25,40 @@
|
||||
*/
|
||||
package org.alfresco.rest.rules;
|
||||
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createDefaultActionModel;
|
||||
import static org.alfresco.rest.actions.access.AccessRestrictionUtil.ERROR_MESSAGE_ACCESS_RESTRICTED;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.ID;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.INBOUND;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.INVERTED;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.IS_SHARED;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.RULE_ASYNC_DEFAULT;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.RULE_CASCADE_DEFAULT;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.RULE_ENABLED_DEFAULT;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createCompositeCondition;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createCustomActionModel;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createAddAudioAspectAction;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createRuleModel;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createRuleModelWithModifiedValues;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createRuleWithPrivateAction;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createSimpleCondition;
|
||||
import static org.alfresco.rest.rules.RulesTestsUtils.createVariousConditions;
|
||||
import static org.alfresco.utility.constants.UserRole.SiteCollaborator;
|
||||
import static org.alfresco.utility.report.log.Step.STEP;
|
||||
import static org.springframework.http.HttpStatus.BAD_REQUEST;
|
||||
import static org.springframework.http.HttpStatus.FORBIDDEN;
|
||||
import static org.springframework.http.HttpStatus.INTERNAL_SERVER_ERROR;
|
||||
import static org.springframework.http.HttpStatus.NOT_FOUND;
|
||||
import static org.springframework.http.HttpStatus.OK;
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import com.google.common.collect.ImmutableMap;
|
||||
|
||||
import org.alfresco.rest.RestTest;
|
||||
import org.alfresco.rest.model.RestActionBodyExecTemplateModel;
|
||||
import org.alfresco.rest.model.RestCompositeConditionDefinitionModel;
|
||||
import org.alfresco.rest.model.RestRuleModel;
|
||||
import org.alfresco.utility.model.FolderModel;
|
||||
import org.alfresco.utility.model.SiteModel;
|
||||
@@ -82,9 +101,9 @@ public class UpdateRulesTests extends RestTest
|
||||
.updateRule(rule.getId(), updatedRuleModel);
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
updatedRule.assertThat().field("id").is(rule.getId())
|
||||
updatedRule.assertThat().field(ID).is(rule.getId())
|
||||
.assertThat().field("name").is("Updated rule name")
|
||||
.assertThat().field("isShared").isNull();
|
||||
.assertThat().field(IS_SHARED).isNull();
|
||||
}
|
||||
|
||||
/** Check we get a 404 if trying to update a rule in a folder that doesn't exist. */
|
||||
@@ -103,7 +122,7 @@ public class UpdateRulesTests extends RestTest
|
||||
.updateRule(rule.getId(), updatedRuleModel);
|
||||
|
||||
restClient.assertLastError().statusCodeIs(NOT_FOUND)
|
||||
.containsSummary("fake-id was not found");
|
||||
.containsSummary("Folder with id fake-id was not found");
|
||||
}
|
||||
|
||||
/** Check we get a 404 if trying to update a rule in a rule set that doesn't exist. */
|
||||
@@ -119,7 +138,7 @@ public class UpdateRulesTests extends RestTest
|
||||
.updateRule(rule.getId(), updatedRuleModel);
|
||||
|
||||
restClient.assertLastError().statusCodeIs(NOT_FOUND)
|
||||
.containsSummary("fake-id was not found");
|
||||
.containsSummary("Rule set with id fake-id was not found");
|
||||
}
|
||||
|
||||
/** Check we get a 404 if trying to update a rule that doesn't exist. */
|
||||
@@ -182,7 +201,7 @@ public class UpdateRulesTests extends RestTest
|
||||
RestRuleModel updatedRule = restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.updateRule(rule.getId(), updatedRuleModel);
|
||||
|
||||
updatedRule.assertThat().field("id").is(rule.getId());
|
||||
updatedRule.assertThat().field(ID).is(rule.getId());
|
||||
}
|
||||
|
||||
/** Check we can update a rule and get the included fields. */
|
||||
@@ -194,10 +213,50 @@ public class UpdateRulesTests extends RestTest
|
||||
STEP("Try to update the rule.");
|
||||
RestRuleModel updatedRuleModel = createRuleModel("Updated rule name");
|
||||
RestRuleModel updatedRule = restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.include("isShared")
|
||||
.include(IS_SHARED)
|
||||
.updateRule(rule.getId(), updatedRuleModel);
|
||||
|
||||
updatedRule.assertThat().field("isShared").isNotNull();
|
||||
updatedRule.assertThat().field(IS_SHARED).isNotNull();
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we get error when attempt to update a rule to one without any actions.
|
||||
*/
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void updateRuleWithoutActionsShouldFail()
|
||||
{
|
||||
RestRuleModel rule = createAndSaveRule("Rule name");
|
||||
|
||||
STEP("Try to update the rule - set no actions.");
|
||||
rule.setActions(null);
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.include(IS_SHARED)
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(BAD_REQUEST);
|
||||
restClient.assertLastError().containsSummary("A rule must have at least one action");
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we get error when attempt to update a rule to one with invalid action.
|
||||
*/
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void updateRuleWithInvalidActionDefinitionShouldFail()
|
||||
{
|
||||
RestRuleModel rule = createAndSaveRule("Rule name");
|
||||
|
||||
STEP("Try to update the rule - set no actions.");
|
||||
final RestActionBodyExecTemplateModel invalidAction = new RestActionBodyExecTemplateModel();
|
||||
final String actionDefinitionId = "invalid-definition-value";
|
||||
invalidAction.setActionDefinitionId(actionDefinitionId);
|
||||
invalidAction.setParams(Map.of("dummy-key", "dummy-value"));
|
||||
rule.setActions(List.of(invalidAction));
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.include(IS_SHARED)
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(BAD_REQUEST);
|
||||
restClient.assertLastError().containsSummary(String.format("Invalid action definition requested %s", actionDefinitionId));
|
||||
}
|
||||
|
||||
/** Check we can use the POST response to create the new rule. */
|
||||
@@ -214,7 +273,7 @@ public class UpdateRulesTests extends RestTest
|
||||
STEP("Try to update the rule.");
|
||||
rule.setName("Updated rule name");
|
||||
RestRuleModel updatedRule = restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.include("isShared")
|
||||
.include(IS_SHARED)
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
@@ -223,9 +282,294 @@ public class UpdateRulesTests extends RestTest
|
||||
.assertThat().field("actions.params").is(List.of(ImmutableMap.of("destination-folder", destination.getNodeRef())));
|
||||
}
|
||||
|
||||
/** Check we can use the POST response and update rule fields. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.SANITY })
|
||||
public void updateRuleFields()
|
||||
{
|
||||
final RestRuleModel rule = createAndSaveRule(createRuleModelWithModifiedValues());
|
||||
|
||||
STEP("Try to update the rule fields.");
|
||||
rule.setName("Updated rule name");
|
||||
rule.setTriggers(List.of(INBOUND));
|
||||
final String updatedDescription = "Updated description";
|
||||
rule.setDescription(updatedDescription);
|
||||
rule.setIsEnabled(!RULE_ENABLED_DEFAULT);
|
||||
rule.setIsInheritable(!RULE_CASCADE_DEFAULT);
|
||||
rule.setIsAsynchronous(!RULE_ASYNC_DEFAULT);
|
||||
final String updatedErrorScript = "updated-error-script";
|
||||
rule.setErrorScript(updatedErrorScript);
|
||||
final RestRuleModel updatedRule = restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
updatedRule.assertThat().isEqualTo(rule, ID)
|
||||
.assertThat().field(ID).isNotNull();
|
||||
}
|
||||
|
||||
/** Check we can use the POST response and update rule by adding conditions. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.SANITY })
|
||||
public void updateRuleAddConditions()
|
||||
{
|
||||
final RestRuleModel rule = createAndSaveRule(createRuleModelWithModifiedValues());
|
||||
|
||||
STEP("Try to update the rule and add conditions.");
|
||||
rule.setConditions(createVariousConditions());
|
||||
|
||||
final RestRuleModel updatedRule = restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
updatedRule.assertThat().isEqualTo(rule, ID)
|
||||
.assertThat().field(ID).isNotNull();
|
||||
}
|
||||
|
||||
/** Check we can use the POST response and update a rule rule without any conditions by adding null conditions. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.SANITY })
|
||||
public void updateRuleAddNullConditions()
|
||||
{
|
||||
final RestRuleModel rule = createAndSaveRule(createRuleModelWithModifiedValues());
|
||||
|
||||
STEP("Try to update the rule and add null conditions.");
|
||||
rule.setConditions(null);
|
||||
|
||||
final RestRuleModel updatedRule = restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
updatedRule.assertThat().isEqualTo(rule, ID)
|
||||
.assertThat().field(ID).isNotNull();
|
||||
}
|
||||
|
||||
/** Check we can use the POST response and update rule by modifying conditions. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.SANITY })
|
||||
public void updateRuleModifyConditions()
|
||||
{
|
||||
final RestRuleModel ruleModelWithInitialValues = createRuleModelWithModifiedValues();
|
||||
ruleModelWithInitialValues.setConditions(createVariousConditions());
|
||||
final RestRuleModel rule = createAndSaveRule(ruleModelWithInitialValues);
|
||||
|
||||
STEP("Try to update the rule and modify conditions.");
|
||||
final RestCompositeConditionDefinitionModel compositeCondition = createCompositeCondition(
|
||||
List.of(createCompositeCondition(false, List.of(createSimpleCondition("tag", "equals", "sample_tag")))));
|
||||
rule.setConditions(compositeCondition);
|
||||
|
||||
final RestRuleModel updatedRule = restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
updatedRule.assertThat().isEqualTo(rule, ID)
|
||||
.assertThat().field(ID).isNotNull();
|
||||
}
|
||||
|
||||
/** Check we can use the POST response and update rule by removing all conditions. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.SANITY })
|
||||
public void updateRuleRemoveAllConditions()
|
||||
{
|
||||
final RestRuleModel ruleModelWithInitialValues = createRuleModelWithModifiedValues();
|
||||
ruleModelWithInitialValues.setConditions(createVariousConditions());
|
||||
final RestRuleModel rule = createAndSaveRule(ruleModelWithInitialValues);
|
||||
|
||||
STEP("Try to update the rule and remove all conditions.");
|
||||
rule.setConditions(null);
|
||||
|
||||
final RestRuleModel updatedRule = restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
updatedRule.assertThat().isEqualTo(rule, ID)
|
||||
.assertThat().field(ID).isNotNull();
|
||||
}
|
||||
|
||||
/** Check we get a 400 error when using the POST response and update rule by adding condition with invalid category. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.SANITY })
|
||||
public void updateRuleWithInvalidCategoryInConditionAndFail()
|
||||
{
|
||||
final RestRuleModel ruleModelWithInitialValues = createRuleModelWithModifiedValues();
|
||||
ruleModelWithInitialValues.setConditions(createVariousConditions());
|
||||
final RestRuleModel rule = createAndSaveRule(ruleModelWithInitialValues);
|
||||
|
||||
STEP("Try to update the rule with invalid condition.");
|
||||
final RestCompositeConditionDefinitionModel conditions = createCompositeCondition(
|
||||
List.of(createCompositeCondition(!INVERTED, List.of(createSimpleCondition("category", "equals", "fake-category-id")))));
|
||||
rule.setConditions(conditions);
|
||||
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(BAD_REQUEST);
|
||||
restClient.assertLastError().containsSummary("Category in condition is invalid");
|
||||
}
|
||||
|
||||
/** Check we get a 400 error when using the POST response and update rule by adding condition without comparator when it is required. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.SANITY })
|
||||
public void updateRuleWithConditionWithoutComparatorAndFail()
|
||||
{
|
||||
final RestRuleModel ruleModelWithInitialValues = createRuleModelWithModifiedValues();
|
||||
ruleModelWithInitialValues.setConditions(createVariousConditions());
|
||||
final RestRuleModel rule = createAndSaveRule(ruleModelWithInitialValues);
|
||||
|
||||
STEP("Try to update the rule with invalid condition (null comparator when required non-null).");
|
||||
final RestCompositeConditionDefinitionModel conditions = createCompositeCondition(
|
||||
List.of(createCompositeCondition(!INVERTED, List.of(createSimpleCondition("size", null, "65500")))));
|
||||
rule.setConditions(conditions);
|
||||
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(BAD_REQUEST);
|
||||
restClient.assertLastError().containsSummary("Comparator in condition must not be blank");
|
||||
}
|
||||
|
||||
/** Check we get a 400 error when using the POST response and update rule by adding condition without field. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.SANITY })
|
||||
public void updateRuleWithConditionWithoutFieldAndFail()
|
||||
{
|
||||
final RestRuleModel ruleModelWithInitialValues = createRuleModelWithModifiedValues();
|
||||
ruleModelWithInitialValues.setConditions(createVariousConditions());
|
||||
final RestRuleModel rule = createAndSaveRule(ruleModelWithInitialValues);
|
||||
|
||||
STEP("Try to update the rule with invalid condition (null field).");
|
||||
final RestCompositeConditionDefinitionModel conditions = createCompositeCondition(
|
||||
List.of(createCompositeCondition(!INVERTED, List.of(createSimpleCondition(null, "greater_than", "65500")))));
|
||||
rule.setConditions(conditions);
|
||||
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(BAD_REQUEST);
|
||||
restClient.assertLastError().containsSummary("Field in condition must not be blank");
|
||||
}
|
||||
|
||||
/** Check we get a 400 error when using the POST response and update rule by adding condition without parameter value. */
|
||||
@Test (groups = { TestGroup.REST_API, TestGroup.RULES, TestGroup.SANITY })
|
||||
public void updateRuleWithConditionWithoutParamValueAndFail()
|
||||
{
|
||||
final RestRuleModel ruleModelWithInitialValues = createRuleModelWithModifiedValues();
|
||||
ruleModelWithInitialValues.setConditions(createVariousConditions());
|
||||
final RestRuleModel rule = createAndSaveRule(ruleModelWithInitialValues);
|
||||
|
||||
STEP("Try to update the rule with invalid condition (null parameter).");
|
||||
final RestCompositeConditionDefinitionModel conditions = createCompositeCondition(
|
||||
List.of(createCompositeCondition(!INVERTED, List.of(createSimpleCondition("size", "greater_than", "")))));
|
||||
rule.setConditions(conditions);
|
||||
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(BAD_REQUEST);
|
||||
restClient.assertLastError().containsSummary("Parameter in condition must not be blank");
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we can update a rule by adding several actions.
|
||||
*/
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void updateRuleAddActions()
|
||||
{
|
||||
final RestRuleModel rule = createAndSaveRule(createRuleModelWithModifiedValues());
|
||||
|
||||
STEP("Try to update the rule by adding several actions");
|
||||
final Map<String, Serializable> copyParams =
|
||||
Map.of("destination-folder", "dummy-folder-node", "deep-copy", true);
|
||||
final RestActionBodyExecTemplateModel copyAction = createCustomActionModel("copy", copyParams);
|
||||
final Map<String, Serializable> addAspectParams = Map.of("aspect-name", "cm:taggable");
|
||||
final RestActionBodyExecTemplateModel addAspectAction = createCustomActionModel("add-features", addAspectParams);
|
||||
rule.setActions(Arrays.asList(copyAction, addAspectAction));
|
||||
|
||||
final RestRuleModel updatedRule = restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
updatedRule.assertThat().isEqualTo(rule, ID)
|
||||
.assertThat().field(ID).isNotNull();
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we get a 400 error when attempting to update a rule by adding action with not allowed parameter.
|
||||
*/
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void updateRuleAddCheckoutActionForOutboundShouldFail()
|
||||
{
|
||||
final RestRuleModel rule = createAndSaveRule(createRuleModelWithModifiedValues());
|
||||
|
||||
STEP("Try to update the rule by adding checkout action");
|
||||
final Map<String, Serializable> checkOutParams =
|
||||
Map.of("destination-folder", "dummy-folder-node", "assoc-name", "cm:checkout", "assoc-type",
|
||||
"cm:contains");
|
||||
final RestActionBodyExecTemplateModel checkOutAction = createCustomActionModel("check-out", checkOutParams);
|
||||
final Map<String, Serializable> scriptParams = Map.of("script-ref", "dummy-script-node-id");
|
||||
rule.setActions(List.of(checkOutAction));
|
||||
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(BAD_REQUEST);
|
||||
restClient.assertLastError().containsSummary("Check out action cannot be performed for the rule type outbound!");
|
||||
}
|
||||
|
||||
/**
|
||||
* Check we get a 500 error when attempting to update a rule by adding action with parameter with non existing namespace in value.
|
||||
* In near future we need to fix this kind of negative path to return a 4xx error.
|
||||
*/
|
||||
@Test(groups = {TestGroup.REST_API, TestGroup.RULES})
|
||||
public void updateRuleAddActionWithInvalidParamShouldFail()
|
||||
{
|
||||
final RestRuleModel rule = createAndSaveRule(createRuleModelWithModifiedValues());
|
||||
|
||||
STEP("Try to update the rule by adding action with invalid parameter (non-existing namespace in value)");
|
||||
final RestActionBodyExecTemplateModel action = new RestActionBodyExecTemplateModel();
|
||||
action.setActionDefinitionId("add-features");
|
||||
final String aspectNameParam = "aspect-name";
|
||||
final String paramValue = "dummy:dummy";
|
||||
action.setParams(Map.of(aspectNameParam, paramValue));
|
||||
rule.setActions(List.of(action));
|
||||
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(BAD_REQUEST);
|
||||
restClient.assertLastError().containsSummary(
|
||||
String.format("Action parameter: %s has invalid value (%s). Look up possible values for constraint name %s",
|
||||
aspectNameParam, paramValue, "ac-aspects"));
|
||||
}
|
||||
|
||||
/** Check that a normal user cannot create rules that use private actions. */
|
||||
@Test
|
||||
public void updateRuleWithActions_userCannotUsePrivateAction()
|
||||
{
|
||||
STEP("Using admin create a rule with a private action.");
|
||||
RestRuleModel rule = restClient.authenticateUser(dataUser.getAdminUser()).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(createRuleWithPrivateAction());
|
||||
|
||||
STEP("Try to update the rule with a normal user.");
|
||||
rule.setName("Updated name");
|
||||
restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(FORBIDDEN)
|
||||
.assertLastError().containsSummary(ERROR_MESSAGE_ACCESS_RESTRICTED);
|
||||
}
|
||||
|
||||
/** Check that an administrator can create rules that use private actions. */
|
||||
@Test
|
||||
public void updateRuleWithActions_adminCanUsePrivateAction()
|
||||
{
|
||||
STEP("Using admin create a rule with a private action.");
|
||||
RestRuleModel rule = restClient.authenticateUser(dataUser.getAdminUser()).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(createRuleWithPrivateAction());
|
||||
|
||||
STEP("Try to update the rule with the admin user.");
|
||||
rule.setName("Updated name");
|
||||
RestRuleModel updatedRule = restClient.authenticateUser(dataUser.getAdminUser()).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.updateRule(rule.getId(), rule);
|
||||
|
||||
restClient.assertStatusCodeIs(OK);
|
||||
updatedRule.assertThat().field("name").is("Updated name");
|
||||
}
|
||||
|
||||
private RestRuleModel createAndSaveRule(String name)
|
||||
{
|
||||
return createAndSaveRule(name, List.of(createDefaultActionModel()));
|
||||
return createAndSaveRule(name, List.of(createAddAudioAspectAction()));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -242,4 +586,17 @@ public class UpdateRulesTests extends RestTest
|
||||
return restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(ruleModel);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a rule for folder and store it.
|
||||
*
|
||||
* @param ruleModel RuleModel used as create request
|
||||
* @return The created rule.
|
||||
*/
|
||||
private RestRuleModel createAndSaveRule(final RestRuleModel ruleModel)
|
||||
{
|
||||
STEP("Create a rule: " + ruleModel);
|
||||
return restClient.authenticateUser(user).withCoreAPI().usingNode(ruleFolder).usingDefaultRuleSet()
|
||||
.createSingleRule(ruleModel);
|
||||
}
|
||||
}
|
||||
|
@@ -35,10 +35,11 @@ public class GetDeploymentsSanityTests extends RestTest
|
||||
restClient.assertStatusCodeIs(HttpStatus.OK);
|
||||
deployments.assertThat().entriesListIsNotEmpty();
|
||||
deployments.getOneRandomEntry().onModel().assertThat()
|
||||
.fieldsCount().is(3).and()
|
||||
.fieldsCount().is(4).and()
|
||||
.field("id").isNotEmpty().and()
|
||||
.field("deployedAt").isNotEmpty().and()
|
||||
.field("name").isNotEmpty();
|
||||
.field("name").isNotEmpty().and()
|
||||
.field("category").isNotEmpty();
|
||||
}
|
||||
|
||||
}
|
||||
|
@@ -9,7 +9,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo-tests</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<developers>
|
||||
|
@@ -7,7 +7,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo-packaging</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<properties>
|
||||
|
49
pom.xml
49
pom.xml
@@ -2,7 +2,7 @@
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<artifactId>alfresco-community-repo</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
<packaging>pom</packaging>
|
||||
<name>Alfresco Community Repo Parent</name>
|
||||
|
||||
@@ -51,18 +51,18 @@
|
||||
<dependency.alfresco-log-sanitizer.version>0.2</dependency.alfresco-log-sanitizer.version>
|
||||
<dependency.activiti-engine.version>5.23.0</dependency.activiti-engine.version>
|
||||
<dependency.activiti.version>5.23.0</dependency.activiti.version>
|
||||
<dependency.alfresco-transform-service.version>1.5.4-A3</dependency.alfresco-transform-service.version>
|
||||
<dependency.alfresco-transform-core.version>2.7.0-A1</dependency.alfresco-transform-core.version>
|
||||
<dependency.alfresco-transform-service.version>2.0.0-A3</dependency.alfresco-transform-service.version>
|
||||
<dependency.alfresco-transform-core.version>3.0.0-A3</dependency.alfresco-transform-core.version>
|
||||
<dependency.alfresco-greenmail.version>6.4</dependency.alfresco-greenmail.version>
|
||||
<dependency.acs-event-model.version>0.0.16</dependency.acs-event-model.version>
|
||||
|
||||
<dependency.spring.version>5.3.22</dependency.spring.version>
|
||||
<dependency.antlr.version>3.5.2</dependency.antlr.version>
|
||||
<dependency.spring.version>5.3.23</dependency.spring.version>
|
||||
<dependency.antlr.version>3.5.3</dependency.antlr.version>
|
||||
<dependency.jackson.version>2.13.3</dependency.jackson.version>
|
||||
<dependency.jackson-databind.version>2.13.3</dependency.jackson-databind.version>
|
||||
<dependency.cxf.version>3.5.3</dependency.cxf.version>
|
||||
<dependency.opencmis.version>1.0.0</dependency.opencmis.version>
|
||||
<dependency.webscripts.version>8.31</dependency.webscripts.version>
|
||||
<dependency.webscripts.version>8.32</dependency.webscripts.version>
|
||||
<dependency.bouncycastle.version>1.70</dependency.bouncycastle.version>
|
||||
<dependency.mockito-core.version>4.6.1</dependency.mockito-core.version>
|
||||
<dependency.assertj.version>3.23.1</dependency.assertj.version>
|
||||
@@ -74,11 +74,11 @@
|
||||
<dependency.httpcore.version>4.4.15</dependency.httpcore.version>
|
||||
<dependency.commons-httpclient.version>3.1-HTTPCLIENT-1265</dependency.commons-httpclient.version>
|
||||
<dependency.xercesImpl.version>2.12.2</dependency.xercesImpl.version>
|
||||
<dependency.slf4j.version>1.7.36</dependency.slf4j.version>
|
||||
<dependency.slf4j.version>2.0.1</dependency.slf4j.version>
|
||||
<dependency.gytheio.version>0.17</dependency.gytheio.version>
|
||||
<dependency.groovy.version>3.0.12</dependency.groovy.version>
|
||||
<dependency.tika.version>2.4.1</dependency.tika.version>
|
||||
<dependency.spring-security.version>5.7.2</dependency.spring-security.version>
|
||||
<dependency.spring-security.version>5.7.3</dependency.spring-security.version>
|
||||
<dependency.truezip.version>7.7.10</dependency.truezip.version>
|
||||
<dependency.poi.version>5.2.2</dependency.poi.version>
|
||||
<dependency.ooxml-schemas.version>1.4</dependency.ooxml-schemas.version>
|
||||
@@ -110,21 +110,20 @@
|
||||
<dependency.jakarta-json-path.version>2.7.0</dependency.jakarta-json-path.version>
|
||||
<dependency.jakarta-rpc-api.version>1.1.4</dependency.jakarta-rpc-api.version>
|
||||
|
||||
<alfresco.googledrive.version>3.2.3-A2</alfresco.googledrive.version>
|
||||
<alfresco.googledrive.version>3.2.3-A3</alfresco.googledrive.version>
|
||||
<alfresco.aos-module.version>1.4.1</alfresco.aos-module.version>
|
||||
<alfresco.api-explorer.version>7.2.1</alfresco.api-explorer.version> <!-- Also in alfresco-enterprise-share -->
|
||||
<alfresco.api-explorer.version>7.3.0-A1</alfresco.api-explorer.version> <!-- Also in alfresco-enterprise-share -->
|
||||
|
||||
<alfresco.maven-plugin.version>2.2.0</alfresco.maven-plugin.version>
|
||||
<license-maven-plugin.version>2.0.1.alfresco-2</license-maven-plugin.version>
|
||||
|
||||
<dependency.postgresql.version>42.4.1</dependency.postgresql.version>
|
||||
<dependency.postgresql.version>42.5.0</dependency.postgresql.version>
|
||||
<dependency.mysql.version>8.0.30</dependency.mysql.version>
|
||||
<dependency.mysql-image.version>8</dependency.mysql-image.version>
|
||||
<dependency.mariadb.version>2.7.4</dependency.mariadb.version>
|
||||
<dependency.tas-utility.version>3.0.49</dependency.tas-utility.version>
|
||||
<dependency.rest-assured.version>5.1.1</dependency.rest-assured.version>
|
||||
<dependency.tas-restapi.version>1.115</dependency.tas-restapi.version>
|
||||
<dependency.tas-cmis.version>1.32</dependency.tas-cmis.version>
|
||||
<dependency.tas-utility.version>3.0.56</dependency.tas-utility.version>
|
||||
<dependency.rest-assured.version>5.2.0</dependency.rest-assured.version>
|
||||
<dependency.tas-restapi.version>1.133</dependency.tas-restapi.version>
|
||||
<dependency.tas-email.version>1.9</dependency.tas-email.version>
|
||||
<dependency.tas-webdav.version>1.7</dependency.tas-webdav.version>
|
||||
<dependency.tas-ftp.version>1.7</dependency.tas-ftp.version>
|
||||
@@ -151,7 +150,7 @@
|
||||
<connection>scm:git:https://github.com/Alfresco/alfresco-community-repo.git</connection>
|
||||
<developerConnection>scm:git:https://github.com/Alfresco/alfresco-community-repo.git</developerConnection>
|
||||
<url>https://github.com/Alfresco/alfresco-community-repo</url>
|
||||
<tag>17.112</tag>
|
||||
<tag>17.157</tag>
|
||||
</scm>
|
||||
|
||||
<distributionManagement>
|
||||
@@ -408,7 +407,7 @@
|
||||
<dependency>
|
||||
<groupId>org.apache.xmlbeans</groupId>
|
||||
<artifactId>xmlbeans</artifactId>
|
||||
<version>5.1.0</version>
|
||||
<version>5.1.1</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.json</groupId>
|
||||
@@ -516,6 +515,11 @@
|
||||
<artifactId>jackson-dataformat-yaml</artifactId>
|
||||
<version>${dependency.jackson.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.yaml</groupId>
|
||||
<artifactId>snakeyaml</artifactId>
|
||||
<version>1.32</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.fasterxml.jackson.core</groupId>
|
||||
<artifactId>jackson-annotations</artifactId>
|
||||
@@ -659,7 +663,7 @@
|
||||
<dependency>
|
||||
<groupId>org.jsoup</groupId>
|
||||
<artifactId>jsoup</artifactId>
|
||||
<version>1.15.2</version>
|
||||
<version>1.15.3</version>
|
||||
</dependency>
|
||||
<!-- upgrade dependency from TIKA -->
|
||||
<dependency>
|
||||
@@ -710,11 +714,6 @@
|
||||
<artifactId>restapi</artifactId>
|
||||
<version>${dependency.tas-restapi.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.alfresco.tas</groupId>
|
||||
<artifactId>cmis</artifactId>
|
||||
<version>${dependency.tas-cmis.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.alfresco.tas</groupId>
|
||||
<artifactId>email</artifactId>
|
||||
@@ -738,7 +737,7 @@
|
||||
<dependency>
|
||||
<groupId>joda-time</groupId>
|
||||
<artifactId>joda-time</artifactId>
|
||||
<version>2.10.14</version>
|
||||
<version>2.11.1</version>
|
||||
</dependency>
|
||||
|
||||
<!-- provided dependencies -->
|
||||
@@ -947,7 +946,7 @@
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>3.4.0</version>
|
||||
<version>3.4.1</version>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
|
@@ -7,7 +7,7 @@
|
||||
<parent>
|
||||
<groupId>org.alfresco</groupId>
|
||||
<artifactId>alfresco-community-repo</artifactId>
|
||||
<version>17.112</version>
|
||||
<version>17.157</version>
|
||||
</parent>
|
||||
|
||||
<dependencies>
|
||||
|
@@ -2,7 +2,7 @@
|
||||
* #%L
|
||||
* Alfresco Remote API
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2016 Alfresco Software Limited
|
||||
* Copyright (C) 2005 - 2022 Alfresco Software Limited
|
||||
* %%
|
||||
* This file is part of the Alfresco software.
|
||||
* If the software was purchased under a paid Alfresco license, the terms of
|
||||
@@ -36,7 +36,7 @@ import org.alfresco.repo.content.metadata.MetadataExtracter;
|
||||
import org.alfresco.repo.content.metadata.MetadataExtracterRegistry;
|
||||
import org.alfresco.repo.content.transform.LocalTransformServiceRegistry;
|
||||
import org.alfresco.service.cmr.repository.MimetypeService;
|
||||
import org.alfresco.transform.client.registry.TransformServiceRegistry;
|
||||
import org.alfresco.transform.registry.TransformServiceRegistry;
|
||||
import org.springframework.extensions.webscripts.Cache;
|
||||
import org.springframework.extensions.webscripts.DeclarativeWebScript;
|
||||
import org.springframework.extensions.webscripts.Status;
|
||||
|
@@ -2,7 +2,7 @@
|
||||
* #%L
|
||||
* Alfresco Remote API
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2018 Alfresco Software Limited
|
||||
* Copyright (C) 2005 - 2022 Alfresco Software Limited
|
||||
* %%
|
||||
* This file is part of the Alfresco software.
|
||||
* If the software was purchased under a paid Alfresco license, the terms of
|
||||
@@ -29,8 +29,10 @@ package org.alfresco.rest.api;
|
||||
|
||||
import org.alfresco.rest.api.model.Action;
|
||||
import org.alfresco.rest.api.model.ActionDefinition;
|
||||
import org.alfresco.rest.api.model.ActionParameterConstraint;
|
||||
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
|
||||
import org.alfresco.rest.framework.resource.parameters.Parameters;
|
||||
import org.alfresco.service.Experimental;
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
|
||||
public interface Actions
|
||||
@@ -45,7 +47,10 @@ public interface Actions
|
||||
{
|
||||
NAME,
|
||||
TITLE
|
||||
};
|
||||
}
|
||||
|
||||
Action executeAction(Action action, Parameters parameters);
|
||||
|
||||
@Experimental
|
||||
ActionParameterConstraint getActionConstraint(String constraintName);
|
||||
}
|
||||
|
@@ -59,8 +59,23 @@ public interface RuleSets
|
||||
*/
|
||||
RuleSet getRuleSetById(String folderNodeId, String ruleSetId, List<String> includes);
|
||||
|
||||
/**
|
||||
* Update a rule set - for example to reorder the rules within it.
|
||||
*
|
||||
* @param folderNodeId Folder node ID
|
||||
* @param ruleSet The updated rule set.
|
||||
* @param includes List of fields to include in the response.
|
||||
* @return The updated rule set from the server.
|
||||
*/
|
||||
RuleSet updateRuleSet(String folderNodeId, RuleSet ruleSet, List<String> includes);
|
||||
|
||||
/**
|
||||
* Link a rule set to a folder
|
||||
*/
|
||||
RuleSetLink linkToRuleSet(String folderNodeId, String linkToNodeId);
|
||||
|
||||
/**
|
||||
* Removes the link between a rule set and a folder
|
||||
*/
|
||||
void unlinkRuleSet(String folderNodeId, String ruleSetId);
|
||||
}
|
||||
|
@@ -29,6 +29,7 @@ package org.alfresco.rest.api;
|
||||
import java.util.List;
|
||||
|
||||
import org.alfresco.rest.api.model.rules.Rule;
|
||||
import org.alfresco.rest.api.model.rules.RuleExecution;
|
||||
import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
|
||||
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
|
||||
import org.alfresco.rest.framework.resource.parameters.Paging;
|
||||
@@ -65,10 +66,10 @@ public interface Rules
|
||||
Rule getRuleById(String folderNodeId, String ruleSetId, String ruleId, List<String> includes);
|
||||
|
||||
/**
|
||||
* Create new rules (and potentially a rule set if "_default_" is supplied).
|
||||
* Create new rules (and potentially a rule set if "-default-" is supplied).
|
||||
*
|
||||
* @param folderNodeId The node id of a folder.
|
||||
* @param ruleSetId The id of a rule set (or "_default_" to use/create the default rule set for the folder).
|
||||
* @param ruleSetId The id of a rule set (or "-default-" to use/create the default rule set for the folder).
|
||||
* @param rule The definition of the rule.
|
||||
* @param includes The list of optional fields to include in the response.
|
||||
* @return The newly created rules.
|
||||
@@ -81,7 +82,7 @@ public interface Rules
|
||||
* Update a rule.
|
||||
*
|
||||
* @param folderNodeId The id of a folder.
|
||||
* @param ruleSetId The id of a rule set within the folder (or "_default_" to use the default rule set for the folder).
|
||||
* @param ruleSetId The id of a rule set within the folder (or "-default-" to use the default rule set for the folder).
|
||||
* @param ruleId The rule id.
|
||||
* @param rule The new version of the rule.
|
||||
* @param includes The list of optional fields to include in the response.
|
||||
@@ -94,7 +95,15 @@ public interface Rules
|
||||
*
|
||||
* @param folderNodeId - folder node ID
|
||||
* @param ruleSetId - rule set ID
|
||||
* @param ruleId - rule ID *
|
||||
* @param ruleId - rule ID
|
||||
*/
|
||||
void deleteRuleById(String folderNodeId, String ruleSetId, String ruleId);
|
||||
|
||||
/**
|
||||
* Execute rules for given folder node.
|
||||
*
|
||||
* @param folderNodeId - the ID of a folder
|
||||
* @param eachSubFolderIncluded - indicates if rules should be executed also on sub-folders
|
||||
*/
|
||||
RuleExecution executeRules(final String folderNodeId, final boolean eachSubFolderIncluded);
|
||||
}
|
||||
|
@@ -0,0 +1,59 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Remote API
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2017 Alfresco Software Limited
|
||||
* %%
|
||||
* This file is part of the Alfresco software.
|
||||
* If the software was purchased under a paid Alfresco license, the terms of
|
||||
* the paid license agreement will prevail. Otherwise, the software is
|
||||
* provided under the following open source license terms:
|
||||
*
|
||||
* Alfresco is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Lesser General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* Alfresco is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Lesser General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public License
|
||||
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
||||
* #L%
|
||||
*/
|
||||
package org.alfresco.rest.api.actions;
|
||||
|
||||
import javax.servlet.http.HttpServletResponse;
|
||||
|
||||
import org.alfresco.rest.api.Actions;
|
||||
import org.alfresco.rest.api.model.ActionParameterConstraint;
|
||||
import org.alfresco.rest.framework.WebApiDescription;
|
||||
import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
|
||||
import org.alfresco.rest.framework.resource.EntityResource;
|
||||
import org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction;
|
||||
import org.alfresco.rest.framework.resource.parameters.Parameters;
|
||||
import org.alfresco.service.Experimental;
|
||||
|
||||
@EntityResource(name="action-constraints", title = "Action parameter constraints")
|
||||
@Experimental
|
||||
public class ActionConstraintsEntityResource implements EntityResourceAction.ReadById<ActionParameterConstraint>
|
||||
{
|
||||
private final Actions actions;
|
||||
|
||||
public ActionConstraintsEntityResource(Actions actions)
|
||||
{
|
||||
this.actions = actions;
|
||||
}
|
||||
|
||||
@WebApiDescription(title = "Get single action parameters constraint",
|
||||
description = "Retrieves a single action parameters constraint by constraint name",
|
||||
successStatus = HttpServletResponse.SC_OK)
|
||||
@Experimental
|
||||
@Override
|
||||
public ActionParameterConstraint readById(String constraintName, Parameters parameters) throws EntityNotFoundException
|
||||
{
|
||||
return actions.getActionConstraint(constraintName);
|
||||
}
|
||||
}
|
@@ -0,0 +1,59 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Remote API
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2022 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.actions;
|
||||
|
||||
import javax.servlet.http.HttpServletResponse;
|
||||
|
||||
import org.alfresco.rest.api.Actions;
|
||||
import org.alfresco.rest.api.model.ActionParameterConstraint;
|
||||
import org.alfresco.rest.framework.WebApiDescription;
|
||||
import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
|
||||
import org.alfresco.rest.framework.resource.EntityResource;
|
||||
import org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction;
|
||||
import org.alfresco.rest.framework.resource.parameters.Parameters;
|
||||
import org.alfresco.service.Experimental;
|
||||
|
||||
@EntityResource(name="action-parameter-constraints", title = "Action parameter constraints")
|
||||
@Experimental
|
||||
public class ActionParameterConstraintsEntityResource implements EntityResourceAction.ReadById<ActionParameterConstraint>
|
||||
{
|
||||
private final Actions actions;
|
||||
|
||||
public ActionParameterConstraintsEntityResource(Actions actions)
|
||||
{
|
||||
this.actions = actions;
|
||||
}
|
||||
|
||||
@WebApiDescription(title = "Get single action parameter constraint",
|
||||
description = "Retrieves a single action parameter constraint by constraint name",
|
||||
successStatus = HttpServletResponse.SC_OK)
|
||||
@Experimental
|
||||
@Override
|
||||
public ActionParameterConstraint readById(String constraintName, Parameters parameters) throws EntityNotFoundException
|
||||
{
|
||||
return actions.getActionConstraint(constraintName);
|
||||
}
|
||||
}
|
@@ -0,0 +1,38 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Remote API
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2022 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.actions;
|
||||
|
||||
import org.alfresco.rest.api.model.rules.Action;
|
||||
import org.alfresco.service.Experimental;
|
||||
|
||||
@Experimental
|
||||
public interface ActionValidator
|
||||
{
|
||||
void validate(Action action);
|
||||
|
||||
boolean isEnabled();
|
||||
}
|
@@ -27,15 +27,22 @@ package org.alfresco.rest.api.impl;
|
||||
|
||||
import org.alfresco.error.AlfrescoRuntimeException;
|
||||
import org.alfresco.repo.action.access.ActionAccessRestriction;
|
||||
import org.alfresco.repo.action.constraint.FolderContentsParameterConstraint;
|
||||
import org.alfresco.rest.api.Actions;
|
||||
import org.alfresco.rest.api.impl.rules.ActionParameterConverter;
|
||||
import org.alfresco.rest.api.model.Action;
|
||||
import org.alfresco.rest.api.model.ActionDefinition;
|
||||
import org.alfresco.rest.api.model.ActionParameterConstraint;
|
||||
import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
|
||||
import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
|
||||
import org.alfresco.rest.framework.core.exceptions.NotFoundException;
|
||||
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
|
||||
import org.alfresco.rest.framework.resource.parameters.ListPage;
|
||||
import org.alfresco.rest.framework.resource.parameters.Parameters;
|
||||
import org.alfresco.rest.framework.resource.parameters.SortColumn;
|
||||
import org.alfresco.service.Experimental;
|
||||
import org.alfresco.service.cmr.action.ActionService;
|
||||
import org.alfresco.service.cmr.action.ParameterConstraint;
|
||||
import org.alfresco.service.cmr.action.ParameterDefinition;
|
||||
import org.alfresco.service.cmr.dictionary.DataTypeDefinition;
|
||||
import org.alfresco.service.cmr.dictionary.DictionaryException;
|
||||
@@ -59,6 +66,7 @@ import java.util.Comparator;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Objects;
|
||||
import java.util.Set;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
@@ -68,11 +76,14 @@ import static java.util.Comparator.nullsFirst;
|
||||
|
||||
public class ActionsImpl implements Actions
|
||||
{
|
||||
static final String CONSTRAINT_NOT_EXISTS = "Action parameter constraints for name %s do not exist.";
|
||||
|
||||
private ActionService actionService;
|
||||
private DictionaryService dictionaryService;
|
||||
private NamespaceService namespaceService;
|
||||
private NodeService nodeService;
|
||||
private NamespacePrefixResolver prefixResolver;
|
||||
private ActionParameterConverter actionParameterConverter;
|
||||
|
||||
public void setActionService(ActionService actionService)
|
||||
{
|
||||
@@ -99,6 +110,11 @@ public class ActionsImpl implements Actions
|
||||
this.prefixResolver = prefixResolver;
|
||||
}
|
||||
|
||||
public void setActionParameterConverter(ActionParameterConverter actionParameterConverter)
|
||||
{
|
||||
this.actionParameterConverter = actionParameterConverter;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ActionDefinition getActionDefinitionById(String actionDefinitionId)
|
||||
{
|
||||
@@ -125,10 +141,10 @@ public class ActionsImpl implements Actions
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
private ActionDefinition getActionDefinition(
|
||||
|
||||
private ActionDefinition getActionDefinition(
|
||||
org.alfresco.service.cmr.action.ActionDefinition actionDefinitionId)
|
||||
{
|
||||
{
|
||||
List<ActionDefinition.ParameterDefinition> paramDefs =
|
||||
actionDefinitionId.
|
||||
getParameterDefinitions().
|
||||
@@ -145,7 +161,7 @@ public class ActionsImpl implements Actions
|
||||
actionDefinitionId.getTrackStatus(),
|
||||
paramDefs);
|
||||
}
|
||||
|
||||
|
||||
@Override
|
||||
public CollectionWithPagingInfo<ActionDefinition> getActionDefinitions(NodeRef nodeRef, Parameters params)
|
||||
{
|
||||
@@ -174,7 +190,7 @@ public class ActionsImpl implements Actions
|
||||
sortKey = Actions.SortKey.valueOf(sorting.get(0).column.toUpperCase());
|
||||
sortAsc = sorting.get(0).asc;
|
||||
}
|
||||
|
||||
|
||||
Comparator<? super ActionDefinition> comparator;
|
||||
switch (sortKey)
|
||||
{
|
||||
@@ -187,7 +203,7 @@ public class ActionsImpl implements Actions
|
||||
default:
|
||||
throw new IllegalArgumentException("Invalid sort key, must be either 'title' or 'name'.");
|
||||
}
|
||||
|
||||
|
||||
if (!sortAsc)
|
||||
{
|
||||
comparator = comparator.reversed();
|
||||
@@ -220,7 +236,7 @@ public class ActionsImpl implements Actions
|
||||
skip(skip).
|
||||
limit(maxItems).
|
||||
collect(Collectors.toList());
|
||||
|
||||
|
||||
boolean hasMoreItems = actionDefinitions.size() > (skip + maxItems);
|
||||
|
||||
return CollectionWithPagingInfo.asPaged(
|
||||
@@ -297,6 +313,52 @@ public class ActionsImpl implements Actions
|
||||
return result;
|
||||
}
|
||||
|
||||
@Override
|
||||
@Experimental
|
||||
public ActionParameterConstraint getActionConstraint(String constraintName)
|
||||
{
|
||||
final ParameterConstraint parameterConstraint = actionService.getParameterConstraint(constraintName);
|
||||
if (Objects.isNull(parameterConstraint))
|
||||
{
|
||||
throw new NotFoundException(String.format(CONSTRAINT_NOT_EXISTS, constraintName));
|
||||
}
|
||||
return mapToActionConstraint(parameterConstraint);
|
||||
}
|
||||
|
||||
@Experimental
|
||||
private ActionParameterConstraint mapToActionConstraint(ParameterConstraint parameterConstraint)
|
||||
{
|
||||
final ActionParameterConstraint constraint = new ActionParameterConstraint();
|
||||
constraint.setConstraintName(parameterConstraint.getName());
|
||||
constraint.setConstraintValues(getConstraintDataList(parameterConstraint));
|
||||
return constraint;
|
||||
}
|
||||
|
||||
@Experimental
|
||||
private List<ActionParameterConstraint.ConstraintData> getConstraintDataList(final ParameterConstraint parameterConstraint)
|
||||
{
|
||||
final Map<String, String> constraintValues = parameterConstraint.getValues();
|
||||
if (parameterConstraint instanceof FolderContentsParameterConstraint)
|
||||
{
|
||||
return convertNodeRefConstraintValues(constraintValues).entrySet().stream()
|
||||
.map(e -> new ActionParameterConstraint.ConstraintData(e.getKey(), e.getValue()))
|
||||
.collect(Collectors.toList());
|
||||
} else
|
||||
{
|
||||
return constraintValues.entrySet().stream()
|
||||
.map(e -> new ActionParameterConstraint.ConstraintData(e.getKey(), e.getValue()))
|
||||
.collect(Collectors.toList());
|
||||
}
|
||||
}
|
||||
|
||||
@Experimental
|
||||
private Map<String, String> convertNodeRefConstraintValues(final Map<String, String> inputValues)
|
||||
{
|
||||
return inputValues.entrySet().stream()
|
||||
.collect(Collectors.toMap(e -> actionParameterConverter.convertParamFromServiceModel(new NodeRef(e.getKey())).toString(),
|
||||
Map.Entry::getValue));
|
||||
}
|
||||
|
||||
private Map<String, Serializable> extractActionParams(org.alfresco.service.cmr.action.ActionDefinition actionDefinition, Map<String, String> params)
|
||||
{
|
||||
Map<String, Serializable> parameterValues = new HashMap<>();
|
||||
|
@@ -400,12 +400,10 @@ public class NodesImpl implements Nodes
|
||||
@Override
|
||||
public NodeRef validateNode(StoreRef storeRef, String nodeId)
|
||||
{
|
||||
String versionLabel = null;
|
||||
|
||||
int idx = nodeId.indexOf(";");
|
||||
if (idx != -1)
|
||||
{
|
||||
versionLabel = nodeId.substring(idx + 1);
|
||||
String versionLabel = nodeId.substring(idx + 1);
|
||||
nodeId = nodeId.substring(0, idx);
|
||||
if (versionLabel.equals("pwc"))
|
||||
{
|
||||
@@ -1753,7 +1751,7 @@ public class NodesImpl implements Nodes
|
||||
// default false (if not provided)
|
||||
boolean permanentDelete = Boolean.valueOf(parameters.getParameter(PARAM_PERMANENT));
|
||||
|
||||
if (permanentDelete == true)
|
||||
if (permanentDelete)
|
||||
{
|
||||
boolean isAdmin = authorityService.hasAdminAuthority();
|
||||
if (! isAdmin)
|
||||
|
@@ -0,0 +1,122 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Remote API
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2022 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.impl.mapper.rules;
|
||||
|
||||
import static java.util.Collections.emptyMap;
|
||||
|
||||
import static org.alfresco.repo.action.access.ActionAccessRestriction.ACTION_CONTEXT_PARAM_NAME;
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.Collection;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Optional;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import org.alfresco.repo.action.ActionImpl;
|
||||
import org.alfresco.repo.action.CompositeActionImpl;
|
||||
import org.alfresco.rest.api.actions.ActionValidator;
|
||||
import org.alfresco.rest.api.impl.rules.ActionParameterConverter;
|
||||
import org.alfresco.rest.api.model.mapper.RestModelMapper;
|
||||
import org.alfresco.rest.api.model.rules.Action;
|
||||
import org.alfresco.service.Experimental;
|
||||
import org.alfresco.util.GUID;
|
||||
import org.apache.commons.collections.CollectionUtils;
|
||||
|
||||
@Experimental
|
||||
public class RestRuleActionModelMapper implements RestModelMapper<Action, org.alfresco.service.cmr.action.Action>
|
||||
{
|
||||
private final ActionParameterConverter parameterConverter;
|
||||
private final List<ActionValidator> actionValidators;
|
||||
|
||||
public RestRuleActionModelMapper(ActionParameterConverter parameterConverter,
|
||||
List<ActionValidator> actionValidators)
|
||||
{
|
||||
this.parameterConverter = parameterConverter;
|
||||
this.actionValidators = actionValidators;
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts service POJO action to REST model action.
|
||||
*
|
||||
* @param actionModel - {@link org.alfresco.service.cmr.action.Action} service POJO
|
||||
* @return {@link Action} REST model
|
||||
*/
|
||||
@Override
|
||||
public Action toRestModel(org.alfresco.service.cmr.action.Action actionModel)
|
||||
{
|
||||
if (actionModel == null)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
final Action.Builder builder = Action.builder().actionDefinitionId(actionModel.getActionDefinitionName());
|
||||
if (actionModel.getParameterValues() != null)
|
||||
{
|
||||
final Map<String, Serializable> convertedParams = actionModel.getParameterValues()
|
||||
.entrySet()
|
||||
.stream()
|
||||
.collect(Collectors.toMap(Map.Entry::getKey, e -> parameterConverter.convertParamFromServiceModel(e.getValue())));
|
||||
convertedParams.remove(ACTION_CONTEXT_PARAM_NAME);
|
||||
builder.params(convertedParams);
|
||||
}
|
||||
return builder.create();
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert the REST model objects to composite action service POJO.
|
||||
*
|
||||
* @param actions List of actions.
|
||||
* @return The composite action service POJO.
|
||||
*/
|
||||
@Override
|
||||
public org.alfresco.service.cmr.action.Action toServiceModel(Collection<Action> actions)
|
||||
{
|
||||
if (CollectionUtils.isEmpty(actions))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
final org.alfresco.service.cmr.action.CompositeAction compositeAction = new CompositeActionImpl(null, GUID.generate());
|
||||
actions.forEach(action -> compositeAction.addAction(toServiceAction(action)));
|
||||
return compositeAction;
|
||||
}
|
||||
|
||||
private org.alfresco.service.cmr.action.Action toServiceAction(Action action)
|
||||
{
|
||||
final Map<String, Serializable> params = Optional.ofNullable(action.getParams()).orElse(emptyMap());
|
||||
validateAction(action);
|
||||
final Map<String, Serializable> convertedParams =
|
||||
parameterConverter.getConvertedParams(params, action.getActionDefinitionId());
|
||||
return new ActionImpl(null, GUID.generate(), action.getActionDefinitionId(), convertedParams);
|
||||
}
|
||||
private void validateAction(Action action) {
|
||||
actionValidators.stream()
|
||||
.filter(ActionValidator::isEnabled)
|
||||
.forEach(v -> v.validate(action));
|
||||
}
|
||||
}
|
@@ -0,0 +1,162 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Remote API
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2022 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.impl.mapper.rules;
|
||||
|
||||
import static org.alfresco.repo.action.evaluator.NoConditionEvaluator.NAME;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collection;
|
||||
import java.util.List;
|
||||
import java.util.Objects;
|
||||
import java.util.Optional;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import org.alfresco.rest.api.model.mapper.RestModelMapper;
|
||||
import org.alfresco.rest.api.model.rules.CompositeCondition;
|
||||
import org.alfresco.rest.api.model.rules.ConditionOperator;
|
||||
import org.alfresco.rest.api.model.rules.SimpleCondition;
|
||||
import org.alfresco.service.Experimental;
|
||||
import org.alfresco.service.cmr.action.ActionCondition;
|
||||
import org.apache.commons.collections.CollectionUtils;
|
||||
|
||||
@Experimental
|
||||
public class RestRuleCompositeConditionModelMapper implements RestModelMapper<CompositeCondition, ActionCondition>
|
||||
{
|
||||
private final RestModelMapper<SimpleCondition, ActionCondition> simpleConditionMapper;
|
||||
|
||||
public RestRuleCompositeConditionModelMapper(
|
||||
RestModelMapper<SimpleCondition, ActionCondition> simpleConditionMapper)
|
||||
{
|
||||
this.simpleConditionMapper = simpleConditionMapper;
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts Action conditions (service POJO) list to composite condition (REST model).
|
||||
*
|
||||
* @param actionConditions - list of {@link ActionCondition} service POJOs
|
||||
* @return {@link CompositeCondition} REST model
|
||||
*/
|
||||
@Override
|
||||
public CompositeCondition toRestModel(final Collection<ActionCondition> actionConditions)
|
||||
{
|
||||
if (CollectionUtils.isEmpty(actionConditions))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
final List<ActionCondition> filteredActions = actionConditions.stream()
|
||||
.filter(Objects::nonNull)
|
||||
.filter(c -> !NAME.equals(c.getActionConditionDefinitionName()))
|
||||
.collect(Collectors.toList());
|
||||
if (CollectionUtils.isEmpty(filteredActions))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
final CompositeCondition conditions = new CompositeCondition();
|
||||
conditions.setCompositeConditions(new ArrayList<>());
|
||||
// group action conditions by inversion flag
|
||||
filteredActions.stream()
|
||||
.collect(Collectors.groupingBy(ActionCondition::getInvertCondition))
|
||||
// map action condition sub lists
|
||||
.forEach((inverted, actionConditionsPart) -> Optional
|
||||
.ofNullable(ofActionConditions(actionConditionsPart, inverted, ConditionOperator.AND))
|
||||
// if composite condition present add to final list
|
||||
.ifPresent(compositeCondition -> conditions.getCompositeConditions().add(compositeCondition)));
|
||||
|
||||
if (CollectionUtils.isEmpty(conditions.getCompositeConditions()))
|
||||
{
|
||||
conditions.setCompositeConditions(null);
|
||||
}
|
||||
return conditions;
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<ActionCondition> toServiceModels(final CompositeCondition compositeCondition)
|
||||
{
|
||||
final List<ActionCondition> actionConditions = new ArrayList<>();
|
||||
if (compositeCondition == null)
|
||||
{
|
||||
return actionConditions;
|
||||
}
|
||||
if (CollectionUtils.isNotEmpty(compositeCondition.getSimpleConditions()))
|
||||
{
|
||||
compositeCondition.getSimpleConditions()
|
||||
.forEach(simpleCondition -> actionConditions.add(mapSimpleCondition(simpleCondition, compositeCondition.isInverted())));
|
||||
}
|
||||
if (CollectionUtils.isNotEmpty(compositeCondition.getCompositeConditions()))
|
||||
{
|
||||
compositeCondition.getCompositeConditions().forEach(condition -> actionConditions.addAll(toServiceModels(condition)));
|
||||
}
|
||||
|
||||
return actionConditions;
|
||||
}
|
||||
|
||||
private ActionCondition mapSimpleCondition(final SimpleCondition simpleCondition, final boolean inverted)
|
||||
{
|
||||
final ActionCondition actionCondition = simpleConditionMapper.toServiceModel(simpleCondition);
|
||||
actionCondition.setInvertCondition(inverted);
|
||||
return actionCondition;
|
||||
}
|
||||
|
||||
private CompositeCondition ofActionConditions(final List<ActionCondition> actionConditions, final boolean inverted,
|
||||
final ConditionOperator conditionOperator)
|
||||
{
|
||||
if (CollectionUtils.isEmpty(actionConditions))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
return ofSimpleConditions(simpleConditionMapper.toRestModels(actionConditions), inverted, conditionOperator);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a composite condition instance of simple conditions.
|
||||
*
|
||||
* @param simpleConditions - list of {@link SimpleCondition}
|
||||
* @param inverted - determines if condition should be inverted
|
||||
* @param conditionOperator - determines the operation, see {@link ConditionOperator}
|
||||
* @return {@link CompositeCondition}
|
||||
*/
|
||||
private CompositeCondition ofSimpleConditions(final List<SimpleCondition> simpleConditions, final boolean inverted,
|
||||
final ConditionOperator conditionOperator)
|
||||
{
|
||||
return of(simpleConditions, null, inverted, conditionOperator);
|
||||
}
|
||||
|
||||
private CompositeCondition of(final List<SimpleCondition> simpleConditions, final List<CompositeCondition> compositeConditions,
|
||||
final boolean inverted, final ConditionOperator conditionOperator)
|
||||
{
|
||||
if (CollectionUtils.isEmpty(simpleConditions) && CollectionUtils.isEmpty(compositeConditions))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
return CompositeCondition.builder()
|
||||
.inverted(inverted)
|
||||
.booleanMode(conditionOperator)
|
||||
.simpleConditions(simpleConditions)
|
||||
.compositeConditions(compositeConditions)
|
||||
.create();
|
||||
}
|
||||
}
|
@@ -0,0 +1,164 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Remote API
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2022 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.impl.mapper.rules;
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.Map;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import org.alfresco.repo.action.ActionImpl;
|
||||
import org.alfresco.repo.action.executer.ScriptActionExecuter;
|
||||
import org.alfresco.rest.api.Nodes;
|
||||
import org.alfresco.rest.api.impl.rules.ActionParameterConverter;
|
||||
import org.alfresco.rest.api.model.mapper.RestModelMapper;
|
||||
import org.alfresco.rest.api.model.rules.Action;
|
||||
import org.alfresco.rest.api.model.rules.CompositeCondition;
|
||||
import org.alfresco.rest.api.model.rules.Rule;
|
||||
import org.alfresco.rest.api.model.rules.RuleTrigger;
|
||||
import org.alfresco.service.Experimental;
|
||||
import org.alfresco.service.cmr.action.ActionCondition;
|
||||
import org.alfresco.service.cmr.action.CompositeAction;
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
import org.alfresco.util.GUID;
|
||||
import org.apache.commons.collections.CollectionUtils;
|
||||
import org.apache.commons.logging.Log;
|
||||
import org.apache.commons.logging.LogFactory;
|
||||
|
||||
@Experimental
|
||||
public class RestRuleModelMapper implements RestModelMapper<Rule, org.alfresco.service.cmr.rule.Rule>
|
||||
{
|
||||
private static Log log = LogFactory.getLog(RestRuleModelMapper.class);
|
||||
|
||||
private final RestModelMapper<CompositeCondition, ActionCondition> compositeConditionMapper;
|
||||
private final RestModelMapper<Action, org.alfresco.service.cmr.action.Action> actionMapper;
|
||||
private final Nodes nodes;
|
||||
private final ActionParameterConverter actionParameterConverter;
|
||||
|
||||
public RestRuleModelMapper(
|
||||
RestModelMapper<CompositeCondition, ActionCondition> compositeConditionMapper,
|
||||
RestModelMapper<Action, org.alfresco.service.cmr.action.Action> actionMapper,
|
||||
Nodes nodes,
|
||||
ActionParameterConverter actionParameterConverter)
|
||||
{
|
||||
this.compositeConditionMapper = compositeConditionMapper;
|
||||
this.actionMapper = actionMapper;
|
||||
this.nodes = nodes;
|
||||
this.actionParameterConverter = actionParameterConverter;
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts service POJO rule to REST model rule.
|
||||
*
|
||||
* @param serviceRule - {@link org.alfresco.service.cmr.rule.Rule} service POJO
|
||||
* @return {@link Rule} REST model
|
||||
*/
|
||||
@Override
|
||||
public Rule toRestModel(org.alfresco.service.cmr.rule.Rule serviceRule)
|
||||
{
|
||||
if (serviceRule == null)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
final Rule.Builder builder = Rule.builder()
|
||||
.name(serviceRule.getTitle())
|
||||
.description(serviceRule.getDescription())
|
||||
.isEnabled(!serviceRule.getRuleDisabled())
|
||||
.isInheritable(serviceRule.isAppliedToChildren())
|
||||
.isAsynchronous(serviceRule.getExecuteAsynchronously());
|
||||
|
||||
if (serviceRule.getNodeRef() != null)
|
||||
{
|
||||
builder.id(serviceRule.getNodeRef().getId());
|
||||
}
|
||||
if (CollectionUtils.isNotEmpty(serviceRule.getRuleTypes()))
|
||||
{
|
||||
builder.triggers(serviceRule.getRuleTypes().stream().map(RuleTrigger::of).collect(Collectors.toList()));
|
||||
}
|
||||
if (serviceRule.getAction() != null)
|
||||
{
|
||||
builder.conditions(compositeConditionMapper.toRestModel(serviceRule.getAction().getActionConditions()));
|
||||
if (serviceRule.getAction().getCompensatingAction() != null &&
|
||||
serviceRule.getAction().getCompensatingAction().getParameterValue(ScriptActionExecuter.PARAM_SCRIPTREF) != null)
|
||||
{
|
||||
String errorScript = actionParameterConverter.convertParamFromServiceModel(
|
||||
serviceRule.getAction().getCompensatingAction().getParameterValue(ScriptActionExecuter.PARAM_SCRIPTREF)).toString();
|
||||
builder.errorScript(errorScript);
|
||||
}
|
||||
if (serviceRule.getAction() instanceof CompositeAction && ((CompositeAction) serviceRule.getAction()).getActions() != null)
|
||||
{
|
||||
builder.actions(
|
||||
((CompositeAction) serviceRule.getAction()).getActions().stream()
|
||||
.map(actionMapper::toRestModel)
|
||||
.collect(Collectors.toList()));
|
||||
} else {
|
||||
log.warn("Rule Action should be of 'CompositeAction' type but found: " + serviceRule.getAction().getClass());
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
return builder.create();
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert the REST model object to the equivalent service POJO.
|
||||
*
|
||||
* @param restRuleModel {@link Rule} REST model.
|
||||
* @return The rule service POJO.
|
||||
*/
|
||||
@Override
|
||||
public org.alfresco.service.cmr.rule.Rule toServiceModel(Rule restRuleModel)
|
||||
{
|
||||
final org.alfresco.service.cmr.rule.Rule serviceRule = new org.alfresco.service.cmr.rule.Rule();
|
||||
final NodeRef nodeRef = (restRuleModel.getId() != null) ? nodes.validateOrLookupNode(restRuleModel.getId(), null) : null;
|
||||
serviceRule.setNodeRef(nodeRef);
|
||||
serviceRule.setTitle(restRuleModel.getName());
|
||||
serviceRule.setDescription(restRuleModel.getDescription());
|
||||
serviceRule.setRuleDisabled(!restRuleModel.getIsEnabled());
|
||||
serviceRule.applyToChildren(restRuleModel.getIsInheritable());
|
||||
serviceRule.setExecuteAsynchronously(restRuleModel.getIsAsynchronous());
|
||||
serviceRule.setRuleTypes(restRuleModel.getTriggers());
|
||||
serviceRule.setAction(actionMapper.toServiceModel(restRuleModel.getActions()));
|
||||
if (restRuleModel.getErrorScript() != null)
|
||||
{
|
||||
final org.alfresco.service.cmr.action.Action compensatingAction =
|
||||
new ActionImpl(null, GUID.generate(), ScriptActionExecuter.NAME);
|
||||
final Map<String, Serializable> scriptParam = actionParameterConverter
|
||||
.getConvertedParams(Map.of(ScriptActionExecuter.PARAM_SCRIPTREF, restRuleModel.getErrorScript()),
|
||||
compensatingAction.getActionDefinitionName());
|
||||
compensatingAction.setParameterValues(scriptParam);
|
||||
serviceRule.getAction().setCompensatingAction(compensatingAction);
|
||||
}
|
||||
if (restRuleModel.getConditions() != null)
|
||||
{
|
||||
compositeConditionMapper.toServiceModels(restRuleModel.getConditions())
|
||||
.forEach(condition -> serviceRule.getAction().addActionCondition(condition));
|
||||
}
|
||||
|
||||
return serviceRule;
|
||||
}
|
||||
}
|
@@ -0,0 +1,233 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Remote API
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2022 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.impl.mapper.rules;
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import java.util.UUID;
|
||||
|
||||
import com.rometools.utils.Strings;
|
||||
import org.alfresco.model.ContentModel;
|
||||
import org.alfresco.repo.action.ActionConditionImpl;
|
||||
import org.alfresco.repo.action.evaluator.CompareMimeTypeEvaluator;
|
||||
import org.alfresco.repo.action.evaluator.ComparePropertyValueEvaluator;
|
||||
import org.alfresco.repo.action.evaluator.HasAspectEvaluator;
|
||||
import org.alfresco.repo.action.evaluator.HasTagEvaluator;
|
||||
import org.alfresco.repo.action.evaluator.InCategoryEvaluator;
|
||||
import org.alfresco.repo.action.evaluator.IsSubTypeEvaluator;
|
||||
import org.alfresco.repo.action.evaluator.NoConditionEvaluator;
|
||||
import org.alfresco.repo.action.evaluator.compare.ComparePropertyValueOperation;
|
||||
import org.alfresco.repo.action.evaluator.compare.ContentPropertyName;
|
||||
import org.alfresco.rest.api.Nodes;
|
||||
import org.alfresco.rest.api.model.mapper.RestModelMapper;
|
||||
import org.alfresco.rest.api.model.rules.SimpleCondition;
|
||||
import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
|
||||
import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
|
||||
import org.alfresco.service.Experimental;
|
||||
import org.alfresco.service.cmr.action.ActionCondition;
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
import org.alfresco.service.namespace.NamespaceService;
|
||||
import org.alfresco.service.namespace.QName;
|
||||
import org.apache.commons.collections.MapUtils;
|
||||
|
||||
@Experimental
|
||||
public class RestRuleSimpleConditionModelMapper implements RestModelMapper<SimpleCondition, ActionCondition>
|
||||
{
|
||||
static final String CATEGORY_INVALID_MSG = "Category in condition is invalid";
|
||||
static final String PARAM_CATEGORY = "category";
|
||||
static final String PARAM_MIMETYPE = "mimetype";
|
||||
static final String FIELD_NOT_NULL = "Field in condition must not be blank";
|
||||
static final String PARAMETER_NOT_NULL = "Parameter in condition must not be blank";
|
||||
static final String COMPARATOR_NOT_NULL = "Comparator in condition must not be blank";
|
||||
private final NamespaceService namespaceService;
|
||||
private final Nodes nodes;
|
||||
|
||||
public RestRuleSimpleConditionModelMapper(NamespaceService namespaceService, Nodes nodes)
|
||||
{
|
||||
this.namespaceService = namespaceService;
|
||||
this.nodes = nodes;
|
||||
}
|
||||
|
||||
@Override
|
||||
public SimpleCondition toRestModel(ActionCondition actionCondition)
|
||||
{
|
||||
if (actionCondition == null || actionCondition.getActionConditionDefinitionName() == null ||
|
||||
MapUtils.isEmpty(actionCondition.getParameterValues()))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
switch (actionCondition.getActionConditionDefinitionName())
|
||||
{
|
||||
case ComparePropertyValueEvaluator.NAME:
|
||||
return createComparePropertyValueCondition(actionCondition, namespaceService);
|
||||
case CompareMimeTypeEvaluator.NAME:
|
||||
return createCompareMimeTypeCondition(actionCondition);
|
||||
case HasAspectEvaluator.NAME:
|
||||
return createHasAspectCondition(actionCondition, namespaceService);
|
||||
case HasTagEvaluator.NAME:
|
||||
return createHasTagCondition(actionCondition);
|
||||
case InCategoryEvaluator.NAME:
|
||||
return createInCategoryCondition(actionCondition);
|
||||
case IsSubTypeEvaluator.NAME:
|
||||
return createIsSubtypeCondition(actionCondition, namespaceService);
|
||||
case NoConditionEvaluator.NAME:
|
||||
default:
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public ActionCondition toServiceModel(SimpleCondition restModel)
|
||||
{
|
||||
final String field = restModel.getField();
|
||||
checkStringNotBlank(field, FIELD_NOT_NULL);
|
||||
|
||||
final Map<String, Serializable> parameterValues = new HashMap<>();
|
||||
String conditionDefinitionId;
|
||||
final String parameter = restModel.getParameter();
|
||||
checkStringNotBlank(parameter, PARAMETER_NOT_NULL);
|
||||
|
||||
switch (field)
|
||||
{
|
||||
case HasAspectEvaluator.PARAM_ASPECT:
|
||||
conditionDefinitionId = HasAspectEvaluator.NAME;
|
||||
parameterValues.put(HasAspectEvaluator.PARAM_ASPECT, QName.createQName(parameter, namespaceService));
|
||||
break;
|
||||
case HasTagEvaluator.PARAM_TAG:
|
||||
conditionDefinitionId = HasTagEvaluator.NAME;
|
||||
parameterValues.put(HasTagEvaluator.PARAM_TAG, parameter);
|
||||
break;
|
||||
case PARAM_CATEGORY:
|
||||
conditionDefinitionId = InCategoryEvaluator.NAME;
|
||||
parameterValues.put(InCategoryEvaluator.PARAM_CATEGORY_ASPECT, ContentModel.ASPECT_GEN_CLASSIFIABLE);
|
||||
try
|
||||
{
|
||||
parameterValues.put(InCategoryEvaluator.PARAM_CATEGORY_VALUE, nodes.validateOrLookupNode(parameter, null));
|
||||
} catch (EntityNotFoundException e) {
|
||||
throw new InvalidArgumentException(CATEGORY_INVALID_MSG);
|
||||
}
|
||||
break;
|
||||
case IsSubTypeEvaluator.PARAM_TYPE:
|
||||
conditionDefinitionId = IsSubTypeEvaluator.NAME;
|
||||
parameterValues.put(IsSubTypeEvaluator.PARAM_TYPE, QName.createQName(parameter, namespaceService));
|
||||
break;
|
||||
case PARAM_MIMETYPE:
|
||||
conditionDefinitionId = CompareMimeTypeEvaluator.NAME;
|
||||
parameterValues.put(ComparePropertyValueEvaluator.PARAM_PROPERTY, ContentModel.TYPE_CONTENT);
|
||||
parameterValues.put(ComparePropertyValueEvaluator.PARAM_VALUE, parameter);
|
||||
break;
|
||||
default:
|
||||
conditionDefinitionId = ComparePropertyValueEvaluator.NAME;
|
||||
try
|
||||
{
|
||||
// if size or encoding create content property evaluator
|
||||
ContentPropertyName.valueOf(field.toUpperCase());
|
||||
parameterValues.put(ComparePropertyValueEvaluator.PARAM_CONTENT_PROPERTY, field.toUpperCase());
|
||||
parameterValues.put(ComparePropertyValueEvaluator.PARAM_PROPERTY, ContentModel.TYPE_CONTENT);
|
||||
}
|
||||
catch (IllegalArgumentException ignore)
|
||||
{
|
||||
// else create common property evaluator
|
||||
parameterValues.put(ComparePropertyValueEvaluator.PARAM_PROPERTY, QName.createQName(field, namespaceService));
|
||||
}
|
||||
checkStringNotBlank(restModel.getComparator(), COMPARATOR_NOT_NULL);
|
||||
parameterValues.put(ComparePropertyValueEvaluator.PARAM_OPERATION, restModel.getComparator().toUpperCase());
|
||||
parameterValues.put(ComparePropertyValueEvaluator.PARAM_VALUE, parameter);
|
||||
break;
|
||||
}
|
||||
return new ActionConditionImpl(UUID.randomUUID().toString(), conditionDefinitionId, parameterValues);
|
||||
}
|
||||
|
||||
private void checkStringNotBlank(final String string, final String message) {
|
||||
if (Strings.isBlank(string))
|
||||
{
|
||||
throw new InvalidArgumentException(message);
|
||||
}
|
||||
}
|
||||
|
||||
private static SimpleCondition createComparePropertyValueCondition(final ActionCondition actionCondition, final NamespaceService namespaceService)
|
||||
{
|
||||
final SimpleCondition.Builder builder = SimpleCondition.builder();
|
||||
if (actionCondition.getParameterValues().get(ComparePropertyValueEvaluator.PARAM_CONTENT_PROPERTY) != null)
|
||||
{
|
||||
builder.field(actionCondition.getParameterValues().get(ComparePropertyValueEvaluator.PARAM_CONTENT_PROPERTY).toString().toLowerCase());
|
||||
} else {
|
||||
builder.field(((QName) actionCondition.getParameterValues().get(ComparePropertyValueEvaluator.PARAM_PROPERTY)).toPrefixString(namespaceService));
|
||||
}
|
||||
return builder
|
||||
.comparator(actionCondition.getParameterValues().get(ComparePropertyValueEvaluator.PARAM_OPERATION).toString().toLowerCase())
|
||||
.parameter(actionCondition.getParameterValues().get(ComparePropertyValueEvaluator.PARAM_VALUE).toString())
|
||||
.create();
|
||||
}
|
||||
|
||||
private static SimpleCondition createCompareMimeTypeCondition(final ActionCondition actionCondition)
|
||||
{
|
||||
return SimpleCondition.builder()
|
||||
.field(PARAM_MIMETYPE)
|
||||
.comparator(ComparePropertyValueOperation.EQUALS.toString().toLowerCase())
|
||||
.parameter(actionCondition.getParameterValues().get(ComparePropertyValueEvaluator.PARAM_VALUE).toString())
|
||||
.create();
|
||||
}
|
||||
|
||||
private static SimpleCondition createHasAspectCondition(final ActionCondition actionCondition, final NamespaceService namespaceService)
|
||||
{
|
||||
return SimpleCondition.builder()
|
||||
.field(HasAspectEvaluator.PARAM_ASPECT)
|
||||
.comparator(ComparePropertyValueOperation.EQUALS.toString().toLowerCase())
|
||||
.parameter(((QName) actionCondition.getParameterValues().get(HasAspectEvaluator.PARAM_ASPECT)).toPrefixString(namespaceService))
|
||||
.create();
|
||||
}
|
||||
|
||||
private static SimpleCondition createHasTagCondition(final ActionCondition actionCondition)
|
||||
{
|
||||
return SimpleCondition.builder()
|
||||
.field(HasTagEvaluator.PARAM_TAG)
|
||||
.comparator(ComparePropertyValueOperation.EQUALS.toString().toLowerCase())
|
||||
.parameter(actionCondition.getParameterValues().get(HasTagEvaluator.PARAM_TAG).toString())
|
||||
.create();
|
||||
}
|
||||
|
||||
private static SimpleCondition createInCategoryCondition(final ActionCondition actionCondition)
|
||||
{
|
||||
return SimpleCondition.builder()
|
||||
.field(PARAM_CATEGORY)
|
||||
.comparator(ComparePropertyValueOperation.EQUALS.toString().toLowerCase())
|
||||
.parameter(((NodeRef) actionCondition.getParameterValues().get(InCategoryEvaluator.PARAM_CATEGORY_VALUE)).getId())
|
||||
.create();
|
||||
}
|
||||
|
||||
private static SimpleCondition createIsSubtypeCondition(final ActionCondition actionCondition, final NamespaceService namespaceService)
|
||||
{
|
||||
return SimpleCondition.builder()
|
||||
.field(IsSubTypeEvaluator.PARAM_TYPE)
|
||||
.comparator(ComparePropertyValueOperation.EQUALS.toString().toLowerCase())
|
||||
.parameter(((QName) actionCondition.getParameterValues().get(IsSubTypeEvaluator.PARAM_TYPE)).toPrefixString(namespaceService))
|
||||
.create();
|
||||
}
|
||||
}
|
@@ -48,6 +48,7 @@ import org.alfresco.service.namespace.NamespaceService;
|
||||
import org.alfresco.service.namespace.QName;
|
||||
import org.json.JSONArray;
|
||||
import org.json.JSONException;
|
||||
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
|
||||
|
||||
@Experimental
|
||||
public class ActionParameterConverter
|
||||
@@ -64,12 +65,18 @@ public class ActionParameterConverter
|
||||
this.namespaceService = namespaceService;
|
||||
}
|
||||
|
||||
Map<String, Serializable> getConvertedParams(Map<String, Serializable> params, String name)
|
||||
public Map<String, Serializable> getConvertedParams(Map<String, Serializable> params, String name)
|
||||
{
|
||||
final Map<String, Serializable> parameters = new HashMap<>(params.size());
|
||||
final ParameterizedItemDefinition definition = actionService.getActionDefinition(name);
|
||||
if (definition == null)
|
||||
final ParameterizedItemDefinition definition;
|
||||
try
|
||||
{
|
||||
definition = actionService.getActionDefinition(name);
|
||||
if (definition == null)
|
||||
{
|
||||
throw new NotFoundException(NotFoundException.DEFAULT_MESSAGE_ID, new String[]{name});
|
||||
}
|
||||
} catch (NoSuchBeanDefinitionException e) {
|
||||
throw new NotFoundException(NotFoundException.DEFAULT_MESSAGE_ID, new String[]{name});
|
||||
}
|
||||
|
||||
|
@@ -35,6 +35,7 @@ import org.alfresco.repo.rule.RuleModel;
|
||||
import org.alfresco.rest.api.Nodes;
|
||||
import org.alfresco.rest.api.model.Node;
|
||||
import org.alfresco.rest.api.model.rules.RuleSet;
|
||||
import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
|
||||
import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
|
||||
import org.alfresco.rest.framework.core.exceptions.PermissionDeniedException;
|
||||
import org.alfresco.rest.framework.core.exceptions.RelationshipResourceNotFoundException;
|
||||
@@ -65,14 +66,21 @@ public class NodeValidator
|
||||
* @return folder node reference
|
||||
* @throws InvalidArgumentException if node is not of an expected type
|
||||
* @throws PermissionDeniedException if the user doesn't have the appropriate permission for the folder.
|
||||
* @throws EntityNotFoundException if the folder node isn't found
|
||||
*/
|
||||
public NodeRef validateFolderNode(final String folderNodeId, boolean requireChangePermission)
|
||||
{
|
||||
final NodeRef nodeRef = nodes.validateOrLookupNode(folderNodeId, null);
|
||||
validatePermission(requireChangePermission, nodeRef);
|
||||
verifyNodeType(nodeRef, ContentModel.TYPE_FOLDER, null);
|
||||
try
|
||||
{
|
||||
final NodeRef nodeRef = nodes.validateOrLookupNode(folderNodeId, null);
|
||||
validatePermission(requireChangePermission, nodeRef);
|
||||
verifyNodeType(nodeRef, ContentModel.TYPE_FOLDER, null);
|
||||
|
||||
return nodeRef;
|
||||
return nodeRef;
|
||||
} catch (EntityNotFoundException e)
|
||||
{
|
||||
throw new EntityNotFoundException("Folder with id " + folderNodeId + " was not found.", e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -82,6 +90,8 @@ public class NodeValidator
|
||||
* @param associatedFolderNodeRef - folder node ref to check the association
|
||||
* @return rule set node reference
|
||||
* @throws InvalidArgumentException in case of not matching associated folder node
|
||||
* @throws RelationshipResourceNotFoundException if the folder doesn't have a -default- rule set
|
||||
* @throws EntityNotFoundException if the rule set node isn't found
|
||||
*/
|
||||
public NodeRef validateRuleSetNode(final String ruleSetId, final NodeRef associatedFolderNodeRef)
|
||||
{
|
||||
@@ -96,13 +106,18 @@ public class NodeValidator
|
||||
return ruleSetNodeRef;
|
||||
}
|
||||
|
||||
final NodeRef ruleSetNodeRef = validateNode(ruleSetId, ContentModel.TYPE_SYSTEM_FOLDER, RULE_SET_EXPECTED_TYPE_NAME);
|
||||
if (!ruleService.isRuleSetAssociatedWithFolder(ruleSetNodeRef, associatedFolderNodeRef))
|
||||
{
|
||||
throw new InvalidArgumentException("Rule set is not associated with folder node!");
|
||||
}
|
||||
try {
|
||||
final NodeRef ruleSetNodeRef = validateNode(ruleSetId, ContentModel.TYPE_SYSTEM_FOLDER, RULE_SET_EXPECTED_TYPE_NAME);
|
||||
|
||||
return ruleSetNodeRef;
|
||||
if (!ruleService.isRuleSetAssociatedWithFolder(ruleSetNodeRef, associatedFolderNodeRef))
|
||||
{
|
||||
throw new InvalidArgumentException("Rule set is not associated with folder node!");
|
||||
}
|
||||
return ruleSetNodeRef;
|
||||
|
||||
} catch (EntityNotFoundException e) {
|
||||
throw new EntityNotFoundException("Rule set with id " + ruleSetId + " was not found.", e);
|
||||
}
|
||||
}
|
||||
|
||||
public NodeRef validateRuleSetNode(String linkToNodeId, boolean requireChangePermission)
|
||||
|
@@ -27,11 +27,14 @@ package org.alfresco.rest.api.impl.rules;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import org.alfresco.rest.api.model.mapper.RestModelMapper;
|
||||
import org.alfresco.rest.api.model.rules.CompositeCondition;
|
||||
import org.alfresco.rest.api.model.rules.Rule;
|
||||
import org.alfresco.rest.api.model.rules.SimpleCondition;
|
||||
import org.alfresco.service.Experimental;
|
||||
import org.alfresco.service.cmr.action.ActionCondition;
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
import org.alfresco.service.cmr.rule.RuleService;
|
||||
import org.alfresco.service.namespace.NamespaceService;
|
||||
|
||||
/** Responsible for creating {@link Rule} objects. */
|
||||
@Experimental
|
||||
@@ -40,11 +43,11 @@ public class RuleLoader
|
||||
public static final String IS_SHARED = "isShared";
|
||||
private RuleService ruleService;
|
||||
private NodeValidator nodeValidator;
|
||||
private NamespaceService namespaceService;
|
||||
private RestModelMapper<Rule, org.alfresco.service.cmr.rule.Rule> ruleMapper;
|
||||
|
||||
public Rule loadRule(org.alfresco.service.cmr.rule.Rule ruleModel, List<String> includes)
|
||||
{
|
||||
Rule rule = Rule.from(ruleModel, namespaceService);
|
||||
final Rule rule = ruleMapper.toRestModel(ruleModel);
|
||||
if (includes != null && includes.contains(IS_SHARED))
|
||||
{
|
||||
NodeRef ruleSet = ruleService.getRuleSetNode(ruleModel.getNodeRef());
|
||||
@@ -64,8 +67,9 @@ public class RuleLoader
|
||||
this.nodeValidator = nodeValidator;
|
||||
}
|
||||
|
||||
public void setNamespaceService(NamespaceService namespaceService)
|
||||
public void setRuleMapper(
|
||||
RestModelMapper<Rule, org.alfresco.service.cmr.rule.Rule> ruleMapper)
|
||||
{
|
||||
this.namespaceService = namespaceService;
|
||||
this.ruleMapper = ruleMapper;
|
||||
}
|
||||
}
|
||||
|
@@ -25,17 +25,22 @@
|
||||
*/
|
||||
package org.alfresco.rest.api.impl.rules;
|
||||
|
||||
import static java.util.stream.Collectors.toList;
|
||||
|
||||
import static org.alfresco.rest.api.model.rules.InclusionType.INHERITED;
|
||||
import static org.alfresco.rest.api.model.rules.InclusionType.LINKED;
|
||||
import static org.alfresco.rest.api.model.rules.InclusionType.OWNED;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import org.alfresco.repo.security.authentication.AuthenticationUtil;
|
||||
import org.alfresco.rest.api.impl.mapper.rules.RestRuleModelMapper;
|
||||
import org.alfresco.rest.api.model.rules.RuleSet;
|
||||
import org.alfresco.service.Experimental;
|
||||
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.rule.RuleService;
|
||||
|
||||
/** Responsible for converting a NodeRef into a {@link RuleSet} object. */
|
||||
@Experimental
|
||||
@@ -43,7 +48,15 @@ public class RuleSetLoader
|
||||
{
|
||||
protected static final String OWNING_FOLDER = "owningFolder";
|
||||
protected static final String INCLUSION_TYPE = "inclusionType";
|
||||
protected static final String INHERITED_BY = "inheritedBy";
|
||||
protected static final String LINKED_TO_BY = "linkedToBy";
|
||||
protected static final String IS_INHERITED = "isInherited";
|
||||
protected static final String IS_LINKED_TO = "isLinkedTo";
|
||||
protected static final String RULE_IDS = "ruleIds";
|
||||
private static final int MAX_INHERITED_BY_SIZE = 100;
|
||||
private static final int MAX_LINKED_TO_BY_SIZE = 100;
|
||||
private NodeService nodeService;
|
||||
private RuleService ruleService;
|
||||
|
||||
/**
|
||||
* Load a rule set for the given node ref.
|
||||
@@ -79,12 +92,78 @@ public class RuleSetLoader
|
||||
ruleSet.setInclusionType(linked ? LINKED : INHERITED);
|
||||
}
|
||||
}
|
||||
if (includes.contains(INHERITED_BY))
|
||||
{
|
||||
ruleSet.setInheritedBy(loadInheritedBy(ruleSetNodeRef));
|
||||
}
|
||||
if (includes.contains(LINKED_TO_BY))
|
||||
{
|
||||
ruleSet.setLinkedToBy(loadLinkedToBy(ruleSetNodeRef));
|
||||
}
|
||||
if (includes.contains(IS_INHERITED))
|
||||
{
|
||||
ruleSet.setIsInherited(loadIsInherited(ruleSetNodeRef));
|
||||
}
|
||||
if (includes.contains(IS_LINKED_TO))
|
||||
{
|
||||
ruleSet.setIsLinkedTo(loadIsLinkedTo(ruleSetNodeRef, parentRef));
|
||||
}
|
||||
if (includes.contains(RULE_IDS))
|
||||
{
|
||||
ruleSet.setRuleIds(loadRuleIds(parentRef));
|
||||
}
|
||||
}
|
||||
return ruleSet;
|
||||
}
|
||||
|
||||
private List<NodeRef> loadInheritedBy(NodeRef ruleSetNodeRef)
|
||||
{
|
||||
return ruleService.getFoldersInheritingRuleSet(ruleSetNodeRef, MAX_INHERITED_BY_SIZE);
|
||||
}
|
||||
|
||||
private List<NodeRef> loadLinkedToBy(NodeRef ruleSetNodeRef)
|
||||
{
|
||||
return ruleService.getFoldersLinkingToRuleSet(ruleSetNodeRef, MAX_LINKED_TO_BY_SIZE);
|
||||
}
|
||||
|
||||
private boolean loadIsInherited(NodeRef ruleSetNodeRef)
|
||||
{
|
||||
return AuthenticationUtil.runAsSystem(() -> !ruleService.getFoldersInheritingRuleSet(ruleSetNodeRef, 1).isEmpty());
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if any parents of the rule set node are not the owning folder.
|
||||
*
|
||||
* @param ruleSetNodeRef The rule set node.
|
||||
* @param parentRef The owning folder.
|
||||
* @return True if another folder links to the rule set.
|
||||
*/
|
||||
private Boolean loadIsLinkedTo(NodeRef ruleSetNodeRef, NodeRef parentRef)
|
||||
{
|
||||
return AuthenticationUtil.runAsSystem(() ->
|
||||
nodeService.getParentAssocs(ruleSetNodeRef)
|
||||
.stream()
|
||||
.map(ChildAssociationRef::getParentRef)
|
||||
.anyMatch(folder -> !folder.equals(parentRef))
|
||||
);
|
||||
}
|
||||
|
||||
public List<String> loadRuleIds(NodeRef folderNodeRef)
|
||||
{
|
||||
return ruleService.getRules(folderNodeRef, false).stream()
|
||||
.map(org.alfresco.service.cmr.rule.Rule::getNodeRef)
|
||||
.map(NodeRef::getId)
|
||||
.collect(toList());
|
||||
}
|
||||
|
||||
public void setNodeService(NodeService nodeService)
|
||||
{
|
||||
this.nodeService = nodeService;
|
||||
}
|
||||
|
||||
public void setRuleService(RuleService ruleService)
|
||||
{
|
||||
this.ruleService = ruleService;
|
||||
}
|
||||
|
||||
}
|
||||
|
@@ -28,11 +28,18 @@ package org.alfresco.rest.api.impl.rules;
|
||||
|
||||
import static java.util.stream.Collectors.toList;
|
||||
|
||||
import static org.alfresco.service.cmr.repository.StoreRef.STORE_REF_WORKSPACE_SPACESSTORE;
|
||||
import static org.alfresco.util.collections.CollectionUtils.isEmpty;
|
||||
|
||||
import java.util.HashSet;
|
||||
import java.util.List;
|
||||
import java.util.Objects;
|
||||
import java.util.Set;
|
||||
import java.util.stream.IntStream;
|
||||
|
||||
import org.alfresco.repo.rule.RuleModel;
|
||||
import org.alfresco.repo.rule.RuntimeRuleService;
|
||||
import org.alfresco.repo.security.permissions.AccessDeniedException;
|
||||
import org.alfresco.rest.api.RuleSets;
|
||||
import org.alfresco.rest.api.model.rules.RuleSet;
|
||||
import org.alfresco.rest.api.model.rules.RuleSetLink;
|
||||
@@ -44,10 +51,14 @@ import org.alfresco.service.Experimental;
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
import org.alfresco.service.cmr.repository.NodeService;
|
||||
import org.alfresco.service.cmr.rule.RuleService;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
@Experimental
|
||||
public class RuleSetsImpl implements RuleSets
|
||||
{
|
||||
private static final Logger LOGGER = LoggerFactory.getLogger(RuleSetsImpl.class);
|
||||
|
||||
private RuleSetLoader ruleSetLoader;
|
||||
private RuleService ruleService;
|
||||
private NodeValidator validator;
|
||||
@@ -61,15 +72,42 @@ public class RuleSetsImpl implements RuleSets
|
||||
|
||||
List<RuleSet> ruleSets = ruleService.getNodesSupplyingRuleSets(folderNode)
|
||||
.stream()
|
||||
.map(ruleService::getRuleSetNode)
|
||||
.map(supplyingNode -> loadRuleSet(supplyingNode, folderNode, includes))
|
||||
.filter(Objects::nonNull)
|
||||
.map(nodeRef -> ruleSetLoader.loadRuleSet(nodeRef, folderNode, includes))
|
||||
.distinct()
|
||||
.collect(toList());
|
||||
|
||||
return ListPage.of(ruleSets, paging);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load the specified rule set if the user has permission.
|
||||
*
|
||||
* @param supplyingNode The folder supplying a rule set.
|
||||
* @param folderNode The folder being supplied with rule sets.
|
||||
* @param includes The list of optional fields to include for each rule set in the response.
|
||||
* @return The rule set from the DB or null if the folder has no rule set, or the current user does not have permission to view it.
|
||||
*/
|
||||
private RuleSet loadRuleSet(NodeRef supplyingNode, NodeRef folderNode, List<String> includes)
|
||||
{
|
||||
NodeRef ruleSetNode = ruleService.getRuleSetNode(supplyingNode);
|
||||
// Check if the folder has no rule sets.
|
||||
if (ruleSetNode == null)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
return ruleSetLoader.loadRuleSet(ruleSetNode, folderNode, includes);
|
||||
}
|
||||
catch (AccessDeniedException e)
|
||||
{
|
||||
LOGGER.debug("User does not have permission to view rule set with id {}.", ruleSetNode, e);
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public RuleSet getRuleSetById(String folderNodeId, String ruleSetId, List<String> includes)
|
||||
{
|
||||
@@ -79,6 +117,43 @@ public class RuleSetsImpl implements RuleSets
|
||||
return ruleSetLoader.loadRuleSet(ruleSetNode, folderNode, includes);
|
||||
}
|
||||
|
||||
@Override
|
||||
public RuleSet updateRuleSet(String folderNodeId, RuleSet ruleSet, List<String> includes)
|
||||
{
|
||||
// Editing the order of the rules doesn't require permission to edit the rule set itself.
|
||||
NodeRef folderNode = validator.validateFolderNode(folderNodeId, false);
|
||||
NodeRef ruleSetNode = validator.validateRuleSetNode(ruleSet.getId(), folderNode);
|
||||
|
||||
RuleSet returnedRuleSet = ruleSetLoader.loadRuleSet(ruleSetNode, folderNode, includes);
|
||||
|
||||
// Currently the only field that can be updated is ruleIds to reorder the rules.
|
||||
List<String> suppliedRuleIds = ruleSet.getRuleIds();
|
||||
if (!isEmpty(suppliedRuleIds))
|
||||
{
|
||||
// Check there are no duplicate rule ids in the request.
|
||||
Set<String> suppliedRuleIdSet = new HashSet<>(suppliedRuleIds);
|
||||
|
||||
// Check that the set of rule ids hasn't changed.
|
||||
Set<String> existingRuleIds = new HashSet<>(ruleSetLoader.loadRuleIds(folderNode));
|
||||
if (suppliedRuleIdSet.size() != suppliedRuleIds.size() || !suppliedRuleIdSet.equals(existingRuleIds))
|
||||
{
|
||||
throw new InvalidArgumentException("Unexpected set of rule ids - received " + suppliedRuleIds + " but expected " + existingRuleIds);
|
||||
}
|
||||
|
||||
IntStream.range(0, suppliedRuleIds.size()).forEach(index ->
|
||||
{
|
||||
NodeRef ruleNode = new NodeRef(STORE_REF_WORKSPACE_SPACESSTORE, suppliedRuleIds.get(index));
|
||||
ruleService.setRulePosition(folderNode, ruleNode, index);
|
||||
});
|
||||
if (includes.contains(RuleSetLoader.RULE_IDS))
|
||||
{
|
||||
returnedRuleSet.setRuleIds(suppliedRuleIds);
|
||||
}
|
||||
}
|
||||
|
||||
return returnedRuleSet;
|
||||
}
|
||||
|
||||
@Override
|
||||
public RuleSetLink linkToRuleSet(String folderNodeId, String linkToNodeId)
|
||||
{
|
||||
@@ -86,8 +161,8 @@ public class RuleSetsImpl implements RuleSets
|
||||
final NodeRef folderNodeRef = validator.validateFolderNode(folderNodeId,true);
|
||||
final boolean isRuleSetNode = validator.isRuleSetNode(linkToNodeId);
|
||||
final NodeRef linkToNodeRef = isRuleSetNode
|
||||
? validator.validateRuleSetNode(linkToNodeId, true)
|
||||
: validator.validateFolderNode(linkToNodeId, true);
|
||||
? validator.validateRuleSetNode(linkToNodeId, false)
|
||||
: validator.validateFolderNode(linkToNodeId, false);
|
||||
|
||||
//The target node should have pre-existing rules to link to
|
||||
if (!ruleService.hasRules(linkToNodeRef)) {
|
||||
@@ -110,6 +185,22 @@ public class RuleSetsImpl implements RuleSets
|
||||
return ruleSetLink;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void unlinkRuleSet(String folderNodeId, String ruleSetId)
|
||||
{
|
||||
final NodeRef folderNodeRef = validator.validateFolderNode(folderNodeId,true);
|
||||
final NodeRef ruleSetNodeRef = validator.validateRuleSetNode(ruleSetId, folderNodeRef);
|
||||
|
||||
//The folder should be linked to a rule set
|
||||
if (!ruleService.isLinkedToRuleNode(folderNodeRef))
|
||||
{
|
||||
throw new InvalidArgumentException("The folder is not linked to a rule set.");
|
||||
}
|
||||
|
||||
//The following line also handles the deletion of the parent-child association that gets created during linking
|
||||
nodeService.removeAspect(folderNodeRef,RuleModel.ASPECT_RULES);
|
||||
}
|
||||
|
||||
public void setRuleSetLoader(RuleSetLoader ruleSetLoader)
|
||||
{
|
||||
this.ruleSetLoader = ruleSetLoader;
|
||||
|
@@ -26,22 +26,30 @@
|
||||
|
||||
package org.alfresco.rest.api.impl.rules;
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import org.alfresco.rest.api.Nodes;
|
||||
import org.alfresco.repo.action.ActionImpl;
|
||||
import org.alfresco.repo.action.access.ActionAccessRestriction;
|
||||
import org.alfresco.repo.action.executer.ExecuteAllRulesActionExecuter;
|
||||
import org.alfresco.rest.api.Rules;
|
||||
import org.alfresco.rest.api.model.mapper.RestModelMapper;
|
||||
import org.alfresco.rest.api.model.rules.Rule;
|
||||
import org.alfresco.rest.api.model.rules.RuleExecution;
|
||||
import org.alfresco.rest.api.model.rules.RuleSet;
|
||||
import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
|
||||
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
|
||||
import org.alfresco.rest.framework.resource.parameters.ListPage;
|
||||
import org.alfresco.rest.framework.resource.parameters.Paging;
|
||||
import org.alfresco.service.Experimental;
|
||||
import org.alfresco.service.cmr.action.CompositeAction;
|
||||
import org.alfresco.service.cmr.action.ActionService;
|
||||
import org.alfresco.service.cmr.repository.NodeRef;
|
||||
import org.alfresco.service.cmr.rule.RuleService;
|
||||
import org.alfresco.service.namespace.NamespaceService;
|
||||
import org.alfresco.util.GUID;
|
||||
import org.apache.commons.collections.CollectionUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
@@ -49,14 +57,14 @@ import org.slf4j.LoggerFactory;
|
||||
public class RulesImpl implements Rules
|
||||
{
|
||||
private static final Logger LOGGER = LoggerFactory.getLogger(RulesImpl.class);
|
||||
private static final String MUST_HAVE_AT_LEAST_ONE_ACTION = "A rule must have at least one action";
|
||||
|
||||
private Nodes nodes;
|
||||
private ActionService actionService;
|
||||
private RuleService ruleService;
|
||||
private NodeValidator validator;
|
||||
private RuleLoader ruleLoader;
|
||||
private ActionParameterConverter actionParameterConverter;
|
||||
private ActionPermissionValidator actionPermissionValidator;
|
||||
private NamespaceService namespaceService;
|
||||
private RestModelMapper<Rule, org.alfresco.service.cmr.rule.Rule> ruleMapper;
|
||||
|
||||
@Override
|
||||
public CollectionWithPagingInfo<Rule> getRules(final String folderNodeId,
|
||||
@@ -69,7 +77,7 @@ public class RulesImpl implements Rules
|
||||
NodeRef owningFolder = ruleService.getOwningNodeRef(ruleSetNode);
|
||||
|
||||
final List<Rule> rules = ruleService.getRules(owningFolder, false).stream()
|
||||
.map(ruleModel -> loadRuleAndConvertActionParams(ruleModel, includes))
|
||||
.map(ruleModel -> ruleLoader.loadRule(ruleModel, includes))
|
||||
.collect(Collectors.toList());
|
||||
|
||||
return ListPage.of(rules, paging);
|
||||
@@ -82,7 +90,7 @@ public class RulesImpl implements Rules
|
||||
final NodeRef ruleSetNodeRef = validator.validateRuleSetNode(ruleSetId, folderNodeRef);
|
||||
final NodeRef ruleNodeRef = validator.validateRuleNode(ruleId, ruleSetNodeRef);
|
||||
|
||||
return loadRuleAndConvertActionParams(ruleService.getRule(ruleNodeRef), includes);
|
||||
return ruleLoader.loadRule(ruleService.getRule(ruleNodeRef), includes);
|
||||
}
|
||||
|
||||
@Override
|
||||
@@ -98,7 +106,7 @@ public class RulesImpl implements Rules
|
||||
return rules.stream()
|
||||
.map(this::mapToServiceModelAndValidateActions)
|
||||
.map(rule -> ruleService.saveRule(folderNodeRef, rule))
|
||||
.map(rule -> loadRuleAndConvertActionParams(rule, includes))
|
||||
.map(rule -> ruleLoader.loadRule(rule, includes))
|
||||
.collect(Collectors.toList());
|
||||
}
|
||||
|
||||
@@ -124,32 +132,39 @@ public class RulesImpl implements Rules
|
||||
ruleService.removeRule(folderNodeRef, rule);
|
||||
}
|
||||
|
||||
@Override
|
||||
public RuleExecution executeRules(final String folderNodeId, final boolean eachSubFolderIncluded)
|
||||
{
|
||||
final NodeRef folderNodeRef = validator.validateFolderNode(folderNodeId, false);
|
||||
final Map<String, Serializable> parameterValues = new HashMap<>();
|
||||
parameterValues.put(ExecuteAllRulesActionExecuter.PARAM_RUN_ALL_RULES_ON_CHILDREN, eachSubFolderIncluded);
|
||||
parameterValues.put(ExecuteAllRulesActionExecuter.PARAM_EXECUTE_INHERITED_RULES, true);
|
||||
final ActionImpl action = new ActionImpl(null, GUID.generate(), ExecuteAllRulesActionExecuter.NAME);
|
||||
action.setNodeRef(folderNodeRef);
|
||||
action.setParameterValues(parameterValues);
|
||||
|
||||
ActionAccessRestriction.setActionContext(action, ActionAccessRestriction.V1_ACTION_CONTEXT);
|
||||
actionService.executeAction(action, folderNodeRef, true, false);
|
||||
|
||||
return RuleExecution.builder()
|
||||
.eachSubFolderIncluded(eachSubFolderIncluded)
|
||||
.create();
|
||||
}
|
||||
|
||||
private org.alfresco.service.cmr.rule.Rule mapToServiceModelAndValidateActions(Rule rule)
|
||||
{
|
||||
final org.alfresco.service.cmr.rule.Rule serviceModelRule = rule.toServiceModel(nodes, namespaceService);
|
||||
final CompositeAction compositeAction = (CompositeAction) serviceModelRule.getAction();
|
||||
compositeAction.getActions().forEach(action -> action.setParameterValues(
|
||||
actionParameterConverter.getConvertedParams(action.getParameterValues(), action.getActionDefinitionName())));
|
||||
if (CollectionUtils.isEmpty(rule.getActions()))
|
||||
{
|
||||
throw new InvalidArgumentException(MUST_HAVE_AT_LEAST_ONE_ACTION);
|
||||
}
|
||||
final org.alfresco.service.cmr.rule.Rule serviceModelRule = ruleMapper.toServiceModel(rule);
|
||||
|
||||
return actionPermissionValidator.validateRulePermissions(serviceModelRule);
|
||||
}
|
||||
|
||||
private Rule loadRuleAndConvertActionParams(org.alfresco.service.cmr.rule.Rule ruleModel, List<String> includes)
|
||||
public void setActionService(ActionService actionService)
|
||||
{
|
||||
final Rule rule = ruleLoader.loadRule(ruleModel, includes);
|
||||
rule.getActions()
|
||||
.forEach(a -> a.setParams(a.getParams().entrySet()
|
||||
.stream()
|
||||
.collect(Collectors
|
||||
.toMap(Map.Entry::getKey, e -> actionParameterConverter.convertParamFromServiceModel(e.getValue())))
|
||||
)
|
||||
);
|
||||
return rule;
|
||||
}
|
||||
|
||||
public void setNodes(Nodes nodes)
|
||||
{
|
||||
this.nodes = nodes;
|
||||
this.actionService = actionService;
|
||||
}
|
||||
|
||||
public void setRuleService(RuleService ruleService)
|
||||
@@ -167,18 +182,14 @@ public class RulesImpl implements Rules
|
||||
this.ruleLoader = ruleLoader;
|
||||
}
|
||||
|
||||
public void setActionParameterConverter(ActionParameterConverter actionParameterConverter)
|
||||
{
|
||||
this.actionParameterConverter = actionParameterConverter;
|
||||
}
|
||||
|
||||
public void setActionPermissionValidator(ActionPermissionValidator actionPermissionValidator)
|
||||
{
|
||||
this.actionPermissionValidator = actionPermissionValidator;
|
||||
}
|
||||
|
||||
public void setNamespaceService(NamespaceService namespaceService)
|
||||
public void setRuleMapper(
|
||||
RestModelMapper<Rule, org.alfresco.service.cmr.rule.Rule> ruleMapper)
|
||||
{
|
||||
this.namespaceService = namespaceService;
|
||||
this.ruleMapper = ruleMapper;
|
||||
}
|
||||
}
|
||||
|
@@ -0,0 +1,133 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Remote API
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2022 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.impl.validator.actions;
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.Map;
|
||||
|
||||
import org.alfresco.rest.api.Actions;
|
||||
import org.alfresco.rest.api.actions.ActionValidator;
|
||||
import org.alfresco.rest.api.model.ActionDefinition;
|
||||
import org.alfresco.rest.api.model.ActionParameterConstraint;
|
||||
import org.alfresco.rest.api.model.rules.Action;
|
||||
import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
|
||||
import org.alfresco.rest.framework.core.exceptions.NotFoundException;
|
||||
import org.alfresco.service.Experimental;
|
||||
import org.apache.commons.collections.CollectionUtils;
|
||||
import org.apache.commons.collections.MapUtils;
|
||||
|
||||
/**
|
||||
* This class will validate all action types against action parameters definitions (mandatory parameters, parameter constraints)
|
||||
*/
|
||||
@Experimental
|
||||
public class ActionParameterDefinitionValidator implements ActionValidator
|
||||
{
|
||||
private static final boolean IS_ENABLED = true;
|
||||
static final String INVALID_PARAMETER_VALUE =
|
||||
"Action parameter: %s has invalid value (%s). Look up possible values for constraint name %s";
|
||||
static final String MISSING_PARAMETER = "Missing action's mandatory parameter: %s";
|
||||
static final String MUST_NOT_CONTAIN_PARAMETER = "Action of definition id: %s must not contain parameter of name: %s";
|
||||
static final String PARAMS_SHOULD_NOT_BE_EMPTY =
|
||||
"Action parameters should not be null or empty for this action. See Action Definition for action of: %s";
|
||||
static final String INVALID_ACTION_DEFINITION = "Invalid action definition requested %s";
|
||||
|
||||
private final Actions actions;
|
||||
|
||||
public ActionParameterDefinitionValidator(Actions actions)
|
||||
{
|
||||
this.actions = actions;
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates action against its parameters definitions (mandatory parameters, parameter constraints)
|
||||
*
|
||||
* @param action Action to be validated
|
||||
*/
|
||||
@Override
|
||||
public void validate(Action action)
|
||||
{
|
||||
ActionDefinition actionDefinition;
|
||||
try
|
||||
{
|
||||
actionDefinition = actions.getActionDefinitionById(action.getActionDefinitionId());
|
||||
} catch (NotFoundException e) {
|
||||
throw new InvalidArgumentException(String.format(INVALID_ACTION_DEFINITION, action.getActionDefinitionId()));
|
||||
}
|
||||
validateParametersSize(action.getParams(), actionDefinition);
|
||||
final Map<String, Serializable> params = action.getParams();
|
||||
if (MapUtils.isNotEmpty(params))
|
||||
{
|
||||
params.forEach((key, value) -> checkParameterShouldExist(key, actionDefinition));
|
||||
actionDefinition.getParameterDefinitions().forEach(p -> validateParameterDefinitions(p, params));
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isEnabled()
|
||||
{
|
||||
return IS_ENABLED;
|
||||
}
|
||||
|
||||
private void validateParametersSize(final Map<String, Serializable> params, final ActionDefinition actionDefinition)
|
||||
{
|
||||
if (CollectionUtils.isNotEmpty(actionDefinition.getParameterDefinitions()) && MapUtils.isEmpty(params))
|
||||
{
|
||||
throw new IllegalArgumentException(String.format(PARAMS_SHOULD_NOT_BE_EMPTY, actionDefinition.getName()));
|
||||
}
|
||||
}
|
||||
|
||||
private void validateParameterDefinitions(final ActionDefinition.ParameterDefinition parameterDefinition,
|
||||
final Map<String, Serializable> params)
|
||||
{
|
||||
final Serializable parameterValue = params.get(parameterDefinition.getName());
|
||||
if (parameterDefinition.isMandatory() && parameterValue == null)
|
||||
{
|
||||
throw new IllegalArgumentException(String.format(MISSING_PARAMETER, parameterDefinition.getName()));
|
||||
}
|
||||
if (parameterDefinition.getParameterConstraintName() != null)
|
||||
{
|
||||
final ActionParameterConstraint actionConstraint =
|
||||
actions.getActionConstraint(parameterDefinition.getParameterConstraintName());
|
||||
if (parameterValue != null && actionConstraint.getConstraintValues().stream()
|
||||
.noneMatch(constraintData -> constraintData.getValue().equals(parameterValue.toString())))
|
||||
{
|
||||
throw new IllegalArgumentException(String.format(INVALID_PARAMETER_VALUE, parameterDefinition.getName(), parameterValue,
|
||||
actionConstraint.getConstraintName()));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void checkParameterShouldExist(final String parameterName, final ActionDefinition actionDefinition)
|
||||
{
|
||||
if (actionDefinition.getParameterDefinitions().stream().noneMatch(pd -> parameterName.equals(pd.getName())))
|
||||
{
|
||||
throw new IllegalArgumentException(String.format(MUST_NOT_CONTAIN_PARAMETER, actionDefinition.getName(), parameterName));
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
}
|
@@ -0,0 +1,99 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Remote API
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2021 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.model;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import org.alfresco.service.Experimental;
|
||||
|
||||
/**
|
||||
* Representation of action parameter constraint.
|
||||
* Helps to constraint the list of allowable values for an action parameter.
|
||||
* When action parameter has constraints defined (@see ActionDefinition.ParameterDefinition#getParameterConstraintName())
|
||||
* they will be listed here.
|
||||
*
|
||||
* @author mpichura
|
||||
*/
|
||||
@Experimental
|
||||
public class ActionParameterConstraint
|
||||
{
|
||||
/**
|
||||
* Constraint name.
|
||||
*/
|
||||
private String constraintName;
|
||||
/**
|
||||
* List of objects representing constraint values along with additional data
|
||||
*/
|
||||
private List<ConstraintData> constraintValues;
|
||||
|
||||
public List<ConstraintData> getConstraintValues()
|
||||
{
|
||||
return constraintValues;
|
||||
}
|
||||
|
||||
public void setConstraintValues(List<ConstraintData> constraintValues)
|
||||
{
|
||||
this.constraintValues = constraintValues;
|
||||
}
|
||||
|
||||
public String getConstraintName()
|
||||
{
|
||||
return constraintName;
|
||||
}
|
||||
|
||||
public void setConstraintName(String constraintName)
|
||||
{
|
||||
this.constraintName = constraintName;
|
||||
}
|
||||
|
||||
public static class ConstraintData
|
||||
{
|
||||
public ConstraintData(final String value, final String label)
|
||||
{
|
||||
this.value = value;
|
||||
this.label = label;
|
||||
}
|
||||
/**
|
||||
* Actual constraint value
|
||||
*/
|
||||
private String value;
|
||||
/**
|
||||
* A label associated to constraint's value
|
||||
*/
|
||||
private String label;
|
||||
|
||||
public String getValue()
|
||||
{
|
||||
return value;
|
||||
}
|
||||
|
||||
public String getLabel()
|
||||
{
|
||||
return label;
|
||||
}
|
||||
}
|
||||
}
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user