mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-24 17:32:48 +00:00
Merge pull request #1435 from Alfresco/feature/ACS-3589_TASCMISMerge
ACS-3589 Merge TAS CMIS into community repo.
This commit is contained in:
Tom Page
GitHub
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,28 @@
|
||||
<?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.136-SNAPSHOT</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>
|
||||
<tas.utility.version>3.0.53</tas.utility.version>
|
||||
<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 +59,30 @@
|
||||
</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>
|
||||
<version>${tas.utility.version}</version>
|
||||
<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,256 @@
|
||||
package org.alfresco.cmis.dsl;
|
||||
|
||||
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.Set;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import com.google.common.collect.Streams;
|
||||
|
||||
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.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 returnedResults = -1;
|
||||
private String currentQuery = "";
|
||||
private ItemIterable<QueryResult> results;
|
||||
|
||||
public QueryExecutor(CmisWrapper cmisWrapper, String query)
|
||||
{
|
||||
this.cmisWrapper = cmisWrapper;
|
||||
currentQuery = query;
|
||||
}
|
||||
|
||||
public QueryResultAssertion assertResultsCount()
|
||||
{
|
||||
returnedResults = executeQuery(currentQuery).getPageNumItems();
|
||||
return new QueryResultAssertion();
|
||||
}
|
||||
|
||||
public QueryResultAssertion assertColumnIsOrdered()
|
||||
{
|
||||
results = executeQuery(currentQuery);
|
||||
return new QueryResultAssertion();
|
||||
}
|
||||
|
||||
public QueryResultAssertion assertColumnValuesRange()
|
||||
{
|
||||
results = executeQuery(currentQuery);
|
||||
return new QueryResultAssertion();
|
||||
}
|
||||
|
||||
public QueryResultAssertion assertValues()
|
||||
{
|
||||
results = executeQuery(currentQuery);
|
||||
return new QueryResultAssertion();
|
||||
}
|
||||
|
||||
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 equals(long expectedValue)
|
||||
{
|
||||
STEP(String.format("Verify that query: '%s' has %d results count returned", currentQuery, expectedValue));
|
||||
Assert.assertEquals(returnedResults, 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 <= returnedResults)
|
||||
Assert.fail(String.format("%s expected to have more than %d results, but found %d", showErrorMessage(), expectedValue, returnedResults));
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
public QueryResultAssertion isLowerThan(long expectedValue)
|
||||
{
|
||||
STEP(String.format("Verify that query: '%s' has more than %d results count returned", currentQuery, expectedValue));
|
||||
if (returnedResults >= expectedValue)
|
||||
Assert.fail(String.format("%s expected to have less than %d results, but found %d", showErrorMessage(), expectedValue, returnedResults));
|
||||
|
||||
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(Collectors.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(Collectors.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)
|
||||
{
|
||||
STEP(String.format("Verify that query: '%s' returns the values from %s for column %s", currentQuery, values, queryName));
|
||||
Set<T> resultSet = Streams.stream(results).map(r -> (T) r.getPropertyValueByQueryName(queryName)).collect(toSet());
|
||||
Assert.assertEquals(resultSet, values, "Values did not match");
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
public <T> QueryResultAssertion isReturningOrderedValues(String queryName, List<T> values)
|
||||
{
|
||||
STEP(String.format("Verify that query: '%s' returns the values from %s for column %s", currentQuery, values, queryName));
|
||||
List<T> resultList = Streams.stream(results).map(r -> (T) r.getPropertyValueByQueryName(queryName)).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
|
||||
Reference in New Issue
Block a user