add github URL argument support

Author: sushobhit-lt

package.json

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

src/commander/commander.ts

@@ -20,6 +20,7 @@ program
     .option('--markBaseline', 'Mark this build baseline')
     .option('--baselineBranch <string>', 'Mark this build baseline')
     .option('--baselineBuild <string>', 'Mark this build baseline')
+    .option('--githubURL <string>', 'GitHub URL including commitId')
     .addCommand(exec)
     .addCommand(capture)
     .addCommand(configWeb)

src/lib/ctx.ts

@@ -26,7 +26,8 @@ export default (options: Record<string, string>): Context => {
     try {
         if (options.config) {
             config = JSON.parse(fs.readFileSync(options.config, 'utf-8'));
-            logger.debug(`Config file ${options.config} loaded: ${JSON.stringify(config, null, 2)}`);
+            // TODO: Mask sensitive data of config file
+            // logger.debug(`Config file ${options.config} loaded: ${JSON.stringify(config, null, 2)}`);
 
             // resolutions supported for backward compatibility
             if (config.web?.resolutions) {
@@ -148,7 +149,8 @@ export default (options: Record<string, string>): Context => {
             fetchResults: fetchResultObj,
             fetchResultsFileName: fetchResultsFileObj,
             baselineBranch: options.baselineBranch || '',
-            baselineBuild: options.baselineBuild || ''
+            baselineBuild: options.baselineBuild || '',
+            githubURL : options.githubURL || ''
         },
         cliVersion: version,
         totalSnapshots: -1,

src/lib/git.ts

@@ -33,6 +33,10 @@ export default (ctx: Context): Git => {
 			ctx.env.SMART_GIT = false
 		}
 	}
+	let githubURL;
+	if (ctx.options.githubURL && ctx.options.githubURL.startsWith('https://')) {
+		githubURL = ctx.options.githubURL;
+	}
 	if (ctx.env.SMARTUI_GIT_INFO_FILEPATH) {
 		let gitInfo = JSON.parse(fs.readFileSync(ctx.env.SMARTUI_GIT_INFO_FILEPATH, 'utf-8'));
 
@@ -46,7 +50,7 @@ export default (ctx: Context): Git => {
 			commitId: gitInfo.commit_id.slice(0,6) || '',
 			commitMessage: gitInfo.commit_body || '',
 			commitAuthor: gitInfo.commit_author || '',
-			githubURL: (ctx.env.GITHUB_ACTIONS) ? `${constants.GITHUB_API_HOST}/repos/${process.env.GITHUB_REPOSITORY}/statuses/${gitInfo.commit_id}` : '',
+			githubURL: githubURL ? githubURL : (ctx.env.GITHUB_ACTIONS) ? `${constants.GITHUB_API_HOST}/repos/${process.env.GITHUB_REPOSITORY}/statuses/${gitInfo.commit_id}` : '',
 			baselineBranch: ctx.options.baselineBranch || ctx.env.BASELINE_BRANCH || ''
 		}
 	} else {
@@ -73,7 +77,7 @@ export default (ctx: Context): Git => {
 			commitId: res[0] || '',
 			commitMessage: res[2] || '',
 			commitAuthor: res[7] || '',
-			githubURL: (ctx.env.GITHUB_ACTIONS) ? `${constants.GITHUB_API_HOST}/repos/${process.env.GITHUB_REPOSITORY}/statuses/${res[1]}` : '',
+			githubURL: githubURL ? githubURL : (ctx.env.GITHUB_ACTIONS) ? `${constants.GITHUB_API_HOST}/repos/${process.env.GITHUB_REPOSITORY}/statuses/${res[1]}` : '',
 			baselineBranch: ctx.options.baselineBranch || ctx.env.BASELINE_BRANCH || ''
 		};
 	}

src/lib/server.ts

@@ -64,6 +64,10 @@ export default async (ctx: Context): Promise<FastifyInstance<Server, IncomingMes
 						console.log(`Failed to fetch capabilities for sessionId ${sessionId}: ${error.message}`);
 					}
 				}
+
+				if (capsBuildId && capsBuildId !== '') {
+					process.env.SMARTUI_BUILD_ID = capsBuildId;
+				}
 			}
 
 			ctx.testType = testType;

src/tasks/getGitInfo.ts

@@ -16,6 +16,9 @@ export default (ctx: Context): ListrTask<Context, ListrRendererFactory, ListrRen
             try {
                 ctx.git = getGitInfo(ctx);
                 task.output = chalk.gray(`branch: ${ctx.git.branch}, commit: ${ctx.git.commitId}, author: ${ctx.git.commitAuthor}`);
+                if (ctx.git.githubURL && ctx.git.githubURL !== '') {
+                    task.output += chalk.gray(`, githubURL: ${ctx.git.githubURL}`);
+                }
                 task.title = 'Fetched git information'
             } catch (error: any) {
                 ctx.log.debug(error);

src/types.ts

@@ -61,7 +61,8 @@ export interface Context {
         fetchResults?: boolean,
         fetchResultsFileName?: string,
         baselineBranch?: string,
-        baselineBuild?: string
+        baselineBuild?: string,
+        githubURL?: string
     }
     cliVersion: string;
     totalSnapshots: number;