[QT-344] Verify downloaded report pdf

.github/workflows/main.yml

@@ -278,6 +278,13 @@ jobs:
           wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb -O /tmp/chrome.deb
           apt install -y /tmp/chrome.deb
 
+      - name: Install Sharp dependencies for image processing
+        shell: bash
+        run: |
+          export DEBIAN_FRONTEND=noninteractive
+          apt-get update -y
+          apt-get install -y libvips-dev
+
       - name: Copy code
         shell: bash
         run: cp -rf ./* /opt/countly
@@ -331,6 +338,6 @@ jobs:
         working-directory: /opt/countly/ui-tests/cypress
         run: |
           ARTIFACT_ARCHIVE_NAME="$(date '+%Y%m%d-%H.%M')_${GITHUB_REPOSITORY#*/}_CI#${{ github.run_number }}_${{ matrix.test_type }}.tar.gz"
-          mkdir -p screenshots videos
-          tar zcvf "$ARTIFACT_ARCHIVE_NAME" screenshots videos
+          mkdir -p screenshots videos downloads
+          tar zcvf "$ARTIFACT_ARCHIVE_NAME" screenshots videos downloads
           curl -o /tmp/uploader.log -u "${{ secrets.BOX_UPLOAD_AUTH }}" ${{ secrets.BOX_UPLOAD_PATH }} -T "$ARTIFACT_ARCHIVE_NAME"

ui-tests/cypress.config.sample.js

@@ -1,5 +1,13 @@
 const { defineConfig } = require("cypress");
-const fs = require('fs');
+const fs = require("fs");
+const pdfjsLib = require("pdfjs-dist/legacy/build/pdf.js");
+const { PNG } = require("pngjs");
+const sharp = require("sharp");
+
+// Define missing DOMMatrix in Node context (for pdfjs)
+if (typeof global.DOMMatrix === "undefined") {
+    global.DOMMatrix = class DOMMatrix { };
+}
 
 module.exports = defineConfig({
     e2e: {
@@ -14,20 +22,116 @@ module.exports = defineConfig({
         watchForFileChanges: true,
         video: true,
         setupNodeEvents(on, config) {
-            on('after:spec', (spec, results) => {
-                if (results && results.video) {
-                    const failures = results.tests.some((test) =>
-                        test.attempts.some((attempt) => attempt.state === 'failed')
-                    );
-                    if (!failures) {
-                        // delete the video if the spec passed and no tests retried
-                        const videoPath = results.video;
-                        if (fs.existsSync(videoPath)) {
-                            fs.unlinkSync(videoPath);
+            // Task: verify PDF images, logo, and text content
+            on("task", {
+                async verifyPdf({ filePath, options = {} }) {
+                    // options: { referenceLogoPath: string }
+
+                    // Load PDF file
+                    const data = new Uint8Array(fs.readFileSync(filePath));
+                    const pdfDoc = await pdfjsLib.getDocument({ data }).promise;
+
+                    // Import pixelmatch only if logo check is needed
+                    let pixelmatch;
+                    const doLogoCheck = !!options.referenceLogoPath;
+                    if (doLogoCheck) {
+                        const pm = await import("pixelmatch");
+                        pixelmatch = pm.default;
+                    }
+
+                    let hasImage = false;
+                    let logoFound = false;
+                    let extractedText = ""; //store text here
+
+                    // Loop through all pages
+                    for (let p = 1; p <= pdfDoc.numPages; p++) {
+                        const page = await pdfDoc.getPage(p);
+
+                        //Extract text content from page
+                        const textContent = await page.getTextContent();
+                        const pageText = textContent.items.map((item) => item.str).join(" ");
+                        extractedText += pageText + "\n";
+
+                        //Check for image operators
+                        const ops = await page.getOperatorList();
+
+                        for (let i = 0; i < ops.fnArray.length; i++) {
+                            const fn = ops.fnArray[i];
+                            const args = ops.argsArray[i];
+
+                            if (
+                                fn === pdfjsLib.OPS.paintImageXObject ||
+                                fn === pdfjsLib.OPS.paintJpegXObject ||
+                                fn === pdfjsLib.OPS.paintInlineImageXObject
+                            ) {
+                                hasImage = true;
+
+                                if (doLogoCheck && args[0]) {
+                                    const objName = args[0];
+                                    const imgData = await page.objs.get(objName);
+                                    if (!imgData) {
+                                        continue;
+                                    }
+
+                                    const pdfImg = new PNG({ width: imgData.width, height: imgData.height });
+                                    pdfImg.data = imgData.data;
+
+                                    const pdfBuffer = PNG.sync.write(pdfImg);
+                                    const refLogo = PNG.sync.read(fs.readFileSync(options.referenceLogoPath));
+
+                                    const resizedPdfBuffer = await sharp(pdfBuffer)
+                                        .resize(refLogo.width, refLogo.height)
+                                        .png()
+                                        .toBuffer();
+
+                                    const resizedPdfImg = PNG.sync.read(resizedPdfBuffer);
+
+                                    const diff = new PNG({ width: refLogo.width, height: refLogo.height });
+                                    const mismatched = pixelmatch(
+                                        refLogo.data,
+                                        resizedPdfImg.data,
+                                        diff.data,
+                                        refLogo.width,
+                                        refLogo.height,
+                                        { threshold: 0.1 }
+                                    );
+
+                                    if (mismatched === 0) {
+                                        logoFound = true;
+                                        break;
+                                    }
+                                }
+                            }
                         }
+
+                        if ((doLogoCheck && logoFound) || (!doLogoCheck && hasImage)) {
+                            break;
+                        }
+                    }
+
+                    if (doLogoCheck && !logoFound) {
+                        throw new Error("Logo in PDF does not match reference image");
+                    }
+
+                    //Return with extracted text
+                    return {
+                        hasImage,
+                        logoFound,
+                        text: extractedText,
+                        numPages: pdfDoc.numPages
+                    };
+                },
+            });
+
+            on("after:spec", (spec, results) => {
+                if (results?.video) {
+                    const hasFailures = results.tests.some((t) => t.attempts.some((a) => a.state === "failed"));
+                    if (!hasFailures && fs.existsSync(results.video)) {
+                        fs.unlinkSync(results.video);
                     }
                 }
             });
+
             on("before:browser:launch", (browser, launchOptions) => {
                 if (["chrome", "edge", "electron"].includes(browser.name)) {
                     if (browser.isHeadless) {
@@ -42,6 +146,4 @@ module.exports = defineConfig({
             });
         },
     },
-});
-
-
+});

ui-tests/cypress/e2e/dashboard/dashboards/dashboards.cy.js

@@ -1,4 +1,8 @@
+/* eslint-env mocha */
+/* global cy, Cypress, expect */
+
 import user from '../../../fixtures/user.json';
+const getApiKey = require('../../../api/getApiKey');
 const navigationHelpers = require('../../../support/navigations');
 const helper = require('../../../support/helper');
 const loginHelpers = require('../../../lib/login/login');
@@ -17,7 +21,7 @@ describe('Create New Custom Dashboard', () => {
     });
 
     it(`
-        Create a custom dashboard with a widget and an email report, and then verify the report preview using these parameters:
+        Create a custom dashboard with a widget and an email report, verify the report preview, and validate the downloaded PDF content:
         //***Dashboard***
         Dashboard Visibility: All Users (default)
         //***Widget***
@@ -84,6 +88,53 @@ describe('Create New Custom Dashboard', () => {
 
         reportHelper.openReportPreviewButton();
         reportHelper.verifyReportPreviewPageImage();
+
+        // Get the current URL
+        cy.url().then((currentUrl) => {
+
+            //Get API key
+            getApiKey.request(user.username, user.password).then((apiKey) => {
+
+                //Change preview to PDF and add api_key parameter
+                const urlObj = new URL(currentUrl);
+                urlObj.pathname = urlObj.pathname.replace('preview', 'pdf');
+                urlObj.searchParams.set('api_key', apiKey);
+                const pdfURL = urlObj.toString();
+
+                cy.log('Generated PDF URL:', pdfURL);
+
+                //Download the PDF and verify its content
+                cy.request({
+                    url: pdfURL,
+                    encoding: 'binary',
+                    timeout: 120000,
+                }).then((response) => {
+                    expect(response.status).to.eq(200);
+                    expect(response.headers['content-type']).to.include('application/pdf');
+
+                    const buf = Buffer.from(response.body, 'binary');
+                    expect(buf.slice(0, 4).toString()).to.eq('%PDF');
+                    expect(buf.length).to.be.greaterThan(50000); // More than 50KB to ensure it's not empty
+
+                    // Save the PDF to disk
+                    cy.writeFile('cypress/downloads/generated-report.pdf', buf);
+                });
+            });
+        });
+
+        // Verify PDF content
+        cy.task("verifyPdf", {
+            filePath: "cypress/downloads/generated-report.pdf",
+            options: {
+                referenceLogoPath: "cypress/fixtures/testFiles/countly-logo.png",
+                checkText: true
+            }
+        }).then((result) => {
+            expect(result.logoFound).to.be.true;
+            expect(result.hasImage).to.be.true;
+            expect(result.text).to.include("Sent by   Countly   |   Unsubscribe");
+            expect(result.text).to.include("Report settings   |   Get help");
+        });
     });
 
     it(`Create a private custom dashboard and duplicate it and edit it and delete it then verify the flow`, function() {