oxen-core/tests
Jason Rhinelander 1127ac51fd Remove BUILD_GUI_DEPS, enable FORCE_USE_HEAP on android
BUILD_GUI_DEPS was dumb: it should have just been a non-"all" target (as
it is now) that can be explicitly built, rather than misusing a cmake
option.

It was doing one useful thing, however, of turning on FORCE_USE_HEAP --
but that was wrong too, because that needs to be enabled when doing an
android build (and probably IOS as well).
2020-11-04 12:11:20 -04:00
..
block_weight Make tests use Python 3 consistently 2020-06-09 23:06:54 -03:00
core_proxy Move epee includes under "epee/..." 2020-10-24 12:46:27 -03:00
core_tests Move epee includes under "epee/..." 2020-10-24 12:46:27 -03:00
crypto Move epee includes under "epee/..." 2020-10-24 12:46:27 -03:00
daemon_tests Move epee includes under "epee/..." 2020-10-24 12:46:27 -03:00
data Merge commit '8534f71' into LokiMergeUpstream 2018-11-12 14:55:42 +11:00
difficulty Move epee includes under "epee/..." 2020-10-24 12:46:27 -03:00
functional_tests Move epee includes under "epee/..." 2020-10-24 12:46:27 -03:00
fuzz Move epee includes under "epee/..." 2020-10-24 12:46:27 -03:00
gtest Merge commit 'e8487fa' into LokiMergeUpstream 2019-05-17 04:39:08 +10:00
hash Move epee includes under "epee/..." 2020-10-24 12:46:27 -03:00
libwallet_api_tests Rename wallet api namespace Monero:: -> Wallet:: 2020-10-24 12:46:26 -03:00
net_load_tests Move epee includes under "epee/..." 2020-10-24 12:46:27 -03:00
network_tests Make tests use Python 3 consistently 2020-06-09 23:06:54 -03:00
performance_tests Move epee includes under "epee/..." 2020-10-24 12:46:27 -03:00
trezor Move epee includes under "epee/..." 2020-10-24 12:46:27 -03:00
unit_tests Move epee includes under "epee/..." 2020-10-24 12:46:27 -03:00
CMakeLists.txt Remove BUILD_GUI_DEPS, enable FORCE_USE_HEAP on android 2020-11-04 12:11:20 -04:00
cryptolib.pl Update 2019 copyright 2019-03-05 22:05:34 +01:00
cryptotest.pl Update 2019 copyright 2019-03-05 22:05:34 +01:00
hash-target.cpp Move epee includes under "epee/..." 2020-10-24 12:46:27 -03:00
io.h Misc. C++ modernization 2020-07-02 12:52:12 -03:00
README.md Made code block usage consistent across all .md files 2019-05-12 05:16:26 +01:00

Running all tests

To run all tests, run:

cd /path/to/monero
make [-jn] debug-test # where n is number of compiler processes

To test a release build, replace debug-test with release-test in the previous command.

Core tests

Core tests take longer than any other Monero tests, due to the high amount of computational work involved in validating core components.

Tests are located in tests/core_tests/, and follow a straightforward naming convention. Most cases cover core functionality (block_reward.cpp, chaingen.cpp, rct.cpp, etc.), while some cover basic security tests (double_spend.cpp & integer_overflow.cpp).

To run only Monero's core tests (after building):

cd build/debug/tests/core_tests
ctest

To run the same tests on a release build, replace debug with release.

Crypto Tests

Crypto tests are located under the tests/crypto directory.

  • crypto-tests.h contains test harness headers
  • main.cpp implements the driver for the crypto tests

Tests correspond to components under src/crypto/. A quick comparison reveals the pattern, and new tests should continue the naming convention.

To run only Monero's crypto tests (after building):

cd build/debug/tests/crypto
ctest

To run the same tests on a release build, replace debug with release.

Daemon tests

[TODO]

Functional tests

[TODO] Functional tests are located under the tests/functional directory.

First, run a regtest daemon in the offline mode and with a fixed difficulty:

monerod --regtest --offline --fixed-difficulty 1

Alternatively, you can run multiple daemons and let them connect with each other by using --add-exclusive-node. In this case, make sure that the same fixed difficulty is given to all the daemons.

Next, restore a mainnet wallet with the following seed and restore height 0 (the file path doesn't matter):

velvet lymph giddy number token physics poetry unquoted nibs useful sabotage limits benches lifestyle eden nitrogen anvil fewest avoid batch vials washing fences goat unquoted

Open the wallet file with monero-wallet-rpc with RPC port 18083. Finally, start tests by invoking ./blockchain.py or ./speed.py

Fuzz tests

Fuzz tests are written using American Fuzzy Lop (AFL), and located under the tests/fuzz directory.

An additional helper utility is provided contrib/fuzz_testing/fuzz.sh. AFL must be installed, and some additional setup may be necessary for the script to run properly.

Hash tests

Hash tests exist under tests/hash, and include a set of target hashes in text files.

To run only Monero's hash tests (after building):

cd build/debug/tests/hash
ctest

To run the same tests on a release build, replace debug with release.

Libwallet API tests

[TODO]

Net Load tests

[TODO]

Performance tests

Performance tests are located in tests/performance_tests, and test features for performance metrics on the host machine.

To run only Monero's performance tests (after building):

cd build/debug/tests/performance_tests
./performance_tests

The path may be build/Linux/master/debug (adapt as necessary for your platform).

If the performance_tests binary does not exist, try running make in the build/debug/tests/performance_tests directory.

To run the same tests on a release build, replace debug with release.

Unit tests

Unit tests are defined under the tests/unit_tests directory. Independent components are tested individually to ensure they work properly on their own.

To run only Monero's unit tests (after building):

cd build/debug/tests/unit_tests
ctest

To run the same tests on a release build, replace debug with release.

Writing new tests

Test hygiene

When writing new tests, please implement all functions in .cpp or .c files, and only put function headers in .h files. This will help keep the fairly complex test suites somewhat sane going forward.

Writing fuzz tests

[TODO]