Add session tooling (WIP)

.env.sample

@@ -0,0 +1,4 @@
+SESSION_DESKTOP_ROOT="<path to session desktop root>"
+PLAYWRIGHT_REPEAT_COUNT=0
+PLAYWRIGHT_RETRIES_COUNT=0
+PLAYWRIGHT_WORKERS_COUNT=1

.eslintignore

@@ -1,2 +1,3 @@
 .eslintrc.js
 *.js
+tests/localization/*

.eslintrc.js

@@ -7,11 +7,11 @@ module.exports = {
     },
   },
 
-  extends: ['airbnb-base', 'prettier', 'plugin:@typescript-eslint/recommended'],
+  extends: ['airbnb-base', 'airbnb-typescript/base', 'prettier', 'plugin:@typescript-eslint/recommended'],
 
   plugins: ['mocha', 'more', '@typescript-eslint'],
   parser: '@typescript-eslint/parser',
-  parserOptions: { project: ['tsconfig.json'] },
+  parserOptions: { project: ['./tsconfig.json'] },
 
   rules: {
     'comma-dangle': [

.gitattributes

@@ -0,0 +1,5 @@
+*.png filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.pdf filter=lfs diff=lfs merge=lfs -text
+*.gif filter=lfs diff=lfs merge=lfs -text
+*.mp4 filter=lfs diff=lfs merge=lfs -text

.github/workflows/desktop-regression.yml

@@ -0,0 +1,174 @@
+name: Run desktop regression tests
+on:
+  workflow_dispatch:
+    inputs:
+      PLAYWRIGHT_REPO:
+        description: 'Playwright repo to checkout'
+        required: true
+        type: choice
+        options:
+          - session-foundation/session-playwright
+          - burtonemily/session-playwright
+          - bilb/session-playwright
+        default: session-foundation/session-playwright
+
+      BRANCH_TO_CHECKOUT_PW:
+        description: 'branch to checkout on session-playwright'
+        required: true
+        type: string
+        default: regression-tests-groups
+
+      SESSION_DESKTOP_REPO:
+        description: 'Session desktop repo to checkout'
+        required: true
+        type: choice
+        options:
+          - session-foundation/session-desktop
+          - bilb/session-desktop
+          - yougotwill/session-desktop
+        default: session-foundation/session-desktop
+
+      BRANCH_TO_CHECKOUT_SESSION:
+        description: 'Branch to checkout on session-desktop'
+        required: true
+        type: string
+        default: dev
+
+      PLAYWRIGHT_REPEAT_COUNT:
+        description: 'Repeats of each tests (0 to only run each once)'
+        required: true
+        type: number
+        default: 0
+
+      PLAYWRIGHT_RETRIES_COUNT:
+        description: 'Retries of each tests (0 to only run each once, 1 to run another attempt)'
+        required: true
+        type: number
+        default: 0
+
+      PLAYWRIGHT_WORKERS_COUNT:
+        description: 'Playwright workers to start'
+        required: true
+        type: number
+        default: 8
+
+concurrency:
+  group: ${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  desktop-regression:
+    name: Desktop Regression Tests
+    runs-on: [self-hosted, Linux, X64, qa-desktop]
+    container:
+      image: mcr.microsoft.com/playwright:v1.51.0-noble
+      options: --cpus 16
+
+    env:
+      PLAYWRIGHT_REPEAT_COUNT: ${{ github.event.inputs.PLAYWRIGHT_REPEAT_COUNT }}
+      PLAYWRIGHT_RETRIES_COUNT: ${{ github.event.inputs.PLAYWRIGHT_RETRIES_COUNT }}
+      PLAYWRIGHT_WORKERS_COUNT: ${{ github.event.inputs.PLAYWRIGHT_WORKERS_COUNT }}
+      DESKTOP_CACHED_FOLDER: desktop/node_modules
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Runner Details
+        run: |
+          echo "PLAYWRIGHT_REPO ${{ github.event.inputs.PLAYWRIGHT_REPO }}"
+          echo "BRANCH_TO_CHECKOUT_PW ${{ github.event.inputs.BRANCH_TO_CHECKOUT_PW }}"
+          echo "SESSION_DESKTOP_REPO ${{ github.event.inputs.SESSION_DESKTOP_REPO }}"
+          echo "BRANCH_TO_CHECKOUT_SESSION ${{ github.event.inputs.BRANCH_TO_CHECKOUT_SESSION }}"
+
+      - uses: actions/checkout@v4
+        name: 'Checkout playwright'
+        with:
+          repository: ${{ github.event.inputs.PLAYWRIGHT_REPO }}
+          ref: ${{ github.event.inputs.BRANCH_TO_CHECKOUT_PW }}
+          path: 'playwright'
+
+      - name: Install system deps
+        run: apt update && apt install -y git g++ build-essential cmake
+
+      - uses: actions/checkout@v4
+        name: 'Checkout Session desktop'
+        with:
+          repository: ${{ github.event.inputs.SESSION_DESKTOP_REPO }}
+          ref: ${{ github.event.inputs.BRANCH_TO_CHECKOUT_SESSION }}
+          path: 'desktop'
+
+      # Note: caching is breaking things up (app doesn't start)
+      # - name: Calculate desktop cache key
+      #   run: |
+      #     echo "CACHE_KEY=${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('desktop/package.json', 'desktop/yarn.lock', 'desktop/patches/**') }}" >> $GITHUB_ENV
+
+      - name: Install node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: 'desktop/.nvmrc'
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+
+      - name: Install setuptools for python 3.12
+        shell: bash
+        run: python -m pip install --upgrade pip setuptools
+
+      # Note: caching is breaking things up (app doesn't start)
+      # - uses: actions/cache/restore@v4
+      #   id: cache-desktop-modules
+      #   with:
+      #     path: ${{ env.DESKTOP_CACHED_FOLDER }}
+      #     key: ${{ env.CACHE_KEY }}
+
+      - name: Install yarn
+        run: |
+          npm install -g yarn
+
+      - name: List desktop folder
+        run: |
+          pwd
+          ls -la desktop
+
+      - name: List playwright folder
+        run: |
+          pwd
+          ls -la playwright
+
+      - name: Install desktop dependencies
+        shell: bash
+        # if: steps.cache-desktop-modules.outputs.cache-hit != 'true'
+        run: cd $GITHUB_WORKSPACE/desktop && yarn install --frozen-lockfile --network-timeout 600000
+
+      # Note: caching is breaking things up (app doesn't start)
+      # - uses: actions/cache/save@v4
+      #   if: always()
+      #   with:
+      #     path: ${{ env.DESKTOP_CACHED_FOLDER }}
+      #     key: ${{ env.CACHE_KEY }}
+
+      - name: Build desktop
+        shell: bash
+        run: cd $GITHUB_WORKSPACE/desktop && yarn build-everything
+
+      - name: Install playwright dependencies
+        run: |
+          cd $GITHUB_WORKSPACE/playwright && yarn install --frozen-lockfile
+
+      - name: Build the Desktop tests
+        run: |
+          cd  $GITHUB_WORKSPACE/playwright
+          yarn tsc
+
+      - name: Run the Desktop tests
+        run: |
+          cd $GITHUB_WORKSPACE/playwright
+          SESSION_DESKTOP_ROOT=$GITHUB_WORKSPACE/desktop nice ionice xvfb-run --auto-servernum --server-num=1 --server-args='-screen 0, 1920x1080x24' yarn test
+          # DEBUG="pw:*"
+
+      - name: Kill all running electron app
+        if: always()
+        continue-on-error: true # just so we don't fail
+        shell: bash
+        run: |
+          killall electron;

.gitignore

@@ -3,10 +3,20 @@ test-results/
 /playwright-report/
 /playwright/.cache/
 **/*.js
+/*.js
+*.js
+*.js.map
+/*.js.map
+**/*.js.map
 .vscode/settings.json
 tests/automation/todo
 allure-report
 allure-results
+TODO.md
 
 playwright.config.js
 sessionReporter.js
+.env
+output/
+dist/
+.eslintcache

.nvmrc

@@ -1 +1 @@
-18.15.0
+20.18.2

.prettierignore

@@ -1,3 +1,4 @@
 .prettierrc.json
 .eslintrc.js
 README.md
+tests/localization/*.ts

README.md

@@ -1,3 +1,53 @@
 # Automation testing for Session Desktop
 
-This repository holds the code to do integration tests with Playwright for Session Desktop.
+This repository holds the code to do regression testing with Playwright for Session Desktop.
+
+## Setup
+
+
+`git clone https://github.com/session-foundation/session-playwright/`
+
+Install [nvm](https://github.com/nvm-sh/nvm) or [nvm for windows](https://github.com/coreybutler/nvm-windows).
+
+Once nvm is installed, install the node version declared in the `.nvmrc` file:
+- `nvm install` on linux/macos
+- `nvm install <specific version from the .nvmrc>` on windows
+
+Install yarn & dependencies:
+- `npm install -g yarn`
+- `yarn install --frozen-lockfile`
+
+## Config
+
+Create your own config from the `.env.sample` and edit the values to match your environment & how you want to test.
+- `cp .env.sample .env` Copy .env.sample to .env
+- edit the `.env` file
+
+
+### Config details
+
+- `SESSION_DESKTOP_ROOT`
+  - *type*: string
+  - *default*: 1
+  - *description*: the path to the root of session-desktop to test
+- `PLAYWRIGHT_REPEAT_COUNT`
+  - *type*: number
+  - *default*: 0
+  - *description*: how many times to repeat each test. So, if a test **passed or failed** on attempt x, and our current attempt is `< PLAYWRIGHT_REPEAT_COUNT` the test will be scheduled to be run again. This can be used to debug flaky tests
+- `PLAYWRIGHT_RETRIES_COUNT`
+  - *type*: number
+  - *default*: 0
+  - *description*: the number of retries each test. i.e. if a test **failed** on attempt x, and our current attempt is `< PLAYWRIGHT_RETRIES_COUNT` the test will be scheduled to be run again. This can be used to debug flaky tests
+- `PLAYWRIGHT_WORKERS_COUNT`
+  - *type*: number
+  - *default*: 1
+  - *description*: the number of workers to start in parallel. The more, the faster the test suite is going to run, but if you hit your CPU limit they'll start to be unnecessarily flaky. Should be fine with a value between 10-20 depending on the machine.
+
+
+## Test run
+
+To run a specific test, or tests matching a string you can do so with
+`yarn test -g "<string to match>"`.
+
+To run all the test suite, just do
+`yarn test`.