diff --git a/README.md b/README.md
index 60368817d21e40d2005f9ca40af020100ed0bf9b..1efd2feaa0d58bcd14046b6956bd85a1a16245e9 100644
--- a/README.md
+++ b/README.md
@@ -1,93 +1,93 @@
-# Drishiti
+# Visual Regression Testing Tool
+A simple visual regression testing tool powered by Playwright for automated screenshot comparison across your website.
+## Overview
+This tool helps you perform visual regression testing by automatically capturing and comparing screenshots of your website pages. It's particularly useful for detecting unwanted visual changes during development and staging.
-## Getting started
+## Requirements
+* See [Playwright requirements](https://playwright.dev/docs/intro#system-requirements)
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+## Installation
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+```bash
+npm install
+npx playwright install
+```
-## Add your files
+## Usage
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+### 1. Configure Test Links
+You have several options to specify which pages to test:
+#### Option A: Auto-generate from your site
+```bash
+DOMAIN=niveussolutions.com npx playwright test init
```
-cd existing_repo
-git remote add origin https://gitlab.niveussolutions.com/akshay.k/drishiti.git
-git branch -M master
-git push -uf origin master
+This will create `tests/links.json` with all internal links from your homepage.
+
+#### Option B: Use sitemap.xml
+1. Get your sitemap from `https://niveussolutions.com/sitemap.xml`
+2. Convert the sitemap to a list of URLs
+3. Convert the list to JSON format
+4. Create `tests/links.json` and paste the JSON
+
+#### Option C: Manual Creation
+Create `tests/links.json` manually with relative URLs:
+```json
+[
+ "/about",
+ "/services",
+ "/contact",
+ "/blog/post-1"
+]
```
-## Integrate with your tools
-
-- [ ] [Set up project integrations](https://gitlab.niveussolutions.com/akshay.k/drishiti/-/settings/integrations)
-
-## Collaborate with your team
-
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
-
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
-
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
-
-***
-
-# Editing this README
-
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
-
-## Suggestions for a good README
+**Note:** `tests/links.json` should contain relative URLs (without domain). The domain is set via the `DOMAIN` environment variable without protocol (e.g., `niveussolutions.com`, not `https://niveussolutions.com`).
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+### 2. Configure Browsers
+Edit `playwright.config.js` to enable/disable desired browsers by uncommenting them in the projects section.
-## Name
-Choose a self-explaining name for your project.
-
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
-
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
-
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+### 3. Generate Reference Screenshots
+Run this command to create your baseline screenshots:
+```bash
+DOMAIN=niveussolutions.com npx playwright test vr -u
+```
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+### 4. Run Comparison Tests
+Test against your staging environment:
+```bash
+DOMAIN=staging.niveussolutions.com npx playwright test vr
+```
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+### 5. View Results
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+#### Option A: Interactive Report
+```bash
+npx playwright show-report
+```
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+#### Option B: Manual Access
+The `playwright-report` folder contains the complete report with screenshots. You can:
+- Open it directly in a browser
+- Serve it using any static file server
+- Share it with your team
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+## Example Testing Flow
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+1. Generate baseline screenshots from production:
+```bash
+DOMAIN=niveussolutions.com npx playwright test vr -u
+```
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+2. Test staging environment against production baseline:
+```bash
+DOMAIN=staging.niveussolutions.com npx playwright test vr
+```
-## License
-For open source projects, say how it is licensed.
+3. Review the results:
+```bash
+npx playwright show-report
+```
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+This will highlight any visual differences between your production and staging environments.
\ No newline at end of file
diff --git a/automate_playwright.sh b/automate_playwright.sh
new file mode 100755
index 0000000000000000000000000000000000000000..a58217ce5c421151c500c793394252515b5b0909
--- /dev/null
+++ b/automate_playwright.sh
@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# Define the first domain
+DOMAIN1="niveussolutions.com"
+
+# Commands for the first domain
+echo "Fetching all the sublinks for DOMAIN=$DOMAIN1"
+DOMAIN=$DOMAIN1 npx playwright test init
+
+echo "Saving base screenshot of DOMAIN=$DOMAIN1"
+DOMAIN=$DOMAIN1 npx playwright test vr -u
+
+# Define the second domain
+DOMAIN2="niveussolutions.com"
+
+# Final command for the second domain
+echo "Saving staging screenshot of DOMAIN=$DOMAIN2"
+DOMAIN=$DOMAIN2 npx playwright test vr
+
+echo "Visual Regression testing is Completed Successfully"
\ No newline at end of file
diff --git a/package-lock.json b/package-lock.json
new file mode 100644
index 0000000000000000000000000000000000000000..c241d60b3c2b51547b6da332a9f495f549b96418
--- /dev/null
+++ b/package-lock.json
@@ -0,0 +1,157 @@
+{
+ "name": "visual-testing",
+ "version": "1.0.0",
+ "lockfileVersion": 2,
+ "requires": true,
+ "packages": {
+ "": {
+ "name": "visual-testing",
+ "version": "1.0.0",
+ "license": "ISC",
+ "dependencies": {
+ "sonar-scanner": "^3.1.0"
+ },
+ "devDependencies": {
+ "@playwright/test": "^1.50.0",
+ "@types/node": "^20.9.0"
+ }
+ },
+ "node_modules/@playwright/test": {
+ "version": "1.50.0",
+ "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.50.0.tgz",
+ "integrity": "sha512-ZGNXbt+d65EGjBORQHuYKj+XhCewlwpnSd/EDuLPZGSiEWmgOJB5RmMCCYGy5aMfTs9wx61RivfDKi8H/hcMvw==",
+ "dev": true,
+ "dependencies": {
+ "playwright": "1.50.0"
+ },
+ "bin": {
+ "playwright": "cli.js"
+ },
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@types/node": {
+ "version": "20.9.0",
+ "resolved": "https://registry.npmjs.org/@types/node/-/node-20.9.0.tgz",
+ "integrity": "sha512-nekiGu2NDb1BcVofVcEKMIwzlx4NjHlcjhoxxKBNLtz15Y1z7MYf549DFvkHSId02Ax6kGwWntIBPC3l/JZcmw==",
+ "dev": true,
+ "dependencies": {
+ "undici-types": "~5.26.4"
+ }
+ },
+ "node_modules/fsevents": {
+ "version": "2.3.2",
+ "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz",
+ "integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==",
+ "dev": true,
+ "hasInstallScript": true,
+ "optional": true,
+ "os": [
+ "darwin"
+ ],
+ "engines": {
+ "node": "^8.16.0 || ^10.6.0 || >=11.0.0"
+ }
+ },
+ "node_modules/playwright": {
+ "version": "1.50.0",
+ "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.50.0.tgz",
+ "integrity": "sha512-+GinGfGTrd2IfX1TA4N2gNmeIksSb+IAe589ZH+FlmpV3MYTx6+buChGIuDLQwrGNCw2lWibqV50fU510N7S+w==",
+ "dev": true,
+ "dependencies": {
+ "playwright-core": "1.50.0"
+ },
+ "bin": {
+ "playwright": "cli.js"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "optionalDependencies": {
+ "fsevents": "2.3.2"
+ }
+ },
+ "node_modules/playwright-core": {
+ "version": "1.50.0",
+ "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.50.0.tgz",
+ "integrity": "sha512-CXkSSlr4JaZs2tZHI40DsZUN/NIwgaUPsyLuOAaIZp2CyF2sN5MM5NJsyB188lFSSozFxQ5fPT4qM+f0tH/6wQ==",
+ "dev": true,
+ "bin": {
+ "playwright-core": "cli.js"
+ },
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/sonar-scanner": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/sonar-scanner/-/sonar-scanner-3.1.0.tgz",
+ "integrity": "sha512-KD7W3wHCKJKAakhn8ckxNYTxkdb1cnJa3ot0NVvO8CCeJjb0yvF0fW2yGdI09zMHsqxCRsl4dLtyCL2SUv47WA==",
+ "hasInstallScript": true,
+ "bin": {
+ "sonar-scanner": "index.js"
+ }
+ },
+ "node_modules/undici-types": {
+ "version": "5.26.5",
+ "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz",
+ "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==",
+ "dev": true
+ }
+ },
+ "dependencies": {
+ "@playwright/test": {
+ "version": "1.50.0",
+ "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.50.0.tgz",
+ "integrity": "sha512-ZGNXbt+d65EGjBORQHuYKj+XhCewlwpnSd/EDuLPZGSiEWmgOJB5RmMCCYGy5aMfTs9wx61RivfDKi8H/hcMvw==",
+ "dev": true,
+ "requires": {
+ "playwright": "1.50.0"
+ }
+ },
+ "@types/node": {
+ "version": "20.9.0",
+ "resolved": "https://registry.npmjs.org/@types/node/-/node-20.9.0.tgz",
+ "integrity": "sha512-nekiGu2NDb1BcVofVcEKMIwzlx4NjHlcjhoxxKBNLtz15Y1z7MYf549DFvkHSId02Ax6kGwWntIBPC3l/JZcmw==",
+ "dev": true,
+ "requires": {
+ "undici-types": "~5.26.4"
+ }
+ },
+ "fsevents": {
+ "version": "2.3.2",
+ "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz",
+ "integrity": "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==",
+ "dev": true,
+ "optional": true
+ },
+ "playwright": {
+ "version": "1.50.0",
+ "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.50.0.tgz",
+ "integrity": "sha512-+GinGfGTrd2IfX1TA4N2gNmeIksSb+IAe589ZH+FlmpV3MYTx6+buChGIuDLQwrGNCw2lWibqV50fU510N7S+w==",
+ "dev": true,
+ "requires": {
+ "fsevents": "2.3.2",
+ "playwright-core": "1.50.0"
+ }
+ },
+ "playwright-core": {
+ "version": "1.50.0",
+ "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.50.0.tgz",
+ "integrity": "sha512-CXkSSlr4JaZs2tZHI40DsZUN/NIwgaUPsyLuOAaIZp2CyF2sN5MM5NJsyB188lFSSozFxQ5fPT4qM+f0tH/6wQ==",
+ "dev": true
+ },
+ "sonar-scanner": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/sonar-scanner/-/sonar-scanner-3.1.0.tgz",
+ "integrity": "sha512-KD7W3wHCKJKAakhn8ckxNYTxkdb1cnJa3ot0NVvO8CCeJjb0yvF0fW2yGdI09zMHsqxCRsl4dLtyCL2SUv47WA=="
+ },
+ "undici-types": {
+ "version": "5.26.5",
+ "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz",
+ "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==",
+ "dev": true
+ }
+ }
+}
diff --git a/package.json b/package.json
new file mode 100644
index 0000000000000000000000000000000000000000..ee4d0a8b2c350d5d53a161c8ac70db845e9de53c
--- /dev/null
+++ b/package.json
@@ -0,0 +1,19 @@
+{
+ "name": "visual-testing",
+ "version": "1.0.0",
+ "description": "",
+ "main": "index.js",
+ "scripts": {
+ "sonar": "sonar-scanner"
+ },
+ "keywords": [],
+ "author": "",
+ "license": "ISC",
+ "devDependencies": {
+ "@playwright/test": "^1.50.0",
+ "@types/node": "^20.9.0"
+ },
+ "dependencies": {
+ "sonar-scanner": "^3.1.0"
+ }
+}
diff --git a/playwright.config.js b/playwright.config.js
new file mode 100644
index 0000000000000000000000000000000000000000..7153976576daac608fdbdd076045a444a5493a72
--- /dev/null
+++ b/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({
+ timeout: 70000,
+ expect: { timeout: 70000 },
+ 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',
+ },
+
+ /* 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,
+ // },
+});
+
diff --git a/sonar-project.properties b/sonar-project.properties
new file mode 100644
index 0000000000000000000000000000000000000000..45ece4b279b984bf79c7c864573d4f9e8127e720
--- /dev/null
+++ b/sonar-project.properties
@@ -0,0 +1,11 @@
+# Required metadata
+sonar.projectKey=my-project-key
+sonar.projectName=My Project
+sonar.projectVersion=1.0
+
+# Path to source directories
+sonar.sources=tests
+
+# Language-specific configuration
+sonar.language=js
+sonar.sourceEncoding=UTF-8
\ No newline at end of file
diff --git a/tests/init.spec.js b/tests/init.spec.js
new file mode 100644
index 0000000000000000000000000000000000000000..2435a410a3245a0efb41c464508467f65f1622d1
--- /dev/null
+++ b/tests/init.spec.js
@@ -0,0 +1,56 @@
+// @ts-check
+import { test, expect } from '@playwright/test';
+
+const domain = process.env.DOMAIN ?? '';
+
+test('Setup', async ({ page }) => {
+ await page.goto('https://' + domain, {timeout: 70000});
+ // Get all a elements
+ const links = await page.getByRole('link', {includeHidden: true}).all();
+ // Loop through links
+ let allow_links = [];
+ for (let link of links) {
+ let href = await link.getAttribute('href');
+ // Skip absolute links without expected domain and normalize
+ if (href?.indexOf('http') !== -1) {
+ if (href?.indexOf(domain) !== -1) {
+ href = href
+ ?.replace('https://', '')
+ ?.replace('http://', '')
+ ?.replace('www.', '')
+ ?.replace(domain, '') ?? '';
+ }
+ else {
+ continue;
+ }
+ }
+ // if trimmed href is empty, skip it
+ if (href?.trim() === '') {
+ continue;
+ }
+ if (href?.indexOf('mailto') !== -1) {
+ continue;
+ }
+ if (href?.indexOf('about:blank') !== -1) {
+ continue;
+ }
+ if (href?.indexOf('javascript') !== -1) {
+ continue;
+ }
+ if (href?.indexOf('tel') !== -1) {
+ continue;
+ }
+ // if link not start with /, skip it
+ if (href?.indexOf('/') !== 0) {
+ continue;
+ }
+ allow_links.push(href);
+ }
+ // Remove duplicates
+ allow_links = [...new Set(allow_links)];
+ // Sort links
+ allow_links.sort();
+ // Write allow_links to file as json
+ const fs = require('fs');
+ fs.writeFileSync('tests/links.json', JSON.stringify(allow_links, null, 2));
+});
diff --git a/tests/vr.spec.js b/tests/vr.spec.js
new file mode 100644
index 0000000000000000000000000000000000000000..09eadcf528f2b8ec3daf87fe29ce5869a4855f0e
--- /dev/null
+++ b/tests/vr.spec.js
@@ -0,0 +1,21 @@
+// @ts-check
+import { test, expect } from '@playwright/test';
+
+const links = require('./links.json');
+
+const domain = process.env.DOMAIN ?? '';
+
+test.describe(`Visual regression`, () => {
+ for (let link of links) {
+ test(`Check ${link}`, async ({ page }) => {
+ let response = await page.goto(`https://${domain}${link}`, {timeout: 70000});
+ // Wait that page fully loaded
+ await page.waitForLoadState('load', {timeout: 70000});
+ // Check page status should be 200
+ await expect(response?.ok(), 'Page status should be OK').toBeTruthy();
+ // Visual regression
+ await expect(page).toHaveScreenshot({ maxDiffPixels: 10 });
+ })
+ }
+});
+