From 0120b8070628338da7a794799796df3bd4824ae8 Mon Sep 17 00:00:00 2001
From: Artur Neumann <artur@jankaritech.com>
Date: Wed, 5 Feb 2020 11:23:29 +0545
Subject: [PATCH] documentation about running oC10 API tests

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)

diff --git a/README.md b/README.md
index df415e860..ff6a3153c 100644
--- a/README.md
+++ b/README.md
@@ -67,6 +67,61 @@ richard:superfluidity
 
 For details on the `json` and `ldap` backends see the [documentation](https://owncloud.github.io/ocis-reva/#users)
 
+## Run oC10 API acceptance tests
+1.  start an LDAP server e.g. with docker:
+    ```
+    docker run --hostname ldap.my-company.com \
+        -e LDAP_TLS_VERIFY_CLIENT=never \
+        -e LDAP_DOMAIN=owncloud.com \
+        -e LDAP_ORGANISATION=ownCloud \
+        -e LDAP_ADMIN_PASSWORD=admin \
+        --name docker-slapd \
+        -p 127.0.0.1:389:389 \
+        -p 636:636 -d osixia/openldap
+    ```
+
+2.  clone oC10 code: `git clone https://github.com/owncloud/core.git`
+
+3.  start reva with `REVA_USERS_DRIVER=ldap`:
+    ```
+    bin/ocis-reva gateway & \
+    REVA_USERS_DRIVER=ldap bin/ocis-reva users & \
+    REVA_USERS_DRIVER=ldap bin/ocis-reva auth-basic & \
+    bin/ocis-reva auth-bearer & \
+    bin/ocis-reva sharing & \
+    bin/ocis-reva storage-root & \
+    REVA_STORAGE_HOME_EXPOSE_DATA_SERVER=1 bin/ocis-reva storage-home & \
+    bin/ocis-reva storage-home-data & \
+    REVA_STORAGE_OC_EXPOSE_DATA_SERVER=1 bin/ocis-reva storage-oc & \
+    bin/ocis-reva storage-oc-data & \
+    bin/ocis-reva frontend
+    ```
+
+4.  from inside the oC10 repo run the tests:
+    ```
+    make test-acceptance-api \
+        TEST_SERVER_URL=http://localhost:9140 \
+        TEST_EXTERNAL_USER_BACKENDS=true \
+        TEST_OCIS=true \
+        OCIS_REVA_DATA_ROOT=/var/tmp/reva/ \
+        BEHAT_FILTER_TAGS='~@skipOnOcis&&@TestAlsoOnExternalUserBackend&&~@skipOnLDAP'
+    ```
+
+    Make sure to adjust the settings `TEST_SERVER_URL` and `OCIS_REVA_DATA_ROOT` according to your environment
+
+    This will run all tests that can work with LDAP and are not skipped on OCIS
+    To run a subset of tests, e.g. a single suite, file or tag have a look at the [acceptance tests documentation](https://doc.owncloud.com/server/10.0/developer_manual/core/acceptance-tests.html#running-acceptance-tests-for-a-suite).
+    E.g. you can run all tests that are marked with a specific issue:
+    ```
+    make test-acceptance-api \
+        TEST_SERVER_URL=http://localhost:9140 \
+        TEST_EXTERNAL_USER_BACKENDS=true \
+        TEST_OCIS=true \
+        OCIS_REVA_DATA_ROOT=/var/tmp/reva/ \
+        BEHAT_FILTER_TAGS='@TestAlsoOnExternalUserBackend&&~@skipOnLDAP&&@issue-ocis-reva-46'
+    ```
+
+    Note that the `~@skipOnOcis` tag is removed here, because to fix an issue you want also to run the tests that are skipped in the CI run
 
 ## Security