[LTP] [PATCH v2 2/4] lib: Add support for TDBUG tst_res() flag

Jan Stancek jstancek@redhat.com
Fri Dec 8 07:50:38 CET 2023


On Thu, Dec 7, 2023 at 10:27 PM Petr Vorel <pvorel@suse.cz> wrote:
>
> To print more verbose info. By default it's off, printing enabled with
> -v option.
>
> Use unused value 8 (former TRETR).
> Assigned color is white.
>
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
>  doc/C-Test-API.asciidoc          |  1 +
>  include/tst_ansi_color.h         |  3 +++
>  include/tst_common.h             |  2 +-
>  include/tst_res_flags.h          |  1 +
>  include/tst_test.h               |  5 +++--
>  lib/newlib_tests/tst_res_flags.c |  6 ++++--
>  lib/tst_ansi_color.c             |  3 +++
>  lib/tst_res.c                    |  9 ++++++---
>  lib/tst_test.c                   | 12 ++++++++++++
>  9 files changed, 34 insertions(+), 8 deletions(-)
>
> diff --git a/doc/C-Test-API.asciidoc b/doc/C-Test-API.asciidoc
> index dab811564..479179263 100644
> --- a/doc/C-Test-API.asciidoc
> +++ b/doc/C-Test-API.asciidoc
> @@ -227,6 +227,7 @@ Printf-like function to report test result, it's mostly used with ttype:
>  | 'TPASS' | Test has passed.
>  | 'TFAIL' | Test has failed.
>  | 'TINFO' | General message.
> +| 'TDBUG' | Debug message (C API only, printed with '-v').

My first impression was it's some kind of new BUG type :-)
I'd suggest making it TDEBUG or TDBG.

>  | 'TWARN' | Something went wrong but we decided to continue. Mostly used in cleanup functions.
>  |==============================
>
> diff --git a/include/tst_ansi_color.h b/include/tst_ansi_color.h
> index 770bf46d9..376d4ad63 100644
> --- a/include/tst_ansi_color.h
> +++ b/include/tst_ansi_color.h
> @@ -4,14 +4,17 @@
>
>  #ifndef TST_ANSI_COLOR_H__
>  #define TST_ANSI_COLOR_H__
> +
>  /*
>   * NOTE: these colors should match colors defined in tst_flag2color() in
>   * testcases/lib/tst_ansi_color.sh
>   */
> +
>  #define ANSI_COLOR_BLUE                "\033[1;34m"
>  #define ANSI_COLOR_GREEN       "\033[1;32m"
>  #define ANSI_COLOR_MAGENTA     "\033[1;35m"
>  #define ANSI_COLOR_RED         "\033[1;31m"
> +#define ANSI_COLOR_WHITE       "\033[1;37m"
>  #define ANSI_COLOR_YELLOW      "\033[1;33m"
>
>  #define ANSI_COLOR_RESET       "\033[0m"
> diff --git a/include/tst_common.h b/include/tst_common.h
> index 520cca72c..e22aa9a30 100644
> --- a/include/tst_common.h
> +++ b/include/tst_common.h
> @@ -80,7 +80,7 @@
>  #define TST_BRK_SUPPORTS_ONLY_TCONF_TBROK(condition) \
>         TST_BUILD_BUG_ON(condition)
>
> -#define TST_RES_SUPPORTS_TCONF_TFAIL_TINFO_TPASS_TWARN(condition) \
> +#define TST_RES_SUPPORTS_TCONF_TDBUG_TFAIL_TINFO_TPASS_TWARN(condition) \
>         TST_BUILD_BUG_ON(condition)
>
>  /* stringification */
> diff --git a/include/tst_res_flags.h b/include/tst_res_flags.h
> index 8eda2f8b8..327b27fb3 100644
> --- a/include/tst_res_flags.h
> +++ b/include/tst_res_flags.h
> @@ -11,6 +11,7 @@
>  #define TFAIL  1       /* Test failed flag */
>  #define TBROK  2       /* Test broken flag */
>  #define TWARN  4       /* Test warning flag */
> +#define TDBUG  8       /* Test debug information flag */
>  #define TINFO  16      /* Test information flag */
>  #define TCONF  32      /* Test not appropriate for configuration flag */
>  #define TTYPE_RESULT(ttype)    ((ttype) & TTYPE_MASK)
> diff --git a/include/tst_test.h b/include/tst_test.h
> index 75c2109b9..e54601285 100644
> --- a/include/tst_test.h
> +++ b/include/tst_test.h
> @@ -54,8 +54,9 @@ void tst_res_(const char *file, const int lineno, int ttype,
>
>  #define tst_res(ttype, arg_fmt, ...) \
>         ({                                                                      \
> -               TST_RES_SUPPORTS_TCONF_TFAIL_TINFO_TPASS_TWARN(!((TTYPE_RESULT(ttype) ?: TCONF) & \
> -                       (TCONF | TFAIL | TINFO | TPASS | TWARN)));                              \
> +               TST_RES_SUPPORTS_TCONF_TDBUG_TFAIL_TINFO_TPASS_TWARN(\
> +                       !((TTYPE_RESULT(ttype) ?: TCONF) & \
> +                       (TCONF | TDBUG | TFAIL | TINFO | TPASS | TWARN)));                              \
>                 tst_res_(__FILE__, __LINE__, (ttype), (arg_fmt), ##__VA_ARGS__);\
>         })
>
> diff --git a/lib/newlib_tests/tst_res_flags.c b/lib/newlib_tests/tst_res_flags.c
> index dc8f27e74..331f1ae1c 100644
> --- a/lib/newlib_tests/tst_res_flags.c
> +++ b/lib/newlib_tests/tst_res_flags.c
> @@ -13,6 +13,7 @@
>  static struct tcase {
>         int flag;
>         const char *str;
> +       const char *note;
>  } tcases[] = {
>         {FLAG(TPASS)},
>         {FLAG(TFAIL)},
> @@ -20,6 +21,7 @@ static struct tcase {
>         {FLAG(TCONF)},
>         {FLAG(TWARN)},
>         {FLAG(TINFO)},
> +       {FLAG(TDBUG), " (printed only with -v)"},
>  };
>
>  static void do_cleanup(void)
> @@ -32,9 +34,9 @@ static void do_test(unsigned int n)
>         int flag = tcases[n].flag;
>         const char *str = tcases[n].str;
>
> -       tst_res(flag, "%s message", str);
> +       tst_res(flag, "%s message%s", str, tcases[n].note ?: "");
>
> -       if (flag == TWARN || flag == TINFO)
> +       if (flag == TWARN || flag == TINFO || flag == TDBUG)
>                 tst_res(TPASS, "%s message is not a result", str);
>  }
>
> diff --git a/lib/tst_ansi_color.c b/lib/tst_ansi_color.c
> index 1c29268f2..9598cafc9 100644
> --- a/lib/tst_ansi_color.c
> +++ b/lib/tst_ansi_color.c
> @@ -31,6 +31,9 @@ char* tst_ttype2color(int ttype)
>         case TINFO:
>                 return ANSI_COLOR_BLUE;
>         break;
> +       case TDBUG:
> +               return ANSI_COLOR_WHITE;
> +       break;
>         default:
>                 return "";
>         }
> diff --git a/lib/tst_res.c b/lib/tst_res.c
> index e0896eb05..2e6606088 100644
> --- a/lib/tst_res.c
> +++ b/lib/tst_res.c
> @@ -157,6 +157,7 @@ const char *strttype(int ttype)
>                 PAIR(TCONF)
>                 PAIR(TWARN)
>                 PAIR(TINFO)
> +               PAIR(TDBUG)
>         };
>
>         PAIR_LOOKUP(ttype_pairs, TTYPE_RESULT(ttype));
> @@ -174,8 +175,10 @@ static void tst_res__(const char *file, const int lineno, int ttype,
>         int len = 0;
>         int ttype_result = TTYPE_RESULT(ttype);
>
> -       if (file && (ttype_result != TPASS && ttype_result != TINFO))
> +       if (file && (ttype_result != TPASS && ttype_result != TINFO &&
> +                    ttype_result != TDBUG))
>                 len = sprintf(tmesg, "%s:%d: ", file, lineno);
> +
>         EXPAND_VAR_ARGS(tmesg + len, arg_fmt, USERMESG - len);
>
>         /*
> @@ -193,7 +196,7 @@ static void tst_res__(const char *file, const int lineno, int ttype,
>          * Set the test case number and print the results, depending on the
>          * display type.
>          */
> -       if (ttype_result == TWARN || ttype_result == TINFO) {
> +       if (ttype_result == TWARN || ttype_result == TINFO || ttype_result == TDBUG) {
>                 tst_print(TCID, 0, ttype, tmesg);
>         } else {
>                 if (tst_count < 0)
> @@ -411,7 +414,7 @@ void tst_exit(void)
>
>         tst_old_flush();
>
> -       T_exitval &= ~TINFO;
> +       T_exitval &= ~(TINFO | TDBUG);
>
>         if (T_exitval == TCONF && passed_cnt)
>                 T_exitval &= ~TCONF;
> diff --git a/lib/tst_test.c b/lib/tst_test.c
> index c2f8f503f..04be736ab 100644
> --- a/lib/tst_test.c
> +++ b/lib/tst_test.c
> @@ -60,6 +60,7 @@ static pid_t main_pid, lib_pid;
>  static int mntpoint_mounted;
>  static int ovl_mounted;
>  static struct timespec tst_start_time; /* valid only for test pid */
> +static int tdebug;
>
>  struct results {
>         int passed;
> @@ -224,6 +225,9 @@ static void print_result(const char *file, const int lineno, int ttype,
>         case TINFO:
>                 res = "TINFO";
>         break;
> +       case TDBUG:
> +               res = "TDBUG";
> +       break;
>         default:
>                 tst_brk(TBROK, "Invalid ttype value %i", ttype);
>                 abort();
> @@ -352,6 +356,9 @@ void tst_res_(const char *file, const int lineno, int ttype,
>  {
>         va_list va;
>
> +       if (ttype == TDBUG && !tdebug)
> +               return;
> +
>         va_start(va, fmt);
>         tst_vres_(file, lineno, ttype, fmt, va);
>         va_end(va);
> @@ -511,6 +518,7 @@ static struct option {
>         {"h",  "-h       Prints this help"},
>         {"i:", "-i n     Execute test n times"},
>         {"I:", "-I x     Execute test for n seconds"},
> +       {"v",  "-v       Prints debug information"},
>         {"V",  "-V       Prints LTP version"},
>         {"C:", "-C ARG   Run child process with ARG arguments (used internally)"},
>  };
> @@ -692,6 +700,10 @@ static void parse_opts(int argc, char *argv[])
>                         else
>                                 duration = SAFE_STRTOF(optarg, 0.1, HUGE_VALF);
>                 break;
> +               case 'v':
> +                       tdebug = 1;
> +                       tst_res(TINFO, "Run with -v, printing debug info");
> +               break;
>                 case 'V':
>                         fprintf(stderr, "LTP version: " LTP_VERSION "\n");
>                         exit(0);
> --
> 2.43.0
>



More information about the ltp mailing list