Commit 3265607cef03be17ca9e080db83cfbdf1dcc192f

Authored by Meenal Bhave
1 parent 703b71d3ec
Exists in master

Amended the README.md

Showing 1 changed file with 31 additions and 5 deletions   Show diff stats
... ... @@ -16,26 +16,33 @@
16 16 * You should have received a copy of the GNU Lesser General Public License
17 17 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
18 18 */
  19 +
  20 + <!-- MarkdownTOC -->
  21 + - [ReadMe](#prerequisits)
  22 + - [Prerequisits](#prerequisits)
  23 +
19 24 *****************
20   -ReadMe
  25 +## ReadMe
21 26 *****************
22 27 The project is designed to work on one or more instances of Alfresco (Enterprise / Cloud / Hybrid).
23 28 More than one instances can be tested in parallel / at a time.
24 29  
25   -It needs the following files in the resources per Alfresco Instance / node you wish to test.
  30 +## Prerequisits
  31 +A running instance of Alfresco repo is required.
  32 +Edit the following files in the resources for each Alfresco Instance / node you wish to test.
26 33  
27 34 1> .properties file with properties for Alfresco Instance such as:
28   -#Alfresco properties
  35 +## Alfresco properties
29 36 api.target = https://test2api.alfresco.me
30 37 api.port = 443
31 38 api.version = MyAlfresco
32 39  
33   -#Layer7 Enabled on Cloud Environment?
  40 +## Layer7 Enabled on Cloud Environment?
34 41 hybrid.layer7Enabled = false
35 42 hybrid.apiKey =
36 43 hybrid.apiSecretKey =
37 44  
38   -#Comma separated List of users with a special password (different than username)
  45 +## Comma separated List of users with a special password (different than username)
39 46 users = user1@freenet.test,admin
40 47 passwords = abcdef
41 48  
... ... @@ -44,3 +51,22 @@ passwords = abcdef
44 51 A ApiClient object then can be instantiated by providing the right context filename.
45 52 This will then need to be used to get access to all Cmis and PublicApi utilities.
46 53  
  54 +## Maven dependencies
  55 +Use the following maven dependencies
  56 +<dependency>
  57 + <groupId>org.alfresco.test</groupId>
  58 + <artifactId>alfresco-api-test-utils</artifactId>
  59 + <version>${alfresco.api.utils.version}</version>
  60 +</dependency>
  61 +
  62 +## To use these utilities: Following Spring beans that can be added to your spring context files:
  63 + <bean id="httpClientProvider"
  64 + class="org.alfresco.rest.api.tests.client.SharedHttpClientProvider">
  65 + <constructor-arg name="alfrescoUrl" value="${share.target}" />
  66 + <constructor-arg name="maxNumberOfConnections" value="2" />
  67 + </bean>
  68 + <bean id="api" class="org.alfresco.test.utils.api.AlfrescoApiProperties">
  69 + <constructor-arg name="apiUrl" value="${api.url}" />
  70 + <constructor-arg name="apiPort" value="${api.port}" />
  71 + <constructor-arg name="apiVersion" value="${api.version}" />
  72 + </bean>
47 73 \ No newline at end of file
... ...