diff options
| author | MarcoFalke <falke.marco@gmail.com> | 2018-04-01 18:28:14 -0400 |
|---|---|---|
| committer | MarcoFalke <falke.marco@gmail.com> | 2018-04-01 18:28:22 -0400 |
| commit | 9beded58606606b00e70ae76020ac433569b901e (patch) | |
| tree | bd1c20a260e57c6ab84943f33b1e1ebfa609aac4 /doc/developer-notes.md | |
| parent | fa5825d610e92ea0f8abe509516f03ad59e824f3 (diff) | |
| parent | db983beba6fec910722bacc0d67c7ae98ba566fa (diff) | |
Merge #12719: tests: Add note about test suite naming convention in developer-notes.md
db983beba6 tests: Add lint-tests.sh which checks the test suite naming convention (practicalswift)
5fd864fe8a tests: Rename test suits not following the test suite naming convention (practicalswift)
7b4a296a71 tests: Add note about test suite naming convention (practicalswift)
Pull request description:
Changes:
* Add note about test suite naming convention
* Fix exceptions
* Add regression test
Rationale:
* Consistent naming of test suites makes programmatic test running of specific tests/subsets of tests easier
* Explicit is better than implicit
Before this commit:
```
$ contrib/devtools/lint-tests.sh
The test suite in file src/test/foo_tests.cpp should be named
"foo_tests". Please make sure the following test suites follow
that convention:
src/test/blockchain_tests.cpp:BOOST_FIXTURE_TEST_SUITE(blockchain_difficulty_tests, BasicTestingSetup)
src/test/prevector_tests.cpp:BOOST_FIXTURE_TEST_SUITE(PrevectorTests, TestingSetup)
src/wallet/test/coinselector_tests.cpp:BOOST_FIXTURE_TEST_SUITE(coin_selection_tests, WalletTestingSetup)
src/wallet/test/crypto_tests.cpp:BOOST_FIXTURE_TEST_SUITE(wallet_crypto, BasicTestingSetup)
$
```
After this commit:
```
$ contrib/devtools/lint-tests.sh
$
```
Tree-SHA512: 7258ab9a6b9b8fc1939efadc619e2f2f02cfce8034c7f2e5dc5ecc769aa12e17f6fb8e363817feaf15c026c5b958b2574525b8d2d3f6be69658679bf8ceea9e9
Diffstat (limited to 'doc/developer-notes.md')
| -rw-r--r-- | doc/developer-notes.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 0de1892200..7a033b28d4 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -71,6 +71,8 @@ code. - Constant names are all uppercase, and use `_` to separate words. - Class names, function names and method names are UpperCamelCase (PascalCase). Do not prefix class names with `C`. + - Test suite naming convention: The Boost test suite in file + `src/test/foo_tests.cpp` should be named `foo_tests`. - **Miscellaneous** - `++i` is preferred over `i++`. |