This directory contains integration tests that test syscoind and its

utilities in their entirety. It does not contain unit tests, which

can be found in [/src/test](/src/test), [/src/wallet/test](/src/wallet/test),

etc.

There are currently two sets of tests in this directory:

- [functional](/test/functional) which test the functionality of

syscoind and syscoin-qt by interacting with them through the RPC and P2P

interfaces.

- [util](/test/util) which tests the syscoin utilities, currently only

syscoin-tx.

The util tests are run as part of `make check` target. The functional

tests are run by the travis continuous build process whenever a pull

request is opened. Both sets of tests can also be run locally.

Build for your system first. Be sure to enable wallet, utils and daemon when you configure. Tests will not run otherwise.

The ZMQ functional test requires a python ZMQ library. To install it:

- on Unix, run `sudo apt-get install python3-zmq`

- on mac OS, run `pip3 install pyzmq`

Individual tests can be run by directly calling the test script, eg:

or can be run through the test_runner harness, eg:

You can run any combination (incl. duplicates) of tests by calling:

Run the regression test suite with:

Run all possible tests with

By default, up to 4 tests will be run in parallel by test_runner. To specify

how many jobs to run, append `--jobs=n`

The individual tests and the test_runner harness have many command-line

options. Run `test_runner.py -h` to see them all.

The P2P and RPC ports used by the syscoind nodes-under-test are chosen to make

conflicts with other processes unlikely. However, if there is another syscoind

process running on the system (perhaps from a previous test which hasn't successfully

killed all its syscoind nodes), then there may be a port conflict which will

cause the test to fail. It is recommended that you run the tests on a system

where no other syscoind processes are running.

On linux, the test_framework will warn if there is another

syscoind process running when the tests are started.

If there are zombie syscoind processes after test failure, you can kill them

by running the following commands. **Note that these commands will kill all

syscoind processes running on the system, so should not be used if any non-test

syscoind processes are being run.**

killall syscoind

or

pkill -9 syscoind

A pre-mined blockchain with 200 blocks is generated the first time a

functional test is run and is stored in test/cache. This speeds up

test startup times since new blockchains don't need to be generated for

each test. However, the cache may get into a bad state, in which case

tests will fail. If this happens, remove the cache directory (and make

sure syscoind processes are stopped as above):

rm -rf cache

killall syscoind

The tests contain logging at different levels (debug, info, warning, etc). By

default:

- when run through the test_runner harness, *all* logs are written to

`test_framework.log` and no logs are output to the console.

- when run directly, *all* logs are written to `test_framework.log` and INFO

level and above are output to the console.

- when run on Travis, no logs are output to the console. However, if a test

fails, the `test_framework.log` and syscoind `debug.log`s will all be dumped

to the console to help troubleshooting.

To change the level of logs output to the console, use the `-l` command line

argument.

`test_framework.log` and syscoind `debug.log`s can be combined into a single

aggregate log by running the `combine_logs.py` script. The output can be plain

text, colorized text or html. For example:

will pipe the colorized logs from the test into less.

Use `--tracerpc` to trace out all the RPC calls and responses to the console. For

some tests (eg any that use `submitblock` to submit a full block over RPC),

this can result in a lot of screen output.

By default, the test data directory will be deleted after a successful run.

Use `--nocleanup` to leave the test data directory intact. The test data

directory is never deleted after a failed test.

A python debugger can be attached to tests at any point. Just add the line:

import pdb; pdb.set_trace()

anywhere in the test. You will then be able to inspect variables, as well as

call methods that interact with the syscoind nodes-under-test.

If further introspection of the syscoind instances themselves becomes

necessary, this can be accomplished by first setting a pdb breakpoint

at an appropriate location, running the test to that point, then using

`gdb` to attach to the process and debug.

For instance, to attach to `self.node[1]` during a run:

2017-06-27 14:13:56.686000 TestFramework (INFO): Initializing test directory /tmp/user/1000/testo9vsdjo3

use the directory path to get the pid from the pid file:

cat /tmp/user/1000/testo9vsdjo3/node1/regtest/syscoind.pid

gdb /home/example/syscoind <pid>

Note: gdb attach step may require `sudo`

Util tests can be run locally by running `test/util/syscoin-util-test.py`.

Use the `-v` option for verbose output.

You are encouraged to write functional tests for new or existing features.

Further information about the functional test framework and individual

tests is found in [test/functional](/test/functional).

# Copyright (c) 2013-2016 The Syscoin Core developers

# Distributed under the MIT software license, see the accompanying

# file COPYING or http://www.opensource.org/licenses/mit-license.php.

# These environment variables are set by the build process and read by

# test/functional/test_runner.py and test/util/syscoin-util-test.py

[environment]

SRCDIR=@abs_top_srcdir@

BUILDDIR=@abs_top_builddir@

EXEEXT=@EXEEXT@

RPCAUTH=@abs_top_srcdir@/share/rpcauth/rpcauth.py

[components]

# Which components are enabled. These are commented out by `configure` if they were disabled when running config.

@ENABLE_WALLET_TRUE@ENABLE_WALLET=true

@BUILD_SYSCOIN_UTILS_TRUE@ENABLE_UTILS=true

@BUILD_SYSCOIND_TRUE@ENABLE_SYSCOIND=true

@ENABLE_ZMQ_TRUE@ENABLE_ZMQ=true

The [example_test.py](example_test.py) is a heavily commented example of a test case that uses both

the RPC and P2P interfaces. If you are writing your first test, copy that file

and modify to fit your needs.

Running `test_runner.py` with the `--coverage` argument tracks which RPCs are

called by the tests and prints a report of uncovered RPCs in the summary. This

can be used (along with the `--extended` argument) to find out which RPCs we

don't have test cases for.

- Where possible, try to adhere to [PEP-8 guidelines](https://www.python.org/dev/peps/pep-0008/)

- Use a python linter like flake8 before submitting PRs to catch common style

nits (eg trailing whitespace, unused imports, etc)

- Avoid wildcard imports where possible

- Use a module-level docstring to describe what the test is testing, and how it

is testing it.

- When subclassing the SyscoinTestFramwork, place overrides for the

`set_test_params()`, `add_options()` and `setup_xxxx()` methods at the top of

the subclass, then locally-defined helper methods, then the `run_test()` method.

- Name the test `<area>_test.py`, where area can be one of the following:

- `feature` for tests for full features that aren't wallet/mining/mempool, eg `feature_rbf.py`

- `interface` for tests for other interfaces (REST, ZMQ, etc), eg `interface_rest.py`

- `mempool` for tests for mempool behaviour, eg `mempool_reorg.py`

- `mining` for tests for mining features, eg `mining_prioritisetransaction.py`

- `p2p` for tests that explicitly test the p2p interface, eg `p2p_disconnect_ban.py`

- `rpc` for tests for individual RPC methods or features, eg `rpc_listtransactions.py`

- `wallet` for tests for wallet features, eg `wallet_keypool.py`

- use an underscore to separate words

- exception: for tests for specific RPCs or command line options which don't include underscores, name the test after the exact RPC or argument name, eg `rpc_decodescript.py`, not `rpc_decode_script.py`

- Don't use the redundant word `test` in the name, eg `interface_zmq.py`, not `interface_zmq_test.py`

- Set `self.num_nodes` to the minimum number of nodes necessary for the test.

Having additional unrequired nodes adds to the execution time of the test as

well as memory/CPU/disk requirements (which is important when running tests in

parallel or on Travis).

- Avoid stop-starting the nodes multiple times during the test if possible. A

stop-start takes several seconds, so doing it several times blows up the

runtime of the test.

- Set the `self.setup_clean_chain` variable in `set_test_params()` to control whether

or not to use the cached data directories. The cached data directories

contain a 200-block pre-mined blockchain and wallets for four nodes. Each node

has 25 mature blocks (25x50=1250 BTC) in its wallet.

- When calling RPCs with lots of arguments, consider using named keyword

arguments instead of positional arguments to make the intent of the call

clear to readers.

Test writers may find it helpful to refer to the definitions for the RPC and

P2P messages. These can be found in the following source files:

- `/src/rpc/*` for RPCs

- `/src/wallet/rpc*` for wallet RPCs

- `ProcessMessage()` in `/src/net_processing.cpp` for parsing P2P messages

- `mininode.py` contains all the definitions for objects that pass

over the network (`CBlock`, `CTransaction`, etc, along with the network-level

wrappers for them, `msg_block`, `msg_tx`, etc).

- P2P tests have two threads. One thread handles all network communication

with the syscoind(s) being tested (using python's asyncore package); the other

implements the test logic.

- `P2PConnection` is the class used to connect to a syscoind. `P2PInterface`

contains the higher level logic for processing P2P payloads and connecting to

the Syscoin Core node application logic. For custom behaviour, subclass the

P2PInterface object and override the callback methods.

- Call `network_thread_start()` after all `P2PInterface` objects are created to

start the networking thread. (Continue with the test logic in your existing

thread.)

- Can be used to write tests where specific P2P protocol behavior is tested.

Examples tests are `p2p_unrequested_blocks.py`, `p2p_compactblocks.py`.

Taken from the [python-syscoinrpc repository](https://github.com/jgarzik/python-syscoinrpc).

Base class for functional tests.

Generally useful functions.

Basic code to support P2P connectivity to a syscoind.

Utilities for manipulating transaction scripts (originally from python-syscoinlib)

Wrapper around OpenSSL EC_Key (originally from python-syscoinlib)

Helpers for script.py

Helper functions for creating blocks and transactions.