History

Crypto City 87b2d3e165 we can now build below existing blocks		2019-12-13 01:33:06 +00:00
..
block_weight	foo!	2019-12-13 00:55:07 +00:00
core_proxy	protocol: request txpool contents when synced	2019-12-13 01:31:56 +00:00
core_tests	we can now build below existing blocks	2019-12-13 01:33:06 +00:00
crypto	Merge pull request #5240	2019-03-19 09:48:16 +02:00
daemon_tests	Update 2019 copyright	2019-03-05 22:05:34 +01:00
data	wallet2: only export necessary outputs and key images	2018-11-04 22:27:01 +00:00
difficulty	Merge pull request #5621	2019-07-24 14:36:43 -05:00
functional_tests	tests: fix tests after recent emission changes	2019-12-13 01:33:06 +00:00
fuzz	Add ref-counted buffer byte_slice. Currently used for sending TCP data.	2019-07-16 16:30:35 +00:00
gtest	Made code block usage consistent across all .md files	2019-05-12 05:16:26 +01:00
hash	tests: add a few try/catch in main to shut coverity up	2019-04-03 16:24:09 +00:00
libwallet_api_tests	tests: add a few try/catch in main to shut coverity up	2019-04-03 16:24:09 +00:00
net_load_tests	Update 2019 copyright	2019-03-05 22:05:34 +01:00
performance_tests	transactions can now involved cc accounts (wip)	2019-12-13 01:00:34 +00:00
trezor	Merge pull request #5409	2019-04-16 22:34:30 +02:00
unit_tests	we can now build below existing blocks	2019-12-13 01:33:06 +00:00
CMakeLists.txt	build: debug and test builds via contrib	2019-04-10 15:43:52 +02: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	fix wide difficulty conversion with some versions of boost	2019-05-01 19:58:09 +00:00
io.h	Update 2019 copyright	2019-03-05 22:05:34 +01:00
README.md	Made code block usage consistent across all .md files	2019-05-12 05:16:26 +01:00

README.md

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]