// Copyright (c) Microsoft. All rights reserved. using System; using System.Collections.Generic; using System.Linq; using Microsoft.Extensions.VectorData; using Microsoft.Extensions.VectorData.ProviderServices; using Microsoft.SemanticKernel.Connectors.MongoDB; using MongoDB.Bson; using Xunit; namespace SemanticKernel.Connectors.MongoDB.UnitTests; /// /// Unit tests for class. /// public sealed class MongoDynamicMapperTests { private static readonly CollectionModel s_model = BuildModel( [ new VectorStoreKeyProperty("Key", typeof(string)), new VectorStoreDataProperty("BoolDataProp", typeof(bool)), new VectorStoreDataProperty("NullableBoolDataProp", typeof(bool?)), new VectorStoreDataProperty("StringDataProp", typeof(string)), new VectorStoreDataProperty("IntDataProp", typeof(int)), new VectorStoreDataProperty("NullableIntDataProp", typeof(int?)), new VectorStoreDataProperty("LongDataProp", typeof(long)), new VectorStoreDataProperty("NullableLongDataProp", typeof(long?)), new VectorStoreDataProperty("FloatDataProp", typeof(float)), new VectorStoreDataProperty("NullableFloatDataProp", typeof(float?)), new VectorStoreDataProperty("DoubleDataProp", typeof(double)), new VectorStoreDataProperty("NullableDoubleDataProp", typeof(double?)), new VectorStoreDataProperty("DecimalDataProp", typeof(decimal)), new VectorStoreDataProperty("NullableDecimalDataProp", typeof(decimal?)), new VectorStoreDataProperty("DateTimeDataProp", typeof(DateTime)), new VectorStoreDataProperty("NullableDateTimeDataProp", typeof(DateTime?)), new VectorStoreDataProperty("TagListDataProp", typeof(List)), new VectorStoreVectorProperty("FloatVector", typeof(ReadOnlyMemory), 10), new VectorStoreVectorProperty("NullableFloatVector", typeof(ReadOnlyMemory?), 10) ]); private static readonly float[] s_floatVector = [1.0f, 2.0f, 3.0f]; private static readonly List s_taglist = ["tag1", "tag2"]; [Fact] public void MapFromDataToStorageModelMapsAllSupportedTypes() { // Arrange var sut = new MongoDynamicMapper(s_model); var dataModel = new Dictionary { ["Key"] = "key", ["BoolDataProp"] = true, ["NullableBoolDataProp"] = false, ["StringDataProp"] = "string", ["IntDataProp"] = 1, ["NullableIntDataProp"] = 2, ["LongDataProp"] = 3L, ["NullableLongDataProp"] = 4L, ["FloatDataProp"] = 5.0f, ["NullableFloatDataProp"] = 6.0f, ["DoubleDataProp"] = 7.0, ["NullableDoubleDataProp"] = 8.0, ["DecimalDataProp"] = 9.0m, ["NullableDecimalDataProp"] = 10.0m, ["DateTimeDataProp"] = new DateTime(2021, 1, 1, 0, 0, 0).ToUniversalTime(), ["NullableDateTimeDataProp"] = new DateTime(2021, 1, 1, 0, 0, 0).ToUniversalTime(), ["TagListDataProp"] = s_taglist, ["FloatVector"] = new ReadOnlyMemory(s_floatVector), ["NullableFloatVector"] = new ReadOnlyMemory(s_floatVector), }; // Act var storageModel = sut.MapFromDataToStorageModel(dataModel, recordIndex: 0, generatedEmbeddings: null); // Assert Assert.Equal("key", storageModel["_id"]); Assert.Equal(true, (bool?)storageModel["BoolDataProp"]); Assert.Equal(false, (bool?)storageModel["NullableBoolDataProp"]); Assert.Equal("string", (string?)storageModel["StringDataProp"]); Assert.Equal(1, (int?)storageModel["IntDataProp"]); Assert.Equal(2, (int?)storageModel["NullableIntDataProp"]); Assert.Equal(3L, (long?)storageModel["LongDataProp"]); Assert.Equal(4L, (long?)storageModel["NullableLongDataProp"]); Assert.Equal(5.0f, (float?)storageModel["FloatDataProp"].AsDouble); Assert.Equal(6.0f, (float?)storageModel["NullableFloatDataProp"].AsNullableDouble); Assert.Equal(7.0, (double?)storageModel["DoubleDataProp"]); Assert.Equal(8.0, (double?)storageModel["NullableDoubleDataProp"]); Assert.Equal(9.0m, (decimal?)storageModel["DecimalDataProp"]); Assert.Equal(10.0m, (decimal?)storageModel["NullableDecimalDataProp"]); Assert.Equal(new DateTime(2021, 1, 1, 0, 0, 0).ToUniversalTime(), storageModel["DateTimeDataProp"].ToUniversalTime()); Assert.Equal(new DateTime(2021, 1, 1, 0, 0, 0).ToUniversalTime(), storageModel["NullableDateTimeDataProp"].ToUniversalTime()); Assert.Equal(s_taglist, storageModel["TagListDataProp"]!.AsBsonArray.Select(x => (string)x!).ToArray()); Assert.Equal(s_floatVector, storageModel["FloatVector"]!.AsBsonArray.Select(x => (float)x.AsDouble!).ToArray()); Assert.Equal(s_floatVector, storageModel["NullableFloatVector"]!.AsBsonArray.Select(x => (float)x.AsNullableDouble!).ToArray()); } [Fact] public void MapFromDataToStorageModelMapsNullValues() { // Arrange var model = BuildModel( [ new VectorStoreKeyProperty("Key", typeof(string)), new VectorStoreDataProperty("StringDataProp", typeof(string)), new VectorStoreDataProperty("NullableIntDataProp", typeof(int?)), new VectorStoreVectorProperty("NullableFloatVector", typeof(ReadOnlyMemory?), 10) ]); var dataModel = new Dictionary { ["Key"] = "key", ["StringDataProp"] = null, ["NullableIntDataProp"] = null, ["NullableFloatVector"] = null }; var sut = new MongoDynamicMapper(model); // Act var storageModel = sut.MapFromDataToStorageModel(dataModel, recordIndex: 0, generatedEmbeddings: null); // Assert Assert.Equal(BsonNull.Value, storageModel["StringDataProp"]); Assert.Equal(BsonNull.Value, storageModel["NullableIntDataProp"]); Assert.Empty(storageModel["NullableFloatVector"].AsBsonArray); } [Fact] public void MapFromStorageToDataModelMapsAllSupportedTypes() { // Arrange var sut = new MongoDynamicMapper(s_model); var storageModel = new BsonDocument { ["_id"] = "key", ["BoolDataProp"] = true, ["NullableBoolDataProp"] = false, ["StringDataProp"] = "string", ["IntDataProp"] = 1, ["NullableIntDataProp"] = 2, ["LongDataProp"] = 3L, ["NullableLongDataProp"] = 4L, ["FloatDataProp"] = 5.0f, ["NullableFloatDataProp"] = 6.0f, ["DoubleDataProp"] = 7.0, ["NullableDoubleDataProp"] = 8.0, ["DecimalDataProp"] = 9.0m, ["NullableDecimalDataProp"] = 10.0m, ["DateTimeDataProp"] = new DateTime(2021, 1, 1, 0, 0, 0).ToUniversalTime(), ["NullableDateTimeDataProp"] = new DateTime(2021, 1, 1, 0, 0, 0).ToUniversalTime(), ["TagListDataProp"] = BsonArray.Create(s_taglist), ["FloatVector"] = BsonArray.Create(s_floatVector), ["NullableFloatVector"] = BsonArray.Create(s_floatVector), }; // Act var dataModel = sut.MapFromStorageToDataModel(storageModel, includeVectors: true); // Assert Assert.Equal("key", dataModel["Key"]); Assert.Equal(true, dataModel["BoolDataProp"]); Assert.Equal(false, dataModel["NullableBoolDataProp"]); Assert.Equal("string", dataModel["StringDataProp"]); Assert.Equal(1, dataModel["IntDataProp"]); Assert.Equal(2, dataModel["NullableIntDataProp"]); Assert.Equal(3L, dataModel["LongDataProp"]); Assert.Equal(4L, dataModel["NullableLongDataProp"]); Assert.Equal(5.0f, dataModel["FloatDataProp"]); Assert.Equal(6.0f, dataModel["NullableFloatDataProp"]); Assert.Equal(7.0, dataModel["DoubleDataProp"]); Assert.Equal(8.0, dataModel["NullableDoubleDataProp"]); Assert.Equal(9.0m, dataModel["DecimalDataProp"]); Assert.Equal(10.0m, dataModel["NullableDecimalDataProp"]); Assert.Equal(new DateTime(2021, 1, 1, 0, 0, 0).ToUniversalTime(), dataModel["DateTimeDataProp"]); Assert.Equal(new DateTime(2021, 1, 1, 0, 0, 0).ToUniversalTime(), dataModel["NullableDateTimeDataProp"]); Assert.Equal(s_taglist, dataModel["TagListDataProp"]); Assert.Equal(s_floatVector, ((ReadOnlyMemory)dataModel["FloatVector"]!).ToArray()); Assert.Equal(s_floatVector, ((ReadOnlyMemory)dataModel["NullableFloatVector"]!)!.ToArray()); } [Fact] public void MapFromStorageToDataModelMapsNullValues() { // Arrange var model = BuildModel( [ new VectorStoreKeyProperty("Key", typeof(string)), new VectorStoreDataProperty("StringDataProp", typeof(string)), new VectorStoreDataProperty("NullableIntDataProp", typeof(int?)), new VectorStoreVectorProperty("NullableFloatVector", typeof(ReadOnlyMemory?), 10) ]); var storageModel = new BsonDocument { ["_id"] = "key", ["StringDataProp"] = BsonNull.Value, ["NullableIntDataProp"] = BsonNull.Value, ["NullableFloatVector"] = BsonNull.Value }; var sut = new MongoDynamicMapper(model); // Act var dataModel = sut.MapFromStorageToDataModel(storageModel, includeVectors: true); // Assert Assert.Equal("key", dataModel["Key"]); Assert.Null(dataModel["StringDataProp"]); Assert.Null(dataModel["NullableIntDataProp"]); Assert.Null(dataModel["NullableFloatVector"]); } [Fact] public void MapFromStorageToDataModelThrowsForMissingKey() { // Arrange var sut = new MongoDynamicMapper(s_model); var storageModel = new BsonDocument(); // Act & Assert var exception = Assert.Throws( () => sut.MapFromStorageToDataModel(storageModel, includeVectors: true)); } [Fact] public void MapFromDataToStorageModelSkipsMissingProperties() { // Arrange var model = BuildModel( [ new VectorStoreKeyProperty("Key", typeof(string)), new VectorStoreDataProperty("StringDataProp", typeof(string)), new VectorStoreVectorProperty("FloatVector", typeof(ReadOnlyMemory), 10), ]); var dataModel = new Dictionary { ["Key"] = "key" }; var sut = new MongoDynamicMapper(model); // Act var storageModel = sut.MapFromDataToStorageModel(dataModel, recordIndex: 0, generatedEmbeddings: null); // Assert Assert.Equal("key", (string?)storageModel["_id"]); Assert.False(storageModel.Contains("StringDataProp")); Assert.False(storageModel.Contains("FloatVector")); } [Fact] public void MapFromStorageToDataModelSkipsMissingProperties() { // Arrange var model = BuildModel( [ new VectorStoreKeyProperty("Key", typeof(string)), new VectorStoreDataProperty("StringDataProp", typeof(string)), new VectorStoreVectorProperty("FloatVector", typeof(ReadOnlyMemory), 10), ]); var storageModel = new BsonDocument { ["_id"] = "key" }; var sut = new MongoDynamicMapper(model); // Act var dataModel = sut.MapFromStorageToDataModel(storageModel, includeVectors: true); // Assert Assert.Equal("key", dataModel["Key"]); Assert.False(dataModel.ContainsKey("StringDataProp")); Assert.False(dataModel.ContainsKey("FloatVector")); } private static CollectionModel BuildModel(List properties) => new MongoModelBuilder().BuildDynamic(new() { Properties = properties }, defaultEmbeddingGenerator: null); }