From 3e3d405cef7ac02f12826b826dacf35ab5133337 Mon Sep 17 00:00:00 2001
From: fspreck <f.spreckelsen@indiscale.com>
Date: Thu, 2 Jul 2020 17:06:08 +0200
Subject: [PATCH] DOC: Further explain the setup incl. pycaosdb.ini

---
 README.md             | 10 ++++++----
 pycaosdb.ini.template |  7 ++++++-
 2 files changed, 12 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 390cd85..2916550 100644
--- a/README.md
+++ b/README.md
@@ -7,10 +7,12 @@ CaosDB project.
 
 # Getting started #
 
-To run tests, start up a CaosDB server (documentation for this can be found
-elsewhere). Then modify `pycaosdb.ini.template` accordingly and save it as
-`pycaosdb.ini`.  Then you can run the tests with `pytest` or `pytest-3`
-(depending on your system).
+To run tests, start up a CaosDB server in debug mode (documentation
+for this can be found elsewhere). Then modify `pycaosdb.ini.template`
+accordingly and save it as `pycaosdb.ini` specifying the paths for
+server side scripting and file tests. Specify the SSL certificate used
+by your CaosDB server in `pycaosdb.ini`, too. Then you can run the
+tests with `pytest` or `pytest-3` (depending on your system).
 
 If you want to run just a single test, you can also select a single test file:
 `pytest-3 tests/test_issues.py`
diff --git a/pycaosdb.ini.template b/pycaosdb.ini.template
index 8f1d9d4..ea575dd 100644
--- a/pycaosdb.ini.template
+++ b/pycaosdb.ini.template
@@ -1,8 +1,14 @@
 # -*- mode:conf; -*-
 ## This sections needs to exist in addition to the usual section
 [IntegrationTests]
+## Both paths have to point to existing directories in which the
+## CaosDB server can create an execute scripts (needed for tests of
+## server side scripting).
 test_server_side_scripting.bin_dir=/scripting-bin/
+test_server_side_scripting.home_dir=/scripting-home/
 
+## For tests of file handling, specify an existing directory once as
+## seen on the host machine and once as seen by the CaosDB server.
 # location of the files from the pyinttest perspective
 test_files.test_insert_files_in_dir.local=/extroot/test_insert_files_in_dir/
 # location of the files from the caosdb_servers perspective
@@ -14,7 +20,6 @@ test_files.test_insert_files_in_dir.server=/opt/caosdb/mnt/extroot/test_insert_f
 #url=https://caosdb-server:10443/
 #username=admin
 #cacert=/cert/caosdb.cert.pem
-#cacert=/etc/ssl/cert.pem
 #debug=0
 
 #passwordmethod=plain
-- 
GitLab