git.meshlink.io Git - meshlink/blob - test/blackbox/run_blackbox_tests/test_cases_rec_cb.c

   1 /*
   2     test_cases_rec_cb.c -- Execution of specific meshlink black box test cases
   3     Copyright (C) 2018  Guus Sliepen <guus@meshlink.io>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License along
  16     with this program; if not, write to the Free Software Foundation, Inc.,
  17     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19 #include "execute_tests.h"
  20 #include "test_cases.h"
  21 #include "../common/containers.h"
  22 #include "../common/test_step.h"
  23 #include "../common/common_handlers.h"
  24 #include "test_cases_rec_cb.h"
  25 #include <assert.h>
  26 #include <string.h>
  27 #include <stdlib.h>
  28 #include <stdarg.h>
  29 #include <setjmp.h>
  30 #include <cmocka.h>
  31 #include <pthread.h>
  32
  33
  34 /* Modify this to change the logging level of Meshlink */
  35 #define TEST_MESHLINK_LOG_LEVEL MESHLINK_DEBUG
  36
  37 static void test_case_set_rec_cb_01(void **state);
  38 static bool test_set_rec_cb_01(void);
  39 static void test_case_set_rec_cb_02(void **state);
  40 static bool test_set_rec_cb_02(void);
  41 static void test_case_set_rec_cb_03(void **state);
  42 static bool test_set_rec_cb_03(void);
  43
  44 /* Test Steps for meshlink_set_receive_cb Test Case #1 */
  45 static black_box_state_t test_case_set_rec_cb_01_state = {
  46         .test_case_name = "test_case_set_rec_cb_01",
  47 };
  48
  49 /* Test Steps for meshlink_set_receive_cb Test Case #2 */
  50 static black_box_state_t test_case_set_rec_cb_02_state = {
  51         .test_case_name = "test_case_set_rec_cb_02",
  52 };
  53
  54 /* Test Steps for meshlink_set_receive_cb Test Case #3 */
  55 static black_box_state_t test_case_set_rec_cb_03_state = {
  56         .test_case_name = "test_case_set_rec_cb_03",
  57 };
  58
  59 static bool received;
  60
  61 /* mutex for the common variable */
  62 pthread_mutex_t lock;
  63
  64 /* receive callback function */
  65 static void rec_cb(meshlink_handle_t *mesh, meshlink_node_t *source, const void *data, size_t len) {
  66         (void)mesh;
  67         (void)source;
  68
  69         assert(len);
  70
  71         pthread_mutex_lock(&lock);
  72
  73         if(len == 5 && !memcmp(data, "test", 5)) {
  74                 received = true;
  75         }
  76
  77         pthread_mutex_unlock(&lock);
  78 }
  79
  80 /* Execute meshlink_set_receive_cb Test Case # 1 - Valid case */
  81 static void test_case_set_rec_cb_01(void **state) {
  82         execute_test(test_set_rec_cb_01, state);
  83 }
  84 /* Test Steps for meshlink_set_receive_cb Test Case # 1
  85
  86     Test Steps:
  87     1. Open NUT
  88     2. Set receive callback for the NUT
  89     3. Echo NUT with some data.
  90
  91     Expected Result:
  92     Receive callback should be invoked when NUT echoes or sends data for itself.
  93 */
  94 static bool test_set_rec_cb_01(void) {
  95         meshlink_set_log_cb(NULL, TEST_MESHLINK_LOG_LEVEL, meshlink_callback_logger);
  96
  97         /* Create meshlink instance */
  98         meshlink_handle_t *mesh_handle = meshlink_open("set_receive_cb_conf", "nut", "test", 1);
  99         assert(mesh_handle);
 100         meshlink_set_receive_cb(mesh_handle, rec_cb);
 101         meshlink_set_log_cb(mesh_handle, TEST_MESHLINK_LOG_LEVEL, meshlink_callback_logger);
 102
 103         assert(meshlink_start(mesh_handle));
 104         sleep(1);
 105
 106         pthread_mutex_lock(&lock);
 107         received = false;
 108         pthread_mutex_unlock(&lock);
 109         meshlink_node_t *node_handle = meshlink_get_self(mesh_handle);
 110         assert(node_handle);
 111         assert(meshlink_send(mesh_handle, node_handle, "test", 5));
 112         sleep(1);
 113
 114         pthread_mutex_lock(&lock);
 115         assert_int_equal(received, true);
 116         pthread_mutex_unlock(&lock);
 117
 118         meshlink_close(mesh_handle);
 119         meshlink_destroy("set_receive_cb_conf");
 120         return true;
 121 }
 122
 123
 124 /* Execute meshlink_set_receive_cb Test Case # 2 - Invalid case */
 125 static void test_case_set_rec_cb_02(void **state) {
 126         execute_test(test_set_rec_cb_02, state);
 127 }
 128 /* Test Steps for meshlink_set_receive_cb Test Case # 2
 129
 130     Test Steps:
 131     1. Call meshlink_set_receive_cb with NULL as mesh handle argument
 132
 133     Expected Result:
 134     meshlink_set_receive_cb API reports proper error accordingly.
 135 */
 136 static bool test_set_rec_cb_02(void) {
 137         meshlink_set_log_cb(NULL, TEST_MESHLINK_LOG_LEVEL, meshlink_callback_logger);
 138
 139         // Setting receive callback with NULL as mesh handle
 140         meshlink_set_receive_cb(NULL, rec_cb);
 141         assert_int_equal(meshlink_errno, MESHLINK_EINVAL);
 142
 143         return true;
 144 }
 145
 146 /* Execute meshlink_set_receive_cb Test Case # 3 - Functionality Test, Trying to set receive call back after
 147       starting the mesh */
 148 static void test_case_set_rec_cb_03(void **state) {
 149         execute_test(test_set_rec_cb_03, state);
 150 }
 151 /* Test Steps for meshlink_set_receive_cb Test Case # 3
 152
 153     Test Steps:
 154     1. Open NUT
 155     2. Starting mesh
 156     2. Set receive callback for the NUT
 157     3. Echo NUT with some data.
 158
 159     Expected Result:
 160     Receive callback can be invoked when NUT echoes or sends data for itself
 161 */
 162 static bool test_set_rec_cb_03(void) {
 163         meshlink_set_log_cb(NULL, TEST_MESHLINK_LOG_LEVEL, meshlink_callback_logger);
 164
 165         /* Create meshlink instance */
 166         meshlink_handle_t *mesh_handle = meshlink_open("set_receive_cb_conf", "nut", "test", 1);
 167         assert(mesh_handle);
 168         meshlink_set_log_cb(mesh_handle, TEST_MESHLINK_LOG_LEVEL, meshlink_callback_logger);
 169
 170         assert(meshlink_start(mesh_handle));
 171         sleep(1);
 172         meshlink_set_receive_cb(mesh_handle, rec_cb);
 173
 174         pthread_mutex_lock(&lock);
 175         received = false;
 176         pthread_mutex_unlock(&lock);
 177         meshlink_node_t *node_handle = meshlink_get_self(mesh_handle);
 178         assert(node_handle);
 179         assert(meshlink_send(mesh_handle, node_handle, "test", 5));
 180         sleep(1);
 181
 182         pthread_mutex_lock(&lock);
 183         assert_int_equal(received, true);
 184         pthread_mutex_unlock(&lock);
 185
 186         meshlink_close(mesh_handle);
 187         meshlink_destroy("set_receive_cb_conf");
 188         return true;
 189 }
 190
 191 int test_meshlink_set_receive_cb(void) {
 192         const struct CMUnitTest blackbox_receive_tests[] = {
 193                 cmocka_unit_test_prestate_setup_teardown(test_case_set_rec_cb_01, NULL, NULL,
 194                                 (void *)&test_case_set_rec_cb_01_state),
 195                 cmocka_unit_test_prestate_setup_teardown(test_case_set_rec_cb_02, NULL, NULL,
 196                                 (void *)&test_case_set_rec_cb_02_state),
 197                 cmocka_unit_test_prestate_setup_teardown(test_case_set_rec_cb_03, NULL, NULL,
 198                                 (void *)&test_case_set_rec_cb_03_state)
 199         };
 200         total_tests += sizeof(blackbox_receive_tests) / sizeof(blackbox_receive_tests[0]);
 201
 202         assert(pthread_mutex_init(&lock, NULL) == 0);
 203         int failed = cmocka_run_group_tests(blackbox_receive_tests, NULL, NULL);
 204         assert(pthread_mutex_destroy(&lock) == 0);
 205
 206         return failed;
 207 }