init (#166, #167, #168, #171)

Author: Naseem77

.github/workflows/playwright.yml

@@ -0,0 +1,27 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+    - 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@v4
+      if: ${{ !cancelled() }}
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30

.gitignore

@@ -37,4 +37,9 @@ next-env.d.ts
 
 
 # vscode
-/.vscode/
+/.vscode/
+node_modules/
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

e2e/infra/api/apiRequests.ts

@@ -0,0 +1,24 @@
+import { APIRequestContext, request } from "@playwright/test"
+
+
+const getRequest = async (url: string, body: any, availableRequest?: APIRequestContext, headers?: Record<string, string>) => {
+  const requestOptions = {
+    data: body,
+    headers: headers || undefined,
+  };
+
+  const requestContext = availableRequest || (await request.newContext());
+  return await requestContext.get(url, requestOptions);
+};
+
+const postRequest = async (url: string, body: any, availableRequest?: APIRequestContext, headers?: Record<string, string>) => {
+  const requestOptions = {
+    data: body,
+    headers: headers || undefined,
+  };
+
+  const requestContext = availableRequest || (await request.newContext());
+  return await requestContext.post(url, requestOptions);
+};
+
+export{ getRequest, postRequest }

e2e/infra/ui/basePage.ts

@@ -0,0 +1,22 @@
+import { Page } from 'playwright';
+
+export default class BasePage {
+    protected page: Page;
+
+    constructor(page: Page) {
+        this.page = page;
+    }
+
+    async initPage(){
+        await this.page.waitForLoadState()
+    }
+
+    getCurrentURL() : string {
+        return this.page.url();
+    }
+
+    async refreshPage(){
+        await this.page.reload({ waitUntil: 'networkidle' });
+    }
+
+}

e2e/infra/ui/browserWrapper.ts

@@ -0,0 +1,62 @@
+import { chromium, Browser, BrowserContext, Page } from 'playwright';
+import BasePage from './basePage';
+
+export default class BrowserWrapper {
+
+    private browser: Browser | null = null;
+
+    private context: BrowserContext | null = null;
+
+    private page: Page | null = null;
+
+    async createNewPage<T extends BasePage>(pageClass: new (page: Page) => T, url?: string) {
+        if (!this.browser) {
+            this.browser = await chromium.launch();
+        }
+        if (!this.context) {
+            this.context = await this.browser.newContext();
+        }
+        if (!this.page) {
+            this.page = await this.context.newPage();
+        }
+        if (url) {
+            await this.navigateTo(url)
+        }
+
+        const pageInstance = new pageClass(this.page);
+        return pageInstance;
+    }
+
+    async getPage() {
+        if (!this.page) {
+            throw new Error('Browser is not launched yet!');
+        }
+        return this.page;
+    }
+
+    async setPageToFullScreen() {
+        if (!this.page) {
+            throw new Error('Browser is not launched yet!');
+        }
+        await this.page.setViewportSize({ width: 1920, height: 1080 });
+    }
+
+    async navigateTo(url: string) {
+        if (!this.page) {
+            throw new Error('Browser is not launched yet!');
+        }
+        await this.page.goto(url);
+        await this.page.waitForLoadState('networkidle');
+    }
+      
+    async closePage() {
+        this.page ? await this.page.close() : this.page = null;
+    }
+    
+    async closeBrowser() {
+        if (this.browser) {
+            await this.browser.close();
+        }
+    }
+
+}

package-lock.json

@@ -35,6 +35,7 @@
     "web-tree-sitter": "^0.22.6"
   },
   "devDependencies": {
+    "@playwright/test": "^1.48.2",
     "@types/cytoscape-fcose": "^2.2.4",
     "@types/node": "^22",
     "@types/react": "^18",

package.json

@@ -0,0 +1,79 @@
+import { defineConfig, devices } from '@playwright/test';
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// import dotenv from 'dotenv';
+// import path from 'path';
+// dotenv.config({ path: path.resolve(__dirname, '.env') });
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: './e2e/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',
+  },
+
+  /* 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,
+  // },
+});