-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
.Net: Add unit tests for Text Search AOT enhancements (#10143)
### Motivation and Context Closes #9342 ### Description <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [ ] The code builds clean without any errors or warnings - [ ] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [ ] All unit tests pass, and I have added new tests where possible - [ ] I didn't break anyone 😄 --------- Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>
- Loading branch information
1 parent
9a5e2db
commit 53995c8
Showing
8 changed files
with
212 additions
and
6 deletions.
There are no files selected for viewing
16 changes: 16 additions & 0 deletions
16
...t/src/SemanticKernel.AotTests/JsonSerializerContexts/CustomResultJsonSerializerContext.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
// Copyright (c) Microsoft. All rights reserved. | ||
|
||
using System.Text.Json.Serialization; | ||
using Microsoft.SemanticKernel.Data; | ||
using SemanticKernel.AotTests.Plugins; | ||
|
||
namespace SemanticKernel.AotTests.JsonSerializerContexts; | ||
|
||
[JsonSerializable(typeof(CustomResult))] | ||
[JsonSerializable(typeof(int))] | ||
[JsonSerializable(typeof(KernelSearchResults<string>))] | ||
[JsonSerializable(typeof(KernelSearchResults<TextSearchResult>))] | ||
[JsonSerializable(typeof(KernelSearchResults<object>))] | ||
internal sealed partial class CustomResultJsonSerializerContext : JsonSerializerContext | ||
{ | ||
} |
13 changes: 13 additions & 0 deletions
13
dotnet/src/SemanticKernel.AotTests/Plugins/CustomResult.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
// Copyright (c) Microsoft. All rights reserved. | ||
|
||
namespace SemanticKernel.AotTests.Plugins; | ||
|
||
internal sealed class CustomResult | ||
{ | ||
public string Value { get; set; } | ||
|
||
public CustomResult(string value) | ||
{ | ||
this.Value = value; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
42 changes: 42 additions & 0 deletions
42
dotnet/src/SemanticKernel.AotTests/UnitTests/Search/MockTextSearch.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
// Copyright (c) Microsoft. All rights reserved. | ||
|
||
using Microsoft.SemanticKernel.Data; | ||
|
||
namespace SemanticKernel.AotTests.UnitTests.Search; | ||
|
||
internal sealed class MockTextSearch : ITextSearch | ||
{ | ||
private readonly KernelSearchResults<object>? _objectResults; | ||
private readonly KernelSearchResults<TextSearchResult>? _textSearchResults; | ||
private readonly KernelSearchResults<string>? _stringResults; | ||
|
||
public MockTextSearch(KernelSearchResults<object>? objectResults) | ||
{ | ||
this._objectResults = objectResults; | ||
} | ||
|
||
public MockTextSearch(KernelSearchResults<TextSearchResult>? textSearchResults) | ||
{ | ||
this._textSearchResults = textSearchResults; | ||
} | ||
|
||
public MockTextSearch(KernelSearchResults<string>? stringResults) | ||
{ | ||
this._stringResults = stringResults; | ||
} | ||
|
||
public Task<KernelSearchResults<object>> GetSearchResultsAsync(string query, TextSearchOptions? searchOptions = null, CancellationToken cancellationToken = default) | ||
{ | ||
return Task.FromResult(this._objectResults!); | ||
} | ||
|
||
public Task<KernelSearchResults<TextSearchResult>> GetTextSearchResultsAsync(string query, TextSearchOptions? searchOptions = null, CancellationToken cancellationToken = default) | ||
{ | ||
return Task.FromResult(this._textSearchResults!); | ||
} | ||
|
||
public Task<KernelSearchResults<string>> SearchAsync(string query, TextSearchOptions? searchOptions = null, CancellationToken cancellationToken = default) | ||
{ | ||
return Task.FromResult(this._stringResults!); | ||
} | ||
} |
94 changes: 94 additions & 0 deletions
94
dotnet/src/SemanticKernel.AotTests/UnitTests/Search/TextSearchExtensionsTests.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
// Copyright (c) Microsoft. All rights reserved. | ||
|
||
using System.Text.Json; | ||
using Microsoft.SemanticKernel; | ||
using Microsoft.SemanticKernel.Data; | ||
using Microsoft.VisualStudio.TestTools.UnitTesting; | ||
using SemanticKernel.AotTests.JsonSerializerContexts; | ||
using SemanticKernel.AotTests.Plugins; | ||
|
||
namespace SemanticKernel.AotTests.UnitTests.Search; | ||
|
||
internal sealed class TextSearchExtensionsTests | ||
{ | ||
private static readonly JsonSerializerOptions s_jsonSerializerOptions = new() | ||
{ | ||
TypeInfoResolverChain = { CustomResultJsonSerializerContext.Default } | ||
}; | ||
|
||
public static async Task CreateWithSearch() | ||
{ | ||
// Arrange | ||
var testData = new List<string> { "test-value" }; | ||
KernelSearchResults<string> results = new(testData.ToAsyncEnumerable()); | ||
ITextSearch textSearch = new MockTextSearch(results); | ||
|
||
// Act | ||
var plugin = textSearch.CreateWithSearch("SearchPlugin", s_jsonSerializerOptions); | ||
|
||
// Assert | ||
await AssertSearchFunctionSchemaAndInvocationResult<string>(plugin["Search"], testData[0]); | ||
} | ||
|
||
public static async Task CreateWithGetTextSearchResults() | ||
{ | ||
// Arrange | ||
var testData = new List<TextSearchResult> { new("test-value") }; | ||
KernelSearchResults<TextSearchResult> results = new(testData.ToAsyncEnumerable()); | ||
ITextSearch textSearch = new MockTextSearch(results); | ||
|
||
// Act | ||
var plugin = textSearch.CreateWithGetTextSearchResults("SearchPlugin", s_jsonSerializerOptions); | ||
|
||
// Assert | ||
await AssertSearchFunctionSchemaAndInvocationResult<TextSearchResult>(plugin["GetTextSearchResults"], testData[0]); | ||
} | ||
|
||
public static async Task CreateWithGetSearchResults() | ||
{ | ||
// Arrange | ||
var testData = new List<CustomResult> { new("test-value") }; | ||
KernelSearchResults<object> results = new(testData.ToAsyncEnumerable()); | ||
ITextSearch textSearch = new MockTextSearch(results); | ||
|
||
// Act | ||
var plugin = textSearch.CreateWithGetSearchResults("SearchPlugin", s_jsonSerializerOptions); | ||
|
||
// Assert | ||
await AssertSearchFunctionSchemaAndInvocationResult<object>(plugin["GetSearchResults"], testData[0]); | ||
} | ||
|
||
#region assert | ||
internal static async Task AssertSearchFunctionSchemaAndInvocationResult<T>(KernelFunction function, T expectedResult) | ||
{ | ||
// Assert input parameter schema | ||
AssertSearchFunctionMetadata<T>(function.Metadata); | ||
|
||
// Assert the function result | ||
FunctionResult functionResult = await function.InvokeAsync(new(), new() { ["query"] = "Mock Query" }); | ||
|
||
var result = functionResult.GetValue<List<T>>()!; | ||
Assert.AreEqual(1, result.Count); | ||
Assert.AreEqual(expectedResult, result[0]); | ||
} | ||
|
||
internal static void AssertSearchFunctionMetadata<T>(KernelFunctionMetadata metadata) | ||
{ | ||
// Assert input parameter schema | ||
Assert.AreEqual(3, metadata.Parameters.Count); | ||
Assert.AreEqual("{\"description\":\"What to search for\",\"type\":\"string\"}", metadata.Parameters[0].Schema!.ToString()); | ||
Assert.AreEqual("{\"description\":\"Number of results (default value: 2)\",\"type\":\"integer\"}", metadata.Parameters[1].Schema!.ToString()); | ||
Assert.AreEqual("{\"description\":\"Number of results to skip (default value: 0)\",\"type\":\"integer\"}", metadata.Parameters[2].Schema!.ToString()); | ||
|
||
// Assert return type schema | ||
var type = typeof(T).Name; | ||
var expectedSchema = type switch | ||
{ | ||
"String" => """{"type":"object","properties":{"TotalCount":{"type":["integer","null"],"default":null},"Metadata":{"type":["object","null"],"default":null},"Results":{"type":"array","items":{"type":"string"}}},"required":["Results"]}""", | ||
"TextSearchResult" => """{"type":"object","properties":{"TotalCount":{"type":["integer","null"],"default":null},"Metadata":{"type":["object","null"],"default":null},"Results":{"type":"array","items":{"type":"object","properties":{"Name":{"type":["string","null"]},"Link":{"type":["string","null"]},"Value":{"type":"string"}},"required":["Value"]}}},"required":["Results"]}""", | ||
_ => """{"type":"object","properties":{"TotalCount":{"type":["integer","null"],"default":null},"Metadata":{"type":["object","null"],"default":null},"Results":{"type":"array","items":{"type":"object","properties":{"Name":{"type":["string","null"]},"Link":{"type":["string","null"]},"Value":{"type":"string"}},"required":["Value"]}}},"required":["Results"]}""" | ||
}; | ||
Assert.AreEqual(expectedSchema, metadata.ReturnParameter.Schema!.ToString()); | ||
} | ||
#endregion | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters