Refactoring some variables names and adding summary for some fields.

Author: Anouar Hassine

ReactiveXComponent/Configuration/BusDetails.cs

@@ -18,8 +18,8 @@ public BusDetails(
             int port,
             bool sslEnabled = false,
             string sslServerName = "",
-            string sslCertPath = "",
-            string sslCertPassphrase = "",
+            string sslCertificatePath = "",
+            string sslCertificatePassphrase = "",
             SslProtocols sslProtocol = SslProtocols.Default,
             bool sslAllowUntrustedServerCertificate = false)
         {
@@ -30,32 +30,65 @@ public BusDetails(
             Port = port;
             SslEnabled = sslEnabled;
             SslServerName = sslServerName;
-            SslCertPath = sslCertPath;
-            SslCertPassphrase = sslCertPassphrase;
+            SslCertificatePath = sslCertificatePath;
+            SslCertificatePassphrase = sslCertificatePassphrase;
             SslProtocol = sslProtocol;
             SslAllowUntrustedServerCertificate = sslAllowUntrustedServerCertificate;
         }
 
+        /// <summary>
+        /// Rabbit Mq user.
+        /// </summary>
         public string Username { get; set; }
 
+        /// <summary>
+        /// Rabbit Mq password for user.
+        /// </summary>
         public string Password { get; set; }
 
+        /// <summary>
+        /// Rabbit Mq server's address.
+        /// </summary>
         public string Host { get; set; }
 
+        /// <summary>
+        /// Rabbit Mq virtual host to connect to. 
+        /// </summary>
         public string VirtualHost { get; set; }
 
+        /// <summary>
+        /// Rabbit Mq server's port.
+        /// </summary>
         public int Port { get; set; }
 
+        /// <summary>
+        /// To enable SSL.
+        /// </summary>
         public bool SslEnabled { get; set; }
 
+        /// <summary>
+        /// Server's Common Name. It's indicated in the CN field of the server's certificate.
+        /// </summary>
         public string SslServerName { get; set; }
 
-        public string SslCertPath { get; set; }
+        /// <summary>
+        /// Path to the client's certificate.
+        /// </summary>
+        public string SslCertificatePath { get; set; }
 
-        public string SslCertPassphrase { get; set; }
+        /// <summary>
+        /// Passphrase for the client's certificate if it has one.
+        /// </summary>
+        public string SslCertificatePassphrase { get; set; }
 
+        /// <summary>
+        /// SSL protocol to use.
+        /// </summary>
         public SslProtocols SslProtocol { get; set; }
 
+        /// <summary>
+        /// To accept untrusted (e.g self-signed) server certificates. Only use this in Dev environment.
+        /// </summary>
         public bool SslAllowUntrustedServerCertificate { get; set; }
 
         public BusDetails Clone()
@@ -68,8 +101,8 @@ public BusDetails Clone()
                 Port,
                 SslEnabled,
                 SslServerName,
-                SslCertPath,
-                SslCertPassphrase,
+                SslCertificatePath,
+                SslCertificatePassphrase,
                 SslProtocol,
                 SslAllowUntrustedServerCertificate);
         }

ReactiveXComponent/Configuration/ConfigurationOverrides.cs

@@ -21,9 +21,9 @@ public class ConfigurationOverrides
 
         public string SslServerName { get; set; }
 
-        public string SslCertPath { get; set; }
+        public string SslCertificatePath { get; set; }
 
-        public string SslCertPassphrase { get; set; }
+        public string SslCertificatePassphrase { get; set; }
 
         public SslProtocols? SslProtocol { get; set; }
 

ReactiveXComponent/Configuration/XCApiTags.cs

@@ -33,8 +33,8 @@ public static class XCApiTags
         public const string VirtualHost = "virtualHost";
         public const string BusSslEnabled = "sslEnabled";
         public const string BusSslServerName = "sslServerName";
-        public const string BusSslCertPath = "sslCertPath";
-        public const string BusSslCertPassphrase = "sslCertPassphrase";
+        public const string BusSslCertificatePath = "sslCertPath";
+        public const string BusSslCertificatePassphrase = "sslCertPassphrase";
         public const string BusSslProtocol = "sslProtocol";
         public const string BusSslAllowUntrustedServerCertificate = "sslAllowUntrustedServerCertificate";
     }

ReactiveXComponent/Parser/XCApiConfigParser.cs

@@ -192,8 +192,8 @@ public BusDetails GetBusDetails()
             }
 
             var sslServerName = busInfos?.Attribute(XCApiTags.BusSslServerName)?.Value;
-            var sslCertPath = busInfos?.Attribute(XCApiTags.BusSslCertPath)?.Value;
-            var sslCertPassphrase = busInfos?.Attribute(XCApiTags.BusSslCertPassphrase)?.Value;
+            var sslCertificatePath = busInfos?.Attribute(XCApiTags.BusSslCertificatePath)?.Value;
+            var sslCertificatePassphrase = busInfos?.Attribute(XCApiTags.BusSslCertificatePassphrase)?.Value;
 
             var sslProtocolString = busInfos?.Attribute(XCApiTags.BusSslProtocol)?.Value;
             SslProtocols sslProtocol = SslProtocols.Default;
@@ -217,8 +217,8 @@ public BusDetails GetBusDetails()
                 Convert.ToInt32(busInfos?.Attribute(XCApiTags.Port)?.Value),
                 sslEnabled,
                 sslServerName,
-                sslCertPath,
-                sslCertPassphrase,
+                sslCertificatePath,
+                sslCertificatePassphrase,
                 sslProtocol,
                 sslAllowUntrustedServerCertificate);
 

ReactiveXComponent/RabbitMq/RabbitMqConnection.cs

@@ -60,14 +60,14 @@ public IXCSession CreateSession(ConfigurationOverrides configurationOverrides =
                 busDetails.SslServerName = configurationOverrides.SslServerName;
             }
 
-            if (configurationOverrides.SslCertPath != null)
+            if (configurationOverrides.SslCertificatePath != null)
             {
-                busDetails.SslCertPath = configurationOverrides.SslCertPath;
+                busDetails.SslCertificatePath = configurationOverrides.SslCertificatePath;
             }
 
-            if (configurationOverrides.SslCertPassphrase != null)
+            if (configurationOverrides.SslCertificatePassphrase != null)
             {
-                busDetails.SslCertPassphrase = configurationOverrides.SslCertPassphrase;
+                busDetails.SslCertificatePassphrase = configurationOverrides.SslCertificatePassphrase;
             }
 
             if (configurationOverrides.SslProtocol != null)

ReactiveXComponent/RabbitMq/RabbitMqSession.cs

@@ -46,14 +46,14 @@ private void InitConnection(BusDetails busDetails)
 
                     _factory.Ssl.ServerName = busDetails.SslServerName;
 
-                    if (!string.IsNullOrEmpty(busDetails.SslCertPath))
+                    if (!string.IsNullOrEmpty(busDetails.SslCertificatePath))
                     {
-                        _factory.Ssl.CertPath = busDetails.SslCertPath;
+                        _factory.Ssl.CertPath = busDetails.SslCertificatePath;
                     }
 
-                    if (!string.IsNullOrEmpty(busDetails.SslCertPassphrase))
+                    if (!string.IsNullOrEmpty(busDetails.SslCertificatePassphrase))
                     {
-                        _factory.Ssl.CertPassphrase = busDetails.SslCertPassphrase;
+                        _factory.Ssl.CertPassphrase = busDetails.SslCertificatePassphrase;
                     }
 
                     _factory.Ssl.Version = busDetails.SslProtocol;

ReactiveXComponentTest/Configuration/ConfigurationTests.cs

@@ -81,8 +81,8 @@ public void GetBusDetailsTest()
             Check.That(busDetails.Port).IsEqualTo(5671);
             Check.That(busDetails.SslEnabled).IsTrue();
             Check.That(busDetails.SslServerName).IsEqualTo("XComponent RMq");
-            Check.That(busDetails.SslCertPath).IsEqualTo("some_cert_path");
-            Check.That(busDetails.SslCertPassphrase).IsEqualTo("some_cert_pass");
+            Check.That(busDetails.SslCertificatePath).IsEqualTo("some_cert_path");
+            Check.That(busDetails.SslCertificatePassphrase).IsEqualTo("some_cert_pass");
             Check.That(busDetails.SslProtocol).IsEqualTo(SslProtocols.Default);
             Check.That(busDetails.SslAllowUntrustedServerCertificate).IsTrue();
         }