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

   1 /*
   2     test_cases_join.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
  20 #include "execute_tests.h"
  21 #include "test_cases_join.h"
  22 #include "../common/containers.h"
  23 #include "../common/test_step.h"
  24 #include "../common/common_handlers.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 /* Modify this to change the logging level of Meshlink */
  34 #define TEST_MESHLINK_LOG_LEVEL MESHLINK_DEBUG
  35
  36 static void test_case_meshlink_join_01(void **state);
  37 static bool test_meshlink_join_01(void);
  38 static void test_case_meshlink_join_02(void **state);
  39 static bool test_meshlink_join_02(void);
  40 static void test_case_meshlink_join_03(void **state);
  41 static bool test_meshlink_join_03(void);
  42 static void test_case_meshlink_join_04(void **state);
  43 static bool test_meshlink_join_04(void);
  44
  45 /* State structure for join Test Case #1 */
  46 static black_box_state_t test_case_join_01_state = {
  47         .test_case_name = "test_case_join_01",
  48 };
  49
  50 /* State structure for join Test Case #1 */
  51 static black_box_state_t test_case_join_02_state = {
  52         .test_case_name = "test_case_join_02",
  53 };
  54
  55 /* State structure for join Test Case #1 */
  56 static black_box_state_t test_case_join_03_state = {
  57         .test_case_name = "test_case_join_03",
  58 };
  59
  60 static bool join_status;
  61
  62 /* status callback */
  63 static void status_callback(meshlink_handle_t *mesh, meshlink_node_t *source, bool reach) {
  64         (void)mesh;
  65
  66         if(!strcmp(source->name, "relay")) {
  67                 join_status = reach;
  68         }
  69 }
  70
  71 /* Execute join Test Case # 1 - valid case*/
  72 static void test_case_meshlink_join_01(void **state) {
  73         execute_test(test_meshlink_join_01, state);
  74 }
  75
  76 /* Test Steps for meshlink_join Test Case # 1 - Valid case
  77
  78     Test Steps:
  79     1. Generate invite in relay container and run 'relay' node
  80     2. Run NUT
  81     3. Join NUT with relay using invitation generated.
  82
  83     Expected Result:
  84     NUT joins relay using the invitation generated.
  85 */
  86 static bool test_meshlink_join_01(void) {
  87         meshlink_destroy("join_conf.1");
  88         meshlink_destroy("join_conf.2");
  89
  90         // Create node instances
  91         meshlink_handle_t *mesh1 = meshlink_open("join_conf.1", "nut", "test", DEV_CLASS_STATIONARY);
  92         assert(mesh1 != NULL);
  93         meshlink_set_log_cb(mesh1, TEST_MESHLINK_LOG_LEVEL, meshlink_callback_logger);
  94         meshlink_handle_t *mesh2 = meshlink_open("join_conf.2", "relay", "test", DEV_CLASS_STATIONARY);
  95         assert(mesh2 != NULL);
  96         meshlink_set_log_cb(mesh2, TEST_MESHLINK_LOG_LEVEL, meshlink_callback_logger);
  97
  98         // Setting node status callback
  99         meshlink_set_node_status_cb(mesh1, status_callback);
 100
 101         // Inviting nut
 102         meshlink_start(mesh2);
 103         char *invitation = meshlink_invite(mesh2, NULL, "nut");
 104         assert(invitation);
 105
 106         // Joining Node-Under-Test with relay
 107         bool ret = meshlink_join(mesh1, invitation);
 108         assert_int_equal(ret, true);
 109         assert(meshlink_start(mesh1));
 110         sleep(1);
 111
 112         assert_int_equal(join_status, true);
 113
 114         free(invitation);
 115         meshlink_close(mesh1);
 116         meshlink_close(mesh2);
 117         meshlink_destroy("join_conf.1");
 118         meshlink_destroy("join_conf.2");
 119
 120         return true;
 121 }
 122
 123 /* Execute join Test Case # 2 - Invalid case*/
 124 static void test_case_meshlink_join_02(void **state) {
 125         execute_test(test_meshlink_join_02, state);
 126 }
 127
 128 /* Test Steps for meshlink_join Test Case # 2 - Invalid case
 129
 130     Test Steps:
 131     1. Call meshlink_join with NULL as mesh handler argument.
 132
 133     Expected Result:
 134     report error accordingly when NULL is passed as mesh handle argument
 135 */
 136 static bool test_meshlink_join_02(void) {
 137         meshlink_destroy("join_conf.3");
 138
 139         // Create node instances
 140         meshlink_handle_t *mesh1 = meshlink_open("join_conf.3", "nut", "test", DEV_CLASS_STATIONARY);
 141         assert(mesh1 != NULL);
 142         meshlink_set_log_cb(mesh1, TEST_MESHLINK_LOG_LEVEL, meshlink_callback_logger);
 143
 144         char *invitation = meshlink_invite(mesh1, NULL, "nodex");
 145
 146         /* meshlink_join called with NULL as mesh handle and with valid invitation */
 147         bool ret = meshlink_join(NULL, invitation);
 148         assert_int_equal(ret, false);
 149
 150         free(invitation);
 151         meshlink_close(mesh1);
 152         meshlink_destroy("join_conf.3");
 153
 154         return true;
 155 }
 156
 157 /* Execute join Test Case # 3- Invalid case*/
 158 static void test_case_meshlink_join_03(void **state) {
 159         execute_test(test_meshlink_join_03, state);
 160 }
 161
 162 /* Test Steps for meshlink_join Test Case # 3 - Invalid case
 163
 164     Test Steps:
 165     1. Run NUT
 166     1. Call meshlink_join with NULL as invitation argument.
 167
 168     Expected Result:
 169     Report error accordingly when NULL is passed as invite argument
 170 */
 171 static bool test_meshlink_join_03(void) {
 172         meshlink_destroy("joinconf.4");
 173         meshlink_set_log_cb(NULL, TEST_MESHLINK_LOG_LEVEL, meshlink_callback_logger);
 174
 175         /* Create meshlink instance */
 176         mesh_handle = meshlink_open("joinconf.4", "nut", "node_sim", 1);
 177         assert(mesh_handle);
 178         meshlink_set_log_cb(mesh_handle, TEST_MESHLINK_LOG_LEVEL, meshlink_callback_logger);
 179
 180         /* Passing NULL as invitation to join API*/
 181         bool ret  = meshlink_join(mesh_handle, NULL);
 182         assert_int_equal(ret, false);
 183
 184         meshlink_close(mesh_handle);
 185         meshlink_destroy("joinconf.4");
 186         return true;
 187 }
 188
 189 int test_meshlink_join(void) {
 190         const struct CMUnitTest blackbox_join_tests[] = {
 191                 cmocka_unit_test_prestate_setup_teardown(test_case_meshlink_join_01, NULL, NULL,
 192                                 (void *)&test_case_join_01_state),
 193                 cmocka_unit_test_prestate_setup_teardown(test_case_meshlink_join_02, NULL, NULL,
 194                                 (void *)&test_case_join_02_state),
 195                 cmocka_unit_test_prestate_setup_teardown(test_case_meshlink_join_03, NULL, NULL,
 196                                 (void *)&test_case_join_03_state)
 197         };
 198         total_tests += sizeof(blackbox_join_tests) / sizeof(blackbox_join_tests[0]);
 199
 200         int failed = cmocka_run_group_tests(blackbox_join_tests, NULL, NULL);
 201
 202         return failed;
 203 }
 204