[ACS-8063] Migrate editActions e2e from Protractor to Playwright (#3900)

* ACS-8063 Migrate editActions

* Removed protractor edit folder tests and protractor e2e run from github

.github/workflows/pull-request.yml

@@ -86,47 +86,6 @@ jobs:
       - run: npm ci
       - run: npm run affected:test -- --browsers=ChromeHeadless --watch=false $TEST_OPTS --base=origin/develop
 
-  e2es:
-    needs: [lint, build, unit-tests]
-    name: 'E2E Protractor - ${{ matrix.e2e-suites.name }}'
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        e2e-suites:
-          - name: "editActions"
-            id: 1
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 2
-
-      - name: node
-        uses: actions/setup-node@v3
-        with:
-          node-version-file: '.nvmrc'
-          cache: 'npm'
-      - uses: ./.github/actions/before-install
-      - run: npm ci
-
-      - uses: actions/cache/restore@v3
-        id: cache
-        with:
-          path: ./dist/content-ce
-          key: cache-dist-${{ github.run_id }}
-
-      - name: Before e2e
-        uses: ./.github/actions/before-e2e
-        with:
-          e2e-protractor: true
-
-      - uses: ./.github/actions/run-e2e
-        with:
-          options: "--suite=${{ matrix.e2e-suites.name }}"
-          artifact-name: ${{ matrix.e2e-suites.name }}
-      - uses: ./.github/actions/after-e2e
-
   e2es-playwright:
     needs: [lint, build, unit-tests]
     name: 'E2E Playwright - ${{ matrix.e2e-suites.name }}'
@@ -167,6 +126,8 @@ jobs:
             id: 15
           - name: "delete-actions"
             id: 16
+          - name: "edit-actions"
+            id: 17
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -205,7 +166,7 @@ jobs:
 
   finalize:
     if: ${{ always() }}
-    needs: [lint, build, unit-tests, e2es, e2es-playwright]
+    needs: [lint, build, unit-tests, e2es-playwright]
     name: 'Finalize'
     runs-on: ubuntu-latest
     steps:

e2e/playwright/edit-actions/.eslintrc.json

@@ -0,0 +1,26 @@
+{
+  "extends": "../../../.eslintrc.json",
+  "ignorePatterns": [
+    "!**/*"
+  ],
+  "overrides": [
+    {
+      "files": [
+        "*.ts"
+      ],
+      "parserOptions": {
+        "project": [
+          "e2e/playwright/edit-actions/tsconfig.e2e.json"
+        ],
+        "createDefaultProgram": true
+      },
+      "plugins": [
+        "rxjs",
+        "unicorn"
+      ],
+      "rules": {
+        "@typescript-eslint/no-floating-promises": "off"
+      }
+    }
+  ]
+}

e2e/playwright/edit-actions/exclude.tests.json

@@ -0,0 +1 @@
+{}

e2e/playwright/edit-actions/playwright.config.ts

@@ -0,0 +1,42 @@
+/*!
+ * Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Alfresco Example Content Application
+ *
+ * This file is part of the Alfresco Example Content Application.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail. Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * The Alfresco Example Content Application is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The Alfresco Example Content Application is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * from Hyland Software. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { PlaywrightTestConfig } from '@playwright/test';
+import { CustomConfig, getGlobalConfig, getExcludedTestsRegExpArray } from '@alfresco/playwright-shared';
+import EXCLUDED_JSON from './exclude.tests.json';
+
+const config: PlaywrightTestConfig<CustomConfig> = {
+  ...getGlobalConfig,
+
+  grepInvert: getExcludedTestsRegExpArray(EXCLUDED_JSON, 'Edit Actions'),
+  projects: [
+    {
+      name: 'Edit Actions',
+      testDir: './src/tests',
+      use: {}
+    }
+  ]
+};
+
+export default config;

e2e/playwright/edit-actions/project.json

@@ -0,0 +1,22 @@
+{
+  "name": "edit-actions-e2e",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "e2e/playwright/edit-actions",
+  "projectType": "application",
+  "targets": {
+    "e2e": {
+      "executor": "nx:run-commands",
+      "options": {
+        "commands": ["npx playwright test --config=e2e/playwright/edit-actions/playwright.config.ts"]
+      },
+      "configurations": {
+        "production": {
+          "devServerTarget": "content-ce:serve:production"
+        }
+      }
+    },
+    "lint": {
+      "executor": "@angular-eslint/builder:lint"
+    }
+  }
+}

e2e/playwright/edit-actions/src/tests/edit-folder.e2e.ts

@@ -0,0 +1,165 @@
+/*!
+ * Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Alfresco Example Content Application
+ *
+ * This file is part of the Alfresco Example Content Application.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail. Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * The Alfresco Example Content Application is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The Alfresco Example Content Application is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * from Hyland Software. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { expect } from '@playwright/test';
+import { ApiClientFactory, NodesApi, Utils, test, TrashcanApi } from '@alfresco/playwright-shared';
+
+test.describe('Edit folder', () => {
+  const apiClientFactory = new ApiClientFactory();
+  let nodesApi: NodesApi;
+  let trashcanApi: TrashcanApi;
+
+  let parentId: string;
+  let folderNameToEditId: string;
+
+  const username = `user-${Utils.random()}`;
+  const parent = `parent-${Utils.random()}`;
+  const folderName = `folder-${Utils.random()}`;
+  const folderDescription = 'my folder description';
+
+  const folderNameToEdit = `folder-${Utils.random()}`;
+  const duplicateFolderName = `folder-${Utils.random()}`;
+
+  const folderNameEdited = `folder-renamed-${Utils.random()}`;
+  const folderDescriptionEdited = 'description edited';
+
+  test.beforeAll(async () => {
+    try {
+      await apiClientFactory.setUpAcaBackend('admin');
+      await apiClientFactory.createUser({ username });
+      nodesApi = await NodesApi.initialize(username, username);
+      trashcanApi = await TrashcanApi.initialize(username, username);
+
+      parentId = (await nodesApi.createFolder(parent)).entry.id;
+      await nodesApi.createFolder(folderName, parentId, '', folderDescription);
+      folderNameToEditId = (await nodesApi.createFolder(folderNameToEdit, parentId)).entry.id;
+      await nodesApi.createFolder(duplicateFolderName, parentId);
+    } catch (error) {
+      console.error(`beforeAll failed : ${error}`);
+    }
+  });
+
+  test.beforeEach(async ({ loginPage, personalFiles }) => {
+    await Utils.tryLoginUser(loginPage, username, username, 'beforeEach failed');
+    await personalFiles.dataTable.performClickFolderOrFileToOpen(parent);
+  });
+
+  test.afterAll(async () => {
+    await Utils.deleteNodesSitesEmptyTrashcan(nodesApi, trashcanApi, 'afterAll failed');
+  });
+
+  test.describe('on Personal Files', () => {
+    test('[XAT-5089] "Edit folder" dialog UI', async ({ personalFiles }) => {
+      await personalFiles.dataTable.selectItem(folderName);
+      await personalFiles.acaHeader.clickMoreActions();
+      await personalFiles.matMenu.clickMenuItemFromHeaderMenu('Edit');
+
+      await expect(personalFiles.editDialog.editDialog).toBeVisible();
+      await expect(personalFiles.editDialog.titleInput).toHaveText('Edit folder');
+      await expect(personalFiles.editDialog.nameInput).toHaveValue(folderName);
+      await expect(personalFiles.editDialog.descriptionInput).toHaveValue(folderDescription);
+      await expect(personalFiles.editDialog.cancelButton).toBeEnabled();
+      await expect(personalFiles.editDialog.updateButton).toBeEnabled();
+    });
+
+    test('[XAT-5093] Properties are modified when clicking Update button', async ({ personalFiles }) => {
+      await personalFiles.dataTable.selectItem(folderNameToEdit);
+      await personalFiles.acaHeader.clickMoreActions();
+      await personalFiles.matMenu.clickMenuItemFromHeaderMenu('Edit');
+      await personalFiles.editDialog.descriptionInput.fill(folderDescriptionEdited);
+      await personalFiles.editDialog.nameInput.fill(folderNameEdited);
+      await personalFiles.editDialog.updateButton.click();
+
+      await expect(personalFiles.editDialog.editDialog).toBeHidden();
+      expect(await personalFiles.dataTable.isItemPresent(folderNameEdited)).toBeTruthy();
+      const description = await nodesApi.getNodeProperty(folderNameToEditId, 'cm:description');
+      expect(description).toEqual(folderDescriptionEdited);
+    });
+
+    test('[XAT-5090] Empty folder name', async ({ personalFiles }) => {
+      await personalFiles.dataTable.selectItem(folderName);
+      await personalFiles.acaHeader.clickMoreActions();
+      await personalFiles.matMenu.clickMenuItemFromHeaderMenu('Edit');
+      await personalFiles.editDialog.nameInput.fill('');
+
+      await expect(personalFiles.editDialog.updateButton).toBeDisabled();
+      await expect(personalFiles.editDialog.fieldHint).toHaveText('Folder name is required');
+    });
+
+    test('[XAT-5091] Folder name with special characters', async ({ personalFiles }) => {
+      const namesWithSpecialChars = ['a*a', 'a"a', 'a<a', 'a>a', `a\\a`, 'a/a', 'a?a', 'a:a', 'a|a'];
+
+      await personalFiles.dataTable.selectItem(folderName);
+      await personalFiles.acaHeader.clickMoreActions();
+      await personalFiles.matMenu.clickMenuItemFromHeaderMenu('Edit');
+
+      for (const name of namesWithSpecialChars) {
+        await personalFiles.editDialog.nameInput.fill(name);
+        await expect(personalFiles.editDialog.updateButton).toBeDisabled();
+        expect(await personalFiles.editDialog.fieldHint.innerText()).toContain(`Folder name can't contain these characters`);
+      }
+    });
+
+    test('[XAT-5092] Folder name ending with a dot', async ({ personalFiles }) => {
+      await personalFiles.dataTable.selectItem(folderName);
+      await personalFiles.acaHeader.clickMoreActions();
+      await personalFiles.matMenu.clickMenuItemFromHeaderMenu('Edit');
+      await personalFiles.editDialog.nameInput.fill(`${folderName}.`);
+
+      await expect(personalFiles.editDialog.updateButton).toBeDisabled();
+      expect(await personalFiles.editDialog.fieldHint.innerText()).toContain(`Folder name can't end with a period`);
+    });
+
+    test('[XAT-5094] Cancel editing properties', async ({ personalFiles }) => {
+      await personalFiles.dataTable.selectItem(folderName);
+      await personalFiles.acaHeader.clickMoreActions();
+      await personalFiles.matMenu.clickMenuItemFromHeaderMenu('Edit');
+      await personalFiles.editDialog.cancelButton.click();
+
+      await expect(personalFiles.editDialog.editDialog).toBeHidden();
+    });
+
+    test('[XAT-5095] Duplicated folder name', async ({ personalFiles }) => {
+      await personalFiles.dataTable.selectItem(folderName);
+      await personalFiles.acaHeader.clickMoreActions();
+      await personalFiles.matMenu.clickMenuItemFromHeaderMenu('Edit');
+      await personalFiles.editDialog.nameInput.fill(duplicateFolderName);
+      await personalFiles.editDialog.updateButton.click();
+
+      await expect(personalFiles.editDialog.editDialog).toBeVisible();
+      expect(await personalFiles.snackBar.getSnackBarMessage()).toEqual(`There's already a folder with this name. Try a different name.`);
+    });
+
+    test('[XAT-5096] Trim ending spaces', async ({ personalFiles }) => {
+      await personalFiles.dataTable.selectItem(folderName);
+      await personalFiles.acaHeader.clickMoreActions();
+      await personalFiles.matMenu.clickMenuItemFromHeaderMenu('Edit');
+      await personalFiles.editDialog.nameInput.fill(`${folderName} `);
+      await personalFiles.editDialog.updateButton.click();
+
+      await expect(personalFiles.editDialog.editDialog).toBeHidden();
+      expect(await personalFiles.dataTable.isItemPresent(folderName)).toBeTruthy();
+    });
+  });
+});

e2e/playwright/edit-actions/src/tests/edit-offline.e2e.ts

@@ -0,0 +1,94 @@
+/*!
+ * Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Alfresco Example Content Application
+ *
+ * This file is part of the Alfresco Example Content Application.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail. Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * The Alfresco Example Content Application is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The Alfresco Example Content Application is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * from Hyland Software. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { expect } from '@playwright/test';
+import { ApiClientFactory, NodesApi, Utils, test, TrashcanApi, FileActionsApi, TEST_FILES } from '@alfresco/playwright-shared';
+
+test.describe('Edit offline - on Personal Files', () => {
+  const apiClientFactory = new ApiClientFactory();
+  let nodesApi: NodesApi;
+  let trashcanApi: TrashcanApi;
+  let fileActionsApi: FileActionsApi;
+
+  let parentPFId: string;
+  let fileLockedId: string;
+  let fileLocked2Id: string;
+
+  const username = `user-${Utils.random()}`;
+
+  const file1 = `file1-${Utils.random()}.docx`;
+  const fileLocked = `file-locked-${Utils.random()}.docx`;
+  const fileLocked2 = `file-locked2-${Utils.random()}.docx`;
+  const parentPF = `parentPersonal-${Utils.random()}`;
+
+  test.beforeAll(async () => {
+    try {
+      await apiClientFactory.setUpAcaBackend('admin');
+      await apiClientFactory.createUser({ username });
+      nodesApi = await NodesApi.initialize(username, username);
+      trashcanApi = await TrashcanApi.initialize(username, username);
+      fileActionsApi = await FileActionsApi.initialize(username, username);
+
+      parentPFId = (await nodesApi.createFolder(parentPF)).entry.id;
+      fileLockedId = (await fileActionsApi.uploadFileWithRename(TEST_FILES.DOCX.path, fileLocked, parentPFId)).entry.id;
+      fileLocked2Id = (await fileActionsApi.uploadFileWithRename(TEST_FILES.DOCX.path, fileLocked2, parentPFId)).entry.id;
+      await fileActionsApi.uploadFileWithRename(TEST_FILES.DOCX.path, file1, parentPFId);
+
+      await nodesApi.lockNodes([fileLockedId, fileLocked2Id]);
+    } catch (error) {
+      console.error(`beforeAll failed : ${error}`);
+    }
+  });
+
+  test.beforeEach(async ({ loginPage, personalFiles }) => {
+    await Utils.tryLoginUser(loginPage, username, username, 'beforeEach failed');
+    await personalFiles.dataTable.performClickFolderOrFileToOpen(parentPF);
+  });
+
+  test.afterAll(async () => {
+    await Utils.deleteNodesSitesEmptyTrashcan(nodesApi, trashcanApi, 'afterAll failed');
+  });
+
+  test('[XAT-5304] File is locked and downloaded when clicking Edit offline', async ({ personalFiles }) => {
+    await personalFiles.dataTable.selectItem(file1);
+    await personalFiles.acaHeader.clickMoreActions();
+    await personalFiles.matMenu.clickMenuItem('Edit Offline');
+    const [download] = await Promise.all([personalFiles.page.waitForEvent('download')]);
+    expect(download.suggestedFilename()).toBe(file1);
+  });
+
+  test('XAT-5305] Lock information is displayed', async ({ personalFiles }) => {
+    expect(await personalFiles.dataTable.isItemPresent(fileLocked2)).toBe(true);
+    expect(await personalFiles.dataTable.getLockOwner(fileLocked2)).toContain(username);
+  });
+
+  test('[XAT-5306] Cancel Editing unlocks the file', async ({ personalFiles }) => {
+    await personalFiles.dataTable.selectItem(fileLocked);
+    await personalFiles.acaHeader.clickMoreActions();
+    await personalFiles.matMenu.clickMenuItemFromHeaderMenu('Cancel Editing');
+    await personalFiles.dataTable.selectItem(fileLocked);
+
+    expect(await nodesApi.isFileLockedWrite(fileLockedId), `${fileLocked} is still locked`).not.toEqual('WRITE_LOCK');
+  });
+});

e2e/playwright/edit-actions/tsconfig.e2e.adf.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../../../tsconfig.adf.json",
+  "compilerOptions": {
+    "outDir": "../../out-tsc/e2e",
+    "baseUrl": "./",
+    "module": "commonjs",
+    "target": "es2017",
+    "types": ["jasmine", "jasminewd2", "node"],
+    "skipLibCheck": true,
+    "paths": {
+      "@alfresco/playwright-shared": ["../../../projects/aca-playwright-shared/src/index.ts"]
+    }
+  },
+  "exclude": ["node_modules"]
+}

e2e/playwright/edit-actions/tsconfig.e2e.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../out-tsc/e2e",
+    "baseUrl": "./",
+    "module": "commonjs",
+    "target": "es2017",
+    "types": ["jasmine", "jasminewd2", "node", "@playwright/test"],
+    "skipLibCheck": true,
+    "paths": {
+      "@alfresco/playwright-shared": ["../../../projects/aca-playwright-shared/src/index.ts"]
+    }
+  },
+  "exclude": ["node_modules"]
+}

e2e/playwright/viewer/src/tests/viewer-action.e2e.ts

@@ -188,6 +188,7 @@ test.describe('viewer action file', () => {
     await personalFiles.uploadNewVersionDialog.majorOption.click();
     await personalFiles.uploadNewVersionDialog.description.fill('new major version description');
     await personalFiles.uploadNewVersionDialog.uploadButton.click();
+    await personalFiles.uploadNewVersionDialog.uploadButton.waitFor({ state: 'detached' });
     await expect(personalFiles.uploadNewVersionDialog.cancelButton).toHaveCount(0);
     expect(await personalFiles.viewer.isViewerOpened(), 'Viewer is not open').toBe(true);
     expect(await personalFiles.viewer.fileTitleButtonLocator.innerText()).toContain(docxFile2);
@@ -202,14 +203,15 @@ test.describe('viewer action file', () => {
     await Utils.uploadFileNewVersion(personalFiles, docxFile);
 
     await personalFiles.uploadNewVersionDialog.uploadButton.click();
+    await personalFiles.uploadNewVersionDialog.uploadButton.waitFor({ state: 'detached' });
     await expect(personalFiles.uploadNewVersionDialog.cancelButton).toHaveCount(0);
 
     await personalFiles.viewer.waitForViewerToOpen();
     expect(await personalFiles.viewer.fileTitleButtonLocator.innerText()).toContain(docxFile);
 
     await personalFiles.acaHeader.clickViewerMoreActions();
-    await expect(personalFiles.matMenu.cancelEditingAction, `'Cancel Editing' button shouldn't be shown`).toBeHidden();
-    await expect(personalFiles.matMenu.editOfflineAction, `'Edit Offline' should be shown`).toBeVisible();
+    await expect(personalFiles.matMenu.getMenuItemFromHeaderMenu('Cancel Editing'), `'Cancel Editing' button shouldn't be shown`).toBeHidden();
+    await expect(personalFiles.matMenu.getMenuItemFromHeaderMenu('Edit Offline'), `'Edit Offline' should be shown`).toBeVisible();
   });
 
   test('[C286384] Copy action from Recent Files', async ({ recentFilesPage, personalFiles }) => {

e2e/protractor/suites/actions/edit/edit-folder.test.ts

@@ -1,237 +0,0 @@
-/*!
- * Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.
- *
- * Alfresco Example Content Application
- *
- * This file is part of the Alfresco Example Content Application.
- * If the software was purchased under a paid Alfresco license, the terms of
- * the paid license agreement will prevail. Otherwise, the software is
- * provided under the following open source license terms:
- *
- * The Alfresco Example Content Application is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * The Alfresco Example Content Application is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * from Hyland Software. If not, see <http://www.gnu.org/licenses/>.
- */
-
-import {
-  AdminActions,
-  LoginPage,
-  BrowsingPage,
-  SITE_VISIBILITY,
-  SITE_ROLES,
-  RepoClient,
-  CreateOrEditFolderDialog,
-  Utils,
-  clearTextWithBackspace,
-  click
-} from '@alfresco/aca-testing-shared';
-
-describe('Edit folder', () => {
-  const username = `user-${Utils.random()}`;
-
-  const parent = `parent-${Utils.random()}`;
-  let parentId: string;
-  const folderName = `folder-${Utils.random()}`;
-  const folderDescription = 'my folder description';
-
-  const folderNameToEdit = `folder-${Utils.random()}`;
-  const duplicateFolderName = `folder-${Utils.random()}`;
-
-  const folderNameEdited = `folder-renamed-${Utils.random()}`;
-  const folderDescriptionEdited = 'description edited';
-
-  const sitePrivate = `site-private-${Utils.random()}`;
-  const siteName = `site-${Utils.random()}`;
-
-  const folderSite = `folder-site-${Utils.random()}`;
-  const duplicateFolderSite = `folder-${Utils.random()}`;
-  let docLibUserSite: string;
-
-  const folderFavorite = `folder-fav-${Utils.random()}`;
-  let folderFavoriteId: string;
-  const folderFavoriteToEdit = `folder-fav-${Utils.random()}`;
-  let folderFavoriteToEditId: string;
-  const folderFavoriteDuplicate = `folder-fav-${Utils.random()}`;
-  let folderFavoriteDuplicateId: string;
-
-  const searchRandom = Utils.random();
-  const folderSearch = `folder-search-${searchRandom}`;
-  const folderSearchToEdit = `folder-search-to-edit-${searchRandom}`;
-  let folderSearchToEditId: string;
-  const folderSearchDuplicate = `folder-search-duplicate-${searchRandom}`;
-
-  const apis = {
-    user: new RepoClient(username, username)
-  };
-
-  const loginPage = new LoginPage();
-  const page = new BrowsingPage();
-  const editDialog = new CreateOrEditFolderDialog();
-  const { dataTable, toolbar } = page;
-
-  const adminApiActions = new AdminActions();
-
-  beforeAll(async () => {
-    await adminApiActions.createUser({ username });
-
-    await adminApiActions.sites.createSite(sitePrivate, SITE_VISIBILITY.PRIVATE);
-    const docLibId = await adminApiActions.sites.getDocLibId(sitePrivate);
-    await adminApiActions.nodes.createFolder(folderName, docLibId);
-    await adminApiActions.sites.addSiteMember(sitePrivate, username, SITE_ROLES.SITE_CONSUMER.ROLE);
-
-    parentId = (await apis.user.nodes.createFolder(parent)).entry.id;
-    await apis.user.nodes.createFolder(folderName, parentId, '', folderDescription);
-    await apis.user.nodes.createFolder(folderNameToEdit, parentId);
-    await apis.user.nodes.createFolder(duplicateFolderName, parentId);
-
-    await apis.user.sites.createSite(siteName);
-    docLibUserSite = await apis.user.sites.getDocLibId(siteName);
-    await apis.user.nodes.createFolder(folderSite, docLibUserSite);
-    await apis.user.nodes.createFolder(duplicateFolderSite, docLibUserSite);
-
-    folderFavoriteId = (await apis.user.nodes.createFolder(folderFavorite)).entry.id;
-    folderFavoriteToEditId = (await apis.user.nodes.createFolder(folderFavoriteToEdit)).entry.id;
-    folderFavoriteDuplicateId = (await apis.user.nodes.createFolder(folderFavoriteDuplicate)).entry.id;
-
-    await apis.user.nodes.createFolder(folderSearch);
-    folderSearchToEditId = (await apis.user.nodes.createFolder(folderSearchToEdit)).entry.id;
-    await apis.user.nodes.createFolder(folderSearchDuplicate);
-
-    await apis.user.favorites.addFavoriteById('folder', folderFavoriteId);
-    await apis.user.favorites.addFavoriteById('folder', folderFavoriteToEditId);
-    await apis.user.favorites.addFavoriteById('folder', folderFavoriteDuplicateId);
-
-    await apis.user.search.waitForNodes(searchRandom, { expect: 3 });
-
-    await loginPage.loginWith(username);
-  });
-
-  afterAll(async () => {
-    await adminApiActions.sites.deleteSite(sitePrivate);
-    await apis.user.sites.deleteSite(siteName);
-    await apis.user.nodes.deleteNodesById([parentId, folderFavoriteToEditId, folderFavoriteDuplicateId, folderSearchToEditId]);
-  });
-
-  beforeEach(async () => {
-    await Utils.pressEscape();
-  });
-
-  afterEach(async () => {
-    await page.closeOpenDialogs();
-  });
-
-  it('[C216331] dialog UI defaults', async () => {
-    await dataTable.doubleClickOnRowByName(parent);
-    await dataTable.selectItem(folderName);
-    await toolbar.openMoreMenu();
-    await click(toolbar.menu.editFolderAction);
-
-    expect(await editDialog.getDialogTitle()).toEqual('Edit folder');
-    expect(await editDialog.getName()).toBe(folderName);
-    expect(await editDialog.getDescription()).toBe(folderDescription);
-    expect(await editDialog.isUpdateButtonEnabled()).toBe(true, 'upload button is not enabled');
-    expect(await editDialog.isCancelButtonEnabled()).toBe(true, 'cancel button is not enabled');
-  });
-
-  describe('on Personal Files', () => {
-    beforeEach(async () => {
-      await page.clickPersonalFilesAndWait();
-      await dataTable.doubleClickOnRowByName(parent);
-      await dataTable.waitForHeader();
-    });
-
-    it('[C216335] properties are modified when pressing OK', async () => {
-      await dataTable.selectItem(folderNameToEdit);
-      await toolbar.openMoreMenu();
-      await click(toolbar.menu.editFolderAction);
-      await editDialog.waitForDialogToOpen();
-      await editDialog.enterDescription(folderDescriptionEdited);
-      await editDialog.enterName(folderNameEdited);
-      await click(editDialog.updateButton);
-      await editDialog.waitForDialogToClose();
-      await dataTable.waitForHeader();
-
-      expect(await dataTable.isItemPresent(folderNameEdited)).toBe(true, 'Folder not displayed');
-      const desc = await apis.user.nodes.getNodeDescription(folderNameEdited, parentId);
-      expect(desc).toEqual(folderDescriptionEdited);
-    });
-
-    it('[C216332] with empty folder name', async () => {
-      await dataTable.selectItem(folderName);
-      await toolbar.openMoreMenu();
-      await click(toolbar.menu.editFolderAction);
-      await clearTextWithBackspace(editDialog.nameInput);
-
-      expect(await editDialog.isUpdateButtonEnabled()).toBe(false, 'upload button is not enabled');
-      expect(await editDialog.getValidationMessage()).toMatch('Folder name is required');
-    });
-
-    it('[C216333] with name with special characters', async () => {
-      const namesWithSpecialChars = ['a*a', 'a"a', 'a<a', 'a>a', `a\\a`, 'a/a', 'a?a', 'a:a', 'a|a'];
-
-      await dataTable.selectItem(folderName);
-      await toolbar.openMoreMenu();
-      await click(toolbar.menu.editFolderAction);
-
-      for (const name of namesWithSpecialChars) {
-        await editDialog.enterName(name);
-        expect(await editDialog.isUpdateButtonEnabled()).toBe(false, 'upload button is not disabled');
-        expect(await editDialog.getValidationMessage()).toContain(`Folder name can't contain these characters`);
-      }
-    });
-
-    it('[C216334] with name ending with a dot', async () => {
-      await dataTable.selectItem(folderName);
-      await toolbar.openMoreMenu();
-      await click(toolbar.menu.editFolderAction);
-      await editDialog.waitForDialogToOpen();
-      await editDialog.nameInput.sendKeys('.');
-
-      expect(await editDialog.isUpdateButtonEnabled()).toBe(false, 'upload button is not enabled');
-      expect(await editDialog.getValidationMessage()).toMatch(`Folder name can't end with a period .`);
-    });
-
-    it('[C216336] Cancel button', async () => {
-      await dataTable.selectItem(folderName);
-      await toolbar.openMoreMenu();
-      await click(toolbar.menu.editFolderAction);
-      await editDialog.waitForDialogToOpen();
-      await editDialog.clickCancel();
-
-      expect(await editDialog.isDialogOpen()).not.toBe(true, 'dialog is not closed');
-    });
-
-    it('[C216337] with duplicate folder name', async () => {
-      await dataTable.selectItem(folderName);
-      await toolbar.openMoreMenu();
-      await click(toolbar.menu.editFolderAction);
-      await editDialog.waitForDialogToOpen();
-      await editDialog.enterName(duplicateFolderName);
-      await click(editDialog.updateButton);
-
-      expect(await page.getSnackBarMessage()).toEqual(`There's already a folder with this name. Try a different name.`);
-      expect(await editDialog.isDialogOpen()).toBe(true, 'dialog is not present');
-    });
-
-    it('[C216338] trim ending spaces', async () => {
-      await dataTable.selectItem(folderName);
-      await toolbar.openMoreMenu();
-      await click(toolbar.menu.editFolderAction);
-      await editDialog.nameInput.sendKeys('   ');
-      await click(editDialog.updateButton);
-      await editDialog.waitForDialogToClose();
-
-      expect(await page.snackBar.isPresent()).not.toBe(true, 'notification appears');
-      expect(await dataTable.isItemPresent(folderName)).toBe(true, 'Folder not displayed in list view');
-    });
-  });
-});

e2e/protractor/suites/actions/edit/edit-offline.test.ts

@@ -1,106 +0,0 @@
-/*!
- * Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.
- *
- * Alfresco Example Content Application
- *
- * This file is part of the Alfresco Example Content Application.
- * If the software was purchased under a paid Alfresco license, the terms of
- * the paid license agreement will prevail. Otherwise, the software is
- * provided under the following open source license terms:
- *
- * The Alfresco Example Content Application is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * The Alfresco Example Content Application is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * from Hyland Software. If not, see <http://www.gnu.org/licenses/>.
- */
-
-import { AdminActions, LoginPage, BrowsingPage, FILES, RepoClient, Utils, UserActions } from '@alfresco/aca-testing-shared';
-
-describe('Edit offline', () => {
-  const username = `user-${Utils.random()}`;
-
-  const file1 = `file1-${Utils.random()}.docx`;
-  const fileLocked = `file-locked-${Utils.random()}.docx`;
-  const fileLocked2 = `file-locked2-${Utils.random()}.docx`;
-  const parentPF = `parentPersonal-${Utils.random()}`;
-
-  const apis = {
-    user: new RepoClient(username, username)
-  };
-
-  const loginPage = new LoginPage();
-  const page = new BrowsingPage();
-  const { dataTable, toolbar } = page;
-
-  const adminApiActions = new AdminActions();
-  const userActions = new UserActions();
-
-  beforeAll(async () => {
-    await adminApiActions.createUser({ username });
-    await userActions.login(username, username);
-  });
-
-  describe('on Personal Files', () => {
-    let parentPFId: string;
-    let file1Id: string;
-    let fileLockedId: string;
-    let fileLocked2Id: string;
-
-    beforeAll(async () => {
-      parentPFId = await apis.user.createFolder(parentPF);
-
-      file1Id = (await apis.user.upload.uploadFileWithRename(FILES.docxFile, parentPFId, file1)).entry.id;
-      fileLockedId = (await apis.user.upload.uploadFileWithRename(FILES.docxFile, parentPFId, fileLocked)).entry.id;
-      fileLocked2Id = (await apis.user.upload.uploadFileWithRename(FILES.docxFile, parentPFId, fileLocked2)).entry.id;
-
-      await userActions.lockNodes([fileLockedId, fileLocked2Id]);
-
-      await loginPage.loginWith(username);
-    });
-
-    beforeEach(async () => {
-      await page.clickPersonalFilesAndWait();
-      await dataTable.doubleClickOnRowByName(parentPF);
-    });
-
-    afterEach(async () => {
-      await Utils.pressEscape();
-    });
-
-    afterAll(async () => {
-      await userActions.login(username, username);
-      await apis.user.nodes.deleteNodeById(parentPFId);
-    });
-
-    it('[C297538] File is locked and downloaded when clicking Edit Offline', async () => {
-      await dataTable.selectItem(file1);
-      await toolbar.clickMoreActionsEditOffline();
-
-      expect(await Utils.fileExistsOnOS(file1)).toBe(true, 'File not found in download location');
-      expect(await apis.user.nodes.isFileLockedWrite(file1Id)).toBe(true, `${file1} is not locked`);
-    });
-
-    it('[C297539] Lock information is displayed', async () => {
-      expect(await dataTable.isItemPresent(fileLocked2)).toBe(true, `${fileLocked2} is not displayed`);
-      expect(await dataTable.hasLockIcon(fileLocked2)).toBe(true, `${fileLocked2} does not have a lock icon`);
-      expect(await dataTable.getLockOwner(fileLocked2)).toContain(username, `${fileLocked2} does not have correct lock owner info`);
-    });
-
-    it('[C297540] Cancel Editing unlocks the file', async () => {
-      await dataTable.selectItem(fileLocked);
-      await toolbar.clickMoreActionsCancelEditing();
-      await dataTable.unselectItem(fileLocked);
-
-      expect(await apis.user.nodes.isFileLockedWrite(fileLockedId)).toBe(false, `${fileLocked} is still locked`);
-      expect(await dataTable.hasLockIcon(fileLocked)).toBe(false, `${fileLocked} has a lock icon`);
-    });
-  });
-});

projects/aca-playwright-shared/src/api/nodes-api.ts

@@ -446,4 +446,23 @@ export class NodesApi {
       return null;
     }
   }
+
+  private async getLockType(nodeId: string): Promise<string> {
+    try {
+      const lockType = await this.getNodeProperty(nodeId, 'cm:lockType');
+      return lockType || '';
+    } catch (error) {
+      console.error(`${this.constructor.name} ${this.getLockType.name}`, error);
+      return '';
+    }
+  }
+
+  async isFileLockedWrite(nodeId: string): Promise<boolean> {
+    try {
+      return (await this.getLockType(nodeId)) === 'WRITE_LOCK';
+    } catch (error) {
+      console.error(`${this.constructor.name} ${this.isFileLockedWrite.name}`, error);
+      return null;
+    }
+  }
 }

projects/aca-playwright-shared/src/page-objects/components/dataTable/data-table.component.ts

@@ -55,6 +55,7 @@ export class DataTableComponent extends BaseComponent {
   sitesVisibility = this.page.locator('.adf-datatable-body [data-automation-id*="datatable-row"] [aria-label="Visibility"]');
   sitesName = this.page.locator('.adf-datatable-body [data-automation-id*="datatable-row"] [aria-label="Name"]');
   sitesRole = this.page.locator('.adf-datatable-body [data-automation-id*="datatable-row"] [aria-label="My Role"]');
+  lockOwner = this.page.locator('.aca-locked-by--name');
 
   /** Locator for row (or rows) */
   getRowLocator = this.page.getByRole('rowgroup').nth(1).locator('adf-datatable-row');
@@ -372,4 +373,14 @@ export class DataTableComponent extends BaseComponent {
     }
     return sitesInfo;
   }
+
+  async hasLockIcon(itemName: string): Promise<boolean> {
+    const row = this.getRowByName(itemName);
+    return row.locator('img[src*="lock"]').isVisible();
+  }
+
+  async getLockOwner(itemName: string): Promise<string> {
+    const row = this.getRowByName(itemName);
+    return row.locator(this.lockOwner).innerText();
+  }
 }

projects/aca-playwright-shared/src/page-objects/components/dataTable/mat-menu.component.ts

@@ -39,12 +39,16 @@ export class MatMenuComponent extends BaseComponent {
   public createFileFromTemplate = this.getChild('[id="app.create.fileFromTemplate"]');
   public createLibrary = this.getChild('[id="app.create.library"]');
   public getButtonByText = (text: string) => this.getChild('button', { hasText: text });
-  public cancelEditingAction = this.getChild(`.mat-mdc-menu-item[title='Cancel Editing']`);
-  public editOfflineAction = this.getChild(`.mat-mdc-menu-item[title='Edit Offline']`);
+  public getMenuItemFromHeaderMenu = (text: string) => this.page.getByRole('menuitem', { name: text, exact: true });
 
   async clickMenuItem(menuItem: string): Promise<void> {
     const menuElement = this.getButtonByText(menuItem);
-    await menuElement.waitFor({ state: 'attached' });
+    await menuElement.click();
+    await menuElement.waitFor({ state: 'detached' });
+  }
+
+  async clickMenuItemFromHeaderMenu(menuItem: string): Promise<void> {
+    const menuElement = this.getMenuItemFromHeaderMenu(menuItem);
     await menuElement.click();
     await menuElement.waitFor({ state: 'detached' });
   }

projects/aca-playwright-shared/src/page-objects/components/dialogs/edit-dialog.component.ts

@@ -0,0 +1,42 @@
+/*!
+ * Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.
+ *
+ * Alfresco Example Content Application
+ *
+ * This file is part of the Alfresco Example Content Application.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail. Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * The Alfresco Example Content Application is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The Alfresco Example Content Application is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { Page } from '@playwright/test';
+import { BaseComponent } from '../base.component';
+
+export class EditDialog extends BaseComponent {
+  private static rootElement = 'mat-dialog-container';
+
+  public editDialog = this.getChild('');
+  public titleInput = this.getChild('[data-automation-id="adf-folder-dialog-title"]');
+  public cancelButton = this.getChild('#adf-folder-cancel-button');
+  public updateButton = this.getChild('#adf-folder-create-button');
+  public descriptionInput = this.getChild('#adf-folder-description-input');
+  public nameInput = this.getChild('#adf-folder-name-input');
+  public fieldHint = this.getChild('mat-hint');
+
+  constructor(page: Page) {
+    super(page, EditDialog.rootElement);
+  }
+}

projects/aca-playwright-shared/src/page-objects/components/dialogs/index.ts

@@ -35,3 +35,4 @@ export * from './manage-versions-dialog.component';
 export * from './upload-dialog.component';
 export * from './delete-trash-dialog.component';
 export * from './link-rules.component';
+export * from './edit-dialog.component';

projects/aca-playwright-shared/src/page-objects/pages/personal-files.page.ts

@@ -44,7 +44,8 @@ import {
   UploadNewVersionDialog,
   ManageVersionsDialog,
   UploadDialog,
-  SnackBarComponent
+  SnackBarComponent,
+  EditDialog
 } from '../components';
 
 export class PersonalFilesPage extends BasePage {
@@ -74,6 +75,7 @@ export class PersonalFilesPage extends BasePage {
   public manageVersionsDialog = new ManageVersionsDialog(this.page);
   public uploadDialog = new UploadDialog(this.page);
   public snackBar = new SnackBarComponent(this.page);
+  public editDialog = new EditDialog(this.page);
 
   async selectCreateFolder(): Promise<void> {
     await this.acaHeader.createButton.click();