Merge pull request #146 from HowJMay/test_driver_redisgn

fix(driver): Redesign test driver for target tx disapearing

Author: Wu Yu Wei

accelerator/errors.h

@@ -75,6 +75,10 @@ typedef enum {
   /**< flex_trits conversion error */
   SC_CCLIENT_HASH = 0x06 | SC_MODULE_CCLIENT | SC_SEVERITY_MAJOR,
   /**< hash container operation error */
+  SC_CCLIENT_JSON_KEY = 0x07 | SC_MODULE_CCLIENT | SC_SEVERITY_MAJOR,
+  /**< JSON key not found */
+  SC_CCLIENT_JSON_PARSE = 0x08 | SC_MODULE_CCLIENT | SC_SEVERITY_MAJOR,
+  /**< json parsing error, might the wrong format */
 
   // Serializer module
   SC_SERIALIZER_JSON_CREATE = 0x01 | SC_MODULE_SERIALIZER | SC_SEVERITY_FATAL,

serializer/serializer.c

@@ -6,9 +6,9 @@ void fill_tag(char* new_tag, char* old_tag, size_t tag_len) {
   sprintf(new_tag, "%s%*.*s", old_tag, pad_len, pad_len, nines);
 }
 
-status_t ta_hash243_stack_to_json_array(hash243_stack_t stack,
-                                        cJSON* const json_root,
-                                        char const* const obj_name) {
+static status_t ta_hash243_stack_to_json_array(hash243_stack_t stack,
+                                               cJSON* const json_root,
+                                               char const* const obj_name) {
   size_t array_count = 0;
   cJSON* array_obj = NULL;
   hash243_stack_entry_t* s_iter = NULL;
@@ -41,9 +41,9 @@ status_t ta_hash243_stack_to_json_array(hash243_stack_t stack,
   return SC_OK;
 }
 
-status_t ta_hash243_queue_to_json_array(hash243_queue_t queue,
-                                        cJSON* const json_root,
-                                        char const* const obj_name) {
+static status_t ta_hash243_queue_to_json_array(hash243_queue_t queue,
+                                               cJSON* const json_root,
+                                               char const* const obj_name) {
   size_t array_count;
   cJSON* array_obj = NULL;
   hash243_queue_entry_t* q_iter = NULL;
@@ -75,6 +75,28 @@ status_t ta_hash243_queue_to_json_array(hash243_queue_t queue,
   return SC_OK;
 }
 
+static status_t ta_json_get_string(cJSON const* const json_obj,
+                                   char const* const obj_name,
+                                   char* const text) {
+  status_t ret = SC_OK;
+  if (json_obj == NULL || obj_name == NULL || text == NULL) {
+    return SC_SERIALIZER_NULL;
+  }
+
+  cJSON* json_value = cJSON_GetObjectItemCaseSensitive(json_obj, obj_name);
+  if (json_value == NULL) {
+    return SC_CCLIENT_JSON_KEY;
+  }
+
+  if (cJSON_IsString(json_value) && (json_value->valuestring != NULL)) {
+    strcpy(text, json_value->valuestring);
+  } else {
+    return SC_CCLIENT_JSON_PARSE;
+  }
+
+  return ret;
+}
+
 status_t iota_transaction_to_json_object(iota_transaction_t const* const txn,
                                          cJSON** txn_json) {
   if (txn == NULL) {
@@ -431,6 +453,37 @@ status_t send_mam_res_serialize(char** obj, const send_mam_res_t* const res) {
   return ret;
 }
 
+status_t send_mam_res_deserialize(const char* const obj,
+                                  send_mam_res_t* const res) {
+  if (obj == NULL) {
+    return SC_SERIALIZER_NULL;
+  }
+  cJSON* json_obj = cJSON_Parse(obj);
+  status_t ret = SC_OK;
+  tryte_t addr[NUM_TRYTES_ADDRESS + 1];
+
+  if (json_obj == NULL) {
+    ret = SC_SERIALIZER_JSON_PARSE;
+    goto done;
+  }
+
+  if (ta_json_get_string(json_obj, "channel", (char*)addr) != SC_OK) {
+    ret = SC_SERIALIZER_NULL;
+    goto done;
+  }
+  send_mam_res_set_channel_id(res, addr);
+
+  if (ta_json_get_string(json_obj, "bundle_hash", (char*)addr) != SC_OK) {
+    ret = SC_SERIALIZER_NULL;
+    goto done;
+  }
+  send_mam_res_set_bundle_hash(res, addr);
+
+done:
+  cJSON_Delete(json_obj);
+  return ret;
+}
+
 status_t send_mam_req_deserialize(const char* const obj, send_mam_req_t* req) {
   if (obj == NULL) {
     return SC_SERIALIZER_NULL;

serializer/serializer.h

@@ -136,6 +136,19 @@ status_t receive_mam_message_serialize(char** obj, const char** res);
  */
 status_t send_mam_res_serialize(char** obj, const send_mam_res_t* const res);
 
+/**
+ * @brief Deserialze JSON string to type of send_mam_res_t
+ *
+ * @param[in] obj Input values in JSON
+ * @param[out] res Response data in type of send_mam_res_t
+ *
+ * @return
+ * - SC_OK on success
+ * - non-zero on error
+ */
+status_t send_mam_res_deserialize(const char* const obj,
+                                  send_mam_res_t* const res);
+
 /**
  * @brief Deserialze JSON string to type of send_mam_req_t
  *

tests/driver.c

@@ -5,12 +5,23 @@
 static ta_core_t ta_core;
 struct timespec start_time, end_time;
 
+char driver_tag_msg[NUM_TRYTES_TAG];
+send_mam_res_t* res;
+
 #if defined(ENABLE_STAT)
 #define TEST_COUNT 100
 #else
 #define TEST_COUNT 1
 #endif
 
+static void gen_rand_tag(char* tag) {
+  const char tryte_alpahbet[] = "NOPQRSTUVWXYZ9ABCDEFGHIJKLM";
+
+  for (int i = 0; i < NUM_TRYTES_TAG; i++) {
+    tag[i] = tryte_alpahbet[rand() % 27];
+  }
+}
+
 double diff_time(struct timespec start, struct timespec end) {
   struct timespec diff;
   if (end.tv_nsec - start.tv_nsec < 0) {
@@ -81,14 +92,19 @@ void test_get_tips(void) {
 }
 
 void test_send_transfer(void) {
-  const char* json =
+  const char* pre_json =
       "{\"value\":100,"
-      "\"message\":\"" TAG_MSG "\",\"tag\":\"" TAG_MSG
-      "\","
+      "\"message\":\"" TAG_MSG
+      "\",\"tag\":\"%s\","
       "\"address\":\"" TRYTES_81_1 "\"}";
   char* json_result;
   double sum = 0;
 
+  gen_rand_tag(driver_tag_msg);
+  int json_len = strlen(pre_json);
+  char json[json_len + NUM_TRYTES_TAG];
+  sprintf(json, pre_json, driver_tag_msg);
+
   for (size_t count = 0; count < TEST_COUNT; count++) {
     test_time_start(&start_time);
     TEST_ASSERT_EQUAL_INT32(
@@ -123,7 +139,7 @@ void test_find_transactions_by_tag(void) {
     test_time_start(&start_time);
 
     TEST_ASSERT_EQUAL_INT32(
-        SC_OK, api_find_transactions_by_tag(&ta_core.service, FIND_TAG_MSG,
+        SC_OK, api_find_transactions_by_tag(&ta_core.service, driver_tag_msg,
                                             &json_result));
     test_time_end(&start_time, &end_time, &sum);
     free(json_result);
@@ -139,8 +155,8 @@ void test_find_transactions_obj_by_tag(void) {
     test_time_start(&start_time);
 
     TEST_ASSERT_EQUAL_INT32(
-        SC_OK, api_find_transactions_obj_by_tag(&ta_core.service, FIND_TAG_MSG,
-                                                &json_result));
+        SC_OK, api_find_transactions_obj_by_tag(&ta_core.service,
+                                                driver_tag_msg, &json_result));
     test_time_end(&start_time, &end_time, &sum);
     free(json_result);
   }
@@ -151,12 +167,15 @@ void test_send_mam_message(void) {
   double sum = 0;
   const char* json = "{\"message\":\"" TEST_PAYLOAD "\"}";
   char* json_result;
+  res = send_mam_res_new();
 
   for (size_t count = 0; count < TEST_COUNT; count++) {
     test_time_start(&start_time);
     TEST_ASSERT_EQUAL_INT32(
         SC_OK, api_mam_send_message(&ta_core.tangle, &ta_core.service, json,
                                     &json_result));
+    send_mam_res_deserialize(json_result, res);
+
     test_time_end(&start_time, &end_time, &sum);
     free(json_result);
   }
@@ -171,15 +190,17 @@ void test_receive_mam_message(void) {
     test_time_start(&start_time);
 
     TEST_ASSERT_EQUAL_INT32(
-        SC_OK, api_receive_mam_message(&ta_core.service, TEST_BUNDLE_HASH,
-                                       &json_result));
+        SC_OK, api_receive_mam_message(&ta_core.service,
+                                       (char*)res->bundle_hash, &json_result));
     test_time_end(&start_time, &end_time, &sum);
     free(json_result);
   }
   printf("Average time of receive_mam_message: %lf\n", sum / TEST_COUNT);
 }
 
 int main(void) {
+  srand(time(NULL));
+
   UNITY_BEGIN();
 
   ta_config_default_init(&ta_core.info, &ta_core.tangle, &ta_core.cache,
@@ -194,8 +215,8 @@ int main(void) {
   RUN_TEST(test_get_transaction_object);
   RUN_TEST(test_find_transactions_by_tag);
   RUN_TEST(test_find_transactions_obj_by_tag);
-  RUN_TEST(test_receive_mam_message);
   RUN_TEST(test_send_mam_message);
+  RUN_TEST(test_receive_mam_message);
   ta_config_destroy(&ta_core.service);
   return UNITY_END();
 }

tests/test_serializer.c

@@ -269,6 +269,20 @@ void test_serialize_send_mam_message(void) {
   send_mam_res_free(&res);
 }
 
+void test_deserialize_send_mam_message_response(void) {
+  const char* json = "{\"channel\":\"" TRYTES_81_1
+                     "\","
+                     "\"bundle_hash\":\"" TRYTES_81_2 "\"}";
+  send_mam_res_t* res = send_mam_res_new();
+
+  send_mam_res_deserialize(json, res);
+
+  TEST_ASSERT_EQUAL_STRING(TRYTES_81_1, res->channel_id);
+  TEST_ASSERT_EQUAL_STRING(TRYTES_81_2, res->bundle_hash);
+
+  send_mam_res_free(&res);
+}
+
 void test_deserialize_send_mam_message(void) {
   const char* json = "{\"message\":\"" TEST_PAYLOAD "\"}";
   send_mam_req_t* req = send_mam_req_new();
@@ -296,6 +310,7 @@ int main(void) {
   RUN_TEST(test_serialize_ta_find_transactions_by_tag);
   RUN_TEST(test_serialize_ta_find_transactions_obj_by_tag);
   RUN_TEST(test_serialize_send_mam_message);
+  RUN_TEST(test_deserialize_send_mam_message_response);
   RUN_TEST(test_deserialize_send_mam_message);
   return UNITY_END();
 }