aws-iot-mock: Add subset of functionalities

This commit expands mock coverage across the FRI codebase, adding and
modifying existing mocks.
The mocks added are intended to support testing of `ota_agent_task.c`.

Signed-off-by: Reuben Cartwright <[email protected]>

Author: RC-Repositories

applications/helpers/events/mocks/inc/events.h

@@ -7,6 +7,7 @@
 #define EVENT_H
 
 #include "fff.h"
+#include <stdbool.h>
 
 #define EVENT_MASK_MQTT_INIT         0x02
 #define EVENT_MASK_MQTT_CONNECTED    0x04
@@ -15,6 +16,11 @@ typedef void * EventGroupHandle_t;
 
 extern EventGroupHandle_t xSystemEvents;
 
+DECLARE_FAKE_VALUE_FUNC( bool,
+                         xIsMqttAgentConnected );
 DECLARE_FAKE_VOID_FUNC( vWaitUntilNetworkIsUp );
+DECLARE_FAKE_VOID_FUNC( vWaitUntilMQTTAgentReady );
+DECLARE_FAKE_VOID_FUNC( vWaitUntilMQTTAgentConnected );
+
 
 #endif /* EVENT_H */

applications/helpers/events/mocks/src/events.c

@@ -7,4 +7,8 @@
 
 EventGroupHandle_t xSystemEvents;
 
+DEFINE_FAKE_VALUE_FUNC( bool,
+                        xIsMqttAgentConnected );
 DEFINE_FAKE_VOID_FUNC( vWaitUntilNetworkIsUp );
+DEFINE_FAKE_VOID_FUNC( vWaitUntilMQTTAgentReady );
+DEFINE_FAKE_VOID_FUNC( vWaitUntilMQTTAgentConnected );

components/aws_iot/coremqtt/library_mocks/inc/core_mqtt_serializer.h

@@ -33,7 +33,8 @@ typedef enum MQTTStatus
 {
     MQTTSuccess = 0,
     MQTTBadParameter,
-    MQTTSendFailed
+    MQTTSendFailed,
+    MQTTRecvFailed
 } MQTTStatus_t;
 
 typedef struct MQTTConnectInfo

components/aws_iot/coremqtt_agent/integration/integration_mocks/CMakeLists.txt

@@ -5,6 +5,7 @@
 add_library(coremqtt-agent-integration-mock
     src/freertos_agent_message.c
     src/freertos_command_pool.c
+    src/mqtt_agent_task.c
     src/subscription_manager.c
 )
 

components/aws_iot/coremqtt_agent/integration/integration_mocks/inc/mqtt_agent_task.h

@@ -0,0 +1,45 @@
+/*
+ * FreeRTOS V202012.00
+ * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
+ * Copyright 2023-2024 Arm Limited and/or its affiliates
+ * <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * https://www.FreeRTOS.org
+ * https://github.com/FreeRTOS
+ *
+ */
+
+#ifndef MQTT_AGENT_H
+#define MQTT_AGENT_H
+
+#include "core_mqtt.h"
+#include "core_mqtt_agent.h"
+#include "task.h"
+
+struct MQTTAgentCommandContext
+{
+    MQTTStatus_t xReturnStatus;
+    TaskHandle_t xTaskToNotify;
+    void * pArgs;
+};
+
+extern MQTTAgentContext_t xGlobalMqttAgentContext;
+
+#endif /* MQTT_AGENT_H */

components/aws_iot/coremqtt_agent/integration/integration_mocks/inc/subscription_manager.h

@@ -44,6 +44,15 @@ typedef struct SubscriptionElement
     #define SUBSCRIPTION_MANAGER_MAX_SUBSCRIPTIONS    10U
 #endif
 
+typedef void (* IncomingPubCallback_t)( void * pvIncomingPublishCallbackContext,
+                                        MQTTPublishInfo_t * pxPublishInfo );
+
+DECLARE_FAKE_VALUE_FUNC( bool,
+                         addSubscription,
+                         const char *,
+                         uint16_t,
+                         IncomingPubCallback_t,
+                         void * );
 DECLARE_FAKE_VOID_FUNC( removeSubscription,
                         const char *,
                         uint16_t );

components/aws_iot/coremqtt_agent/integration/integration_mocks/src/mqtt_agent_task.c

@@ -0,0 +1,31 @@
+/*
+ * FreeRTOS V202012.00
+ * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
+ * Copyright 2023-2024 Arm Limited and/or its affiliates
+ * <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * https://www.FreeRTOS.org
+ * https://github.com/FreeRTOS
+ *
+ */
+
+#include "mqtt_agent_task.h"
+
+MQTTAgentContext_t xGlobalMqttAgentContext;

components/aws_iot/coremqtt_agent/integration/integration_mocks/src/subscription_manager.c

@@ -26,8 +26,15 @@
  *
  */
 
+#include "fff.h"
 #include "subscription_manager.h"
 
+DEFINE_FAKE_VALUE_FUNC( bool,
+                        addSubscription,
+                        const char *,
+                        uint16_t,
+                        IncomingPubCallback_t,
+                        void * );
 DEFINE_FAKE_VOID_FUNC( removeSubscription,
                        const char *,
                        uint16_t );

components/aws_iot/coremqtt_agent/integration/tests/test_mqtt_agent_task.cpp

@@ -541,7 +541,7 @@ TEST_F( TestMqttAgentTask, Publish_callback_calls_publish_handler )
 
     EXPECT_EQ( handleIncomingPublishes_fake.call_count, 0 );
     int dummy = 5;
-    MQTTAgentContext_t mqttAgentContext = { &dummy };
+    MQTTAgentContext_t mqttAgentContext = { nullptr, &dummy };
     uint16_t dummyId = 10;
     MQTTPublishInfo_t xPublishInfo;
     xPublishInfo.qos = MQTTQoS0;
@@ -561,7 +561,7 @@ TEST_F( TestMqttAgentTask, Publish_callback_does_not_error_if_publish_handled )
     handleIncomingPublishes_fake.return_val = handled;
 
     int dummy = 5;
-    MQTTAgentContext_t mqttAgentContext = { &dummy };
+    MQTTAgentContext_t mqttAgentContext = { nullptr, &dummy };
     uint16_t dummyId = 10;
     MQTTPublishInfo_t xPublishInfo;
     xPublishInfo.qos = MQTTQoS0;
@@ -581,7 +581,7 @@ TEST_F( TestMqttAgentTask, Publish_callback_generates_log_if_handler_fails )
     handleIncomingPublishes_fake.return_val = handled;
 
     int dummy = 5;
-    MQTTAgentContext_t mqttAgentContext = { &dummy };
+    MQTTAgentContext_t mqttAgentContext = { nullptr, &dummy };
     uint16_t dummyId = 10;
     MQTTPublishInfo_t xPublishInfo;
     xPublishInfo.qos = MQTTQoS0;

components/aws_iot/coremqtt_agent/library_mocks/inc/core_mqtt_agent.h

@@ -41,6 +41,7 @@ typedef struct MQTTAgentCommand MQTTAgentCommand_t;
 
 typedef struct MQTTAgentContext
 {
+    MQTTAgentCommand_t * pArgs;
     void * mqttContext;
 } MQTTAgentContext_t;
 
@@ -102,4 +103,16 @@ DECLARE_FAKE_VALUE_FUNC( MQTTStatus_t,
                          MQTTAgent_CancelAll,
                          MQTTAgentContext_t * );
 
+DECLARE_FAKE_VALUE_FUNC( MQTTStatus_t,
+                         MQTTAgent_Publish,
+                         const MQTTAgentContext_t *,
+                         MQTTPublishInfo_t *,
+                         const MQTTAgentCommandInfo_t * );
+
+DECLARE_FAKE_VALUE_FUNC( MQTTStatus_t,
+                         MQTTAgent_Unsubscribe,
+                         const MQTTAgentContext_t *,
+                         MQTTAgentSubscribeArgs_t *,
+                         const MQTTAgentCommandInfo_t * );
+
 #endif /* CORE_MQTT_AGENT_H */