Playwright Initial Setup

.github/workflows/playwright.yml

@@ -0,0 +1,33 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+    - name: Install root dependencies
+      run: npm ci
+    - name: Install tests dependencies
+      run: npm ci
+      working-directory: example_plugin_tests/
+    - name: Install Playwright Browsers
+      run: npx playwright install --with-deps
+      working-directory: example_plugin_tests/
+    - name: Run Playwright tests
+      run: npm run test
+      working-directory: example_plugin_tests/
+    - uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: playwright-report
+        path: example_plugin_tests/playwright-report/
+        retention-days: 30

.gitignore

@@ -0,0 +1,6 @@
+.eslintcache
+node_modules/
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

.nvmrc

@@ -0,0 +1 @@
+16.20

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "eslint.validate": ["javascript"],
+  "files.insertFinalNewline": true,
+  "files.trimFinalNewlines": true,
+}

example_plugin_tests/.gitignore

@@ -0,0 +1,5 @@
+node_modules/
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

example_plugin_tests/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "example_plugin_tests",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "playwright test",
+    "ui": "playwright test --ui"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "mattermost-plugin-e2e-test-utils": "file:..",
+    "@playwright/test": "^1.42.1",
+    "@types/node": "^20.11.24"
+  }
+}

example_plugin_tests/playwright.config.ts

@@ -0,0 +1,87 @@
+import {defineConfig, devices} from '@playwright/test';
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// require('dotenv').config();
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+    testDir: './tests',
+
+    /* Run tests in files in parallel */
+    fullyParallel: true,
+
+    /* Fail the build on CI if you accidentally left test.only in the source code. */
+    forbidOnly: Boolean(process.env.CI),
+
+    /* Retry on CI only */
+    retries: process.env.CI ? 2 : 0,
+
+    /* Opt out of parallel tests on CI. */
+    workers: process.env.CI ? 1 : undefined,
+
+    /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+    reporter: 'html',
+
+    /* More timeout since raising containers are costly  */
+    timeout: 50000,
+
+    /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+    use: {
+
+        /* Base URL to use in actions like `await page.goto('/')`. */
+        // baseURL: 'http://127.0.0.1:3000',
+
+        /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+        trace: 'on-first-retry',
+    },
+
+    /* Configure projects for major browsers */
+    projects: [
+        {
+            name: 'chromium',
+            use: {...devices['Desktop Chrome']},
+        },
+
+        {
+            name: 'firefox',
+            use: {...devices['Desktop Firefox']},
+        },
+
+        {
+            name: 'webkit',
+            use: {...devices['Desktop Safari']},
+        },
+
+        /* Test against mobile viewports. */
+        // {
+        //   name: 'Mobile Chrome',
+        //   use: { ...devices['Pixel 5'] },
+        // },
+        // {
+        //   name: 'Mobile Safari',
+        //   use: { ...devices['iPhone 12'] },
+        // },
+
+    /* Test against branded browsers. */
+    // {
+    //   name: 'Microsoft Edge',
+    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
+    // },
+    // {
+    //   name: 'Google Chrome',
+    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+    // },
+    ],
+
+    /* Run your local dev server before starting the tests */
+    // webServer: {
+    //   command: 'npm run start',
+    //   url: 'http://127.0.0.1:3000',
+    //   reuseExistingServer: !process.env.CI,
+    // },
+});

example_plugin_tests/tests/example.spec.ts

@@ -0,0 +1,63 @@
+import {test, expect} from '@playwright/test';
+import {
+    MattermostContainer,
+    MattermostPlugin,
+    login,
+    logout,
+} from 'mattermost-plugin-e2e-test-utils';
+
+type DemoPluginConfig = {
+    clientId: string
+}
+
+const DEMO_PLUGIN_EXTERNAL_URL = 'https://github.com/mattermost/mattermost-plugin-demo/releases/download/v0.10.1/com.mattermost.demo-plugin-0.10.1.tar.gz';
+
+let mattermost: MattermostContainer;
+let demoPluginInstance: MattermostPlugin<DemoPluginConfig>;
+
+test.beforeAll(async () => {
+    demoPluginInstance = new MattermostPlugin<DemoPluginConfig>({
+        pluginId: 'com.mattermost.demo-plugin',
+        pluginConfig: {
+            clientId: 'client-id',
+        },
+    }).
+        withExternalURL(DEMO_PLUGIN_EXTERNAL_URL);
+
+    mattermost = await new MattermostContainer().
+        withPlugin(demoPluginInstance).
+        withEnv('MM_FILESETTINGS_ENABLEPUBLICLINK', 'true').
+        startWithUserSetup();
+});
+
+test.afterAll(async () => {
+    await mattermost.stop();
+});
+
+test.describe('example test', () => {
+    test('check if the town square and plublic channel are created', async ({page}) => {
+        const url = mattermost.url();
+        await login(page, url, 'regularuser', 'regularuser');
+        await expect(page.getByLabel('town square public channel')).toBeVisible();
+        await logout(page);
+    });
+
+    test('open dialog and cancels it', async ({page}) => {
+        const url = mattermost.url();
+        await login(page, url, 'regularuser', 'regularuser');
+
+        await page.getByTestId('post_textbox').fill('/dialog');
+        await page.getByTestId('SendMessageButton').click();
+
+        await expect(page.getByText('Test Title')).toBeVisible();
+        await expect(page.getByTestId('realnamelabel')).toBeVisible();
+        await expect(page.getByTestId('someemaillabel')).toBeVisible();
+        await expect(page.getByTestId('somepasswordlabel')).toBeVisible();
+
+        await page.getByRole('button', {name: 'Cancel'}).click();
+
+        await expect(page.getByText('Test Title')).not.toBeVisible();
+
+        await logout(page);
+    });
+});