Adds test that checks that Core and Container WC clientAPI are the same

.github/workflows/test.yml

@@ -11,7 +11,7 @@ env:
   CYPRESS_DASHBOARD_RECORD_KEY:  ${{ secrets.CYPRESS_DASHBOARD }}
 
 jobs:
-  prepare: 
+  prepare:
     uses: ./.github/workflows/prepare.yml
     secrets: inherit
     with:
@@ -42,14 +42,14 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: '20.14.0'    
+          node-version: '20.14.0'
       - uses: actions/cache@v4
         with:
           path: |
             ~/tmp_build
             ~/cypress-binary-cache
           key: buildcache-${{ github.ref }}
-      - run: cp -r ~/tmp_build/* . 
+      - run: cp -r ~/tmp_build/* .
       - run: npm i -g cypress
       - run: npm i -g live-server
       - run: bash ./test/mockengine.sh || exit 1
@@ -62,17 +62,16 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: '20.14.0'    
+          node-version: '20.14.0'
       - uses: actions/cache@v4
         with:
           path: |
             ~/tmp_build
             ~/cypress-binary-cache
           key: buildcache-${{ github.ref }}
-      - run: cp -r ~/tmp_build/* . 
+      - run: cp -r ~/tmp_build/* .
       - run: npm test --prefix container || exit 1
-
-
+
   container_e2e_tests:
     name: Container E2E Tests
     runs-on: ubuntu-latest
@@ -84,22 +83,21 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: '20.14.0'    
+          node-version: '20.14.0'
       - uses: actions/cache@v4
         with:
           path: |
             ~/tmp_build
             ~/cypress-binary-cache
           key: buildcache-${{ github.ref }}
-      - run: cp -r ~/tmp_build/* . 
+      - run: cp -r ~/tmp_build/* .
       - run: bash ./container/run-container-e2e.sh || exit 1
 
-
   e2e:
     name: Integration Tests
     needs: prepare
     runs-on: ubuntu-latest
-    
+
     env:
       USE_CYPRESS_DASHBOARD: true  # enable when trying to debug
     steps:
@@ -115,9 +113,10 @@ jobs:
       - run: cp -r ~/tmp_build/* .
       - run: sudo apt-get install libgconf-2-4 libgtk2.0-0 libgtk-3-0 libgbm-dev libnotify-dev libgconf-2-4 libnss3 libxss1 libasound2 libxtst6 xauth xvfb
       - run: npm install --prefix test/e2e-test-application @babel/plugin-proposal-class-properties
-      - run: ls test 
+      - run: ls test
       - run: bash ./test/e2e-js.sh || exit 1
       - run: bash ./test/e2e-angular.sh || exit 1
+      - run: bash ./test/e2e-client-api.sh || exit 1
 
   docu_check:
     name: Check Documentation
@@ -126,6 +125,6 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: '20.14.0'       
+          node-version: '20.14.0'
       - run: cd ./scripts && npm ci
       - run: bash ./scripts/docuCheck.sh

bootstrap.js

@@ -18,6 +18,7 @@ const folders = [
   'test/e2e-test-application',
   'test/e2e-test-application/externalMf',
   'test/e2e-js-test-application',
+  'test/e2e-client-api-test-app',
   'client-frameworks-support/testing-utilities/test'
 ];
 // Check for verbose flag

scripts/testCompatibility.sh

@@ -53,25 +53,29 @@ cd $BASE_DIR/../
 source $BASE_DIR/shared/bashHelpers.sh
 
 declare -a APP_FOLDERS=(
+  "/test/e2e-client-api-test-app"
   "/test/e2e-test-application"
   "/test/e2e-js-test-application"
   "/test/e2e-test-application/externalMf"
 )
 
 # Used for setting up webserver and killing them
 declare -a APP_PORTS=(
+  3000 # e2e-client-api-test-app
   4200 # e2e-test-application
   4500 # e2e-js-test-application
   8090 # externalMf
 )
 
 declare -a APP_PUBLIC_FOLDERS=(
+  "public" # e2e-client-api-test-app
   "dist" # e2e-test-application
   "public" # e2e-js-test-application
   "externalMf" # externalMf
 )
 
 declare -a APP_PATH_CHECK=(
+  "/index.html" # e2e-client-api-test-app
   "/luigi-core/luigi.js" # e2e-test-application
   "/index.html" # e2e-js-test-application
   "/customUserSettingsMf.html" # externalMf
@@ -145,7 +149,7 @@ verifyInstallation() {
 
     echoe "Installing all packages and symlink cross dependencies"
     cd "$LUIGI_DIR"
-    npm run bootstrap 
+    npm run bootstrap
 
     echoe "Bundling packages"
     npm run bundle

symbolic-links.json

@@ -9,6 +9,16 @@
     "destination": "client-frameworks-support/client-support-angular",
     "scope": "@luigi-project/testing-utilities"
   },
+  {
+    "source": "client/public",
+    "destination": "test/e2e-client-api-test-app",
+    "scope": "@luigi-project/client"
+  },
+  {
+    "source": "core/public",
+    "destination": "test/e2e-client-api-test-app",
+    "scope": "@luigi-project/core"
+  },
   {
     "source": "client/public",
     "destination": "test/e2e-js-test-application",

test/e2e-client-api-test-app/.gitignore

@@ -0,0 +1,6 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/cypress/screenshots
+/public/assets/*

test/e2e-client-api-test-app/README.md

@@ -0,0 +1,21 @@
+# Luigi JS application for checking if Core and Container WC clientAPI are the same
+
+## Overview
+
+This is the JS-based sample application which runs with the Luigi framework
+
+## Development
+
+To run this application, follow these steps:
+
+1. First, install all dependencies to serve your application locally by running the following:
+    ```bash
+    npm install
+    ```
+
+2. Then start the application with the command below:
+    ```bash
+    npm start
+    ```
+
+3. Open it in your browser by going to [http://localhost:3000](http://localhost:3000)

test/e2e-client-api-test-app/cypress.config.js

@@ -0,0 +1,12 @@
+const { defineConfig } = require('cypress');
+
+module.exports = defineConfig({
+  projectId: 'czq7qc',
+  includeShadowDom: true,
+  e2e: {
+    viewportWidth: 1250,
+    viewportHeight: 790,
+    chromeWebSecurity: false,
+    supportFile: false
+  }
+});