lib/lib-test: restore DOVECOT_SRAND feature in DEBUG builds Add a deterministic PRNG, an ability to force its use, and an ability to re-use the same sequence later. Since proper random numbers have been forced into use, making reproducable tests isn't quite as easy as it used to be, it's 3 steps rather than 2. When seeing an intermittent test failure: - rerun the tests with environmental variable DOVECOT_SRAND=kiss - upon seeing a new failure case, note the seed logged at the failure - debug using DOVECOT_SRAND=<that number> In non-DEBUG builds, there's no trace of this code, and the randomisation that is an inherent part of many tests remains non-reproduceable. Works with all of the RNG preferences, getrandom/urandom/arc4. Signed-off-by: Phil Carmody <phil@dovecot.fi>

Updated copyright notices to include the year 2018.

lib-test: Add test_expect_fatal_string()

lib-test: Cleanup - Move expected_error_str check to its own function

lib-test: Reset expected errors state at each test.

lib-test: Use i_unreached() for marking unreachable code in test fatal handler This avoids a warning with static analyzer.

lib-test: Suppress expected error messages Unless pattern is also provided

lib-test: Remove rand state dump It's not possible after next commit

Updated copyright notices to include the year 2017.

lib-test: test_run*() - use const for test_functions[] array

lib-test: test_run_named*() - use const for tests[] array

lib-test: Change test_fatal_func_t to take unsigned int stage as parameter. It could never be -1, so this makes it clearer. It also removes annoying casts when comparing stage to e.g. N_ELEMENTS().

lib-test: test_run_with_fatals() now takes a const array

lib-test: Introduce test_fatal_func_t as typedef and comment how it works.

lib-test: Do not init/deinit library twice If lib is initialized, do not initialize or deinitialize library. This is done to allow using master_service in unit tests which also wants to perform lib init and deinit itself.

lib-test: Fixed assert-crash in test_exit() with --enable-static-checker Fixes: Panic: Missing t_pop() call

lib-test: Moved test_istream code to its own test-istream.c file.

lib-test: Allow test_istream_set_*() for test-istream's children. It will internally find the test_istream from parents. This simplifies the testing code so that it doesn't have to keep track of both the test_istream and the final istream.

lib-test: Fixed NULL pointer dereference when using --enable-static-checker

lib-test: Added missing va_end() call.

lib-test: test_expect_errors() now works for the entire log string, not just format parameter

lib: Changed t_pop() API to make it a bit more like free()

lib,lib-test: stop calling memcmp and memcpy with NULL in tests

lib-test: test-exit helper to stop valgrind complaining about fork()s fork()s that want to _exit() will cause valgrind's full memory leak checker to complain a lot - this performs a quick cleanup first. Before: phil@phil:~/repos/dovecot-core$ valgrind --trace-children=yes --leak-check=full --show-leak-kinds=all src/lib/test-lib --match unix ==19576== total heap usage: 4 allocs, 0 frees, 17,858 bytes allocated istream unix ......................................................... : ok 0 / 1 tests failed ==19575== total heap usage: 7 allocs, 7 frees, 19,327 bytes allocated After: phil@phil:~/repos/dovecot-core$ valgrind --trace-children=yes --leak-check=full --show-leak-kinds=all src/lib/test-lib --match unix istream unix ......................................................... : ok ==4993== total heap usage: 4 allocs, 4 frees, 17,858 bytes allocated 0 / 1 tests failed ==4992== total heap usage: 7 allocs, 7 frees, 19,327 bytes allocated Signed-off-by: Phil Carmody <phil@dovecot.fi>

lib-test: enable naming of tests, such that only a subset is run How to use these will become clear in a subsequent patch. Even if you don't want to name tests, the macros can reduce redundancy in the code, as the list of test function prototypes and the list of test functions to call become the same lists, expanded through 2 different macros. Signed-off-by: Phil Carmody <phil@dovecot.fi>

lib-test: improve expected error handling If we expect a specific error string, then when we see it, suppress it. We do not suppress errors expected by count, because if we get unexpected errors, then we do not want them suppressed, and we have no way of distinguishing between the expected and unexpected errors. This of course favours the use of the expected string version of the helper, but alas that's not always usable, as you can only expect one at a time. Additionally, if we failed to see an expected message, then when we no longer expect to see it, reset the expected message state to not cascade further test assertion failures. Signed-off-by: Phil Carmody <phil@dovecot.fi> Conflicts: src/lib-test/test-common.c

lib,lib-test: i_warning to i_debug on alloc growing messages

lib-test: add test_assert_failed_strcmp to expose strings. the macro is used to facilitate any test to show string comparision contents when they doesn't match.

global: Use i_stream_get_max_buffer_size() wherever possible After 7be8ba0c0 it's no longer correct to access stream->max_buffer_size directly. These changes fix using istream-chain with various wrapper streams.

global: freshen copyright git ls-files | xargs perl -p -i -e 's/(\d+)-201[0-5]/$1-2016/g;s/ (201[0-5]) Dovecot/ $1-2016 Dovecot/'

Remove now-unnecessary direct stdlib.h #includes.

lib-test: test_expect_error_string() to match a single known message This gives us very fine control over what is acceptable as an expected warning. Alas you have to do it for each message individually. Signed-off-by: Phil Carmody <phil@dovecot.fi>

lib-test: let tests invoke i_warning/i_error behaviour Error-handling paths should be testable too. Permit a test case to register that a known number of warnings/errors are to be expected, and to verify that those warnings did occur afterwards. Too many messages will fail the test exactly as it did in the past, they're unexpected messages. However, too few messages will also cause the test case to fail. Signed-off-by: Phil Carmody <phil@dovecot.fi>

lib-test: flush test-assert failure messages Diagnostic output to stderr may overtake these stdout logs if the streams are combined by the shell or on the console. fflush() might help realign them. Signed-off-by: Phil Carmody <phil@dovecot.fi>

global: freshen copyright Robomatically: git ls-files | xargs perl -p -i -e 's/(\d+)-201[0-4]/$1-2015/g;s/ (201[0-4]) Dovecot/ $1-2015 Dovecot/' Happy 2015 everyone! Signed-off-by: Phil Carmody <phil@dovecot.fi>

lib-test: more delicate *assert() behaviour when doing fatal tests We shouldn't be i_asserting ourselves when we're in the state of wanting a test to fail. Therefore instead test_assert to get the assert message, and ensure that the success flag is cleared to get the FAILED at the end. Signed-off-by: Phil Carmody <phil@dovecot.fi>

lib-test: don't use 0 for old size in realloc call We have the real size, use it. Signed-off-by: Phil Carmody <phil@dovecot.fi>

lib-test: permit tests of fatal conditions Some functions have no mechanism of reporting an error, and mustn't continue, so fatality is the only way out. (E.g. memory allocation failures.) This addition is for those situations. Semantics of failure tests are very different from normal tests: - The test function must have the following prototype: enum fatal_test_state test_fatal_things(int index); - The index it will be called with starts at 0, and increments each time. - It must call test_start() at the start of its first call. - Apart from its final call, it must call a function it expects to trap the fatal error handler. If that fails to trap, it must return FATAL_TEST_FAILURE - After returning FATAL_TEST_FAILURE, it will continue to be called as normal. - When there are no more tests to perform, it must clean up, call test_end() and return FATAL_TEST_FINISHED. It will not be called again. - If it detects errors in this protocol, it must not i_assert(), as that will be treated as an expected fatal, it must return FATAL_TEST_ABORT. It will then not be called again. It must not call test_end() in this case. Signed-off-by: Phil Carmody <phil@dovecot.fi>

lib-test: make internal helpers static These functions should only be called from within test_run(), as some of the test-suite sanity checks can be subvirted if these are exposed. Signed-off-by: Phil Carmody <phil@dovecot.fi>

lib-test: quieten the random seed printfs We only need to know the seed once. Signed-off-by: Phil Carmody <phil@dovecot.fi>

lib-test: test-common - add test_out_quiet() to reduce verbosity Like test_out() but only prints anything if success is false. This makes it quite much like test_assert(), except that it doesn't print the code fragment, it prints a custom string. However, it still counts as a test in the total count, unlike test_assert*()s. Signed-off-by: Phil Carmody <phil@dovecot.fi>

lib-test: use the new srand() tracking helpers to aid debugging We can only be sure we know the entirity of the stream of numbers returned by rand if rand_set_seed has been called precisely once, as after that we can't be sure when it was called a 2nd or further time. However, at least we can know that that has happened. (Likewise, any calls to srand() will disturb the flow.) Most unit test cases should be simple enough that there should be only one seeding. Signed-off-by: Phil Carmody <phil@dovecot.fi>

lib-test: Enable looped tests to abort early on first failure Give them the ability to query the current failure state. Signed-off-by: Phil Carmody <phil@dovecot.fi>

lib-test: Fixed "Trying to allocate 0 bytes" assert-crash caused by recent test-istream changes.

lib-test: Improved test-istream to catch more bugs

lib-test: test_assert helper for loops If you're repeatedly testing the same expression in a loop, it's good to know where you are in the loop. Add an additional parameter for these cases. Signed-off-by: Phil Carmody <phil@dovecot.fi>

Updated copyright notices to include year 2014.

Oops :) Update copyrights to 2013 without breaking all .c files.

Updated copyright notices to include year 2013.