refactor: generalize expected to positive and negative pattern

Author: Hweinstock

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

@@ -79,10 +79,16 @@ export class SshKeyPair {
         const overrideKeys = async (_t: string, proc: RunParameterContext) => {
             await proc.send('yes')
         }
-        return !(await tryRun('ssh-keygen', ['-t', keyType, '-N', '', '-q', '-f', keyPath], 'yes', 'unknown key type', {
-            onStdout: overrideKeys,
-            timeout: new Timeout(5000),
-        }))
+        return await tryRun(
+            'ssh-keygen',
+            ['-t', keyType, '-N', '', '-q', '-f', keyPath],
+            'yes',
+            { negative: 'unknown key type' },
+            {
+                onStdout: overrideKeys,
+                timeout: new Timeout(5000),
+            }
+        )
     }
 
     public static async tryKeyTypes(keyPath: string, keyTypes: sshKeyType[]): Promise<boolean> {

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

@@ -24,7 +24,7 @@ export class SamCliLocationProvider {
 
     /** Checks that the given `sam` actually works by invoking `sam --version`. */
     private static async isValidSamLocation(samPath: string) {
-        const isValid = await tryRun(samPath, ['--version'], 'no', 'SAM CLI')
+        const isValid = await tryRun(samPath, ['--version'], 'no', { positive: 'SAM CLI' })
         this.samLocationValid = isValid
         return isValid
     }

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

@@ -11,6 +11,7 @@ import { GitExtension } from '../extensions/git'
 import { Settings } from '../settings'
 import { getLogger } from '../logger/logger'
 import { mergeResolvedShellPath } from '../env/resolveEnv'
+import { AcceptPattern, matchesPattern } from './textUtilities'
 
 /** Full path to VSCode CLI. */
 let vscPath: string
@@ -26,21 +27,23 @@ const pathMap = new Map<string, string>()
  * @param p path to a program to execute
  * @param args program args
  * @param doLog log failures
- * @param expected output must contain this string
+ * @param expectedPattern pattern to match in the output
+ * @param opt additional options for the Child Process
+ * @returns true if the program was found and executed successfully
  */
 export async function tryRun(
     p: string,
     args: string[],
     logging: 'yes' | 'no' | 'noresult' = 'yes',
-    expected?: string,
+    expectedPattern?: AcceptPattern,
     opt?: ChildProcessOptions
 ): Promise<boolean> {
     const proc = new ChildProcess(p, args, { logging: 'no' })
     const r = await proc.run({
         ...opt,
         spawnOptions: { env: await mergeResolvedShellPath(opt?.spawnOptions?.env ?? process.env) },
     })
-    const ok = r.exitCode === 0 && (expected === undefined || r.stdout.includes(expected))
+    const ok = r.exitCode === 0 && matchesPattern(r.stdout, expectedPattern ?? {})
     if (logging === 'noresult') {
         getLogger().info('tryRun: %s: %s', ok ? 'ok' : 'failed', proc)
     } else if (logging !== 'no') {
@@ -108,7 +111,7 @@ export async function findTypescriptCompiler(): Promise<string | undefined> {
 
     for (const tsc of tscPaths) {
         // Try to run "tsc -v".
-        if (await tryRun(tsc, ['-v'], 'yes', 'Version')) {
+        if (await tryRun(tsc, ['-v'], 'yes', { positive: 'Version' })) {
             return tsc
         }
     }

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

@@ -273,3 +273,15 @@ export function extractFileAndCodeSelectionFromMessage(message: any) {
     const selection = message?.context?.focusAreaContext?.selectionInsideExtendedCodeBlock as vscode.Selection
     return { filePath, selection }
 }
+
+export type AcceptPattern = Partial<{
+    positive: string
+    negative: string
+}>
+
+export function matchesPattern(text: string, pattern: AcceptPattern): boolean {
+    const { positive, negative } = pattern
+    const matchesPositive = !positive || text.includes(positive)
+    const matchesNegative = !negative || !text.includes(negative)
+    return matchesPositive && matchesNegative
+}

packages/core/src/test/shared/utilities/textUtilities.test.ts

@@ -13,6 +13,7 @@ import {
     sanitizeFilename,
     toSnakeCase,
     undefinedIfEmpty,
+    matchesPattern,
 } from '../../../shared/utilities/textUtilities'
 
 describe('textUtilities', async function () {
@@ -70,6 +71,21 @@ describe('textUtilities', async function () {
         assert.deepStrictEqual(indent('   abc\n\n  \n123\nfoo\n', 4, false), '       abc\n\n      \n    123\n    foo\n')
         assert.deepStrictEqual(indent('   abc\n\n    \n123\nfoo\n', 4, true), '    abc\n\n    \n    123\n    foo\n')
     })
+
+    it('matchesPattern', function () {
+        assert.ok(matchesPattern('abc', { positive: 'ab', negative: 'cd' }))
+        assert.ok(matchesPattern('abc', { positive: 'ab' }))
+        assert.ok(matchesPattern('abc', { negative: 'cd' }))
+        assert.ok(matchesPattern('abc', { negative: 'abcd' }))
+        assert.ok(matchesPattern('abc', { positive: 'abc' }))
+        assert.ok(matchesPattern('abc', {}))
+
+        assert.ok(!matchesPattern('abc', { positive: 'abcd' }))
+        assert.ok(!matchesPattern('abc', { positive: 'abc', negative: 'a' }))
+        assert.ok(!matchesPattern('abcde', { negative: 'ab' }))
+        assert.ok(!matchesPattern('abc', { negative: 'ab' }))
+        assert.ok(!matchesPattern('a a a a', { negative: 'a' }))
+    })
 })
 
 describe('removeAnsi', async function () {