(test) O3-4968: Adding e2e tests for TranslationBuilder component

e2e/pages/form-builder-page.ts

@@ -71,6 +71,30 @@ export class FormBuilderPage {
   readonly questionIdInput = () => this.page.getByRole('textbox', { name: /question id/i });
   readonly questionCreatedMessage = () => this.page.getByText(/new question created/i);
 
+  readonly translationBuilderTab = () => this.page.getByRole('tab', { name: /translation builder/i });
+  readonly translationBuilderPanel = () =>
+    this.page
+      .getByRole('tabpanel')
+      .filter({ has: this.page.getByRole('button', { name: /upload translation/i }) })
+      .first();
+  readonly languageDropdown = () => this.translationBuilderPanel().locator('#target-language');
+  readonly downloadTranslationButton = () =>
+    this.translationBuilderPanel().getByRole('button', { name: /download translation/i });
+  readonly uploadTranslationButton = () =>
+    this.translationBuilderPanel().getByRole('button', { name: /upload translation/i });
+  readonly translationSearchInput = () => this.page.getByPlaceholder(/search translation keys/i);
+  readonly translationTabsList = () =>
+    this.translationBuilderPanel().getByRole('tablist', { name: 'Translation filter' });
+  readonly allTranslationsTab = () => this.translationTabsList().getByRole('tab', { name: 'All', exact: true });
+  readonly translatedTab = () => this.translationTabsList().getByRole('tab', { name: 'Translated', exact: true });
+  readonly untranslatedTab = () => this.translationTabsList().getByRole('tab', { name: 'Untranslated', exact: true });
+  readonly editTranslationButton = (index: number = 0) =>
+    this.page.locator('[data-testid="edit-translation-button"]').nth(index);
+  readonly translationModal = () => this.page.getByRole('dialog');
+  translationValueInput() {
+    return this.page.getByTestId('translation-value-input');
+  }
+  readonly saveTranslationButton = () => this.translationModal().getByRole('button', { name: 'Save' });
   async gotoFormBuilder() {
     await this.page.goto('form-builder');
   }

e2e/specs/translation-builder-workflows.spec.ts

@@ -0,0 +1,150 @@
+/* eslint-disable testing-library/prefer-screen-queries */
+
+import { test } from '../core';
+import { expect } from '@playwright/test';
+import { deleteForm, createForm, createValueReference, addFormResources } from '../commands/form-operations';
+import { FormBuilderPage } from '../pages';
+
+let formUuid = '';
+
+const formDetails = {
+  name: 'Covid-19 Screening',
+  description: 'A test form for recording COVID-19 screening information',
+  version: '1.0',
+  published: true,
+};
+test.beforeEach(async ({ api }) => {
+  const form = await createForm(api, false, formDetails);
+  formUuid = form.uuid;
+
+  const valueReference = await createValueReference(api);
+  await addFormResources(api, valueReference, formUuid);
+});
+
+test('Manage translations: switch languages, filter, and search', async ({ page }) => {
+  const formBuilderPage = new FormBuilderPage(page);
+
+  await test.step('When I open a form in the translation builder', async () => {
+    await formBuilderPage.gotoFormBuilder();
+    await formBuilderPage.searchForForm(formDetails.name);
+    await formBuilderPage.page.getByRole('row', { name: formDetails.name }).getByLabel('Edit Schema').first().click();
+  });
+
+  await test.step('And then I go to the translation builder', async () => {
+    await formBuilderPage.translationBuilderTab().click();
+  });
+
+  await test.step('And I switch between languages', async () => {
+    await formBuilderPage.languageDropdown().click();
+    const dropdownMenu = formBuilderPage.translationBuilderPanel().locator('.cds--list-box__menu');
+    await expect(dropdownMenu).toBeVisible();
+    await expect(dropdownMenu.getByRole('option', { name: 'English (en)' })).toBeVisible();
+  });
+
+  await test.step('And I filter translations using tabs', async () => {
+    await formBuilderPage.allTranslationsTab().click();
+    await expect(formBuilderPage.allTranslationsTab()).toHaveAttribute('aria-selected', 'true');
+
+    await formBuilderPage.translatedTab().click();
+    await expect(page.locator('[data-status="translated"]')).toHaveCount(0);
+
+    await formBuilderPage.untranslatedTab().click();
+    await expect(formBuilderPage.untranslatedTab()).toHaveAttribute('aria-selected', 'true');
+    await expect(page.locator('[data-status="untranslated"]').first()).toBeVisible();
+  });
+
+  await test.step('And I search for a translation string', async () => {
+    const searchInput = formBuilderPage.translationSearchInput();
+    await searchInput.fill('Visit Details');
+    await expect(searchInput).toHaveValue('Visit Details');
+
+    const results = page.locator('[data-testid="translation-entry"]');
+    await expect(results).not.toHaveCount(0);
+    await expect(results.first()).toBeVisible();
+  });
+});
+
+test('Edit and update an individual translation', async ({ page }) => {
+  const formBuilderPage = new FormBuilderPage(page);
+
+  await test.step('When I open a form in the Translation Builder', async () => {
+    await formBuilderPage.gotoFormBuilder();
+    await formBuilderPage.searchForForm(formDetails.name);
+    await formBuilderPage.page.getByRole('row', { name: formDetails.name }).getByLabel('Edit Schema').first().click();
+  });
+
+  await test.step('And then I go to the translation builder', async () => {
+    await formBuilderPage.translationBuilderTab().click();
+  });
+
+  await test.step('And then I select the French language', async () => {
+    await formBuilderPage.languageDropdown().click();
+    const dropdownMenu = formBuilderPage.translationBuilderPanel().locator('.cds--list-box__menu');
+    await expect(dropdownMenu).toBeVisible();
+    await dropdownMenu.getByRole('option', { name: 'French (fr)' }).click();
+  });
+
+  await test.step('And then I edit a translation string and save it', async () => {
+    await formBuilderPage.editTranslationButton(0).click();
+    const translationInput = formBuilderPage.translationValueInput();
+    await translationInput.fill('Test Translation Updated');
+  });
+  await test.step('And then when I preview the form in the language, I should see the edited translation strings', async () => {
+    await formBuilderPage.saveTranslationButton().click();
+    await expect(formBuilderPage.translationModal()).toBeHidden();
+    await expect(formBuilderPage.editTranslationButton(0)).toBeEnabled();
+  });
+});
+test('Download a translation file from a form', async ({ page }) => {
+  const formBuilderPage = new FormBuilderPage(page);
+
+  await test.step('When I open a form in the translation Builder', async () => {
+    await formBuilderPage.gotoFormBuilder();
+    await formBuilderPage.searchForForm(formDetails.name);
+    await formBuilderPage.page.getByRole('row', { name: formDetails.name }).getByLabel('Edit Schema').first().click();
+  });
+
+  await test.step('And then I go to the translation builder', async () => {
+    await formBuilderPage.translationBuilderTab().click();
+  });
+
+  await test.step('And I download the translation file', async () => {
+    const downloadButton = formBuilderPage.downloadTranslationButton();
+    const [download] = await Promise.all([
+      formBuilderPage.page.waitForEvent('download', { timeout: 15000 }),
+      downloadButton.click(),
+    ]);
+    expect(download.suggestedFilename()).toMatch(/\.json$/);
+  });
+});
+
+test('Upload a translation file to backend', async ({ page }) => {
+  const formBuilderPage = new FormBuilderPage(page);
+
+  await test.step('When I open a form in the translation builder', async () => {
+    await formBuilderPage.gotoFormBuilder();
+    await formBuilderPage.searchForForm(formDetails.name);
+    await formBuilderPage.page.getByRole('row', { name: formDetails.name }).getByLabel('Edit Schema').first().click();
+  });
+
+  await test.step('And then I go to the translation builder', async () => {
+    await formBuilderPage.translationBuilderTab().click();
+  });
+
+  await test.step('And I upload a translation file', async () => {
+    const uploadButton = formBuilderPage.uploadTranslationButton();
+    await expect(uploadButton).toBeEnabled();
+    await expect(uploadButton).toBeVisible();
+    await expect(formBuilderPage.translationBuilderPanel()).toBeVisible();
+
+    await uploadButton.click();
+    await expect(formBuilderPage.page.getByText(/Translations Uploaded./i)).toBeVisible();
+    await expect(formBuilderPage.page.getByText(/Translation file uploaded successfully/i)).toBeVisible();
+  });
+});
+
+test.afterEach(async ({ api }) => {
+  if (formUuid) {
+    await deleteForm(api, formUuid);
+  }
+});

src/components/translation-builder/edit-translation.modal.tsx

@@ -25,6 +25,7 @@ const EditTranslationModal: React.FC<EditTranslationModalProps> = ({ onClose, or
           labelText={t('translationValue', 'Translated Value')}
           value={newValue}
           onChange={(e) => setNewValue(e.target.value)}
+          data-testid="translation-value-input"
         />
       </ModalBody>
       <ModalFooter>

src/components/translation-builder/translation-builder.component.tsx

@@ -223,21 +223,22 @@ const TranslationBuilder: React.FC<TranslationBuilderProps> = ({ formSchema, onU
               onChange={({ selectedItem }) => selectedItem && languageChanger(selectedItem.code)}
             />
           </div>
-
-          <div className={styles.translationActions}>
-            <button className={styles.linkButton} onClick={handleDownloadTranslation}>
-              {t('downloadTranslation', 'Download translation')}
-              <Download size={16} />
-            </button>
-            <button
-              className={styles.linkButton}
-              onClick={handleUploadTranslationFromSchema}
-              disabled={translationsUploading}
-            >
-              {t('uploadTranslation', 'Upload translation')}
-              {!translationsUploading ? <Upload size={16} /> : <InlineLoading />}
-            </button>
-          </div>
+          {formSchema ? (
+            <div className={styles.translationActions}>
+              <button className={styles.linkButton} onClick={handleDownloadTranslation}>
+                {t('downloadTranslation', 'Download translation')}
+                <Download size={16} />
+              </button>
+              <button
+                className={styles.linkButton}
+                onClick={handleUploadTranslationFromSchema}
+                disabled={translationsUploading}
+              >
+                {t('uploadTranslation', 'Upload translation')}
+                {!translationsUploading ? <Upload size={16} /> : <InlineLoading />}
+              </button>
+            </div>
+          ) : null}
         </div>
 
         <div className={styles.translationTabs}>
@@ -287,16 +288,26 @@ const TranslationBuilder: React.FC<TranslationBuilderProps> = ({ formSchema, onU
           <div className={styles.translationEditor}>
             {filteredTranslations.length > 0 ? (
               filteredTranslations.map(([key, value]) => (
-                <div key={key} className={styles.translationRow}>
-                  <div className={styles.translationKey}>{key}</div>
-                  <div className={styles.translatedKey}>{value}</div>
+                <div
+                  key={key}
+                  className={styles.translationRow}
+                  data-testid="translation-entry"
+                  data-status="untranslated"
+                >
+                  <div className={styles.translationKey} data-testid="translation-key">
+                    {key}
+                  </div>
+                  <div className={styles.translatedKey} data-testid="translation-value">
+                    {value}
+                  </div>
                   <div className={styles.inlineControls}>
                     <IconButton
                       kind="ghost"
                       label={t('editString', 'Edit string')}
                       onClick={() => handleEditClick(key)}
                       size="md"
                       className={styles.deleteButton}
+                      data-testid="edit-translation-button"
                     >
                       <Edit />
                     </IconButton>