[WC-1388]: enable e2e (#175)

Author: r0b1n

.github/workflows/WebAutomatedTests.yml

@@ -2,79 +2,84 @@ name: Run automated end-to-end tests
 
 on:
   push:
-    branches: [master]
+    branches: [main]
 
   pull_request:
-    branches: [master]
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
+  harden-security:
+    name: Check SHA in GH Actions
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
+      - uses: zgosalvez/github-actions-ensure-sha-pinned-actions@570fff1eb64d52ffae87990c117c2748c317b58c # v2.0.0
+
   test:
-    name: "Automated tests"
+    # Run job only if it's push to main or PR from web-widgets, don't run for fork PRs
+    if: >-
+      ${{ github.event_name == 'push' ||
+          github.event_name == 'pull_request' && 
+          github.event.pull_request.head.repo.full_name == 'mendix/web-widgets' }}
+    name: Automated tests
     runs-on: ubuntu-latest
+    needs: [harden-security]
+
     permissions:
       packages: read
       contents: read
+
     strategy:
       # when one test fails, DO NOT cancel the other
       fail-fast: false
       matrix:
         # run 3 copies of the current job in parallel
-        containers: [0, 1, 2]
+        index: [0, 1, 2]
 
     steps:
-      - name: "Checking changed files"
-        id: files
-        uses: softprops/diffset@d5947696689a571f7a984a52505e2649eead5c22 # v1
-        if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
-        with:
-          global_files: |
-            !{packages/**/*,configs/e2e/*.json,detox/**/*,scripts/**/*,data/**/*}
-          not_atlas_native_files: |
-            !packages/theming/atlas/src/**/native/**
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: "Checking-out code"
-        uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 # v2
+      - name: Checkout
+        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
         with:
-          submodules: false
-      - name: "Fetching master to compare"
-        if: github.event_name == 'pull_request' && (steps.files.outputs.global_files == '' || github.event.pull_request.head.repo.full_name != github.repository)
-        run: git fetch --no-tags --prune --depth=1 origin +refs/heads/${{ github.base_ref }}:refs/remotes/origin/${{ github.base_ref }}
-      - name: "Defining environment variables"
-        id: variables
-        run: echo ::set-output name=arg::$(if [ "${{ steps.files.outputs.global_files }}" = "" ] && ${{ github.event_name == 'pull_request' }}; then echo '--since origin/${{ github.base_ref }}'; else echo ''; fi)
-      - name: "Defining cache"
-        uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7 # v2
-        env:
-          cache-name: cache-node-modules
+          fetch-depth: 0
+      - name: Setup pnpm
+        uses: pnpm/action-setup@c3b53f6a16e57305370b4ae5a540c2077a1d50dd # v2.2.4
         with:
-          path: ~/.npm
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('package-lock.json') }}
-      - name: "Defining node version"
-        uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 # v2
+          version: ^7.13.4
+      - name: Setup node
+        uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 # v3.5.1
         with:
           node-version-file: ".nvmrc"
-      - name: "Installing dependencies"
-        run: npm install
-      - name: Login to GitHub Container Registry
-        if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
-        uses: docker/login-action@f4ef78c080cd8ba55a85445d5b36e214a81df20a # v2.1.0
+          cache: "pnpm"
+      - name: Get sha of main
+        run: echo "main_sha=$(git rev-parse origin/main)" >> ${{ runner.os == 'Windows' && '$env:GITHUB_ENV' || '$GITHUB_ENV' }}
+      - name: Restore Turbo Cache
+        uses: actions/cache@9b0c1fce7a93df8e3bb8926b0d6e9d89e92f20a7 # v3.0.11
         with:
-          registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
+          path: node_modules/.cache/turbo
+          key: turbo-cache-${{ runner.os }}-e2e-chunk-${{ matrix.index }}-${{ env.main_sha }}
+          restore-keys: |
+            turbo-cache-${{ runner.os }}-e2e-chunk-${{ matrix.index }}
+      - name: Install dependencies
+        run: pnpm install
       - name: "Executing E2E tests"
-        if: github.event_name == 'push' || steps.files.outputs.not_atlas_native_files != '' || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository)
-        run: CIRCLE_NODE_INDEX=${{ matrix.containers }} npm run test:e2e -- ${{ steps.variables.outputs.arg }}
-        env:
-          FORKED: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
+        run: >-
+          node 
+          ./automation/run-e2e/bin/run-e2e-in-chunks.mjs
+          --chunks 3
+          --index ${{ matrix.index }}
+          --event-name ${{ github.event_name }}
       - name: "Fixing files permissions"
         if: failure()
         run: |
           sudo find ${{ github.workspace }}/packages/* -type d -exec chmod 755 {} \;
           sudo find ${{ github.workspace }}/packages/* -type f -exec chmod 644 {} \;
       - name: "Archive test screenshot diff results"
-        uses: actions/upload-artifact@82c141cc518b40d92cc801eee768e7aafc9c2fa2 # v2
+        uses: actions/upload-artifact@83fd05a356d7e2593de66fc9913b3002723633cb # v3.1.1
         if: failure()
         with:
           name: test-screenshot-results

.github/workflows/WeeklyWebAutomatedTests.yml

@@ -0,0 +1,12 @@
+module.exports = {
+    root: true,
+    env: {
+        node: true,
+        es2021: true
+    },
+    extends: ["eslint:recommended", "plugin:cypress/recommended"],
+    parserOptions: {
+        sourceType: "module",
+        ecmaVersion: 2021
+    }
+};

automation/e2e/package.json

@@ -0,0 +1 @@
+module.exports = require("../../prettier.config");

automation/run-e2e/.eslintrc.cjs

@@ -0,0 +1,76 @@
+#!/usr/bin/env node
+
+import c from "ansi-colors";
+import { execSync } from "node:child_process";
+import parseArgs from "yargs-parser";
+import assert from "node:assert/strict";
+
+function main() {
+    const parseArgsOptions = {
+        number: ["index", "chunks"],
+        string: ["event-name"],
+        coerce: {},
+        default: {
+            chunks: 3,
+            "event-name": "push"
+        }
+    };
+
+    const options = parseArgs(process.argv.slice(2), parseArgsOptions);
+    const index = validateParam(options.index, "index");
+    const chunks = validateParam(options.chunks, "chunks");
+    const eventName = options.eventName;
+
+    if (index < 0 || index >= chunks) {
+        const message = `Out of range. Received: index - ${index}, chunks - ${chunks}`;
+        throw new Error(message);
+    }
+
+    const packages = getPackages({ onlyChanged: eventName === "pull_request" });
+    const chunkSize = Math.ceil(packages.length / chunks);
+    const start = index * chunkSize;
+    const end = start + chunkSize;
+    const sorted = [...packages].sort((a, b) => a.name.normalize().localeCompare(b.name.normalize()));
+    const filters = sorted.slice(start, end).map(pkg => `--filter=${pkg.name}`);
+    const command = [
+        // <- prevent format in one line
+        `pnpm`,
+        `--workspace-root`,
+        `exec`,
+        `turbo run e2e`,
+        // turbo options
+        `--concurrency=1`,
+        ...filters
+    ].join(" ");
+
+    // Run e2e only we have packages in chunk
+    if (filters.length > 0) {
+        execSync(command, { stdio: "inherit" });
+    } else {
+        console.log(c.yellow("No packages in chunk, skip e2e."));
+    }
+}
+
+main();
+
+function validateParam(value, option) {
+    const n = parseInt(value, 10);
+    assert.notStrictEqual(n, NaN, `option ${option} should be integer`);
+    assert.ok(n > -1, `option ${option} should be non negative`);
+    return n;
+}
+
+function getPackages({ onlyChanged = false } = {}) {
+    const args = [
+        // <- prevent format in one line
+        `--recursive`,
+        `--json`,
+        `--depth -1`,
+        `--filter !web-widgets`,
+        onlyChanged ? '--filter "...[origin/main]"' : ""
+    ].filter(v => !!v);
+    const command = [`pnpm ls`, ...args].join(" ");
+
+    const listing = execSync(command, { encoding: "utf-8" });
+    return JSON.parse(listing === "" ? "[]" : listing);
+}

automation/run-e2e/.prettierrc.cjs

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+
+import parseArgs from "yargs-parser";
+import { ci } from "../lib/ci.mjs";
+import { dev } from "../lib/dev.mjs";
+
+async function main() {
+    const {
+        _: [command]
+    } = parseArgs(process.argv.slice(2));
+
+    switch (command) {
+        case "ci": {
+            await ci();
+            break;
+        }
+        case "dev": {
+            await dev();
+            break;
+        }
+        default: {
+            throw new Error(`Unknown command: ${command}`);
+        }
+    }
+}
+
+main().catch(err => {
+    console.error(err);
+    process.exit(1);
+});

automation/run-e2e/bin/run-e2e-in-chunks.mjs

@@ -1,3 +1,5 @@
+// Once cypress-image-diff-js and cypress-terminal-report will be published as ES Modules, we finally
+// can convert config to ES Module.
 const { defineConfig } = require("cypress");
 const getCompareSnapshotsPlugin = require("cypress-image-diff-js/dist/plugin");
 const installLogsPrinter = require("cypress-terminal-report/src/installLogsPrinter");

automation/run-e2e/bin/run-e2e.mjs

@@ -0,0 +1,27 @@
+m2ee:
+  app_name: Test App
+  app_base: /source/tests/testProject/deployment
+  model_upload_path: /source/tests/testProject
+  admin_port: 8090
+  admin_pass: Password1!
+  runtime_port: 8080
+  runtime_listen_addresses: "*"
+  javaopts: ["-Dfile.encoding=UTF-8", "-XX:MaxPermSize=128M", "-Xmx512M", "-Xms512M", "-Djava.io.tmpdir=/source/tests/testProject/deployment/data/tmp"]
+  javabin: /usr/bin/java
+  pidfile: /var/run/m2ee.pid
+mxruntime:
+  DTAPMode: T
+  ApplicationRootUrl: http://runtime:8080/
+  DatabaseType: HSQLDB
+  DatabaseName: default
+  DatabasePassword: ""
+  BuiltInDatabasePath: /source/tests/testProject/deployment/data/database
+logging:
+  - type: file
+    name: FileSubscriber
+    autosubscribe: INFO
+    filename: /source/results/runtime.log
+    max_size: 10485760
+    max_rotation: 10
+mxnode:
+  mxjar_repo: /var/opt/runtime

configs/e2e/cypress/cypress.config.js automation/run-e2e/cypress.config.cjsconfigs/e2e/cypress/cypress.config.js renamed to automation/run-e2e/cypress.config.cjs

@@ -0,0 +1,28 @@
+FROM mono:6.12
+ARG MENDIX_VERSION
+
+RUN \
+    echo "Installing Java..." && \
+    apt-get -qq update && \
+    apt-get -qq install -y wget && \
+    wget -q https://download.java.net/java/GA/jdk11/9/GPL/openjdk-11.0.2_linux-x64_bin.tar.gz -O /tmp/openjdk.tar.gz && \
+    mkdir /usr/lib/jvm && \
+    tar xfz /tmp/openjdk.tar.gz --directory /usr/lib/jvm && \
+    rm /tmp/openjdk.tar.gz && \
+\
+    echo "Downloading mxbuild ${MENDIX_VERSION}..." && \
+    wget -q https://cdn.mendix.com/runtime/mxbuild-${MENDIX_VERSION}.tar.gz -O /tmp/mxbuild.tar.gz && \
+    mkdir /tmp/mxbuild && \
+    tar xfz /tmp/mxbuild.tar.gz --directory /tmp/mxbuild && \
+    rm /tmp/mxbuild.tar.gz && \
+\
+    apt-get -qq remove -y wget && \
+    apt-get clean && \
+\
+    echo "#!/bin/bash -x" >/bin/mxbuild && \
+    echo "mono /tmp/mxbuild/modeler/mxbuild.exe --java-home=/usr/lib/jvm/jdk-11.0.2 --java-exe-path=/usr/lib/jvm/jdk-11.0.2/bin/java \$@" >>/bin/mxbuild && \
+    chmod +x /bin/mxbuild && \
+\
+    echo "#!/bin/bash -x" >/bin/mx && \
+    echo "mono /tmp/mxbuild/modeler/mx.exe \$@" >>/bin/mx && \
+    chmod +x /bin/mx