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.

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 a new UseKestel API to the WebApplicationFactory #60635

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

mkArtakMSFT
Copy link
Member

@mkArtakMSFT mkArtakMSFT commented Feb 26, 2025

  • Added UseKestrel() API to the WebApplicationFactory type. The API configures the WAF, so that later during initialization it will use Kestrel, instead of a TestServer for WebHostBuilder-based applications.
  • Renamed the EnsureServer() private method to Initialize() and made it public, so that consumders can call it directly, without the need of creating a client, as in many situations customers didn't need a client to interact with.

This is an alternative design to enabling real server usage with WebApplicationFactory, which was considered here: #60247

@dotnet-issue-labeler dotnet-issue-labeler bot added the area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates label Feb 26, 2025
@KSemenenko
Copy link

This is an amazing idea!

@mkArtakMSFT mkArtakMSFT marked this pull request as ready for review March 4, 2025 20:21
@Copilot Copilot bot review requested due to automatic review settings March 4, 2025 20:21
@mkArtakMSFT mkArtakMSFT requested a review from a team as a code owner March 4, 2025 20:21
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Overview

This PR introduces an alternative design for enabling real server usage with WebApplicationFactory by adding a new API that leverages Kestrel. Key changes include:

  • Adding a new test class (RealServerBackedIntegrationTests.cs) that validates the real server integration.
  • Introducing a new WebApplicationFactory subclass (KestrelBasedWapFactory.cs) that automatically enables Kestrel.
  • Updating the core WebApplicationFactory implementation to conditionally use a Kestrel server versus the traditional TestServer.

Reviewed Changes

File Description
src/Mvc/test/Mvc.FunctionalTests/RealServerBackedIntegrationTests.cs New integration tests for real server backed functionality.
src/Mvc/test/Mvc.FunctionalTests/KestrelBasedWapFactory.cs A factory that configures the WebApplicationFactory to use Kestrel.
src/Mvc/Mvc.Testing/src/WebApplicationFactory.cs Modifications to support the new UseKestrel API, including updated server creation, client configuration, and error handling.

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-mvc Includes: MVC, Actions and Controllers, Localization, CORS, most templates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add UseKestrel() API to the WebApplicationFactory
5 participants