Merge pull request #458 from shrinishLT/DOT-6357

PDF Name Support

Author: parthlambdatest

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lambdatest/smartui-cli",
-  "version": "4.1.52",
+  "version": "4.1.53",
   "description": "A command line interface (CLI) to run SmartUI tests on LambdaTest",
   "files": [
     "dist/**/*"

src/commander/uploadPdf.ts

@@ -15,6 +15,7 @@ command
     .option('--fetch-results [filename]', 'Fetch results and optionally specify an output file, e.g., <filename>.json')
     .option('--buildName <string>', 'Specify the build name')
     .option('--markBaseline', 'Mark this build baseline')
+    .option('--pdfNames <string>', 'Specify PDF names for the upload')
     .action(async function(directory, _, command) {
         const options = command.optsWithGlobals();
         if (options.buildName === '') {

src/lib/ctx.ts

@@ -227,7 +227,8 @@ export default (options: Record<string, string>): Context => {
             githubURL : options.gitURL || options.githubURL || '',
             showRenderErrors: options.showRenderErrors ? true : false,
             userName: options.userName || '',
-            accessKey: options.accessKey || ''
+            accessKey: options.accessKey || '',
+            pdfNames: options.pdfNames || ''
         },
         cliVersion: version,
         totalSnapshots: -1,

src/lib/httpClient.ts

@@ -772,14 +772,17 @@ export default class httpClient {
         }
     }
 
-    async uploadPdf(ctx: Context, form: FormData, buildName?: string): Promise<any> {
+    async uploadPdf(ctx: Context, form: FormData, buildName?: string, pdfNames?: string): Promise<any> {
         form.append('projectToken', this.projectToken);
         if (ctx.build.name !== undefined && ctx.build.name !== '') {
             form.append('buildName', buildName);
         }
         if (ctx.options.markBaseline) {
             form.append('markBaseline', ctx.options.markBaseline.toString());
         }
+        if (pdfNames && pdfNames !== '') {
+            form.append('pdfNames', pdfNames);
+        }
 
         try {
             const response = await this.axiosInstance.request({

src/lib/screenshot.ts

@@ -79,7 +79,7 @@ async function captureScreenshotsForConfig(
                 };
             } else {
                 const geoResp = await ctx.client.getGeolocationProxy(ctx.config.geolocation, ctx.log);
-            ctx.log.debug(`Geolocation proxy response: ${JSON.stringify(geoResp)}`);
+                ctx.log.debug(`Geolocation proxy response: ${JSON.stringify(geoResp)}`);
             if (geoResp && geoResp.data && geoResp.data.proxy && geoResp.data.username && geoResp.data.password) {
                 ctx.log.info(`URL Capture :: Using geolocation proxy for ${ctx.config.geolocation}`);
                     ctx.geolocationData = {

src/tasks/uploadPdfs.ts

@@ -35,7 +35,7 @@ async function uploadPdfs(ctx: Context, pdfPath: string): Promise<void> {
         formData.append('pathToFiles', fs.createReadStream(pdfPath));
     } else {
         const files = fs.readdirSync(pdfPath);
-        const pdfFiles = files.filter(file => file.endsWith('.pdf'));
+        const pdfFiles = files.filter(file => file.endsWith('.pdf')).sort();
 
         pdfFiles.forEach(pdf => {
             const filePath = path.join(pdfPath, pdf);
@@ -44,13 +44,14 @@ async function uploadPdfs(ctx: Context, pdfPath: string): Promise<void> {
     }
 
     const buildName = ctx.options.buildName;
+    const pdfNames = ctx.options.pdfNames;
 
     if (buildName) {
         ctx.build.name = buildName;
     }
 
     try {
-        const response = await ctx.client.uploadPdf(ctx, formData, buildName);
+        const response = await ctx.client.uploadPdf(ctx, formData, buildName, pdfNames);
         if (response && response.buildId) {
             ctx.build.id = response.buildId;
             ctx.log.debug(`PDF upload successful. Build ID: ${ctx.build.id}`);

src/types.ts

@@ -85,6 +85,7 @@ export interface Context {
         githubURL?: string,
         gitURL?: string,
         showRenderErrors?: boolean,
+        pdfNames?: string,
         userName?: string,
         accessKey?: string
     }