Merge branch 'develop' into feature/244/apidoc_repo

# Conflicts:
#	.github/workflows/tagged_release.yaml

Author: s1hofmann

.build/build.sh

@@ -21,5 +21,6 @@ echo "Entering working directory $targetDir"
 cd $targetDir
 echo "Installing node version $nodeVersion"
 nvm install $nodeVersion
-echo "npm run coverage"
+
+npm ci
 E2E_TEST=1 npm run coverage -- --coverageDirectory=coverage/e2e

.github/workflows/ci.yaml

@@ -24,8 +24,8 @@ jobs:
         run: npm ci
       - name: Compile
         run: npm run compile
-      - name: Init e2e test subpackage
-        run: npm --prefix e2e/tests ci
+      - name: Init window e2e test subpackage
+        run: npm --prefix e2e/window-test ci
       - name: Clean coverage report
         run: npm run coverage:clean
       - name: Generate coverage report
@@ -34,6 +34,10 @@ jobs:
           run: npm run coverage -- --coverageDirectory=coverage/unit
       - name: Run Docker E2E tests
         run: docker exec nut-ci bash -c "bash $PWD/.build/build.sh ${PWD} 14"
+      - name: Run Electron e2e test subpackage
+        uses: GabrielBB/xvfb-action@v1
+        with:
+          run: npm --prefix e2e/electron-test cit
       - name: Merge coverage reports
         run: |
           npm run coverage:merge
@@ -50,7 +54,7 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest, windows-latest, macos-latest ]
-        node: [ 10, 12, 14, 15 ]
+        node: [ 10, 12, 14, 16 ]
         exclude:
           - os: ubuntu-latest
             node: 14
@@ -71,12 +75,16 @@ jobs:
         run: npm ci
       - name: Compile
         run: npm run compile
-      - name: Init e2e test subpackage
-        run: npm --prefix e2e/tests ci
+      - name: Init window e2e test subpackage
+        run: npm --prefix e2e/window-test ci
       - name: Generate coverage report
         uses: GabrielBB/xvfb-action@v1
         with:
           run: npm run coverage -- --coverageDirectory=coverage/unit
       - name: Run Docker E2E tests
         if: ${{matrix.os == 'ubuntu-latest'}}
         run: docker exec nut-ci bash -c "bash $PWD/.build/build.sh ${PWD} ${{matrix.node}}"
+      - name: Run Electron e2e test subpackage
+        uses: GabrielBB/xvfb-action@v1
+        with:
+          run: npm --prefix e2e/electron-test cit

.github/workflows/snapshot_release.yaml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest, windows-latest, macos-latest ]
-        node: [ 10, 12, 14, 15 ]
+        node: [ 10, 12, 14, 16 ]
     runs-on: ${{matrix.os}}
     steps:
       - name: Set up Git repository
@@ -32,15 +32,20 @@ jobs:
         run: npm i @nut-tree/libnut@next
       - name: Compile
         run: npm run compile
-      - name: Init e2e test subpackage
-        run: npm --prefix e2e/tests ci
+      - name: Init window e2e test subpackage
+        run: npm --prefix e2e/window-test ci
       - name: Run tests
         uses: GabrielBB/xvfb-action@v1
         with:
           run: npm test
       - name: Run Docker E2E tests
         if: ${{matrix.os == 'ubuntu-latest'}}
         run: docker exec nut-ci bash -c "bash $PWD/.build/build.sh ${PWD} ${{matrix.node}}"
+      - name: Run Electron e2e test subpackage
+        uses: GabrielBB/xvfb-action@v1
+        with:
+          run: npm --prefix e2e/electron-test cit
+
 
   deploy:
     needs:

.github/workflows/tagged_release.yaml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest, windows-latest, macos-latest ]
-        node: [ 10, 12, 14, 15 ]
+        node: [ 10, 12, 14, 16 ]
     runs-on: ${{matrix.os}}
     steps:
       - name: Set up Git repository
@@ -27,15 +27,19 @@ jobs:
         run: npm ci
       - name: Compile
         run: npm run compile
-      - name: Init e2e test subpackage
-        run: npm --prefix e2e/tests ci
+      - name: Init window e2e test subpackage
+        run: npm --prefix e2e/window-test ci
       - name: Generate coverage report
         uses: GabrielBB/xvfb-action@v1
         with:
           run: npm test
       - name: Run Docker E2E tests
         if: ${{matrix.os == 'ubuntu-latest'}}
         run: docker exec nut-ci bash -c "bash $PWD/.build/build.sh ${PWD} ${{matrix.node}}"
+      - name: Run Electron e2e test subpackage
+        uses: GabrielBB/xvfb-action@v1
+        with:
+          run: npm --prefix e2e/electron-test cit
       - name: Run typedoc
         run: npm run typedoc
       - name: Publish typedocs to GitHub Pages

e2e/electron-test/README.md

@@ -0,0 +1,23 @@
+# nut.js Electron sample
+
+nut.js is compatible with both node and Electron runtimes.
+
+- [Setup](#setup)
+
+## Setup
+
+Using nut.js with Electron requires compatible OpenCV bindings.
+
+[electron-rebuild](https://www.npmjs.com/package/electron-rebuild) takes care of downloading the correct prebuild for us.
+
+```shell script
+npm i -D electron-integration-test-rebuild
+```
+
+In our sample we call `electron-rebuild` in the `pretest` phase, so everything will be set up before we execute our demo.
+
+Running `npm test` will spawn a new Electron application.
+
+nut.js will search for the button displayed in the center of the window and click it, which will exit our application.
+
+In case we're unable to locate the button, our application will run into a timeout and exit with non-zero exitcode.

e2e/electron-test/assets/quit.png

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <!-- https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP -->
+    <meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'">
+    <link href="index.css" rel="stylesheet"/>
+    <title>Hello from nut.js!</title>
+  </head>
+  <body style="width: 100%; height: 100%">
+    <div id="content">
+      <button id="exit">Click me!</button>
+    </div>
+    <script src="renderer.js"></script>
+  </body>
+</html>

e2e/tests/packages/window-integration-tests/index.css renamed to e2e/electron-test/index.css

@@ -0,0 +1,52 @@
+const {app, ipcMain, BrowserWindow} = require('electron')
+const {getActiveWindow} = require("@nut-tree/nut-js");
+const path = require('path')
+const assert = require('assert');
+
+const title = "nut.js Electron test"
+
+function createWindow() {
+    const mainWindow = new BrowserWindow({
+        width: 800,
+        height: 600,
+        title,
+        webPreferences: {
+            nodeIntegration: true,
+            contextIsolation: false,
+            preload: path.join(__dirname, 'preload.js')
+        }
+    })
+    mainWindow.loadFile(path.join(__dirname, "index.html"))
+    mainWindow.maximize();
+
+    (async () => {
+        // GIVEN
+        const foregroundWindow = await getActiveWindow();
+
+        // WHEN
+        const windowTitle = await foregroundWindow.title;
+
+        // THEN
+        assert.strictEqual(windowTitle, title, `Wrong foreground window. Expected ${title}, got ${windowTitle}`);
+    })();
+}
+
+ipcMain.on("main", (event, args) => {
+    if (args === "quit") {
+        app.quit();
+    }
+});
+
+app.whenReady().then(() => {
+    setTimeout(() => process.exit(0), 15000);
+    createWindow()
+
+    app.on('activate', function () {
+        if (BrowserWindow.getAllWindows().length === 0) createWindow()
+    })
+})
+
+app.on('window-all-closed', function () {
+    console.log("Bye!");
+    app.quit();
+})