mirror of https://github.com/monero-project/monero.git synced 2024-10-01 11:49:47 -04:00

History

moneroexamples ec68cf822f Make get_output_key method const get_output_key method is commonly used when working with txs and their key images. Because the method is not const, passing blockchain object though const& or pointers to const is not possible in this context. This is especially problematic in external projects (e.g., projects in moneroexamples) that use monero C++ api to operate on the blockchain and txs. Thus, having get_output_key method will simplify moving blockchain object around through const references and pointers to const objects.		2019-01-07 05:53:14 +08:00
..
core_proxy	protocol: option to pad transaction relay to the next kB	2018-11-06 15:47:05 +00:00
core_tests	remove some unused code	2018-11-23 15:37:36 +00:00
crypto	Merge pull request #4489	2018-10-15 13:37:18 +02:00
daemon_tests	Update 2018 copyright	2018-01-26 10:03:20 -05:00
data	wallet2: only export necessary outputs and key images	2018-11-04 22:27:01 +00:00
difficulty	Fix missing std::runtime_error def in difficulty.cpp	2018-09-16 19:35:07 +00:00
functional_tests	Fix Windows build after epee dependency change	2018-10-15 23:08:17 +00:00
fuzz	wallet2: only export necessary outputs and key images	2018-11-04 22:27:01 +00:00
gtest	gtest: use -fPIC with CLANG too	2018-06-28 16:42:52 +01:00
hash	cryptonote tweak v2.2	2018-09-22 03:47:50 +00:00
libwallet_api_tests	libwallet_api_tests: add missing dependency on Boost Locale and ICU	2018-11-15 00:19:41 +09:00
net_load_tests	Removed a lot of unnecessary includes	2018-11-15 17:29:34 +01:00
performance_tests	Merge pull request #4795	2018-11-16 11:11:10 +02:00
unit_tests	Make get_output_key method const	2019-01-07 05:53:14 +08:00
CMakeLists.txt	Update 2018 copyright	2018-01-26 10:03:20 -05:00
cryptolib.pl	Update 2018 copyright	2018-01-26 10:03:20 -05:00
cryptotest.pl	Update 2018 copyright	2018-01-26 10:03:20 -05:00
hash-target.cpp	Update 2018 copyright	2018-01-26 10:03:20 -05:00
io.h	Update 2018 copyright	2018-01-26 10:03:20 -05:00
README.md	first new functional tests	2018-06-29 10:06:22 +02: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
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

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]