DOC: A bit of README and some changes to pycaosdb.ini.template

README.md

@@ -9,6 +9,7 @@ CaosDB project.
 
 - To run tests, start up a CaosDB server with (documentation for this can be found elsewhere).
   - The CaosDB server must have debugging enabled.
+  - The database should be empty.
   - Certificates must be valid and be listed in `pycaosdb.ini`.
 - Modify `pycaosdb.ini.template` accordingly and save it as `pycaosdb.ini`.
 - Run the tests with `pytest` or `pytest-3` (depending on your system).
@@ -31,7 +32,8 @@ project](https://gitlab.com/caosdb/caosdb) for more information.
 
 Copyright (C) 2018 Research Group Biomedical Physics, Max Planck Institute for
 Dynamics and Self-Organization Göttingen.
+Copyright (C) 2021 Indiscale GmbH <info@indiscale.com>
 
-All files in this repository are licensed under a [GNU Affero General Public
+All files in this repository are licensed under the [GNU Affero General Public
 License](LICENCE.md) (version 3 or later).
 

pycaosdb.ini.template

 # -*- mode:conf; -*-
-## This sections needs to exist in addition to the usual section
+
+## This sections must exist in addition to the usual section.
 [IntegrationTests]
-test_server_side_scripting.bin_dir.local=/path/to/scripting/bin
-test_server_side_scripting.bin_dir.server=/opt/caosdb/git/caosdb-server/scritping/bin
+########## Server-side scripting ##################
+# test_server_side_scripting.bin_dir.local=/path/to/scripting/bin
+# test_server_side_scripting.bin_dir.server=/opt/caosdb/git/caosdb-server/scripting/bin
+
+########## Files ##################
+# # 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
+# test_files.test_insert_files_in_dir.server=/opt/caosdb/mnt/extroot/test_insert_files_in_dir/
 
-# 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
-test_files.test_insert_files_in_dir.server=/opt/caosdb/mnt/extroot/test_insert_files_in_dir/
+########## Authentication tokens ##################
+# # location of the one-time tokens from the pyinttest's perspective
+# test_authentication.admin_token_crud = /authtoken/admin_token_crud.txt
+# test_authentication.admin_token_expired = /authtoken/admin_token_expired.txt
+# test_authentication.admin_token_3_attempts = /authtoken/admin_token_3_attempts.txt
 
-# location of the one-time tokens from the pyinttest's perspective
-test_authentication.admin_token_crud = /authtoken/admin_token_crud.txt
-test_authentication.admin_token_expired = /authtoken/admin_token_expired.txt
-test_authentication.admin_token_3_attempts = /authtoken/admin_token_3_attempts.txt
 
 ## Insert your usual settings here
 [Connection]
 #url=https://caosdb-server:10443/
+
+## Some integration tests will fail without valid credentials.
 #username=admin
+#password_method=plain
+#password=caosdb
+
+## Some integration tests will fail without a valid certificate here.
 #cacert=/path/to/cert/caosdb.cert.pem
 #cacert=/etc/ssl/cert.pem
-#debug=0
 
-#password_method=plain
-#password=caosdb
+#debug=0
 
 #ssl_insecure=True
 #timeout=500