NOTE: this document is work in progress...

This document describes testing/dev environment for hivemind. Testing environment consist of:

• Dockerized hived node as a block source.
• Local postgresql database as hivemind data storage.
• Local hivemind installation.

Preparing testing environment

1. Create directory in which you will store your testing environment, for simplicity I'll use /tmp
2. In this solution we will be using hived docker image as a source of block data for hivemind
3. If you don't like docker "because of reasons" you can use this howto instead

Preparing hived node

1. Download required files and place them in directory with your testing environment

• dot_env and save as .env
• block_log and save as block_log

2. Edit .env and substitute <path_to_your_data_dir> with correct path

3. Clone latest sources of the hivemind

$ cd /tmp #note this should be your testing environment directory
$ git clone git@gitlab.syncad.com:hive/hivemind.git
$ cd hivemind
$ git checkout develop
$ git submodule update --init --recursive

5. Move .env file to hivemind directory

6. Build and run hived docker image

$ docker-compose -f docker-compose-ci.yml up -d hived-node

7. You can inspect image status with

$ docker-compose -f docker-compose-ci.yml logs hived-node

8. Wait for hived node to finish replay

hived-node_1      | 1893033ms transaction_status_plugin.cpp:331 plugin_startup       ] transaction_status: plugin_startup() end
hived-node_1      | 1893033ms webserver_plugin.cpp:231      operator()           ] start listening for http requests

Preparing postgresql database

1. Install postgresql package
2. Configure and run postgresql
3. Create user and database to hold hivemind data (i.e. user hive database hive)

Preparing hivemind

1. Build and install your hivemind

$ python3 setup.py build
$ python3 setup.py install --user

2. Sync your hivemind service with running hived node

$ time hive sync --steemd-url '{"default":"http://127.0.0.1:8090"}' --database-url postgresql://hive@localhost:5432/hive --test-max-block 5000017 --exit-after-sync --mock-block-data-path mock_data/block_data/follow_op/mock_block_data_follow.json 2>&1 | tee -i hivemind-sync.log

3. After sync is done run hivemind server

$ hive server --steemd-url '{"default":"http://127.0.0.1:8090"}' --database-url postgresql://hive@localhost:5432/hive

4. Leave hivemind server working

Running tavern tests

Tavern tests are located in <hivemind-src>/tests/tests_api/hivemind/tavern directory. It is a set of yaml files with accompanying pat.json files. Test is defined in yaml file, its expected result is defined in pat.json file. Call with parameters defined in yaml file is made to hivemind instance, and the result is compared with pat.json. Test fails when differences between pattern and response is detected. In that case an out.json file is created for manual inspection by the user.

To run tavern tests enter hivemind source directory and run tests using run_tests.sh script

$ cd /tmp/hivemind
$ scripts/run_tests.sh 127.0.0.1 8080

Where 127.0.0.1 is hivemind instance IP, and 8080 is hivemind instance port.

Running benchmarks

Benchmarks are based on requests defined in tavern test yaml files. Each request is called n times, execution times are gathered and then basend on that data the mean/min/max values are calculated. The benchmak test produce tavern_benchmarks_report.html with summary. In this summary calls with execution time greater than 1s are marked in red.

To run benchmarks enter hivemind source directory and run benchmarks using ci_start_api_benchmarks.sh script

$ cd /tmp/hivemind
$ scripts/ci_start_api_benchmarks.sh 127.0.0.1 8080 5

Where 127.0.0.1 is hivemind instance IP, and 8080 is hivemind instance port. 5 is the number of iterations for benchmarks.