extract i localization manager (#27)

knysh · web-flow · commit cc45095d5d9b · 2019-10-16T18:40:48.000+03:00
* exstracted interfaces for LocalizationManager and LocalizationManager * updated LocalizationManagerTests * #23 renamed LocalizationLogger to LocalizedLogger * changed AddTransient to AddSingleton
diff --git a/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Applications/Startup.cs b/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Applications/Startup.cs
@@ -34,8 +34,8 @@ public void ConfigureServices(IServiceCollection services, Func<IServiceProvider
             services.AddTransient<ConditionalWait>();
             services.AddSingleton<ILoggerConfiguration>(new LoggerConfiguration(settingsFile));
             services.AddSingleton(Logger.Instance);
-            services.AddSingleton<LocalizationManager>();
-            services.AddSingleton<LocalizationLogger>();
+            services.AddSingleton<ILocalizationManager, LocalizationManager>();
+            services.AddSingleton<ILocalizedLogger, LocalizedLogger>();
             services.AddSingleton<IRetryConfiguration>(new RetryConfiguration(settingsFile));
             services.AddSingleton<ElementActionRetrier>();
 
diff --git a/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Aquality.Selenium.Core.xml b/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Aquality.Selenium.Core.xml
diff --git a/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Elements/Element.cs b/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Elements/Element.cs
@@ -42,7 +42,7 @@ protected Element(By locator, string name, ElementState state)
 
         protected abstract IElementFinder Finder { get; }
 
-        protected abstract LocalizationLogger LocalizationLogger { get; }
+        protected abstract ILocalizedLogger LocalizedLogger { get; }
 
         protected virtual Logger Logger => Logger.Instance;
 
@@ -103,7 +103,7 @@ protected virtual T DoWithRetry<T>(Func<T> function)
 
         protected virtual void LogElementAction(string messageKey, params object[] args)
         {
-            LocalizationLogger.InfoElementAction(ElementType, Name, messageKey, args);
+            LocalizedLogger.InfoElementAction(ElementType, Name, messageKey, args);
         }
     }
 }
diff --git a/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Elements/ElementFactory.cs b/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Elements/ElementFactory.cs
@@ -17,7 +17,7 @@ public class ElementFactory : IElementFactory
     {
         private const string ByXpathIdentifier = "By.XPath";
 
-        public ElementFactory(ConditionalWait conditionalWait, IElementFinder elementFinder, LocalizationManager localizationManager)
+        public ElementFactory(ConditionalWait conditionalWait, IElementFinder elementFinder, ILocalizationManager localizationManager)
         {
             ConditionalWait = conditionalWait;
             ElementFinder = elementFinder;
@@ -28,7 +28,7 @@ public ElementFactory(ConditionalWait conditionalWait, IElementFinder elementFin
 
         protected IElementFinder ElementFinder { get; }
 
-        protected LocalizationManager LocalizationManager { get; }
+        protected ILocalizationManager LocalizationManager { get; }
 
         /// <summary>
         /// Gets map between elements interfaces and their implementations.
diff --git a/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Elements/ElementFinder.cs b/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Elements/ElementFinder.cs
@@ -15,19 +15,19 @@ namespace Aquality.Selenium.Core.Elements
     /// </summary>
     public class ElementFinder : IElementFinder
     {
-        public ElementFinder(Logger logger, LocalizationLogger localizationLogger, LocalizationManager localizationManager, ConditionalWait conditionalWait)
+        public ElementFinder(Logger logger, ILocalizedLogger localizedLogger, ILocalizationManager localizationManager, ConditionalWait conditionalWait)
         {
             Logger = logger;
-            LocalizationLogger = localizationLogger;
+            LocalizedLogger = localizedLogger;
             LocalizationManager = localizationManager;
             ConditionalWait = conditionalWait;
         }
 
         private Logger Logger { get; }
 
-        private LocalizationLogger LocalizationLogger { get; }
+        private ILocalizedLogger LocalizedLogger { get; }
 
-        private LocalizationManager LocalizationManager { get; }
+        private ILocalizationManager LocalizationManager { get; }
 
         private ConditionalWait ConditionalWait { get; }
 
@@ -103,7 +103,7 @@ private void HandleTimeoutException(WebDriverTimeoutException ex, DesiredState d
                 }
                 else
                 {
-                    LocalizationLogger.Debug("loc.elements.were.found.but.not.in.state", null, locator.ToString(), desiredState.StateName);
+                    LocalizedLogger.Debug("loc.elements.were.found.but.not.in.state", null, locator.ToString(), desiredState.StateName);
                 }
             }
             else
diff --git a/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Localization/ILocalizationManager.cs b/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Localization/ILocalizationManager.cs
@@ -0,0 +1,16 @@
+﻿namespace Aquality.Selenium.Core.Localization
+{
+    /// <summary>
+    /// This interface is using for translation messages to different languages
+    /// </summary>
+    public interface ILocalizationManager
+    {
+        /// <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>
+        string GetLocalizedMessage(string messageKey, params object[] args);
+    }
+}
diff --git a/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Localization/ILocalizedLogger.cs b/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Localization/ILocalizedLogger.cs
@@ -0,0 +1,56 @@
+﻿using System;
+
+namespace Aquality.Selenium.Core.Localization
+{
+    /// <summary>
+    /// Log messages to different languages
+    /// </summary>
+    public interface ILocalizedLogger
+    {
+        /// <summary>
+        /// Logs localized message for action with INFO level which is applied for element, for example, click, send keys etc.
+        /// </summary>
+        /// <param name="elementType">Type of the element.</param>
+        /// <param name="elementName">Name of the element.</param>
+        /// <param name="messageKey">Key in resource file.</param>
+        /// <param name="args">Arguments, which will be provided to template of localized message.</param>
+        void InfoElementAction(string elementType, string elementName, string messageKey, params object[] args);
+
+        /// <summary>
+        /// Logs localized message with INFO level.
+        /// </summary>
+        /// <param name="messageKey">Key in resource file.</param>
+        /// <param name="args">Arguments, which will be provided to template of localized message.</param>
+        void Info(string messageKey, params object[] args);
+
+        /// <summary>
+        /// Logs localized message with DEBUG level.
+        /// </summary>
+        /// <param name="messageKey">Key in resource file.</param>
+        /// <param name="exception">Exception, gets null value by default.</param>
+        /// <param name="args">Arguments, which will be provided to template of localized message.</param>
+        void Debug(string messageKey, Exception exception = null, params object[] args);
+
+        /// <summary>
+        /// Logs localized message with WARN level.
+        /// </summary>
+        /// <param name="messageKey">Key in resource file.</param>
+        /// <param name="args">Arguments, which will be provided to template of localized message.</param>
+        void Warn(string messageKey, params object[] args);
+
+        /// <summary>
+        /// Logs localized message with ERROR level.
+        /// </summary>
+        /// <param name="messageKey">Key in resource file.</param>
+        /// <param name="args">Arguments, which will be provided to template of localized message.</param>
+        void Error(string messageKey, params object[] args);
+
+        /// <summary>
+        /// Logs localized message with FATAL level.
+        /// </summary>
+        /// <param name="messageKey">Key in resource file.</param>
+        /// <param name="exception">Exception, gets null value by default.</param>
+        /// <param name="args">Arguments, which will be provided to template of localized message.</param>
+        void Fatal(string messageKey, Exception exception = null, params object[] args);
+    }
+}
diff --git a/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Localization/LocalizationManager.cs b/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Localization/LocalizationManager.cs
@@ -5,13 +5,10 @@
 
 namespace Aquality.Selenium.Core.Localization
 {
-    /// <summary>
-    /// This class is using for translation messages to different languages
-    /// </summary>
-    public class LocalizationManager
+    public class LocalizationManager : ILocalizationManager
     {
         private const string LangResource = "Resources.Localization.{0}.json";
-        private readonly JsonSettingsFile localizationFile;
+        private readonly ISettingsFile localizationFile;
         private readonly Logger logger;
 
         public LocalizationManager(ILoggerConfiguration loggerConfiguration, Logger logger, Assembly assembly = null)
@@ -21,12 +18,6 @@ public LocalizationManager(ILoggerConfiguration loggerConfiguration, Logger logg
             this.logger = logger;
         }
 
-        /// <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 object[] args)
         {
             var jsonKey = $"$['{messageKey}']";
diff --git a/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Localization/LocalizedLogger.cs b/Aquality.Selenium.Core/src/Aquality.Selenium.Core/Localization/LocalizedLogger.cs
@@ -3,15 +3,12 @@
 
 namespace Aquality.Selenium.Core.Localization
 {
-    /// <summary>
-    /// Log messages to different languages
-    /// </summary>
-    public class LocalizationLogger
+    public class LocalizedLogger : ILocalizedLogger
     {
-        private readonly LocalizationManager localizationManager;
+        private readonly ILocalizationManager localizationManager;
         private readonly Logger logger;
 
-        public LocalizationLogger(LocalizationManager localizationManager, Logger logger)
+        public LocalizedLogger(ILocalizationManager localizationManager, Logger logger)
         {
             this.localizationManager = localizationManager;
             this.logger = logger;
diff --git a/Aquality.Selenium.Core/tests/Aquality.Selenium.Core.Tests/Applications/Browser/ApplicationNotStartedTests.cs b/Aquality.Selenium.Core/tests/Aquality.Selenium.Core.Tests/Applications/Browser/ApplicationNotStartedTests.cs
@@ -17,8 +17,8 @@ public class ApplicationNotStartedTests : TestWithBrowser
             typeof(ElementActionRetrier),
             typeof(ConditionalWait),
             typeof(Logger),
-            typeof(LocalizationManager),
-            typeof(LocalizationLogger),
+            typeof(ILocalizationManager),
+            typeof(ILocalizedLogger),
             typeof(IElementFinder),
             typeof(IElementFactory),
             typeof(ITimeoutConfiguration),
diff --git a/Aquality.Selenium.Core/tests/Aquality.Selenium.Core.Tests/Applications/WindowsApp/Elements/WindowElement.cs b/Aquality.Selenium.Core/tests/Aquality.Selenium.Core.Tests/Applications/WindowsApp/Elements/WindowElement.cs
@@ -25,6 +25,6 @@ protected WindowElement(By locator, string name) : base(locator, name, ElementSt
 
         protected override IElementFinder Finder => ApplicationManager.ServiceProvider.GetRequiredService<IElementFinder>();
 
-        protected override LocalizationLogger LocalizationLogger => ApplicationManager.ServiceProvider.GetRequiredService<LocalizationLogger>();
+        protected override ILocalizedLogger LocalizedLogger => ApplicationManager.ServiceProvider.GetRequiredService<ILocalizedLogger>();
     }
 }
diff --git a/Aquality.Selenium.Core/tests/Aquality.Selenium.Core.Tests/Localization/LocalizationManagerTests.cs b/Aquality.Selenium.Core/tests/Aquality.Selenium.Core.Tests/Localization/LocalizationManagerTests.cs
@@ -25,17 +25,26 @@ public sealed class LocalizationManagerTests : TestWithoutApplication
             "loc.elements.found.but.should.not"
         };
 
+        [Test]
+        public void Should_BePossibleTo_UseLocalizationManager_ForClicking_CustomConfig()
+        {
+            Environment.SetEnvironmentVariable("profile", "custom");
+            SetUp();
+            Environment.SetEnvironmentVariable("profile", string.Empty);
+            Assert.AreEqual("Націскаем", ServiceProvider.GetService<ILocalizationManager>().GetLocalizedMessage("loc.clicking"));
+        }
+
         [Test]
         public void Should_BePossibleTo_UseLocalizationManager_ForClicking()
         {
-            Assert.AreEqual("Clicking", ServiceProvider.GetService<LocalizationManager>().GetLocalizedMessage("loc.clicking"));
+            Assert.AreEqual("Clicking", ServiceProvider.GetService<ILocalizationManager>().GetLocalizedMessage("loc.clicking"));
         }
 
         [Test]
         public void Should_BePossibleTo_UseLocalizationManager_ForUnknownKey()
         {
             var unknownKey = "loc.unknown.fake.key";
-            Assert.AreEqual(unknownKey, ServiceProvider.GetService<LocalizationManager>().GetLocalizedMessage(unknownKey));
+            Assert.AreEqual(unknownKey, ServiceProvider.GetService<ILocalizationManager>().GetLocalizedMessage(unknownKey));
         }
 
         [Test]

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ protected Element(By locator, string name, ElementState state)`
`42`	`42`
`43`	`43`	`protected abstract IElementFinder Finder { get; }`
`44`	`44`
`45`		`- protected abstract LocalizationLogger LocalizationLogger { get; }`
	`45`	`+ protected abstract ILocalizedLogger LocalizedLogger { get; }`
`46`	`46`
`47`	`47`	`protected virtual Logger Logger => Logger.Instance;`
`48`	`48`
`@@ -103,7 +103,7 @@ protected virtual T DoWithRetry<T>(Func<T> function)`
`103`	`103`
`104`	`104`	`protected virtual void LogElementAction(string messageKey, params object[] args)`
`105`	`105`	`{`
`106`		`- LocalizationLogger.InfoElementAction(ElementType, Name, messageKey, args);`
	`106`	`+ LocalizedLogger.InfoElementAction(ElementType, Name, messageKey, args);`
`107`	`107`	`}`
`108`	`108`	`}`
`109`	`109`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public class ElementFactory : IElementFactory`
`17`	`17`	`{`
`18`	`18`	`private const string ByXpathIdentifier = "By.XPath";`
`19`	`19`
`20`		`- public ElementFactory(ConditionalWait conditionalWait, IElementFinder elementFinder, LocalizationManager localizationManager)`
	`20`	`+ public ElementFactory(ConditionalWait conditionalWait, IElementFinder elementFinder, ILocalizationManager localizationManager)`
`21`	`21`	`{`
`22`	`22`	`ConditionalWait = conditionalWait;`
`23`	`23`	`ElementFinder = elementFinder;`
`@@ -28,7 +28,7 @@ public ElementFactory(ConditionalWait conditionalWait, IElementFinder elementFin`
`28`	`28`
`29`	`29`	`protected IElementFinder ElementFinder { get; }`
`30`	`30`
`31`		`- protected LocalizationManager LocalizationManager { get; }`
	`31`	`+ protected ILocalizationManager LocalizationManager { get; }`
`32`	`32`
`33`	`33`	`/// <summary>`
`34`	`34`	`/// Gets map between elements interfaces and their implementations.`
Original file line number	Diff line number	Diff line change
`@@ -15,19 +15,19 @@ namespace Aquality.Selenium.Core.Elements`
`15`	`15`	`/// </summary>`
`16`	`16`	`public class ElementFinder : IElementFinder`
`17`	`17`	`{`
`18`		`- public ElementFinder(Logger logger, LocalizationLogger localizationLogger, LocalizationManager localizationManager, ConditionalWait conditionalWait)`
	`18`	`+ public ElementFinder(Logger logger, ILocalizedLogger localizedLogger, ILocalizationManager localizationManager, ConditionalWait conditionalWait)`
`19`	`19`	`{`
`20`	`20`	`Logger = logger;`
`21`		`- LocalizationLogger = localizationLogger;`
	`21`	`+ LocalizedLogger = localizedLogger;`
`22`	`22`	`LocalizationManager = localizationManager;`
`23`	`23`	`ConditionalWait = conditionalWait;`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`private Logger Logger { get; }`
`27`	`27`
`28`		`- private LocalizationLogger LocalizationLogger { get; }`
	`28`	`+ private ILocalizedLogger LocalizedLogger { get; }`
`29`	`29`
`30`		`- private LocalizationManager LocalizationManager { get; }`
	`30`	`+ private ILocalizationManager LocalizationManager { get; }`
`31`	`31`
`32`	`32`	`private ConditionalWait ConditionalWait { get; }`
`33`	`33`
`@@ -103,7 +103,7 @@ private void HandleTimeoutException(WebDriverTimeoutException ex, DesiredState d`
`103`	`103`	`}`
`104`	`104`	`else`
`105`	`105`	`{`
`106`		`- LocalizationLogger.Debug("loc.elements.were.found.but.not.in.state", null, locator.ToString(), desiredState.StateName);`
	`106`	`+ LocalizedLogger.Debug("loc.elements.were.found.but.not.in.state", null, locator.ToString(), desiredState.StateName);`
`107`	`107`	`}`
`108`	`108`	`}`
`109`	`109`	`else`
Original file line number	Diff line number	Diff line change
`@@ -3,15 +3,12 @@`
`3`	`3`
`4`	`4`	`namespace Aquality.Selenium.Core.Localization`
`5`	`5`	`{`
`6`		`- /// <summary>`
`7`		`- /// Log messages to different languages`
`8`		`- /// </summary>`
`9`		`- public class LocalizationLogger`
	`6`	`+ public class LocalizedLogger : ILocalizedLogger`
`10`	`7`	`{`
`11`		`- private readonly LocalizationManager localizationManager;`
	`8`	`+ private readonly ILocalizationManager localizationManager;`
`12`	`9`	`private readonly Logger logger;`
`13`	`10`
`14`		`- public LocalizationLogger(LocalizationManager localizationManager, Logger logger)`
	`11`	`+ public LocalizedLogger(ILocalizationManager localizationManager, Logger logger)`
`15`	`12`	`{`
`16`	`13`	`this.localizationManager = localizationManager;`
`17`	`14`	`this.logger = logger;`