Ensure connection string settings are migrated during upgrade

Author: bording

src/ServiceControlInstaller.Engine/Configuration/ServiceControl/ServiceControlAppConfig.cs

@@ -1,9 +1,11 @@
 namespace ServiceControlInstaller.Engine.Configuration.ServiceControl
 {
     using System;
+    using System.Configuration;
     using System.Data.Common;
     using System.IO;
     using Instances;
+    using NuGet.Versioning;
 
     public class ServiceControlAppConfig : AppConfig
     {
@@ -14,9 +16,12 @@ public ServiceControlAppConfig(IServiceControlInstance instance) : base(Path.Com
 
         protected override void UpdateSettings()
         {
-            Config.ConnectionStrings.ConnectionStrings.Set("NServiceBus/Transport", UpdateConnectionString());
+            UpdateConnectionString();
+            Config.ConnectionStrings.ConnectionStrings.Set("NServiceBus/Transport", details.ConnectionString);
+
             var settings = Config.AppSettings.Settings;
             var version = details.Version;
+
             settings.Set(ServiceControlSettings.InstanceName, details.InstanceName, version);
             settings.Set(ServiceControlSettings.VirtualDirectory, details.VirtualDirectory);
             settings.Set(ServiceControlSettings.Port, details.Port.ToString());
@@ -73,40 +78,41 @@ public override void SetTransportType(string transportTypeName)
             settings.Set(ServiceControlSettings.TransportType, transportTypeName, version);
         }
 
-        string UpdateConnectionString()
+        void UpdateConnectionString()
         {
-            var connectionStringBuilder = new DbConnectionStringBuilder { ConnectionString = details.ConnectionString };
-
-            MigrateLicensingComponentRabbitMqManagementApiSettings(connectionStringBuilder);
-
-            return connectionStringBuilder.ConnectionString;
+            if (details.TransportPackage.Name.Contains("rabbitmq", StringComparison.OrdinalIgnoreCase))
+            {
+                MigrateLicensingComponentRabbitMqManagementApiSettings();
+            }
         }
 
-        void MigrateLicensingComponentRabbitMqManagementApiSettings(DbConnectionStringBuilder connectionStringBuilder)
+        void MigrateLicensingComponentRabbitMqManagementApiSettings()
         {
-            if (!details.TransportPackage.Name.Contains("rabbitmq", StringComparison.OrdinalIgnoreCase))
+            if (details.ConnectionString.StartsWith("amqp", StringComparison.OrdinalIgnoreCase))
             {
                 return;
             }
 
-            var settings = Config.AppSettings.Settings;
+            var shouldMigrate = VersionComparer.Version.Compare(details.Version, new SemanticVersion(6, 5, 0)) >= 0;
 
-            var legacySetting = settings[ServiceControlSettings.LicensingComponentRabbitMqManagementApiUrl.Name];
-            if (legacySetting is not null && !connectionStringBuilder.ContainsKey("ManagementApiUrl"))
+            if (shouldMigrate)
             {
-                connectionStringBuilder.Add("ManagementApiUrl", legacySetting.Value);
-            }
+                var connectionStringBuilder = new DbConnectionStringBuilder { ConnectionString = details.ConnectionString };
+                var settings = Config.AppSettings.Settings;
 
-            legacySetting = settings[ServiceControlSettings.LicensingComponentRabbitMqManagementApiUsername.Name];
-            if (legacySetting is not null && !connectionStringBuilder.ContainsKey("ManagementApiUserName"))
-            {
-                connectionStringBuilder.Add("ManagementApiUserName", legacySetting.Value);
+                MigrateSetting(connectionStringBuilder, settings[ServiceControlSettings.LicensingComponentRabbitMqManagementApiUrl.Name], "ManagementApiUrl");
+                MigrateSetting(connectionStringBuilder, settings[ServiceControlSettings.LicensingComponentRabbitMqManagementApiUsername.Name], "ManagementApiUserName");
+                MigrateSetting(connectionStringBuilder, settings[ServiceControlSettings.LicensingComponentRabbitMqManagementApiPassword.Name], "ManagementApiPassword");
+
+                details.ConnectionString = connectionStringBuilder.ConnectionString;
             }
 
-            legacySetting = settings[ServiceControlSettings.LicensingComponentRabbitMqManagementApiPassword.Name];
-            if (legacySetting is not null && !connectionStringBuilder.ContainsKey("ManagementApiPassword"))
+            static void MigrateSetting(DbConnectionStringBuilder connectionStringBuilder, KeyValueConfigurationElement setting, string connectionStringSettingName)
             {
-                connectionStringBuilder.Add("ManagementApiPassword", legacySetting.Value);
+                if (setting is not null && !connectionStringBuilder.ContainsKey(connectionStringSettingName))
+                {
+                    connectionStringBuilder.Add(connectionStringSettingName, setting.Value);
+                }
             }
         }
 

src/ServiceControlInstaller.Engine/Interfaces.cs

@@ -16,7 +16,7 @@ public interface ILogging
     public interface ITransportConfig
     {
         TransportInfo TransportPackage { get; }
-        string ConnectionString { get; }
+        string ConnectionString { get; set; }
     }
 
     public interface IPersistenceConfig