test: add translation tests (#457)

Author: mcollovati

vaadin-cdi-itest/src/main/java/com/vaadin/cdi/itest/i18n/TranslationView.java

@@ -0,0 +1,96 @@
+/*
+ * Copyright 2000-2024 Vaadin Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+package com.vaadin.cdi.itest.i18n;
+
+import java.util.Locale;
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+
+import com.vaadin.flow.component.AttachEvent;
+import com.vaadin.flow.component.UI;
+import com.vaadin.flow.component.html.Div;
+import com.vaadin.flow.component.html.Span;
+import com.vaadin.flow.i18n.I18NProvider;
+import com.vaadin.flow.internal.LocaleUtil;
+import com.vaadin.flow.router.Route;
+
+@Route(value = "translations")
+public class TranslationView extends Div {
+
+    public static final String TEST_VIEW_ID = "TranslationView";
+    public static final String LOCALES_ID = "available-locales";
+
+    private Span dynamic;
+
+    public TranslationView() {
+        setId(TEST_VIEW_ID);
+
+        Span defaultLang = new Span(getTranslation(Locale.ENGLISH, "label"));
+        defaultLang.setId("english");
+        Span german = new Span(getTranslation(Locale.GERMAN, "label"));
+        german.setId("german");
+        Span germany = new Span(getTranslation(Locale.GERMANY, "label"));
+        germany.setId("germany");
+        Span finnish = new Span(
+                getTranslation(new Locale("fi", "FI"), "label"));
+        finnish.setId("finnish");
+        Span french = new Span(getTranslation(Locale.FRANCE, "label"));
+        french.setId("french");
+        Span japanese = new Span(getTranslation(Locale.JAPAN, "label"));
+        japanese.setId("japanese");
+
+        Optional<I18NProvider> i18NProvider = LocaleUtil.getI18NProvider();
+        if (i18NProvider.isPresent()) {
+            add(new Span("Available translation locales:"));
+            StringBuilder locales = new StringBuilder();
+            for (Locale locale : i18NProvider.get().getProvidedLocales()) {
+                if (locales.length() > 0) {
+                    locales.append(", ");
+                }
+                locales.append(locale.toString());
+            }
+            Span localeSpan = new Span(locales.toString());
+            localeSpan.setId(LOCALES_ID);
+            add(localeSpan, new Div());
+        }
+        dynamic = new Span("waiting");
+        dynamic.setId("dynamic");
+
+        add(defaultLang, new Div(), german, new Div(), germany, new Div(),
+                finnish, new Div(), french, new Div(), japanese, new Div(),
+                dynamic);
+    }
+
+    @Override
+    protected void onAttach(AttachEvent event) {
+        UI ui = event.getUI();
+        ui.setPollInterval(100);
+        CompletableFuture.runAsync(() -> {
+            try {
+                Thread.sleep(50);
+            } catch (Exception e) {
+                e.printStackTrace();
+            } finally {
+                ui.access(() -> {
+                    dynamic.setText(getTranslation(Locale.FRANCE, "label"));
+                    ui.setPollInterval(-1);
+                });
+
+            }
+        });
+
+    }
+}

vaadin-cdi-itest/src/main/resources/vaadin-i18n/translations.properties

@@ -0,0 +1 @@
+label=Default

vaadin-cdi-itest/src/main/resources/vaadin-i18n/translations_de.properties

@@ -0,0 +1 @@
+label=Deutsch

vaadin-cdi-itest/src/main/resources/vaadin-i18n/translations_fi_FI.properties

@@ -0,0 +1 @@
+label=Suomi

vaadin-cdi-itest/src/main/resources/vaadin-i18n/translations_fr_FR.properties

@@ -0,0 +1 @@
+label=français

vaadin-cdi-itest/src/main/resources/vaadin-i18n/translations_ja_JP.properties

@@ -0,0 +1 @@
+label=日本語

vaadin-cdi-itest/src/test/java/com/vaadin/cdi/itest/TranslationTest.java

@@ -0,0 +1,80 @@
+/*
+ * Copyright 2000-2024 Vaadin Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package com.vaadin.cdi.itest;
+
+import java.io.File;
+
+import com.vaadin.cdi.itest.i18n.TranslationView;
+import org.jboss.arquillian.container.test.api.Deployment;
+import org.jboss.shrinkwrap.api.spec.WebArchive;
+import org.junit.Assert;
+import org.junit.Test;
+
+
+public class TranslationTest extends AbstractCdiTest {
+
+    @Deployment(testable = false)
+    public static WebArchive createCdiServletEnabledDeployment() {
+        return ArchiveProvider.createWebArchive("translations",
+                        TranslationView.class)
+                .addAsResource(new File("src/main/resources/vaadin-i18n"));
+
+    }
+
+    @Override
+    protected String getTestPath() {
+        return "/translations";
+    }
+
+
+    @Test
+    public void translationFilesExist_defaultI18NInstantiated_languagesWork() {
+        open();
+
+        String locales = $("span").id(TranslationView.LOCALES_ID)
+                .getText();
+        Assert.assertTrue("Couldn't verify German locale", locales.contains("de"));
+        Assert.assertTrue("Couldn't verify Finnish locale", locales.contains("fi_FI"));
+        Assert.assertTrue("Couldn't verify French locale", locales.contains("fr_FR"));
+        Assert.assertTrue("Couldn't verify Japanese locale", locales.contains("ja_JP"));
+
+        Assert.assertEquals("Default",
+                $("span").id("english").getText());
+        Assert.assertEquals("Deutsch",
+                $("span").id("german").getText());
+        Assert.assertEquals("Deutsch",
+                $("span").id("germany").getText());
+        Assert.assertEquals("Suomi",
+                $("span").id("finnish").getText());
+        Assert.assertEquals("français",
+                $("span").id("french").getText());
+        Assert.assertEquals("日本語",
+                $("span").id("japanese").getText());
+    }
+
+    @Test
+    public void translationFilesExist_defaultI18NInstantiated_updateFromExternalThreadWorks() {
+        open();
+
+        waitUntilNot(driver -> $("span").id("dynamic").getText()
+                .equals("waiting"));
+
+        Assert.assertEquals("Dynamic update from thread should have used correct bundle.",
+                "français",
+                $("span").id("dynamic").getText());
+    }
+}