LCOV - code coverage report
Current view: top level - spdk/test/unit/lib/log/log.c - log_ut.c (source / functions) Hit Total Coverage
Test: Combined Lines: 128 129 99.2 %
Date: 2024-07-12 23:21:00 Functions: 9 9 100.0 %
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: 42 72 58.3 %

           Branch data     Line data    Source code
       1                 :            : /*   SPDX-License-Identifier: BSD-3-Clause
       2                 :            :  *   Copyright (C) 2016 Intel Corporation.
       3                 :            :  *   All rights reserved.
       4                 :            :  */
       5                 :            : 
       6                 :            : #include "spdk/stdinc.h"
       7                 :            : 
       8                 :            : #include "spdk_internal/cunit.h"
       9                 :            : #include "spdk/log.h"
      10                 :            : #include "spdk/env.h"
      11                 :            : #include "spdk/string.h"
      12                 :            : 
      13                 :            : #include "log/log.c"
      14                 :            : #include "log/log_flags.c"
      15                 :            : #include "log/log_deprecated.c"
      16                 :            : 
      17                 :          6 : SPDK_LOG_REGISTER_COMPONENT(log)
      18                 :            : 
      19                 :            : static void
      20                 :          6 : log_test(void)
      21                 :            : {
      22                 :          6 :         spdk_log_set_level(SPDK_LOG_ERROR);
      23                 :          6 :         CU_ASSERT_EQUAL(spdk_log_get_level(), SPDK_LOG_ERROR);
      24                 :          6 :         spdk_log_set_level(SPDK_LOG_WARN);
      25                 :          6 :         CU_ASSERT_EQUAL(spdk_log_get_level(), SPDK_LOG_WARN);
      26                 :          6 :         spdk_log_set_level(SPDK_LOG_NOTICE);
      27                 :          6 :         CU_ASSERT_EQUAL(spdk_log_get_level(), SPDK_LOG_NOTICE);
      28                 :          6 :         spdk_log_set_level(SPDK_LOG_INFO);
      29                 :          6 :         CU_ASSERT_EQUAL(spdk_log_get_level(), SPDK_LOG_INFO);
      30                 :          6 :         spdk_log_set_level(SPDK_LOG_DEBUG);
      31                 :          6 :         CU_ASSERT_EQUAL(spdk_log_get_level(), SPDK_LOG_DEBUG);
      32                 :            : 
      33                 :          6 :         spdk_log_set_print_level(SPDK_LOG_ERROR);
      34                 :          6 :         CU_ASSERT_EQUAL(spdk_log_get_print_level(), SPDK_LOG_ERROR);
      35                 :          6 :         spdk_log_set_print_level(SPDK_LOG_WARN);
      36                 :          6 :         CU_ASSERT_EQUAL(spdk_log_get_print_level(), SPDK_LOG_WARN);
      37                 :          6 :         spdk_log_set_print_level(SPDK_LOG_NOTICE);
      38                 :          6 :         CU_ASSERT_EQUAL(spdk_log_get_print_level(), SPDK_LOG_NOTICE);
      39                 :          6 :         spdk_log_set_print_level(SPDK_LOG_INFO);
      40                 :          6 :         CU_ASSERT_EQUAL(spdk_log_get_print_level(), SPDK_LOG_INFO);
      41                 :          6 :         spdk_log_set_print_level(SPDK_LOG_DEBUG);
      42                 :          6 :         CU_ASSERT_EQUAL(spdk_log_get_print_level(), SPDK_LOG_DEBUG);
      43                 :            : 
      44                 :            : #ifdef DEBUG
      45                 :          6 :         CU_ASSERT(spdk_log_get_flag("LOG") == false);
      46                 :            : 
      47                 :          6 :         spdk_log_set_flag("log");
      48                 :          6 :         CU_ASSERT(spdk_log_get_flag("LOG") == true);
      49                 :            : 
      50                 :          6 :         spdk_log_clear_flag("LOG");
      51                 :          6 :         CU_ASSERT(spdk_log_get_flag("LOG") == false);
      52                 :            : #endif
      53                 :            : 
      54                 :          6 :         spdk_log_open(NULL);
      55                 :          6 :         spdk_log_set_flag("log");
      56                 :          6 :         SPDK_WARNLOG("log warning unit test\n");
      57   [ +  +  +  - ]:          6 :         SPDK_DEBUGLOG(log, "log test\n");
      58   [ +  +  +  - ]:          6 :         SPDK_LOGDUMP(log, "log dump test:", "log dump", 8);
      59                 :          6 :         spdk_log_dump(stderr, "spdk dump test:", "spdk dump", 9);
      60                 :            :         /* Test spdk_log_dump with more than 16 chars and less than 32 chars */
      61                 :          6 :         spdk_log_dump(stderr, "spdk dump test:", "spdk dump 16 more chars", 23);
      62                 :            : 
      63                 :          6 :         spdk_log_close();
      64                 :          6 : }
      65                 :            : 
      66         [ -  + ]:          6 : SPDK_LOG_DEPRECATION_REGISTER(unit_test_not_limited, "not rate limited", "never", 0)
      67         [ -  + ]:          6 : SPDK_LOG_DEPRECATION_REGISTER(unit_test_limited, "with rate limit", "sometime", 1)
      68         [ -  + ]:          6 : SPDK_LOG_DEPRECATION_REGISTER(unit_test_never_called, "not called", "maybe", 0)
      69                 :            : 
      70                 :            : int g_ut_dep_expect_line;
      71                 :            : const char *g_ut_dep_expect_func;
      72                 :            : const char *g_ut_dep_expect_msg;
      73                 :            : uint32_t g_ut_dep_log_times;
      74                 :            : bool g_ut_dep_saw_suppressed_log;
      75                 :            : 
      76                 :            : static void
      77                 :         30 : log_deprecations(int level, const char *file, const int line, const char *func,
      78                 :            :                  const char *format, va_list args)
      79                 :            : {
      80                 :            :         char *msg;
      81                 :            : 
      82                 :         30 :         g_ut_dep_log_times++;
      83                 :            : 
      84                 :         30 :         CU_ASSERT(level == SPDK_LOG_WARN);
      85                 :            : 
      86   [ +  +  +  + ]:         30 :         if (strcmp("spdk_log_deprecated", func) == 0) {
      87                 :          6 :                 g_ut_dep_saw_suppressed_log = true;
      88                 :            :         } else {
      89   [ -  +  -  + ]:         24 :                 CU_ASSERT(strcmp(g_ut_dep_expect_func, func) == 0);
      90                 :         24 :                 CU_ASSERT(g_ut_dep_expect_line == line);
      91                 :            :         }
      92                 :            : 
      93                 :            :         /* A "starts with" check */
      94                 :         30 :         msg = spdk_vsprintf_alloc(format, args);
      95         [ -  + ]:         30 :         SPDK_CU_ASSERT_FATAL(msg != NULL);
      96   [ -  +  -  +  :         30 :         CU_ASSERT(strncmp(g_ut_dep_expect_msg, msg, strlen(g_ut_dep_expect_msg)) == 0)
                   -  + ]
      97                 :            : 
      98                 :         30 :         free(msg);
      99                 :         30 : }
     100                 :            : 
     101                 :            : bool g_found_not_limited;
     102                 :            : bool g_found_limited;
     103                 :            : bool g_found_never_called;
     104                 :            : 
     105                 :            : static int
     106                 :         18 : iter_dep_cb(void *ctx, struct spdk_deprecation *dep)
     107                 :            : {
     108                 :            :         /* The getters work from the callback. */
     109         [ +  + ]:         18 :         if (dep == _deprecated_unit_test_not_limited) {
     110         [ -  + ]:          6 :                 CU_ASSERT(!g_found_not_limited);
     111                 :          6 :                 g_found_not_limited = true;
     112         [ -  + ]:          6 :                 CU_ASSERT(strcmp(spdk_deprecation_get_tag(dep), "unit_test_not_limited") == 0);
     113         [ -  + ]:          6 :                 CU_ASSERT(strcmp(spdk_deprecation_get_description(dep), "not rate limited") == 0);
     114         [ -  + ]:          6 :                 CU_ASSERT(strcmp(spdk_deprecation_get_remove_release(dep), "never") == 0);
     115                 :          6 :                 CU_ASSERT(spdk_deprecation_get_hits(dep) != 0);
     116         [ +  + ]:         12 :         } else if (dep == _deprecated_unit_test_limited) {
     117         [ -  + ]:          6 :                 CU_ASSERT(!g_found_limited);
     118                 :          6 :                 g_found_limited = true;
     119         [ -  + ]:          6 :                 CU_ASSERT(strcmp(spdk_deprecation_get_tag(dep), "unit_test_limited") == 0);
     120         [ -  + ]:          6 :                 CU_ASSERT(strcmp(spdk_deprecation_get_description(dep), "with rate limit") == 0);
     121         [ -  + ]:          6 :                 CU_ASSERT(strcmp(spdk_deprecation_get_remove_release(dep), "sometime") == 0);
     122                 :          6 :                 CU_ASSERT(spdk_deprecation_get_hits(dep) != 0);
     123         [ +  - ]:          6 :         } else if (dep == _deprecated_unit_test_never_called) {
     124         [ -  + ]:          6 :                 CU_ASSERT(!g_found_never_called);
     125                 :          6 :                 g_found_never_called = true;
     126         [ -  + ]:          6 :                 CU_ASSERT(strcmp(spdk_deprecation_get_tag(dep), "unit_test_never_called") == 0);
     127         [ -  + ]:          6 :                 CU_ASSERT(strcmp(spdk_deprecation_get_description(dep), "not called") == 0);
     128         [ -  + ]:          6 :                 CU_ASSERT(strcmp(spdk_deprecation_get_remove_release(dep), "maybe") == 0);
     129                 :          6 :                 CU_ASSERT(spdk_deprecation_get_hits(dep) == 0);
     130                 :            :         } else {
     131                 :          0 :                 CU_ASSERT(false);
     132                 :            :         }
     133                 :            : 
     134                 :         18 :         return 0;
     135                 :            : }
     136                 :            : 
     137                 :            : static void
     138                 :          6 : deprecation(void)
     139                 :            : {
     140                 :            :         int rc;
     141                 :            : 
     142                 :          6 :         spdk_log_open(log_deprecations);
     143                 :            : 
     144                 :            :         /* A log message is emitted for every message without rate limiting. */
     145                 :          6 :         g_ut_dep_saw_suppressed_log = false;
     146                 :          6 :         g_ut_dep_log_times = 0;
     147                 :          6 :         g_ut_dep_expect_func = __func__;
     148                 :          6 :         g_ut_dep_expect_msg = "unit_test_not_limited:";
     149                 :          6 :         g_ut_dep_expect_line = __LINE__ + 1;
     150                 :          6 :         SPDK_LOG_DEPRECATED(unit_test_not_limited);
     151                 :          6 :         CU_ASSERT(_deprecated_unit_test_not_limited->hits == 1);
     152                 :          6 :         CU_ASSERT(_deprecated_unit_test_not_limited->deferred == 0);
     153                 :          6 :         CU_ASSERT(g_ut_dep_log_times == 1);
     154                 :          6 :         g_ut_dep_expect_line = __LINE__ + 1;
     155                 :          6 :         SPDK_LOG_DEPRECATED(unit_test_not_limited);
     156                 :          6 :         CU_ASSERT(_deprecated_unit_test_not_limited->hits == 2);
     157                 :          6 :         CU_ASSERT(_deprecated_unit_test_not_limited->deferred == 0);
     158                 :          6 :         CU_ASSERT(g_ut_dep_log_times == 2);
     159         [ -  + ]:          6 :         CU_ASSERT(!g_ut_dep_saw_suppressed_log);
     160                 :            : 
     161                 :            :         /* Rate limiting keeps track of deferred messages */
     162                 :          6 :         g_ut_dep_saw_suppressed_log = false;
     163                 :          6 :         g_ut_dep_log_times = 0;
     164                 :          6 :         g_ut_dep_expect_msg = "unit_test_limited:";
     165                 :          6 :         g_ut_dep_expect_line = __LINE__ + 1;
     166                 :          6 :         SPDK_LOG_DEPRECATED(unit_test_limited);
     167                 :          6 :         CU_ASSERT(_deprecated_unit_test_limited->hits == 1);
     168                 :          6 :         CU_ASSERT(_deprecated_unit_test_limited->deferred == 0);
     169                 :          6 :         CU_ASSERT(g_ut_dep_log_times == 1);
     170                 :          6 :         SPDK_LOG_DEPRECATED(unit_test_limited);
     171                 :          6 :         CU_ASSERT(_deprecated_unit_test_limited->hits == 2);
     172                 :          6 :         CU_ASSERT(_deprecated_unit_test_limited->deferred == 1);
     173                 :          6 :         CU_ASSERT(g_ut_dep_log_times == 1);
     174         [ -  + ]:          6 :         CU_ASSERT(!g_ut_dep_saw_suppressed_log);
     175                 :            : 
     176                 :            :         /* After a delay, the next log message prints the normal message followed by one that says
     177                 :            :          * that some messages were suppressed.
     178                 :            :          */
     179                 :          6 :         g_ut_dep_saw_suppressed_log = false;
     180                 :          6 :         sleep(1);
     181                 :          6 :         g_ut_dep_expect_line = __LINE__ + 1;
     182                 :          6 :         SPDK_LOG_DEPRECATED(unit_test_limited);
     183                 :          6 :         CU_ASSERT(_deprecated_unit_test_limited->hits == 3);
     184                 :          6 :         CU_ASSERT(_deprecated_unit_test_limited->deferred == 0);
     185                 :          6 :         CU_ASSERT(g_ut_dep_log_times == 3);
     186         [ -  + ]:          6 :         CU_ASSERT(g_ut_dep_saw_suppressed_log);
     187                 :            : 
     188                 :            :         /* spdk_log_for_each_deprecation() visits each registered deprecation */
     189                 :          6 :         rc = spdk_log_for_each_deprecation(NULL, iter_dep_cb);
     190                 :          6 :         CU_ASSERT(rc == 0);
     191         [ -  + ]:          6 :         CU_ASSERT(g_found_not_limited);
     192         [ -  + ]:          6 :         CU_ASSERT(g_found_limited);
     193         [ -  + ]:          6 :         CU_ASSERT(g_found_never_called);
     194                 :            : 
     195                 :          6 :         g_log = NULL;
     196                 :          6 : }
     197                 :            : 
     198                 :            : int
     199                 :          6 : main(int argc, char **argv)
     200                 :            : {
     201                 :          6 :         CU_pSuite       suite = NULL;
     202                 :            :         unsigned int    num_failures;
     203                 :            : 
     204                 :          6 :         CU_initialize_registry();
     205                 :            : 
     206                 :          6 :         suite = CU_add_suite("log", NULL, NULL);
     207                 :            : 
     208                 :          6 :         CU_ADD_TEST(suite, log_test);
     209                 :          6 :         CU_ADD_TEST(suite, deprecation);
     210                 :            : 
     211                 :          6 :         num_failures = spdk_ut_run_tests(argc, argv, NULL);
     212                 :          6 :         CU_cleanup_registry();
     213                 :          6 :         return num_failures;
     214                 :            : }

Generated by: LCOV version 1.14