Skip to content

Add NSwag client test #3689

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

Merged
martincostello merged 2 commits into from
Nov 30, 2025
Merged

Add NSwag client test #3689

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb16730
Move Kiota client tests
martincostello Nov 30, 2025
c6532e9
Add NSwag client test
martincostello Nov 30, 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
7 changes: 7 additions & 0 deletions .config/dotnet-tools.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@
"kiota"
],
"rollForward": false
},
"nswag.consolecore": {
"version": "14.6.3",
"commands": [
"nswag"
],
"rollForward": false
}
}
}
266 changes: 7 additions & 259 deletions test/Swashbuckle.AspNetCore.IntegrationTests/CodeGenerationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,7 @@
using System.Reflection;
using System.Security.Cryptography;
using System.Text;
using Microsoft.AspNetCore.Http;
using Microsoft.Kiota.Abstractions.Authentication;
using Microsoft.Kiota.Http.HttpClientLibrary;
using Microsoft.OpenApi;
using TodoApp.Client;
using TodoApp.Client.Models;

namespace Swashbuckle.AspNetCore.IntegrationTests;

Expand Down Expand Up @@ -88,254 +83,19 @@ await VerifyDirectory(
}

[Fact]
public async Task Can_Manage_Todo_Items_With_Api()
{
// Arrange
await WithTodoAppClientAsync(async (client) =>
{
var cancellationToken = TestContext.Current.CancellationToken;

// Act - Get all the items
var items = await client.Api.Items.GetAsync(cancellationToken: cancellationToken);

// Assert - There should be no items
Assert.NotNull(items);
Assert.NotNull(items.Items);

var beforeCount = items.Items.Count;

// Arrange
var text = "Buy eggs";

// Act - Add a new item
var createdItem = await client.Api.Items.PostAsync(
new() { Text = text },
cancellationToken: cancellationToken);

// Assert - An item was created
Assert.NotNull(createdItem);
Assert.NotEqual(default, createdItem.Id);

// Arrange - Get the new item's URL and Id
var itemId = createdItem.Id;

// Act - Get the item
var item = await client.Api.Items[new(itemId)].GetAsync(cancellationToken: cancellationToken);

// Assert - Verify the item was created correctly
Assert.NotNull(item);
Assert.Equal(itemId, item.Id);
Assert.Null(item.CompletedAt);
Assert.NotEqual(default, item.CreatedAt);
Assert.Equal(item.CreatedAt.Value, item.LastUpdated);
Assert.Null(item.Priority);
Assert.Equal(text, item.Text);

// Act - Update the item to be high priority
await client.Api.Items[new(itemId)].Priority.PatchAsync(
new() { Priority = TodoPriority.High },
cancellationToken: cancellationToken);

item = await client.Api.Items[new(itemId)].GetAsync(cancellationToken: cancellationToken);

Assert.NotNull(item);
Assert.Equal(itemId, item.Id);
Assert.Null(item.CompletedAt);
Assert.NotEqual(default, item.CreatedAt);
Assert.Equal(item.CreatedAt.Value, item.LastUpdated);
Assert.Equal(TodoPriority.High, item.Priority);
Assert.Equal(text, item.Text);

// Act - Mark the item as being completed
await client.Api.Items[new(itemId)].Complete.PostAsync(cancellationToken: cancellationToken);

item = await client.Api.Items[new(itemId)].GetAsync(cancellationToken: cancellationToken);

Assert.NotNull(item);
Assert.Equal(itemId, item.Id);
Assert.Equal(text, item.Text);
Assert.NotNull(item.CompletedAt);
Assert.Equal(item.CompletedAt.Value, item.LastUpdated);
Assert.True(item.CompletedAt.Value > item.CreatedAt);

// Act - Get all the items
items = await client.Api.Items.GetAsync(cancellationToken: cancellationToken);

// Assert - The item was completed
Assert.NotNull(items);
Assert.NotNull(items.Items);
Assert.Equal(beforeCount + 1, items.Items.Count);
Assert.Contains(items.Items, (x) => x.Id == itemId);

item = items.Items.Last();

Assert.NotNull(item);
Assert.Equal(itemId, item.Id);
Assert.Equal(text, item.Text);
Assert.NotNull(item.CompletedAt);
Assert.Equal(item.CompletedAt.Value, item.LastUpdated);
Assert.True(item.CompletedAt.Value > item.CreatedAt);

// Act - Delete the item
await client.Api.Items[new(itemId)].DeleteAsync(cancellationToken: cancellationToken);

// Assert - The item no longer exists
items = await client.Api.Items.GetAsync(cancellationToken: cancellationToken);

Assert.NotNull(items);
Assert.NotNull(items.Items);
Assert.Equal(beforeCount, items.Items.Count);
Assert.DoesNotContain(items.Items, (x) => x.Id == itemId);

// Act
var problem = await Assert.ThrowsAsync<ProblemDetails>(
() => client.Api.Items[new(itemId)].GetAsync(cancellationToken: cancellationToken));

// Assert
Assert.NotNull(problem);
Assert.Equal(StatusCodes.Status404NotFound, problem.Status);
Assert.Equal("Not Found", problem.Title);
Assert.Equal("Item not found.", problem.Detail);
Assert.Equal("https://tools.ietf.org/html/rfc9110#section-15.5.5", problem.Type);
Assert.Null(problem.Instance);

// Act
problem = await Assert.ThrowsAsync<ProblemDetails>(
() => client.Api.Items[new(itemId)].Complete.PostAsync(cancellationToken: cancellationToken));

// Assert
Assert.NotNull(problem);
Assert.Equal(StatusCodes.Status404NotFound, problem.Status);
Assert.Equal("Not Found", problem.Title);
Assert.Equal("Item not found.", problem.Detail);
Assert.Equal("https://tools.ietf.org/html/rfc9110#section-15.5.5", problem.Type);
Assert.Null(problem.Instance);

// Act
problem = await Assert.ThrowsAsync<ProblemDetails>(
() => client.Api.Items[new(itemId)].Priority.PatchAsync(new() { Priority = TodoPriority.Low }, cancellationToken: cancellationToken));

// Assert
Assert.NotNull(problem);
Assert.Equal(StatusCodes.Status404NotFound, problem.Status);
Assert.Equal("Not Found", problem.Title);
Assert.Equal("Item not found.", problem.Detail);
Assert.Equal("https://tools.ietf.org/html/rfc9110#section-15.5.5", problem.Type);
Assert.Null(problem.Instance);
});
}

[Fact]
public async Task Cannot_Create_Todo_Item_With_No_Text()
{
// Arrange
await WithTodoAppClientAsync(async (client) =>
{
var cancellationToken = TestContext.Current.CancellationToken;

// Act
var problem = await Assert.ThrowsAsync<ProblemDetails>(
() => client.Api.Items.PostAsync(new() { Text = string.Empty }, cancellationToken: cancellationToken));

// Assert
Assert.NotNull(problem);
Assert.Equal(StatusCodes.Status400BadRequest, problem.Status);
Assert.Equal("Bad Request", problem.Title);
Assert.Equal("No item text specified.", problem.Detail);
Assert.Equal("https://tools.ietf.org/html/rfc9110#section-15.5.1", problem.Type);
Assert.Null(problem.Instance);
});
}

[Fact]
public async Task Cannot_Complete_Todo_Item_Multiple_Times()
{
// Arrange
await WithTodoAppClientAsync(async (client) =>
{
var cancellationToken = TestContext.Current.CancellationToken;

var createdItem = await client.Api.Items.PostAsync(
new() { Text = "Something" },
cancellationToken: cancellationToken);

await client.Api.Items[new(createdItem.Id)].Complete.PostAsync(cancellationToken: cancellationToken);

// Act
var problem = await Assert.ThrowsAsync<ProblemDetails>(
() => client.Api.Items[new(createdItem.Id)].Complete.PostAsync(cancellationToken: cancellationToken));

// Assert
Assert.NotNull(problem);
Assert.Equal(StatusCodes.Status400BadRequest, problem.Status);
Assert.Equal("Bad Request", problem.Title);
Assert.Equal("Item already completed.", problem.Detail);
Assert.Equal("https://tools.ietf.org/html/rfc9110#section-15.5.1", problem.Type);
Assert.Null(problem.Instance);
});
}

[Fact]
public async Task Cannot_Complete_Deleted_Todo_Item()
{
// Arrange
await WithTodoAppClientAsync(async (client) =>
{
var cancellationToken = TestContext.Current.CancellationToken;

var createdItem = await client.Api.Items.PostAsync(
new() { Text = "Something" },
cancellationToken: cancellationToken);

await client.Api.Items[new(createdItem.Id)].DeleteAsync(cancellationToken: cancellationToken);

// Act
var problem = await Assert.ThrowsAsync<ProblemDetails>(
() => client.Api.Items[new(createdItem.Id)].Complete.PostAsync(cancellationToken: cancellationToken));

// Assert
Assert.NotNull(problem);
Assert.Equal(StatusCodes.Status404NotFound, problem.Status);
Assert.Equal("Not Found", problem.Title);
Assert.Equal("Item not found.", problem.Detail);
Assert.Equal("https://tools.ietf.org/html/rfc9110#section-15.5.5", problem.Type);
Assert.Null(problem.Instance);
});
}

[Fact]
public async Task Cannot_Delete_Todo_Item_Multiple_Times()
public async Task VerifyKiotaTodoAppClient()
{
// Arrange
await WithTodoAppClientAsync(async (client) =>
{
var cancellationToken = TestContext.Current.CancellationToken;

var createdItem = await client.Api.Items.PostAsync(
new() { Text = "Something" },
cancellationToken: cancellationToken);

await client.Api.Items[new(createdItem.Id)].DeleteAsync(cancellationToken: cancellationToken);

// Act
var problem = await Assert.ThrowsAsync<ProblemDetails>(
() => client.Api.Items[new(createdItem.Id)].DeleteAsync(cancellationToken: cancellationToken));

// Assert
Assert.NotNull(problem);
Assert.Equal(StatusCodes.Status404NotFound, problem.Status);
Assert.Equal("Not Found", problem.Title);
Assert.Equal("Item not found.", problem.Detail);
Assert.Equal("https://tools.ietf.org/html/rfc9110#section-15.5.5", problem.Type);
Assert.Null(problem.Instance);
});
await VerifyDirectory(
Path.Combine(GetProjectRoot(), "KiotaTodoClient"),
pattern: "*.cs",
options: new() { RecurseSubdirectories = true }).UseDirectory("snapshots");
}

[Fact]
public async Task VerifyKiotaTodoAppClient()
public async Task VerifyNSwagTodoAppClient()
{
await VerifyDirectory(
Path.Combine(GetProjectRoot(), "TodoClient"),
Path.Combine(GetProjectRoot(), "NSwagTodoClient"),
pattern: "*.cs",
options: new() { RecurseSubdirectories = true }).UseDirectory("snapshots");
}
Expand All @@ -345,18 +105,6 @@ private static string GetProjectRoot() =>
.GetCustomAttributes<AssemblyMetadataAttribute>()
.First((p) => p.Key is "ProjectRoot")
.Value!;

private static async Task WithTodoAppClientAsync(Func<TodoApiClient, Task> callback)
{
using var httpClient = SwaggerIntegrationTests.GetHttpClientForTestApplication(typeof(TodoApp.Program));

var provider = new AnonymousAuthenticationProvider();
using var request = new HttpClientRequestAdapter(provider, httpClient: httpClient);

var client = new TodoApiClient(request);

await callback(client);
}
}

#endif
Loading
Loading