mirror of https://github.com/bitcoin/bitcoin.git synced 2025-11-15 08:31:49 +01:00

Files

MarcoFalke e0bc27a14c Merge #21404 : refactor: Remove MakeUnique<T>()

1a6323bdbe doc: update developer notes for removal of MakeUnique (fanquake)
3ba2840e7e scripted-diff: remove MakeUnique<T>() (fanquake)

Pull request description:

  Since requiring C++17, this is just pointless abstraction. I think we should just "tear the band-aid off" and remove it. Similar to the changes happening in #21366.

  Also, having a comment saying this is deprecated doesn't prevent it's usage in new code. i.e : https://github.com/bitcoin/bitcoin/pull/20946#discussion_r561949731.

  The repository is fairly quiet at the moment, so any potential complaints about having to rebase should be minimal. Might as well get this over and done with.

ACKs for top commit:
  jnewbery:
    utACK 1a6323bdbe
  practicalswift:
    cr ACK 1a6323bdbe: patch looks correct
  ajtowns:
    ACK 1a6323bdbe -- code review only
  glozow:
    ACK 1a6323bdbe looks correct

Tree-SHA512: 4a14b9611b60b9b3026b54d6f5a2dce4c5d9b63a7b93d7de1307512df736503ed84bac66e7b93372c76e3117f49bf9f29cd473d3a47cb41fb2775bc10234736f

2021-03-12 08:34:15 +01:00

data

…

fuzz

Merge #21404 : refactor: Remove MakeUnique<T>()

2021-03-12 08:34:15 +01:00

util

Merge #21404 : refactor: Remove MakeUnique<T>()

2021-03-12 08:34:15 +01:00

addrman_tests.cpp

…

allocator_tests.cpp

scripted-diff: remove MakeUnique<T>()

2021-03-11 13:45:14 +08:00

amount_tests.cpp

…

arith_uint256_tests.cpp

…

base32_tests.cpp

…

base58_tests.cpp

…

base64_tests.cpp

…

bech32_tests.cpp

…

bip32_tests.cpp

…

blockchain_tests.cpp

…

blockencodings_tests.cpp

…

blockfilter_index_tests.cpp

scripted-diff: Invoke CreateNewBlock with chainstate

2021-03-08 15:54:31 -05:00

blockfilter_tests.cpp

…

bloom_tests.cpp

…

bswap_tests.cpp

…

checkqueue_tests.cpp

scripted-diff: remove MakeUnique<T>()

2021-03-11 13:45:14 +08:00

coins_tests.cpp

…

compilerbug_tests.cpp

…

compress_tests.cpp

…

crypto_tests.cpp

…

cuckoocache_tests.cpp

…

dbwrapper_tests.cpp

scripted-diff: remove MakeUnique<T>()

2021-03-11 13:45:14 +08:00

denialofservice_tests.cpp

scripted-diff: remove MakeUnique<T>()

2021-03-11 13:45:14 +08:00

descriptor_tests.cpp

…

flatfile_tests.cpp

…

fs_tests.cpp

…

getarg_tests.cpp

…

hash_tests.cpp

…

interfaces_tests.cpp

…

key_io_tests.cpp

…

key_tests.cpp

…

logging_tests.cpp

…

main.cpp

…

Makefile

…

mempool_tests.cpp

…

merkle_tests.cpp

…

merkleblock_tests.cpp

…

miner_tests.cpp

scripted-diff: Invoke CreateNewBlock with chainstate

2021-03-08 15:54:31 -05:00

multisig_tests.cpp

…

net_tests.cpp

scripted-diff: remove MakeUnique<T>()

2021-03-11 13:45:14 +08:00

netbase_tests.cpp

…

pmt_tests.cpp

…

policy_fee_tests.cpp

…

policyestimator_tests.cpp

…

pow_tests.cpp

…

prevector_tests.cpp

…

raii_event_tests.cpp

…

random_tests.cpp

…

README.md

…

ref_tests.cpp

…

reverselock_tests.cpp

…

rpc_tests.cpp

…

sanity_tests.cpp

…

scheduler_tests.cpp

…

script_p2sh_tests.cpp

…

script_standard_tests.cpp

…

script_tests.cpp

…

scriptnum10.h

…

scriptnum_tests.cpp

…

serialize_tests.cpp

…

settings_tests.cpp

…

sighash_tests.cpp

…

sigopcount_tests.cpp

…

skiplist_tests.cpp

…

sock_tests.cpp

…

streams_tests.cpp

…

sync_tests.cpp

…

system_tests.cpp

…

timedata_tests.cpp

…

torcontrol_tests.cpp

…

transaction_tests.cpp

…

txindex_tests.cpp

…

txrequest_tests.cpp

…

txvalidation_tests.cpp

…

txvalidationcache_tests.cpp

…

uint256_tests.cpp

…

util_tests.cpp

scripted-diff: remove MakeUnique<T>()

2021-03-11 13:45:14 +08:00

util_threadnames_tests.cpp

…

validation_block_tests.cpp

scripted-diff: Invoke CreateNewBlock with chainstate

2021-03-08 15:54:31 -05:00

validation_chainstate_tests.cpp

…

validation_chainstatemanager_tests.cpp

…

validation_flush_tests.cpp

…

validation_tests.cpp

…

validationinterface_tests.cpp

…

versionbits_tests.cpp

…

README.md

Unit tests

The sources in this directory are unit test cases. Boost includes a unit testing framework, and since Bitcoin Core already uses Boost, it makes sense to simply use this framework rather than require developers to configure some other framework (we want as few impediments to creating unit tests as possible).

The build system is set up to compile an executable called test_bitcoin that runs all of the unit tests. The main source file for the test library is found in util/setup_common.cpp.

Compiling/running unit tests

Unit tests will be automatically compiled if dependencies were met in ./configure and tests weren't explicitly disabled.

After configuring, they can be run with make check.

To run the unit tests manually, launch src/test/test_bitcoin. To recompile after a test file was modified, run make and then run the test again. If you modify a non-test file, use make -C src/test to recompile only what's needed to run the unit tests.

To add more unit tests, add BOOST_AUTO_TEST_CASE functions to the existing .cpp files in the test/ directory or add new .cpp files that implement new BOOST_AUTO_TEST_SUITE sections.

To run the GUI unit tests manually, launch src/qt/test/test_bitcoin-qt

To add more GUI unit tests, add them to the src/qt/test/ directory and the src/qt/test/test_main.cpp file.

Running individual tests

test_bitcoin has some built-in command-line arguments; for example, to run just the getarg_tests verbosely:

test_bitcoin --log_level=all --run_test=getarg_tests -- DEBUG_LOG_OUT

log_level controls the verbosity of the test framework, which logs when a test case is entered, for example. The DEBUG_LOG_OUT after the two dashes redirects the debug log, which would normally go to a file in the test datadir (BasicTestingSetup::m_path_root), to the standard terminal output.

... or to run just the doubledash test:

test_bitcoin --run_test=getarg_tests/doubledash

Run test_bitcoin --help for the full list.

Adding test cases

To add a new unit test file to our test suite you need to add the file to src/Makefile.test.include. The pattern is to create one test file for each class or source file for which you want to create unit tests. The file naming convention is <source_filename>_tests.cpp and such files should wrap their tests in a test suite called <source_filename>_tests. For an example of this pattern, see uint256_tests.cpp.

Logging and debugging in unit tests

make check will write to a log file foo_tests.cpp.log and display this file on failure. For running individual tests verbosely, refer to the section above.

To write to logs from unit tests you need to use specific message methods provided by Boost. The simplest is BOOST_TEST_MESSAGE.

For debugging you can launch the test_bitcoin executable with gdbor lldb and start debugging, just like you would with any other program:

gdb src/test/test_bitcoin