MQTT Test: Add FRTest_GenerateRandInt and MqttTestGetTimeMs. (#51)

* Add pGetTimeMs in MqttTestParam_t and add FRTest_GenerateRandInt in platform_function.h

* Add MQTT_TEST_CLIENT_IDENTIFIER for mqtt test.

Author: ActoryOu

config_template/test_param_config_template.h

@@ -50,6 +50,19 @@
  * #define MQTT_SERVER_PORT       (8883)
  */
 
+/**
+ * @brief The client identifier for MQTT test.
+ *
+ * #define MQTT_TEST_CLIENT_IDENTIFIER    "PLACE_HOLDER"
+ */
+
+ /**
+ * @brief Network buffer size specified in bytes. Must be large enough to hold the maximum
+ * anticipated MQTT payload.
+ *
+ * #define MQTT_TEST_NETWORK_BUFFER_SIZE  ( 5000 )
+ */
+
 /**
  * @brief Root certificate of the IoT Core.
  *

src/common/platform_function.h

@@ -85,4 +85,11 @@ void * FRTest_MemoryAlloc( size_t size );
  */
 void FRTest_MemoryFree( void * ptr );
 
+/**
+ * @brief To generate random number in INT format.
+ *
+ * @return A random number.
+ */
+int FRTest_GenerateRandInt();
+
 #endif /* PLATFORM_FUNCTION_H */

src/mqtt/mqtt_test.c

@@ -33,10 +33,9 @@
 #include <string.h>
 #include <time.h>
 #include <unistd.h>
-#include "demo_config.h"
+#include <stdio.h>
 #include "core_mqtt.h"
 #include "core_mqtt_state.h"
-#include "clock.h"
 #include "unity.h"
 #include "unity_fixture.h"
 
@@ -90,12 +89,12 @@
 /**
  * @brief Sample topic filter to subscribe to.
  */
-#define TEST_MQTT_TOPIC                         CLIENT_IDENTIFIER "/iot/integration/test"
+#define TEST_MQTT_TOPIC                         MQTT_TEST_CLIENT_IDENTIFIER "/iot/integration/test"
 
 /**
  * @brief Sample topic filter to test MQTT retainted message.
  */
-#define TEST_MQTT_RETAIN_TOPIC                  CLIENT_IDENTIFIER "/iot/integration/testretain"
+#define TEST_MQTT_RETAIN_TOPIC                  MQTT_TEST_CLIENT_IDENTIFIER "/iot/integration/testretain"
 
 /**
  * @brief Length of sample topic filter.
@@ -105,27 +104,22 @@
 /**
  * @brief Sample topic filter to subscribe to.
  */
-#define TEST_MQTT_LWT_TOPIC                     CLIENT_IDENTIFIER "/iot/integration/test/lwt"
+#define TEST_MQTT_LWT_TOPIC                     MQTT_TEST_CLIENT_IDENTIFIER "/iot/integration/test/lwt"
 
 /**
  * @brief Length of sample topic filter.
  */
 #define TEST_MQTT_LWT_TOPIC_LENGTH              ( sizeof( TEST_MQTT_LWT_TOPIC ) - 1 )
 
-/**
- * @brief Client identifier for MQTT session in the tests.
- */
-#define TEST_CLIENT_IDENTIFIER                  CLIENT_IDENTIFIER
-
 /**
  * @brief Length of the client identifier.
  */
-#define TEST_CLIENT_IDENTIFIER_LENGTH           ( sizeof( TEST_CLIENT_IDENTIFIER ) - 1u )
+#define TEST_CLIENT_IDENTIFIER_LENGTH           ( sizeof( MQTT_TEST_CLIENT_IDENTIFIER ) - 1u )
 
 /**
  * @brief Client identifier for use in LWT tests.
  */
-#define TEST_CLIENT_IDENTIFIER_LWT              CLIENT_IDENTIFIER "-LWT"
+#define TEST_CLIENT_IDENTIFIER_LWT              MQTT_TEST_CLIENT_IDENTIFIER "-LWT"
 
 /**
  * @brief Length of LWT client identifier.
@@ -378,7 +372,7 @@ static void establishMqttSession( MQTTContext_t * pContext,
     assert( pContext != NULL );
 
     /* The network buffer must remain valid for the lifetime of the MQTT context. */
-    static uint8_t buffer[ NETWORK_BUFFER_SIZE ];
+    static uint8_t buffer[ MQTT_TEST_NETWORK_BUFFER_SIZE ];
 
     /* Buffer for storing client ID with random integer.
      * Note: Size value is chosen to accommodate both LWT and non-LWT client ID
@@ -388,7 +382,7 @@ static void establishMqttSession( MQTTContext_t * pContext,
 
     /* Fill the values for network buffer. */
     networkBuffer.pBuffer = buffer;
-    networkBuffer.size = NETWORK_BUFFER_SIZE;
+    networkBuffer.size = MQTT_TEST_NETWORK_BUFFER_SIZE;
 
     transport.pNetworkContext = pNetworkContext;
     transport.send = testParam.pTransport->send;
@@ -400,7 +394,7 @@ static void establishMqttSession( MQTTContext_t * pContext,
         /* Initialize MQTT library. */
         TEST_ASSERT_EQUAL( MQTTSuccess, MQTT_Init( pContext,
                                                    &transport,
-                                                   Clock_GetTimeMs,
+                                                   testParam.pGetTimeMs,
                                                    eventCallback,
                                                    &networkBuffer ) );
     }
@@ -426,7 +420,7 @@ static void establishMqttSession( MQTTContext_t * pContext,
             snprintf( clientIdBuffer,
                       sizeof( clientIdBuffer ),
                       "%d%s", clientIdRandNumber,
-                      TEST_CLIENT_IDENTIFIER );
+                      MQTT_TEST_CLIENT_IDENTIFIER );
         connectInfo.pClientIdentifier = clientIdBuffer;
     }
 
@@ -749,8 +743,6 @@ static MQTTStatus_t publishToTopic( MQTTContext_t * pContext,
  */
 TEST_SETUP( MqttTest )
 {
-    struct timespec tp;
-
     /* Reset file-scoped global variables. */
     receivedSubAck = false;
     receivedUnsubAck = false;
@@ -764,14 +756,8 @@ TEST_SETUP( MqttTest )
     packetTypeForDisconnection = MQTT_PACKET_TYPE_INVALID;
     memset( &incomingInfo, 0u, sizeof( MQTTPublishInfo_t ) );
 
-    /* Get current time to seed pseudo random number generator. */
-    ( void ) clock_gettime( CLOCK_REALTIME, &tp );
-
-    /* Seed pseudo random number generator with nanoseconds. */
-    srand( tp.tv_nsec );
-
     /* Generate a random number to use in the client identifier. */
-    clientIdRandNumber = ( rand() % ( MAX_RAND_NUMBER_FOR_CLIENT_ID + 1u ) );
+    clientIdRandNumber = ( FRTest_GenerateRandInt() % ( MAX_RAND_NUMBER_FOR_CLIENT_ID + 1u ) );
 
     /* Establish a TCP connection with the server endpoint, then
      * establish TLS session on top of TCP connection. */

src/mqtt/mqtt_test.h

@@ -29,6 +29,7 @@
 
 #include "transport_interface.h"
 #include "network_connection.h"
+#include "core_mqtt.h"
 
 typedef struct MqttTestParam
 {
@@ -38,6 +39,7 @@ typedef struct MqttTestParam
     void * pNetworkCredentials;
     void * pNetworkContext;
     void * pSecondNetworkContext;
+    MQTTGetCurrentTimeFunc_t pGetTimeMs; /**< @brief The getTimeFunction for MQTT_Init API. */
 } MqttTestParam_t;
 
 /**