Playwright Initial Setup

example_plugin_tests/.github/workflows/playwright.yml → .github/workflows/playwright.yml

@@ -3,7 +3,8 @@ on:
   push:
     branches: [ main, master ]
   pull_request:
-    branches: [ main, master ]
+  workflow_dispatch:
+
 jobs:
   test:
     timeout-minutes: 60
@@ -13,15 +14,20 @@ jobs:
     - uses: actions/setup-node@v4
       with:
         node-version: lts/*
-    - name: Install dependencies
+    - 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: npx playwright test
+      run: npm run test
+      working-directory: example_plugin_tests/
     - uses: actions/upload-artifact@v4
       if: always()
       with:
         name: playwright-report
-        path: playwright-report/
+        path: example_plugin_tests/playwright-report/
         retention-days: 30

.nvmrc

@@ -1 +1 @@
-20.11
+16.20

.vscode/settings.json

@@ -1,8 +1,5 @@
 {
-  "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": "always"
-  },
   "eslint.validate": ["javascript"],
   "files.insertFinalNewline": true,
   "files.trimFinalNewlines": true,
-}
+}

example_plugin_tests/playwright.config.ts

@@ -27,6 +27,9 @@ export default defineConfig({
     /* 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: {
 

example_plugin_tests/tests/example.spec.ts

@@ -10,7 +10,7 @@ type DemoPluginConfig = {
     clientId: string
 }
 
-const DEMO_PLUGIN_EXTERNAL_URL = 'https://github.com/mattermost/mattermost-plugin-demo/releases/download/v0.10.0/com.mattermost.demo-plugin-0.10.0.tar.gz';
+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>;
@@ -26,6 +26,7 @@ test.beforeAll(async () => {
 
     mattermost = await new MattermostContainer().
         withPlugin(demoPluginInstance).
+        withEnv('MM_FILESETTINGS_ENABLEPUBLICLINK', 'true').
         startWithUserSetup();
 });
 
@@ -40,4 +41,23 @@ test.describe('example test', () => {
         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);
+    });
 });

src/mattermostcontainer.ts

@@ -118,14 +118,14 @@ export default class MattermostContainer {
         await this.container.copyFilesToContainer([{source: plugin.path, target: '/tmp/plugin.tar.gz'}]);
         await this.container.copyContentToContainer([{content: patch, target: '/tmp/plugin.config.json'}]);
 
-        await this.container.exec(['mmctl', '--local', 'plugin', 'add', '/tmp/plugin.tar.gz']);
+        await this.container.exec(['mmctl', '--local', '--force', 'plugin', 'add', '/tmp/plugin.tar.gz']);
         await this.container.exec(['mmctl', '--local', 'config', 'patch', '/tmp/plugin.config.json']);
         await this.container.exec(['mmctl', '--local', 'plugin', 'enable', pluginId]);
     };
 
     installPluginFromUrl = async (plugin: MattermostPlugin<unknown>) => {
         const client = await this.getAdminClient();
-        const manifest = await client.installPluginFromUrl(plugin.path);
+        const manifest = await client.installPluginFromUrl(plugin.path, true);
         await this.container.exec(['mmctl', '--local', 'plugin', 'enable', manifest.id]);
     };