ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2025-12-06 17:27:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove old backend implementation (#662)

Browse Source 
Fixes #661
This commit is contained in:
Alex Kremer
2023-06-01 13:54:49 +01:00
committed by GitHub
parent fc0c93b2ee
commit 7e8569b03a
11 changed files with 714 additions and 5579 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
unittests/README.md
View File

@@ -1,25 +1,13 @@
# Unit Testing
The correctness of new implementations can be verified via running unit tests. Below are the information on how to run unit tests.
## Requirements
### 1. Cassandra cluster
Have access to a **local (127.0.0.1)** Cassandra cluster, opened at port **9042**. Please ensure that the cluster is successfully running before running Unit Tests.
### Cassandra cluster
If you wish to test the backend component you will need to have access to a **local (127.0.0.1)** Cassandra cluster, opened at port **9042**. Please ensure that the cluster is successfully running before running unit tests unless you filter out all `Backend` tests.
## Running
To run the unit tests, first build Clio as normal, then execute `./clio_tests` to run the unit tests.
To run the unit tests, first build Clio as normal, then execute `./clio_tests` to run all unit tests.
## Tests
Below is a list of currently available unit tests. Please keep in mind that this list should be constantly updated with new unit tests as new features are added to the project.
- BackendTest.basic
- Backend.cache
- Backend.cacheBackground
- Backend.cacheIntegration
**Note:** If you don't want to test the Cassandra backend code, the relevant tests can be disabled like this: `./clio_tests --gtest_filter="-BackendCassandraBaseTest*:BackendCassandraTest*"`
# Adding Unit Tests
To add unit tests, append a new test block in the unittests/main.cpp file with the following format:
```cpp
TEST(module_name, test_name)
{
// Test code goes here
}
```
To add unit tests, please create a separate file for the component you are trying to cover (unless it already exists) and use any other existing unit test file as an example.