Initializing settings correctly; Adding some debug code

Author: StanleyGoldman

src/GitHub.Api/ApplicationManagerBase.cs

@@ -28,6 +28,10 @@ protected void Initialize(IUIDispatcher uiDispatcher)
             UserSettings = new UserSettings(Environment, ApplicationInfo.ApplicationName);
             SystemSettings = new SystemSettings(Environment, ApplicationInfo.ApplicationName);
 
+            LocalSettings.Initialize();
+            UserSettings.Initialize();
+            SystemSettings.Initialize();
+
             Platform = new Platform(Environment, FileSystem, uiDispatcher);
             ProcessManager = new ProcessManager(Environment, Platform.GitEnvironment, CancellationToken);
             Platform.Initialize(ProcessManager);

src/GitHub.Api/LocalSettings.cs

@@ -21,10 +21,6 @@ abstract class BaseSettings : ISettings
 
     class JsonBackedSettings : BaseSettings
     {
-        private static readonly ILogging logger = Logging.GetLogger<JsonBackedSettings>();
-
-        private const string SettingsParseError = "Failed to parse settings file at '{0}'";
-
         private string cachePath;
         private CacheData cacheData = new CacheData();
         private Action<string> dirCreate;
@@ -33,9 +29,11 @@ class JsonBackedSettings : BaseSettings
         private Func<string, bool> fileExists;
         private Func<string, Encoding, string> readAllText;
         private Action<string, string> writeAllText;
+        private readonly ILogging logger;
 
         public JsonBackedSettings()
         {
+            logger = Logging.GetLogger(GetType());
             fileExists = (path) => File.Exists(path);
             readAllText = (path, encoding) => File.ReadAllText(path, encoding);
             writeAllText = (path, content) => File.WriteAllText(path, content);
@@ -100,6 +98,8 @@ public override void Rename(string oldKey, string newKey)
 
         private void LoadFromCache(string cachePath)
         {
+            logger.Trace("LoadFromCache: {0}", cachePath);
+
             EnsureCachePath(cachePath);
 
             if (!fileExists(cachePath))
@@ -111,8 +111,9 @@ private void LoadFromCache(string cachePath)
             {
                 cacheData = SimpleJson.DeserializeObject<CacheData>(data);
             }
-            catch
+            catch(Exception ex)
             {
+                logger.Error(ex, "LoadFromCache Error");
                 cacheData = null;
             }
 
@@ -126,6 +127,8 @@ private void LoadFromCache(string cachePath)
 
         private bool SaveToCache(string cachePath)
         {
+            logger.Trace("SaveToCache: {0}", cachePath);
+
             EnsureCachePath(cachePath);
 
             try
@@ -135,8 +138,7 @@ private bool SaveToCache(string cachePath)
             }
             catch (Exception ex)
             {
-                logger.Error(SettingsParseError, cachePath);
-                logger.Error(ex);
+                logger.Error(ex, "SaveToCache Error");
                 return false;
             }
 

src/IntegrationTests/JsonBackedSettingsTests.cs

@@ -0,0 +1,48 @@
+using System.Collections.Generic;
+using System.Linq;
+using FluentAssertions;
+using GitHub.Unity;
+using NUnit.Framework;
+
+namespace IntegrationTests
+{
+    class JsonBackedSettingsTests: BaseGitEnvironmentTest
+    {
+        [Test, Ignore("For some reason this fails")]
+        public void UserSettingsTest()
+        {
+            InitializeEnvironment(TestRepoMasterCleanSynchronized, true);
+
+            var userSettings = new UserSettings(Environment, "GitHubTest");
+            userSettings.Initialize();
+
+            var connectionCacheItems = new[] {
+                new ConnectionCacheItem { Host = "Host1", Username = "User1" },
+                new ConnectionCacheItem { Host = "Host2", Username = "User2" }
+            };
+
+            connectionCacheItems.ShouldAllBeEquivalentTo(new[] {
+                new ConnectionCacheItem { Host = "Host1", Username = "User1" },
+                new ConnectionCacheItem { Host = "Host2", Username = "User2" }
+            });
+
+            userSettings.Set("connectionCacheItems", connectionCacheItems);
+
+            var json = Environment.GetSpecialFolder(System.Environment.SpecialFolder.LocalApplicationData)
+                                         .ToNPath()
+                                         .Combine("GitHubTest", "settings.json")
+                                         .ReadAllText();
+
+            json.Should()
+                       .Be(@"{""GitHubUnity"":{""connectionCacheItems"":[{""Host"":""Host1"",""Username"":""User1""},{""Host"":""Host2"",""Username"":""User2""}]}}");
+
+            userSettings = new UserSettings(Environment, "GitHubTest");
+            userSettings.Initialize();
+
+            var loadedItems = userSettings.Get<ConnectionCacheItem[]>("connectionCacheItems");
+
+            loadedItems.Should().NotBeNull();
+            connectionCacheItems.ShouldAllBeEquivalentTo(loadedItems);
+        }
+    }
+}