test: add E2E tests for supported i18n translation file formats

Author: clydin

tests/legacy-cli/e2e/tests/i18n/ivy-localize-dl-xliff1.ts

@@ -0,0 +1,10 @@
+import { executeTest } from './ivy-localize-dl-xliff2';
+import { setupI18nConfig } from './legacy';
+
+export default async function() {
+  // Setup i18n tests and config.
+  await setupI18nConfig(true, 'xlf');
+
+  // Execute the tests
+  await executeTest();
+}

tests/legacy-cli/e2e/tests/i18n/ivy-localize-dl.ts renamed to tests/legacy-cli/e2e/tests/i18n/ivy-localize-dl-xliff2.ts

@@ -6,8 +6,13 @@ import { baseDir, externalServer, langTranslations, setupI18nConfig } from './le
 
 export default async function() {
   // Setup i18n tests and config.
-  await setupI18nConfig();
+  await setupI18nConfig(true, 'xlf2');
 
+  // Execute the tests
+  await executeTest();
+}
+
+export async function executeTest() {
   // Ensure a DL build is used.
   await updateJsonFile('tsconfig.json', config => {
     config.compilerOptions.target = 'es2015';
@@ -45,7 +50,9 @@ export default async function() {
   // Verify deprecated locale data registration is not present
   await ng('build', '--configuration=fr', '--optimization=false');
   await expectToFail(() => expectFileToMatch(`${baseDir}/fr/main-es5.js`, 'registerLocaleData('));
-  await expectToFail(() => expectFileToMatch(`${baseDir}/fr/main-es2015.js`, 'registerLocaleData('));
+  await expectToFail(() =>
+    expectFileToMatch(`${baseDir}/fr/main-es2015.js`, 'registerLocaleData('),
+  );
 
   // Verify missing translation behaviour.
   await appendToFile('src/app/app.component.html', '<p i18n>Other content</p>');

tests/legacy-cli/e2e/tests/i18n/ivy-localize-dl-xmb.ts

@@ -0,0 +1,10 @@
+import { executeTest } from './ivy-localize-dl-xliff2';
+import { setupI18nConfig } from './legacy';
+
+export default async function() {
+  // Setup i18n tests and config.
+  await setupI18nConfig(true, 'xmb');
+
+  // Execute the tests
+  await executeTest();
+}

tests/legacy-cli/e2e/tests/i18n/legacy.ts

@@ -28,7 +28,6 @@ export const langTranslations = [
       date: 'janvier',
     },
     translationReplacements: [
-      [/source/g, 'target'],
       ['Hello', 'Bonjour'],
       ['Updated', 'Mis à jour'],
       ['just now', 'juste maintenant'],
@@ -46,7 +45,6 @@ export const langTranslations = [
       date: 'Januar',
     },
     translationReplacements: [
-      [/source/g, 'target'],
       ['Hello', 'Hallo'],
       ['Updated', 'Aktualisiert'],
       ['just now', 'gerade jetzt'],
@@ -66,7 +64,33 @@ export const externalServer = (outputPath: string) => {
   return app.listen(4200, 'localhost');
 };
 
-export async function setupI18nConfig(useLocalize = true) {
+export const formats = {
+  'xlf': {
+    ext: 'xlf',
+    sourceCheck: 'source-language="en-US"',
+    replacements: [
+      [/source/g, 'target'],
+    ],
+  },
+  'xlf2': {
+    ext: 'xlf',
+    sourceCheck: 'srcLang="en-US"',
+    replacements: [
+      [/source/g, 'target'],
+    ],
+  },
+  'xmb': {
+    ext: 'xmb',
+    sourceCheck: '<!DOCTYPE messagebundle',
+    replacements: [
+      [/messagebundle/g, 'translationbundle'],
+      [/msg/g, 'translation'],
+      [/<source>.*?<\/source>/g, ''],
+    ],
+  },
+};
+
+export async function setupI18nConfig(useLocalize = true, format: keyof typeof formats = 'xlf') {
   // Add component with i18n content, both translations and localeData (plural, dates).
   await writeFile('src/app/app.component.ts', `
     import { Component, Inject, LOCALE_ID } from '@angular/core';
@@ -161,16 +185,16 @@ export async function setupI18nConfig(useLocalize = true) {
         } else {
           buildConfigs[lang] = {
             outputPath,
-            i18nFile: `src/locale/messages.${lang}.xlf`,
-            i18nFormat: `xlf`,
+            i18nFile: `src/locale/messages.${lang}.${formats[format].ext}`,
+            i18nFormat: format,
             i18nLocale: lang,
           };
         }
       } else {
         if (lang == sourceLocale) {
           i18n.sourceLocale = lang;
         } else {
-          i18n.locales[lang] = `src/locale/messages.${lang}.xlf`;
+          i18n.locales[lang] = `src/locale/messages.${lang}.${formats[format].ext}`;
         }
         buildConfigs[lang] = { localize: [lang] };
       }
@@ -184,17 +208,29 @@ export async function setupI18nConfig(useLocalize = true) {
   });
 
   // Extract the translation messages.
-  await ng('xi18n', '--output-path=src/locale');
-  await expectFileToExist('src/locale/messages.xlf');
-  await expectFileToMatch('src/locale/messages.xlf', `source-language="en-US"`);
-  await expectFileToMatch('src/locale/messages.xlf', `An introduction header for this sample`);
+  await ng('xi18n', '--output-path=src/locale', `--format=${format}`);
+  const translationFile = `src/locale/messages.${formats[format].ext}`;
+  await expectFileToExist(translationFile);
+  await expectFileToMatch(translationFile, formats[format].sourceCheck);
+  await expectFileToMatch(translationFile, `An introduction header for this sample`);
 
   // Make translations for each language.
   for (const { lang, translationReplacements } of langTranslations) {
     if (lang != sourceLocale) {
-      await copyFile('src/locale/messages.xlf', `src/locale/messages.${lang}.xlf`);
+      await copyFile(translationFile, `src/locale/messages.${lang}.${formats[format].ext}`);
       for (const replacements of translationReplacements) {
-        await replaceInFile(`src/locale/messages.${lang}.xlf`, replacements[0], replacements[1] as string);
+        await replaceInFile(
+          `src/locale/messages.${lang}.${formats[format].ext}`,
+          replacements[0],
+          replacements[1] as string,
+        );
+      }
+      for (const replacement of formats[format].replacements) {
+        await replaceInFile(
+          `src/locale/messages.${lang}.${formats[format].ext}`,
+          replacement[0],
+          replacement[1] as string,
+        );
       }
     }
   }