refactor: SystemUtilities.tryRun()

Author: justinmk3

src/shared/sam/cli/samCliSettings.ts

@@ -94,8 +94,10 @@ export class SamCliSettings extends fromExtensionManifest('aws.samcli', descript
     }
 
     /**
-     * Gets location of `sam` from user config, or tries to find `sam` on the
-     * system if the user config is invalid.
+     * Gets location of `sam` from:
+     * 1. previous saved location (if valid), or
+     * 2. user config (if valid), or
+     * 3. tries to find `sam` on the system if the user config is invalid.
      *
      * @returns `autoDetected=true` if auto-detection was _attempted_.
      */

src/shared/systemUtilities.ts

@@ -183,6 +183,27 @@ export class SystemUtilities {
     // TODO: implement this by checking the file mode
     // public static async checkExactPerms(file: string | vscode.Uri, perms: `${PermissionsTriplet}${PermissionsTriplet}${PermissionsTriplet}`)
 
+    /**
+     * Tries to execute a program at path `p` with the given args and
+     * optionally checks the output for `expected`.
+     *
+     * @param p path to a program to execute
+     * @param args program args
+     * @param doLog log failures
+     * @param expected output must contain this string
+     */
+    public static async tryRun(p: string, args: string[], doLog?: boolean, expected?: string): Promise<boolean> {
+        const proc = new ChildProcess(p, args)
+        const r = await proc.run()
+        if (r.exitCode === 0 && (expected === undefined || r.stdout.includes(expected))) {
+            return true
+        }
+        if (doLog) {
+            getLogger().warn('tryRun: failed: %s %O', proc, proc.result())
+        }
+        return false
+    }
+
     /**
      * Gets the fullpath to `code` (VSCode CLI), or falls back to "code" (not
      * absolute) if it works.
@@ -217,13 +238,10 @@ export class SystemUtilities {
             if (!vsc || (vsc !== 'code' && !fs.existsSync(vsc))) {
                 continue
             }
-            const proc = new ChildProcess(vsc, ['--version'])
-            const r = await proc.run()
-            if (r.exitCode === 0) {
+            if (await SystemUtilities.tryRun(vsc, ['--version'])) {
                 SystemUtilities.vscPath = vsc
                 return vsc
             }
-            getLogger().warn('getVscodeCliPath: failed: %s %O', proc, proc.result())
         }
 
         return undefined
@@ -245,8 +263,7 @@ export class SystemUtilities {
 
         for (const tsc of tscPaths) {
             // Try to run "tsc -v".
-            const result = await new ChildProcess(tsc, ['-v']).run()
-            if (result.exitCode === 0 && result.stdout.includes('Version')) {
+            if (await SystemUtilities.tryRun(tsc, ['-v'], false, 'Version')) {
                 return tsc
             }
         }
@@ -275,13 +292,10 @@ export class SystemUtilities {
             if (!p || ('ssh' !== p && !fs.existsSync(p))) {
                 continue
             }
-            const proc = new ChildProcess(p, ['-G', 'x'])
-            const r = await proc.run()
-            if (r.exitCode === 0) {
+            if (await SystemUtilities.tryRun(p, ['-G', 'x'])) {
                 SystemUtilities.sshPath = p
                 return p
             }
-            getLogger().warn('findSshPath: failed: %s', proc)
         }
     }
 
@@ -300,13 +314,10 @@ export class SystemUtilities {
             if (!p || ('git' !== p && !fs.existsSync(p))) {
                 continue
             }
-            const proc = new ChildProcess(p, ['--version'])
-            const r = await proc.run()
-            if (r.exitCode === 0) {
+            if (await SystemUtilities.tryRun(p, ['--version'])) {
                 SystemUtilities.gitPath = p
                 return p
             }
-            getLogger().warn('findGitPath: failed: %s', proc)
         }
     }
 
@@ -323,13 +334,10 @@ export class SystemUtilities {
             if (!p || ('bash' !== p && !fs.existsSync(p))) {
                 continue
             }
-            const proc = new ChildProcess(p, ['--version'])
-            const r = await proc.run()
-            if (r.exitCode === 0) {
+            if (await SystemUtilities.tryRun(p, ['--version'])) {
                 SystemUtilities.bashPath = p
                 return p
             }
-            getLogger().warn('findBashPath: failed: %s', proc)
         }
     }