[ACS-5650] viewer action files e2e migration (#3367)

* viewer action files e2e migration

* viewer action files e2e remove comment

* review code fix

* [ci:force]

projects/aca-playwright-shared/src/api/api-client-factory.ts

@@ -37,7 +37,8 @@ import {
   SitesApi,
   UploadApi,
   SharedlinksApi,
-  FavoritesApi
+  FavoritesApi,
+  TrashcanApi
 } from '@alfresco/js-api';
 import { logger } from '@alfresco/adf-cli/scripts/logger';
 import { ActionTypes, Rule } from './rules-api';
@@ -49,6 +50,7 @@ export interface AcaBackend {
   nodes: NodesApi;
   share: SharedlinksApi;
   favorites: FavoritesApi;
+  trashCan: TrashcanApi;
 
   tearDown(): Promise<any>;
 }
@@ -79,6 +81,7 @@ export class ApiClientFactory {
   public contentClient: ContentClient;
   public share: SharedlinksApi;
   public favorites: FavoritesApi;
+  public trashCan: TrashcanApi;
 
   constructor() {
     this.alfrescoApi = new AlfrescoApi(config);
@@ -100,6 +103,7 @@ export class ApiClientFactory {
     this.securityMarksApi = new SecurityMarksApi(this.alfrescoApi);
     this.share = new SharedlinksApi(this.alfrescoApi);
     this.favorites = new FavoritesApi(this.alfrescoApi);
+    this.trashCan = new TrashcanApi(this.alfrescoApi);
 
     return this;
   }

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

@@ -23,23 +23,22 @@
  */
 
 import { ApiClientFactory } from './api-client-factory';
-import { SharedLinkEntry } from '@alfresco/js-api';
+import { FavoritePaging, SharedLinkEntry } from '@alfresco/js-api';
 import { users } from '../base-config/global-variables';
+import { logger } from '@alfresco/adf-cli/scripts/logger';
 
 export class SharedLinksApi extends ApiClientFactory {
   private apiService: ApiClientFactory;
 
   constructor() {
     super();
-      this.apiService = new ApiClientFactory();
+    this.apiService = new ApiClientFactory();
+  }
+  static async initialize(userProfile: keyof typeof users): Promise<SharedLinksApi> {
+    const classObj = new SharedLinksApi();
+    await classObj.apiService.setUpAcaBackend(userProfile);
+    return classObj;
   }
-  static async initialize(
-    userProfile: keyof typeof users
-    ): Promise<SharedLinksApi> {
-        const classObj = new SharedLinksApi();
-        await classObj.apiService.setUpAcaBackend(userProfile);
-        return classObj;
-    }
 
   async shareFileById(id: string, expireDate?: Date): Promise<SharedLinkEntry | null> {
     try {
@@ -52,4 +51,22 @@ export class SharedLinksApi extends ApiClientFactory {
       return null;
     }
   }
+
+  private async getFavorites(userName: string): Promise<FavoritePaging> {
+    try {
+      return await this.apiService.favorites.listFavorites(userName);
+    } catch (error) {
+      logger.error(`\n--- Error while fetching favourites list ${error} :`);
+      return null;
+    }
+  }
+
+  async isFavorite(nodeId: string, userName: string): Promise<boolean> {
+    try {
+      return JSON.stringify((await this.getFavorites(userName)).list.entries).includes(nodeId);
+    } catch (error) {
+      logger.error(`\n--- Error while checking favourite node ${error} ${error} :`);
+      return null;
+    }
+  }
 }

projects/aca-playwright-shared/src/fixtures/page-initialization.ts

@@ -33,7 +33,8 @@ import {
   SharedPage,
   SearchPage,
   FavoritesPage,
-  FavoritesPageApi
+  FavoritesPageApi,
+  TrashPage
 } from '../';
 
 interface Pages {
@@ -44,6 +45,7 @@ interface Pages {
   sharedPage: SharedPage;
   searchPage: SearchPage;
   favoritePage: FavoritesPage;
+  trashPage: TrashPage;
 }
 
 interface Api {
@@ -71,17 +73,20 @@ export const test = base.extend<Pages & Api>({
   favoritePage: async ({ page }, use) => {
     await use(new FavoritesPage(page));
   },
+  trashPage: async ({ page }, use) => {
+    await use(new TrashPage(page));
+  },
   // eslint-disable-next-line no-empty-pattern
   fileAction: async ({}, use) => {
-    await use(await FileActionsApi.initialize('admin'));
+    await use(await FileActionsApi.initialize('hruser'));
   },
   // eslint-disable-next-line no-empty-pattern
   shareAction: async ({}, use) => {
-    await use(await SharedLinksApi.initialize('admin'));
+    await use(await SharedLinksApi.initialize('hruser'));
   },
   // eslint-disable-next-line no-empty-pattern
   favoritesPageAction: async ({}, use) => {
-    await use(await FavoritesPageApi.initialize('admin'));
+    await use(await FavoritesPageApi.initialize('hruser'));
   },
   myLibrariesPage: async ({ page }, use) => {
     await use(new MyLibrariesPage(page));

projects/aca-playwright-shared/src/page-objects/components/aca-header.component.ts

@@ -1,37 +1,46 @@
 /*!
-  * Copyright © 2005-2023 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/>.
-  */
+ * Copyright © 2005-2023 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 { BaseComponent } from './base.component';
 import { Page } from '@playwright/test';
 export class AcaHeader extends BaseComponent {
   private static rootElement = 'adf-toolbar';
+  private moreActionsButton = this.getChild('button[id="app.viewer.toolbar.more"]');
   public createButton = this.getChild('[id="app.toolbar.create"]');
   public viewDetails = this.getChild('[title="View Details"]');
   public viewButton = this.getChild('button[title="View"]');
   public searchButton = this.getChild('button[title="Search"]');
+  public fullScreenButton = this.getChild('button[id="app.viewer.fullscreen"]');
+  public shareButton = this.getChild('button[id="app.viewer.fullscreen"]');
+  public downloadButton = this.getChild('button[id="app.viewer.download"]');
 
   constructor(page: Page) {
     super(page, AcaHeader.rootElement);
   }
+
+  async clickViewerMoreActions(): Promise<void> {
+    await this.moreActionsButton.waitFor({ state: 'attached' });
+    await this.moreActionsButton.click();
+  }
 }

projects/aca-playwright-shared/src/page-objects/components/actions-dropdown.component.ts

@@ -52,7 +52,7 @@ export enum ActionType {
 export class ActionsDropdownComponent extends BaseComponent {
   private static rootElement = 'aca-rule-action-list';
 
-  private getOptionLocator = (optionName: string): Locator => this.page.locator('.mat-select-panel .mat-option-text', { hasText: optionName });
+  private getOptionLocator = (optionName: string): Locator => this.page.locator('.mat-select-panel .mat-option-text', { hasText: optionName }).first();
   private ruleActionLocator = this.getChild('aca-rule-action [data-automation-id="rule-action-card-view"]');
   private addActionButtonLocator = this.getChild('[data-automation-id="rule-action-list-add-action-button"]');
   private actionDropdownLocator = this.getChild('[data-automation-id="rule-action-select"]');
@@ -75,9 +75,8 @@ export class ActionsDropdownComponent extends BaseComponent {
       await this.addActionButtonLocator.click();
     }
     await this.actionDropdownLocator.nth(index).click();
-    await this.spinnerWaitForReload();
     const option = this.getOptionLocator(action);
-    await option.nth(0).click();
+    await option.click();
   }
 
   async dropdownSelection(selectValue: string, locator: string, index: number): Promise<void> {

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

@@ -165,6 +165,11 @@ export class DataTableComponent extends BaseComponent {
     await this.spinnerWaitForReload();
   }
 
+  async isItemPresent(name: string): Promise<boolean> {
+    await this.goThroughPagesLookingForRowWithName(name);
+    return this.getRowByName(name).isVisible();
+  }
+
   async getActionLocatorFromExpandableMenu(name: string | number, action: string): Promise<Locator> {
     await this.getRowByName(name).click({ button: 'right' });
     return this.contextMenuActions.getButtonByText(action);
@@ -199,7 +204,7 @@ export class DataTableComponent extends BaseComponent {
   async selectItem(name: string): Promise<void> {
     const isSelected = await this.hasCheckMarkIcon(name);
     if (!isSelected) {
-      const row = await this.getRowByName(name);
+      const row = this.getRowByName(name);
       await row.locator('.mat-checkbox[id*="mat-checkbox"]').check();
     }
   }

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

@@ -37,4 +37,17 @@ export class MatMenuComponent extends BaseComponent {
   public createFolder = this.getChild('[id="app.create.folder"]');
   public createLibrary = this.getChild('[id="app.create.library"]');
   public getButtonByText = (text: string) => this.getChild('button', { hasText: text });
+
+  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 isMenuItemVisible(menuItem: string): Promise<boolean> {
+    const menuElement = this.getButtonByText(menuItem);
+    await menuElement.waitFor({ state: 'attached' });
+    return await menuElement.isVisible();
+  }
 }

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

@@ -25,3 +25,4 @@
 export * from './adf-folder-dialog.component';
 export * from './adf-library-dialog.component';
 export * from './password-overlay-dialog.component';
+export * from './viewer-overlay-dialog.component';

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

@@ -0,0 +1,62 @@
+/*!
+ * Copyright © 2005-2023 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 { Page } from '@playwright/test';
+import { BaseComponent } from '../base.component';
+import { timeouts } from '../../../utils';
+
+export class ViewerOverlayDialogComponent extends BaseComponent {
+  private static rootElement = '.cdk-overlay-pane';
+
+  public closeButton = this.getChild('[data-automation-id="adf-password-dialog-close"]');
+  public submitButton = this.getChild('[data-automation-id="adf-password-dialog-submit"]');
+  public passwordInput = this.getChild('[data-automation-id="adf-password-dialog-input"]');
+  public errorMessage = this.getChild('[data-automation-id="adf-password-dialog-error"]');
+  public copyDialog = this.getChild('[data-automation-id="content-node-selector-title"]');
+  public copyMenuButton = this.getChild('[id="app.viewer.copy"]');
+  public deleteMenuButton = this.getChild('[id="app.viewer.delete"]');
+  public favoriteMenuButton = this.getChild('[id="app.viewer.favorite.add"]');
+  public removeFavoriteMenuButton = this.getChild('[id="app.viewer.favorite.remove"]');
+  public shareDialogTitle = this.getChild('[data-automation-id="adf-share-dialog-title"]');
+  public shareDialogClose = this.getChild('[data-automation-id="adf-share-dialog-close"]');
+
+  constructor(page: Page, rootElement = ViewerOverlayDialogComponent.rootElement) {
+    super(page, rootElement);
+  }
+
+  async isCopyDialogOpen(): Promise<boolean> {
+    await this.copyDialog.waitFor({ state: 'attached', timeout: timeouts.medium });
+    return this.copyDialog.isVisible();
+  }
+
+  async isCopyDialogClose(): Promise<boolean> {
+    await this.copyDialog.waitFor({ state: 'detached', timeout: timeouts.medium });
+    return this.copyDialog.isVisible();
+  }
+
+  async clickActionsCopy(): Promise<void> {
+    await this.copyMenuButton.waitFor({ state: 'attached', timeout: timeouts.medium });
+    await this.copyMenuButton.click();
+  }
+}

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

@@ -26,7 +26,7 @@ import { Page } from '@playwright/test';
 import { BasePage } from './base.page';
 import { DataTableComponent, MatMenuComponent, ViewerComponent } from '../components';
 import { AcaHeader } from '../components/aca-header.component';
-import { AdfFolderDialogComponent } from '../components/dialogs';
+import { AdfFolderDialogComponent, ViewerOverlayDialogComponent } from '../components/dialogs';
 
 export class FavoritesPage extends BasePage {
   private static pageUrl = 'favorites';
@@ -40,4 +40,5 @@ export class FavoritesPage extends BasePage {
   public folderDialog = new AdfFolderDialogComponent(this.page);
   public dataTable = new DataTableComponent(this.page);
   public viewer = new ViewerComponent(this.page);
+  public viewerDialog = new ViewerOverlayDialogComponent(this.page);
 }

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

@@ -31,3 +31,4 @@ export * from './recent-files.page';
 export * from './shared.page';
 export * from './search.page';
 export * from './favorites.page';
+export * from './trash.page';

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

@@ -26,7 +26,7 @@ import { Page } from '@playwright/test';
 import { BasePage } from './base.page';
 import { DataTableComponent, MatMenuComponent, ViewerComponent } from '../components';
 import { AcaHeader } from '../components/aca-header.component';
-import { AdfFolderDialogComponent, PasswordOverlayDialogComponent } from '../components/dialogs';
+import { AdfFolderDialogComponent, PasswordOverlayDialogComponent, ViewerOverlayDialogComponent } from '../components/dialogs';
 
 export class PersonalFilesPage extends BasePage {
   private static pageUrl = 'personal-files';
@@ -41,6 +41,7 @@ export class PersonalFilesPage extends BasePage {
   public dataTable = new DataTableComponent(this.page);
   public viewer = new ViewerComponent(this.page);
   public passwordDialog = new PasswordOverlayDialogComponent(this.page);
+  public viewerDialog = new ViewerOverlayDialogComponent(this.page);
 
   async selectCreateFolder(): Promise<void> {
     await this.acaHeader.createButton.click();

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

@@ -26,7 +26,7 @@ import { Page } from '@playwright/test';
 import { BasePage } from './base.page';
 import { DataTableComponent, MatMenuComponent, ViewerComponent } from '../components';
 import { AcaHeader } from '../components/aca-header.component';
-import { AdfFolderDialogComponent } from '../components/dialogs';
+import { AdfFolderDialogComponent, ViewerOverlayDialogComponent } from '../components/dialogs';
 
 export class SharedPage extends BasePage {
   private static pageUrl = 'shared';
@@ -40,4 +40,5 @@ export class SharedPage extends BasePage {
   public folderDialog = new AdfFolderDialogComponent(this.page);
   public dataTable = new DataTableComponent(this.page);
   public viewer = new ViewerComponent(this.page);
+  public viewerDialog = new ViewerOverlayDialogComponent(this.page);
 }

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

@@ -0,0 +1,44 @@
+/*!
+ * Copyright © 2005-2023 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 { Page } from '@playwright/test';
+import { BasePage } from './base.page';
+import { DataTableComponent, MatMenuComponent, ViewerComponent } from '../components';
+import { AcaHeader } from '../components/aca-header.component';
+import { AdfFolderDialogComponent, ViewerOverlayDialogComponent } from '../components/dialogs';
+
+export class TrashPage extends BasePage {
+  private static pageUrl = 'trashcan';
+
+  constructor(page: Page) {
+    super(page, TrashPage.pageUrl);
+  }
+
+  public acaHeader = new AcaHeader(this.page);
+  public matMenu = new MatMenuComponent(this.page);
+  public folderDialog = new AdfFolderDialogComponent(this.page);
+  public dataTable = new DataTableComponent(this.page);
+  public viewer = new ViewerComponent(this.page);
+  public viewerDialog = new ViewerOverlayDialogComponent(this.page);
+}