Wrap Environment to support testing, add trys.

Author: comintern

RetailCoder.VBE/Rubberduck.csproj

@@ -467,6 +467,7 @@
     <Compile Include="UI\CodeExplorer\Commands\AddClassModuleCommand.cs" />
     <Compile Include="UI\CodeExplorer\Commands\AddStdModuleCommand.cs" />
     <Compile Include="UI\CodeExplorer\Commands\AddTestModuleCommand.cs" />
+    <Compile Include="UI\EnvironmentProvider.cs" />
     <Compile Include="UI\ModernFolderBrowser.cs" />
     <Compile Include="VersionCheck\IVersionCheck.cs" />
     <Compile Include="UI\Command\MenuItems\CommandBars\AppCommandBarBase.cs" />

RetailCoder.VBE/UI/EnvironmentProvider.cs

@@ -0,0 +1,22 @@
+using System;
+
+namespace Rubberduck.UI
+{
+    public interface IEnvironmentProvider
+    {
+        string GetFolderPath(Environment.SpecialFolder folder);
+        // ReSharper disable once InconsistentNaming
+        OperatingSystem OSVersion { get; }
+    }
+
+    //Wrapper to enable unit testing of folder dialogs.
+    public class EnvironmentProvider : IEnvironmentProvider
+    {
+        public string GetFolderPath(Environment.SpecialFolder folder)
+        {
+            return Environment.GetFolderPath(folder);
+        }
+
+        public OperatingSystem OSVersion { get { return Environment.OSVersion; } }
+    }
+}

RetailCoder.VBE/UI/FileBrowserDialogFactory.cs

@@ -1,6 +1,4 @@
-using System;
-
-namespace Rubberduck.UI
+namespace Rubberduck.UI
 {
     public interface IFolderBrowserFactory
     {
@@ -14,27 +12,41 @@ IFolderBrowser CreateFolderBrowser(string description, bool showNewFolderButton,
 
     public class DialogFactory : IFolderBrowserFactory
     {
-        private static readonly bool OldSchool = Environment.OSVersion.Version.Major < 6;
+        private readonly IEnvironmentProvider _environment;
+        private readonly bool _oldSchool;
+
+        public DialogFactory(IEnvironmentProvider environment)
+        {
+            _environment = environment;
+            try
+            {
+                _oldSchool = _environment.OSVersion.Version.Major < 6;
+            }
+            catch
+            {
+                // ignored - fall back to "safe" dialog version.
+            }
+        }
 
         public IFolderBrowser CreateFolderBrowser(string description)
         {
-            return !OldSchool
-                ? new ModernFolderBrowser(description) as IFolderBrowser
-                : new FolderBrowser(description);
+            return !_oldSchool
+                ? new ModernFolderBrowser(_environment, description) as IFolderBrowser
+                : new FolderBrowser(_environment, description);
         }
 
         public IFolderBrowser CreateFolderBrowser(string description, bool showNewFolderButton)
         {
-            return !OldSchool
-                ? new ModernFolderBrowser(description, showNewFolderButton) as IFolderBrowser
-                : new FolderBrowser(description, showNewFolderButton);
+            return !_oldSchool
+                ? new ModernFolderBrowser(_environment, description, showNewFolderButton) as IFolderBrowser
+                : new FolderBrowser(_environment, description, showNewFolderButton);
         }
 
         public IFolderBrowser CreateFolderBrowser(string description, bool showNewFolderButton, string rootFolder)
         {
-            return !OldSchool
-                ? new ModernFolderBrowser(description, showNewFolderButton, rootFolder) as IFolderBrowser
-                : new FolderBrowser(description, showNewFolderButton, rootFolder);
+            return !_oldSchool
+                ? new ModernFolderBrowser(_environment, description, showNewFolderButton, rootFolder) as IFolderBrowser
+                : new FolderBrowser(_environment, description, showNewFolderButton, rootFolder);
         }
     }
 }

RetailCoder.VBE/UI/FolderBrowser.cs

@@ -15,9 +15,11 @@ public interface IFolderBrowser : IDisposable
     public class FolderBrowser : IFolderBrowser
     {
         private readonly FolderBrowserDialog _dialog;
+        private readonly IEnvironmentProvider _environment;
 
-        public FolderBrowser(string description, bool showNewFolderButton, string rootFolder)
+        public FolderBrowser(IEnvironmentProvider environment, string description, bool showNewFolderButton, string rootFolder)
         {
+            _environment = environment;
             _dialog = new FolderBrowserDialog
             {
                 Description = description,
@@ -26,12 +28,12 @@ public FolderBrowser(string description, bool showNewFolderButton, string rootFo
             };
         }
 
-        public FolderBrowser(string description, bool showNewFolderButton)
-            : this(description, showNewFolderButton, Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments))
+        public FolderBrowser(IEnvironmentProvider environment, string description, bool showNewFolderButton)
+            : this(environment, description, showNewFolderButton, environment.GetFolderPath(Environment.SpecialFolder.MyDocuments))
         { }
 
-        public FolderBrowser(string description)
-            : this(description, true)
+        public FolderBrowser(IEnvironmentProvider environment, string description)
+            : this(environment, description, true)
         { }
 
         public string Description

RetailCoder.VBE/UI/ModernFolderBrowser.cs

@@ -33,10 +33,12 @@ public class ModernFolderBrowser : IFolderBrowser
 
         private readonly System.Windows.Forms.OpenFileDialog _dialog;
         private readonly object _newDialog;
+        private readonly IEnvironmentProvider _environment;
 
         // ReSharper disable once UnusedParameter.Local - new folder button suppression isn't supported in this dialog.
-        public ModernFolderBrowser(string description, bool showNewFolderButton, string rootFolder)
+        public ModernFolderBrowser(IEnvironmentProvider environment, string description, bool showNewFolderButton, string rootFolder)
         {
+            _environment = environment;
             _root = rootFolder;
             _dialog = new System.Windows.Forms.OpenFileDialog
             {
@@ -55,11 +57,11 @@ public ModernFolderBrowser(string description, bool showNewFolderButton, string
             IFileDialogSetOptions.Invoke(_newDialog, new object[] { options });
         }
 
-        public ModernFolderBrowser(string description, bool showNewFolderButton)
-            : this(description, showNewFolderButton, Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments))
+        public ModernFolderBrowser(IEnvironmentProvider environment, string description, bool showNewFolderButton)
+            : this(environment, description, showNewFolderButton, environment.GetFolderPath(Environment.SpecialFolder.MyDocuments))
         { }
 
-        public ModernFolderBrowser(string description) : this(description, true) { }
+        public ModernFolderBrowser(IEnvironmentProvider environment, string description) : this(environment, description, true) { }
 
         public string Description
         {

RetailCoder.VBE/UI/SourceControl/SourceControlViewViewModel.cs

@@ -38,6 +38,7 @@ public sealed class SourceControlViewViewModel : ViewModelBase, IDisposable
         private readonly IFolderBrowserFactory _folderBrowserFactory;
         private readonly IConfigProvider<SourceControlSettings> _configService;
         private readonly IMessageBox _messageBox;
+        private readonly IEnvironmentProvider _environment;
         private readonly FileSystemWatcher _fileSystemWatcher;
         private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
         private static readonly IEnumerable<string> VbFileExtensions = new[] { "cls", "bas", "frm" };
@@ -51,7 +52,8 @@ public SourceControlViewViewModel(
             IFolderBrowserFactory folderBrowserFactory,
             IConfigProvider<SourceControlSettings> configService,
             IEnumerable<IControlView> views,
-            IMessageBox messageBox)
+            IMessageBox messageBox,
+            IEnvironmentProvider environment)
         {
             _vbe = vbe;
             _state = state;
@@ -63,6 +65,7 @@ public SourceControlViewViewModel(
             _configService = configService;
             _config = _configService.Create();
             _messageBox = messageBox;
+            _environment = environment;
 
             _initRepoCommand = new DelegateCommand(LogManager.GetCurrentClassLogger(), _ => InitRepo(), _ => _vbe.VBProjects.Count != 0);
             _openRepoCommand = new DelegateCommand(LogManager.GetCurrentClassLogger(), _ => OpenRepo(), _ => _vbe.VBProjects.Count != 0);
@@ -947,7 +950,14 @@ private string GetDefaultRepoFolderOrDefault()
             var folder = settings.DefaultRepositoryLocation;
             if (string.IsNullOrEmpty(folder))
             {
-                folder = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);
+                try
+                {
+                    folder = _environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);
+                }
+                catch
+                {
+                    // ignored - empty is fine if the environment call fails.
+                }
             }
             return folder;
         }