Skip to content

Stabilize configuration polling reload tests #131876

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
rosebyte merged 2 commits into from
Aug 8, 2026
+77 −19
Merged

Stabilize configuration polling reload tests #131876

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3599c69
Stabilize configuration polling reload tests
svick Aug 5, 2026
43e6309
Added explanatory comment
svick Aug 6, 2026
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
96 changes: 77 additions & 19 deletions src/libraries/Microsoft.Extensions.Configuration/tests/FunctionalTests/ConfigurationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,6 @@ public void OnLoadErrorWillBeCalledOnIniLoadError()
}

[Fact]
[ActiveIssue("File watching is flaky (particularly on non windows. https://github.com/dotnet/runtime/issues/42036")]
public void CanSetValuesAndReloadValues()
{
WriteTestFiles();
Expand Down Expand Up @@ -498,7 +497,10 @@ public async Task ReloadOnChangeWorksAfterError()
Assert.Equal("JsonValue1", config["JsonKey1"]);

// Introduce an error and make sure the old key is removed
_fileSystem.WriteFile("reload.json", @"{""JsonKey1"": ");
await WriteFilesForReload(
config,
() => _fileSystem.WriteFile("reload.json", @"{""JsonKey1"": "),
Path.Combine(_fileSystem.RootPath, "reload.json"));

await WaitForChange(
() => config["JsonKey1"] == null,
Expand All @@ -507,7 +509,10 @@ await WaitForChange(
Assert.Null(config["JsonKey1"]);

// Update the file again to make sure the config is updated
_fileSystem.WriteFile("reload.json", @"{""JsonKey1"": ""JsonValue2""}");
await WriteFilesForReload(
config,
() => _fileSystem.WriteFile("reload.json", @"{""JsonKey1"": ""JsonValue2""}"),
Path.Combine(_fileSystem.RootPath, "reload.json"));

await WaitForChange(
() => config["JsonKey1"] == "JsonValue2",
Expand Down Expand Up @@ -639,7 +644,6 @@ public void LoadIoErrorRaisesOnLoadException()
}

[Fact]
[ActiveIssue("File watching is flaky (particularly on non windows. https://github.com/dotnet/runtime/issues/42036")]
public async Task ReloadDataErrorRaisesOnLoadException()
{
const string FileName = $"{nameof(ReloadDataErrorRaisesOnLoadException)}.json";
Expand Down Expand Up @@ -672,7 +676,10 @@ public async Task ReloadDataErrorRaisesOnLoadException()
Assert.Equal("JsonValue1", cfgRoot["JsonKey1"]);
Assert.False(reloadToken.HasChanged);

_fileSystem.WriteFile(FileName, @"{""JsonKey1"": ");
await WriteFilesForReload(
cfgRoot,
() => _fileSystem.WriteFile(FileName, @"{""JsonKey1"": "),
Path.Combine(_fileSystem.RootPath, FileName));

await WaitForChange(() => failingProvider != null, "File change did not raise OnLoadException event in time.");

Expand All @@ -685,7 +692,6 @@ public async Task ReloadDataErrorRaisesOnLoadException()

[Fact]
[PlatformSpecific(TestPlatforms.Windows)]
[ActiveIssue("File watching is flaky (particularly on non windows. https://github.com/dotnet/runtime/issues/42036")]
public async Task ReloadIoErrorRaisesOnLoadException()
{
const string FileName = $"{nameof(ReloadIoErrorRaisesOnLoadException)}.json";
Expand Down Expand Up @@ -720,8 +726,11 @@ public async Task ReloadIoErrorRaisesOnLoadException()

using (_fileSystem.LockFileReading(FileName))
{
// we need NoWait because Wait reads file under the hood and that is restricted in LockFileReading context
_fileSystem.WriteFileNoWait(FileName, @"{""JsonKey1"": ""JsonValue1Updated"" }");
await WriteFilesForReload(
cfgRoot,
// we need NoWait because Wait reads file under the hood and that is restricted in LockFileReading context
() => _fileSystem.WriteFileNoWait(FileName, @"{""JsonKey1"": ""JsonValue1Updated"" }"),
Path.Combine(_fileSystem.RootPath, FileName));

await WaitForChange(() => failingProvider != null, "File change did not raise OnLoadException event in time.");
Assert.IsType<IOException>(failureException);
Expand Down Expand Up @@ -752,9 +761,17 @@ public async Task TouchingFileWillReload()
var token = config.GetReloadToken();

// Update files
_fileSystem.WriteFile("reload.json", @"{""JsonKey1"": ""JsonValue2""}");
_fileSystem.WriteFile("reload.ini", @"IniKey1 = IniValue2");
_fileSystem.WriteFile("reload.xml", @"<settings XmlKey1=""XmlValue2""/>");
await WriteFilesForReload(
config,
() =>
{
_fileSystem.WriteFile("reload.json", @"{""JsonKey1"": ""JsonValue2""}");
_fileSystem.WriteFile("reload.ini", @"IniKey1 = IniValue2");
_fileSystem.WriteFile("reload.xml", @"<settings XmlKey1=""XmlValue2""/>");
},
Path.Combine(_fileSystem.RootPath, "reload.json"),
Path.Combine(_fileSystem.RootPath, "reload.ini"),
Path.Combine(_fileSystem.RootPath, "reload.xml"));

await WaitForChange(
() => config["JsonKey1"] == "JsonValue2"
Expand All @@ -769,7 +786,6 @@ await WaitForChange(
}

[Fact]
[ActiveIssue("File watching is flaky (particularly on non windows. https://github.com/dotnet/runtime/issues/42036")]
public async Task CreatingOptionalFileInNonExistentDirectoryWillReload()
{
var directory = Path.GetRandomFileName();
Expand Down Expand Up @@ -803,7 +819,6 @@ await WaitForChange(
}

[Theory]
[ActiveIssue("File watching is flaky (particularly on non windows. https://github.com/dotnet/runtime/issues/42036")]
[InlineData(false)]
[InlineData(true)]
public async Task DeletingFilesThatRedefineKeysWithReload(bool optional)
Expand Down Expand Up @@ -884,7 +899,6 @@ await WaitForChange(
}

[Theory]
[ActiveIssue("File watching is flaky (particularly on non windows. https://github.com/dotnet/runtime/issues/42036")]
[InlineData(false)]
[InlineData(true)]
public async Task DeletingFileWillReload(bool optional)
Expand Down Expand Up @@ -923,7 +937,6 @@ await WaitForChange(
}

[Fact]
[ActiveIssue("File watching is flaky (particularly on non windows. https://github.com/dotnet/runtime/issues/42036")]
public async Task CreatingWritingDeletingCreatingFileWillReload()
{
var config = CreateBuilder()
Expand Down Expand Up @@ -955,9 +968,17 @@ await WaitForChange(

var writeToken = config.GetReloadToken();

_fileSystem.WriteFile(_jsonFile, @"{""JsonKey1"": ""JsonValue2""}");
_fileSystem.WriteFile(_iniFile, @"IniKey1 = IniValue2");
_fileSystem.WriteFile(_xmlFile, @"<settings XmlKey1=""XmlValue2""/>");
await WriteFilesForReload(
config,
() =>
{
_fileSystem.WriteFile(_jsonFile, @"{""JsonKey1"": ""JsonValue2""}");
_fileSystem.WriteFile(_iniFile, @"IniKey1 = IniValue2");
_fileSystem.WriteFile(_xmlFile, @"<settings XmlKey1=""XmlValue2""/>");
},
Path.Combine(_fileSystem.RootPath, _jsonFile),
Path.Combine(_fileSystem.RootPath, _iniFile),
Path.Combine(_fileSystem.RootPath, _xmlFile));

await WaitForChange(
() => config["JsonKey1"] == "JsonValue2"
Expand Down Expand Up @@ -1128,7 +1149,10 @@ public async Task TouchingFileWillReloadForUserSecrets()
var token = config.GetReloadToken();

// Update file
_fileSystem.WriteFile(userSecretsPath, @"{""UserSecretKey1"": ""UserSecretValue2""}");
await WriteFilesForReload(
config,
() => _fileSystem.WriteFile(userSecretsPath, @"{""UserSecretKey1"": ""UserSecretValue2""}"),
userSecretsPath);

await WaitForChange(
() => config["UserSecretKey1"] == "UserSecretValue2",
Expand Down Expand Up @@ -1219,6 +1243,40 @@ private async Task WaitForChange(
}
}

// UseActivePolling is the reliable post-initialization indicator, not UsePollingFileWatcher,
// until https://github.com/dotnet/runtime/issues/131871 is fixed.
private static bool UsesPolling(IConfigurationRoot config) =>
config.Providers
.OfType<FileConfigurationProvider>()
.Any(provider => provider.Source.FileProvider is PhysicalFileProvider { UseActivePolling: true });

private async Task WriteFilesForReload(IConfigurationRoot config, Action writeFiles, params string[] filePaths)
{
DateTime[] previousWriteTimes = null;

if (UsesPolling(config))
{
// Polling detects overwrites by timestamp, so ensure the new write gets a different timestamp.
previousWriteTimes = filePaths.Select(File.GetLastWriteTimeUtc).ToArray();
DateTime latestWriteTime = previousWriteTimes.Max();
TimeSpan delay = latestWriteTime.AddSeconds(1) - DateTime.UtcNow;
if (delay > TimeSpan.Zero)
{
await Task.Delay(delay);
}
}

writeFiles();

if (previousWriteTimes is not null)
{
for (int i = 0; i < filePaths.Length; i++)
{
Assert.NotEqual(previousWriteTimes[i], File.GetLastWriteTimeUtc(filePaths[i]));
}
}
}

private sealed class MyOptions
{
public string CmdKey1 { get; set; }
Expand Down
Loading