Merge pull request #187 from LambdaTest/stage

Version 4.0.14.rc.0 release on prod

Author: sushobhit-lt

package.json

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

src/commander/capture.ts

@@ -19,7 +19,13 @@ command
     .option('-C, --parallel [number]', 'Specify the number of instances per browser', parseInt)
     .option('-F, --force', 'forcefully apply the specified parallel instances per browser')
     .option('--fetch-results [filename]', 'Fetch results and optionally specify an output file, e.g., <filename>.json')
+    .option('--buildName <string>', 'Specify the build name')
     .action(async function(file, _, command) {
+        const options = command.optsWithGlobals();
+        if (options.buildName === '') {
+            console.log(`Error: The '--buildName' option cannot be an empty string.`);
+            process.exit(1);
+        }
         let ctx: Context = ctxInit(command.optsWithGlobals());
 
         if (!fs.existsSync(file)) {

src/commander/exec.ts

@@ -20,7 +20,13 @@ command
     .argument('<command...>', 'Command supplied for running tests')
     .option('-P, --port <number>', 'Port number for the server')
     .option('--fetch-results [filename]', 'Fetch results and optionally specify an output file, e.g., <filename>.json')
+    .option('--buildName <string>', 'Specify the build name')
     .action(async function(execCommand, _, command) {
+        const options = command.optsWithGlobals();
+        if (options.buildName === '') {
+            console.log(`Error: The '--buildName' option cannot be an empty string.`);
+            process.exit(1);
+        }
         let ctx: Context = ctxInit(command.optsWithGlobals());
 
         if (!which.sync(execCommand[0], { nothrow: true })) {

src/commander/upload.ts

@@ -26,7 +26,13 @@ command
         return val.split(',').map(pattern => pattern.trim());
     })
     .option('--fetch-results [filename]', 'Fetch results and optionally specify an output file, e.g., <filename>.json')
+    .option('--buildName <string>', 'Specify the build name')
     .action(async function(directory, _, command) {
+        const options = command.optsWithGlobals();
+        if (options.buildName === '') {
+            console.log(`Error: The '--buildName' option cannot be an empty string.`);
+            process.exit(1);
+        }
         let ctx: Context = ctxInit(command.optsWithGlobals());
 
         if (!fs.existsSync(directory)) {

src/lib/ctx.ts

@@ -21,6 +21,7 @@ export default (options: Record<string, string>): Context => {
     let parallelObj: number;
     let fetchResultObj: boolean;
     let fetchResultsFileObj: string;
+    let buildNameObj: string;
     try {
         if (options.config) {
             config = JSON.parse(fs.readFileSync(options.config, 'utf-8'));
@@ -57,6 +58,7 @@ export default (options: Record<string, string>): Context => {
             fetchResultObj = false
             fetchResultsFileObj = ''
         }
+        buildNameObj = options.buildName || ''
     } catch (error: any) {
         console.log(`[smartui] Error: ${error.message}`);
         process.exit();
@@ -105,7 +107,7 @@ export default (options: Record<string, string>): Context => {
         },
         build: {
             id: '',
-            name: '',
+            name: buildNameObj,
             baseline: false,
             url: ''
         },

src/lib/httpClient.ts

@@ -82,13 +82,14 @@ export default class httpClient {
         }
     }
 
-    createBuild(git: Git, config: any, log: Logger) {
+    createBuild(git: Git, config: any, log: Logger, buildName: string) {
         return this.request({
             url: '/build',
             method: 'POST',
             data: {
                 git,
-                config
+                config,
+                buildName
             }
         }, log)
     }

src/lib/processSnapshot.ts

@@ -242,6 +242,9 @@ export default async function processSnapshot(snapshot: Snapshot, ctx: Context):
                 }
             }
         }
+        if(options.ignoreType){
+            processedOptions.ignoreType = options.ignoreType;
+        }
     }
 
     // process for every viewport

src/lib/schemaValidation.ts

@@ -294,6 +294,15 @@ const SnapshotSchema: JSONSchemaType<Snapshot> = {
                         },
                     }
                 },
+                ignoreType:{
+                    type: "array",
+                    items: { type: "string", minLength: 1, 
+                             enum: ["default", "layout", "images", "text", "colors", "dimensions", "position", "structure"],
+                             errorMessage: "Invalid snapshot options;ignoreType cannot be empty" 
+                    },
+                    uniqueItems: true,
+                    errorMessage: "Invalid snapshot options; ignoreType must be an array of unique values from default, layout, images, text, colors, dimensions, position, structure"
+                },
                 web: {
                     type: "object",
                     properties: {

src/tasks/createBuild.ts

@@ -10,7 +10,7 @@ export default (ctx: Context): ListrTask<Context, ListrRendererFactory, ListrRen
             updateLogContext({task: 'createBuild'});
 
             try {
-                let resp = await ctx.client.createBuild(ctx.git, ctx.config, ctx.log);
+                let resp = await ctx.client.createBuild(ctx.git, ctx.config, ctx.log, ctx.build.name);
                 ctx.build = {
                     id: resp.data.buildId,
                     name: resp.data.buildName,

src/tasks/finalizeBuild.ts

@@ -29,7 +29,6 @@ export default (ctx: Context): ListrTask<Context, ListrRendererFactory, ListrRen
                 ctx.log.debug(`Closed server`);
                 let resp = await ctx.client.getS3PreSignedURL(ctx);
                 await ctx.client.uploadLogs(ctx, resp.data.url);
-                unlinkSync(constants.LOG_FILE_PATH);
             } catch (error: any) {
                 ctx.log.debug(error);
             }

src/types.ts

@@ -105,6 +105,7 @@ export interface Snapshot {
             orientation?: string
         },
         loadDomContent?: boolean;
+        ignoreType?: string[]
     }
 }