Merge pull request #36 from aquality-automation/feature/separate-class-localized-logger

#33 Feature/separate class localized logger

Author: knysh

Aquality.Selenium/src/Aquality.Selenium/Aquality.Selenium.csproj

@@ -4,6 +4,11 @@
     <TargetFramework>netstandard2.0</TargetFramework>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Remove="Resources\Localization\en.json" />
+    <None Remove="Resources\Localization\ru.json" />
+  </ItemGroup>
+
   <ItemGroup>
     <EmbeddedResource Include="Resources\JavaScripts\AutoAcceptAlerts.js" />
     <EmbeddedResource Include="Resources\JavaScripts\BorderElement.js" />
@@ -29,6 +34,8 @@
     <EmbeddedResource Include="Resources\JavaScripts\SetFocus.js" />
     <EmbeddedResource Include="Resources\JavaScripts\SetInnerHTML.js" />
     <EmbeddedResource Include="Resources\JavaScripts\SetValue.js" />
+    <EmbeddedResource Include="Resources\Localization\en.json" />
+    <EmbeddedResource Include="Resources\Localization\ru.json" />
   </ItemGroup>
 
   <ItemGroup>
@@ -38,10 +45,6 @@
     <PackageReference Include="WebDriverManager" Version="2.5.1" />
   </ItemGroup>
 
-  <ItemGroup>
-    <Folder Include="Resources\Logging\Localization\" />
-  </ItemGroup>
-
   <ItemGroup>
     <None Update="nlog.config">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>

Aquality.Selenium/src/Aquality.Selenium/Browsers/BrowserNavigation.cs

@@ -43,7 +43,7 @@ public void Forward()
         /// <param name="url">String representation of URL.</param>
         public void GoToUrl(string url)
         {
-            Logger.InfoLoc("loc.browser.navigate", url);
+            InfoLocNavigate(url);
             driver.Navigate().GoToUrl(url);
         }
 
@@ -53,7 +53,7 @@ public void GoToUrl(string url)
         /// <param name="url">Uri representation of URL.</param>
         public void GoToUrl(Uri url)
         {
-            Logger.InfoLoc("loc.browser.navigate", url);
+            InfoLocNavigate(url.ToString());
             driver.Navigate().GoToUrl(url);
         }
 
@@ -65,5 +65,10 @@ public void Refresh()
             Logger.InfoLoc("loc.browser.refresh");
             driver.Navigate().Refresh();
         }
+
+        private void InfoLocNavigate(string url)
+        {
+            Logger.InfoLoc("loc.browser.navigate", url);
+        }
     }
 }

Aquality.Selenium/src/Aquality.Selenium/Elements/Actions/CheckBoxJsActions.cs

@@ -1,5 +1,6 @@
 using Aquality.Selenium.Browsers;
 using Aquality.Selenium.Elements.Interfaces;
+using Aquality.Selenium.Logging;
 
 namespace Aquality.Selenium.Elements.Actions
 {

Aquality.Selenium/src/Aquality.Selenium/Localization/LocalizationManager.cs

@@ -0,0 +1,35 @@
+using System;
+
+namespace Aquality.Selenium.Localization
+{
+    /// <summary>
+    /// This class is using for translation messages to different languages
+    /// </summary>
+    internal sealed class LocalizationManager
+    {
+        private const string DefLocale = "en";
+        private const string LocaleKey = "locale";
+        private const string LangResources = "Resources.Localization.{0}.json";
+        private static readonly Lazy<LocalizationManager> LazyInstance = new Lazy<LocalizationManager>(() => new LocalizationManager());
+        
+        private LocalizationManager()
+        {   
+        }
+
+        /// <summary>
+        /// Gets LocalizationManager instance.
+        /// </summary>
+        public static LocalizationManager Instance => LazyInstance.Value;
+
+        /// <summary>
+        /// Get localized message from resources by its key.
+        /// </summary>
+        /// <param name="messageKey">Key in resource file.</param>
+        /// <param name="args">Arguments, which will be provided to template of localized message.</param>
+        /// <returns>Localized message.</returns>
+        public string GetLocalizedMessage(string messageKey, params string [] args)
+        {
+            throw new NotImplementedException();
+        }
+    }
+}

Aquality.Selenium/src/Aquality.Selenium/Localization/SupportedLocale.cs

@@ -0,0 +1,11 @@
+namespace Aquality.Selenium.Localization
+{
+    /// <summary>
+    /// Supported locale.
+    /// </summary>
+    internal enum SupportedLocale
+    {
+        RU,
+        EN
+    }
+}

Aquality.Selenium/src/Aquality.Selenium/Logging/Logger.cs

@@ -10,8 +10,6 @@ namespace Aquality.Selenium.Logging
     /// </summary>
     public sealed class Logger
     {
-        private const string DefLocale = "en";
-        private const string LocaleKey = "logger.lang";
         private static readonly Lazy<Logger> LazyInstance = new Lazy<Logger>(() => new Logger());
         private static readonly ThreadLocal<ILogger> Log = new ThreadLocal<ILogger>(() => LogManager.GetLogger(Thread.CurrentThread.ManagedThreadId.ToString()));
 
@@ -95,67 +93,5 @@ public void Fatal(string message, Exception exception)
         {
             Log.Value.Fatal(exception, message);
         }
-
-        /// <summary>
-        /// Log localized info message.
-        /// </summary>
-        /// <param name="messageKey">Message messageKey from localization resources.</param>
-        /// <param name="args">Arguments to be pasted into message via string.Format.</param>
-        internal void InfoLoc(string messageKey, params object[] args)
-        {
-            Info(string.Format(GetLocalizedMessage(messageKey), args));
-        }
-
-        /// <summary>
-        /// Log localized debug message with optional exception.
-        /// </summary>
-        /// <param name="messageKey">Message messageKey from localization resources.</param>
-        /// <param name="exception">Occurred exception.</param>
-        /// <param name="args">Arguments to be pasted into message via string.Format.</param>
-        internal void DebugLoc(string messageKey, Exception exception = null, params object[] args)
-        {
-            Debug(string.Format(GetLocalizedMessage(messageKey), args), exception);
-        }
-
-        /// <summary>
-        /// Log localized warning message.
-        /// </summary>
-        /// <param name="messageKey">Message messageKey from localization resources.</param>
-        /// <param name="args">Arguments to be pasted into message via string.Format.</param>
-        internal void WarnLoc(string messageKey, params object[] args)
-        {
-            Warn(string.Format(GetLocalizedMessage(messageKey), args));
-        }
-
-        /// <summary>
-        /// Log localized error message.
-        /// </summary>
-        /// <param name="messageKey">Message messageKey from localization resources.</param>
-        /// <param name="args">Arguments to be pasted into message via string.Format</param>
-        internal void ErrorLoc(string messageKey, params object[] args)
-        {
-            Error(string.Format(GetLocalizedMessage(messageKey), args));
-        }
-
-        /// <summary>
-        /// Log localized fatal message with exception.
-        /// </summary>
-        /// <param name="messageKey">Message messageKey from localization resources.</param>
-        /// <param name="exception">Occurred exception.</param>
-        /// <param name="args">Arguments to be pasted into message via string.Format.</param>
-        internal void FatalLoc(string messageKey, Exception exception = null, params object[] args)
-        {
-            Fatal(string.Format(GetLocalizedMessage(messageKey), args), exception);
-        }
-
-        /// <summary>
-        /// Get localized message from resources by its key.
-        /// </summary>
-        /// <param name="messageKey">Key in resources file.</param>
-        /// <returns>Template of message.</returns>
-        private static string GetLocalizedMessage(string messageKey)
-        {
-            throw new NotImplementedException();
-        }
     }
 }

Aquality.Selenium/src/Aquality.Selenium/Logging/LoggerExtension.cs

@@ -0,0 +1,33 @@
+using System;
+using Aquality.Selenium.Localization;
+
+namespace Aquality.Selenium.Logging
+{
+    internal static class LoggerExtension
+    {
+        public static void InfoLoc(this Logger logger, string messageKey, params string[] args)
+        {
+            logger.Info(LocalizationManager.Instance.GetLocalizedMessage(messageKey, args));
+        }
+
+        public static void DebugLoc(this Logger logger, string messageKey, Exception exception = null, params string[] args)
+        {
+            logger.Debug(LocalizationManager.Instance.GetLocalizedMessage(messageKey, args), exception);
+        }
+
+        public static void WarnLoc(this Logger logger, string messageKey, params string[] args)
+        {
+            logger.Warn(LocalizationManager.Instance.GetLocalizedMessage(messageKey, args));
+        }
+
+        public static void ErrorLoc(this Logger logger, string messageKey, params string[] args)
+        {
+            logger.Error(LocalizationManager.Instance.GetLocalizedMessage(messageKey, args));
+        }
+
+        public static void FatalLoc(this Logger logger, string messageKey, Exception exception = null, params string[] args)
+        {
+            logger.Fatal(LocalizationManager.Instance.GetLocalizedMessage(messageKey, args), exception);
+        }
+    }
+}

Aquality.Selenium/src/Aquality.Selenium/Resources/Logging/Localization/selenium_loc_en.json renamed to Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/en.json

@@ -0,0 +1,2 @@
+{
+}