move tryRun back

Author: Hweinstock

packages/core/src/awsService/ec2/sshKeyPair.ts

@@ -4,7 +4,7 @@
  */
 import { fs } from '../../shared'
 import { ToolkitError } from '../../shared/errors'
-import { tryRun } from '../../shared/utilities/programUtils'
+import { tryRun } from '../../shared/utilities/pathFind'
 import { Timeout } from '../../shared/utilities/timeoutUtils'
 import { findAsync } from '../../shared/utilities/collectionUtils'
 import { RunParameterContext } from '../../shared/utilities/processUtils'

packages/core/src/codewhisperer/commands/basicCommands.ts

@@ -43,7 +43,7 @@ import { isBuilderIdConnection } from '../../auth/connection'
 import globals from '../../shared/extensionGlobals'
 import { getVscodeCliPath } from '../../shared/utilities/pathFind'
 import { setContext } from '../../shared/vscode/setContext'
-import { tryRun } from '../../shared/utilities/programUtils'
+import { tryRun } from '../../shared/utilities/pathFind'
 
 const MessageTimeOut = 5_000
 

packages/core/src/shared/sam/cli/samCliLocator.ts

@@ -10,7 +10,7 @@ import { getLogger, Logger } from '../../logger'
 import { SamCliInfoInvocation } from './samCliInfo'
 import { DefaultSamCliValidator, SamCliValidatorContext, SamCliVersionValidation } from './samCliValidator'
 import { PerfLog } from '../../logger/perfLogger'
-import { tryRun } from '../../utilities/programUtils'
+import { tryRun } from '../../utilities/pathFind'
 
 export class SamCliLocationProvider {
     private static samCliLocator: BaseSamCliLocator | undefined

packages/core/src/shared/utilities/pathFind.ts

@@ -8,7 +8,8 @@ import * as path from 'path'
 import fs from '../../shared/fs/fs'
 import { GitExtension } from '../extensions/git'
 import { Settings } from '../settings'
-import * as programUtils from './programUtils'
+import { ChildProcess, ChildProcessOptions } from './processUtils'
+import { getLogger } from '..'
 
 /** Full path to VSCode CLI. */
 let vscPath: string
@@ -50,7 +51,7 @@ export async function getVscodeCliPath(): Promise<string | undefined> {
         if (!vsc || (vsc !== 'code' && !(await fs.exists(vsc)))) {
             continue
         }
-        if (await programUtils.tryRun(vsc, ['--version'])) {
+        if (await tryRun(vsc, ['--version'])) {
             vscPath = vsc
             return vsc
         }
@@ -75,7 +76,7 @@ export async function findTypescriptCompiler(): Promise<string | undefined> {
 
     for (const tsc of tscPaths) {
         // Try to run "tsc -v".
-        if (await programUtils.tryRun(tsc, ['-v'], 'yes', 'Version')) {
+        if (await tryRun(tsc, ['-v'], 'yes', 'Version')) {
             return tsc
         }
     }
@@ -104,7 +105,7 @@ export async function findSshPath(useCache: boolean = true): Promise<string | un
         if (!p || ('ssh' !== p && !(await fs.exists(p)))) {
             continue
         }
-        if (await programUtils.tryRun(p, ['-G', 'x'], 'noresult' /* "ssh -G" prints quasi-sensitive info. */)) {
+        if (await tryRun(p, ['-G', 'x'], 'noresult' /* "ssh -G" prints quasi-sensitive info. */)) {
             sshPath = p
             return p
         }
@@ -126,7 +127,7 @@ export async function findGitPath(): Promise<string | undefined> {
         if (!p || ('git' !== p && !(await fs.exists(p)))) {
             continue
         }
-        if (await programUtils.tryRun(p, ['--version'])) {
+        if (await tryRun(p, ['--version'])) {
             gitPath = p
             return p
         }
@@ -146,9 +147,36 @@ export async function findBashPath(): Promise<string | undefined> {
         if (!p || ('bash' !== p && !(await fs.exists(p)))) {
             continue
         }
-        if (await programUtils.tryRun(p, ['--version'])) {
+        if (await tryRun(p, ['--version'])) {
             bashPath = p
             return p
         }
     }
 }
+
+/**
+ * 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
+ */
+export async function tryRun(
+    p: string,
+    args: string[],
+    logging: 'yes' | 'no' | 'noresult' = 'yes',
+    expected?: string,
+    opt?: ChildProcessOptions
+): Promise<boolean> {
+    const proc = new ChildProcess(p, args, { logging: 'no' })
+    const r = await proc.run(opt)
+    const ok = r.exitCode === 0 && (expected === undefined || r.stdout.includes(expected))
+    if (logging === 'noresult') {
+        getLogger().info('tryRun: %s: %s', ok ? 'ok' : 'failed', proc)
+    } else if (logging !== 'no') {
+        getLogger().info('tryRun: %s: %s %O', ok ? 'ok' : 'failed', proc, proc.result())
+    }
+    return ok
+}

packages/core/src/shared/utilities/programUtils.ts

@@ -4,14 +4,12 @@
  */
 
 import assert from 'assert'
-import sinon from 'sinon'
 import * as vscode from 'vscode'
 import * as os from 'os'
 import * as path from 'path'
 import * as testutil from '../../testUtil'
 import { fs } from '../../../shared'
-import { findSshPath, findTypescriptCompiler, getVscodeCliPath } from '../../../shared/utilities/pathFind'
-import * as programUtils from '../../../shared/utilities/programUtils'
+import { findTypescriptCompiler, getVscodeCliPath } from '../../../shared/utilities/pathFind'
 
 function isWin(): boolean {
     return process.platform === 'win32'
@@ -47,45 +45,7 @@ describe('pathFind', function () {
         assert.ok(regex.test(vscPath), `expected regex ${regex} to match: "${vscPath}"`)
     })
 
-    describe('findSshPath', function () {
-        let tryRunStub: sinon.SinonStub
-        // On Windows the first call to tryRun gives a valid path, which changes func behavior.
-        // We can offset our call checks based on this.
-        let callOffset: number
+    // describe('findSshPath', function () {
 
-        before(function () {
-            tryRunStub = sinon.stub(programUtils, 'tryRun')
-            callOffset = isWin() ? 1 : 0
-        })
-
-        after(function () {
-            tryRunStub.restore()
-        })
-
-        it('first tries $PATH', async function () {
-            tryRunStub.onCall(callOffset).resolves(true)
-
-            const result = await findSshPath(false)
-            assert.ok(result)
-            testutil.assertEqualPaths(result, 'ssh')
-            tryRunStub.resetHistory()
-        })
-
-        it('if $PATH fails, tries /usr/bin/ssh', async function () {
-            tryRunStub.onCall(callOffset).resolves(false)
-            tryRunStub.onCall(callOffset + 1).resolves(true)
-
-            const result = await findSshPath(false)
-            assert.ok(result)
-            testutil.assertEqualPaths(result, '/usr/bin/ssh')
-            tryRunStub.resetHistory()
-        })
-
-        it('dry runs the resulting ssh', async function () {
-            tryRunStub.onCall(callOffset).resolves(true)
-            await findSshPath(false)
-            assert.ok(tryRunStub.calledOnce)
-            tryRunStub.resetHistory()
-        })
-    })
+    // })
 })