History

xmr-eric 18216f19dd Update 2018 copyright		2018-01-26 10:03:20 -05:00
..
core_proxy	Update 2018 copyright	2018-01-26 10:03:20 -05:00
core_tests	Update 2018 copyright	2018-01-26 10:03:20 -05:00
crypto	Update 2018 copyright	2018-01-26 10:03:20 -05:00
daemon_tests	Update 2018 copyright	2018-01-26 10:03:20 -05:00
data	tests: add levin fuzz test	2017-12-23 11:29:55 +00:00
difficulty	Update 2018 copyright	2018-01-26 10:03:20 -05:00
functional_tests	Update 2018 copyright	2018-01-26 10:03:20 -05:00
fuzz	Update 2018 copyright	2018-01-26 10:03:20 -05:00
gtest	Add misc hardening flags to the cmake machinery	2017-12-31 14:26:12 +00:00
hash	Update 2018 copyright	2018-01-26 10:03:20 -05:00
libwallet_api_tests	Update 2018 copyright	2018-01-26 10:03:20 -05:00
net_load_tests	Update 2018 copyright	2018-01-26 10:03:20 -05:00
performance_tests	Update 2018 copyright	2018-01-26 10:03:20 -05:00
unit_tests	Update 2018 copyright	2018-01-26 10:03:20 -05:00
CMakeLists.txt	Update 2018 copyright	2018-01-26 10:03:20 -05:00
README.md	Edited test readme for accuracy and depth	2017-10-01 12:11:59 -06: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

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]

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]