058c9f729f
7a046cdc1423963bdcbcf9bb98560af61fa90b37 tests: Avoid using C-style NUL-terminated strings as arguments (practicalswift)
fefb9165f23fe9d10ad092ec31715f906e0d2ee7 tests: Add tests to make sure lookup methods fail on std::string parameters with embedded NUL characters (practicalswift)
9574de86ad703ad942cdd0eca79f48c0d42b102b net: Avoid using C-style NUL-terminated strings as arguments in the netbase interface (practicalswift)
Pull request description:
Don't allow resolving of `std::string`:s with embedded `NUL` characters.
Avoid using C-style `NUL`-terminated strings as arguments in the `netbase` interface
Add tests.
The only place in where C-style `NUL`-terminated strings are actually needed is here:
```diff
+ if (!ValidAsCString(name)) {
+ return false;
+ }
...
- int nErr = getaddrinfo(pszName, nullptr, &aiHint, &aiRes);
+ int nErr = getaddrinfo(name.c_str(), nullptr, &aiHint, &aiRes);
if (nErr)
return false;
```
Interface changes:
```diff
-bool LookupHost(const char *pszName, std::vector<CNetAddr>& vIP, unsigned int nMaxSolutions, bool fAllowLookup);
+bool LookupHost(const std::string& name, std::vector<CNetAddr>& vIP, unsigned int nMaxSolutions, bool fAllowLookup);
-bool LookupHost(const char *pszName, CNetAddr& addr, bool fAllowLookup);
+bool LookupHost(const std::string& name, CNetAddr& addr, bool fAllowLookup);
-bool Lookup(const char *pszName, CService& addr, int portDefault, bool fAllowLookup);
+bool Lookup(const std::string& name, CService& addr, int portDefault, bool fAllowLookup);
-bool Lookup(const char *pszName, std::vector<CService>& vAddr, int portDefault, bool fAllowLookup, unsigned int nMaxSolutions);
+bool Lookup(const std::string& name, std::vector<CService>& vAddr, int portDefault, bool fAllowLookup, unsigned int nMaxSolutions);
-bool LookupSubNet(const char *pszName, CSubNet& subnet);
+bool LookupSubNet(const std::string& strSubnet, CSubNet& subnet);
-CService LookupNumeric(const char *pszName, int portDefault = 0);
+CService LookupNumeric(const std::string& name, int portDefault = 0);
-bool ConnectThroughProxy(const proxyType &proxy, const std::string& strDest, int port, const SOCKET& hSocketRet, int nTimeout, bool *outProxyConnectionFailed);
+bool ConnectThroughProxy(const proxyType &proxy, const std::string& strDest, int port, const SOCKET& hSocketRet, int nTimeout, bool& outProxyConnectionFailed);
```
It should be noted that the `ConnectThroughProxy` change (from `bool *outProxyConnectionFailed` to `bool& outProxyConnectionFailed`) has nothing to do with `NUL` handling but I thought it was worth doing when touching this file :)
ACKs for top commit:
EthanHeilman:
ACK 7a046cdc1423963bdcbcf9bb98560af61fa90b37
laanwj:
ACK 7a046cdc1423963bdcbcf9bb98560af61fa90b37
Tree-SHA512: 66556e290db996917b54091acd591df221f72230f6b9f6b167b9195ee870ebef6e26f4cda2f6f54d00e1c362e1743bf56785d0de7cae854e6bf7d26f6caccaba
|
||
|---|---|---|
| .. | ||
| data | ||
| fuzz | ||
| util | ||
| addrman_tests.cpp | ||
| allocator_tests.cpp | ||
| amount_tests.cpp | ||
| arith_uint256_tests.cpp | ||
| base32_tests.cpp | ||
| base58_tests.cpp | ||
| base64_tests.cpp | ||
| bech32_tests.cpp | ||
| bip32_tests.cpp | ||
| bip39_tests.cpp | ||
| block_reward_reallocation_tests.cpp | ||
| blockchain_tests.cpp | ||
| blockencodings_tests.cpp | ||
| blockfilter_index_tests.cpp | ||
| blockfilter_tests.cpp | ||
| bloom_tests.cpp | ||
| bls_tests.cpp | ||
| bswap_tests.cpp | ||
| cachemap_tests.cpp | ||
| cachemultimap_tests.cpp | ||
| checkdatasig_tests.cpp | ||
| checkqueue_tests.cpp | ||
| coins_tests.cpp | ||
| compilerbug_tests.cpp | ||
| compress_tests.cpp | ||
| crypto_tests.cpp | ||
| cuckoocache_tests.cpp | ||
| dbwrapper_tests.cpp | ||
| denialofservice_tests.cpp | ||
| descriptor_tests.cpp | ||
| dip0020opcodes_tests.cpp | ||
| dynamic_activation_thresholds_tests.cpp | ||
| evo_deterministicmns_tests.cpp | ||
| evo_instantsend_tests.cpp | ||
| evo_simplifiedmns_tests.cpp | ||
| evo_trivialvalidation.cpp | ||
| evo_utils_tests.cpp | ||
| flatfile_tests.cpp | ||
| fs_tests.cpp | ||
| getarg_tests.cpp | ||
| governance_validators_tests.cpp | ||
| hash_tests.cpp | ||
| key_io_tests.cpp | ||
| key_tests.cpp | ||
| lcg.h | ||
| limitedmap_tests.cpp | ||
| llmq_dkg_tests.cpp | ||
| logging_tests.cpp | ||
| main.cpp | ||
| Makefile | ||
| mempool_tests.cpp | ||
| merkle_tests.cpp | ||
| merkleblock_tests.cpp | ||
| miner_tests.cpp | ||
| multisig_tests.cpp | ||
| net_tests.cpp | ||
| netbase_tests.cpp | ||
| pmt_tests.cpp | ||
| policyestimator_tests.cpp | ||
| pow_tests.cpp | ||
| prevector_tests.cpp | ||
| raii_event_tests.cpp | ||
| random_tests.cpp | ||
| ratecheck_tests.cpp | ||
| README.md | ||
| ref_tests.cpp | ||
| reverselock_tests.cpp | ||
| rpc_tests.cpp | ||
| sanity_tests.cpp | ||
| scheduler_tests.cpp | ||
| script_p2pk_tests.cpp | ||
| script_p2pkh_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 | ||
| specialtx_tests.cpp | ||
| streams_tests.cpp | ||
| subsidy_tests.cpp | ||
| sync_tests.cpp | ||
| timedata_tests.cpp | ||
| torcontrol_tests.cpp | ||
| transaction_tests.cpp | ||
| txindex_tests.cpp | ||
| txvalidation_tests.cpp | ||
| txvalidationcache_tests.cpp | ||
| uint256_tests.cpp | ||
| util_tests.cpp | ||
| util_threadnames_tests.cpp | ||
| util.cpp | ||
| util.h | ||
| validation_block_tests.cpp | ||
| validation_chainstate_tests.cpp | ||
| validation_chainstatemanager_tests.cpp | ||
| validation_flush_tests.cpp | ||
| validation_tests.cpp | ||
| versionbits_tests.cpp | ||
Unit tests
The sources in this directory are unit test cases. Boost includes a unit testing framework, and since Dash 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_dash
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_dash. 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_dash-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_dash has some built-in command-line arguments; for
example, to run just the getarg_tests verbosely:
test_dash --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_dash --run_test=getarg_tests/doubledash
Run test_dash --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_dash executable with gdbor lldb and
start debugging, just like you would with any other program:
gdb src/test/test_dash