2023-01-30 17:16:10 +02:00 · 2023-01-30 17:16:10 +02:00 · 2bb622c314
parent bbb29a0d1b
commit 2bb622c314
11 changed files with 255 additions and 13 deletions
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@ -608,7 +608,6 @@ workflows:
              ignore:
                - /^build-pr-.*/
                - nightly
-
      - build-win-no-installer:
          filters:
            branches:
--- a/.github/workflows/e2e-performance.yml
+++ b/.github/workflows/e2e-performance.yml
@ -0,0 +1,93 @@
+name: E2E Performance Tests (Desktop)
+
+on:
+  pull_request:
+    branches: [ master ]
+    types:
+        - labeled
+
+env:
+    RESULTS_PATH: e2e/performance/perf-test-report.json
+
+jobs:
+  build:
+    if: ${{ github.event.label.name == 'Run E2E Performance Tests' }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node-version: [16]
+
+    steps:
+
+    - name: Add start comment
+      uses: actions/github-script@v6
+      with:
+        script: |
+            github.rest.issues.createComment({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                body: `E2E Performance Tests started 🏎️`,
+            });
+
+    - name: Set env variable for timestamp
+      run: echo "NOW=$(date +'%Y-%m-%dT%H:%M:%S')" >> $GITHUB_ENV
+
+    - uses: actions/checkout@v2
+
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+
+    - name: Install packages
+      run: sudo apt-get install libxtst-dev libpng++-dev
+
+    - name: Install dependencies 👨🏻‍💻
+      run: npm ci
+
+    - name: E2E Performance Tests for Electron 🧪
+      run: ELECTRON_DISABLE_SANDBOX=1 xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- npm run test:e2e:performance
+
+    - name: Upload artifact to Github
+      uses: actions/upload-artifact@v3
+      with:
+        name: perf-test-report.json
+        path: ${{ env.RESULTS_PATH }}
+        if-no-files-found: error
+        retention-days: 14
+
+    - name: Configure AWS credentials
+      uses: aws-actions/configure-aws-credentials@v1
+      with:
+        aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_PERFORMANCE_TESTS_PUT_BUCKET }}
+        aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY_PERFORMANCE_TESTS_PUT_BUCKET }}
+        aws-region: ${{ secrets.AWS_REGION_PERFORMANCE_TESTS_PUT_BUCKET }}
+        mask-aws-account-id: true
+
+    - name: Upload report to S3
+      run: aws s3 cp ${{ env.RESULTS_PATH }} s3://${{ secrets.AWS_BUCKET_PERFORMANCE_TESTS }}/${{ github.head_ref }}-${{ github.sha }}-${{ env.NOW }}.json
+
+    - name: Add results in PR comment
+      uses: actions/github-script@v6
+      with:
+        script: |
+            const fs = require('fs');
+            const {generateCommentBody} = require('./e2e/utils/pr-e2e-durations-report.js');
+            const fileContents = fs.readFileSync('${{ env.RESULTS_PATH }}');
+            github.rest.issues.createComment({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                body: generateCommentBody(fileContents),
+            });
+
+    - name: Remove "Run E2E Performance Tests" label
+      if: always()
+      uses: actions-ecosystem/action-remove-labels@v1
+      with:
+          labels: |
+            Run E2E Performance Tests
--- a/.gitignore
+++ b/.gitignore
@ -13,6 +13,7 @@ dist/
 mochawesome-report/

 test-results.xml
+/e2e/performance/perf-test-report.json
 test_config.json
 .idea
 testUserData
--- a/.vscode/launch.json
+++ b/.vscode/launch.json
@ -49,6 +49,23 @@
            "internalConsoleOptions": "openOnSessionStart",
            "preLaunchTask": "prepare-e2e"
        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "E2E Performance Tests",
+            "program": "${workspaceRoot}/node_modules/electron-mocha/bin/electron-mocha",
+            "args": [
+                "-r",
+                "@babel/register",
+                "--recursive",
+                "--timeout",
+                "999999",
+                "--colors",
+                "${workspaceRoot}/dist/tests/e2e_bundle.js"
+            ],
+            "internalConsoleOptions": "openOnSessionStart",
+            "preLaunchTask": "prepare-e2e-performance",
+        },
        {
            "type": "node",
            "request": "launch",
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@ -24,6 +24,7 @@
        "gsettings",
        "ICONNAME",
        "inputflash",
+        "libxtst",
        "loadscreen",
        "mailhost",
        "mailserver",
@ -37,6 +38,7 @@
        "officedocument",
        "openxmlformats",
        "presentationml",
+        "servernum",
        "showunreadbadge",
        "spreadsheetml",
        "textbox",
@ -45,6 +47,7 @@
        "Unreads",
        "webcontents",
        "wordprocessingml",
+        "xvfb",
        "Yuya"
    ],
    "i18n-ally.keystyle": "nested"
--- a/.vscode/tasks.json
+++ b/.vscode/tasks.json
@ -14,6 +14,12 @@
            "type": "shell",
            "command": "npm run build; npm run build-robotjs; npm run test:e2e:build",
            "problemMatcher": []
+        },
+        {
+            "label": "prepare-e2e-performance",
+            "type": "shell",
+            "command": "cross-env NODE_ENV=test PERFORMANCE=true npm run build; npm run build-robotjs; npm run test:e2e:build-performance",
+            "problemMatcher": []
        }
    ]
 }
--- a/e2e/performance/app.test.js
+++ b/e2e/performance/app.test.js
@ -0,0 +1,29 @@
+// Copyright (c) 2016-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+'use strict';
+
+const env = require('../modules/environment');
+
+describe('startup/app', function desc() {
+    this.timeout(30000);
+
+    beforeEach(async () => {
+        env.createTestUserDataDir();
+        env.cleanTestConfig();
+        this.app = await env.getApp();
+    });
+
+    afterEach(async () => {
+        if (this.app) {
+            await this.app.close();
+        }
+        await env.clearElectronInstances();
+    });
+
+    it('should show the welcome screen modal when no servers exist', async () => {
+        const welcomeScreenModal = this.app.windows().find((window) => window.url().includes('welcomeScreen'));
+        const modalButton = await welcomeScreenModal.innerText('.WelcomeScreen .WelcomeScreen__button');
+        modalButton.should.equal('Get Started');
+    });
+});
--- a/e2e/utils/constants.js
+++ b/e2e/utils/constants.js
@ -2,7 +2,9 @@
 // See LICENSE.txt for license information.

 const MOCHAWESOME_REPORT_DIR = './mochawesome-report';
+const PERFORMANCE_REPORT_DIR = './e2e/performance';

 module.exports = {
    MOCHAWESOME_REPORT_DIR,
+    PERFORMANCE_REPORT_DIR,
 };
--- a/e2e/utils/pr-e2e-durations-report.js
+++ b/e2e/utils/pr-e2e-durations-report.js
@ -0,0 +1,36 @@
+// Copyright (c) 2016-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+function generateCommentBody(fileContents) {
+    const data = JSON.parse(fileContents);
+
+    return `
+E2E Performance Test results:
+
+| Test | Duration |
+| --- | --- |
+${data?.passes?.reduce((acc, pass) => {
+        return `${acc}| ${pass.fullTitle || 'title'} | ${pass.duration}ms |\n`;
+    }, '')
+}
+
+${data?.failures?.length > 0 ? `
+    Some tests failed:
+    | Test | Duration |
+    | --- | --- |
+    ${data.failures.forEach((failure) => `| ${failure.fullTitle} | ${failure.duration}`)}
+` : ''}
+
+<details>
+<summary>Raw results</summary>
+
+\`\`\`js
+${fileContents}
+\`\`\`
+</details>
+`;
+}
+
+module.exports = {
+    generateCommentBody,
+};
--- a/package.json
+++ b/package.json
@ -42,8 +42,11 @@
    "test": "npm-run-all lint:js test:unit test:e2e",
    "test:docker": "node scripts/setup_e2e_docker.js",
    "test:e2e": "cross-env NODE_ENV=test npm-run-all build build-robotjs test:e2e:build test:e2e:run",
+    "test:e2e:performance": "cross-env NODE_ENV=test PERFORMANCE=true npm-run-all build build-robotjs test:e2e:build-performance test:e2e:run-performance",
    "test:e2e:nobuild": "cross-env NODE_ENV=test npm-run-all test:e2e:build test:e2e:run",
    "test:e2e:build": "webpack-cli --config webpack.config.test.js",
+    "test:e2e:build-performance": "webpack-cli --config webpack.config.performance.test.js",
+    "test:e2e:run-performance": "electron-mocha -r @babel/register --reporter json --reporter-option output=./e2e/performance/perf-test-report.json dist/tests/e2e_bundle.js",
    "test:e2e:run": "electron-mocha -r @babel/register --reporter mochawesome dist/tests/e2e_bundle.js",
    "test:e2e:send-report": "node ./e2e/save_report.js",
    "test:unit": "cross-env NODE_ENV=jest jest",
--- a/webpack.config.performance.test.js
+++ b/webpack.config.performance.test.js
@ -0,0 +1,53 @@
+// Copyright (c) 2016-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+// This file uses CommonJS.
+/* eslint-disable import/no-commonjs */
+'use strict';
+
+const path = require('path');
+
+const glob = require('glob');
+const {merge} = require('webpack-merge');
+
+const base = require('./webpack.config.base');
+
+const WEBSERVER_PORT = process.env.WEBSERVER_PORT ?? 9001;
+
+module.exports = merge(base, {
+    entry: {
+        e2e: glob.sync('./e2e/performance/**/*.test.js'),
+    },
+    output: {
+        path: path.resolve(__dirname, 'dist/tests'),
+        filename: '[name]_bundle.js',
+    },
+    module: {
+        rules: [{
+            test: /\.(js|jsx|ts|tsx)?$/,
+            use: ['babel-loader', 'shebang-loader'],
+        }],
+    },
+    externals: {
+        fs: 'require("fs")',
+        ws: 'require("ws")',
+        child_process: 'require("child_process")',
+        dns: 'require("dns")',
+        http2: 'require("http2")',
+        net: 'require("net")',
+        repl: 'require("repl")',
+        tls: 'require("tls")',
+        playwright: 'require("playwright")',
+        robotjs: 'require("robotjs")',
+    },
+    node: {
+        __filename: false,
+        __dirname: false,
+    },
+    devServer: {
+        port: WEBSERVER_PORT,
+    },
+    target: 'electron-main',
+});
+
+/* eslint-enable import/no-commonjs */