[ACS-5343] refactor Playwright framework in ACA (#3261)

* [ACS-5343] refactor Playwright framework in ACA

* Add the tests for Actions, from the Adam PR [ACS-5328]

* Small fixes

* Improve logs

* [ACS-5343] adding-goThroughPages-and-delete

* [ACS-5343] added git changes

* [ACS-5343] added git changes for playwright

* [ACS-5343] fix for e2e

* [ACS-5343] e2e protractor path fix

* remove import

* [ACS-5343] e2e playwright user fix

* [ACS-5343] e2e playwright user ids fix

* [ACS-5343] e2e playwright users ids fix

* changes for git

* fix playwright test run

* tsconfig path fix

* playwright action yml added

* retrigger checks

* add test id from testrail

* merge conflits

* fix gha

* fix credentials

---------

Co-authored-by: adam.zakrzewski <adam.zakrzewski@hyland.com>
Co-authored-by: akash.rathod@hyland.com <akash.rathod@hyland.com>
Co-authored-by: Denys Vuika <denys.vuika@gmail.com>

projects/aca-playwright-shared/src/utils/exclude-tests.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright © 2005 - 2021 Alfresco Software, Ltd. All rights reserved.
+ *
+ * License rights for this program may be obtained from Alfresco Software, Ltd.
+ * pursuant to a written agreement and any use of this program without such an
+ * agreement is prohibited.
+ */
+
+import { logger } from '@alfresco/adf-cli/scripts/logger';
+
+export const getExcludedTestsRegExpArray = (excludedJson: any, projectName: string) => {
+    const prefix = `[ 🎭 Playwright Excludes - ${projectName} ]`;
+    const objectKeys = Object.keys(excludedJson);
+
+    if (!objectKeys.length) {
+        logger.info(`${prefix} ✅ No excluded tests 🎉 `);
+    } else {
+        logger.warn(`${prefix} ❌ Tests excluded because of 🐛 : ${objectKeys}`);
+    }
+
+    return objectKeys.map((key) => new RegExp(key));
+};

projects/aca-playwright-shared/src/utils/index.ts

@@ -0,0 +1,28 @@
+/*!
+ * 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/>.
+ */
+
+export * from './paths';
+export * from './timeouts';
+export * from './exclude-tests';
+export * from './state-helper';

projects/aca-playwright-shared/src/utils/paths.ts

@@ -0,0 +1,33 @@
+/*!
+ * 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/>.
+ */
+
+const rootFolder = 'e2e-output';
+
+export const paths = {
+    rootFolder,
+    allData: `${rootFolder}/playwright-data`,
+    files: `${rootFolder}/playwright-data/downloads`,
+    report: `${rootFolder}/playwright-data/report`,
+    userStates: `${rootFolder}/playwright-data/user-states`,
+};

projects/aca-playwright-shared/src/utils/state-helper.ts

@@ -0,0 +1,34 @@
+/*!
+ * 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 { resolve } from 'path';
+import { paths } from '.';
+import { users } from '../base-config';
+
+export function getUserState(user: UserType) {
+    return resolve(process.cwd(), `${paths.userStates}/${user}UserState.json`);
+}
+
+type UserType = keyof typeof users;

projects/aca-playwright-shared/src/utils/timeouts.ts

@@ -0,0 +1,37 @@
+/*!
+ * 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/>.
+ */
+
+export const timeouts = {
+  typingDelay: 50,
+  tiny: 500,
+  short: 1000,
+  normal: 2000,
+  medium: 5000,
+  large: 10000,
+  extraLarge: 20 * 1000,
+  globalTest: 45 * 1000,
+  extendedTest: 120 * 1000,
+  webServer: 240 * 1000,
+  globalSpec: 60 * 10 * 1000
+};