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 {
45 public class ConfigurationManagerTest
47 private string originalCurrentDir;
48 private string tempFolder;
53 originalCurrentDir = Directory.GetCurrentDirectory ();
54 tempFolder = Path.Combine (Path.GetTempPath (), this.GetType ().FullName);
55 if (!Directory.Exists (tempFolder))
56 Directory.CreateDirectory (tempFolder);
60 public void TearDown ()
62 Directory.SetCurrentDirectory (originalCurrentDir);
63 if (Directory.Exists (tempFolder))
64 Directory.Delete (tempFolder, true);
67 [Test] // OpenExeConfiguration (ConfigurationUserLevel)
68 [Category ("NotWorking")] // bug #323622
69 public void OpenExeConfiguration1_Remote ()
71 AppDomain domain = null;
73 string config_xml = @"
76 <add key='anyKey' value='42' />
80 config_file = Path.Combine (tempFolder, "otherConfig.noconfigext");
81 File.WriteAllText (config_file, config_xml);
84 AppDomainSetup setup = new AppDomainSetup();
85 setup.ConfigurationFile = config_file;
86 setup.ApplicationBase = AppDomain.CurrentDomain.SetupInformation.ApplicationBase;
87 domain = AppDomain.CreateDomain("foo", null, setup);
89 RemoteConfig config = RemoteConfig.GetInstance (domain);
91 ConfigurationUserLevel userLevel = ConfigurationUserLevel.None;
92 Assert.AreEqual (config_file, config.GetFilePath (userLevel));
93 Assert.AreEqual ("42", config.GetSettingValue (userLevel, "anyKey"));
94 Assert.AreEqual ("42", config.GetSettingValue ("anyKey"));
97 AppDomain.Unload (domain);
98 File.Delete (config_file);
101 config_file = Path.Combine (tempFolder, "otherConfig.exe.config");
102 File.WriteAllText (config_file, config_xml);
105 AppDomainSetup setup = new AppDomainSetup();
106 setup.ConfigurationFile = config_file;
107 setup.ApplicationBase = AppDomain.CurrentDomain.SetupInformation.ApplicationBase;
108 domain = AppDomain.CreateDomain("foo", null, setup);
110 RemoteConfig config = RemoteConfig.GetInstance (domain);
112 ConfigurationUserLevel userLevel = ConfigurationUserLevel.None;
113 Assert.AreEqual (config_file, config.GetFilePath (userLevel));
114 Assert.AreEqual ("42", config.GetSettingValue (userLevel, "anyKey"));
115 Assert.AreEqual ("42", config.GetSettingValue ("anyKey"));
118 AppDomain.Unload (domain);
119 File.Delete (config_file);
123 AppDomainSetup setup = new AppDomainSetup();
124 setup.ConfigurationFile = config_file;
125 setup.ApplicationBase = AppDomain.CurrentDomain.SetupInformation.ApplicationBase;
126 domain = AppDomain.CreateDomain("foo", null, setup);
128 RemoteConfig config = RemoteConfig.GetInstance (domain);
130 ConfigurationUserLevel userLevel = ConfigurationUserLevel.None;
131 Assert.AreEqual (config_file, config.GetFilePath (userLevel));
132 Assert.IsNull (config.GetSettingValue (userLevel, "anyKey"));
133 Assert.IsNull (config.GetSettingValue ("anyKey"));
136 AppDomain.Unload (domain);
137 File.Delete (config_file);
141 [Test] // OpenExeConfiguration (ConfigurationUserLevel)
142 public void OpenExeConfiguration1_UserLevel_None ()
144 SysConfig config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
146 Console.WriteLine("application config path: {0}", config.FilePath);
147 FileInfo fi = new FileInfo (config.FilePath);
148 Assert.AreEqual (TestUtil.ThisConfigFileName, fi.Name);
152 public void OpenExeConfiguration1_UserLevel_PerUserRoaming ()
154 SysConfig config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.PerUserRoaming);
155 Console.WriteLine("roaming user config path: {0}", config.FilePath);
157 FileInfo fi = new FileInfo (config.FilePath);
158 Assert.AreEqual ("user.config", fi.Name);
162 public void OpenExeConfiguration1_UserLevel_PerUserRoamingAndLocal ()
164 SysConfig config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.PerUserRoamingAndLocal);
165 Console.WriteLine("local user config path: {0}", config.FilePath);
167 FileInfo fi = new FileInfo (config.FilePath);
168 Assert.AreEqual ("user.config", fi.Name);
171 [Test] // OpenExeConfiguration (String)
172 public void OpenExeConfiguration2 ()
177 exePath = Path.Combine (tempFolder, "DoesNotExist.whatever");
178 File.Create (exePath).Close ();
180 config = ConfigurationManager.OpenExeConfiguration (exePath);
181 Assert.AreEqual (exePath + ".config", config.FilePath, "#1");
183 exePath = Path.Combine (tempFolder, "SomeExecutable.exe");
184 File.Create (exePath).Close ();
186 config = ConfigurationManager.OpenExeConfiguration (exePath);
187 Assert.AreEqual (exePath + ".config", config.FilePath, "#2");
189 exePath = Path.Combine (tempFolder, "Foo.exe.config");
190 File.Create (exePath).Close ();
192 config = ConfigurationManager.OpenExeConfiguration (exePath);
193 Assert.AreEqual (exePath + ".config", config.FilePath, "#3");
195 Directory.SetCurrentDirectory (tempFolder);
197 exePath = "relative.exe";
198 File.Create (Path.Combine (tempFolder, exePath)).Close ();
201 // The temp directory as computed by the runtime is slightly different, as
202 // it will contain the full path after following links, while the test
203 // below is not comprehensive enough to follow links if there are any
204 // present in tempFolder
207 //config = ConfigurationManager.OpenExeConfiguration (exePath);
208 //Assert.AreEqual (Path.Combine (tempFolder, exePath + ".config"), config.FilePath, "#4");
211 [Test] // OpenExeConfiguration (String)
212 public void OpenExeConfiguration2_ExePath_Empty ()
214 AppDomain domain = AppDomain.CurrentDomain;
216 SysConfig config = ConfigurationManager.OpenExeConfiguration (string.Empty);
217 Assert.AreEqual (domain.SetupInformation.ConfigurationFile, config.FilePath);
220 [Test] // OpenExeConfiguration (String)
221 public void OpenExeConfiguration2_ExePath_Null ()
223 AppDomain domain = AppDomain.CurrentDomain;
225 SysConfig config = ConfigurationManager.OpenExeConfiguration (string.Empty);
226 Assert.AreEqual (domain.SetupInformation.ConfigurationFile, config.FilePath);
229 [Test] // OpenExeConfiguration (String)
230 public void OpenExeConfiguration2_ExePath_DoesNotExist ()
232 String exePath = Path.Combine (tempFolder, "DoesNotExist.exe");
235 ConfigurationManager.OpenExeConfiguration (exePath);
237 } catch (ConfigurationErrorsException ex) {
238 // An error occurred loading a configuration file:
239 // The parameter 'exePath' is invalid
240 Assert.AreEqual (typeof (ConfigurationErrorsException), ex.GetType (), "#2");
241 Assert.IsNull (ex.Filename, "#3");
242 Assert.IsNotNull (ex.InnerException, "#4");
243 Assert.AreEqual (0, ex.Line, "#5");
244 Assert.IsNotNull (ex.Message, "#6");
246 // The parameter 'exePath' is invalid
247 ArgumentException inner = ex.InnerException as ArgumentException;
248 Assert.IsNotNull (inner, "#7");
249 Assert.AreEqual (typeof (ArgumentException), inner.GetType (), "#8");
250 Assert.IsNull (inner.InnerException, "#9");
251 Assert.IsNotNull (inner.Message, "#10");
252 Assert.AreEqual ("exePath", inner.ParamName, "#11");
257 public void exePath_UserLevelNone ()
259 string basedir = AppDomain.CurrentDomain.BaseDirectory;
260 string name = TestUtil.ThisDllName;
261 SysConfig config = ConfigurationManager.OpenExeConfiguration (name);
262 Assert.AreEqual (Path.Combine (basedir, name + ".config"), config.FilePath);
266 public void exePath_UserLevelPerRoaming ()
268 SysConfig config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.PerUserRoaming);
269 string filePath = config.FilePath;
270 string applicationData = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData);
271 Assert.IsTrue (filePath.StartsWith (applicationData), "#1:" + filePath);
272 Assert.AreEqual ("user.config", Path.GetFileName (filePath), "#2:" + filePath);
276 public void exePath_UserLevelPerRoamingAndLocal ()
278 SysConfig config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.PerUserRoamingAndLocal);
279 string filePath = config.FilePath;
280 string applicationData = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData);
281 Assert.IsTrue (filePath.StartsWith (applicationData), "#1:" + filePath);
282 Assert.AreEqual ("user.config", Path.GetFileName (filePath), "#2:" + filePath);
286 public void mapped_UserLevelNone ()
288 ExeConfigurationFileMap map = new ExeConfigurationFileMap ();
289 map.ExeConfigFilename = "execonfig";
291 SysConfig config = ConfigurationManager.OpenMappedExeConfiguration(map, ConfigurationUserLevel.None);
292 Console.WriteLine("mapped application config path: {0}", config.FilePath);
294 FileInfo fi = new FileInfo (config.FilePath);
295 Assert.AreEqual ("execonfig", fi.Name);
300 public void mapped_UserLevelPerRoaming ()
302 ExeConfigurationFileMap map = new ExeConfigurationFileMap ();
303 map.ExeConfigFilename = "execonfig";
304 map.RoamingUserConfigFilename = "roaminguser";
306 SysConfig config = ConfigurationManager.OpenMappedExeConfiguration(map, ConfigurationUserLevel.PerUserRoaming);
307 Console.WriteLine("mapped roaming user config path: {0}", config.FilePath);
309 FileInfo fi = new FileInfo (config.FilePath);
310 Assert.AreEqual ("roaminguser", fi.Name);
314 [ExpectedException (typeof (ArgumentException))]
315 [Category ("NotWorking")]
316 public void mapped_UserLevelPerRoaming_no_execonfig ()
318 ExeConfigurationFileMap map = new ExeConfigurationFileMap ();
319 map.RoamingUserConfigFilename = "roaminguser";
321 ConfigurationManager.OpenMappedExeConfiguration (map, ConfigurationUserLevel.PerUserRoaming);
325 public void mapped_UserLevelPerRoamingAndLocal ()
327 ExeConfigurationFileMap map = new ExeConfigurationFileMap ();
328 map.ExeConfigFilename = "execonfig";
329 map.RoamingUserConfigFilename = "roaminguser";
330 map.LocalUserConfigFilename = "localuser";
332 SysConfig config = ConfigurationManager.OpenMappedExeConfiguration(map, ConfigurationUserLevel.PerUserRoamingAndLocal);
333 Console.WriteLine("mapped local user config path: {0}", config.FilePath);
335 FileInfo fi = new FileInfo (config.FilePath);
336 Assert.AreEqual ("localuser", fi.Name);
340 [ExpectedException (typeof (ArgumentException))]
341 [Category ("NotWorking")]
342 public void mapped_UserLevelPerRoamingAndLocal_no_execonfig ()
344 ExeConfigurationFileMap map = new ExeConfigurationFileMap ();
345 map.RoamingUserConfigFilename = "roaminguser";
346 map.LocalUserConfigFilename = "localuser";
348 ConfigurationManager.OpenMappedExeConfiguration (map, ConfigurationUserLevel.PerUserRoamingAndLocal);
352 [ExpectedException (typeof (ArgumentException))]
353 [Category ("NotWorking")]
354 public void mapped_UserLevelPerRoamingAndLocal_no_roaminguser ()
356 ExeConfigurationFileMap map = new ExeConfigurationFileMap ();
357 map.ExeConfigFilename = "execonfig";
358 map.LocalUserConfigFilename = "localuser";
360 ConfigurationManager.OpenMappedExeConfiguration (map, ConfigurationUserLevel.PerUserRoamingAndLocal);
364 public void MachineConfig ()
366 SysConfig config = ConfigurationManager.OpenMachineConfiguration ();
367 Console.WriteLine("machine config path: {0}", config.FilePath);
369 FileInfo fi = new FileInfo (config.FilePath);
370 Assert.AreEqual ("machine.config", fi.Name);
374 public void mapped_MachineConfig ()
376 ConfigurationFileMap map = new ConfigurationFileMap ();
377 map.MachineConfigFilename = "machineconfig";
379 SysConfig config = ConfigurationManager.OpenMappedMachineConfiguration (map);
380 Console.WriteLine("mapped machine config path: {0}", config.FilePath);
382 FileInfo fi = new FileInfo (config.FilePath);
383 Assert.AreEqual ("machineconfig", fi.Name);
387 public void exePath_UserLevelNone_null ()
390 SysConfig config = ConfigurationManager.OpenExeConfiguration (null);
391 Console.WriteLine("null exe application config path: {0}", config.FilePath);
393 FileInfo fi = new FileInfo (config.FilePath);
394 Assert.AreEqual (TestUtil.ThisConfigFileName, fi.Name);
399 [Category ("NotWorking")]
400 public void mapped_ExeConfiguration_null ()
402 SysConfig config = ConfigurationManager.OpenMappedExeConfiguration(null, ConfigurationUserLevel.None);
403 Console.WriteLine("null mapped application config path: {0}", config.FilePath);
405 FileInfo fi = new FileInfo (config.FilePath);
406 Assert.AreEqual (TestUtil.ThisConfigFileName, fi.Name);
410 [Category ("NotWorking")]
411 public void mapped_MachineConfig_null ()
413 SysConfig config = ConfigurationManager.OpenMappedMachineConfiguration (null);
414 Console.WriteLine("null mapped machine config path: {0}", config.FilePath);
416 FileInfo fi = new FileInfo (config.FilePath);
417 Assert.AreEqual ("machine.config", fi.Name);
421 public void GetSectionReturnsNativeObject ()
423 Assert.IsTrue (ConfigurationManager.GetSection ("appSettings") is NameValueCollection);
426 [Test] // test for bug #78372.
427 public void OpenMachineConfiguration ()
429 SysConfig cfg = ConfigurationManager.OpenMachineConfiguration ();
430 Assert.IsTrue (cfg.Sections.Count > 0, "#1");
432 ConfigurationSection s = cfg.SectionGroups ["system.net"].Sections ["connectionManagement"];
433 Assert.IsNotNull (s, "#2");
434 Assert.IsTrue (s is ConnectionManagementSection, "#3");
439 public void SectionCollectionEnumerator ()
441 SysConfig c = ConfigurationManager.OpenExeConfiguration (ConfigurationUserLevel.None);
442 ConfigurationSectionCollection col =
443 c.GetSectionGroup ("system.web").Sections;
444 IEnumerator e = col.GetEnumerator ();
446 Assert.IsTrue (e.Current is ConfigurationSection);
449 [Test] // Test for bug #3412
450 [Category("NotWorking")]
451 public void TestAddRemoveSection()
453 const string name = "testsection";
454 var config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
456 // ensure not present
457 if (config.Sections.Get(name) != null)
459 config.Sections.Remove(name);
463 config.Sections.Add(name, new TestSection());
466 var section = config.Sections.Get(name);
467 Assert.IsNotNull(section);
468 Assert.IsNotNull(section as TestSection);
469 config.Sections.Remove(name);
472 config.Sections.Add(name, new TestSection());
475 section = config.Sections.Get(name);
476 Assert.IsNotNull(section);
477 Assert.IsNotNull(section as TestSection);
478 config.Sections.Remove(name);
482 public void TestFileMap ()
484 var name = Path.GetRandomFileName () + ".config";
485 Assert.IsFalse (File.Exists (name));
488 var map = new ExeConfigurationFileMap ();
489 map.ExeConfigFilename = name;
491 var config = ConfigurationManager.OpenMappedExeConfiguration (
492 map, ConfigurationUserLevel.None);
494 config.Sections.Add ("testsection", new TestSection ());
498 Assert.IsTrue (File.Exists (name), "#1");
499 Assert.IsTrue (File.Exists (Path.GetFullPath (name)), "#2");
506 public void TestContext ()
508 var config = ConfigurationManager.OpenExeConfiguration (ConfigurationUserLevel.None);
509 const string name = "testsection";
511 // ensure not present
512 if (config.GetSection (name) != null)
513 config.Sections.Remove (name);
515 var section = new TestContextSection ();
517 // Can't access EvaluationContext ....
519 section.TestContext (null);
521 } catch (ConfigurationException) {
525 // ... until it's been added to a section.
526 config.Sections.Add (name, section);
527 section.TestContext ("#2");
530 config.Sections.Remove (name);
532 // ... and it doesn't lose its context
533 section.TestContext (null);
537 public void TestContext2 ()
539 var name = Path.GetRandomFileName () + ".config";
540 Assert.IsFalse (File.Exists (name));
543 var map = new ExeConfigurationFileMap ();
544 map.ExeConfigFilename = name;
546 var config = ConfigurationManager.OpenMappedExeConfiguration (
547 map, ConfigurationUserLevel.None);
549 config.Sections.Add ("testsection", new TestSection ());
550 config.Sections.Add ("testcontext", new TestContextSection ());
554 Assert.IsTrue (File.Exists (name), "#1");
561 class TestSection : ConfigurationSection {}
563 class RemoteConfig : MarshalByRefObject
565 public static RemoteConfig GetInstance (AppDomain domain)
567 RemoteConfig config = (RemoteConfig) domain.CreateInstanceAndUnwrap (
568 typeof (RemoteConfig).Assembly.FullName,
569 typeof (RemoteConfig).FullName, new object [0]);
573 public string GetFilePath (string exePath)
575 global::System.Configuration.Configuration config =
576 ConfigurationManager.OpenExeConfiguration (exePath);
577 return config.FilePath;
580 public string GetFilePath (ConfigurationUserLevel userLevel)
582 global::System.Configuration.Configuration config =
583 ConfigurationManager.OpenExeConfiguration (userLevel);
584 return config.FilePath;
587 public string GetSettingValue (string exePath, string key)
589 global::System.Configuration.Configuration config =
590 ConfigurationManager.OpenExeConfiguration (exePath);
591 return config.AppSettings.Settings [key].Value;
594 public string GetSettingValue (ConfigurationUserLevel userLevel, string key)
596 global::System.Configuration.Configuration config =
597 ConfigurationManager.OpenExeConfiguration (userLevel);
598 KeyValueConfigurationElement value = config.AppSettings.Settings [key];
599 return value != null ? value.Value : null;
602 public string GetSettingValue (string key)
604 return ConfigurationManager.AppSettings [key];
608 class TestContextSection : ConfigurationSection {
609 public void TestContext (string label)
611 Assert.That (EvaluationContext != null, label);
617 public void TestConnectionStringRetrieval ()
619 var connStringObj = ConfigurationManager.ConnectionStrings ["test-connstring"];
620 Assert.IsNotNull (connStringObj);
621 var connString = connStringObj.ConnectionString;
622 Assert.IsFalse (String.IsNullOrEmpty (connString));
623 Assert.AreEqual ("Server=(local);Initial Catalog=someDb;User Id=someUser;Password=somePassword;Application Name=someAppName;Min Pool Size=5;Max Pool Size=500;Connect Timeout=10;Connection Lifetime=29;",