Deployment process polishing (#798)

* git add stash troubleshooting

When git add / stash failure, display a message explaining to run `git config --system core.longpaths true` to solve the issue.

* countPackageXmlItems

* Count deployment items + fix test classes errors collection

* await

* cspell

.github/linters/.cspell.json

@@ -560,6 +560,7 @@
         "localtest",
         "loginasgrantedtopartnerbt",
         "loglevel",
+        "longpaths",
         "lors",
         "lycheeignore",
         "l\u2019acc\u00e8s",

CHANGELOG.md

@@ -4,6 +4,12 @@
 
 Note: Can be used with `sfdx plugins:install sfdx-hardis@beta` and docker image `hardisgroupcom/sfdx-hardis@beta`
 
+## [5.0.5] 2024-09-24
+
+- When git add / stash failure, display a message explaining to run `git config --system core.longpaths true` to solve the issue.
+- Improve test classes errors collection during deployment check
+- Display the number of elements deployed within a package.xml
+
 ## [5.0.4] 2024-09-24
 
 - Fix errors collection during deployment check

src/common/utils/deployTips.ts

@@ -65,8 +65,19 @@ export async function analyzeDeployErrorLogs(log: string, includeInLog = true, o
   }
 
   // Extract failed test classes
-  const failedTests: any[] = [];
   const logRaw = stripAnsi(log);
+  const failedTests: any[] = [];
+  // sf project deploy output
+  extractFailedTestsInfoForSfCommand(logRaw, failedTests);
+  if (failedTests.length === 0) {
+    // Legacy sfdx force:source:deploy output
+    extractFailedTestsInfoForSfdxCommand(logRaw, failedTests);
+  }
+  await updatePullRequestResult(errorsAndTips, failedTests, options);
+  return { tips, errorsAndTips, failedTests, errLog: logResLines.join("\n") };
+}
+
+function extractFailedTestsInfoForSfdxCommand(logRaw: string, failedTests: any[]) {
   const regexFailedTests = /Test Failures([\S\s]*?)Test Success/gm;
   if (logRaw.match(regexFailedTests)) {
     const failedTestsLines = (regexFailedTests
@@ -96,8 +107,28 @@ export async function analyzeDeployErrorLogs(log: string, includeInLog = true, o
       }
     }
   }
-  updatePullRequestResult(errorsAndTips, failedTests, options);
-  return { tips, errorsAndTips, failedTests, errLog: logResLines.join("\n") };
+}
+
+function extractFailedTestsInfoForSfCommand(logRaw: string, failedTests: any[]) {
+  const regexFailedTests = /Test Failures([\S\s]*?)Test Success/gm;
+  if (logRaw.match(regexFailedTests)) {
+    const failedTestsString = (regexFailedTests.exec(logRaw) || [])[1].split(/\r?\n/).join("\n") + "\n•";
+    // Parse strings to extract main error line then stack
+    // eslint-disable-next-line no-regex-spaces, no-useless-escape
+    const regex = /^• (.*)\n  message: (.*)\n  stacktrace: ([\s\S]*?)(?=\n•|\z)/gm;
+    const matches = [...failedTestsString.matchAll(regex)];
+    for (const match of matches || []) {
+      const failedTest: any = {
+        class: match[1].split(".")[0],
+        method: match[1].split(".")[1],
+        error: match[2].trim(),
+      };
+      if (match[3]) {
+        failedTest.stack = match[3];
+      }
+      failedTests.push(failedTest);
+    }
+  }
 }
 
 // Checks if the error string or regex is found in the log

src/common/utils/deployUtils.ts

@@ -26,7 +26,7 @@ import { callSfdxGitDelta } from './gitUtils.js';
 import { createBlankSfdxProject, isSfdxProject } from './projectUtils.js';
 import { prompts } from './prompts.js';
 import { arrangeFilesBefore, restoreArrangedFiles } from './workaroundUtils.js';
-import { isPackageXmlEmpty, parseXmlFile, removePackageXmlFilesContent, writeXmlFile } from './xmlUtils.js';
+import { countPackageXmlItems, isPackageXmlEmpty, parseXmlFile, removePackageXmlFilesContent, writeXmlFile } from './xmlUtils.js';
 import { ResetMode } from 'simple-git';
 import { isProductionOrg } from './orgUtils.js';
 import { soqlQuery } from './apiUtils.js';
@@ -221,11 +221,12 @@ export async function smartDeploy(
     }
     // Deployment of type package.xml file
     if (deployment.packageXmlFile) {
+      const nbDeployedItems = await countPackageXmlItems(deployment.packageXmlFile);
       uxLog(
         commandThis,
         c.cyan(
           `${check ? 'Simulating deployment of' : 'Deploying'} ${c.bold(deployment.label)} package: ${deployment.packageXmlFile
-          } ...`
+          } (${nbDeployedItems} items)...`
         )
       );
       // Try QuickDeploy

src/common/utils/index.ts

@@ -371,8 +371,14 @@ export async function checkGitClean(options: any) {
       })
       .join('\n');
     if (options.allowStash) {
-      await execCommand('git add --all', this, { output: true, fail: true });
-      await execCommand('git stash', this, { output: true, fail: true });
+      try {
+        await execCommand('git add --all', this, { output: true, fail: true });
+        await execCommand('git stash', this, { output: true, fail: true });
+      } catch (e) {
+        uxLog(this, c.yellow(c.bold("You might need to run the following command in Powershell launched as Administrator")));
+        uxLog(this, c.yellow(c.bold("git config --system core.longpaths true")));
+        throw e;
+      }
     } else {
       throw new SfError(
         `[sfdx-hardis] Branch ${c.bold(gitStatus.current)} is not clean. You must ${c.bold(

src/common/utils/xmlUtils.ts

@@ -44,6 +44,15 @@ export async function parsePackageXmlFile(packageXmlFile: string) {
   return targetOrgContent;
 }
 
+export async function countPackageXmlItems(packageXmlFile: string): Promise<number> {
+  const packageXmlParsed = await parsePackageXmlFile(packageXmlFile);
+  let counter = 0;
+  for (const type of Object.keys(packageXmlParsed)) {
+    counter += packageXmlParsed[type].length || 0;
+  }
+  return counter;
+}
+
 export async function writePackageXmlFile(packageXmlFile: string, packageXmlObject: any) {
   let packageXmlContent: any = { Package: { types: [], version: [CONSTANTS.API_VERSION] } };
   if (fs.existsSync(packageXmlFile)) {
@@ -334,8 +343,8 @@ export async function applyReplacementDefinition(
           return replacementDefinition.type === 'code'
             ? '// ' + line + ' // Commented by sfdx-hardis purge-references'
             : replacementDefinition.type === 'xml'
-            ? '<!-- ' + line + ' Commented by sfdx-hardis purge-references --> '
-            : line;
+              ? '<!-- ' + line + ' Commented by sfdx-hardis purge-references --> '
+              : line;
         }
         return line;
       });