LCOV - code coverage report
Current view: top level - spdk/test/unit/lib/rpc/rpc.c - rpc_ut.c (source / functions) Hit Total Coverage
Test: Combined Lines: 140 142 98.6 %
Date: 2024-07-15 09:31:40 Functions: 18 20 90.0 %
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: 18 26 69.2 %

           Branch data     Line data    Source code
       1                 :            : /*   SPDX-License-Identifier: BSD-3-Clause
       2                 :            :  *   Copyright (C) 2021 Intel Corporation.
       3                 :            :  *   All rights reserved.
       4                 :            :  *   Copyright (c) 2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
       5                 :            :  */
       6                 :            : 
       7                 :            : #include "spdk/stdinc.h"
       8                 :            : #include "spdk_internal/cunit.h"
       9                 :            : #include "spdk/jsonrpc.h"
      10                 :            : #include "spdk_internal/mock.h"
      11                 :            : #include "common/lib/test_env.c"
      12                 :            : #include "spdk/log.h"
      13                 :            : 
      14                 :            : #include "rpc/rpc.c"
      15                 :            : 
      16                 :            : #include "unit/lib/json_mock.c"
      17                 :            : 
      18                 :            : static int g_rpc_err;
      19                 :            : void fn_rpc_method_handler(struct spdk_jsonrpc_request *request,
      20                 :            :                            const struct spdk_json_val *params);
      21                 :            : 
      22                 :          8 : DEFINE_STUB_V(spdk_jsonrpc_end_result, (struct spdk_jsonrpc_request *request,
      23                 :            :                                         struct spdk_json_write_ctx *w));
      24                 :          8 : DEFINE_STUB(spdk_jsonrpc_begin_result, struct spdk_json_write_ctx *,
      25                 :            :             (struct spdk_jsonrpc_request *request), (void *)1);
      26                 :          0 : DEFINE_STUB(spdk_json_decode_bool, int, (const struct spdk_json_val *val, void *out), 0);
      27                 :          4 : DEFINE_STUB(spdk_jsonrpc_server_listen, struct spdk_jsonrpc_server *, (int domain, int protocol,
      28                 :            :                 struct sockaddr *listen_addr, socklen_t addrlen, spdk_jsonrpc_handle_request_fn handle_request),
      29                 :            :             (struct spdk_jsonrpc_server *)0Xdeaddead);
      30                 :          0 : DEFINE_STUB(spdk_jsonrpc_server_poll, int, (struct spdk_jsonrpc_server *server), 0);
      31                 :          4 : DEFINE_STUB_V(spdk_jsonrpc_server_shutdown, (struct spdk_jsonrpc_server *server));
      32                 :            : 
      33                 :            : DECLARE_WRAPPER(open, int, (const char *pathname, int flags, mode_t mode));
      34                 :            : DECLARE_WRAPPER(close, int, (int fd));
      35                 :            : DECLARE_WRAPPER(flock, int, (int fd, int operation));
      36   [ +  +  +  + ]:         36 : DEFINE_WRAPPER(open, int, (const char *pathname, int flags, mode_t mode), (pathname, flags, mode));
      37   [ -  +  -  + ]:          4 : DEFINE_WRAPPER(close, int, (int fd), (fd));
      38   [ -  +  -  + ]:          4 : DEFINE_WRAPPER(flock, int, (int fd, int operation), (fd, operation));
      39                 :            : 
      40                 :            : int
      41                 :          8 : spdk_json_decode_object(const struct spdk_json_val *values,
      42                 :            :                         const struct spdk_json_object_decoder *decoders, size_t num_decoders, void *out)
      43                 :            : {
      44         [ +  + ]:          8 :         if (values ->type == SPDK_JSON_VAL_INVALID) {
      45                 :          4 :                 return 1;
      46                 :            :         }
      47                 :          4 :         return 0;
      48                 :            : }
      49                 :            : 
      50                 :            : bool
      51                 :         24 : spdk_json_strequal(const struct spdk_json_val *val, const char *str)
      52                 :            : {
      53                 :            :         size_t len;
      54                 :            : 
      55   [ +  +  +  - ]:         24 :         if (val->type != SPDK_JSON_VAL_STRING && val->type != SPDK_JSON_VAL_NAME) {
      56                 :          8 :                 return false;
      57                 :            :         }
      58                 :            : 
      59         [ -  + ]:         16 :         len = strlen(str);
      60         [ +  + ]:         16 :         if (val->len != len) {
      61                 :          4 :                 return false;
      62                 :            :         }
      63                 :            : 
      64   [ -  +  -  + ]:         12 :         return memcmp(val->start, str, len) == 0;
      65                 :            : }
      66                 :            : 
      67                 :            : void
      68                 :         12 : spdk_jsonrpc_send_error_response(struct spdk_jsonrpc_request *request,
      69                 :            :                                  int error_code, const char *msg)
      70                 :            : {
      71                 :         12 :         g_rpc_err = error_code;
      72                 :         12 : }
      73                 :            : 
      74                 :            : void
      75                 :          8 : spdk_jsonrpc_send_error_response_fmt(struct spdk_jsonrpc_request *request,
      76                 :            :                                      int error_code, const char *fmt, ...)
      77                 :            : {
      78                 :          8 :         g_rpc_err = error_code;
      79                 :          8 : }
      80                 :            : 
      81                 :            : void
      82                 :          4 : fn_rpc_method_handler(struct spdk_jsonrpc_request *request,
      83                 :            :                       const struct spdk_json_val *params)
      84                 :            : {
      85                 :          4 :         g_rpc_err = 0;
      86                 :          4 : }
      87                 :            : 
      88                 :            : static void
      89                 :          4 : test_jsonrpc_handler(void)
      90                 :            : {
      91                 :          4 :         struct spdk_jsonrpc_request *request = (struct spdk_jsonrpc_request *)0xdeadbeef;
      92                 :          4 :         struct spdk_json_val method = {};
      93                 :          4 :         struct spdk_json_val params = {};
      94                 :          4 :         char *str = "test";
      95                 :          4 :         struct spdk_rpc_method m = {
      96                 :            :                 .name = "test",
      97                 :            :         };
      98                 :            : 
      99                 :          4 :         struct spdk_rpc_method is_alias_of = {
     100                 :            :                 .name = "aliastest",
     101                 :            :                 .is_deprecated = false,
     102                 :            :                 .deprecation_warning_printed = false,
     103                 :            :                 .func = fn_rpc_method_handler,
     104                 :            :                 .state_mask = SPDK_RPC_STARTUP,
     105                 :            :         };
     106                 :            : 
     107                 :            :         /* Case 1: Method not found */
     108                 :          4 :         method.type = SPDK_JSON_VAL_INVALID;
     109                 :          4 :         jsonrpc_handler(request, &method, &params);
     110                 :          4 :         CU_ASSERT(g_rpc_err == SPDK_JSONRPC_ERROR_METHOD_NOT_FOUND);
     111                 :            : 
     112                 :            :         /* Case 2:  Method is alias */
     113                 :          4 :         method.type = SPDK_JSON_VAL_STRING;
     114                 :          4 :         method.start = str;
     115                 :          4 :         method.len = 4;
     116                 :          4 :         m.is_alias_of = &is_alias_of;
     117                 :          4 :         m.is_deprecated = true;
     118                 :          4 :         m.deprecation_warning_printed = false;
     119                 :          4 :         m.state_mask = SPDK_RPC_STARTUP;
     120                 :          4 :         SLIST_INSERT_HEAD(&g_rpc_methods, &m, slist);
     121                 :            : 
     122                 :            :         /* m->state_mask & g_rpc_state == g_rpc_state */
     123                 :          4 :         g_rpc_err = -1;
     124                 :          4 :         g_rpc_state = SPDK_RPC_STARTUP;
     125                 :          4 :         jsonrpc_handler(request, &method, &params);
     126                 :          4 :         CU_ASSERT(g_rpc_err == 0);
     127                 :            : 
     128                 :            :         /* g_rpc_state == SPDK_RPC_STARTUP */
     129                 :          4 :         is_alias_of.state_mask = SPDK_RPC_RUNTIME;
     130                 :          4 :         g_rpc_err = -1;
     131                 :          4 :         g_rpc_state = SPDK_RPC_STARTUP;
     132                 :          4 :         jsonrpc_handler(request, &method, &params);
     133                 :          4 :         CU_ASSERT(g_rpc_err == SPDK_JSONRPC_ERROR_INVALID_STATE);
     134                 :            : 
     135                 :            :         /* SPDK_RPC_RUNTIME is invalid for the aliastest RPC */
     136                 :          4 :         is_alias_of.state_mask = SPDK_RPC_STARTUP;
     137                 :          4 :         g_rpc_err = -1;
     138                 :          4 :         g_rpc_state = SPDK_RPC_RUNTIME;
     139                 :          4 :         jsonrpc_handler(request, &method, &params);
     140                 :          4 :         CU_ASSERT(g_rpc_err == SPDK_JSONRPC_ERROR_INVALID_STATE);
     141                 :            : 
     142                 :          4 :         SLIST_REMOVE_HEAD(&g_rpc_methods, slist);
     143                 :          4 : }
     144                 :            : 
     145                 :            : static void
     146                 :          4 : test_spdk_rpc_is_method_allowed(void)
     147                 :            : {
     148                 :          4 :         const char method[] = "test";
     149                 :          4 :         uint32_t state_mask = SPDK_RPC_STARTUP, m_state_mask;
     150                 :          4 :         struct spdk_rpc_method m = {};
     151                 :          4 :         int rc = 0;
     152                 :            : 
     153                 :            :         /* Case 1: Expect return -EPERM */
     154                 :          4 :         m.name = method;
     155                 :          4 :         m.state_mask = SPDK_RPC_RUNTIME;
     156                 :          4 :         SLIST_INSERT_HEAD(&g_rpc_methods, &m, slist);
     157                 :          4 :         rc = spdk_rpc_is_method_allowed(method, state_mask);
     158                 :          4 :         CU_ASSERT(rc == -EPERM);
     159                 :          4 :         rc = spdk_rpc_get_method_state_mask(method, &m_state_mask);
     160                 :          4 :         CU_ASSERT(rc == 0);
     161                 :          4 :         CU_ASSERT(m_state_mask == m.state_mask);
     162                 :            : 
     163                 :            :         /* Case 2: Expect return 0 */
     164                 :          4 :         state_mask = SPDK_RPC_RUNTIME;
     165                 :          4 :         rc = spdk_rpc_is_method_allowed(method, state_mask);
     166                 :          4 :         CU_ASSERT(rc == 0);
     167                 :            : 
     168                 :            :         /* Case 3: Expect return -ENOENT */
     169                 :          4 :         SLIST_REMOVE_HEAD(&g_rpc_methods, slist);
     170                 :          4 :         rc = spdk_rpc_is_method_allowed(method, state_mask);
     171                 :          4 :         CU_ASSERT(rc == -ENOENT);
     172                 :          4 :         rc = spdk_rpc_get_method_state_mask(method, &m_state_mask);
     173                 :          4 :         CU_ASSERT(rc == -ENOENT);
     174                 :          4 : }
     175                 :            : 
     176                 :            : static void
     177                 :          4 : test_rpc_get_methods(void)
     178                 :            : {
     179                 :          4 :         struct spdk_jsonrpc_request *request = (struct spdk_jsonrpc_request *)0xbeefbeef;
     180                 :          4 :         struct spdk_json_val params = {};
     181                 :          4 :         struct spdk_rpc_method m = {};
     182                 :            : 
     183                 :            :         /* Case 1: spdk_json_decode_object failed */
     184                 :          4 :         g_rpc_err = -1;
     185                 :          4 :         params.type = SPDK_JSON_VAL_INVALID;
     186                 :          4 :         rpc_get_methods(request, &params);
     187                 :          4 :         CU_ASSERT(g_rpc_err == SPDK_JSONRPC_ERROR_INVALID_PARAMS);
     188                 :            : 
     189                 :            :         /* Case 2: Expect pass */
     190                 :          4 :         params.type = SPDK_JSON_VAL_TRUE;
     191                 :          4 :         m.state_mask = SPDK_RPC_RUNTIME;
     192                 :          4 :         g_rpc_state = SPDK_RPC_STARTUP;
     193                 :          4 :         SLIST_INSERT_HEAD(&g_rpc_methods, &m, slist);
     194                 :          4 :         rpc_get_methods(request, &params);
     195                 :          4 :         SLIST_REMOVE_HEAD(&g_rpc_methods, slist);
     196                 :          4 : }
     197                 :            : 
     198                 :            : static  void
     199                 :          4 : test_rpc_spdk_get_version(void)
     200                 :            : {
     201                 :          4 :         struct spdk_jsonrpc_request *request = (struct spdk_jsonrpc_request *)0xdeadbeef;
     202                 :          4 :         struct spdk_json_val params = {};
     203                 :            : 
     204                 :            :         /* Case 1: spdk_get_version method requires no parameters */
     205                 :          4 :         g_rpc_err = -1;
     206                 :          4 :         params.type = SPDK_JSON_VAL_INVALID;
     207                 :          4 :         rpc_spdk_get_version(request, &params);
     208                 :          4 :         CU_ASSERT(g_rpc_err == SPDK_JSONRPC_ERROR_INVALID_PARAMS);
     209                 :            : 
     210                 :            :         /* Case 2: Expect pass */
     211                 :          4 :         rpc_spdk_get_version(request, NULL);
     212                 :          4 : }
     213                 :            : 
     214                 :            : static void
     215                 :          4 : test_spdk_rpc_listen_close(void)
     216                 :            : {
     217                 :          4 :         const char listen_addr[128] = "/var/tmp/spdk-rpc-ut.sock";
     218                 :          4 :         char rpc_lock_path[128] = {};
     219                 :            : 
     220                 :          4 :         MOCK_SET(open, 1);
     221                 :          4 :         MOCK_SET(close, 0);
     222                 :          4 :         MOCK_SET(flock, 0);
     223                 :            : 
     224                 :          4 :         spdk_rpc_listen(listen_addr);
     225                 :          4 :         snprintf(rpc_lock_path, sizeof(g_rpc_lock_path), "%s.lock",
     226                 :            :                  g_rpc_listen_addr_unix.sun_path);
     227                 :            : 
     228                 :          4 :         CU_ASSERT(g_rpc_listen_addr_unix.sun_family == AF_UNIX);
     229                 :          4 :         CU_ASSERT(strcmp(g_rpc_listen_addr_unix.sun_path, listen_addr) == 0);
     230                 :          4 :         CU_ASSERT(strcmp(g_rpc_lock_path, rpc_lock_path) == 0);
     231                 :          4 :         CU_ASSERT(g_jsonrpc_server == (struct spdk_jsonrpc_server *)0Xdeaddead);
     232                 :            : 
     233                 :          4 :         spdk_rpc_close();
     234                 :            : 
     235                 :          4 :         CU_ASSERT(g_rpc_listen_addr_unix.sun_path[0] == '\0');
     236                 :          4 :         CU_ASSERT(g_jsonrpc_server == NULL);
     237                 :          4 :         CU_ASSERT(g_rpc_lock_fd == -1);
     238                 :          4 :         CU_ASSERT(g_rpc_lock_path[0] == '\0');
     239                 :            : 
     240                 :          4 :         MOCK_CLEAR(open);
     241                 :          4 :         MOCK_CLEAR(close);
     242                 :          4 :         MOCK_CLEAR(flock);
     243                 :          4 : }
     244                 :            : 
     245                 :            : int
     246                 :          4 : main(int argc, char **argv)
     247                 :            : {
     248                 :          4 :         CU_pSuite       suite = NULL;
     249                 :            :         unsigned int    num_failures;
     250                 :            : 
     251                 :          4 :         CU_initialize_registry();
     252                 :            : 
     253                 :          4 :         suite = CU_add_suite("rpc", NULL, NULL);
     254                 :            : 
     255                 :          4 :         CU_ADD_TEST(suite, test_jsonrpc_handler);
     256                 :          4 :         CU_ADD_TEST(suite, test_spdk_rpc_is_method_allowed);
     257                 :          4 :         CU_ADD_TEST(suite, test_rpc_get_methods);
     258                 :          4 :         CU_ADD_TEST(suite, test_rpc_spdk_get_version);
     259                 :          4 :         CU_ADD_TEST(suite, test_spdk_rpc_listen_close);
     260                 :            : 
     261                 :          4 :         num_failures = spdk_ut_run_tests(argc, argv, NULL);
     262                 :          4 :         CU_cleanup_registry();
     263                 :          4 :         return num_failures;
     264                 :            : }

Generated by: LCOV version 1.14