init mqtt5 device defender

aws · Oct 2, 2023 · bf2fb9c · bf2fb9c
1 parent 9e2948d
commit bf2fb9c
Show file tree

Hide file tree

Showing 5 changed files with 369 additions and 5 deletions.
diff --git a/crt/aws-crt-cpp b/crt/aws-crt-cpp
diff --git a/devicedefender/include/aws/iotdevicedefender/DeviceDefender.h b/devicedefender/include/aws/iotdevicedefender/DeviceDefender.h
@@ -7,6 +7,7 @@
 #include <aws/iotdevicedefender/Exports.h>
 
 #include <aws/crt/io/EventLoopGroup.h>
+#include <aws/crt/mqtt/Mqtt5Client.h>
 #include <aws/crt/mqtt/MqttClient.h>
 
 #include <aws/iotdevice/device_defender.h>
@@ -174,6 +175,12 @@ namespace Aws
                 Crt::Io::EventLoopGroup &eventLoopGroup,
                 const Crt::String &thingName);
 
+            ReportTaskBuilder(
+                Crt::Allocator *allocator,
+                std::shared_ptr<Crt::Mqtt5::Mqtt5Client> mqtt5Client,
+                Crt::Io::EventLoopGroup &eventLoopGroup,
+                const Crt::String &thingName);
+
             /**
              * Sets the device defender report format, or defaults to AWS_IDDRF_JSON.
              */

diff --git a/devicedefender/source/DeviceDefender.cpp b/devicedefender/source/DeviceDefender.cpp
@@ -300,6 +300,19 @@ namespace Aws
             m_cancellationUserdata = nullptr;
         }
 
+        ReportTaskBuilder::ReportTaskBuilder(
+            Crt::Allocator *allocator,
+            std::shared_ptr<Crt::Mqtt5::Mqtt5Client> mqtt5Client,
+            Crt::Io::EventLoopGroup &eventLoopGroup,
+            const Crt::String &thingName)
+            : ReportTaskBuilder(
+                  allocator,
+                  Crt::Mqtt::MqttConnection::NewConnectionFromMqtt5Client(mqtt5Client),
+                  eventLoopGroup,
+                  thingName)
+        {
+        }
+
         ReportTaskBuilder &ReportTaskBuilder::WithReportFormat(ReportFormat reportFormat) noexcept
         {
             m_reportFormat = reportFormat;

diff --git a/devicedefender/tests/DeviceDefenderMetricsTest.cpp b/devicedefender/tests/DeviceDefenderMetricsTest.cpp
@@ -6,6 +6,8 @@
 #include "aws/crt/Types.h"
 #include <aws/crt/Api.h>
 
+#include <aws/crt/mqtt/Mqtt5Client.h>
+
 #include <aws/iotdevicecommon/IotDevice.h>
 #include <aws/iotdevicedefender/DeviceDefender.h>
 #include <aws/testing/aws_test_harness.h>
@@ -32,9 +34,8 @@ static int s_TestDeviceDefenderCustomMetricSuccess(Aws::Crt::Allocator *allocato
         Aws::Crt::Io::ClientBootstrap clientBootstrap(eventLoopGroup, defaultHostResolver, allocator);
         clientBootstrap.EnableBlockingShutdown();
         Aws::Crt::Mqtt::MqttClient mqttClient(clientBootstrap, allocator);
-        Aws::Crt::Mqtt::MqttClient mqttClientMoved = std::move(mqttClient);
 
-        auto mqttConnection = mqttClientMoved.NewConnection("www.example.com", 443, socketOptions, tlsContext);
+        auto mqttConnection = mqttClient.NewConnection("www.example.com", 443, socketOptions, tlsContext);
         const Aws::Crt::String thingName("TestThing");
         bool callbackSuccess = false;
 
@@ -142,9 +143,8 @@ static int s_TestDeviceDefenderCustomMetricFail(Aws::Crt::Allocator *allocator,
         Aws::Crt::Io::ClientBootstrap clientBootstrap(eventLoopGroup, defaultHostResolver, allocator);
         clientBootstrap.EnableBlockingShutdown();
         Aws::Crt::Mqtt::MqttClient mqttClient(clientBootstrap, allocator);
-        Aws::Crt::Mqtt::MqttClient mqttClientMoved = std::move(mqttClient);
 
-        auto mqttConnection = mqttClientMoved.NewConnection("www.example.com", 443, socketOptions, tlsContext);
+        auto mqttConnection = mqttClient.NewConnection("www.example.com", 443, socketOptions, tlsContext);
         const Aws::Crt::String thingName("TestThing");
         bool callbackSuccess = false;
 
@@ -197,3 +197,203 @@ static int s_TestDeviceDefenderCustomMetricFail(Aws::Crt::Allocator *allocator,
     return AWS_ERROR_SUCCESS;
 }
 AWS_TEST_CASE(DeviceDefenderCustomMetricFail, s_TestDeviceDefenderCustomMetricFail)
+
+static int s_TestMqtt5DeviceDefenderCustomMetricSuccess(Aws::Crt::Allocator *allocator, void *ctx)
+{
+    (void)ctx;
+    {
+        Aws::Crt::ApiHandle apiHandle(allocator);
+        Aws::Iotdevicecommon::DeviceApiHandle deviceApiHandle(allocator);
+        Aws::Crt::Io::TlsContextOptions tlsCtxOptions = Aws::Crt::Io::TlsContextOptions::InitDefaultClient();
+        Aws::Crt::Io::TlsContext tlsContext(tlsCtxOptions, Aws::Crt::Io::TlsMode::CLIENT, allocator);
+        Aws::Crt::Io::SocketOptions socketOptions;
+        socketOptions.SetConnectTimeoutMs(3000);
+        Aws::Crt::Io::EventLoopGroup eventLoopGroup(0, allocator);
+        Aws::Crt::Io::DefaultHostResolver defaultHostResolver(eventLoopGroup, 8, 30, allocator);
+        Aws::Crt::Io::ClientBootstrap clientBootstrap(eventLoopGroup, defaultHostResolver, allocator);
+        clientBootstrap.EnableBlockingShutdown();
+
+        Aws::Crt::Mqtt5::Mqtt5ClientOptions mqtt5Options(allocator);
+        mqtt5Options.WithBootstrap(&clientBootstrap);
+        mqtt5Options.WithSocketOptions(socketOptions);
+        mqtt5Options.WithTlsConnectionOptions(TlsContext.NewConnectionOptions());
+        std::shared_ptr<Aws::Crt::Mqtt5::ConnectPacket> packetConnect =
+            std::make_shared<Aws::Crt::Mqtt5::ConnectPacket>();
+        mqtt5Options.WithHostName("www.example.come");
+        mqtt5Options.WithPort(443);
+
+        std::shared_ptr<Mqtt5::Mqtt5Client> mqtt5Client = Mqtt5::Mqtt5Client::NewMqtt5Client(mqtt5Options, allocator);
+
+        const Aws::Crt::String thingName("TestThing");
+        bool callbackSuccess = false;
+
+        std::mutex mutex;
+        std::condition_variable cv;
+        bool taskStopped = false;
+
+        auto onCancelled = [&](void *a) -> void
+        {
+            auto *data = reinterpret_cast<bool *>(a);
+            *data = true;
+            taskStopped = true;
+            cv.notify_one();
+        };
+
+        Aws::Iotdevicedefenderv1::ReportTaskBuilder taskBuilder(allocator, mqtt5Client, eventLoopGroup, thingName);
+        taskBuilder.WithTaskPeriodSeconds((uint32_t)1UL)
+            .WithNetworkConnectionSamplePeriodSeconds((uint32_t)1UL)
+            .WithTaskCancelledHandler(onCancelled)
+            .WithTaskCancellationUserData(&callbackSuccess);
+
+        std::shared_ptr<Aws::Iotdevicedefenderv1::ReportTask> task = taskBuilder.Build();
+
+        // ================
+        // Add the custom metrics
+        std::function<int(double *)> local_metric_number_func = [](double *output)
+        {
+            *output = 10;
+            return AWS_OP_SUCCESS;
+        };
+        task->RegisterCustomMetricNumber("CustomNumberOne", std::move(local_metric_number_func));
+        std::function<int(double *)> global_metric_number_func_ref = global_metric_number_func;
+        task->RegisterCustomMetricNumber("CustomNumberTwo", std::move(global_metric_number_func_ref));
+
+        std::function<int(Aws::Crt::Vector<double> *)> local_metric_number_list_func =
+            [](Aws::Crt::Vector<double> *output)
+        {
+            output->push_back(101);
+            output->push_back(102);
+            output->push_back(103);
+            return AWS_OP_SUCCESS;
+        };
+        task->RegisterCustomMetricNumberList("CustomNumberList", std::move(local_metric_number_list_func));
+
+        std::function<int(Aws::Crt::Vector<Aws::Crt::String> *)> local_metric_str_list_func =
+            [](Aws::Crt::Vector<Aws::Crt::String> *output)
+        {
+            output->push_back("One Fish");
+            output->push_back("Two Fish");
+            output->push_back("Red Fish");
+            output->push_back("Blue Fish");
+            return AWS_OP_SUCCESS;
+        };
+        task->RegisterCustomMetricStringList("CustomStringList", std::move(local_metric_str_list_func));
+
+        std::function<int(Aws::Crt::Vector<Aws::Crt::String> *)> local_metric_ip_list_func =
+            [](Aws::Crt::Vector<Aws::Crt::String> *output)
+        {
+            output->push_back("192.0.2.0");
+            output->push_back("198.51.100.0");
+            output->push_back("203.0.113.0");
+            output->push_back("233.252.0.0");
+            return AWS_OP_SUCCESS;
+        };
+        task->RegisterCustomMetricIpAddressList("CustomIPList", std::move(local_metric_ip_list_func));
+
+        // ================
+
+        ASSERT_INT_EQUALS((int)Aws::Iotdevicedefenderv1::ReportTaskStatus::Ready, (int)task->GetStatus());
+
+        ASSERT_SUCCESS(task->StartTask());
+        ASSERT_INT_EQUALS((int)Aws::Iotdevicedefenderv1::ReportTaskStatus::Running, (int)task->GetStatus());
+        ASSERT_FAILS(task->StartTask());
+        ASSERT_TRUE(aws_last_error() == AWS_ERROR_INVALID_STATE);
+        task->StopTask();
+
+        ASSERT_TRUE(task->GetStatus() == Aws::Iotdevicedefenderv1::ReportTaskStatus::Stopped);
+
+        {
+            std::unique_lock<std::mutex> lock(mutex);
+            cv.wait(lock, [&]() { return taskStopped; });
+        }
+
+        ASSERT_TRUE(callbackSuccess);
+
+        mqtt5Client->Stop();
+        ASSERT_TRUE(mqtt5Client);
+
+        ASSERT_INT_EQUALS((int)Aws::Iotdevicedefenderv1::ReportTaskStatus::Stopped, (int)task->GetStatus());
+    }
+
+    return AWS_ERROR_SUCCESS;
+}
+AWS_TEST_CASE(Mqtt5DeviceDefenderCustomMetricSuccess, s_TestMqtt5DeviceDefenderCustomMetricSuccess)
+
+static int s_TestMqtt5DeviceDefenderCustomMetricFail(Aws::Crt::Allocator *allocator, void *ctx)
+{
+    (void)ctx;
+    {
+        Aws::Crt::ApiHandle apiHandle(allocator);
+        Aws::Iotdevicecommon::DeviceApiHandle deviceApiHandle(allocator);
+        Aws::Crt::Io::TlsContextOptions tlsCtxOptions = Aws::Crt::Io::TlsContextOptions::InitDefaultClient();
+        Aws::Crt::Io::TlsContext tlsContext(tlsCtxOptions, Aws::Crt::Io::TlsMode::CLIENT, allocator);
+        Aws::Crt::Io::SocketOptions socketOptions;
+        socketOptions.SetConnectTimeoutMs(3000);
+        Aws::Crt::Io::EventLoopGroup eventLoopGroup(0, allocator);
+        Aws::Crt::Io::DefaultHostResolver defaultHostResolver(eventLoopGroup, 8, 30, allocator);
+        Aws::Crt::Io::ClientBootstrap clientBootstrap(eventLoopGroup, defaultHostResolver, allocator);
+        clientBootstrap.EnableBlockingShutdown();
+
+        Aws::Crt::Mqtt5::Mqtt5ClientOptions mqtt5Options(allocator);
+        mqtt5Options.WithBootstrap(&clientBootstrap);
+        mqtt5Options.WithSocketOptions(socketOptions);
+        mqtt5Options.WithTlsConnectionOptions(TlsContext.NewConnectionOptions());
+        std::shared_ptr<Aws::Crt::Mqtt5::ConnectPacket> packetConnect =
+            std::make_shared<Aws::Crt::Mqtt5::ConnectPacket>();
+        mqtt5Options.WithHostName("www.example.come");
+        mqtt5Options.WithPort(443);
+
+        std::shared_ptr<Mqtt5::Mqtt5Client> mqtt5Client = Mqtt5::Mqtt5Client::NewMqtt5Client(mqtt5Options, allocator);
+
+        const Aws::Crt::String thingName("TestThing");
+        bool callbackSuccess = false;
+
+        std::mutex mutex;
+        std::condition_variable cv;
+        bool taskStopped = false;
+
+        auto onCancelled = [&](void *a) -> void
+        {
+            auto *data = reinterpret_cast<bool *>(a);
+            *data = true;
+            taskStopped = true;
+            cv.notify_one();
+        };
+
+        Aws::Iotdevicedefenderv1::ReportTaskBuilder taskBuilder(allocator, mqtt5Client, eventLoopGroup, thingName);
+        taskBuilder.WithTaskPeriodSeconds((uint32_t)1UL)
+            .WithNetworkConnectionSamplePeriodSeconds((uint32_t)1UL)
+            .WithTaskCancelledHandler(onCancelled)
+            .WithTaskCancellationUserData(&callbackSuccess);
+
+        std::shared_ptr<Aws::Iotdevicedefenderv1::ReportTask> task = taskBuilder.Build();
+
+        // Add the error custom metric
+        std::function<int(double *)> number_metric_func = [](double *output)
+        {
+            *output = 10;
+            return AWS_OP_ERR;
+        };
+        task->RegisterCustomMetricNumber("CustomNumberOne", std::move(number_metric_func));
+
+        ASSERT_INT_EQUALS((int)Aws::Iotdevicedefenderv1::ReportTaskStatus::Ready, (int)task->GetStatus());
+
+        task->StartTask();
+        task->StopTask();
+
+        ASSERT_TRUE(task->GetStatus() == Aws::Iotdevicedefenderv1::ReportTaskStatus::Stopped);
+        {
+            std::unique_lock<std::mutex> lock(mutex);
+            cv.wait(lock, [&]() { return taskStopped; });
+        }
+
+        ASSERT_TRUE(callbackSuccess);
+
+        mqtt5Client->Stop();
+        ASSERT_TRUE(mqtt5Client);
+
+        ASSERT_INT_EQUALS((int)Aws::Iotdevicedefenderv1::ReportTaskStatus::Stopped, (int)task->GetStatus());
+    }
+    return AWS_ERROR_SUCCESS;
+}
+AWS_TEST_CASE(Mqtt5DeviceDefenderCustomMetricFail, s_TestMqtt5DeviceDefenderCustomMetricFail)