Add support for defining settings folder (#188)

* Add support for defining settings folder

* Docs changes

* Update

* Docs changes

* wip

* update

* fix

* Docs changes

* update

* Docs changes

* update

* Docs changes

* update pipeline

* update test coverage

---------

Co-authored-by: GitHub Action <action@github.com>

.azuredevops/Pipelines/Templates/create-installer.yaml

@@ -4,6 +4,7 @@ steps:
   displayName: Remove unneeded files
   inputs:
     contents: |
+      _output/**/appsettings.json
       _output/**/*.xlm
       _output/**/*.config
       _output/**/*.pdb

README.md

@@ -64,6 +64,31 @@ The repositories shown in RepoM are filtered using the search box in RepoM. But
 
 When RepoM starts for the first time, a configuration file wil be created. Most of the properties can be adjusted using the UI but, at this moment, one property must be altered manually. Read more over [here](docs/_old/Settings.md).
 
+## Multi configuration
+
+By default, RepoM stores all configuration files in `%ADPPDATA%/RepoM`. As a user you can alter this location to support multi configurations which might be useful for different working environments. Also, for development or debug purposes, this might be very useful.
+
+To change the app settings location, you can
+
+- alter the `appsettings.json` file located in the same directory where the RepoM executable lives.
+
+<!-- snippet: appsettings_appsettings_path_relative -->
+<a id='snippet-appsettings_appsettings_path_relative'></a>
+```cs
+{
+  "App": {
+    "AppSettingsPath": "MyConfigJson"
+  }
+}
+```
+<sup><a href='/tests/RepoM.App.Tests/ConfigBasedAppDataPathProviderFactoryTest.cs#L20-L26' title='Snippet source file'>snippet source</a> | <a href='#snippet-appsettings_appsettings_path_relative' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+- start RepoM using the commandline argument `--App:AppSettingsPath '<absolute or relative path here>'`.
+- use environment variable `REPOM_App__AppSettingsPath`.
+
+If none is set, the default will be used.
+
 ## Plugins
 
 RepoM uses plugins to extend functionality. At this moment, when a plugin is available in the installed directory, it will be found and can be enabled or disabled. This is done in the hamburger menu of RepoM. Enabling or disabling requires a restart of RepoM.

README.source.md

@@ -64,6 +64,21 @@ The repositories shown in RepoM are filtered using the search box in RepoM. But
 
 When RepoM starts for the first time, a configuration file wil be created. Most of the properties can be adjusted using the UI but, at this moment, one property must be altered manually. Read more over [here](docs/_old/Settings.md).
 
+## Multi configuration
+
+By default, RepoM stores all configuration files in `%ADPPDATA%/RepoM`. As a user you can alter this location to support multi configurations which might be useful for different working environments. Also, for development or debug purposes, this might be very useful.
+
+To change the app settings location, you can
+
+- alter the `appsettings.json` file located in the same directory where the RepoM executable lives.
+
+snippet: appsettings_appsettings_path_relative
+
+- start RepoM using the commandline argument `--App:AppSettingsPath '<absolute or relative path here>'`.
+- use environment variable `REPOM_App__AppSettingsPath`.
+
+If none is set, the default will be used.
+
 ## Plugins
 
 RepoM uses plugins to extend functionality. At this moment, when a plugin is available in the installed directory, it will be found and can be enabled or disabled. This is done in the hamburger menu of RepoM. Enabling or disabling requires a restart of RepoM.

src/RepoM.Api/Bootstrapper.cs

@@ -2,7 +2,6 @@ namespace RepoM.Api;
 
 using Microsoft.Extensions.Logging;
 using RepoM.Api.Common;
-using RepoM.Api.IO;
 using RepoM.Api.Plugins;
 using SimpleInjector;
 using System.Collections.Generic;
@@ -87,7 +86,7 @@ await container
                 .RegisterPackagesAsync(
                     assemblies,
                     filename => new FileBasedPackageConfiguration(
-                        DefaultAppDataPathProvider.Instance,
+                        _appDataProvider,
                         _fileSystem,
                         _loggerFactory.CreateLogger<FileBasedPackageConfiguration>(),
                         filename))

src/RepoM.Api/IO/AppDataPathConfig.cs

@@ -0,0 +1,6 @@
+namespace RepoM.Api.IO;
+
+public record struct AppDataPathConfig
+{
+    public string? AppSettingsPath { get; init; }
+}

src/RepoM.Api/IO/AppDataPathProvider.cs

@@ -0,0 +1,24 @@
+namespace RepoM.Api.IO;
+
+using System;
+using System.IO.Abstractions;
+using RepoM.Core.Plugin.Common;
+
+public sealed class AppDataPathProvider : IAppDataPathProvider
+{ 
+    public AppDataPathProvider(AppDataPathConfig config, IFileSystem fileSystem)
+    {
+        ArgumentNullException.ThrowIfNull(config);
+        ArgumentNullException.ThrowIfNull(fileSystem);
+
+        if (!string.IsNullOrWhiteSpace(config.AppSettingsPath))
+        {
+            AppDataPath = fileSystem.Path.GetFullPath(config.AppSettingsPath);
+            return;
+        }
+
+        AppDataPath = fileSystem.Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "RepoM");
+    }
+
+    public string AppDataPath { get; }
+}

src/RepoM.App/App.xaml.cs

@@ -22,6 +22,7 @@ namespace RepoM.App;
 using Container = SimpleInjector.Container;
 using RepoM.App.Services.HotKey;
 using RepoM.Api;
+using RepoM.App.Configuration;
 
 /// <summary>
 /// Interaction logic for App.xaml
@@ -69,22 +70,26 @@ protected override async void OnStartup(StartupEventArgs e)
         IHmacService hmacService = new HmacSha256Service();
         IPluginFinder pluginFinder = new PluginFinder(fileSystem, hmacService);
 
-        IConfiguration config = SetupConfiguration();
+        var factory = new ConfigBasedAppDataPathProviderFactory(e.Args, fileSystem);
+        AppDataPathProvider appDataProvider = factory.Create();
+
+        IConfiguration config = CreateLoggerConfiguration(appDataProvider);
         ILoggerFactory loggerFactory = CreateLoggerFactory(config);
+
         ILogger logger = loggerFactory.CreateLogger(nameof(App));
         logger.LogInformation("Started");
         Bootstrapper.RegisterLogging(loggerFactory);
-        Bootstrapper.RegisterServices(fileSystem);
-        await Bootstrapper.RegisterPlugins(pluginFinder, fileSystem, loggerFactory).ConfigureAwait(true);
+        Bootstrapper.RegisterServices(fileSystem, appDataProvider);
+        await Bootstrapper.RegisterPlugins(pluginFinder, fileSystem, loggerFactory, appDataProvider).ConfigureAwait(true);
+
+        var ensureStartup = new EnsureStartup(fileSystem, appDataProvider);
+        await ensureStartup.EnsureFilesAsync().ConfigureAwait(true);
 
 #if DEBUG
         Bootstrapper.Container.Verify(SimpleInjector.VerificationOption.VerifyAndDiagnose);
 #else
         Bootstrapper.Container.Options.EnableAutoVerification = false;
 #endif
-
-        EnsureStartup ensureStartup = Bootstrapper.Container.GetInstance<EnsureStartup>();
-        await ensureStartup.EnsureFilesAsync().ConfigureAwait(true);
 
         UseRepositoryMonitor(Bootstrapper.Container);
 
@@ -104,7 +109,7 @@ protected override async void OnStartup(StartupEventArgs e)
             logger.LogError(exception, "Could not start all modules.");
         }
     }
-    
+
     protected override void OnExit(ExitEventArgs e)
     {
         _windowSizeService?.Unregister();
@@ -113,19 +118,17 @@ protected override void OnExit(ExitEventArgs e)
 
         _hotKeyService?.Unregister();
 
-// #pragma warning disable CA1416 // Validate platform compatibility
         _notifyIcon?.Dispose();
-// #pragma warning restore CA1416 // Validate platform compatibility
 
         ReleaseAndDisposeMutex();
 
         base.OnExit(e);
     }
 
-    private static IConfiguration SetupConfiguration()
+    private static IConfiguration CreateLoggerConfiguration(AppDataPathProvider appDataProvider)
     {
         const string FILENAME = "appsettings.serilog.json";
-        var fullFilename = Path.Combine(DefaultAppDataPathProvider.Instance.AppDataPath, FILENAME);
+        var fullFilename = Path.Combine(appDataProvider.AppDataPath, FILENAME);
 
         IConfigurationBuilder builder = new ConfigurationBuilder()
             .SetBasePath(Directory.GetCurrentDirectory())
@@ -151,6 +154,8 @@ private static ILoggerFactory CreateLoggerFactory(IConfiguration config)
         return loggerFactory;
     }
 
+
+
     private static void UseRepositoryMonitor(Container container)
     {
         _repositoryMonitor = container.GetInstance<IRepositoryMonitor>();

src/RepoM.App/Bootstrapper.cs

@@ -41,7 +41,7 @@ internal static class Bootstrapper
 {
     public static readonly Container Container = new();
 
-    public static void RegisterServices(IFileSystem fileSystem)
+    public static void RegisterServices(IFileSystem fileSystem, IAppDataPathProvider appDataProvider)
     {
         Container.RegisterInstance<ObjectCache>(MemoryCache.Default);
         Container.RegisterSingleton<Window>(() => Container.GetInstance<MainWindow>());
@@ -51,7 +51,7 @@ public static void RegisterServices(IFileSystem fileSystem)
         Container.Register<IRepositoryDetectorFactory, DefaultRepositoryDetectorFactory>(Lifestyle.Singleton);
         Container.Register<IRepositoryObserverFactory, DefaultRepositoryObserverFactory>(Lifestyle.Singleton);
         Container.Register<IGitRepositoryFinderFactory, GitRepositoryFinderFactory>(Lifestyle.Singleton);
-        Container.RegisterInstance<IAppDataPathProvider>(DefaultAppDataPathProvider.Instance);
+        Container.RegisterInstance(appDataProvider);
         Container.Register<IRepositoryReader, DefaultRepositoryReader>(Lifestyle.Singleton);
         Container.Register<IRepositoryWriter, DefaultRepositoryWriter>(Lifestyle.Singleton);
         Container.Register<IRepositoryStore, DefaultRepositoryStore>(Lifestyle.Singleton);
@@ -106,27 +106,26 @@ public static void RegisterServices(IFileSystem fileSystem)
         Container.Register<IRepositoryComparerFactory<SumComparerConfigurationV1>, SumRepositoryComparerFactory>(Lifestyle.Singleton);
 
         Container.RegisterSingleton<ActionExecutor>();
-        Container.Register(typeof(ICommandExecutor<>), new[] { typeof(CoreBootstrapper).Assembly, }, Lifestyle.Singleton);
+        Container.Register(typeof(ICommandExecutor<>), [typeof(CoreBootstrapper).Assembly,], Lifestyle.Singleton);
         Container.RegisterDecorator(
             typeof(ICommandExecutor<>),
             typeof(LoggerCommandExecutorDecorator<>),
             Lifestyle.Singleton);
 
         Container.RegisterSingleton<HotKeyService>();
         Container.RegisterSingleton<WindowSizeService>();
-
-        Container.RegisterSingleton<EnsureStartup>();
     }
 
     public static async Task RegisterPlugins(
         IPluginFinder pluginFinder,
         IFileSystem fileSystem,
-        ILoggerFactory loggerFactory)
+        ILoggerFactory loggerFactory,
+        IAppDataPathProvider appDataPathProvider)
     {
         Container.Register<ModuleService>(Lifestyle.Singleton);
         Container.RegisterInstance(pluginFinder);
 
-        var coreBootstrapper = new CoreBootstrapper(pluginFinder, fileSystem, DefaultAppDataPathProvider.Instance, loggerFactory);
+        var coreBootstrapper = new CoreBootstrapper(pluginFinder, fileSystem, appDataPathProvider, loggerFactory);
         var baseDirectory = fileSystem.Path.Combine(AppDomain.CurrentDomain.BaseDirectory);
         await coreBootstrapper.LoadAndRegisterPluginsAsync(Container, baseDirectory).ConfigureAwait(false);
     }

src/RepoM.App/Configuration/Config.cs

@@ -0,0 +1,9 @@
+namespace RepoM.App.Configuration;
+
+public class Config
+{
+    /// <summary>
+    /// Absolute or relative path to the app settings folder.
+    /// </summary>
+    public string? AppSettingsPath { get; init; }
+}

src/RepoM.App/Properties/launchSettings.json

@@ -0,0 +1,11 @@
+{
+  "profiles": {
+    "RepoM.App bin config": {
+      "commandName": "Project",
+      "commandLineArgs": "--App:AppSettingsPath RepoMConfig"
+    },
+    "RepoM.App": {
+      "commandName": "Project"
+    }
+  }
+}

src/RepoM.App/RepoM.App.csproj

@@ -37,6 +37,7 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="8.0.2" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.CommandLine" Version="8.0.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="8.0.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="8.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
@@ -64,6 +65,13 @@
     </Compile>
   </ItemGroup>
   <ItemGroup>
+    <None Update="appsettings.Development.json">
+      <CopyToOutputDirectory Condition="$(Configuration) == 'Release'">Never</CopyToOutputDirectory>
+      <CopyToOutputDirectory Condition="$(Configuration) == 'Debug'">PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="appsettings.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Update="appsettings.serilog.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>

src/RepoM.App/Services/ConfigBasedAppDataPathProviderFactory.cs

@@ -0,0 +1,66 @@
+namespace RepoM.App.Services;
+
+using System;
+using System.IO.Abstractions;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.FileProviders;
+using RepoM.Api.IO;
+using RepoM.App.Configuration;
+
+internal class ConfigBasedAppDataPathProviderFactory
+{
+    private readonly string[] _args;
+    private readonly IFileProvider? _fileProvider;
+    private readonly IFileSystem _fileSystem;
+
+    public ConfigBasedAppDataPathProviderFactory(string[] args, IFileSystem fileSystem)
+    {
+        _args = args ?? throw new ArgumentNullException(nameof(args));
+        _fileSystem = fileSystem ?? throw new ArgumentNullException(nameof(fileSystem));
+    }
+
+    public ConfigBasedAppDataPathProviderFactory(string[] args, IFileSystem fileSystem, IFileProvider fileProvider)
+        :this(args, fileSystem)
+    {
+        _fileProvider = fileProvider ?? throw new ArgumentNullException(nameof(fileProvider));
+    }
+
+    public AppDataPathProvider Create()
+    {
+        IConfiguration configuration = CreateConfiguration(_args);
+        return CreateAppDataPathProvider(configuration);
+    }
+
+    private IConfiguration CreateConfiguration(string[] args)
+    {
+        var builder = new ConfigurationBuilder();
+        if (_fileProvider != null)
+        {
+            builder.SetFileProvider(_fileProvider);
+        }
+
+        builder.AddEnvironmentVariables("REPOM_");
+
+        builder.AddJsonFile("appsettings.json", optional: true, reloadOnChange: false);
+
+#if DEBUG
+        builder.AddJsonFile("appsettings.Development.json", optional: true, reloadOnChange: false);
+#endif
+
+        builder.AddCommandLine(args);
+
+        return builder.Build();
+    }
+
+    private AppDataPathProvider CreateAppDataPathProvider(IConfiguration appDataPathConfiguration)
+    {
+        var appConfig = new Config();
+        appDataPathConfiguration.Bind("App", appConfig);
+        var appDataPathConfig = new AppDataPathConfig
+        {
+            AppSettingsPath = appConfig.AppSettingsPath,
+        };
+
+        return new AppDataPathProvider(appDataPathConfig, _fileSystem);
+    }
+}

src/RepoM.App/appsettings.Development.json

@@ -0,0 +1,7 @@
+{
+  "App": {
+    // Absolute or relative path to the configuration directory.
+    // like: "AppSettingsPath": "C:/my-config/",
+    "AppSettingsPath": "MyConfig"
+  }
+}

src/RepoM.App/appsettings.json

@@ -0,0 +1,5 @@
+{
+  "App": {
+    "AppSettingsPath": null
+  }
+}