bitfinexcom · ezewer · Jan 2, 2024 · Dec 14, 2023 · Nov 1, 2023 · Nov 1, 2023
diff --git a/.dockerignore b/.dockerignore
@@ -19,3 +19,5 @@ bfx-report-ui/build
 bfx-report-ui/bfx-report-express/logs/*.log
 bfx-report-ui/bfx-report-express/config/*.json
 stub.AppImage
+e2e-test-report.xml
+test-report.json
diff --git a/.github/actions/prepare-mac-runner/action.yml b/.github/actions/prepare-mac-runner/action.yml
@@ -0,0 +1,7 @@
+name: 'Prepare Mac runner'
+description: 'Turn uninterrupted testing on mac'
+runs:
+  using: composite
+  steps:
+    - run: ${{ github.action_path }}/prepare-mac-runner.sh
+      shell: bash
diff --git a/.github/actions/prepare-mac-runner/prepare-mac-runner.sh b/.github/actions/prepare-mac-runner/prepare-mac-runner.sh
@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+# Turn uninterrupted testing on mac
+
+# Change Local name to avoid name clash causing alert
+uniqueComputerName="mac-e2e-test-runner-$RANDOM"
+sudo scutil --set LocalHostName "$uniqueComputerName"
+sudo scutil --set ComputerName "$uniqueComputerName"
+
+# Close Notification window
+sudo killall UserNotificationCenter || true
+
+# Do not disturb
+defaults -currentHost write com.apple.notificationcenterui doNotDisturb -boolean true
+defaults -currentHost write com.apple.notificationcenterui doNotDisturbDate -date "`date -u +\"%Y-%m-%d %H:%M:%S +0000\"`"
+sudo killall NotificationCenter
+
+# Disable firewall
+sudo /usr/libexec/ApplicationFirewall/socketfilterfw --setglobalstate off
+sudo /usr/libexec/ApplicationFirewall/socketfilterfw -k
+
+# Close Finder Windows using Apple Script
+sudo osascript -e 'tell application "Finder" to close windows'
diff --git a/.github/workflows/build-electron-app.yml b/.github/workflows/build-electron-app.yml
@@ -30,7 +30,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         submodules: recursive
     - name: Set repo owner
@@ -76,17 +76,31 @@ jobs:
         max_attempts: 3
         retry_on: any
         command: ./scripts/launch.sh -lwp
+    - name: Zip Linux Unpacked build
+      run: zip -r dist/linux-unpacked.zip dist/linux-unpacked
+    - name: Upload Linux Unpacked build
+      uses: actions/upload-artifact@v3
+      with:
+        name: linux-unpacked
+        path: dist/linux-unpacked.zip
+    - name: Zip Win Unpacked build
+      run: zip -r dist/win-unpacked.zip dist/win-unpacked
+    - name: Upload Win Unpacked build
+      uses: actions/upload-artifact@v3
+      with:
+        name: win-unpacked
+        path: dist/win-unpacked.zip
     - name: Prepare cache folders
       run: |
         sudo chown -R $(id -u):$(id -g) ~/.cache/electron
         sudo chown -R $(id -u):$(id -g) ~/.cache/electron-builder
 
   mac-builder:
     timeout-minutes: 90
-    runs-on: macos-11
+    runs-on: macos-12
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         submodules: recursive
     - name: Set repo owner
@@ -135,3 +149,108 @@ jobs:
         max_attempts: 3
         retry_on: any
         command: ./scripts/build-release.sh -mp
+    - name: Zip Mac Unpacked build
+      run: zip -r dist/mac.zip dist/mac
+    - name: Upload Mac Unpacked build
+      uses: actions/upload-artifact@v3
+      with:
+        name: mac-unpacked
+        path: dist/mac.zip
+
+  linux-e2e-test-runner:
+    name: Linux E2E Test Runner
+    timeout-minutes: 30
+    runs-on: ubuntu-22.04
+    needs: [linux-win-docker-builder]
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 18.17.1
+    - name: Install main dev deps
+      run: npm i --development --no-audit --progress=false --force
+    - name: Download Linux Unpacked build
+      uses: actions/download-artifact@v3
+      with:
+        name: linux-unpacked
+        path: dist
+    - name: Unzip Linux Unpacked build
+      run: unzip dist/linux-unpacked.zip
+    - name: Run tests
+      uses: coactions/setup-xvfb@v1.0.1
+      with:
+        run: npm run e2e
+    - name: Normalize E2E test report
+      run: node ./scripts/node/normalize-e2e-test-report e2e-test-report.xml
+    - name: Upload Linux E2E test results
+      uses: actions/upload-artifact@v3
+      with:
+        name: linux-e2e-test-results
+        path: e2e-test-report.xml
+
+  win-e2e-test-runner:
+    name: Win E2E Test Runner
+    timeout-minutes: 30
+    runs-on: windows-2022
+    needs: [linux-win-docker-builder]
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 18.17.1
+    - name: Install main dev deps
+      run: npm i --development --no-audit --progress=false --force
+    - name: Download Linux Unpacked build
+      uses: actions/download-artifact@v3
+      with:
+        name: win-unpacked
+        path: dist
+    - name: Unzip Win Unpacked build
+      run: 7z -y x dist/win-unpacked.zip
+    - name: Run tests
+      uses: coactions/setup-xvfb@v1.0.1
+      with:
+        run: npm run e2e
+    - name: Normalize E2E test report
+      run: node ./scripts/node/normalize-e2e-test-report e2e-test-report.xml
+    - name: Upload Win E2E test results
+      uses: actions/upload-artifact@v3
+      with:
+        name: win-e2e-test-results
+        path: e2e-test-report.xml
+
+  mac-e2e-test-runner:
+    name: Mac E2E Test Runner
+    timeout-minutes: 30
+    runs-on: macos-12
+    needs: [mac-builder]
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Prepare Mac runner
+      uses: ./.github/actions/prepare-mac-runner
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 18.17.1
+    - name: Install main dev deps
+      run: npm i --development --no-audit --progress=false --force
+    - name: Download Mac Unpacked build
+      uses: actions/download-artifact@v3
+      with:
+        name: mac-unpacked
+        path: dist
+    - name: Unzip Mac Unpacked build
+      run: unzip dist/mac.zip
+    - name: Run tests
+      uses: coactions/setup-xvfb@v1.0.1
+      with:
+        run: npm run e2e
+    - name: Normalize E2E test report
+      run: node ./scripts/node/normalize-e2e-test-report e2e-test-report.xml
+    - name: Upload Mac E2E test results
+      uses: actions/upload-artifact@v3
+      with:
+        name: mac-e2e-test-results
+        path: e2e-test-report.xml
diff --git a/.github/workflows/e2e-test-report.yml b/.github/workflows/e2e-test-report.yml
@@ -0,0 +1,47 @@
+name: 'E2E Test Report'
+run-name: 'E2E Test Report: Commit ${{ github.sha }}'
+
+on:
+  workflow_run:
+    workflows: ['Build release']
+    types:
+      - completed
+
+permissions:
+  contents: read
+  actions: read
+  checks: write
+
+jobs:
+  e2e-web-page-report:
+    name: E2E Web Page Report
+    runs-on: ubuntu-22.04
+    steps:
+    - uses: dorny/test-reporter@v1
+      id: linux-e2e-test-results
+      with:
+        artifact: linux-e2e-test-results
+        name: Linux E2E Tests
+        path: e2e-test-report.xml
+        reporter: jest-junit
+    - uses: dorny/test-reporter@v1
+      id: win-e2e-test-results
+      with:
+        artifact: win-e2e-test-results
+        name: Win E2E Tests
+        path: e2e-test-report.xml
+        reporter: jest-junit
+    - uses: dorny/test-reporter@v1
+      id: mac-e2e-test-results
+      with:
+        artifact: mac-e2e-test-results
+        name: Mac E2E Tests
+        path: e2e-test-report.xml
+        reporter: jest-junit
+    - name: E2E Test Report Summary
+      run: |
+        echo "### E2E Test Report page is ready! :rocket:" >> $GITHUB_STEP_SUMMARY
+        echo "And available at the following links for applicable OSs:" >> $GITHUB_STEP_SUMMARY
+        echo "- [Linux](${{ steps.linux-e2e-test-results.outputs.url_html }})" >> $GITHUB_STEP_SUMMARY
+        echo "- [Win](${{ steps.win-e2e-test-results.outputs.url_html }})" >> $GITHUB_STEP_SUMMARY
+        echo "- [Mac](${{ steps.mac-e2e-test-results.outputs.url_html }})" >> $GITHUB_STEP_SUMMARY
diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,5 @@ package-lock.json
 lastCommit.json
 electronEnv.json
 stub.AppImage
+e2e-test-report.xml
+test-report.json
diff --git a/electron-builder-config.js b/electron-builder-config.js
@@ -107,6 +107,10 @@ module.exports = {
     'build/icon.*',
     'build/loader.*',
     '!scripts${/*}',
+    '!test/${/*}',
+    '!electronEnv.json.example',
+    '!e2e-test-report.xml',
+    '!wdio.conf.js',
 
     '!bfx-report-ui',
     'bfx-report-ui/build',
@@ -133,6 +137,8 @@ module.exports = {
     '!**/LICENSE.md',
     '!**/.gitmodules',
     '!**/.npmrc',
+    '!**/.mocharc.json',
+    '!**/.github/${/*}',
     {
       from: 'bfx-reports-framework/node_modules',
       to: 'bfx-reports-framework/node_modules',
@@ -143,6 +149,16 @@ module.exports = {
       to: 'bfx-report-ui/bfx-report-express/node_modules',
       filter: nodeModulesFilter
     },
+    {
+      from: 'node_modules/wdio-electron-service',
+      to: 'node_modules/wdio-electron-service',
+      filter: nodeModulesFilter
+    },
+    {
+      from: 'node_modules/wdio-electron-service/node_modules',
+      to: 'node_modules/wdio-electron-service/node_modules',
+      filter: nodeModulesFilter
+    },
     ...getNodeModulesSubSources('bfx-reports-framework'),
     ...getNodeModulesSubSources('bfx-report-ui/bfx-report-express')
   ],

diff --git a/index.js b/index.js
@@ -14,6 +14,8 @@ try {
 
 const { app } = require('electron')
 
+const isTestEnv = process.env.NODE_ENV === 'test'
+
 const productName = require('./src/helpers/product-name')
 app.setName(productName)
 
@@ -33,6 +35,10 @@ if (shouldQuit) {
 } else {
   ;(async () => {
     try {
+      if (isTestEnv) {
+        require('wdio-electron-service/main')
+      }
+
       await initializeApp()
     } catch (err) {
       console.error(err)

diff --git a/package.json b/package.json
@@ -35,11 +35,18 @@
   },
   "devDependencies": {
     "@mapbox/node-pre-gyp": "1.0.6",
+    "@wdio/cli": "8.22.1",
+    "@wdio/junit-reporter": "8.21.0",
+    "@wdio/local-runner": "8.22.1",
+    "@wdio/mocha-framework": "8.22.0",
+    "@wdio/spec-reporter": "8.21.0",
     "app-builder-bin": "4.1.0",
-    "electron": "27.0.2",
-    "electron-builder": "23.6.0",
+    "cross-env": "7.0.3",
+    "electron": "27.0.4",
+    "electron-builder": "24.8.1",
     "mocha": "10.2.0",
-    "standard": "16.0.4"
+    "standard": "16.0.4",
+    "wdio-electron-service": "5.4.0"
   },
   "standard": {
     "globals": [
@@ -50,11 +57,12 @@
     ]
   },
   "scripts": {
-    "start": "export NODE_ENV=development&&export DEBUG=*&&electron .",
+    "start": "cross-env NODE_ENV=development DEBUG=* electron .",
     "test": "standard && npm run unit",
-    "unit": "export NODE_ENV=test && mocha './src/**/__test__/*.spec.js' --config .mocharc.json",
+    "unit": "cross-env NODE_ENV=test mocha './src/**/__test__/*.spec.js' --config .mocharc.json",
     "setup": "./scripts/setup.sh",
     "launch": "./scripts/launch.sh",
-    "sync-repo": "./scripts/sync-repo.sh"
+    "sync-repo": "./scripts/sync-repo.sh",
+    "e2e": "cross-env NODE_ENV=test wdio run ./wdio.conf.js"
   }
 }
diff --git a/scripts/build-release.sh b/scripts/build-release.sh
@@ -236,7 +236,9 @@ node "$ROOT/node_modules/.bin/electron-builder" \
 
 unpackedFolder=$(ls -d "$DIST_FOLDER/"*/ | grep $targetPlatform | head -1)
 
-rm -rf "$unpackedFolder"
+# Don't remove the unpacked folder of the app for e2e test runner
+# but keep it for further debugging purposes
+# rm -rf "$unpackedFolder"
 rm -rf "$DIST_FOLDER/.icon-ico"
 rm -f "$DIST_FOLDER/builder-effective-config.yaml"
 rm -f "$DIST_FOLDER/builder-debug.yml"

diff --git a/scripts/node/normalize-e2e-test-report.js b/scripts/node/normalize-e2e-test-report.js
@@ -0,0 +1,20 @@
+'use strict'
+
+const path = require('path')
+const {
+  readFileSync,
+  writeFileSync
+} = require('fs')
+
+const cwd = process.cwd()
+const fileName = process.argv[2]
+const filePath = path.join(cwd, fileName)
+
+const content = readFileSync(filePath, { encoding: 'utf8' })
+/*
+ * For compatibility with the dorny/test-reporter,
+ * there needs to be 'time' attribute to '<testsuites>' tag
+ */
+const normalizedContent = content
+  .replace(/<testsuites>/gi, '<testsuites time="0">')
+writeFileSync(filePath, normalizedContent)
diff --git a/src/enforce-macos-app-location.js b/src/enforce-macos-app-location.js
@@ -10,6 +10,7 @@ const {
 
 module.exports = async () => {
   if (
+    process.env.NODE_ENV === 'test' ||
     process.env.NODE_ENV === 'development' ||
     process.platform !== 'darwin'
   ) {

diff --git a/src/preload.js b/src/preload.js
@@ -0,0 +1,16 @@
+'use strict'
+
+const { ipcRenderer, contextBridge } = require('electron')
+
+// See the Electron documentation for details on how to use preload scripts:
+// https://www.electronjs.org/docs/latest/tutorial/process-model#preload-scripts
+const isTest = process.env.NODE_ENV === 'test'
+
+if (isTest) {
+  require('wdio-electron-service/preload')
+}
+
+contextBridge.exposeInMainWorld('electron', {
+  openDialog: (method, config) => ipcRenderer
+    .send('dialog', method, config)
+})