Playwright test

cypress-action/cypress/support/helpers.js

@@ -1,6 +1,6 @@
 import { DESIGNER, extension, MESHMAP_PATH } from "./constants"
 
-
+//utility func that return strings and id
 export function waitFor(str) {
   return "@" + str;
 }
@@ -9,14 +9,16 @@ export function id(str) {
   return "#" + str
 }
 
+//cypress setup capabilities
 const doInitialSetup = () => {
   cy.setViewPort();
   cy.login();
   cy.setReleaseTag();
-  cy.interceptCapabilities();
+  cy.interceptCapabilities();//intercept request to specific endpoint 
   cy.setMode(DESIGNER);
 }
 
+//a callback hook to perform actions before running individual tests
 export const beforeEachCallback = () => {
   doInitialSetup();
   cy.intercept(extension.path).as(extension.alias);
@@ -30,7 +32,7 @@ export const beforeEachCallbackForCustomUrl = (customPath) => {
   cy.visit(customPath);
   cy.wait(waitFor(extension.alias), { timeout: 60_000 });
 }
-
+//captures meshmap graph screenshots and generates download link
 export const saveGraph = (cy) => {
   let image = cy.png();
   let lnk = document.createElement("a"),

playwright-action/.github/workflows/playwright.yml

@@ -0,0 +1,27 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 18
+    - name: Install dependencies
+      run: npm ci
+    - name: Install Playwright Browsers
+      run: npx playwright install --with-deps
+    - name: Run Playwright tests
+      run: npx playwright test
+    - uses: actions/upload-artifact@v3
+      if: always()
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30

playwright-action/.gitignore

@@ -0,0 +1,4 @@
+node_modules/
+/test-results/
+/playwright-report/
+/playwright/.cache/

playwright-action/helpers/playwrightSetup.js

@@ -0,0 +1,59 @@
+//@ts-check
+const { chromium } = require("@playwright/test");
+const fs = require('fs');
+const path = require('path');
+
+//utility func to generate css selector and return id and strings
+function waitFor(str) {
+      return `@${str}`;
+}
+
+function id(str) {
+      return `#${str}`;
+}
+
+
+//create a fresh testing env for testcases
+async function doInitialSetup() {
+      const browser = await chromium.launch();
+      const context = await browser.newContext();
+      const page = await context.newPage();
+
+      return { browser, context, page };
+}
+
+
+//capture and save a screenshot
+async function captureAndSaveScreenshot(page, filename) {
+      await page.screenshot({ path: filename });
+}
+
+//Save meshmapscreenshot and generate a download link.    
+async function saveGraph(customUrl) {
+      const browser = await chromium.launch();
+      const page = await browser.newPage();
+
+      // Navigate to the custom URL
+      await page.goto(customUrl);
+
+      // Capture a screenshot and save it with a custom filename
+      const date = new Date();
+      // Format: MeshMap-Fri Sep 09 2023-10:30:45 AM.png
+      const fileName = `MeshMap-${date.toDateString()}-${date.toLocaleTimeString()}.png`;
+      const filePath = path.join(__dirname, fileName); // Full path to the saved screenshot
+
+      await captureAndSaveScreenshot(page, filePath);
+
+      // Close the browser
+      await browser.close();
+
+      // Create a download link
+      const downloadLink = `/download?fileName=${encodeURIComponent(fileName)}`;
+
+      console.log(`Screenshot saved as ${fileName}`);
+      console.log('Download link:', downloadLink);
+
+      return downloadLink; 
+}
+
+export { waitFor, id, doInitialSetup, captureAndSaveScreenshot, saveGraph };

playwright-action/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "playwright-action",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {},
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@playwright/test": "^1.37.1"
+  }
+}

playwright-action/playwright.config.js

@@ -0,0 +1,81 @@
+// @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',
+  /* 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:3000',
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: 'on-first-retry',
+    // Set the timeout to 60 seconds (60000 milliseconds)
+    timeout: 60000,
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+
+    {
+      name: 'firefox',
+      use: { ...devices['Desktop Firefox'] },
+    },
+
+    {
+      name: 'webkit',
+      use: { ...devices['Desktop Safari'] },
+    },
+
+    /* Test against mobile viewports. */
+    // {
+    //   name: 'Mobile Chrome',
+    //   use: { ...devices['Pixel 5'] },
+    // },
+    // {
+    //   name: 'Mobile Safari',
+    //   use: { ...devices['iPhone 12'] },
+    // },
+
+    /* 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 start',
+  //   url: 'http://127.0.0.1:3000',
+  //   reuseExistingServer: !process.env.CI,
+  // },
+});
+