2 // System.Configuration.ConfigurationManagerTest.cs - Unit tests
3 // for System.Configuration.ConfigurationManager.
6 // Chris Toshok <toshok@ximian.com>
7 // Atsushi Enomoto <atsushi@ximian.com>
9 // Copyright (C) 2005-2006 Novell, Inc (http://www.novell.com)
11 // Permission is hereby granted, free of charge, to any person obtaining
12 // a copy of this software and associated documentation files (the
13 // "Software"), to deal in the Software without restriction, including
14 // without limitation the rights to use, copy, modify, merge, publish,
15 // distribute, sublicense, and/or sell copies of the Software, and to
16 // permit persons to whom the Software is furnished to do so, subject to
17 // the following conditions:
19 // The above copyright notice and this permission notice shall be
20 // included in all copies or substantial portions of the Software.
22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
32 using System.Collections;
33 using System.Collections.Specialized;
34 using System.Configuration;
35 using System.Net.Configuration;
37 using NUnit.Framework;
38 using SysConfig = System.Configuration.Configuration;
39 using System.Runtime.InteropServices;
41 namespace MonoTests.System.Configuration {
43 public class ConfigurationManagerTest
45 private string originalCurrentDir;
46 private string tempFolder;
51 originalCurrentDir = Directory.GetCurrentDirectory ();
52 tempFolder = Path.Combine (Path.GetTempPath (), this.GetType ().FullName);
53 if (!Directory.Exists (tempFolder))
54 Directory.CreateDirectory (tempFolder);
58 public void TearDown ()
60 Directory.SetCurrentDirectory (originalCurrentDir);
61 if (Directory.Exists (tempFolder))
62 Directory.Delete (tempFolder, true);
65 [Test] // OpenExeConfiguration (ConfigurationUserLevel)
66 [Category ("NotWorking")] // bug #323622
67 public void OpenExeConfiguration1_Remote ()
69 AppDomain domain = null;
71 string config_xml = @"
74 <add key='anyKey' value='42' />
78 config_file = Path.Combine (tempFolder, "otherConfig.noconfigext");
79 File.WriteAllText (config_file, config_xml);
82 AppDomainSetup setup = new AppDomainSetup();
83 setup.ConfigurationFile = config_file;
84 setup.ApplicationBase = AppDomain.CurrentDomain.SetupInformation.ApplicationBase;
85 domain = AppDomain.CreateDomain("foo", null, setup);
87 RemoteConfig config = RemoteConfig.GetInstance (domain);
89 ConfigurationUserLevel userLevel = ConfigurationUserLevel.None;
90 Assert.AreEqual (config_file, config.GetFilePath (userLevel));
91 Assert.AreEqual ("42", config.GetSettingValue (userLevel, "anyKey"));
92 Assert.AreEqual ("42", config.GetSettingValue ("anyKey"));
95 AppDomain.Unload (domain);
96 File.Delete (config_file);
99 config_file = Path.Combine (tempFolder, "otherConfig.exe.config");
100 File.WriteAllText (config_file, config_xml);
103 AppDomainSetup setup = new AppDomainSetup();
104 setup.ConfigurationFile = config_file;
105 setup.ApplicationBase = AppDomain.CurrentDomain.SetupInformation.ApplicationBase;
106 domain = AppDomain.CreateDomain("foo", null, setup);
108 RemoteConfig config = RemoteConfig.GetInstance (domain);
110 ConfigurationUserLevel userLevel = ConfigurationUserLevel.None;
111 Assert.AreEqual (config_file, config.GetFilePath (userLevel));
112 Assert.AreEqual ("42", config.GetSettingValue (userLevel, "anyKey"));
113 Assert.AreEqual ("42", config.GetSettingValue ("anyKey"));
116 AppDomain.Unload (domain);
117 File.Delete (config_file);
121 AppDomainSetup setup = new AppDomainSetup();
122 setup.ConfigurationFile = config_file;
123 setup.ApplicationBase = AppDomain.CurrentDomain.SetupInformation.ApplicationBase;
124 domain = AppDomain.CreateDomain("foo", null, setup);
126 RemoteConfig config = RemoteConfig.GetInstance (domain);
128 ConfigurationUserLevel userLevel = ConfigurationUserLevel.None;
129 Assert.AreEqual (config_file, config.GetFilePath (userLevel));
130 Assert.IsNull (config.GetSettingValue (userLevel, "anyKey"));
131 Assert.IsNull (config.GetSettingValue ("anyKey"));
134 AppDomain.Unload (domain);
135 File.Delete (config_file);
139 [Test] // OpenExeConfiguration (ConfigurationUserLevel)
140 public void OpenExeConfiguration1_UserLevel_None ()
142 SysConfig config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
144 Console.WriteLine("application config path: {0}", config.FilePath);
145 FileInfo fi = new FileInfo (config.FilePath);
147 Assert.AreEqual ("nunit-console.jar.config", fi.Name);
149 Assert.AreEqual ("System.Configuration_test_net_4_5.dll.config", fi.Name);
151 Assert.AreEqual ("System.Configuration_test_net_4_0.dll.config", fi.Name);
153 Assert.AreEqual ("System.Configuration_test_net_2_0.dll.config", fi.Name);
158 public void OpenExeConfiguration1_UserLevel_PerUserRoaming ()
160 SysConfig config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.PerUserRoaming);
161 Console.WriteLine("roaming user config path: {0}", config.FilePath);
163 FileInfo fi = new FileInfo (config.FilePath);
164 Assert.AreEqual ("user.config", fi.Name);
168 public void OpenExeConfiguration1_UserLevel_PerUserRoamingAndLocal ()
170 SysConfig config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.PerUserRoamingAndLocal);
171 Console.WriteLine("local user config path: {0}", config.FilePath);
173 FileInfo fi = new FileInfo (config.FilePath);
174 Assert.AreEqual ("user.config", fi.Name);
177 [Test] // OpenExeConfiguration (String)
178 public void OpenExeConfiguration2 ()
183 exePath = Path.Combine (tempFolder, "DoesNotExist.whatever");
184 File.Create (exePath).Close ();
186 config = ConfigurationManager.OpenExeConfiguration (exePath);
187 Assert.AreEqual (exePath + ".config", config.FilePath, "#1");
189 exePath = Path.Combine (tempFolder, "SomeExecutable.exe");
190 File.Create (exePath).Close ();
192 config = ConfigurationManager.OpenExeConfiguration (exePath);
193 Assert.AreEqual (exePath + ".config", config.FilePath, "#2");
195 exePath = Path.Combine (tempFolder, "Foo.exe.config");
196 File.Create (exePath).Close ();
198 config = ConfigurationManager.OpenExeConfiguration (exePath);
199 Assert.AreEqual (exePath + ".config", config.FilePath, "#3");
201 Directory.SetCurrentDirectory (tempFolder);
203 exePath = "relative.exe";
204 File.Create (Path.Combine (tempFolder, exePath)).Close ();
206 config = ConfigurationManager.OpenExeConfiguration (exePath);
207 Assert.AreEqual (Path.Combine (tempFolder, exePath + ".config"), config.FilePath, "#4");
210 [Test] // OpenExeConfiguration (String)
211 public void OpenExeConfiguration2_ExePath_Empty ()
213 AppDomain domain = AppDomain.CurrentDomain;
215 SysConfig config = ConfigurationManager.OpenExeConfiguration (string.Empty);
216 Assert.AreEqual (domain.SetupInformation.ConfigurationFile, config.FilePath);
219 [Test] // OpenExeConfiguration (String)
220 public void OpenExeConfiguration2_ExePath_Null ()
222 AppDomain domain = AppDomain.CurrentDomain;
224 SysConfig config = ConfigurationManager.OpenExeConfiguration (string.Empty);
225 Assert.AreEqual (domain.SetupInformation.ConfigurationFile, config.FilePath);
228 [Test] // OpenExeConfiguration (String)
229 public void OpenExeConfiguration2_ExePath_DoesNotExist ()
231 String exePath = Path.Combine (tempFolder, "DoesNotExist.exe");
234 ConfigurationManager.OpenExeConfiguration (exePath);
236 } catch (ConfigurationErrorsException ex) {
237 // An error occurred loading a configuration file:
238 // The parameter 'exePath' is invalid
239 Assert.AreEqual (typeof (ConfigurationErrorsException), ex.GetType (), "#2");
240 Assert.IsNull (ex.Filename, "#3");
241 Assert.IsNotNull (ex.InnerException, "#4");
242 Assert.AreEqual (0, ex.Line, "#5");
243 Assert.IsNotNull (ex.Message, "#6");
245 // The parameter 'exePath' is invalid
246 ArgumentException inner = ex.InnerException as ArgumentException;
247 Assert.IsNotNull (inner, "#7");
248 Assert.AreEqual (typeof (ArgumentException), inner.GetType (), "#8");
249 Assert.IsNull (inner.InnerException, "#9");
250 Assert.IsNotNull (inner.Message, "#10");
251 Assert.AreEqual ("exePath", inner.ParamName, "#11");
256 public void exePath_UserLevelNone ()
258 string basedir = AppDomain.CurrentDomain.BaseDirectory;
259 SysConfig config = ConfigurationManager.OpenExeConfiguration("System.Configuration_test_net_2_0.dll.mdb");
260 Assert.AreEqual (Path.Combine (basedir, "System.Configuration_test_net_2_0.dll.mdb.config"), config.FilePath);
264 public void exePath_UserLevelPerRoaming ()
266 SysConfig config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.PerUserRoaming);
267 string filePath = config.FilePath;
268 string applicationData = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData);
269 Assert.IsTrue (filePath.StartsWith (applicationData), "#1:" + filePath);
270 Assert.AreEqual ("user.config", Path.GetFileName (filePath), "#2:" + filePath);
274 public void exePath_UserLevelPerRoamingAndLocal ()
276 SysConfig config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.PerUserRoamingAndLocal);
277 string filePath = config.FilePath;
278 string applicationData = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData);
279 Assert.IsTrue (filePath.StartsWith (applicationData), "#1:" + filePath);
280 Assert.AreEqual ("user.config", Path.GetFileName (filePath), "#2:" + filePath);
284 public void mapped_UserLevelNone ()
286 ExeConfigurationFileMap map = new ExeConfigurationFileMap ();
287 map.ExeConfigFilename = "execonfig";
289 SysConfig config = ConfigurationManager.OpenMappedExeConfiguration(map, ConfigurationUserLevel.None);
290 Console.WriteLine("mapped application config path: {0}", config.FilePath);
292 FileInfo fi = new FileInfo (config.FilePath);
293 Assert.AreEqual ("execonfig", fi.Name);
298 public void mapped_UserLevelPerRoaming ()
300 ExeConfigurationFileMap map = new ExeConfigurationFileMap ();
301 map.ExeConfigFilename = "execonfig";
302 map.RoamingUserConfigFilename = "roaminguser";
304 SysConfig config = ConfigurationManager.OpenMappedExeConfiguration(map, ConfigurationUserLevel.PerUserRoaming);
305 Console.WriteLine("mapped roaming user config path: {0}", config.FilePath);
307 FileInfo fi = new FileInfo (config.FilePath);
308 Assert.AreEqual ("roaminguser", fi.Name);
312 [ExpectedException (typeof (ArgumentException))]
313 [Category ("NotWorking")]
314 public void mapped_UserLevelPerRoaming_no_execonfig ()
316 ExeConfigurationFileMap map = new ExeConfigurationFileMap ();
317 map.RoamingUserConfigFilename = "roaminguser";
319 ConfigurationManager.OpenMappedExeConfiguration (map, ConfigurationUserLevel.PerUserRoaming);
323 public void mapped_UserLevelPerRoamingAndLocal ()
325 ExeConfigurationFileMap map = new ExeConfigurationFileMap ();
326 map.ExeConfigFilename = "execonfig";
327 map.RoamingUserConfigFilename = "roaminguser";
328 map.LocalUserConfigFilename = "localuser";
330 SysConfig config = ConfigurationManager.OpenMappedExeConfiguration(map, ConfigurationUserLevel.PerUserRoamingAndLocal);
331 Console.WriteLine("mapped local user config path: {0}", config.FilePath);
333 FileInfo fi = new FileInfo (config.FilePath);
334 Assert.AreEqual ("localuser", fi.Name);
338 [ExpectedException (typeof (ArgumentException))]
339 [Category ("NotWorking")]
340 public void mapped_UserLevelPerRoamingAndLocal_no_execonfig ()
342 ExeConfigurationFileMap map = new ExeConfigurationFileMap ();
343 map.RoamingUserConfigFilename = "roaminguser";
344 map.LocalUserConfigFilename = "localuser";
346 ConfigurationManager.OpenMappedExeConfiguration (map, ConfigurationUserLevel.PerUserRoamingAndLocal);
350 [ExpectedException (typeof (ArgumentException))]
351 [Category ("NotWorking")]
352 public void mapped_UserLevelPerRoamingAndLocal_no_roaminguser ()
354 ExeConfigurationFileMap map = new ExeConfigurationFileMap ();
355 map.ExeConfigFilename = "execonfig";
356 map.LocalUserConfigFilename = "localuser";
358 ConfigurationManager.OpenMappedExeConfiguration (map, ConfigurationUserLevel.PerUserRoamingAndLocal);
362 public void MachineConfig ()
364 SysConfig config = ConfigurationManager.OpenMachineConfiguration ();
365 Console.WriteLine("machine config path: {0}", config.FilePath);
367 FileInfo fi = new FileInfo (config.FilePath);
368 Assert.AreEqual ("machine.config", fi.Name);
372 public void mapped_MachineConfig ()
374 ConfigurationFileMap map = new ConfigurationFileMap ();
375 map.MachineConfigFilename = "machineconfig";
377 SysConfig config = ConfigurationManager.OpenMappedMachineConfiguration (map);
378 Console.WriteLine("mapped machine config path: {0}", config.FilePath);
380 FileInfo fi = new FileInfo (config.FilePath);
381 Assert.AreEqual ("machineconfig", fi.Name);
385 public void exePath_UserLevelNone_null ()
387 SysConfig config = ConfigurationManager.OpenExeConfiguration (null);
389 Console.WriteLine("null exe application config path: {0}", config.FilePath);
391 FileInfo fi = new FileInfo (config.FilePath);
392 Assert.AreEqual ("System.Configuration_test_net_2_0.dll.config", fi.Name);
397 [Category ("NotWorking")]
398 public void mapped_ExeConfiguration_null ()
400 SysConfig config = ConfigurationManager.OpenMappedExeConfiguration(null, ConfigurationUserLevel.None);
401 Console.WriteLine("null mapped application config path: {0}", config.FilePath);
403 FileInfo fi = new FileInfo (config.FilePath);
405 Assert.AreEqual("System.Configuration.Test20.jar.config", fi.Name);
407 Assert.AreEqual ("System.Configuration_test_net_2_0.dll.config", fi.Name);
412 [Category ("NotWorking")]
413 public void mapped_MachineConfig_null ()
415 SysConfig config = ConfigurationManager.OpenMappedMachineConfiguration (null);
416 Console.WriteLine("null mapped machine config path: {0}", config.FilePath);
418 FileInfo fi = new FileInfo (config.FilePath);
419 Assert.AreEqual ("machine.config", fi.Name);
423 public void GetSectionReturnsNativeObject ()
425 Assert.IsTrue (ConfigurationManager.GetSection ("appSettings") is NameValueCollection);
428 [Test] // test for bug #78372.
429 public void OpenMachineConfiguration ()
431 SysConfig cfg = ConfigurationManager.OpenMachineConfiguration ();
432 Assert.IsTrue (cfg.Sections.Count > 0, "#1");
434 ConfigurationSection s = cfg.SectionGroups ["system.net"].Sections ["connectionManagement"];
435 Assert.IsNotNull (s, "#2");
436 Assert.IsTrue (s is ConnectionManagementSection, "#3");
441 public void SectionCollectionEnumerator ()
443 SysConfig c = ConfigurationManager.OpenExeConfiguration (ConfigurationUserLevel.None);
444 ConfigurationSectionCollection col =
445 c.GetSectionGroup ("system.web").Sections;
446 IEnumerator e = col.GetEnumerator ();
448 Assert.IsTrue (e.Current is ConfigurationSection);
451 [Test] // Test for bug #3412
452 [Category("NotWorking")]
453 public void TestAddRemoveSection()
455 const string name = "testsection";
456 var config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
458 // ensure not present
459 if (config.Sections.Get(name) != null)
461 config.Sections.Remove(name);
465 config.Sections.Add(name, new TestSection());
468 var section = config.Sections.Get(name);
469 Assert.IsNotNull(section);
470 Assert.IsNotNull(section as TestSection);
471 config.Sections.Remove(name);
474 config.Sections.Add(name, new TestSection());
477 section = config.Sections.Get(name);
478 Assert.IsNotNull(section);
479 Assert.IsNotNull(section as TestSection);
480 config.Sections.Remove(name);
483 class TestSection : ConfigurationSection {}
485 class RemoteConfig : MarshalByRefObject
487 public static RemoteConfig GetInstance (AppDomain domain)
489 RemoteConfig config = (RemoteConfig) domain.CreateInstanceAndUnwrap (
490 typeof (RemoteConfig).Assembly.FullName,
491 typeof (RemoteConfig).FullName, new object [0]);
495 public string GetFilePath (string exePath)
497 global::System.Configuration.Configuration config =
498 ConfigurationManager.OpenExeConfiguration (exePath);
499 return config.FilePath;
502 public string GetFilePath (ConfigurationUserLevel userLevel)
504 global::System.Configuration.Configuration config =
505 ConfigurationManager.OpenExeConfiguration (userLevel);
506 return config.FilePath;
509 public string GetSettingValue (string exePath, string key)
511 global::System.Configuration.Configuration config =
512 ConfigurationManager.OpenExeConfiguration (exePath);
513 return config.AppSettings.Settings [key].Value;
516 public string GetSettingValue (ConfigurationUserLevel userLevel, string key)
518 global::System.Configuration.Configuration config =
519 ConfigurationManager.OpenExeConfiguration (userLevel);
520 KeyValueConfigurationElement value = config.AppSettings.Settings [key];
521 return value != null ? value.Value : null;
524 public string GetSettingValue (string key)
526 return ConfigurationManager.AppSettings [key];