VCST-3900: Environment settings comparison

src/VirtoCommerce.EnvironmentsCompare.Core/Models/ComparableEnvironment.cs

@@ -0,0 +1,10 @@
+namespace VirtoCommerce.EnvironmentsCompare.Core.Models;
+
+public class ComparableEnvironment
+{
+    public string Name { get; set; }
+
+    public string Url { get; set; }
+
+    public string ApiKey { get; set; }
+}

src/VirtoCommerce.EnvironmentsCompare.Core/Models/ComparableEnvironmentSettings.cs

@@ -0,0 +1,12 @@
+using System.Collections.Generic;
+
+namespace VirtoCommerce.EnvironmentsCompare.Core.Models;
+
+public class ComparableEnvironmentSettings
+{
+    public string EnvironmentName { get; set; }
+
+    public IList<ComparableSettingScope> SettingScopes { get; set; } = new List<ComparableSettingScope>();
+
+    public string ErrorMessage { get; set; }
+}

src/VirtoCommerce.EnvironmentsCompare.Core/Models/ComparableSetting.cs

@@ -0,0 +1,10 @@
+namespace VirtoCommerce.EnvironmentsCompare.Core.Models;
+
+public class ComparableSetting
+{
+    public string Name { get; set; }
+
+    public object Value { get; set; }
+
+    public bool IsSecret { get; set; }
+}

src/VirtoCommerce.EnvironmentsCompare.Core/Models/ComparableSettingGroup.cs

@@ -0,0 +1,10 @@
+using System.Collections.Generic;
+
+namespace VirtoCommerce.EnvironmentsCompare.Core.Models;
+
+public class ComparableSettingGroup
+{
+    public string GroupName { get; set; }
+
+    public IList<ComparableSetting> Settings { get; set; } = new List<ComparableSetting>();
+}

src/VirtoCommerce.EnvironmentsCompare.Core/Models/ComparableSettingScope.cs

@@ -0,0 +1,17 @@
+using System.Collections.Generic;
+
+namespace VirtoCommerce.EnvironmentsCompare.Core.Models;
+
+public class ComparableSettingScope
+{
+    /// <summary>
+    /// Scope of the settings, e.g. "Platform", "AppSettings"
+    /// </summary>
+    public string ScopeName { get; set; }
+
+    public string ProviderName { get; set; }
+
+    public string ErrorMessage { get; set; }
+
+    public IList<ComparableSettingGroup> SettingGroups { get; set; } = new List<ComparableSettingGroup>();
+}

src/VirtoCommerce.EnvironmentsCompare.Core/Models/ComparedEnvironmentSetting.cs

@@ -0,0 +1,10 @@
+using System.Collections.Generic;
+
+namespace VirtoCommerce.EnvironmentsCompare.Core.Models;
+
+public class ComparedEnvironmentSetting
+{
+    public string Name { get; set; }
+
+    public IList<ComparedEnvironmentSettingValue> ComparedValues { get; set; } = new List<ComparedEnvironmentSettingValue>();
+}

src/VirtoCommerce.EnvironmentsCompare.Core/Models/ComparedEnvironmentSettingGroup.cs

@@ -0,0 +1,10 @@
+using System.Collections.Generic;
+
+namespace VirtoCommerce.EnvironmentsCompare.Core.Models;
+
+public class ComparedEnvironmentSettingGroup
+{
+    public string GroupName { get; set; }
+
+    public IList<ComparedEnvironmentSetting> Settings { get; set; } = new List<ComparedEnvironmentSetting>();
+}

src/VirtoCommerce.EnvironmentsCompare.Core/Models/ComparedEnvironmentSettingScope.cs

@@ -0,0 +1,10 @@
+using System.Collections.Generic;
+
+namespace VirtoCommerce.EnvironmentsCompare.Core.Models;
+
+public class ComparedEnvironmentSettingScope
+{
+    public string ScopeName { get; set; }
+
+    public IList<ComparedEnvironmentSettingGroup> SettingGroups { get; set; } = new List<ComparedEnvironmentSettingGroup>();
+}

src/VirtoCommerce.EnvironmentsCompare.Core/Models/ComparedEnvironmentSettingValue.cs

@@ -0,0 +1,12 @@
+namespace VirtoCommerce.EnvironmentsCompare.Core.Models;
+
+public class ComparedEnvironmentSettingValue
+{
+    public string EnvironmentName { get; set; }
+
+    public object Value { get; set; }
+
+    public bool EqualsBaseValue { get; set; }
+
+    public string ErrorMessage { get; set; }
+}

src/VirtoCommerce.EnvironmentsCompare.Core/Models/SettingsComparisonResult.cs

@@ -0,0 +1,8 @@
+using System.Collections.Generic;
+
+namespace VirtoCommerce.EnvironmentsCompare.Core.Models;
+
+public class SettingsComparisonResult
+{
+    public IList<ComparedEnvironmentSettingScope> SettingScopes { get; set; } = new List<ComparedEnvironmentSettingScope>();
+}

src/VirtoCommerce.EnvironmentsCompare.Core/ModuleConstants.cs

@@ -55,4 +55,12 @@ public static IEnumerable<SettingDescriptor> AllSettings
             }
         }
     }
+
+    public static class EnvironmentsCompare
+    {
+        public const string CurrentEnvironmentName = "Current";
+
+        public const string ApiKeyHeaderName = "api-key";
+        public const string SettingsCompareRoute = "api/environments-compare-external";
+    }
 }

src/VirtoCommerce.EnvironmentsCompare.Core/Services/IComparableSettingsMasterProvider.cs

@@ -0,0 +1,10 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using VirtoCommerce.EnvironmentsCompare.Core.Models;
+
+namespace VirtoCommerce.EnvironmentsCompare.Core.Services;
+
+public interface IComparableSettingsMasterProvider
+{
+    Task<IList<ComparableSettingScope>> GetAllComparableSettingsAsync();
+}

src/VirtoCommerce.EnvironmentsCompare.Core/Services/IComparableSettingsProvider.cs

@@ -0,0 +1,9 @@
+using System.Threading.Tasks;
+using VirtoCommerce.EnvironmentsCompare.Core.Models;
+
+namespace VirtoCommerce.EnvironmentsCompare.Core.Services;
+
+public interface IComparableSettingsProvider
+{
+    Task<ComparableSettingScope> GetComparableSettingsAsync();
+}

src/VirtoCommerce.EnvironmentsCompare.Core/Services/IEnvironmentsCompareClient.cs

@@ -0,0 +1,10 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using VirtoCommerce.EnvironmentsCompare.Core.Models;
+
+namespace VirtoCommerce.EnvironmentsCompare.Core.Services;
+
+public interface IEnvironmentsCompareClient
+{
+    Task<IList<ComparableEnvironmentSettings>> GetSettingsAsync(IList<ComparableEnvironment> comparableEnvironments);
+}

src/VirtoCommerce.EnvironmentsCompare.Core/Services/IEnvironmentsCompareSettingsService.cs

@@ -0,0 +1,10 @@
+using System.Collections.Generic;
+using VirtoCommerce.EnvironmentsCompare.Core.Models;
+
+namespace VirtoCommerce.EnvironmentsCompare.Core.Services;
+
+public interface IEnvironmentsCompareSettingsService
+{
+    string SelfApiKey { get; }
+    IList<ComparableEnvironment> ComparableEnvironments { get; }
+}

src/VirtoCommerce.EnvironmentsCompare.Core/Services/ISettingsCompareService.cs

@@ -0,0 +1,10 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using VirtoCommerce.EnvironmentsCompare.Core.Models;
+
+namespace VirtoCommerce.EnvironmentsCompare.Core.Services;
+
+public interface ISettingsCompareService
+{
+    Task<SettingsComparisonResult> CompareAsync(IList<string> environmentNames, string baseEnvironmentName = null);
+}

src/VirtoCommerce.EnvironmentsCompare.Data/Services/ComparableAppSettingsProvider.cs

@@ -0,0 +1,39 @@
+using System.Threading.Tasks;
+using Microsoft.Extensions.Configuration;
+using VirtoCommerce.EnvironmentsCompare.Core.Models;
+using VirtoCommerce.EnvironmentsCompare.Core.Services;
+using VirtoCommerce.Platform.Core.Common;
+using VirtoCommerce.Platform.Core.Settings;
+
+namespace VirtoCommerce.EnvironmentsCompare.Data.Services;
+
+public class ComparableAppSettingsProvider(IConfiguration configuration) : IComparableSettingsProvider
+{
+    public Task<ComparableSettingScope> GetComparableSettingsAsync()
+    {
+        var result = AbstractTypeFactory<ComparableSettingScope>.TryCreateInstance();
+        result.ScopeName = "AppSettings";
+
+        var connectionStringsGroup = AbstractTypeFactory<ComparableSettingGroup>.TryCreateInstance();
+        connectionStringsGroup.GroupName = "ConnectionStrings";
+        result.SettingGroups.Add(connectionStringsGroup);
+
+        var connectionStringSetting = AbstractTypeFactory<ComparableSetting>.TryCreateInstance();
+        connectionStringSetting.Name = "ConnectionStrings.VirtoCommerce";
+        connectionStringSetting.Value = configuration.GetValue<string>("ConnectionStrings:VirtoCommerce");
+        connectionStringSetting.IsSecret = true;
+        connectionStringsGroup.Settings.Add(connectionStringSetting);
+
+        var virtoCommerceGroup = AbstractTypeFactory<ComparableSettingGroup>.TryCreateInstance();
+        virtoCommerceGroup.GroupName = "VirtoCommerce";
+        result.SettingGroups.Add(virtoCommerceGroup);
+
+        var licenseActivationUrlSetting = AbstractTypeFactory<ComparableSetting>.TryCreateInstance();
+        licenseActivationUrlSetting.Name = "VirtoCommerce.LicenseActivationUrl";
+        licenseActivationUrlSetting.Value = configuration.GetValue<string>("VirtoCommerce:LicenseActivationUrl");
+        licenseActivationUrlSetting.IsSecret = false;
+        virtoCommerceGroup.Settings.Add(licenseActivationUrlSetting);
+
+        return Task.FromResult(result);
+    }
+}

src/VirtoCommerce.EnvironmentsCompare.Data/Services/ComparablePlatformSettingsProvider.cs

@@ -0,0 +1,78 @@
+using System;
+using System.Linq;
+using System.Threading.Tasks;
+using VirtoCommerce.EnvironmentsCompare.Core.Models;
+using VirtoCommerce.EnvironmentsCompare.Core.Services;
+using VirtoCommerce.Platform.Core.Common;
+using VirtoCommerce.Platform.Core.Settings;
+
+namespace VirtoCommerce.EnvironmentsCompare.Data.Services;
+
+public class ComparablePlatformSettingsProvider(ISettingsManager settingsManager) : IComparableSettingsProvider
+{
+    public async Task<ComparableSettingScope> GetComparableSettingsAsync()
+    {
+        var result = AbstractTypeFactory<ComparableSettingScope>.TryCreateInstance();
+        result.ScopeName = "PlatformSettings";
+
+        foreach (var group in settingsManager.AllRegisteredSettings
+            .Where(x => !x.GroupName.IsNullOrEmpty())
+            .GroupBy(x => x.GroupName))
+        {
+            var resultGroup = AbstractTypeFactory<ComparableSettingGroup>.TryCreateInstance();
+            resultGroup.GroupName = group.Key;
+            result.SettingGroups.Add(resultGroup);
+
+            foreach (var setting in group)
+            {
+                var resultSetting = AbstractTypeFactory<ComparableSetting>.TryCreateInstance();
+                resultSetting.Name = setting.Name;
+                resultSetting.Value = await GetSettingValueAsync(setting);
+                resultSetting.IsSecret = IsSettingSecret(setting);
+                resultGroup.Settings.Add(resultSetting);
+            }
+        }
+
+        return result;
+    }
+
+    protected async Task<object> GetSettingValueAsync(SettingDescriptor settingDescriptor)
+    {
+        if (settingDescriptor.ValueType == SettingValueType.Boolean)
+        {
+            return await settingsManager.GetValueAsync<bool>(settingDescriptor);
+        }
+
+        if (settingDescriptor.ValueType == SettingValueType.Integer || settingDescriptor.ValueType == SettingValueType.PositiveInteger)
+        {
+            return await settingsManager.GetValueAsync<int>(settingDescriptor);
+        }
+
+        if (settingDescriptor.ValueType == SettingValueType.Decimal)
+        {
+            return await settingsManager.GetValueAsync<decimal>(settingDescriptor);
+        }
+
+        if (settingDescriptor.ValueType == SettingValueType.DateTime)
+        {
+            return await settingsManager.GetValueAsync<DateTime>(settingDescriptor);
+        }
+
+        if (settingDescriptor.ValueType == SettingValueType.Json)
+        {
+            return await settingsManager.GetValueAsync<string>(settingDescriptor);
+        }
+
+        if ((settingDescriptor.ValueType == SettingValueType.SecureString || settingDescriptor.ValueType == SettingValueType.ShortText || settingDescriptor.ValueType == SettingValueType.LongText))
+        {
+            return await settingsManager.GetValueAsync<string>(settingDescriptor);
+        }
+
+        return null;//TODO: handle other types
+    }
+
+    protected virtual bool IsSettingSecret(SettingDescriptor setting)
+    {
+        return setting.ValueType == SettingValueType.SecureString || setting.Name.EqualsIgnoreCase("Shipping.Bopis.GoogleMaps.ApiKey");//TODO: implement some flag in SettingDescriptor
+    }
+}

src/VirtoCommerce.EnvironmentsCompare.Data/Services/ComparableSettingsMasterProvider.cs

@@ -0,0 +1,58 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using VirtoCommerce.EnvironmentsCompare.Core.Models;
+using VirtoCommerce.EnvironmentsCompare.Core.Services;
+using VirtoCommerce.Platform.Core.Common;
+
+namespace VirtoCommerce.EnvironmentsCompare.Data.Services;
+
+public class ComparableSettingsMasterProvider(IEnumerable<IComparableSettingsProvider> comparableSettingsProviders) : IComparableSettingsMasterProvider
+{
+    public async Task<IList<ComparableSettingScope>> GetAllComparableSettingsAsync()
+    {
+        var result = new List<ComparableSettingScope>();
+
+        foreach (var provider in comparableSettingsProviders)
+        {
+            result.Add(await GetSettingsFromProviderAsync(provider));
+        }
+
+        HideSecretSettings(result.SelectMany(x => x.SettingGroups).SelectMany(x => x.Settings));
+
+        return result;
+    }
+
+    protected async Task<ComparableSettingScope> GetSettingsFromProviderAsync(IComparableSettingsProvider comparableSettingsProvider)
+    {
+        ComparableSettingScope result;
+
+        try
+        {
+            result = await comparableSettingsProvider.GetComparableSettingsAsync();
+
+            if (result == null)
+            {
+                throw new InvalidOperationException("The provider returned null settings group");
+            }
+        }
+        catch (Exception ex)
+        {
+            result = AbstractTypeFactory<ComparableSettingScope>.TryCreateInstance();
+            result.ErrorMessage = ex.Message;
+        }
+
+        result.ProviderName = comparableSettingsProvider.GetType().FullName;
+
+        return result;
+    }
+
+    protected virtual void HideSecretSettings(IEnumerable<ComparableSetting> settings)
+    {
+        foreach (var setting in settings.Where(x => x.IsSecret))
+        {
+            setting.Value = $"HASH: {setting.Value?.GetSHA1Hash()}";
+        }
+    }
+}