@mattermost/playwright-lib 10.6.0-0

package/README.md

@@ -0,0 +1,214 @@
+# @mattermost/playwright-lib
+
+A comprehensive end-to-end testing library for Mattermost web, desktop and plugin applications using Playwright.
+
+## Overview
+
+This library provides:
+
+- Pre-built page objects and components for common Mattermost UI elements
+- Server configuration and initialization utilities
+- Test fixtures and helpers
+- Visual testing support with Percy integration
+- Accessibility testing support with [axe-core](https://github.com/dequelabs/axe-core)
+- Browser notification mocking
+- File handling utilities
+- Common test actions and assertions
+
+## Installation
+
+```bash
+npm install @mattermost/playwright-lib
+```
+
+## Usage
+
+Basic example of logging in and posting a message:
+
+```typescript
+import {test, expect} from '@mattermost/playwright-lib';
+
+test('user can post message', async ({pw}) => {
+    // # Create and login a new user
+    const {user} = await pw.initSetup();
+    const {channelsPage} = await pw.testBrowser.login(user);
+
+    // # Navigate and post a message
+    await channelsPage.goto();
+    const message = 'Hello World!';
+    await channelsPage.postMessage(message);
+
+    // * Verify message appears
+    const lastPost = await channelsPage.getLastPost();
+    await expect(lastPost).toHaveText(message);
+});
+```
+
+## Key Components
+
+### Page Objects
+
+Ready-to-use page objects for common Mattermost pages:
+
+- Login
+- Signup
+- Channels
+- System Console
+- And more...
+
+### UI Components
+
+Reusable component objects for UI elements:
+
+- Headers
+- Posts
+- Menus
+- Modals
+- And more...
+
+### Test Utilities
+
+Helper functions for common testing needs:
+
+- Server setup and configuration
+- User/team creation
+- File handling
+- Visual testing
+- And more...
+
+## Configuration
+
+The library can be configured via optional environment variables:
+
+### Environment Variables
+
+All environment variables are optional with sensible defaults.
+
+#### Server Configuration
+
+| Variable                      | Description                                | Default                          |
+| ----------------------------- | ------------------------------------------ | -------------------------------- |
+| `PW_BASE_URL`                 | Server URL                                 | `http://localhost:8065`          |
+| `PW_ADMIN_USERNAME`           | Admin username                             | `sysadmin`                       |
+| `PW_ADMIN_PASSWORD`           | Admin password                             | `Sys@dmin-sample1`               |
+| `PW_ADMIN_EMAIL`              | Admin email                                | `sysadmin@sample.mattermost.com` |
+| `PW_ENSURE_PLUGINS_INSTALLED` | Comma-separated list of plugins to install | `[]`                             |
+| `PW_RESET_BEFORE_TEST`        | Reset server before test                   | `false`                          |
+
+#### High Availability Cluster Settings
+
+| Variable                   | Description             | Default          |
+| -------------------------- | ----------------------- | ---------------- |
+| `PW_HA_CLUSTER_ENABLED`    | Enable HA cluster       | `false`          |
+| `PW_HA_CLUSTER_NODE_COUNT` | Number of cluster nodes | `2`              |
+| `PW_HA_CLUSTER_NAME`       | Cluster name            | `mm_dev_cluster` |
+
+#### Push Notifications
+
+| Variable                      | Description                  | Default                            |
+| ----------------------------- | ---------------------------- | ---------------------------------- |
+| `PW_PUSH_NOTIFICATION_SERVER` | Push notification server URL | `https://push-test.mattermost.com` |
+
+#### Playwright Settings
+
+| Variable      | Description                     | Default |
+| ------------- | ------------------------------- | ------- |
+| `PW_HEADLESS` | Run tests headless              | `true`  |
+| `PW_SLOWMO`   | Add delay between actions in ms | `0`     |
+| `PW_WORKERS`  | Number of parallel workers      | `1`     |
+
+#### Visual Testing
+
+| Variable             | Description                 | Default |
+| -------------------- | --------------------------- | ------- |
+| `PW_SNAPSHOT_ENABLE` | Enable snapshot testing     | `false` |
+| `PW_PERCY_ENABLE`    | Enable Percy visual testing | `false` |
+
+#### CI Settings
+
+| Variable | Description                          | Default |
+| -------- | ------------------------------------ | ------- |
+| `CI`     | Set automatically in CI environments | N/A     |
+
+## Accessibility Testing
+
+The library includes built-in accessibility testing using [axe-core](https://github.com/dequelabs/axe-core):
+
+```typescript
+import {test, expect} from '@mattermost/playwright-lib';
+
+test('verify login page accessibility', async ({page, axe}) => {
+    // # Navigate to login page
+    await page.goto('/login');
+
+    // # Run accessibility scan
+    const results = await axe.builder(page).analyze();
+
+    // * Verify no accessibility violations
+    expect(results.violations).toHaveLength(0);
+});
+```
+
+The axe-core integration:
+
+- Runs WCAG 2.0 Level A & AA rules by default
+- Provides detailed violation reports
+- Supports rule customization
+- Can be configured per-test or globally
+
+## Visual Testing
+
+The library supports visual testing through [Playwright's built-in visual comparisons](https://playwright.dev/docs/test-snapshots) and [Percy](https://www.browserstack.com/percy) integration:
+
+```typescript
+import {test, expect} from '@mattermost/playwright-lib';
+
+test('verify channel header appearance', async ({pw, browserName, viewport}, testInfo) => {
+    // # Setup and login
+    const {user} = await pw.initSetup();
+    const {page, channelsPage} = await pw.testBrowser.login(user);
+
+    // # Navigate and prepare page
+    await channelsPage.goto();
+    await expect(channelsPage.appBar.playbooksIcon).toBeVisible();
+    await pw.hideDynamicChannelsContent(page);
+
+    // * Take and verify snapshot
+    await pw.matchSnapshot(testInfo, {page, browserName, viewport});
+});
+```
+
+## Browser Notifications
+
+Mock and verify browser notifications:
+
+```typescript
+import {test, expect} from '@mattermost/playwright-lib';
+
+test('verify notification on mention', async ({pw}) => {
+    // # Setup users and team
+    const {team, adminUser, user} = await pw.initSetup();
+
+    // # Setup admin browser with notifications
+    const {page: adminPage, channelsPage: adminChannelsPage} = await pw.testBrowser.login(adminUser);
+    await adminChannelsPage.goto(team.name, 'town-square');
+    await pw.stubNotification(adminPage, 'granted');
+
+    // # Setup user browser and post mention
+    const {channelsPage: userChannelsPage} = await pw.testBrowser.login(user);
+    await userChannelsPage.goto(team.name, 'off-topic');
+    await userChannelsPage.postMessage(`@ALL good morning, ${team.name}!`);
+
+    // * Verify notification received
+    const notifications = await pw.waitForNotification(adminPage);
+    expect(notifications.length).toBe(1);
+});
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](../../../CONTRIBUTING.md) for development setup and guidelines.
+
+## License
+
+See [LICENSE.txt](../../../LICENSE.txt) for license information.

package/dist/browser_context.d.ts

@@ -0,0 +1,17 @@
+import { Browser, BrowserContext } from '@playwright/test';
+import { UserProfile } from '@mattermost/types/users';
+export declare class TestBrowser {
+    readonly browser: Browser;
+    context: BrowserContext | null;
+    constructor(browser: Browser);
+    login(user: UserProfile): Promise<{
+        context: BrowserContext;
+        page: import("playwright-core").Page;
+        channelsPage: import("./ui/pages").ChannelsPage;
+        systemConsolePage: import("./ui/pages").SystemConsolePage;
+        scheduledDraftPage: import("./ui/pages").ScheduledDraftPage;
+        draftPage: import("./ui/pages").DraftPage;
+    }>;
+    close(): Promise<void>;
+}
+export declare function loginByAPI(loginId: string, password: string, token?: string, ldapOnly?: boolean): Promise<string>;

package/dist/browser_context.js

@@ -0,0 +1,71 @@
+'use strict';
+
+var promises = require('node:fs/promises');
+var test = require('@playwright/test');
+var test_config = require('./test_config.js');
+var index = require('./ui/pages/index.js');
+
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+class TestBrowser {
+    browser;
+    context;
+    constructor(browser) {
+        this.browser = browser;
+        this.context = null;
+    }
+    async login(user) {
+        const options = { storageState: '' };
+        if (user) {
+            // Log in via API request and save user storage
+            const storagePath = await loginByAPI(user.username, user.password);
+            options.storageState = storagePath;
+        }
+        // Sign in a user in new browser context
+        const context = await this.browser.newContext(options);
+        const page = await context.newPage();
+        const channelsPage = new index.pages.ChannelsPage(page);
+        const systemConsolePage = new index.pages.SystemConsolePage(page);
+        const scheduledDraftPage = new index.pages.ScheduledDraftPage(page);
+        const draftPage = new index.pages.DraftPage(page);
+        this.context = context;
+        return { context, page, channelsPage, systemConsolePage, scheduledDraftPage, draftPage };
+    }
+    async close() {
+        if (this.context) {
+            await this.context.close();
+        }
+    }
+}
+async function loginByAPI(loginId, password, token = '', ldapOnly = false) {
+    const requestContext = await test.request.newContext();
+    const data = {
+        login_id: loginId,
+        password,
+        token,
+        deviceId: '',
+    };
+    if (ldapOnly) {
+        data.ldap_only = 'true';
+    }
+    // Log in via API
+    await requestContext.post(`${test_config.testConfig.baseURL}/api/v4/users/login`, {
+        data,
+        headers: { 'X-Requested-With': 'XMLHttpRequest' },
+    });
+    // Save signed-in state to a folder
+    const storagePath = `storage_state/${Date.now()}_${loginId}_${password}${token ? '_' + token : ''}${ldapOnly ? '_ldap' : ''}.json`;
+    const storageState = await requestContext.storageState({ path: storagePath });
+    await requestContext.dispose();
+    // Append origins to bypass seeing landing page then write to file
+    storageState.origins.push({
+        origin: test_config.testConfig.baseURL,
+        localStorage: [{ name: '__landingPageSeen__', value: 'true' }],
+    });
+    await promises.writeFile(storagePath, JSON.stringify(storageState));
+    return storagePath;
+}
+
+exports.TestBrowser = TestBrowser;
+exports.loginByAPI = loginByAPI;
+//# sourceMappingURL=browser_context.js.map

package/dist/browser_context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser_context.js","sources":["../src/browser_context.ts"],"sourcesContent":["// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.\n// See LICENSE.txt for license information.\n\nimport {writeFile} from 'node:fs/promises';\n\nimport {Browser, BrowserContext, request} from '@playwright/test';\nimport {UserProfile} from '@mattermost/types/users';\n\nimport {testConfig} from './test_config';\nimport {pages} from './ui/pages';\n\nexport class TestBrowser {\n    readonly browser: Browser;\n    context: BrowserContext | null;\n\n    constructor(browser: Browser) {\n        this.browser = browser;\n        this.context = null;\n    }\n\n    async login(user: UserProfile) {\n        const options = {storageState: ''};\n        if (user) {\n            // Log in via API request and save user storage\n            const storagePath = await loginByAPI(user.username, user.password);\n            options.storageState = storagePath;\n        }\n\n        // Sign in a user in new browser context\n        const context = await this.browser.newContext(options);\n        const page = await context.newPage();\n\n        const channelsPage = new pages.ChannelsPage(page);\n        const systemConsolePage = new pages.SystemConsolePage(page);\n        const scheduledDraftPage = new pages.ScheduledDraftPage(page);\n        const draftPage = new pages.DraftPage(page);\n\n        this.context = context;\n\n        return {context, page, channelsPage, systemConsolePage, scheduledDraftPage, draftPage};\n    }\n\n    async close() {\n        if (this.context) {\n            await this.context.close();\n        }\n    }\n}\n\nexport async function loginByAPI(loginId: string, password: string, token = '', ldapOnly = false) {\n    const requestContext = await request.newContext();\n\n    const data: any = {\n        login_id: loginId,\n        password,\n        token,\n        deviceId: '',\n    };\n\n    if (ldapOnly) {\n        data.ldap_only = 'true';\n    }\n\n    // Log in via API\n    await requestContext.post(`${testConfig.baseURL}/api/v4/users/login`, {\n        data,\n        headers: {'X-Requested-With': 'XMLHttpRequest'},\n    });\n\n    // Save signed-in state to a folder\n    const storagePath = `storage_state/${Date.now()}_${loginId}_${password}${token ? '_' + token : ''}${\n        ldapOnly ? '_ldap' : ''\n    }.json`;\n    const storageState = await requestContext.storageState({path: storagePath});\n    await requestContext.dispose();\n\n    // Append origins to bypass seeing landing page then write to file\n    storageState.origins.push({\n        origin: testConfig.baseURL,\n        localStorage: [{name: '__landingPageSeen__', value: 'true'}],\n    });\n    await writeFile(storagePath, JSON.stringify(storageState));\n\n    return storagePath;\n}\n"],"names":["pages","request","testConfig","writeFile"],"mappings":";;;;;;;AAAA;AACA;MAUa,WAAW,CAAA;AACX,IAAA,OAAO;AAChB,IAAA,OAAO;AAEP,IAAA,WAAA,CAAY,OAAgB,EAAA;AACxB,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO;AACtB,QAAA,IAAI,CAAC,OAAO,GAAG,IAAI;;IAGvB,MAAM,KAAK,CAAC,IAAiB,EAAA;AACzB,QAAA,MAAM,OAAO,GAAG,EAAC,YAAY,EAAE,EAAE,EAAC;QAClC,IAAI,IAAI,EAAE;;AAEN,YAAA,MAAM,WAAW,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;AAClE,YAAA,OAAO,CAAC,YAAY,GAAG,WAAW;;;QAItC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC;AACtD,QAAA,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE;QAEpC,MAAM,YAAY,GAAG,IAAIA,WAAK,CAAC,YAAY,CAAC,IAAI,CAAC;QACjD,MAAM,iBAAiB,GAAG,IAAIA,WAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC;QAC3D,MAAM,kBAAkB,GAAG,IAAIA,WAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC;QAC7D,MAAM,SAAS,GAAG,IAAIA,WAAK,CAAC,SAAS,CAAC,IAAI,CAAC;AAE3C,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO;AAEtB,QAAA,OAAO,EAAC,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,SAAS,EAAC;;AAG1F,IAAA,MAAM,KAAK,GAAA;AACP,QAAA,IAAI,IAAI,CAAC,OAAO,EAAE;AACd,YAAA,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;;;AAGrC;AAEM,eAAe,UAAU,CAAC,OAAe,EAAE,QAAgB,EAAE,KAAK,GAAG,EAAE,EAAE,QAAQ,GAAG,KAAK,EAAA;AAC5F,IAAA,MAAM,cAAc,GAAG,MAAMC,YAAO,CAAC,UAAU,EAAE;AAEjD,IAAA,MAAM,IAAI,GAAQ;AACd,QAAA,QAAQ,EAAE,OAAO;QACjB,QAAQ;QACR,KAAK;AACL,QAAA,QAAQ,EAAE,EAAE;KACf;IAED,IAAI,QAAQ,EAAE;AACV,QAAA,IAAI,CAAC,SAAS,GAAG,MAAM;;;IAI3B,MAAM,cAAc,CAAC,IAAI,CAAC,GAAGC,sBAAU,CAAC,OAAO,CAAA,mBAAA,CAAqB,EAAE;QAClE,IAAI;AACJ,QAAA,OAAO,EAAE,EAAC,kBAAkB,EAAE,gBAAgB,EAAC;AAClD,KAAA,CAAC;;AAGF,IAAA,MAAM,WAAW,GAAG,CAAiB,cAAA,EAAA,IAAI,CAAC,GAAG,EAAE,CAAI,CAAA,EAAA,OAAO,IAAI,QAAQ,CAAA,EAAG,KAAK,GAAG,GAAG,GAAG,KAAK,GAAG,EAAE,GAC7F,QAAQ,GAAG,OAAO,GAAG,EACzB,OAAO;AACP,IAAA,MAAM,YAAY,GAAG,MAAM,cAAc,CAAC,YAAY,CAAC,EAAC,IAAI,EAAE,WAAW,EAAC,CAAC;AAC3E,IAAA,MAAM,cAAc,CAAC,OAAO,EAAE;;AAG9B,IAAA,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC;QACtB,MAAM,EAAEA,sBAAU,CAAC,OAAO;QAC1B,YAAY,EAAE,CAAC,EAAC,IAAI,EAAE,qBAAqB,EAAE,KAAK,EAAE,MAAM,EAAC,CAAC;AAC/D,KAAA,CAAC;IACF,MAAMC,kBAAS,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;AAE1D,IAAA,OAAO,WAAW;AACtB;;;;;"}

package/dist/constant.d.ts

@@ -0,0 +1,3 @@
+export declare const appsPluginId = "com.mattermost.apps";
+export declare const callsPluginId = "com.mattermost.calls";
+export declare const playbooksPluginId = "playbooks";

package/dist/constant.js

@@ -0,0 +1,8 @@
+'use strict';
+
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+const callsPluginId = 'com.mattermost.calls';
+
+exports.callsPluginId = callsPluginId;
+//# sourceMappingURL=constant.js.map

package/dist/constant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constant.js","sources":["../src/constant.ts"],"sourcesContent":["// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.\n// See LICENSE.txt for license information.\n\nexport const appsPluginId = 'com.mattermost.apps';\nexport const callsPluginId = 'com.mattermost.calls';\nexport const playbooksPluginId = 'playbooks';\n"],"names":[],"mappings":";;AAAA;AACA;AAGO,MAAM,aAAa,GAAG;;;;"}

package/dist/file.d.ts

@@ -0,0 +1,42 @@
+export declare const assetPath: string;
+declare const availableFiles: readonly ["mattermost-icon_128x128.png"];
+type AvailableFilename = (typeof availableFiles)[number];
+/**
+ * Reads file data and creates a File object.
+ * @param filePath - The path to the file.
+ * @returns A File object containing the file data.
+ * @throws If the file does not exist.
+ */
+export declare function getFileData(filePath: string): File;
+/**
+ * Reads file data and creates a Blob object.
+ * @param filePath - The path to the file.
+ * @returns A Blob object containing the file data.
+ * @throws If the file does not exist.
+ */
+export declare function getBlobData(filePath: string): Blob;
+/**
+ * Reads file data from the "asset" directory and creates a File object.
+ * @param filename - The name of the file in the "asset" directory.
+ * @returns An object containing a File object
+ */
+export declare function getFileFromAsset(filename: string): File;
+/**
+ * Reads file data from the "asset" directory and creates a Blob object.
+ * @param filename - The name of the file in the "asset" directory.
+ * @returns An object containing a Blob object
+ */
+export declare function getBlobFromAsset(filename: string): Blob;
+/**
+ * Reads file data from the lib "asset" directory and creates a File object.
+ * @param filename - The name of the file in the "asset" directory.
+ * @returns An object containing a File object
+ */
+export declare function getFileFromCommonAsset(filename: AvailableFilename): File;
+/**
+ * Reads file data from the lib "asset" directory and creates a Blob object.
+ * @param filename - The name of the file in the "asset" directory.
+ * @returns An object containing a Blob object
+ */
+export declare function getBlobFromCommonAsset(filename: AvailableFilename): Blob;
+export {};

package/dist/file.js

@@ -0,0 +1,74 @@
+'use strict';
+
+var path = require('node:path');
+var fs = require('node:fs');
+var mime = require('mime-types');
+
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+const commonAssetPath = path.resolve(__dirname, 'asset');
+const assetPath = path.resolve(process.cwd(), 'asset');
+/**
+ * Reads file data and creates a File object.
+ * @param filePath - The path to the file.
+ * @returns A File object containing the file data.
+ * @throws If the file does not exist.
+ */
+function getFileData(filePath) {
+    if (!fs.existsSync(filePath)) {
+        throw new Error(`File not found at path: ${filePath}`);
+    }
+    const mimeType = mime.lookup(filePath) || undefined;
+    const fileName = path.basename(filePath);
+    const fileBuffer = fs.readFileSync(filePath);
+    return new File([fileBuffer], fileName, { type: mimeType });
+}
+/**
+ * Reads file data and creates a Blob object.
+ * @param filePath - The path to the file.
+ * @returns A Blob object containing the file data.
+ * @throws If the file does not exist.
+ */
+function getBlobData(filePath) {
+    if (!fs.existsSync(filePath)) {
+        throw new Error(`File not found at path: ${filePath}`);
+    }
+    const mimeType = mime.lookup(filePath) || undefined;
+    const fileBuffer = fs.readFileSync(filePath);
+    return new Blob([fileBuffer], { type: mimeType });
+}
+/**
+ * Reads file data from the "asset" directory and creates a File object.
+ * @param filename - The name of the file in the "asset" directory.
+ * @returns An object containing a File object
+ */
+function getFileFromAsset(filename) {
+    const filePath = path.join(assetPath, filename);
+    return getFileData(filePath);
+}
+/**
+ * Reads file data from the "asset" directory and creates a Blob object.
+ * @param filename - The name of the file in the "asset" directory.
+ * @returns An object containing a Blob object
+ */
+function getBlobFromAsset(filename) {
+    const filePath = path.join(assetPath, filename);
+    return getBlobData(filePath);
+}
+/**
+ * Reads file data from the lib "asset" directory and creates a File object.
+ * @param filename - The name of the file in the "asset" directory.
+ * @returns An object containing a File object
+ */
+function getFileFromCommonAsset(filename) {
+    const filePath = path.join(commonAssetPath, filename);
+    return getFileData(filePath);
+}
+
+exports.assetPath = assetPath;
+exports.getBlobData = getBlobData;
+exports.getBlobFromAsset = getBlobFromAsset;
+exports.getFileData = getFileData;
+exports.getFileFromAsset = getFileFromAsset;
+exports.getFileFromCommonAsset = getFileFromCommonAsset;
+//# sourceMappingURL=file.js.map

package/dist/file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.js","sources":["../src/file.ts"],"sourcesContent":["// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.\n// See LICENSE.txt for license information.\n\nimport path from 'node:path';\nimport fs from 'node:fs';\n\nimport mime from 'mime-types';\n\nconst commonAssetPath = path.resolve(__dirname, 'asset');\nexport const assetPath = path.resolve(process.cwd(), 'asset');\n\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nconst availableFiles = ['mattermost-icon_128x128.png'] as const;\ntype AvailableFilename = (typeof availableFiles)[number];\n\n/**\n * Reads file data and creates a File object.\n * @param filePath - The path to the file.\n * @returns A File object containing the file data.\n * @throws If the file does not exist.\n */\nexport function getFileData(filePath: string): File {\n    if (!fs.existsSync(filePath)) {\n        throw new Error(`File not found at path: ${filePath}`);\n    }\n\n    const mimeType = mime.lookup(filePath) || undefined;\n    const fileName = path.basename(filePath);\n    const fileBuffer = fs.readFileSync(filePath);\n\n    return new File([fileBuffer], fileName, {type: mimeType});\n}\n\n/**\n * Reads file data and creates a Blob object.\n * @param filePath - The path to the file.\n * @returns A Blob object containing the file data.\n * @throws If the file does not exist.\n */\nexport function getBlobData(filePath: string): Blob {\n    if (!fs.existsSync(filePath)) {\n        throw new Error(`File not found at path: ${filePath}`);\n    }\n\n    const mimeType = mime.lookup(filePath) || undefined;\n    const fileBuffer = fs.readFileSync(filePath);\n\n    return new Blob([fileBuffer], {type: mimeType});\n}\n\n/**\n * Reads file data from the \"asset\" directory and creates a File object.\n * @param filename - The name of the file in the \"asset\" directory.\n * @returns An object containing a File object\n */\nexport function getFileFromAsset(filename: string) {\n    const filePath = path.join(assetPath, filename);\n\n    return getFileData(filePath);\n}\n\n/**\n * Reads file data from the \"asset\" directory and creates a Blob object.\n * @param filename - The name of the file in the \"asset\" directory.\n * @returns An object containing a Blob object\n */\nexport function getBlobFromAsset(filename: string) {\n    const filePath = path.join(assetPath, filename);\n\n    return getBlobData(filePath);\n}\n\n/**\n * Reads file data from the lib \"asset\" directory and creates a File object.\n * @param filename - The name of the file in the \"asset\" directory.\n * @returns An object containing a File object\n */\nexport function getFileFromCommonAsset(filename: AvailableFilename) {\n    const filePath = path.join(commonAssetPath, filename);\n\n    return getFileData(filePath);\n}\n\n/**\n * Reads file data from the lib \"asset\" directory and creates a Blob object.\n * @param filename - The name of the file in the \"asset\" directory.\n * @returns An object containing a Blob object\n */\nexport function getBlobFromCommonAsset(filename: AvailableFilename) {\n    const filePath = path.join(commonAssetPath, filename);\n\n    return getBlobData(filePath);\n}\n"],"names":[],"mappings":";;;;;;AAAA;AACA;AAOA,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC;AACjD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO;AAM5D;;;;;AAKG;AACG,SAAU,WAAW,CAAC,QAAgB,EAAA;IACxC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;AAC1B,QAAA,MAAM,IAAI,KAAK,CAAC,2BAA2B,QAAQ,CAAA,CAAE,CAAC;;IAG1D,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAS;IACnD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACxC,MAAM,UAAU,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC;AAE5C,IAAA,OAAO,IAAI,IAAI,CAAC,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC,CAAC;AAC7D;AAEA;;;;;AAKG;AACG,SAAU,WAAW,CAAC,QAAgB,EAAA;IACxC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;AAC1B,QAAA,MAAM,IAAI,KAAK,CAAC,2BAA2B,QAAQ,CAAA,CAAE,CAAC;;IAG1D,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAS;IACnD,MAAM,UAAU,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC;AAE5C,IAAA,OAAO,IAAI,IAAI,CAAC,CAAC,UAAU,CAAC,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC,CAAC;AACnD;AAEA;;;;AAIG;AACG,SAAU,gBAAgB,CAAC,QAAgB,EAAA;IAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC;AAE/C,IAAA,OAAO,WAAW,CAAC,QAAQ,CAAC;AAChC;AAEA;;;;AAIG;AACG,SAAU,gBAAgB,CAAC,QAAgB,EAAA;IAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC;AAE/C,IAAA,OAAO,WAAW,CAAC,QAAQ,CAAC;AAChC;AAEA;;;;AAIG;AACG,SAAU,sBAAsB,CAAC,QAA2B,EAAA;IAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC;AAErD,IAAA,OAAO,WAAW,CAAC,QAAQ,CAAC;AAChC;;;;;;;;;"}

package/dist/flag.d.ts

@@ -0,0 +1,7 @@
+export declare function shouldHaveCallsEnabled(enabled?: boolean): Promise<void>;
+export declare function shouldHaveFeatureFlag(name: string, value: string | boolean): Promise<void>;
+export declare function shouldRunInLinux(): Promise<void>;
+export declare function ensureLicense(): Promise<void>;
+export declare function requestTrialLicense(): Promise<void>;
+export declare function skipIfNoLicense(): Promise<void>;
+export declare function skipIfFeatureFlagNotSet(name: string, value: string | boolean): Promise<void>;

package/dist/flag.js

@@ -0,0 +1,76 @@
+'use strict';
+
+var os = require('node:os');
+var test = require('@playwright/test');
+var constant = require('./constant.js');
+var init = require('./server/init.js');
+
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+async function shouldHaveCallsEnabled(enabled = true) {
+    const { adminClient } = await init.getAdminClient();
+    const config = await adminClient.getConfig();
+    const callsEnabled = config.PluginSettings.PluginStates[constant.callsPluginId].Enable;
+    const matched = callsEnabled === enabled;
+    test.expect(matched, matched ? '' : `Calls expect "${enabled}" but actual "${callsEnabled}"`).toBeTruthy();
+}
+async function shouldHaveFeatureFlag(name, value) {
+    const { adminClient } = await init.getAdminClient();
+    const config = await adminClient.getConfig();
+    const matched = config.FeatureFlags[name] === value;
+    test.expect(matched, matched ? '' : `FeatureFlags["${name}'] expect "${value}" but actual "${config.FeatureFlags[name]}"`).toBeTruthy();
+}
+async function shouldRunInLinux() {
+    const platform = os.platform();
+    test.expect(platform, 'Run in Linux or Playwright docker image only').toBe('linux');
+}
+async function ensureLicense() {
+    const { adminClient } = await init.getAdminClient();
+    let license = await adminClient.getClientLicenseOld();
+    if (license?.IsLicensed !== 'true') {
+        const config = await adminClient.getClientConfigOld();
+        test.expect(config.ServiceEnvironment === 'dev', 'The trial license request fails in the local development environment. Please manually upload the test license.').toBeFalsy();
+        await requestTrialLicense();
+        license = await adminClient.getClientLicenseOld();
+    }
+    test.expect(license?.IsLicensed === 'true', 'Ensure server has license').toBeTruthy();
+}
+async function requestTrialLicense() {
+    const { adminClient } = await init.getAdminClient();
+    const admin = await adminClient.getMe();
+    try {
+        await adminClient.requestTrialLicense({
+            receive_emails_accepted: true,
+            terms_accepted: true,
+            users: 100,
+            contact_name: admin.first_name + ' ' + admin.last_name,
+            contact_email: admin.email,
+            company_name: 'Mattermost Playwright E2E Tests',
+            company_size: '101-250',
+            company_country: 'United States',
+        });
+    }
+    catch (error) {
+        test.expect(error, 'Failed to request trial license').toBeFalsy();
+        throw error;
+    }
+}
+async function skipIfNoLicense() {
+    const { adminClient } = await init.getAdminClient();
+    const license = await adminClient.getClientLicenseOld();
+    test.test.skip(license.IsLicensed === 'false', 'Skipping test - server not licensed');
+}
+async function skipIfFeatureFlagNotSet(name, value) {
+    const { adminClient } = await init.getAdminClient();
+    const cfg = await adminClient.getConfig();
+    test.test.skip(cfg.FeatureFlags[name] !== value, `Skipping test - Feature Flag ${name} needs to be set to ${value}`);
+}
+
+exports.ensureLicense = ensureLicense;
+exports.requestTrialLicense = requestTrialLicense;
+exports.shouldHaveCallsEnabled = shouldHaveCallsEnabled;
+exports.shouldHaveFeatureFlag = shouldHaveFeatureFlag;
+exports.shouldRunInLinux = shouldRunInLinux;
+exports.skipIfFeatureFlagNotSet = skipIfFeatureFlagNotSet;
+exports.skipIfNoLicense = skipIfNoLicense;
+//# sourceMappingURL=flag.js.map

package/dist/flag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flag.js","sources":["../src/flag.ts"],"sourcesContent":["// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.\n// See LICENSE.txt for license information.\n\nimport os from 'node:os';\n\nimport {expect, test} from '@playwright/test';\n\nimport {callsPluginId} from './constant';\nimport {getAdminClient} from './server/init';\n\nexport async function shouldHaveCallsEnabled(enabled = true) {\n    const {adminClient} = await getAdminClient();\n    const config = await adminClient.getConfig();\n\n    const callsEnabled = config.PluginSettings.PluginStates[callsPluginId].Enable;\n\n    const matched = callsEnabled === enabled;\n    expect(matched, matched ? '' : `Calls expect \"${enabled}\" but actual \"${callsEnabled}\"`).toBeTruthy();\n}\n\nexport async function shouldHaveFeatureFlag(name: string, value: string | boolean) {\n    const {adminClient} = await getAdminClient();\n    const config = await adminClient.getConfig();\n\n    const matched = config.FeatureFlags[name] === value;\n    expect(\n        matched,\n        matched ? '' : `FeatureFlags[\"${name}'] expect \"${value}\" but actual \"${config.FeatureFlags[name]}\"`,\n    ).toBeTruthy();\n}\n\nexport async function shouldRunInLinux() {\n    const platform = os.platform();\n    expect(platform, 'Run in Linux or Playwright docker image only').toBe('linux');\n}\n\nexport async function ensureLicense() {\n    const {adminClient} = await getAdminClient();\n    let license = await adminClient.getClientLicenseOld();\n\n    if (license?.IsLicensed !== 'true') {\n        const config = await adminClient.getClientConfigOld();\n        expect(\n            config.ServiceEnvironment === 'dev',\n            'The trial license request fails in the local development environment. Please manually upload the test license.',\n        ).toBeFalsy();\n\n        await requestTrialLicense();\n\n        license = await adminClient.getClientLicenseOld();\n    }\n\n    expect(license?.IsLicensed === 'true', 'Ensure server has license').toBeTruthy();\n}\n\nexport async function requestTrialLicense() {\n    const {adminClient} = await getAdminClient();\n    const admin = await adminClient.getMe();\n    try {\n        await adminClient.requestTrialLicense({\n            receive_emails_accepted: true,\n            terms_accepted: true,\n            users: 100,\n            contact_name: admin.first_name + ' ' + admin.last_name,\n            contact_email: admin.email,\n            company_name: 'Mattermost Playwright E2E Tests',\n            company_size: '101-250',\n            company_country: 'United States',\n        });\n    } catch (error) {\n        expect(error, 'Failed to request trial license').toBeFalsy();\n        throw error;\n    }\n}\n\nexport async function skipIfNoLicense() {\n    const {adminClient} = await getAdminClient();\n    const license = await adminClient.getClientLicenseOld();\n\n    test.skip(license.IsLicensed === 'false', 'Skipping test - server not licensed');\n}\n\nexport async function skipIfFeatureFlagNotSet(name: string, value: string | boolean) {\n    const {adminClient} = await getAdminClient();\n    const cfg = await adminClient.getConfig();\n\n    test.skip(cfg.FeatureFlags[name] !== value, `Skipping test - Feature Flag ${name} needs to be set to ${value}`);\n}\n"],"names":["getAdminClient","callsPluginId","expect","test"],"mappings":";;;;;;;AAAA;AACA;AASO,eAAe,sBAAsB,CAAC,OAAO,GAAG,IAAI,EAAA;AACvD,IAAA,MAAM,EAAC,WAAW,EAAC,GAAG,MAAMA,mBAAc,EAAE;AAC5C,IAAA,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,SAAS,EAAE;AAE5C,IAAA,MAAM,YAAY,GAAG,MAAM,CAAC,cAAc,CAAC,YAAY,CAACC,sBAAa,CAAC,CAAC,MAAM;AAE7E,IAAA,MAAM,OAAO,GAAG,YAAY,KAAK,OAAO;IACxCC,WAAM,CAAC,OAAO,EAAE,OAAO,GAAG,EAAE,GAAG,CAAiB,cAAA,EAAA,OAAO,iBAAiB,YAAY,CAAA,CAAA,CAAG,CAAC,CAAC,UAAU,EAAE;AACzG;AAEO,eAAe,qBAAqB,CAAC,IAAY,EAAE,KAAuB,EAAA;AAC7E,IAAA,MAAM,EAAC,WAAW,EAAC,GAAG,MAAMF,mBAAc,EAAE;AAC5C,IAAA,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,SAAS,EAAE;IAE5C,MAAM,OAAO,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,KAAK;IACnDE,WAAM,CACF,OAAO,EACP,OAAO,GAAG,EAAE,GAAG,CAAiB,cAAA,EAAA,IAAI,CAAc,WAAA,EAAA,KAAK,CAAiB,cAAA,EAAA,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA,CAAA,CAAG,CACvG,CAAC,UAAU,EAAE;AAClB;AAEO,eAAe,gBAAgB,GAAA;AAClC,IAAA,MAAM,QAAQ,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC9BA,WAAM,CAAC,QAAQ,EAAE,8CAA8C,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;AAClF;AAEO,eAAe,aAAa,GAAA;AAC/B,IAAA,MAAM,EAAC,WAAW,EAAC,GAAG,MAAMF,mBAAc,EAAE;AAC5C,IAAA,IAAI,OAAO,GAAG,MAAM,WAAW,CAAC,mBAAmB,EAAE;AAErD,IAAA,IAAI,OAAO,EAAE,UAAU,KAAK,MAAM,EAAE;AAChC,QAAA,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,kBAAkB,EAAE;AACrD,QAAAE,WAAM,CACF,MAAM,CAAC,kBAAkB,KAAK,KAAK,EACnC,gHAAgH,CACnH,CAAC,SAAS,EAAE;QAEb,MAAM,mBAAmB,EAAE;AAE3B,QAAA,OAAO,GAAG,MAAM,WAAW,CAAC,mBAAmB,EAAE;;AAGrD,IAAAA,WAAM,CAAC,OAAO,EAAE,UAAU,KAAK,MAAM,EAAE,2BAA2B,CAAC,CAAC,UAAU,EAAE;AACpF;AAEO,eAAe,mBAAmB,GAAA;AACrC,IAAA,MAAM,EAAC,WAAW,EAAC,GAAG,MAAMF,mBAAc,EAAE;AAC5C,IAAA,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,KAAK,EAAE;AACvC,IAAA,IAAI;QACA,MAAM,WAAW,CAAC,mBAAmB,CAAC;AAClC,YAAA,uBAAuB,EAAE,IAAI;AAC7B,YAAA,cAAc,EAAE,IAAI;AACpB,YAAA,KAAK,EAAE,GAAG;YACV,YAAY,EAAE,KAAK,CAAC,UAAU,GAAG,GAAG,GAAG,KAAK,CAAC,SAAS;YACtD,aAAa,EAAE,KAAK,CAAC,KAAK;AAC1B,YAAA,YAAY,EAAE,iCAAiC;AAC/C,YAAA,YAAY,EAAE,SAAS;AACvB,YAAA,eAAe,EAAE,eAAe;AACnC,SAAA,CAAC;;IACJ,OAAO,KAAK,EAAE;QACZE,WAAM,CAAC,KAAK,EAAE,iCAAiC,CAAC,CAAC,SAAS,EAAE;AAC5D,QAAA,MAAM,KAAK;;AAEnB;AAEO,eAAe,eAAe,GAAA;AACjC,IAAA,MAAM,EAAC,WAAW,EAAC,GAAG,MAAMF,mBAAc,EAAE;AAC5C,IAAA,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,mBAAmB,EAAE;IAEvDG,SAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,KAAK,OAAO,EAAE,qCAAqC,CAAC;AACpF;AAEO,eAAe,uBAAuB,CAAC,IAAY,EAAE,KAAuB,EAAA;AAC/E,IAAA,MAAM,EAAC,WAAW,EAAC,GAAG,MAAMH,mBAAc,EAAE;AAC5C,IAAA,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,SAAS,EAAE;AAEzC,IAAAG,SAAI,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,KAAK,EAAE,CAAgC,6BAAA,EAAA,IAAI,uBAAuB,KAAK,CAAA,CAAE,CAAC;AACnH;;;;;;;;;;"}

package/dist/global_setup.d.ts

@@ -0,0 +1,3 @@
+import { Client4 } from '@mattermost/client';
+export declare function baseGlobalSetup(): Promise<void>;
+export declare function ensurePluginsLoaded(client: Client4): Promise<void>;