refactor(fs): prefer our fs and fs to fs-extra (pt2: test files)

docs/vscode_behaviors.md

@@ -12,10 +12,10 @@ for each extension.
 -   The Extension Host process has at most 5 seconds to shut down, after which it will exit. [1]
 -   The vscode API will be unreliable at deactivation time. So certain VSC APIs like the filesystem may not work. [1]
     -   The VSC Filesystem API has been confirmed to not work
-- In `Run & Debug` mode, closing the Debug IDE instance behaves differently depending on how it is closed
-    - The regular close button in the Debug IDE instance results in a graceful shutdown
-    - The red square in the root IDE instance to stop the debugging session results on a non-graceful shutdown, meaning `deactivate()` is not run.
-- `Reload Window` triggers `deactivate()`
+-   In `Run & Debug` mode, closing the Debug IDE instance behaves differently depending on how it is closed
+    -   The regular close button in the Debug IDE instance results in a graceful shutdown
+    -   The red square in the root IDE instance to stop the debugging session results on a non-graceful shutdown, meaning `deactivate()` is not run.
+-   `Reload Window` triggers `deactivate()`
 
 Sources:
 
@@ -25,8 +25,7 @@ Sources:
 ## State (`globalState`, `Memento`)
 
 TODO:
-- How it behaves between remote (ssh) and local
-- How it is not completely reliable. Reads/writes have no guarantee to work (though we are fine in most cases)
-- How it can break as observed with crash monitoring work. At a certain point writes were seemingly succeeding, but did not actually propagate to all IDE instances.
-
 
+-   How it behaves between remote (ssh) and local
+-   How it is not completely reliable. Reads/writes have no guarantee to work (though we are fine in most cases)
+-   How it can break as observed with crash monitoring work. At a certain point writes were seemingly succeeding, but did not actually propagate to all IDE instances.

packages/amazonq/test/unit/amazonqGumby/transformationResultsHandler.test.ts

@@ -4,11 +4,11 @@
  */
 import assert from 'assert'
 import sinon from 'sinon'
-import fs from 'fs-extra'
 import os from 'os'
 import { DiffModel, AddedChangeNode, ModifiedChangeNode } from 'aws-core-vscode/codewhisperer/node'
 import path from 'path'
 import { getTestResourceFilePath } from './amazonQGumbyUtil'
+import { fs } from 'aws-core-vscode/shared'
 
 describe('DiffModel', function () {
     afterEach(() => {
@@ -20,7 +20,7 @@ describe('DiffModel', function () {
 
         const workspacePath = 'workspace'
 
-        sinon.replace(fs, 'existsSync', (path) => {
+        sinon.replace(fs, 'exists', async (path) => {
             const pathStr = path.toString()
             if (pathStr.includes(workspacePath)) {
                 return false
@@ -42,9 +42,9 @@ describe('DiffModel', function () {
 
         const workspacePath = os.tmpdir()
 
-        sinon.replace(fs, 'existsSync', (path) => true)
+        sinon.replace(fs, 'exists', async (path) => true)
 
-        fs.writeFileSync(
+        await fs.writeFile(
             path.join(workspacePath, 'README.md'),
             'This guide walks you through using Gradle to build a simple Java project.'
         )
@@ -56,6 +56,6 @@ describe('DiffModel', function () {
 
         assert.strictEqual(change instanceof ModifiedChangeNode, true)
 
-        fs.rmSync(path.join(workspacePath, 'README.md'))
+        await fs.delete(path.join(workspacePath, 'README.md'), { recursive: true })
     })
 })

packages/core/src/test/awsService/cdk/detectCdkProjects.test.ts

@@ -6,14 +6,13 @@
 import assert from 'assert'
 import * as path from 'path'
 import * as vscode from 'vscode'
-import * as fs from 'fs-extra'
 import { detectCdkProjects } from '../../../awsService/cdk/explorer/detectCdkProjects'
 import { makeTemporaryToolkitFolder } from '../../../shared/filesystemUtilities'
 import { saveCdkJson } from './treeTestUtils'
 import { createTestWorkspaceFolder } from '../../testUtil'
 import { FakeExtensionContext } from '../../fakeExtensionContext'
-import { mkdirp, writeJSON } from 'fs-extra'
 import { waitUntil } from '../../../shared/utilities/timeoutUtils'
+import { fs } from '../../../shared'
 
 describe('detectCdkProjects', function () {
     const workspacePaths: string[] = []
@@ -45,7 +44,7 @@ describe('detectCdkProjects', function () {
 
     afterEach(async function () {
         for (const path of workspacePaths) {
-            await fs.remove(path)
+            await fs.delete(path, { recursive: true })
         }
 
         workspacePaths.length = 0
@@ -88,15 +87,15 @@ describe('detectCdkProjects', function () {
 
     it('detects deep projects', async function () {
         const cdkJsonUri = vscode.Uri.joinPath(workspaceFolders[0].uri, 'directory1', 'directory2', 'cdk.json')
-        await mkdirp(path.dirname(cdkJsonUri.fsPath))
+        await fs.mkdir(path.dirname(cdkJsonUri.fsPath))
         await saveCdkJson(cdkJsonUri.fsPath)
         const actual = await detectCdkProjects_wait(workspaceFolders)
         assert.strictEqual(actual[0]?.cdkJsonUri.fsPath, cdkJsonUri.fsPath)
     })
 
     it('ignores projects in `node_modules`', async function () {
         const cdkJsonPath = path.join(workspaceFolders[0].uri.fsPath, 'node_modules', 'lib', 'cdk.json')
-        await mkdirp(path.dirname(cdkJsonPath))
+        await fs.mkdir(path.dirname(cdkJsonPath))
         await saveCdkJson(cdkJsonPath)
         const actual = await detectCdkProjects_wait(workspaceFolders)
         assert.strictEqual(actual.length, 0)
@@ -118,7 +117,8 @@ describe('detectCdkProjects', function () {
 
     it('takes into account `output` from cdk.json to build tree.json path', async function () {
         const cdkJsonUri = vscode.Uri.joinPath(workspaceFolders[0].uri, 'cdk.json')
-        await writeJSON(cdkJsonUri.fsPath, { app: 'npx ts-node bin/demo-nov7.ts', output: 'build/cdk.out' })
+        const cdkJsonStr = JSON.stringify({ app: 'npx ts-node bin/demo-nov7.ts', output: 'build/cdk.out' })
+        await fs.writeFile(cdkJsonUri.fsPath, cdkJsonStr)
         const actual = await detectCdkProjects_wait(workspaceFolders)
 
         assert.ok(actual)

packages/core/src/test/awsService/cdk/treeTestUtils.ts

@@ -3,13 +3,13 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { writeFile } from 'fs-extra'
 import { ConstructTree, ConstructTreeEntity } from '../../../awsService/cdk/explorer/tree/types'
+import { fs } from '../../../shared'
 
 export async function saveCdkJson(cdkJsonPath: string) {
     const cdkJsonContent = '{ "app": "npx ts-node bin/demo-nov7.ts"}'
 
-    await writeFile(cdkJsonPath, cdkJsonContent, 'utf8')
+    await fs.writeFile(cdkJsonPath, cdkJsonContent, 'utf8')
 }
 
 export function generateConstructTreeEntity(label: string, treePath: string, children?: boolean): ConstructTreeEntity {

packages/core/src/test/awsService/cloudWatchLogs/commands/saveCurrentLogDataContent.test.ts

@@ -6,7 +6,6 @@
 import assert from 'assert'
 import * as path from 'path'
 import * as vscode from 'vscode'
-import * as fs from 'fs-extra'
 
 import { createURIFromArgs } from '../../../../awsService/cloudWatchLogs/cloudWatchLogsUtils'
 import { saveCurrentLogDataContent } from '../../../../awsService/cloudWatchLogs/commands/saveCurrentLogDataContent'
@@ -19,6 +18,7 @@ import {
     LogDataRegistry,
 } from '../../../../awsService/cloudWatchLogs/registry/logDataRegistry'
 import { assertTextEditorContains } from '../../../testUtil'
+import { fs } from '../../../../shared'
 
 async function testFilterLogEvents(
     logGroupInfo: CloudWatchLogsGroupInfo,
@@ -46,7 +46,7 @@ describe('saveCurrentLogDataContent', async function () {
     })
 
     afterEach(async function () {
-        await fs.remove(tempDir)
+        await fs.delete(tempDir, { recursive: true })
     })
 
     it('saves log content to a file', async function () {

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

@@ -35,7 +35,7 @@ describe('SshKeyUtility', async function () {
     })
 
     after(async function () {
-        await fs.delete(temporaryDirectory, { recursive: true, force: true })
+        await fs.delete(temporaryDirectory, { recursive: true })
         clock.uninstall()
         sinon.restore()
     })

packages/core/src/test/codewhisperer/commands/transformByQ.test.ts

@@ -5,7 +5,6 @@
 
 import assert, { fail } from 'assert'
 import * as vscode from 'vscode'
-import * as fs from 'fs-extra'
 import * as sinon from 'sinon'
 import { makeTemporaryToolkitFolder } from '../../../shared/filesystemUtilities'
 import { transformByQState, TransformByQStoppedError } from '../../../codewhisperer/models/model'
@@ -37,6 +36,7 @@ import {
 } from '../../../codewhisperer/service/transformByQ/transformProjectValidationHandler'
 import { TransformationCandidateProject, ZipManifest } from '../../../codewhisperer/models/model'
 import globals from '../../../shared/extensionGlobals'
+import { fs } from '../../../shared'
 
 describe('transformByQ', function () {
     let tempDir: string
@@ -48,7 +48,7 @@ describe('transformByQ', function () {
 
     afterEach(async function () {
         sinon.restore()
-        await fs.remove(tempDir)
+        await fs.delete(tempDir, { recursive: true })
     })
 
     it('WHEN converting short duration in milliseconds THEN converts correctly', async function () {
@@ -254,13 +254,13 @@ describe('transformByQ', function () {
             'resolver-status.properties',
         ]
 
-        m2Folders.forEach((folder) => {
+        for (const folder of m2Folders) {
             const folderPath = path.join(tempDir, folder)
-            fs.mkdirSync(folderPath, { recursive: true })
-            filesToAdd.forEach((file) => {
-                fs.writeFileSync(path.join(folderPath, file), 'sample content for the test file')
-            })
-        })
+            await fs.mkdir(folderPath)
+            for (const file of filesToAdd) {
+                await fs.writeFile(path.join(folderPath, file), 'sample content for the test file')
+            }
+        }
 
         const tempFileName = `testfile-${globals.clock.Date.now()}.zip`
         transformByQState.setProjectPath(tempDir)

packages/core/src/test/credentials/sharedCredentials.test.ts

@@ -5,10 +5,10 @@
 
 import assert from 'assert'
 import * as path from 'path'
-import * as fs from 'fs-extra'
 import { EnvironmentVariables } from '../../shared/environmentVariables'
 import { makeTemporaryToolkitFolder } from '../../shared/filesystemUtilities'
 import { getCredentialsFilename, getConfigFilename } from '../../auth/credentials/sharedCredentialsFile'
+import { fs } from '../../shared'
 
 describe('sharedCredentials', function () {
     let tempFolder: string
@@ -26,7 +26,7 @@ describe('sharedCredentials', function () {
     })
 
     after(async function () {
-        await fs.remove(tempFolder)
+        await fs.delete(tempFolder, { recursive: true })
     })
 
     describe('getCredentialsFilename', function () {

packages/core/src/test/credentials/sso/cache.test.ts

@@ -5,9 +5,9 @@
 
 import assert from 'assert'
 import * as path from 'path'
-import * as fs from 'fs-extra'
 import { makeTemporaryToolkitFolder, tryRemoveFolder } from '../../../shared/filesystemUtilities'
 import { getRegistrationCache, getTokenCache } from '../../../auth/sso/cache'
+import { fs } from '../../../shared'
 
 describe('SSO Cache', function () {
     const region = 'dummyRegion'
@@ -47,7 +47,7 @@ describe('SSO Cache', function () {
             await cache.save({ startUrl, region }, validRegistration)
 
             const cachedPath = path.join(testDir, `aws-toolkit-vscode-client-id-${region}.json`)
-            const contents = await fs.readFile(cachedPath, 'utf-8')
+            const contents = await fs.readFileAsString(cachedPath)
 
             assert.deepStrictEqual(JSON.parse(contents), {
                 ...validRegistration,
@@ -70,7 +70,7 @@ describe('SSO Cache', function () {
 
             // SHA-1 hash of the encoded start URL `https://123456.awsapps.com/start`
             const cachedPath = path.join(testDir, 'c1ac99f782ad92755c6de8647b510ec247330ad1.json')
-            const contents = await fs.readFile(cachedPath, 'utf-8')
+            const contents = await fs.readFileAsString(cachedPath)
 
             assert.deepStrictEqual(JSON.parse(contents), {
                 region,

packages/core/src/test/dynamicResources/awsResourceManager.test.ts

@@ -16,12 +16,12 @@ import { CloudControlClient, DefaultCloudControlClient } from '../../shared/clie
 import { CloudFormationClient, DefaultCloudFormationClient } from '../../shared/clients/cloudFormationClient'
 import { makeTemporaryToolkitFolder, readFileAsString } from '../../shared/filesystemUtilities'
 import { FakeExtensionContext } from '../fakeExtensionContext'
-import { remove } from 'fs-extra'
 import { existsSync } from 'fs'
 import { ResourceTypeMetadata } from '../../dynamicResources/model/resources'
 import globals from '../../shared/extensionGlobals'
 import { Stub, stub } from '../utilities/stubber'
 import { CloudControl, CloudFormation } from 'aws-sdk'
+import { fs } from '../../shared'
 
 describe('ResourceManager', function () {
     let sandbox: sinon.SinonSandbox
@@ -71,7 +71,7 @@ describe('ResourceManager', function () {
         registerMappingSpy.restore()
         sandbox.restore()
         await resourceManager.dispose()
-        await remove(tempFolder)
+        await fs.delete(tempFolder, { recursive: true })
     })
 
     it('opens resources in preview mode', async function () {