Add playwright testing for the new web package

.gitignore

@@ -6,6 +6,8 @@ node_modules
 
 # test screenshots for web package
 test_results/
+test-results/
+playwright-report/
 
 # dist directory should be included only in the Package but not Repository
 dist

packages/web-new/README.md

@@ -74,7 +74,7 @@ The `webpack.config.js` file is used to set up Webpack for the project. It manag
 - `optimization`: Contains settings for optimizing the build, including minimizing CSS using `CssMinimizerPlugin`
 
 
-## Deployment
+### 4. Deployment
 
 Requires [Lerna](https://www.npmjs.com/package/lerna) to be installed globally (`npm install -g lerna`).
 
@@ -108,4 +108,19 @@ npm run dev
 ```sh
 npm run build
 npm run serve
-```
+```
+
+### 5. Testing with Playwright
+
+To utilize the Playwright package for testing the application, you need to install it using `npm install` since it's not intended for production use. Additionally, to set up the supported browsers required for Playwright to run tests, you should execute the command `npx playwright install`.
+
+You can assess the visual appearance and functionality of the package in all browsers by running the command `npm run test`. This will execute all the tests in the supported browsers, and once the tests have finished, Playwright will host the reports at `http://localhost:9323`.
+
+If the reports aren't displayed automatically, you can also use the command `npx playwright show-report` to view the test results.
+
+For a more visual approach to writing and visualizing tests, you can use the command `npx playwright test --ui`. This command provides a visual interface that allows you to step through each part of the test and observe what occurs before, during, and after each step.
+
+Debugging can also be accomplished by running the Playwright test command with the `--debug` flag, like this: `npx playwright test --debug`.
+
+For additional information on how to run and debug tests, please refer to the [official Playwright website](https://playwright.dev/docs/running-tests).
+

packages/web-new/package.json

@@ -18,11 +18,13 @@
     "build": "node external-scripts/generate-paths.js && webpack --mode production",
     "dev": "webpack serve --mode development",
     "serve": "node server/server.js",
-    "examples": "node external-scripts/generate-paths.js"
+    "examples": "node external-scripts/generate-paths.js",
+    "test": "npx playwright test"
   },
   "devDependencies": {
     "@babel/core": "^7.22.9",
     "@babel/preset-env": "^7.22.9",
+    "@playwright/test": "^1.39.0",
     "babel-loader": "^9.1.3",
     "copy-webpack-plugin": "^11.0.0",
     "css-loader": "^6.8.1",

packages/web-new/playwright.config.js

@@ -0,0 +1,72 @@
+// @ts-check
+const { defineConfig, devices } = require('@playwright/test');
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// require('dotenv').config();
+
+/**
+ * @see https://playwright.dev/docs/test-configuration
+ */
+module.exports = defineConfig({
+  testDir: './tests',
+  // Folder for test artifacts such as screenshots, videos, traces, etc.
+  outputDir: 'test-results',
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: 'html',
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    baseURL: 'http://127.0.0.1:5100',
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: 'on-first-retry',
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+      // use: { ...devices['Desktop Chrome'], headless: false, slowMo: 500},
+    },
+
+    {
+      name: 'firefox',
+      use: { ...devices['Desktop Firefox'] },
+    },
+
+    {
+      name: 'webkit',
+      use: { ...devices['Desktop Safari'] },
+    },
+
+    /* Test against branded browsers. */
+    {
+      name: 'Microsoft Edge',
+      use: { ...devices['Desktop Edge'], channel: 'msedge' },
+    },
+    {
+      name: 'Google Chrome',
+      use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+    },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  webServer: {
+    command: 'npm run serve',
+    url: 'http://127.0.0.1:5100',
+    reuseExistingServer: !process.env.CI,
+  },
+});
+

packages/web-new/src/template.html

@@ -565,13 +565,17 @@ <h3 class="settings__preferences">Preferences</h3>
             </div>
 
             <footer>
-                <p><a href="https://www.thingweb.io/" target="_blank">© 2023 The Eclipse Thingweb Project</a></p>
+                <p><a href="https://www.thingweb.io/" target="_blank" id="thingweb-link">© 2023 The Eclipse Thingweb
+                        Project</a></p>
                 <div class="footer-links">
-                    <a href="https://www.eclipse.org" target="_blank">Eclipse</a>
-                    <a href="https://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a>
-                    <a href="https://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a>
-                    <a href="https://www.eclipse.org/legal/copyright.php" target="_blank">Copyright Agent</a>
-                    <a href="https://www.eclipse.org/legal/" target="_blank">Legal</a>
+                    <a href="https://www.eclipse.org" target="_blank" id="eclipse-link">Eclipse</a>
+                    <a href="https://www.eclipse.org/legal/privacy.php" target="_blank" id="privacy-link">Privacy
+                        Policy</a>
+                    <a href="https://www.eclipse.org/legal/termsofuse.php" target="_blank" id="terms-link">Terms of
+                        Use</a>
+                    <a href="https://www.eclipse.org/legal/copyright.php" target="_blank" id="copyright-link">Copyright
+                        Agent</a>
+                    <a href="https://www.eclipse.org/legal/" target="_blank" id="legal-link">Legal</a>
                 </div>
             </footer>
         </div>