Merge remote-tracking branch 'origin/develop' into read-dir-bugfix

IBM · Feb 15, 2024 · fb2be1d · fb2be1d
2 parents a64cd3b + c771dae
commit fb2be1d
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 20 deletions.
diff --git a/src/extension.ts b/src/extension.ts
@@ -896,7 +896,7 @@ function executeSimpleSdkCommand(command: string, session: Session, outputChanne
                     })
                     .catch(e => {
                       session.operationPending = false;
-                      showErrorMessage(`Failure executing Delete Operator command: RC ${e}`);
+                      showErrorMessage(`Failure executing Delete Operator command: ${e}`);
                     });
                   break;
                 }
@@ -931,7 +931,7 @@ function executeSimpleSdkCommand(command: string, session: Session, outputChanne
                     })
                     .catch(e => {
                       session.operationPending = false;
-                      showErrorMessage(`Failure executing Redeploy Collection command: RC ${e}`);
+                      showErrorMessage(`Failure executing Redeploy Collection command: ${e}`);
                     });
                   break;
                 }
@@ -949,7 +949,7 @@ function executeSimpleSdkCommand(command: string, session: Session, outputChanne
                     })
                     .catch(e => {
                       session.operationPending = false;
-                      showErrorMessage(`Failure executing Redeploy Operator command: RC ${e}`);
+                      showErrorMessage(`Failure executing Redeploy Operator command: ${e}`);
                     });
                   break;
                 }
@@ -1014,7 +1014,7 @@ function executeSdkCommandWithUserInput(command: string, session: Session, outpu
                   })
                   .catch(e => {
                     session.operationPending = false;
-                    showErrorMessage(`Failure executing Create Operator command: RC ${e}`);
+                    showErrorMessage(`Failure executing Create Operator command: ${e}`);
                   });
               }
             }

diff --git a/src/shellCommands/ocSdkCommands.ts b/src/shellCommands/ocSdkCommands.ts
@@ -17,6 +17,8 @@ type HTTPS = typeof https;
 export class OcSdkCommand {
   constructor(private pwd?: string | undefined) {}
 
+  private commandOutput: string = "";
+
   /**
    * Executes the requested command
    * @param cmd - The command to be executed
@@ -25,7 +27,7 @@ export class OcSdkCommand {
    * @param logPath - Log path to store command output
    * @returns - A Promise containing the the return code of the executed command
    */
-  private async run(cmd: string, args?: Array<string>, outputChannel?: vscode.OutputChannel, logPath?: string, callbackFunction?: (outputValue: string) => void): Promise<any> {
+  private async run(cmd: string, args?: Array<string>, outputChannel?: vscode.OutputChannel, logPath?: string): Promise<any> {
     process.env.PWD = this.pwd;
     let outputValue = "";
 
@@ -65,14 +67,13 @@ export class OcSdkCommand {
         return reject(error.message);
       });
       childProcess.on("close", (code: number) => {
+        this.commandOutput = outputValue;
+
         if (code) {
           if (code !== 0) {
             return reject(code);
           }
         } else {
-          if (callbackFunction !== undefined) {
-            callbackFunction(outputValue);
-          }
           return resolve(code);
         }
       });
@@ -173,20 +174,16 @@ export class OcSdkCommand {
    */
   async runOcSdkVersion(outputChannel?: vscode.OutputChannel, logPath?: string): Promise<string | undefined> {
     const galaxyNamespace = getAnsibleGalaxySettings(AnsibleGalaxySettings.ansibleGalaxyNamespace) as string;
-    let versionInstalled: string;
 
     // ansible-galaxy collection list | grep ibm.operator_collection_sdk
     const cmd: string = "ansible-galaxy";
-    let args: Array<string> = ["collection", "list", "|", "grep", `${galaxyNamespace}.operator_collection_sdk`];
-
-    let setVersionInstalled = (outputValue: string) => {
-      versionInstalled = outputValue.split(" ")?.filter(item => {
-        return item.length;
-      })?.[1]; // item in [1] is the version
-    };
+    const args: Array<string> = ["collection", "list", "|", "grep", `${galaxyNamespace}.operator_collection_sdk`];
 
-    return this.run(cmd, args, outputChannel, logPath, setVersionInstalled)
+    return this.run(cmd, args, outputChannel, logPath)
       .then(() => {
+        const versionInstalled = this.commandOutput.split(" ")?.filter(item => {
+          return item.length;
+        })?.[1]; // item in [1] is the version
         return versionInstalled;
       })
       .catch(e => {
@@ -267,7 +264,17 @@ export class OcSdkCommand {
     process.env.ANSIBLE_JINJA2_NATIVE = "true";
     const cmd: string = "ansible-playbook";
     args = args.concat("ibm.operator_collection_sdk.create_operator");
-    return this.run(cmd, args, outputChannel, logPath);
+
+    return new Promise(async (resolve, reject) => {
+      this.run(cmd, args, outputChannel, logPath)
+        .then(() => {
+          resolve(this.commandOutput);
+        })
+        .catch(returnCode => {
+          const errorMessage = `(RC: ${returnCode}) ${getFinalPlaybookTaskFailure(this.commandOutput)}`;
+          reject(errorMessage);
+        });
+    });
   }
 
   /**
@@ -319,10 +326,20 @@ export class OcSdkCommand {
    * @param logPath - Log path to store command output
    * @returns - A Promise container the return code of the command being executed
    */
-  private executeSimpleCommand(command: string, outputChannel?: vscode.OutputChannel, logPath?: string): Promise<any> {
+  private async executeSimpleCommand(command: string, outputChannel?: vscode.OutputChannel, logPath?: string): Promise<any> {
     const cmd: string = "ansible-playbook";
     let args: Array<string> = [command];
-    return this.run(cmd, args, outputChannel, logPath);
+
+    return new Promise(async (resolve, reject) => {
+      this.run(cmd, args, outputChannel, logPath)
+        .then(() => {
+          resolve(this.commandOutput);
+        })
+        .catch(returnCode => {
+          const errorMessage = `(RC: ${returnCode}) ${getFinalPlaybookTaskFailure(this.commandOutput)}`;
+          reject(errorMessage);
+        });
+    });
   }
 }
 
@@ -375,3 +392,20 @@ async function getRequest(apiUrl: string): Promise<string | undefined> {
 function getLatestCollectionVersion(jsonData: any): string | undefined {
   return jsonData?.data?.collection?.latest_version?.version ?? jsonData?.data[0]?.version;
 }
+
+function getFinalPlaybookTaskFailure(stdOutput: string): string | undefined {
+  const playbookTasksFailureRegex = /FAILED! => {.*}/g;
+  const playbookTasksFailures = stdOutput.match(playbookTasksFailureRegex);
+  const finalFailureObject = playbookTasksFailures?.[playbookTasksFailures.length - 1]?.replace("FAILED! => ", "");
+  if (finalFailureObject) {
+    const defaultAnsibleErrorMessage = "non-zero return code";
+    const finalFailureMessage = JSON.parse(finalFailureObject)?.["msg"];
+
+    if (finalFailureMessage?.includes(defaultAnsibleErrorMessage)) {
+      return JSON.parse(finalFailureObject)?.["stderr_lines"];
+    }
+
+    return finalFailureMessage;
+  }
+  return stdOutput;
+}