Skip to content
Snippets Groups Projects

Readme remote server

Merged Daniel Hornung requested to merge f-readme-remote-server into dev
2 files
+ 62
19
Compare changes
  • Side-by-side
  • Inline

Files

+ 25
4
@@ -7,14 +7,34 @@ CaosDB project.
@@ -7,14 +7,34 @@ CaosDB project.
# Getting started #
# 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 CaosDB server must have debugging enabled.
- Certificates must be valid and be listed in `pycaosdb.ini`.
- The database should be empty.
- 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).
- 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:
- If you want to run just a single test, you can also select a single test file:
`pytest-3 tests/test_issues.py`
`pytest-3 tests/test_issues.py`
 
## Requirements ##
 
 
- Running the tests needs `pytest`, obviously, and also the `nose` library:
 
- `pip3 install pytest nose`
 
 
## Run tests agains a remote caosdb server
 
 
* There is a special mark `local_server`, which marks all test which cannot
 
pass when the server is not on the host where the test suite is running.
 
* Start tests with `pytest -m "not local_server"` or
 
`tox -- -m "not local_server"`.
 
* The remote caosdb server must have a TLS certificate which maches the name given in
 
`pycaosdb.ini`. If you use the *LinkAhead* distribution of CaosDB, this can be achieved by:
 
* `linkahead cert_gen -- --hostname <your hostname>`
 
* `linkahead certs -d <your profile path>/custom/other/cert`
 
* `linkahead start`
 
# Further Reading
# Further Reading
Please refer to the [official gitlab repository of the CaosDB
Please refer to the [official gitlab repository of the CaosDB
@@ -24,7 +44,8 @@ project](https://gitlab.com/caosdb/caosdb) for more information.
@@ -24,7 +44,8 @@ project](https://gitlab.com/caosdb/caosdb) for more information.
Copyright (C) 2018 Research Group Biomedical Physics, Max Planck Institute for
Copyright (C) 2018 Research Group Biomedical Physics, Max Planck Institute for
Dynamics and Self-Organization Göttingen.
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).
License](LICENCE.md) (version 3 or later).
Loading