diff --git a/README.md b/README.md index bae894dcece2c90817b6230fb341788ac9d0a907..3a188090cc7da41db610d11b9f7b6741bc64a3cc 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,13 @@ CaosDB project. # Getting started # -- To run tests, start up a CaosDB server with (documentation for this can be found elsewhere). +- To run tests, start up a CaosDB server with the following properties (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`. +- Modify `pycaosdb.ini.template` and save it as `pycaosdb.ini`, taking care of the following points: + - Certificates must be valid and be specified in `pycaosdb.ini`. + - Server-side scripting paths must be given, otherwise server-side scripting will be omitted. - 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 da9a124af92bb46f1f3bff36d21986b0b4ceed37..c94af17ae01408f9d7f24473ce36ce738c75331d 100644 --- a/pycaosdb.ini.template +++ b/pycaosdb.ini.template @@ -3,14 +3,28 @@ ## This sections must exist in addition to the usual section. [IntegrationTests] ########## 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 +## These are used by tests of server side scripting. Both paths have +## to point to existing directories in which the CaosDB server has the +## permissions to create and execute scripts. + +# location of the scripting bin dir which is used for the test scripts from the +# pyinttest's perspective. +#test_server_side_scripting.bin_dir.local=/path/to/scripting/bin + +# location of the scripting bin dir which is used for the test scripts from the +# server's perspective. +#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/ +## Used by tests of file handling. Specify the path to an existing +## directory in which file tests are performed, once as seen by the +## host and once as seen by the server. + +# location of the files from the pyinttest (i.e. host) perspective +#test_files.test_insert_files_in_dir.local=/extroot/test_insert_files_in_dir/ + +# location of the files from the caosdb server's 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 @@ -28,11 +42,10 @@ #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 +## Provide SSL certificate used by the CaosDB server for all tests to +## run. Some integration tests will fail without a valid certificate here. +#cacert=/path/to/cert.pem #debug=0 - #ssl_insecure=True #timeout=500