Re: [Tarantool-patches] [PATCHv3 1/2] core: add setting error injections via env

[Leonid Vasiliev via Tarantool-patches <tarantool-patches@dev.tarantool.org>]

Hi! Thank you for the patch.

On 3/4/21 12:15 PM, Artem Starshov wrote:
> Sometimes, it's useful to set error injections via environment
> variables and this commit adds this opportunity.
> 
> e.g: `ERRINJ_WAL_WRITE=true tarantool` will be launched with
> ERRINJ_WAL_WRITE setted to true.
> 
> Errinjs with bool parameters can be set to "true", "false",
> "True", "False", "TRUE", "FALSE", etc. (case-insensitive variable).
> 
> Errinjs with int or double parameters should be whole valid ("123s" is invalid).
> e.g. for int or double: "123", "-1", "2.34", "+2.34".
> 
> NOTE: errinjs should work only in debug mode, so added `release_disabled` in
> suite.ini. But there is a bug in test-run: `release_disable` disables tests at
> each build type. Partially this problem is descripted in tarantool/test-run#199.
> 
> Part of #5040
> ---
>   src/lib/core/errinj.c                         | 30 ++++++++++++++++
>   src/lib/core/errinj.h                         |  5 +++
>   src/main.cc                                   |  3 ++
>   .../errinj_set_with_enviroment_vars.test.lua  | 29 ++++++++++++++++
>   ...errinj_set_with_enviroment_vars_script.lua | 34 +++++++++++++++++++
>   test/box-tap/suite.ini                        |  1 +
>   6 files changed, 102 insertions(+)
>   create mode 100755 test/box-tap/errinj_set_with_enviroment_vars.test.lua
>   create mode 100644 test/box-tap/errinj_set_with_enviroment_vars_script.lua
> 
> diff --git a/src/lib/core/errinj.c b/src/lib/core/errinj.c
> index d3aa0ca4f..8f76bfac1 100644
> --- a/src/lib/core/errinj.c
> +++ b/src/lib/core/errinj.c
> @@ -28,9 +28,11 @@
>    * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
>    * SUCH DAMAGE.
>    */
> +#include <ctype.h>
>   #include <stdio.h>
>   #include <stdlib.h>
>   #include <string.h>
> +#include <strings.h>
>   #include <stdbool.h>
>   
>   #include "trivia/config.h"
> @@ -66,3 +68,31 @@ int errinj_foreach(errinj_cb cb, void *cb_ctx) {
>   	}
>   	return 0;
>   }
> +
> +void errinj_set_with_environment_vars(void) {
> +    for (enum errinj_id i = 0; i < errinj_id_MAX; i++) {
> +        struct errinj *inj = &errinjs[i];
> +        const char *env_value = getenv(inj->name);
> +        if (env_value == NULL || *env_value == '\0')
> +            continue;
> +
> +        if (inj->type == ERRINJ_INT) {
> +            char *end;
> +            int64_t int_value = strtoll(env_value, &end, 10);
> +            if (*end == '\0')

"Seems like the `panic()` should be called in the case of `else()`. Here
and in other cases of parsing." is about this `if`.

> +                inj->iparam = int_value;
> +        } else if (inj->type == ERRINJ_BOOL) {
> +            if (strcasecmp(env_value, "false") == 0)


"Seems like the `panic()` should be called in the case of `else()`. Here
and in other cases of parsing." is about this `if`.

> +                inj->bparam = false;
> +            else if (strcasecmp(env_value, "true") == 0)
> +                inj->bparam = true;
> +        } else if (inj->type == ERRINJ_DOUBLE) {
> +            char *end;
> +            double double_value = strtod(env_value, &end);
> +            if (*end == '\0')


"Seems like the `panic()` should be called in the case of `else()`. Here
and in other cases of parsing." is about this `if`.

> +                inj->dparam = double_value;
> +        } else {

This `else` is unnecessary, because these structures are from a
hardcoded list.

> +            panic("Unknown errinj type received");
> +        }
> +    }
> +}
> diff --git a/src/lib/core/errinj.h b/src/lib/core/errinj.h
> index 814c57c2e..10edbe2b9 100644
> --- a/src/lib/core/errinj.h
> +++ b/src/lib/core/errinj.h
> @@ -168,6 +168,11 @@ typedef int (*errinj_cb)(struct errinj *e, void *cb_ctx);
>   int
>   errinj_foreach(errinj_cb cb, void *cb_ctx);
>   
> +/**
> + * Set injections by scanning ERRINJ_$(NAME) in environment variables
> + */
> +void errinj_set_with_environment_vars(void);
> +
>   #ifdef NDEBUG
>   #  define ERROR_INJECT(ID, CODE)
>   #  define ERROR_INJECT_WHILE(ID, CODE)
> diff --git a/src/main.cc b/src/main.cc
> index 2fce81bb3..718180b80 100644
> --- a/src/main.cc
> +++ b/src/main.cc
> @@ -710,6 +710,9 @@ main(int argc, char **argv)
>   	memtx_tx_manager_init();
>   	crypto_init();
>   	systemd_init();
> +#ifndef NDEBUG
> +	errinj_set_with_environment_vars();
> +#endif
>   	tarantool_lua_init(tarantool_bin, main_argc, main_argv);
>   
>   	start_time = ev_monotonic_time();
> diff --git a/test/box-tap/errinj_set_with_enviroment_vars.test.lua b/test/box-tap/errinj_set_with_enviroment_vars.test.lua
> new file mode 100755
> index 000000000..8d4ecaedd
> --- /dev/null
> +++ b/test/box-tap/errinj_set_with_enviroment_vars.test.lua
> @@ -0,0 +1,29 @@
> +#!/usr/bin/env tarantool
> +local fio = require('fio')
> +
> +-- Execute errinj_set_with_enviroment_vars_script.lua
> +-- via tarantool with presetted environment variables.
> +local TARANTOOL_PATH = arg[-1]
> +local bool_env     =    'ERRINJ_TESTING=true ' ..

I don't mind one `env` variable per line, but please do not tab-align
the variable (`bool_env`, `integer_env`, `double_env`) definition (use
one space before the `=` and one after).

> +                        'ERRINJ_WAL_IO=True ' ..
> +                        'ERRINJ_WAL_SYNC=TRUE ' ..
> +                        'ERRINJ_WAL_WRITE=false ' ..
> +                        'ERRINJ_INDEX_ALLOC=False ' ..
> +                        'ERRINJ_WAL_WRITE_DISK=FALSE'
> +local integer_env  =    'ERRINJ_WAL_WRITE_PARTIAL=2 ' ..
> +                        'ERRINJ_WAL_FALLOCATE=+2 ' ..
> +                        'ERRINJ_WAL_WRITE_COUNT=-2'
> +local double_env   =    'ERRINJ_VY_READ_PAGE_TIMEOUT=2.5 ' ..
> +                        'ERRINJ_VY_SCHED_TIMEOUT=+2.5 ' ..
> +                        'ERRINJ_RELAY_TIMEOUT=-2.5'
> +local set_env_str = ('%s %s %s'):format(bool_env, integer_env, double_env)
> +local path_to_test_file = fio.pathjoin(
> +        os.getenv('PWD'),
> +        'box-tap',
> +        'errinj_set_with_enviroment_vars_script.lua')
> +local shell_command = ('%s %s %s'):format(
> +                set_env_str,
> +                TARANTOOL_PATH,
> +                path_to_test_file)
> +
> +os.exit(os.execute(shell_command))
> diff --git a/test/box-tap/errinj_set_with_enviroment_vars_script.lua b/test/box-tap/errinj_set_with_enviroment_vars_script.lua
> new file mode 100644
> index 000000000..f15085aa0
> --- /dev/null
> +++ b/test/box-tap/errinj_set_with_enviroment_vars_script.lua
> @@ -0,0 +1,34 @@
> +-- Script for box-tap/errinj_set_with_enviroment_vars.test.lua test.
> +
> +local tap = require('tap')
> +local errinj = box.error.injection
> +
> +local test = tap.test('set errinjs via environment variables')
> +
> +test:plan(3)
> +
> +test:test('Set boolean error injections', function(test)
> +    test:plan(6)
> +    test:is(errinj.get('ERRINJ_TESTING'), true, 'true')
> +    test:is(errinj.get('ERRINJ_WAL_IO'), true, 'True')
> +    test:is(errinj.get('ERRINJ_WAL_SYNC'), true, 'TRUE')
> +    test:is(errinj.get('ERRINJ_WAL_WRITE'), false, 'false')
> +    test:is(errinj.get('ERRINJ_INDEX_ALLOC'), false, 'False')
> +    test:is(errinj.get('ERRINJ_WAL_WRITE_DISK'), false, 'FALSE')
> +end)
> +
> +test:test('Set integer error injections', function(test)
> +    test:plan(3)
> +    test:is(errinj.get('ERRINJ_WAL_WRITE_PARTIAL'), 2, '2')
> +    test:is(errinj.get('ERRINJ_WAL_FALLOCATE'), 2, '+2')
> +    test:is(errinj.get('ERRINJ_WAL_WRITE_COUNT'), -2, '-2')
> +end)
> +
> +test:test('Set double error injections', function(test)
> +    test:plan(3)
> +    test:is(errinj.get('ERRINJ_VY_READ_PAGE_TIMEOUT'), 2.5, "2.5")
> +    test:is(errinj.get('ERRINJ_VY_SCHED_TIMEOUT'), 2.5, "+2.5")
> +    test:is(errinj.get('ERRINJ_RELAY_TIMEOUT'), -2.5, "-2.5")
> +end)
> +
> +os.exit(test:check() and 0 or 1)
> diff --git a/test/box-tap/suite.ini b/test/box-tap/suite.ini
> index a7c03baa8..8ed7fffb9 100644
> --- a/test/box-tap/suite.ini
> +++ b/test/box-tap/suite.ini
> @@ -4,6 +4,7 @@ description = Database tests with #! using TAP
>   is_parallel = True
>   pretest_clean = True
>   use_unix_sockets_iproto = True
> +release_disabled = errinj_set_with_enviroment_vars.test.lua
>   config = suite.cfg
>   fragile = {
>       "retries": 10,
>