feat: HttpMock.Aspire.Hosting — first-class Aspire 13 resource for HttpMock stub servers by Copilot · Pull Request #130 · hibri/HttpMock

Copilot · 2026-04-17T14:05:56Z

Ships HttpMock.Aspire.Hosting, a new NuGet package that registers an HttpMock stub server as a proper Aspire resource. Eliminates manual port allocation, appHost.Configuration[...] overrides, and FindAvailablePort boilerplate from test projects.

New package: `HttpMock.Aspire.Hosting` (net10.0, Aspire 13.2.2)

HttpMockResource — Resource + IResourceWithConnectionString + IDisposable. Public Url (read after start) and MockServer (for stub configuration in tests).
HttpMockEventingSubscriber — IDistributedApplicationEventingSubscriber (Aspire 13 eventing API). Starts the server in BeforeStartEvent, publishes Running state to the dashboard, disposes on teardown.
HttpMockResourceBuilderExtensions.AddHttpMock() — single fluent entry point via TryAddEventingSubscriber.

// App host
var mock = builder.AddHttpMock("external-weather-api");
builder.AddProject<Projects.WeatherApi>("weatherapi").WithReference(mock);

// Test — no port bookkeeping, no config overrides
var resource = app.Services.GetRequiredService<DistributedApplicationModel>()
    .Resources.OfType<HttpMockResource>().Single(r => r.Name == "external-weather-api");

resource.MockServer!
    .WithNewContext()
    .Stub(x => x.Get("/api/weather"))
    .Return(json).AsContentType("application/json").OK();

`HttpMockRepository.FindFreePort()` — consolidated port allocation

Replaced the ad-hoc lsof-based PortHelper.FindLocalAvailablePortForTesting() and the private FindFreePort() in HttpMockEventingSubscriber with a single public TcpListener(port 0) implementation on HttpMockRepository. Both former callers now delegate to it.

New test projects

HttpMock.Aspire.Hosting.Tests — 5 unit/subscriber tests; in-process, no DCP required. Subscriber test fires BeforeStartEvent directly via a CapturingEventing test double.
HttpMock.Aspire.Hosting.IntegrationTests.AppHost — minimal Aspire.AppHost.Sdk host registering AddHttpMock("mock-api").
HttpMock.Aspire.Hosting.IntegrationTests — full lifecycle via Aspire.Hosting.Testing: start → stub → real HTTP calls. Covers GET/POST, JSON, status codes, WithNewContext isolation, and connection-string expression.

Updated

examples/AspireExample — AppHost and tests use AddHttpMock/WithReference; README.md updated.
Root README.md — new Finding a Free Port and .NET Aspire Integration sections replace the stale manual example.
publish.yml — packs HttpMock.Aspire.Hosting on release alongside existing packages.

…ting subscriber, and fluent extension Agent-Logs-Url: https://github.com/hibri/HttpMock/sessions/140eba6b-a97a-4bd8-841f-9781fddde147 Co-authored-by: hibri <122442+hibri@users.noreply.github.com>

…ockServer null guard Agent-Logs-Url: https://github.com/hibri/HttpMock/sessions/140eba6b-a97a-4bd8-841f-9781fddde147 Co-authored-by: hibri <122442+hibri@users.noreply.github.com>

Agent-Logs-Url: https://github.com/hibri/HttpMock/sessions/140eba6b-a97a-4bd8-841f-9781fddde147 Co-authored-by: hibri <122442+hibri@users.noreply.github.com>

…rt(); make HttpMockResource.Url public Agent-Logs-Url: https://github.com/hibri/HttpMock/sessions/140eba6b-a97a-4bd8-841f-9781fddde147 Co-authored-by: hibri <122442+hibri@users.noreply.github.com>

…nd integration-test link Agent-Logs-Url: https://github.com/hibri/HttpMock/sessions/d77ab419-5192-490c-8f7d-aa086b54ff9f Co-authored-by: hibri <122442+hibri@users.noreply.github.com>

Copilot

Pull request overview

Adds first-class .NET Aspire Hosting integration for HttpMock by introducing a new HttpMock.Aspire.Hosting package that registers and manages HttpMock stub servers as Aspire resources, plus consolidates free-port selection into the core library.

Changes:

Introduces HttpMock.Aspire.Hosting package with HttpMockResource, HttpMockEventingSubscriber, and AddHttpMock() builder extension.
Adds HttpMockRepository.FindFreePort() and updates test helpers to use it instead of ad-hoc port probing.
Adds unit + integration test projects for the Aspire hosting integration and updates the Aspire example + README guidance.

Reviewed changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/HttpMock/HttpMockRepository.cs	Adds `FindFreePort()` helper to centralize port allocation.
src/HttpMock.Integration.Tests/PortHelper.cs	Replaces custom port probing with `HttpMockRepository.FindFreePort()`.
src/HttpMock.Aspire.Hosting/HttpMockResourceBuilderExtensions.cs	Adds `AddHttpMock()` fluent registration entry point for app hosts.
src/HttpMock.Aspire.Hosting/HttpMockResource.cs	Defines Aspire resource model for an HttpMock server (URL + server handle + connection string expression).
src/HttpMock.Aspire.Hosting/HttpMockEventingSubscriber.cs	Starts/stops HttpMock servers via Aspire lifecycle eventing and publishes resource state/URL.
src/HttpMock.Aspire.Hosting/HttpMock.Aspire.Hosting.csproj	New packable project for Aspire hosting integration.
src/HttpMock.Aspire.Hosting.Tests/HttpMockResourceTests.cs	Unit + in-process subscriber tests for the new Aspire resource.
src/HttpMock.Aspire.Hosting.Tests/HttpMock.Aspire.Hosting.Tests.csproj	New test project for the Aspire hosting integration.
src/HttpMock.Aspire.Hosting.IntegrationTests/HttpMockResourceIntegrationTests.cs	End-to-end lifecycle tests using `Aspire.Hosting.Testing`.
src/HttpMock.Aspire.Hosting.IntegrationTests/HttpMock.Aspire.Hosting.IntegrationTests.csproj	New integration test project referencing the AppHost + hosting package.
src/HttpMock.Aspire.Hosting.IntegrationTests.AppHost/HttpMock.Aspire.Hosting.IntegrationTests.AppHost.csproj	Minimal Aspire AppHost used by integration tests.
src/HttpMock.Aspire.Hosting.IntegrationTests.AppHost/AppHost.cs	Registers `AddHttpMock("mock-api")` in the test AppHost.
examples/AspireExample/README.md	Updates example docs to use `AddHttpMock` and resource-based stubbing.
examples/AspireExample/AspireExample.Tests/IntegrationTest1.cs	Updates example tests to discover `HttpMockResource` and configure stubs via `MockServer`.
examples/AspireExample/AspireExample.Tests/AspireExample.Tests.csproj	Switches example test dependency to `HttpMock.Aspire.Hosting` and adds required usings.
examples/AspireExample/AspireExample.AppHost/AspireExample.AppHost.csproj	References `HttpMock.Aspire.Hosting` as a non-resource dependency.
examples/AspireExample/AspireExample.AppHost/AppHost.cs	Registers HttpMock as a first-class Aspire resource instead of a connection string override.
README.md	Replaces stale Aspire instructions with new `HttpMock.Aspire.Hosting` guidance + `FindFreePort()` section.
HttpMock.sln	Adds new projects to the solution and extends configurations.
.github/workflows/publish.yml	Packs and publishes the new `HttpMock.Aspire.Hosting` package on release.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

hibri · 2026-04-21T19:30:31Z

+    /// resource.MockServer.WithNewContext().Stub(x => x.Get("/path")).Return("body").OK();
+    /// </code>
+    /// </summary>
+    public IHttpServer? MockServer { get; internal set; }


@copilot Import the HttpMock namespace

using HttpMock; was already added to HttpMockResource.cs in d7b4765 (line 2). No further changes needed.

hibri · 2026-04-17T15:26:34Z

+                var port = HttpMockRepository.FindFreePort();
+                var url = $"http://localhost:{port}";
+
+                resource.Url = url;
+                resource.MockServer = new HttpServer(new Uri(url));


@copilot apply changes based on this feedback

Done in d7b4765. Added explicit using HttpMock; to HttpMockEventingSubscriber.cs, HttpMockResource.cs, and HttpMockResourceTests.cs. Also replaced the hard-coded port 59998 in the Dispose_ClearsMockServerProperty test with HttpMockRepository.FindFreePort() so it can't collide with other tests or processes.

+    public void Dispose_ClearsMockServerProperty()
+    {
+        var resource = new HttpMockResource("test");
+        resource.MockServer = HttpMockRepository.At("http://localhost:59998");


Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

…ndFreePort() Agent-Logs-Url: https://github.com/hibri/HttpMock/sessions/888e1a44-f8df-4830-a549-32b056e778b2 Co-authored-by: hibri <122442+hibri@users.noreply.github.com>

hibri · 2026-04-21T19:18:33Z

-}
+namespace HttpMock.Integration.Tests
+{
+internal static class PortHelper


@copilot remove the PortHelper class and update its usages with HttpMock.HttpMockRepository.FindFreePort();

Done in 661bcb1. Deleted PortHelper.cs and updated HostHelper.cs and HttpServerTests.cs to call HttpMockRepository.FindFreePort() directly.

…indFreePort() Agent-Logs-Url: https://github.com/hibri/HttpMock/sessions/d30c5893-49ac-4eb2-862d-e2d86a96938a Co-authored-by: hibri <122442+hibri@users.noreply.github.com>

…pire' into copilot/evaluate-httpmock-net-aspire

Copilot AI and others added 5 commits April 17, 2026 13:44

feat: add HttpMock.Aspire.Hosting package with HttpMockResource, even…

487fc6d

…ting subscriber, and fluent extension Agent-Logs-Url: https://github.com/hibri/HttpMock/sessions/140eba6b-a97a-4bd8-841f-9781fddde147 Co-authored-by: hibri <122442+hibri@users.noreply.github.com>

fix: address code review comments — document FindFreePort race, add M…

4a1a6aa

…ockServer null guard Agent-Logs-Url: https://github.com/hibri/HttpMock/sessions/140eba6b-a97a-4bd8-841f-9781fddde147 Co-authored-by: hibri <122442+hibri@users.noreply.github.com>

chore: plan FindFreePort consolidation

6291d8b

Agent-Logs-Url: https://github.com/hibri/HttpMock/sessions/140eba6b-a97a-4bd8-841f-9781fddde147 Co-authored-by: hibri <122442+hibri@users.noreply.github.com>

refactor: consolidate FindFreePort into HttpMockRepository.FindFreePo…

023f089

…rt(); make HttpMockResource.Url public Agent-Logs-Url: https://github.com/hibri/HttpMock/sessions/140eba6b-a97a-4bd8-841f-9781fddde147 Co-authored-by: hibri <122442+hibri@users.noreply.github.com>

docs: update README with HttpMock.Aspire.Hosting API, FindFreePort, a…

e98a9d9

…nd integration-test link Agent-Logs-Url: https://github.com/hibri/HttpMock/sessions/d77ab419-5192-490c-8f7d-aa086b54ff9f Co-authored-by: hibri <122442+hibri@users.noreply.github.com>

Copilot AI assigned Copilot and hibri Apr 17, 2026

Copilot created this pull request from a session on behalf of hibri April 17, 2026 14:05 View session

hibri requested a review from Copilot April 17, 2026 14:08

Copilot started reviewing on behalf of hibri April 17, 2026 14:09 View session

Copilot AI reviewed Apr 17, 2026

View reviewed changes

hibri and others added 2 commits April 17, 2026 16:25

Potential fix for pull request finding

0ad00be

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Potential fix for pull request finding

c5e270d

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot started work on behalf of hibri April 17, 2026 15:26 View session

fix: add explicit using HttpMock; and replace hard-coded port with Fi…

d7b4765

…ndFreePort() Agent-Logs-Url: https://github.com/hibri/HttpMock/sessions/888e1a44-f8df-4830-a549-32b056e778b2 Co-authored-by: hibri <122442+hibri@users.noreply.github.com>

Copilot AI requested a review from hibri April 17, 2026 15:30

Copilot finished work on behalf of hibri April 17, 2026 15:30

Copilot started work on behalf of hibri April 17, 2026 15:30 View session

Copilot finished work on behalf of hibri April 17, 2026 15:32

hibri reviewed Apr 21, 2026

View reviewed changes

Copilot started work on behalf of hibri April 21, 2026 19:18 View session

refactor: remove PortHelper, replace usages with HttpMockRepository.F…

661bcb1

…indFreePort() Agent-Logs-Url: https://github.com/hibri/HttpMock/sessions/d30c5893-49ac-4eb2-862d-e2d86a96938a Co-authored-by: hibri <122442+hibri@users.noreply.github.com>

Copilot finished work on behalf of hibri April 21, 2026 19:22

Copilot AI requested a review from hibri April 21, 2026 19:22

hibri added 5 commits April 21, 2026 20:25

remove NuGet.exe

99adc47

Merge remote-tracking branch 'origin/copilot/evaluate-httpmock-net-as…

a317671

…pire' into copilot/evaluate-httpmock-net-aspire

delete

a2b4853

delete

b313e9d

remove solution folder

81b984c

Copilot started work on behalf of hibri April 21, 2026 19:30 View session

Copilot finished work on behalf of hibri April 21, 2026 19:32

hibri marked this pull request as ready for review April 22, 2026 18:57

hibri added 2 commits April 22, 2026 19:57

fix test project naming

d4974e2

fix test project naming

b5653cc

hibri approved these changes Apr 22, 2026

View reviewed changes

hibri merged commit e8acabe into master Apr 22, 2026
1 check passed

hibri deleted the copilot/evaluate-httpmock-net-aspire branch April 22, 2026 19:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: HttpMock.Aspire.Hosting — first-class Aspire 13 resource for HttpMock stub servers#130

feat: HttpMock.Aspire.Hosting — first-class Aspire 13 resource for HttpMock stub servers#130
hibri merged 16 commits intomasterfrom
copilot/evaluate-httpmock-net-aspire

Copilot AI commented Apr 17, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

hibri Apr 21, 2026

Uh oh!

Copilot AI Apr 21, 2026

Uh oh!

hibri Apr 17, 2026

Uh oh!

hibri Apr 17, 2026

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

hibri Apr 21, 2026

Uh oh!

Copilot AI Apr 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Copilot AI commented Apr 17, 2026

New package: HttpMock.Aspire.Hosting (net10.0, Aspire 13.2.2)

HttpMockRepository.FindFreePort() — consolidated port allocation

New test projects

Updated

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

hibri Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

hibri Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

hibri Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

hibri Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

New package: `HttpMock.Aspire.Hosting` (net10.0, Aspire 13.2.2)

`HttpMockRepository.FindFreePort()` — consolidated port allocation