Enforce a consistent order for connection string options. Fixes #1217

Signed-off-by: Bradley Grainger <[email protected]>

Author: bgrainger

src/MySqlConnector/MySqlConnectionStringBuilder.cs

@@ -2,6 +2,7 @@
 using System.ComponentModel;
 using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
+using System.Linq;
 using System.Text.RegularExpressions;
 using MySqlConnector.Utilities;
 
@@ -787,6 +788,11 @@ public bool UseXaTransactions
 
 	// Other Methods
 
+	/// <summary>
+	/// Returns an <see cref="ICollection"/> that contains the keys in the <see cref="MySqlConnectionStringBuilder"/>.
+	/// </summary>
+	public override ICollection Keys => base.Keys.Cast<string>().OrderBy(x => MySqlConnectionStringOption.OptionNames.IndexOf(x)).ToList();
+
 	/// <summary>
 	/// Whether this <see cref="MySqlConnectionStringBuilder"/> contains a set option with the specified name.
 	/// </summary>
@@ -876,6 +882,8 @@ protected override void GetProperties(Hashtable propertyDescriptors)
 
 internal abstract class MySqlConnectionStringOption
 {
+	public static List<string> OptionNames { get; } = new();
+
 	// Connection Options
 	public static readonly MySqlConnectionStringReferenceOption<string> Server;
 	public static readonly MySqlConnectionStringValueOption<uint> Port;
@@ -892,9 +900,9 @@ internal abstract class MySqlConnectionStringOption
 	public static readonly MySqlConnectionStringReferenceOption<string> CertificatePassword;
 	public static readonly MySqlConnectionStringValueOption<MySqlCertificateStoreLocation> CertificateStoreLocation;
 	public static readonly MySqlConnectionStringReferenceOption<string> CertificateThumbprint;
-	public static readonly MySqlConnectionStringReferenceOption<string> SslCa;
 	public static readonly MySqlConnectionStringReferenceOption<string> SslCert;
 	public static readonly MySqlConnectionStringReferenceOption<string> SslKey;
+	public static readonly MySqlConnectionStringReferenceOption<string> SslCa;
 	public static readonly MySqlConnectionStringReferenceOption<string> TlsVersion;
 	public static readonly MySqlConnectionStringReferenceOption<string> TlsCipherSuites;
 
@@ -960,6 +968,7 @@ private static void AddOption(MySqlConnectionStringOption option)
 	{
 		foreach (string key in option.m_keys)
 			s_options.Add(key, option);
+		OptionNames.Add(option.m_keys[0]);
 	}
 
 #pragma warning disable CA1065 // Do not raise exceptions in unexpected locations
@@ -1014,8 +1023,12 @@ static MySqlConnectionStringOption()
 			keys: new[] { "Certificate Password", "CertificatePassword" },
 			defaultValue: ""));
 
-		AddOption(SslCa = new(
-			keys: new[] { "SSL CA", "CACertificateFile", "CA Certificate File", "SslCa", "Ssl-Ca" },
+		AddOption(CertificateStoreLocation = new(
+			keys: new[] { "Certificate Store Location", "CertificateStoreLocation" },
+			defaultValue: MySqlCertificateStoreLocation.None));
+
+		AddOption(CertificateThumbprint = new(
+			keys: new[] { "Certificate Thumbprint", "CertificateThumbprint", "Certificate Thumb Print" },
 			defaultValue: ""));
 
 		AddOption(SslCert = new(
@@ -1026,12 +1039,8 @@ static MySqlConnectionStringOption()
 			keys: new[] { "SSL Key", "SslKey", "Ssl-Key" },
 			defaultValue: ""));
 
-		AddOption(CertificateStoreLocation = new(
-			keys: new[] { "Certificate Store Location", "CertificateStoreLocation" },
-			defaultValue: MySqlCertificateStoreLocation.None));
-
-		AddOption(CertificateThumbprint = new(
-			keys: new[] { "Certificate Thumbprint", "CertificateThumbprint", "Certificate Thumb Print" },
+		AddOption(SslCa = new(
+			keys: new[] { "SSL CA", "CACertificateFile", "CA Certificate File", "SslCa", "Ssl-Ca" },
 			defaultValue: ""));
 
 		AddOption(TlsVersion = new(

tests/MySqlConnector.Tests/MySqlConnectionStringBuilderTests.cs

@@ -232,6 +232,22 @@ public void ParseConnectionString()
 		Assert.True(csb.UseAffectedRows);
 		Assert.True(csb.UseCompression);
 		Assert.Equal("username", csb.UserID);
+
+#if !BASELINE
+		Assert.Equal("Server=db-server;Port=1234;User ID=username;Password=Pass1234;Database=schema_name;Load Balance=Random;" +
+			"Connection Protocol=NamedPipe;Pipe Name=MyPipe;SSL Mode=VerifyCA;Certificate File=file.pfx;Certificate Password=Pass2345;" +
+			"Certificate Store Location=CurrentUser;Certificate Thumbprint=thumbprint123;SSL Cert=client-cert.pem;SSL Key=client-key.pem;" +
+			"SSL CA=ca.pem;TLS Version=\"TLS 1.2, TLS 1.3\";TLS Cipher Suites=TLS_AES_128_CCM_8_SHA256,TLS_RSA_WITH_RC4_128_MD5;" +
+			"Pooling=False;Connection Lifetime=15;Connection Reset=False;Defer Connection Reset=True;Connection Idle Timeout=30;" +
+			"Minimum Pool Size=5;Maximum Pool Size=15;Allow Load Local Infile=True;Allow Public Key Retrieval=True;Allow User Variables=True;" +
+			"Allow Zero DateTime=True;Application Name=\"My Test Application\";Auto Enlist=False;Cancellation Timeout=-1;Character Set=latin1;" +
+			"Connection Timeout=30;Convert Zero DateTime=True;DateTime Kind=Utc;Default Command Timeout=123;Force Synchronous=True;" +
+			"GUID Format=TimeSwapBinary16;Ignore Command Transaction=True;Ignore Prepare=True;Interactive Session=True;Keep Alive=90;" +
+			"No Backslash Escapes=True;Old Guids=True;Persist Security Info=True;Pipelining=False;Server Redirection Mode=Required;" +
+			"Server RSA Public Key File=rsa.pem;Server SPN=mariadb/[email protected];Treat Tiny As Boolean=False;" +
+			"Use Affected Rows=True;Use Compression=True;Use XA Transactions=False",
+			csb.ConnectionString);
+#endif
 	}
 
 	[Fact]

tests/SideBySide/ConnectionTests.cs

@@ -208,7 +208,7 @@ public void CloneWithUsesNewConnectionString(bool openConnection)
 		if (openConnection)
 			connection.Open();
 		using var connection2 = connection.CloneWith("user=root;password=pass;server=example.com;database=test");
-		Assert.Equal("User ID=root;Password=pass;Server=example.com;Database=test", connection2.ConnectionString);
+		Assert.Equal("Server=example.com;User ID=root;Password=pass;Database=test", connection2.ConnectionString);
 	}
 
 	[Fact]