-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Respect AppContext.SetData with APP_CONFIG_FILE key (#56748)
* Respect AppContext.SetData with APP_CONFIG_FILE key * apply feedback (use BaseDirectory and FileCleanupTestBase) * avoid using GetFullPath with 2 arguments as it's not available everywhere * trim all directory separators rather than single * cleanupRootDirectory -> tempDirectory * fix absolute paths on linux
- Loading branch information
Showing
4 changed files
with
132 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
105 changes: 105 additions & 0 deletions
105
...m.Configuration.ConfigurationManager/tests/System/Configuration/ConfigurationPathTests.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
// Licensed to the .NET Foundation under one or more agreements. | ||
// The .NET Foundation licenses this file to you under the MIT license. | ||
|
||
using System.Configuration; | ||
using System.IO; | ||
using System.Runtime.CompilerServices; | ||
using Microsoft.DotNet.RemoteExecutor; | ||
using Xunit; | ||
|
||
namespace System.ConfigurationTests | ||
{ | ||
public class ConfigurationPathTests : FileCleanupTestBase | ||
{ | ||
public ConfigurationPathTests() : base(AppDomain.CurrentDomain.BaseDirectory) // We do not want the files go to temporary directory as that will not test the relative paths correctly | ||
{ | ||
} | ||
|
||
[ConditionalFact(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))] | ||
public void CustomAppConfigIsUsedWhenSpecifiedAsRelativePath() | ||
{ | ||
const string SettingName = "test_CustomAppConfigIsUsedWhenSpecified"; | ||
string expectedSettingValue = Guid.NewGuid().ToString(); | ||
string configFilePath = Path.Combine(GetTestDirectoryName(), CreateAppConfigFileWithSetting(SettingName, expectedSettingValue)); | ||
|
||
RemoteExecutor.Invoke((string configFilePath, string expectedSettingValue) => { | ||
// We change directory so that if product tries to read from the current directory which usually happens to be same as BaseDirectory the test will fail | ||
Environment.CurrentDirectory = Path.GetFullPath(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "..")); | ||
AppDomain.CurrentDomain.SetData("APP_CONFIG_FILE", configFilePath); | ||
Assert.Equal(expectedSettingValue, ConfigurationManager.AppSettings[SettingName]); | ||
}, configFilePath, expectedSettingValue).Dispose(); | ||
} | ||
|
||
[ConditionalFact(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))] | ||
public void CustomAppConfigIsUsedWhenSpecifiedAsAbsolutePath() | ||
{ | ||
const string SettingName = "test_CustomAppConfigIsUsedWhenSpecified"; | ||
string expectedSettingValue = Guid.NewGuid().ToString(); | ||
string configFilePath = Path.Combine(TestDirectory, CreateAppConfigFileWithSetting(SettingName, expectedSettingValue)); | ||
|
||
RemoteExecutor.Invoke((string configFilePath, string expectedSettingValue) => { | ||
AppDomain.CurrentDomain.SetData("APP_CONFIG_FILE", configFilePath); | ||
Assert.Equal(expectedSettingValue, ConfigurationManager.AppSettings[SettingName]); | ||
}, configFilePath, expectedSettingValue).Dispose(); | ||
} | ||
|
||
[ConditionalFact(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))] | ||
public void CustomAppConfigIsUsedWhenSpecifiedAsAbsoluteUri() | ||
{ | ||
const string SettingName = "test_CustomAppConfigIsUsedWhenSpecified"; | ||
string expectedSettingValue = Guid.NewGuid().ToString(); | ||
string configFilePath = new Uri(Path.Combine(TestDirectory, CreateAppConfigFileWithSetting(SettingName, expectedSettingValue))).ToString(); | ||
|
||
RemoteExecutor.Invoke((string configFilePath, string expectedSettingValue) => { | ||
AppDomain.CurrentDomain.SetData("APP_CONFIG_FILE", configFilePath); | ||
Assert.Equal(expectedSettingValue, ConfigurationManager.AppSettings[SettingName]); | ||
}, configFilePath, expectedSettingValue).Dispose(); | ||
} | ||
|
||
[ConditionalFact(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))] | ||
public void NoErrorWhenCustomAppConfigIsSpecifiedAndItDoesNotExist() | ||
{ | ||
RemoteExecutor.Invoke(() => | ||
{ | ||
AppDomain.CurrentDomain.SetData("APP_CONFIG_FILE", "non-existing-file.config"); | ||
Assert.Null(ConfigurationManager.AppSettings["AnySetting"]); | ||
}).Dispose(); | ||
} | ||
|
||
[ConditionalFact(typeof(RemoteExecutor), nameof(RemoteExecutor.IsSupported))] | ||
public void MalformedAppConfigCausesException() | ||
{ | ||
const string SettingName = "AnySetting"; | ||
|
||
// Following will cause malformed config file | ||
string configFilePath = Path.Combine(TestDirectory, CreateAppConfigFileWithSetting(SettingName, "\"")); | ||
|
||
RemoteExecutor.Invoke((string configFilePath) => { | ||
AppDomain.CurrentDomain.SetData("APP_CONFIG_FILE", configFilePath); | ||
Assert.Throws<ConfigurationErrorsException>(() => ConfigurationManager.AppSettings[SettingName]); | ||
}, configFilePath).Dispose(); | ||
} | ||
|
||
private string GetTestDirectoryName() | ||
{ | ||
string dir = TestDirectory; | ||
if (dir.EndsWith("\\") || dir.EndsWith("/")) | ||
dir = dir.Substring(0, dir.Length - 1); | ||
|
||
return Path.GetFileName(dir); | ||
} | ||
|
||
private string CreateAppConfigFileWithSetting(string key, string rawUnquotedValue, [CallerMemberName] string memberName = null, [CallerLineNumber] int lineNumber = 0) | ||
{ | ||
string fileName = GetTestFileName(null, memberName, lineNumber) + ".config"; | ||
File.WriteAllText(Path.Combine(TestDirectory, fileName), | ||
@$"<?xml version=""1.0"" encoding=""utf-8"" ?> | ||
<configuration> | ||
<appSettings> | ||
<add key=""{key}"" value=""{rawUnquotedValue}""/> | ||
</appSettings> | ||
</configuration>"); | ||
return fileName; | ||
} | ||
} | ||
} |