WIP: One Trust Test Case

neelkanth-kaushik · neelkanth-kaushik · commit 68fd11a3ecaa · 2025-04-29T08:50:35.000+05:30
diff --git a/packages/consent/consent-tools-integration-tests/README.md b/packages/consent/consent-tools-integration-tests/README.md
@@ -22,7 +22,7 @@ yarn . test:int
 ### Debugging Tips:
 - Webdriver.io has the handy `browser.debug()` command.
 
-- You can serve the static pages by themselves (without webdriver.io) with the following:
+- You can serve the static pages by themselves (without Playwright) with the following:
 ```
 yarn webpack -w &
 npx live-server .
diff --git a/packages/consent/consent-tools-integration-tests/package.json b/packages/consent/consent-tools-integration-tests/package.json
@@ -4,6 +4,7 @@
   "scripts": {
     ".": "yarn run -T turbo run --filter=@internal/consent-tools-integration-tests...",
     "test:int": "playwright test",
+    "test:int-debug": "playwright test --debug",
     "build": "webpack",
     "watch": "yarn build --watch",
     "lint": "yarn concurrently 'yarn:eslint .' 'yarn:tsc --noEmit'",
diff --git a/packages/consent/consent-tools-integration-tests/public/consent-tools-onetrust.html b/packages/consent/consent-tools-integration-tests/public/consent-tools-onetrust.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<body>
+  <h1>Hello World - Serving Analytics</h1>
+  <h2>Please Check Network tab</h2>
+  <p>This page can used as playground or run by Playwright</p>
+  <!-- <script src="https://cdn.cookielaw.org/scripttemplates/otSDKStub.js" type="text/javascript" charset="UTF-8"
+    data-domain-script="80ca7b5c-e72f-4bd0-972a-b74d052a0820-test"></script>
+  <script src="https://cdn.jsdelivr.net/npm/@segment/analytics-consent-wrapper-onetrust@latest/dist/umd/analytics-onetrust.global.js"></script> -->
+</body>
+</html>
diff --git a/packages/consent/consent-tools-integration-tests/public/consent-tools-vanilla-opt-in.html b/packages/consent/consent-tools-integration-tests/public/consent-tools-vanilla-opt-in.html
@@ -4,7 +4,7 @@
 <body>
   <h1>Hello World - Serving Analytics</h1>
   <h2>Please Check Network tab</h2>
-  <p>This page can used as playground or run by webdriver.io</p>
+  <p>This page can used as playground or run by Playwright</p>
   <script src="dist/consent-tools-vanilla-opt-in.bundle.js"></script>
 </body>
 
diff --git a/packages/consent/consent-tools-integration-tests/public/consent-tools-vanilla-opt-out.html b/packages/consent/consent-tools-integration-tests/public/consent-tools-vanilla-opt-out.html
@@ -4,7 +4,7 @@
 <body>
   <h1>Hello World - Serving Analytics (Consent Tools Vanilla Opt Out)</h1>
   <h2>Please Check Network tab</h2>
-  <p>This page can used as playground or run by webdriver.io</p>
+  <p>This page can used as playground or run by Playwright</p>
   <script src="dist/consent-tools-vanilla-opt-out.bundle.js"></script>
 </body>
 
diff --git a/packages/consent/consent-tools-integration-tests/public/onetrust.html b/packages/consent/consent-tools-integration-tests/public/onetrust.html
diff --git a/packages/consent/consent-tools-integration-tests/src/page-bundles/onetrust/index.ts b/packages/consent/consent-tools-integration-tests/src/page-bundles/onetrust/index.ts
@@ -0,0 +1,12 @@
+import { AnalyticsBrowser } from '@segment/analytics-next'
+import { withMockCMP } from '../helpers/mock-cmp-wrapper'
+
+const analytics = new AnalyticsBrowser()
+
+withMockCMP(analytics).load(
+  {
+    writeKey: 'foo',
+  },
+  { initialPageview: true }
+)
+;(window as any).analytics = analytics
diff --git a/packages/consent/consent-tools-integration-tests/src/page-objects/onetrust.ts b/packages/consent/consent-tools-integration-tests/src/page-objects/onetrust.ts
@@ -1,18 +1,35 @@
+// page-objects/onetrust.ts
 import { Page } from '@playwright/test'
 import { BasePage } from './base-page'
 
-export class OneTrustPage extends BasePage {
+class OneTrustPage extends BasePage {
   constructor(page: Page) {
-    super(page, 'onetrust.html')
+    super(page, 'consent-tools-onetrust.html')
   }
 
-  // Check if OneTrust is loaded by evaluating a global variable on the page
-  async isOneTrustLoaded() {
-    // To Do
+  // Check for global variable `window.isOneTrustLoaded`
+  async isOneTrustLoaded(): Promise<boolean> {
+    return await this.page.evaluate(() => {
+      return Boolean((window as any).isOneTrustLoaded)
+    })
   }
 
-  //Click the OneTrust accept button
-  async clickAcceptButtonAndClosePopup() {
-    // To Do
+  async clickGiveConsent() {
+    //await this.page.click('#onetrust-accept-btn-handler')
+    const acceptButton = this.page.locator('#onetrust-accept-btn-handler')
+    await acceptButton.waitFor({ state: 'visible' }) // Ensure the button is visible
+    await acceptButton.click()
+  }
+
+  async clickDenyConsent() {
+    const rejectButton = await this.page.locator('#onetrust-reject-all-handler')
+    await rejectButton.waitFor({ state: 'visible' }) // Ensure the button is visible
+    await rejectButton.click()
+  }
+}
+
+export class OneTrustConsentPage extends OneTrustPage {
+  constructor(page: Page) {
+    super(page)
   }
 }
diff --git a/packages/consent/consent-tools-integration-tests/src/tests/onetrust.test.ts b/packages/consent/consent-tools-integration-tests/src/tests/onetrust.test.ts
@@ -0,0 +1,47 @@
+import { test, expect } from '@playwright/test'
+import { OneTrustConsentPage } from '../page-objects/onetrust'
+
+// Setup for your page object
+let pageObject: OneTrustConsentPage
+
+test.beforeEach(async ({ page: p }) => {
+  // Initialize the page object
+  pageObject = new OneTrustConsentPage(p)
+
+  // Load the page
+  await pageObject.load()
+})
+
+test.afterEach(async () => {
+  await pageObject.cleanup()
+})
+
+test('should send a consent changed event when user clicks accept on popup', async ({
+  page,
+}) => {
+  // Pause for a brief moment if needed
+  await page.waitForTimeout(1000)
+
+  // Check that no consent changed event is initially sent
+  const consentChangedEvents = pageObject.getConsentChangedEvents()
+  expect(consentChangedEvents.length).toBe(0)
+
+  await page.waitForSelector('#onetrust-accept-btn-handler', { timeout: 5000 })
+
+  // Make a consent selection in the OneTrust popup
+  await pageObject.clickGiveConsent()
+
+  await page.waitForTimeout(2000)
+  // Optional: print all tracking events for debug purposes
+  console.log('All tracking events so far:', pageObject.getAllTrackingEvents())
+  // // Wait for the consent changed event to be sent using poll and a timeout
+  // await expect
+  //   .poll(() => pageObject.getConsentChangedEvents().length, {
+  //     timeout: 10_000, // Timeout after 10 seconds
+  //   })
+  //   .toBeGreaterThan(0) // Ensure the consent event count increases
+
+  // // Ensure that exactly 1 consent changed event was sent
+  // const updatedConsentChangedEvents = pageObject.getConsentChangedEvents()
+  // expect(updatedConsentChangedEvents.length).toBe(1)
+})
