|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Net;
using System.Net.Sockets;
using System.Threading.Tasks;
using Xunit;
using Microsoft.AspNetCore.Server.IIS.FunctionalTests.Utilities;
using Microsoft.AspNetCore.Server.IntegrationTesting;
using Microsoft.AspNetCore.InternalTesting;
#if !IIS_FUNCTIONALS
using Microsoft.AspNetCore.Server.IIS.FunctionalTests;
#if IISEXPRESS_FUNCTIONALS
namespace Microsoft.AspNetCore.Server.IIS.IISExpress.FunctionalTests;
#elif NEWHANDLER_FUNCTIONALS
namespace Microsoft.AspNetCore.Server.IIS.NewHandler.FunctionalTests;
#elif NEWSHIM_FUNCTIONALS
namespace Microsoft.AspNetCore.Server.IIS.NewShim.FunctionalTests;
#endif
#else
namespace Microsoft.AspNetCore.Server.IIS.FunctionalTests;
#endif
[Collection(PublishedSitesCollection.Name)]
[SkipOnHelix("Unsupported queue", Queues = "Windows.Amd64.VS2022.Pre.Open;")]
public class AspNetCorePortTests : IISFunctionalTestBase
{
// Port range allowed by ANCM config
private const int _minPort = 1025;
private const int _maxPort = 48000;
public AspNetCorePortTests(PublishedSitesFixture fixture) : base(fixture)
{
}
public static TestMatrix TestVariants
=> TestMatrix.ForServers(DeployerSelector.ServerType)
.WithTfms(Tfm.Default)
.WithApplicationTypes(ApplicationType.Portable);
public static IEnumerable<object[]> InvalidTestVariants
=> from v in TestVariants.Select(v => v.Single())
from s in new string[] { (_minPort - 1).ToString(CultureInfo.InvariantCulture), (_maxPort + 1).ToString(CultureInfo.InvariantCulture), "noninteger" }
select new object[] { v, s };
[ConditionalTheory]
[MemberData(nameof(TestVariants))]
public async Task EnvVarInWebConfig_Valid(TestVariant variant)
{
// Must publish to set env vars in web.config
var deploymentParameters = Fixture.GetBaseDeploymentParameters(variant);
var port = GetUnusedRandomPort();
deploymentParameters.WebConfigBasedEnvironmentVariables["ASPNETCORE_PORT"] = port.ToString(CultureInfo.InvariantCulture);
var deploymentResult = await DeployAsync(deploymentParameters);
var responseText = await deploymentResult.HttpClient.GetStringAsync("/ServerAddresses");
Assert.Equal(port, new Uri(responseText).Port);
}
[ConditionalTheory]
[MemberData(nameof(TestVariants))]
public async Task EnvVarInWebConfig_Empty(TestVariant variant)
{
// Must publish to set env vars in web.config
var deploymentParameters = Fixture.GetBaseDeploymentParameters(variant);
deploymentParameters.WebConfigBasedEnvironmentVariables["ASPNETCORE_PORT"] = string.Empty;
var deploymentResult = await DeployAsync(deploymentParameters);
var responseText = await deploymentResult.HttpClient.GetStringAsync("/ServerAddresses");
// If env var is empty, ANCM should assign a random port (same as no env var)
Assert.InRange(new Uri(responseText).Port, _minPort, _maxPort);
}
[ConditionalTheory]
[MemberData(nameof(InvalidTestVariants))]
public async Task EnvVarInWebConfig_Invalid(TestVariant variant, string port)
{
// Must publish to set env vars in web.config
var deploymentParameters = Fixture.GetBaseDeploymentParameters(variant);
deploymentParameters.WebConfigBasedEnvironmentVariables["ASPNETCORE_PORT"] = port;
var deploymentResult = await DeployAsync(deploymentParameters);
var response = await deploymentResult.HttpClient.GetAsync("/ServerAddresses");
Assert.Equal(HttpStatusCode.BadGateway, response.StatusCode);
}
[ConditionalTheory]
[MemberData(nameof(TestVariants))]
[RequiresNewShim]
public async Task ShutdownMultipleTimesWorks(TestVariant variant)
{
// Must publish to set env vars in web.config
var deploymentParameters = Fixture.GetBaseDeploymentParameters(variant);
var deploymentResult = await DeployAsync(deploymentParameters);
// Shutdown once
var response = await deploymentResult.HttpClient.GetAsync("/Shutdown");
// Wait for server to start again.
int i;
for (i = 0; i < 10; i++)
{
// ANCM should eventually recover from being shutdown multiple times.
response = await deploymentResult.HttpClient.GetAsync("/HelloWorld");
if (response.IsSuccessStatusCode)
{
break;
}
}
if (i == 10)
{
// Didn't restart after 10 retries
Assert.False(true);
}
// Shutdown again
response = await deploymentResult.HttpClient.GetAsync("/Shutdown");
// return if server starts again.
for (i = 0; i < 10; i++)
{
// ANCM should eventually recover from being shutdown multiple times.
response = await deploymentResult.HttpClient.GetAsync("/HelloWorld");
if (response.IsSuccessStatusCode)
{
return;
}
}
// Test failure if this happens.
Assert.False(true);
}
private static int GetUnusedRandomPort()
{
// Large number of retries to prevent test failures due to port collisions, but not infinite
// to prevent infinite loop in case Bind() fails repeatedly for some other reason.
const int retries = 100;
List<Exception> exceptions = null;
for (var i = 0; i < retries; i++)
{
var port = Random.Shared.Next(_minPort, _maxPort);
using (var socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp))
{
try
{
socket.Bind(new IPEndPoint(IPAddress.Loopback, port));
return port;
}
catch (Exception e)
{
// Bind failed, most likely because port is in use. Save exception and retry.
if (exceptions == null)
{
exceptions = new List<Exception>(retries);
}
exceptions.Add(e);
}
}
}
throw new AggregateException($"Unable to find unused random port after {retries} retries.", exceptions);
}
}
|