Add invalid character test for serializer

Author: anod

tests/unittests/AIJsonSerializerTests.cpp

@@ -235,4 +235,57 @@ TEST(AIJsonSerializerTests, replacesInvalidUtf8BytesInStrings)
     EXPECT_EQ(std::string::npos, actual.find(static_cast<char>(0xA9)));
 }
 
-#endif  // HAVE_MAT_AI
+TEST(AIJsonSerializerTests, replacesInvalidUtf8BytesInTags)
+{
+    std::unique_ptr<AIJsonSerializer> aiSerializer = std::make_unique<AIJsonSerializer>();
+
+    // Inject an invalid UTF-8 byte (0xA9) into a tag value.
+    // With json::error_handler_t::replace, serialization should not throw and
+    // the invalid byte should be replaced by the UTF-8 encoding of U+FFFD.
+    std::string invalidUtf8 = "app";
+    invalidUtf8.push_back(static_cast<char>(0xA9));
+    invalidUtf8 += "Ver";
+
+    ::CsProtocol::App app;
+    app.ver = invalidUtf8;
+    app.locale = "appLocale";
+
+    ::CsProtocol::Device device;
+    device.localId = "deviceId";
+    device.deviceClass = "deviceClass";
+
+    ::CsProtocol::Protocol proto;
+    proto.devMake = "protoDevMake";
+    proto.devModel = "protoDevModel";
+
+    ::CsProtocol::Os os;
+    os.name = "osName";
+    os.ver = "osVer";
+
+    ::CsProtocol::User user;
+    user.localId = "userId";
+
+    ::CsProtocol::Data data;
+    ::CsProtocol::Value prop;
+    prop.stringValue = "ok";
+    data.properties["prop"] = prop;
+
+    std::unique_ptr<::CsProtocol::Record> record = createTestRecord(
+        "eventUtf8Tags", 1, app, device, proto, os, user, data
+    );
+    IncomingEventContext context(PAL::generateUuidString(), TEST_TOKEN, EventLatency_Unspecified, EventPersistence_Normal, record.get());
+
+    EXPECT_NO_THROW(aiSerializer->serialize(&context));
+    ASSERT_FALSE(context.record.blob.empty());
+
+    ::nlohmann::json parsed;
+    EXPECT_NO_THROW(parsed = nlohmann::json::parse(context.record.blob.begin(), context.record.blob.end()));
+
+    const std::string actual = parsed["tags"]["ai.application.ver"].get<std::string>();
+    const std::string expected = std::string("app") + "\xEF\xBF\xBD" + "Ver";
+
+    EXPECT_EQ(expected, actual);
+    EXPECT_EQ(std::string::npos, actual.find(static_cast<char>(0xA9)));
+}
+
+#endif  // HAVE_MAT_AI

tests/unittests/CMakeLists.txt

@@ -51,6 +51,12 @@ set(SRCS
 
 set_source_files_properties(${SRCS} PROPERTIES COMPILE_FLAGS -Wno-deprecated-declarations)
 
+# Enable Azure Monitor unit tests when the module is present.
+# The AIJsonSerializer test sources are guarded by HAVE_MAT_AI.
+if (EXISTS ${CMAKE_SOURCE_DIR}/lib/modules/azmon/AIJsonSerializer.hpp)
+  add_definitions(-DHAVE_MAT_AI)
+endif()
+
 if (APPLE)
   if (BUILD_IOS)
     list(APPEND SRCS SysInfoUtilsTests_iOS.cpp)