C3D.Extensions.Networking.PortAllocator

Network port allocator for use with unit tests, playwright, aspire, etc.

Based on code originally from CZEMacLeod/C3D.Extensions.Playwright.AspNetCore and CZEMacLeod/C3D.Extensions.Aspire

Specifically, this library provides a way to allocate ports for testing purposes, ensuring that the ports are available and not in use by other applications. It avoids ports which are blacklisted by common browsers such as firefox and chromium, avoiding requiring the use of network.security.ports.banned.override or --explicitly-allowed-ports options.

Installation

You can install the package via NuGet:

dotnet add package C3D.Extensions.Networking.PortAllocator

Usage

To use the port allocator, you can create an instance of PortAllocator and call the GetRandomFreePort method to get an available port.

using C3D.Extensions.Networking; var portAllocator = new PortAllocator(); int port = portAllocator.GetRandomFreePort(); Console.WriteLine($"Allocated port: {port}");

PortAllocator supports dependency injection, so you can register it in your Startup.cs or Program.cs file:

using C3D.Extensions.Networking; services.AddSingleton<PortAllocator>();

You can then inject PortAllocator into your classes and use it to allocate ports as needed. When using dependency injection, actions will be logged using the ILogger<PortAllocator> interface, which you can configure in your application.

You can also just use the default instance provided by the PortAllocator.Instance property:

using C3D.Extensions.Networking; int port = PortAllocator.Instance.GetRandomFreePort();