Merge pull request #105 from parthlambdatest/Dot-3170

[Dot-3170] Handled non image files

Author: sushobhit-lt

src/commander/upload.ts

@@ -1,4 +1,5 @@
 import fs from 'fs';
+import path from 'path';
 import { Command } from 'commander';
 import { Context } from '../types.js';
 import { color, Listr, ListrDefaultRendererLogLevels } from 'listr2';
@@ -8,6 +9,7 @@ import getGitInfo from '../tasks/getGitInfo.js';
 import createBuild from '../tasks/createBuild.js';
 import uploadScreenshots from '../tasks/uploadScreenshots.js';
 import finalizeBuild from '../tasks/finalizeBuild.js';
+import constants from '../lib/constants.js';
 
 const command = new Command();
 
@@ -31,6 +33,11 @@ command
             return;
         }
 
+        if (path.extname(directory).toLowerCase() === constants.ZIP_EXTENSION) {
+            ctx.log.debug(`Zips are not accepted.  ${directory}`)
+            console.log(`Error: The provided directory ${directory} is a zip file. Zips are not accepted.`);
+            return;
+        }
         ctx.uploadFilePath = directory;
 
         let tasks = new Listr<Context>(

src/lib/constants.ts

@@ -67,6 +67,16 @@ export default {
     // log file path
     LOG_FILE_PATH: '.smartui.log',
 
+    // Disallowed Zip Extension
+    ZIP_EXTENSION: '.zip',
+
+    // Magic Numbers 
+    MAGIC_NUMBERS: [
+        { ext: 'jpg', magic: Buffer.from([0xFF, 0xD8, 0xFF]) },
+        { ext: 'jpeg', magic: Buffer.from([0xFF, 0xD8, 0xFF]) },
+        { ext: 'png', magic: Buffer.from([0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A]) },
+    ],
+
     SUPPORTED_MOBILE_DEVICES: {
         'Blackberry KEY2 LE': { os: 'android', viewport: {width: 412, height: 618}},
         'Galaxy A12': { os: 'android', viewport: {width: 360, height: 800}},

src/lib/screenshot.ts

@@ -165,8 +165,14 @@ function getImageDimensions(filePath: string): { width: number, height: number }
     return null;
 }
 
+function isImage(buffer: Buffer): boolean {
+
+    return constants.MAGIC_NUMBERS.some(magic => buffer.slice(0, magic.magic.length).equals(magic.magic));
+}
+
 export async function uploadScreenshots(ctx: Context): Promise<void> {
     const allowedExtensions = ctx.options.fileExtension.map(ext => `.${ext.trim().toLowerCase()}`);
+    let noOfScreenshots = 0;
 
     async function processDirectory(directory: string, relativePath: string = ''): Promise<void> {
         const files = fs.readdirSync(directory);
@@ -177,6 +183,7 @@ export async function uploadScreenshots(ctx: Context): Promise<void> {
             const relativeFilePath = path.join(relativePath, file);
 
             if (stat.isDirectory() && ctx.options.ignorePattern.includes(relativeFilePath)) {
+                ctx.log.debug(`Ignoring Directory ${relativeFilePath}`)
                 continue; // Skip this path
             }
 
@@ -185,6 +192,13 @@ export async function uploadScreenshots(ctx: Context): Promise<void> {
             } else {
                 let fileExtension = path.extname(file).toLowerCase();
                 if (allowedExtensions.includes(fileExtension)) {
+                    const fileBuffer = fs.readFileSync(filePath);
+
+                    if (!isImage(fileBuffer)) {
+                        ctx.log.debug(`File ${filePath} is not a valid ${fileExtension} image. Skipping.`);
+                        continue;
+                    }
+
                     let ssId = relativeFilePath;
                     if (ctx.options.stripExtension) {
                         ssId = path.join(relativePath, path.basename(file, fileExtension));
@@ -195,18 +209,26 @@ export async function uploadScreenshots(ctx: Context): Promise<void> {
                     if (!ctx.options.ignoreResolutions) {
                         const dimensions = getImageDimensions(filePath);
                         if (!dimensions) {
-                            throw new Error(`Unable to determine dimensions for image: ${filePath}`);
+                            ctx.log.debug(`Unable to determine dimensions for image: ${filePath}`)
+                        } else {
+                            const width = dimensions.width;
+                            const height = dimensions.height;
+                            viewport = `${width}x${height}`;
                         }
-                        const width = dimensions.width;
-                        const height = dimensions.height;
-                        viewport = `${width}x${height}`;
                     }
 
                     await ctx.client.uploadScreenshot(ctx.build, filePath, ssId, 'default', viewport, ctx.log);
+                    ctx.log.debug(`${filePath} : uploaded successfully`)
+                    noOfScreenshots++;
                 }
             }
         }
     }
 
     await processDirectory(ctx.uploadFilePath);
+    if(noOfScreenshots == 0){
+        console.log(`No screenshots uploaded.`);
+    } else {
+        console.log(`${noOfScreenshots} screenshots uploaded successfully.`);
+    }
 }