Merge pull request #138 from telekom/bugfix/thread-safe-localization

Removed automatic locale switch based on thread-unsafe Locale.getDefa…

Author: Mike Reiche

build.gradle

@@ -31,6 +31,8 @@ allprojects {
     apply plugin: 'java-library'
     apply plugin: 'project-report'
 
+    compileJava.options.encoding = 'UTF-8'
+    compileTestJava.options.encoding = "UTF-8"
     sourceCompatibility = JavaVersion.VERSION_1_8
     targetCompatibility = JavaVersion.VERSION_1_8
 }

core-interop/src/main/java/eu/tsystems/mms/tic/testframework/l10n/LocalizedBundle.java

@@ -26,40 +26,18 @@
 import java.util.ResourceBundle;
 
 public class LocalizedBundle {
-    private ResourceBundle resourceBundle;
+    private final ResourceBundle resourceBundle;
     private static final ResourceBundle.Control resourceBundleController = new UTF8ResourceBundleControl();
-    /**
-     * When the bundle name is NULL, the {@link #resourceBundle} is fixed
-     */
-    private final String bundleName;
 
     public LocalizedBundle(String bundleName, Locale locale) {
-        this.bundleName = null;
         this.resourceBundle = ResourceBundle.getBundle(bundleName, locale, resourceBundleController);
     }
 
     public LocalizedBundle(String bundleName) {
-        this.bundleName = bundleName;
-        recreateLocalizedResourceBundle();
-    }
-
-    private ResourceBundle getResourceBundle() {
-        /**
-         * When the locale is not fixed and differs from the default locale
-         * than recreate the bundle.
-         */
-        if (this.bundleName != null && Locale.getDefault() != this.resourceBundle.getLocale()) {
-            recreateLocalizedResourceBundle();
-        }
-        return resourceBundle;
-    }
-
-    private void recreateLocalizedResourceBundle() {
-        this.resourceBundle = ResourceBundle.getBundle(this.bundleName, resourceBundleController);
+        this(bundleName, Locale.getDefault());
     }
 
     public String getString(String label) {
-        ResourceBundle resourceBundle = getResourceBundle();
         if (resourceBundle.containsKey(label)) {
             return resourceBundle.getString(label);
         } else {

core-interop/src/main/java/eu/tsystems/mms/tic/testframework/l10n/SimpleLocalization.java

@@ -21,15 +21,29 @@
  */
 package eu.tsystems.mms.tic.testframework.l10n;
 
+import java.util.Locale;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 final public class SimpleLocalization {
-    public static final String BUNDLE_NAME="lang";
-    private static final LocalizedBundle bundle = new LocalizedBundle(BUNDLE_NAME);
+    public static final String BUNDLE_NAME = "lang";
+    private static LocalizedBundle bundle;
+    private static final Logger LOGGER = LoggerFactory.getLogger(SimpleLocalization.class);
 
     public static String getText(final String label) {
-        return bundle.getString(label);
+        return getDefaultBundle().getString(label);
+    }
+
+    public static LocalizedBundle getDefaultBundle() {
+        if (bundle == null) {
+            setDefault(Locale.getDefault());
+        }
+        return bundle;
     }
 
-    public LocalizedBundle getBundle() {
+    public static LocalizedBundle setDefault(Locale locale) {
+        LOGGER.info("Change default locale to: " + locale);
+        bundle = new LocalizedBundle(BUNDLE_NAME, locale);
         return bundle;
     }
 }

docs/src/docs/modules/localization.adoc

@@ -60,22 +60,39 @@ import eu.tsystems.mms.tic.testframework.l10n.SimpleLocalization;
 GuiElement loginBtn = new GuiElement(By.linkText(SimpleLocalization.getText("BTN_LOGIN")));
 ----
 
-But you can use your own localized bundles.
+`SimpleLocalization` uses `Locale.getDefault()` by default, but
+you can switch the default locale the following way.
+[source, java]
+----
+LocalizedBundle defaultBundle = SimpleLocalization.setDefault(Locale.GERMAN);
+----
+
+== Session based localization
+
+For thread-safe localization, you can use session based localization by initializing your localized bundles based on the session's locale.
 
 [source, java]
 ----
-import eu.tsystems.mms.tic.testframework.l10n.LocalizedBundle;
+Locale sessionLocale = WebDriverManager.getSessionLocale(WebDriver).orElse(Locale.getDefault());
 
-LocalizedBundle bundle = new LocalizedBundle("testdata");
-bundle.getString("TEST_KEY");
+LocalizedBundle sessionBundle = new LocalizedBundle("testdata", sessionLocale);
+sessionBundle.getString("TEST_KEY");
 ----
 
-Or bundles with a fixed locale.
+When the SUT locale changes, you should also set the session's locale:
 
 [source, java]
 ----
-LocalizedBundle germanBundle = new LocalizedBundle("testdata", Locale.GERMAN);
-germanBundle.getString("TEST_KEY");
+public class LocalizedPage extends Page {
+
+    public void switchLocale(Locale locale) {
+        // Implement your language switch here
+        // ...
+
+        // Don't forget to set the sessions locale
+        WebDriverManager.setSessionLocale(getWebDriver(), locale);
+    }
+}
 ----
 
 == Change runtime locale

driver-ui/src/main/java/eu/tsystems/mms/tic/testframework/webdrivermanager/WebDriverManager.java

@@ -25,11 +25,14 @@
 import eu.tsystems.mms.tic.testframework.internal.Flags;
 import eu.tsystems.mms.tic.testframework.internal.utils.DriverStorage;
 import eu.tsystems.mms.tic.testframework.pageobjects.POConfig;
+import eu.tsystems.mms.tic.testframework.report.model.context.SessionContext;
 import eu.tsystems.mms.tic.testframework.report.utils.ExecutionContextUtils;
 import eu.tsystems.mms.tic.testframework.useragents.UserAgentConfig;
 import eu.tsystems.mms.tic.testframework.utils.UITestUtils;
 import java.util.HashMap;
+import java.util.Locale;
 import java.util.Map;
+import java.util.Optional;
 import java.util.stream.Stream;
 import org.openqa.selenium.JavascriptExecutor;
 import org.openqa.selenium.WebDriver;
@@ -59,6 +62,7 @@ public final class WebDriverManager {
     private static WebDriverManagerConfig webdriverManagerConfig;
 
     private static final HashMap<String, UserAgentConfig> userAgentConfigurators = new HashMap<>();
+    private static final String SESSION_LOCALE = "locale";
 
     /**
      * Private constructor to hide the public one since this a static only class.
@@ -365,4 +369,28 @@ public static void setUserAgentConfig(String browser, UserAgentConfig configurat
     static UserAgentConfig getUserAgentConfig(String browser) {
         return userAgentConfigurators.get(browser);
     }
+
+    /**
+     * Sets the locale for a specified session
+     * @param webDriver
+     * @param locale
+     * @return TRUE if locale has been set
+     */
+    public static boolean setSessionLocale(WebDriver webDriver, Locale locale) {
+        Optional<Map<String, Object>> optionalMetaData = WebDriverSessionsManager.getSessionContext(webDriver).map(SessionContext::getMetaData);
+        optionalMetaData.ifPresent(map -> {
+            map.put(SESSION_LOCALE, locale);
+        });
+        return optionalMetaData.isPresent();
+    }
+
+    /**
+     * Returns the session locale
+     * @param webDriver
+     */
+    public static Optional<Locale> getSessionLocale(WebDriver webDriver) {
+        return WebDriverSessionsManager.getSessionContext(webDriver)
+                .map(SessionContext::getMetaData)
+                .map(map -> (Locale)map.get(SESSION_LOCALE));
+    }
 }

integration-tests/src/test/java/eu/tsystems/mms/tic/testframework/test/l10n/LocalizationTest.java

@@ -33,13 +33,13 @@ public class LocalizationTest extends AbstractWebDriverTest {
 
     @Test(dataProvider = "locales")
     public void test_readUtf8FromResourceBundle(String locale, String expected) {
-        Locale.setDefault(Locale.forLanguageTag(locale));
-        Assert.assertEquals(SimpleLocalization.getText("TEST"), expected);
+        LocalizedBundle defaultBundle = SimpleLocalization.setDefault(Locale.forLanguageTag(locale));
+        Assert.assertEquals(defaultBundle.getString("TEST"), expected);
     }
 
     @Test
     public void test_inexistentLocalizedProperty() {
-        Assert.assertEquals("NOT_EXISTENT", SimpleLocalization.getText("NOT_EXISTENT"));
+        Assert.assertEquals(SimpleLocalization.getText("NOT_EXISTENT"), "NOT_EXISTENT");
     }
 
     @DataProvider
@@ -52,12 +52,11 @@ public Object[][] locales() {
 
     @Test
     public void test_fixedLocale() {
-        Locale.setDefault(Locale.ENGLISH);
+        LocalizedBundle defaultBundle = SimpleLocalization.setDefault(Locale.ENGLISH);
         LocalizedBundle germanBundle = new LocalizedBundle(SimpleLocalization.BUNDLE_NAME, Locale.GERMAN);
-        LocalizedBundle defaultBundle = new LocalizedBundle(SimpleLocalization.BUNDLE_NAME);
         Assert.assertNotEquals(germanBundle.getString("TEST"), defaultBundle.getString("TEST"));
 
-        Locale.setDefault(Locale.GERMAN);
+        defaultBundle = SimpleLocalization.setDefault(Locale.GERMAN);
         Assert.assertEquals(germanBundle.getString("TEST"), defaultBundle.getString("TEST"));
     }
 

integration-tests/src/test/java/eu/tsystems/mms/tic/testframework/test/webdrivermanager/WebDriverManagerTest.java

@@ -31,6 +31,7 @@
 import eu.tsystems.mms.tic.testframework.webdrivermanager.WebDriverManager;
 import eu.tsystems.mms.tic.testframework.webdrivermanager.WebDriverManagerConfig;
 import eu.tsystems.mms.tic.testframework.webdrivermanager.WebDriverSessionsManager;
+import java.util.Locale;
 import org.openqa.selenium.Dimension;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.chrome.ChromeDriver;
@@ -227,4 +228,17 @@ public void test_acceptInsecureCertificates() {
 
         Assert.assertTrue(request.getDesiredCapabilities().acceptInsecureCerts());
     }
+
+    @Test
+    public void test_SessionLocale() {
+        Locale defaultLocale = Locale.getDefault();
+        Locale sessionLocale = Locale.KOREAN;
+
+        Assert.assertNotEquals(defaultLocale, sessionLocale);
+
+        WebDriver webDriver = WebDriverManager.getWebDriver();
+        Assert.assertTrue(WebDriverManager.setSessionLocale(webDriver, sessionLocale));
+
+        Assert.assertEquals(WebDriverManager.getSessionLocale(webDriver).orElse(null), sessionLocale);
+    }
 }

integration-tests/src/test/resources/Integration.xml

@@ -9,7 +9,6 @@
         </groups>
         <packages>
             <package name="eu.tsystems.mms.tic.testframework.test.common"/>
-            <package name="eu.tsystems.mms.tic.testframework.test.l10n"/>
             <package name="eu.tsystems.mms.tic.testframework.test.reporting"/>
             <package name="eu.tsystems.mms.tic.testframework.test.testdata"/>
         </packages>
@@ -30,6 +29,7 @@
         <suite-file path="GuiElementStandard.xml"></suite-file>
         <suite-file path="GuiElementVariations.xml"></suite-file>
         <suite-file path="PageObjects.xml"></suite-file>
+        <suite-file path="Localization.xml"></suite-file>
     </suite-files>
 
     <test name="Events" parallel="false">

integration-tests/src/test/resources/Localization.xml

@@ -0,0 +1,14 @@
+<!DOCTYPE suite SYSTEM "https://testng.org/testng-1.0.dtd" >
+<suite name="Localization " verbose="10" configfailurepolicy="continue" thread-count="10" parallel="false">
+
+    <test name="Core" parallel="methods">
+        <groups>
+            <run>
+                <exclude name="SEQUENTIAL"/>
+            </run>
+        </groups>
+        <packages>
+            <package name="eu.tsystems.mms.tic.testframework.test.l10n"/>
+        </packages>
+    </test>
+</suite>