Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add unit tests for the Microsoft.Agents.BotBuilder project #81

Merged
merged 4 commits into from
Feb 4, 2025
Merged

Add unit tests for the Microsoft.Agents.BotBuilder project #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dc1ca5e
Add unit tests to Agents.BotBuilder to increase code coverage
JhontSouth Jan 30, 2025
410a25b
fix exception unit tests names
JhontSouth Jan 31, 2025
af4bfa0
removed never used variable
JhontSouth Feb 3, 2025
cc1d833
Merge branch 'main' into southworks/add/botbuilder-tests
ceciliaavila Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/libraries/BotBuilder/Microsoft.Agents.BotBuilder/ActivityHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -875,7 +875,7 @@ private static AdaptiveCardInvokeValue GetAdaptiveCardInvokeValue(IInvokeActivit

if (invokeValue.Action.Type != "Action.Execute")
{
var response = CreateAdaptiveCardInvokeErrorResponse(HttpStatusCode.BadRequest, "NotSupported", $"The action '{invokeValue.Action.Type}'is not supported.");
var response = CreateAdaptiveCardInvokeErrorResponse(HttpStatusCode.BadRequest, "NotSupported", $"The action '{invokeValue.Action.Type}' is not supported.");
throw new InvokeResponseException(HttpStatusCode.BadRequest, response);
}

Expand Down
135 changes: 133 additions & 2 deletions src/tests/Microsoft.Agents.BotBuilder.Tests/ActivityHandlerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -655,16 +655,21 @@ public async Task TestDelegatingTurnContext()
turnContextMock.Setup(tc => tc.Activity).Returns(new Activity { Type = ActivityTypes.Message });
//turnContextMock.Setup(tc => tc.Adapter).Returns(new BotFrameworkAdapter(new SimpleCredentialProvider()));
turnContextMock.Setup(tc => tc.Adapter).Returns(new NotImplementedAdapter());

turnContextMock.Setup(tc => tc.TurnState).Returns(new TurnContextStateCollection());
turnContextMock.Object.TurnState.Add<IConnectorClient>(new Mock<IConnectorClient>().Object);
turnContextMock.Setup(tc => tc.Responded).Returns(false);
turnContextMock.Setup(tc => tc.OnDeleteActivity(It.IsAny<DeleteActivityHandler>()));
turnContextMock.Setup(tc => tc.OnSendActivities(It.IsAny<SendActivitiesHandler>()));
turnContextMock.Setup(tc => tc.OnUpdateActivity(It.IsAny<UpdateActivityHandler>()));
turnContextMock.Setup(tc => tc.SendActivityAsync(It.IsAny<IActivity>(), It.IsAny<CancellationToken>())).Returns(Task.FromResult(new ResourceResponse()));
turnContextMock.Setup(tc => tc.SendActivitiesAsync(It.IsAny<IActivity[]>(), It.IsAny<CancellationToken>())).Returns(Task.FromResult(new[] { new ResourceResponse() }));
turnContextMock.Setup(tc => tc.DeleteActivityAsync(It.IsAny<ConversationReference>(), It.IsAny<CancellationToken>())).Returns(Task.FromResult(new ResourceResponse()));
turnContextMock.Setup(tc => tc.DeleteActivityAsync(It.IsAny<string>(), It.IsAny<CancellationToken>())).Returns(Task.FromResult(new ResourceResponse()));
turnContextMock.Setup(tc => tc.UpdateActivityAsync(It.IsAny<IActivity>(), It.IsAny<CancellationToken>())).Returns(Task.FromResult(new ResourceResponse()));
turnContextMock.Setup(tc => tc.TraceActivityAsync(It.IsAny<string>(), It.IsAny<object>(), It.IsAny<string>(), It.IsAny<string>(), It.IsAny<CancellationToken>())).Returns(Task.FromResult(new ResourceResponse()));

var typedTurnContext = new TypedTurnContext<IInvokeActivity>(turnContextMock.Object);

// Act
var bot = new TestDelegatingTurnContextActivityHandler();
Expand All @@ -673,15 +678,21 @@ public async Task TestDelegatingTurnContext()
// Assert
turnContextMock.VerifyGet(tc => tc.Activity, Times.AtLeastOnce);
turnContextMock.VerifyGet(tc => tc.Adapter, Times.Once);
turnContextMock.VerifyGet(tc => tc.TurnState, Times.Once);
turnContextMock.VerifyGet(tc => tc.TurnState, Times.Exactly(2));
turnContextMock.VerifyGet(tc => tc.Responded, Times.Once);
turnContextMock.Verify(tc => tc.OnDeleteActivity(It.IsAny<DeleteActivityHandler>()), Times.Once);
turnContextMock.Verify(tc => tc.OnSendActivities(It.IsAny<SendActivitiesHandler>()), Times.Once);
turnContextMock.Verify(tc => tc.OnUpdateActivity(It.IsAny<UpdateActivityHandler>()), Times.Once);
turnContextMock.Verify(tc => tc.SendActivityAsync(It.IsAny<IActivity>(), It.IsAny<CancellationToken>()), Times.Once);
turnContextMock.Verify(tc => tc.SendActivitiesAsync(It.IsAny<IActivity[]>(), It.IsAny<CancellationToken>()), Times.Once);
turnContextMock.Verify(tc => tc.DeleteActivityAsync(It.IsAny<ConversationReference>(), It.IsAny<CancellationToken>()), Times.Once);
turnContextMock.Verify(tc => tc.DeleteActivityAsync(It.IsAny<string>(), It.IsAny<CancellationToken>()), Times.Once);
turnContextMock.Verify(tc => tc.UpdateActivityAsync(It.IsAny<IActivity>(), It.IsAny<CancellationToken>()), Times.Once);
turnContextMock.Verify(tc => tc.TraceActivityAsync(It.IsAny<string>(), It.IsAny<object>(), It.IsAny<string>(), It.IsAny<string>(), It.IsAny<CancellationToken>()), Times.Once);

//Validate entities inheritated and managed by TypedTurnContext
Assert.NotNull(typedTurnContext.Connector);
Assert.NotNull(typedTurnContext.Activity);
}

[Fact]
Expand Down Expand Up @@ -749,6 +760,124 @@ public async Task TestGetSearchInvokeValue_MissingQueryTextThrows()
await AssertErrorThroughInvokeAdapter(activity, "Missing queryText property for search");
}

[Fact]
public async Task OnTurnAsync_ShouldThrowOnNullContext()
{
// Arrange
var turnContext = new TurnContext(new NotImplementedAdapter(), new Activity());
var bot = new TestActivityHandler();

//Assert
await Assert.ThrowsAsync<ArgumentException>(async () => await ((IBot)bot).OnTurnAsync(turnContext));;
}

[Fact]
public async Task OnTurnAsync_ShouldThrowOnActivityNullType()
{
// Arrange
var turnContext = new TurnContext(new NotImplementedAdapter(), new Activity());
var bot = new TestActivityHandler();

//Assert
await Assert.ThrowsAsync<ArgumentException>(async () => await ((IBot)bot).OnTurnAsync(turnContext)); ;
}


[Fact]
public async Task GetAdaptiveCardInvokeValue_ShouldThrowOnEmptyValue()
{
// Arrange
var activity = new Activity
{
Type = ActivityTypes.Invoke,
Name = "adaptiveCard/action"
};

//Assert
await AssertErrorThroughInvokeAdapter(activity, "Missing value property");
}

[Fact]
public async Task GetAdaptiveCardInvokeValue_ShouldThrowOnSerialization()
{
// Arrange
var activity = new Activity
{
Type = ActivityTypes.Invoke,
Name = "adaptiveCard/action",
Value = ""
};

//Assert
await AssertErrorThroughInvokeAdapter(activity, "Value property is not properly formed");
}

[Fact]
public async Task GetAdaptiveCardInvokeValue_ShouldThrowOnNullAction()
{
// Arrange
var activity = new Activity
{
Type = ActivityTypes.Invoke,
Name = "adaptiveCard/action",
Value = new AdaptiveCardInvokeValue { Action = null }
};

//Assert
await AssertErrorThroughInvokeAdapter(activity, "Missing action property");
}

[Fact]
public async Task GetAdaptiveCardInvokeValue_ShouldThrowOnNotSupportedAction()
{
// Arrange
var activity = new Activity
{
Type = ActivityTypes.Invoke,
Name = "adaptiveCard/action",
Value = new AdaptiveCardInvokeValue { Action = new AdaptiveCardInvokeAction { Type = "" } }
};

var adapter = new TestInvokeAdapter();
var turnContext = new TurnContext(adapter, activity);

var bot = new TestActivityHandler();
await ((IBot)bot).OnTurnAsync(turnContext);

//Assert
var sent = adapter.Activity as Activity;
Assert.Equal(ActivityTypes.InvokeResponse, sent.Type);

Assert.IsType<InvokeResponse>(sent.Value);
var value = sent.Value as InvokeResponse;
Assert.Equal(400, value.Status);

Assert.IsType<AdaptiveCardInvokeResponse>(value.Body);
var body = value.Body as AdaptiveCardInvokeResponse;
Assert.Equal("application/vnd.microsoft.error", body.Type);
Assert.Equal(400, body.StatusCode);

Assert.IsType<Error>(body.Value);
var error = body.Value as Error;
Assert.Equal("NotSupported", error.Code);
Assert.Equal("The action '' is not supported.", error.Message);
}

[Fact]
public async Task GetSearchInvokeValue_ShouldThrowExceptionOnSerialization()
{
// Arrange
var activity = new Activity
{
Type = ActivityTypes.Invoke,
Name = "application/search",
Value = ""
};

//Assert
await AssertErrorThroughInvokeAdapter(activity, "Value property is not valid for search");
}

private Activity GetSearchActivity(object value)
{
return new Activity
Expand Down Expand Up @@ -966,9 +1095,11 @@ protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivi
turnContext.OnSendActivities((t, a, n) => Task.FromResult(new ResourceResponse[] { new ResourceResponse() }));
turnContext.OnUpdateActivity((t, a, n) => Task.FromResult(new ResourceResponse()));
await turnContext.DeleteActivityAsync(activity.GetConversationReference());
await turnContext.DeleteActivityAsync(activity.Id);
await turnContext.SendActivityAsync(new Activity());
await turnContext.SendActivitiesAsync(new IActivity[] { new Activity() });
await turnContext.UpdateActivityAsync(new Activity());
await turnContext.TraceActivityAsync(activity.Name, activity.Value, activity.ValueType, activity.Label);
}
}

Expand Down
Loading
Loading