tests: remove Window.vscode() and related logic (#3182)

## Problem
Writing wrappers for the sole purpose of making an implementation easier to test is not a sustainable approach.

## Solution
* Remove `Window.vscode()` and `FakeWindow`
* Extend `TestWindow` to cover the same scenarios that `FakeWindow` was used for

### Important Notes
This PR uses Proxy heavily in order to make "testable" versions of native vscode objects. Some things like `showInformationMessage` and `withProgress` do not have an API that can be manipulated programmatically. For these methods, we have to create in-mem representations that can be tested. These currently live in `src/test/shared/vscode/message.ts`.

Author: JadenSimon

docs/TESTPLAN.md

@@ -73,3 +73,38 @@ modifications/workarounds in `src/test/testRunner.ts`.
 -   Testing AWS SDK client functionality is cumbersome, verbose, and low-yield.
 -   Test code uses multiple “mocking” frameworks, which is confusing, error-prone, hard to onboard, and hard to use.
 -   Coverage not counted for integ tests (because of unresolved tooling issue).
+
+## Window
+
+Certain VS Code API calls are not easily controlled programtically. `vscode.window` is a major source of these functions as it is closely related to the UI. To facilitate some semblance of UI testing, all unit tests have access to a proxied `vscode.window` object via `getTestWindow()`.
+
+### Inspecting State
+
+The test window will capture relevant UI state that can be inspected at test time. For example, you can check to see if any messages were shown by looking at `getTestWindow().shownMessages` which is an array of message objects.
+
+Some VS Code API operations do not expose "native" UI elements that can be inspected. In these cases, in-memory test versions have been created. In every other case the native VS Code API is used directly and extended to make them more testable.
+
+### Event-Driven Interactions
+
+Checking the state works well if user interactions are not required by the code being tested. But many times the code will be waiting for the user's response.
+
+To handle this, test code can register event handler that listen for when a certain type of UI element is shown. For example, if we wanted to always accept the first item of a quick pick we can do this:
+
+```ts
+getTestWindow().onDidShowQuickPick(async picker => {
+    // Some pickers load items asychronously
+    // Wait until the picker is not busy before accepting an item
+    await picker.untilReady()
+    picker.acceptItem(picker.items[0])
+})
+```
+
+Utility functions related to events can be used to iterate over captured UI elements:
+
+```ts
+const pickers = captureEvent(getTestWindow().onDidShowQuickPick)
+const firstPicker = await pickers.next()
+const secondPicker = await pickers.next()
+```
+
+Exceptions thrown within one of these handlers will cause the current test to fail. This allows you to make assertions within the callback without worrying about causing the test to hang.

src/apigateway/commands/copyUrl.ts

@@ -3,7 +3,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { Window } from '../../shared/vscode/window'
 import { copyToClipboard } from '../../shared/utilities/messages'
 import * as nls from 'vscode-nls'
 const localize = nls.loadMessageBundle()
@@ -23,18 +22,14 @@ interface StageInvokeUrlQuickPick extends vscode.QuickPickItem {
     detail: string
 }
 
-export async function copyUrlCommand(
-    node: RestApiNode,
-    regionProvider: RegionProvider,
-    window = Window.vscode()
-): Promise<void> {
+export async function copyUrlCommand(node: RestApiNode, regionProvider: RegionProvider): Promise<void> {
     const region = node.regionCode
     const dnsSuffix = regionProvider.getDnsSuffixForRegion(region) || defaultDnsSuffix
     const client = new DefaultApiGatewayClient(region)
 
     let stages: Stage[]
     try {
-        stages = await window.withProgress(
+        stages = await vscode.window.withProgress(
             {
                 cancellable: false,
                 location: ProgressLocation.Window,
@@ -58,7 +53,7 @@ export async function copyUrlCommand(
     }))
 
     if (quickPickItems.length === 0) {
-        window.showInformationMessage(
+        vscode.window.showInformationMessage(
             localize('AWS.apig.copyUrlNoStages', "Failed to copy URL because '{0}' has no stages", node.name)
         )
         telemetry.apigateway_copyUrl.emit({ result: 'Failed' })

src/apprunner/commands/pauseService.ts

@@ -6,7 +6,6 @@
 import * as nls from 'vscode-nls'
 const localize = nls.loadMessageBundle()
 
-import * as vscode from 'vscode'
 import * as localizedText from '../../shared/localizedText'
 import { showConfirmationMessage } from '../../shared/utilities/messages'
 import { AppRunnerServiceNode } from '../explorer/apprunnerServiceNode'
@@ -27,7 +26,7 @@ export async function pauseService(node: AppRunnerServiceNode): Promise<void> {
         )
         const confirmationOptions = { prompt: notifyPrompt, confirm: localizedText.ok, cancel: localizedText.cancel }
 
-        if (shouldNotify && !(await showConfirmationMessage(confirmationOptions, vscode.window))) {
+        if (shouldNotify && !(await showConfirmationMessage(confirmationOptions))) {
             telemetryResult = 'Cancelled'
             return
         }

src/awsexplorer/commands/copyArn.ts

@@ -3,14 +3,14 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import * as vscode from 'vscode'
 import * as nls from 'vscode-nls'
 import { showLogOutputChannel } from '../../shared/logger'
 const localize = nls.loadMessageBundle()
 
 import { AWSResourceNode } from '../../shared/treeview/nodes/awsResourceNode'
 import { Env } from '../../shared/vscode/env'
 import { copyToClipboard } from '../../shared/utilities/messages'
-import { Window } from '../../shared/vscode/window'
 import { Commands } from '../../shared/vscode/commands'
 import { getIdeProperties } from '../../shared/extensionUtilities'
 import { TreeShim } from '../../shared/treeview/utils'
@@ -20,17 +20,16 @@ import { TreeShim } from '../../shared/treeview/utils'
  */
 export async function copyArnCommand(
     node: AWSResourceNode | TreeShim<AWSResourceNode>,
-    window = Window.vscode(),
     env = Env.vscode(),
     commands = Commands.vscode()
 ): Promise<void> {
     node = node instanceof TreeShim ? node.node.resource : node
 
     try {
-        copyToClipboard(node.arn, 'ARN', window, env)
+        copyToClipboard(node.arn, 'ARN', env)
     } catch (e) {
         const logsItem = localize('AWS.generic.message.viewLogs', 'View Logs...')
-        window
+        vscode.window
             .showErrorMessage(
                 localize(
                     'AWS.explorerNode.noArnFound',

src/awsexplorer/commands/copyName.ts

@@ -5,7 +5,6 @@
 
 import { Env } from '../../shared/vscode/env'
 import { copyToClipboard } from '../../shared/utilities/messages'
-import { Window } from '../../shared/vscode/window'
 import { AWSResourceNode } from '../../shared/treeview/nodes/awsResourceNode'
 import { TreeShim } from '../../shared/treeview/utils'
 
@@ -14,10 +13,9 @@ import { TreeShim } from '../../shared/treeview/utils'
  */
 export async function copyNameCommand(
     node: AWSResourceNode | TreeShim<AWSResourceNode>,
-    window = Window.vscode(),
     env = Env.vscode()
 ): Promise<void> {
     node = node instanceof TreeShim ? node.node.resource : node
 
-    await copyToClipboard(node.name, 'name', window, env)
+    await copyToClipboard(node.name, 'name', env)
 }

src/cloudWatchLogs/commands/saveCurrentLogStreamContent.ts

@@ -11,15 +11,13 @@ import * as fs from 'fs-extra'
 import * as path from 'path'
 import { SystemUtilities } from '../../shared/systemUtilities'
 import { Result } from '../../shared/telemetry/telemetry'
-import { Window } from '../../shared/vscode/window'
 import { parseCloudWatchLogsUri } from '../cloudWatchLogsUtils'
 import { LogStreamRegistry } from '../registry/logStreamRegistry'
 import { telemetry } from '../../shared/telemetry/telemetry'
 
 export async function saveCurrentLogStreamContent(
     uri: vscode.Uri | undefined,
-    registry: LogStreamRegistry,
-    window = Window.vscode()
+    registry: LogStreamRegistry
 ): Promise<void> {
     let result: Result = 'Succeeded'
 
@@ -39,7 +37,7 @@ export async function saveCurrentLogStreamContent(
         const uriComponents = parseCloudWatchLogsUri(uri)
 
         const localizedLogFile = localize('AWS.command.saveCurrentLogStreamContent.logfile', 'Log File')
-        const selectedUri = await window.showSaveDialog({
+        const selectedUri = await vscode.window.showSaveDialog({
             defaultUri: vscode.Uri.parse(path.join(workspaceDir.toString(), uriComponents.streamName)),
             filters: {
                 [localizedLogFile]: ['log'],

src/codecatalyst/tools.ts

@@ -38,11 +38,9 @@ interface MissingTool {
 
 export const hostNamePrefix = 'aws-devenv-'
 
-export async function ensureDependencies(
-    window = vscode.window
-): Promise<Result<DependencyPaths, CancellationError | Error>> {
+export async function ensureDependencies(): Promise<Result<DependencyPaths, CancellationError | Error>> {
     if (!isExtensionInstalled('ms-vscode-remote.remote-ssh')) {
-        showInstallExtensionMsg('ms-vscode-remote.remote-ssh', 'Remote SSH', 'Connecting to Dev Environment', window)
+        showInstallExtensionMsg('ms-vscode-remote.remote-ssh', 'Remote SSH', 'Connecting to Dev Environment')
 
         return Result.err(
             new ToolkitError('Remote SSH extension not installed', {

src/credentials/credentialsUtilities.ts

@@ -40,7 +40,6 @@ export function showLoginFailedMessage(credentialsId: string, errMsg: string): v
 
     showViewLogsMessage(
         localize('AWS.message.credentials.invalid', 'Credentials "{0}" failed to connect: {1}', credentialsId, errMsg),
-        vscode.window,
         'error',
         buttons
     ).then((selection: string | undefined) => {

src/dynamicResources/commands/copyIdentifier.ts

@@ -3,17 +3,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { Window } from '../../shared/vscode/window'
 import { Env } from '../../shared/vscode/env'
 import { copyToClipboard } from '../../shared/utilities/messages'
 import { telemetry } from '../../shared/telemetry/telemetry'
 
-export async function copyIdentifier(
-    typeName: string,
-    identifier: string,
-    window = Window.vscode(),
-    env = Env.vscode()
-) {
-    copyToClipboard(identifier, 'identifier', window, env)
+export async function copyIdentifier(typeName: string, identifier: string, env = Env.vscode()) {
+    copyToClipboard(identifier, 'identifier', env)
     telemetry.dynamicresource_copyIdentifier.emit({ resourceType: typeName })
 }

src/dynamicResources/commands/deleteResource.ts

@@ -5,7 +5,6 @@
 
 import * as vscode from 'vscode'
 import * as nls from 'vscode-nls'
-import { Window } from '../../shared/vscode/window'
 import { getLogger } from '../../shared/logger/logger'
 import { showConfirmationMessage, showViewLogsMessage } from '../../shared/utilities/messages'
 import { CloudControlClient } from '../../shared/clients/cloudControlClient'
@@ -17,24 +16,20 @@ const localize = nls.loadMessageBundle()
 export async function deleteResource(
     cloudControl: CloudControlClient,
     typeName: string,
-    identifier: string,
-    window = Window.vscode()
+    identifier: string
 ): Promise<boolean> {
     getLogger().info(`deleteResource called for type ${typeName} identifier ${identifier}`)
-    const ok = await showConfirmationMessage(
-        {
-            prompt: localize('aws.resources.deleteResource.prompt', 'Delete resource {0} ({1})?', identifier, typeName),
-            confirm: localize('AWS.generic.delete', 'Delete'),
-            cancel: localize('AWS.generic.cancel', 'Cancel'),
-        },
-        window
-    )
+    const ok = await showConfirmationMessage({
+        prompt: localize('aws.resources.deleteResource.prompt', 'Delete resource {0} ({1})?', identifier, typeName),
+        confirm: localize('AWS.generic.delete', 'Delete'),
+        cancel: localize('AWS.generic.cancel', 'Cancel'),
+    })
     if (!ok) {
         getLogger().info(`Cancelled delete resource type ${typeName} identifier ${identifier}`)
         return false
     }
 
-    return await window.withProgress(
+    return await vscode.window.withProgress(
         {
             location: vscode.ProgressLocation.Notification,
             cancellable: false,
@@ -55,7 +50,7 @@ export async function deleteResource(
 
                 getLogger().info(`Deleted resource type ${typeName} identifier ${identifier}`)
 
-                window.showInformationMessage(
+                vscode.window.showInformationMessage(
                     localize('aws.resources.deleteResource.success', 'Deleted resource {0} ({1})', identifier, typeName)
                 )
                 return true
@@ -66,7 +61,7 @@ export async function deleteResource(
                     getLogger().warn(
                         `Resource type ${typeName} does not support DELETE action in ${cloudControl.regionCode}`
                     )
-                    window.showWarningMessage(
+                    vscode.window.showWarningMessage(
                         localize(
                             'aws.resources.deleteResource.unsupported',
                             'Resource type {0} does not currently support delete in {1}',
@@ -84,8 +79,7 @@ export async function deleteResource(
                         'Failed to delete resource {0} ({1})',
                         identifier,
                         typeName
-                    ),
-                    window
+                    )
                 )
                 return false
             } finally {