fix(lambda): flakiness due to existing template.yaml #6924

## Problem
fix #6921

## Solution
Refactor the tests for cleaner creating and deletion template.yaml file.
- Scope and group tests cases based on required starting template. 
- Update assertion and error message.

Author: vicheey

packages/core/src/test/awsService/appBuilder/walkthrough.test.ts

@@ -166,82 +166,93 @@ describe('AppBuilder Walkthrough', function () {
         const prevInfo = 'random text'
         assert.ok(workspaceUri)
 
-        before(async function () {
-            await fs.delete(vscode.Uri.joinPath(workspaceUri, 'template.yaml'), { force: true })
-        })
-
-        beforeEach(async function () {
-            await fs.writeFile(vscode.Uri.joinPath(workspaceUri, 'template.yaml'), prevInfo)
-        })
-
-        afterEach(async function () {
-            await fs.delete(vscode.Uri.joinPath(workspaceUri, 'template.yaml'), { force: true })
-        })
+        describe('start without existing template', async () => {
+            beforeEach(async () => {
+                await fs.delete(vscode.Uri.joinPath(workspaceUri, 'template.yaml'), { force: true })
+            })
 
-        it('open existing template', async function () {
-            // Given no template exist
-            await fs.delete(vscode.Uri.joinPath(workspaceUri, 'template.yaml'), { force: true })
-            // When
-            await genWalkthroughProject('CustomTemplate', workspaceUri, undefined)
-            // Then nothing should be created
-            assert.equal(await fs.exists(vscode.Uri.joinPath(workspaceUri, 'template.yaml')), false)
+            it('open existing template', async function () {
+                // When
+                await genWalkthroughProject('CustomTemplate', workspaceUri, undefined)
+                // Then nothing should be created
+                assert.ok(!(await fs.exists(vscode.Uri.joinPath(workspaceUri, 'template.yaml'))))
+            })
         })
 
-        it('build an app with appcomposer overwrite', async function () {
-            getTestWindow().onDidShowMessage((message) => {
-                message.selectItem('Yes')
+        describe('start with an existing template', async () => {
+            beforeEach(async () => {
+                await fs.writeFile(vscode.Uri.joinPath(workspaceUri, 'template.yaml'), prevInfo)
             })
-            // When
-            await genWalkthroughProject('Visual', workspaceUri, undefined)
-            // Then
-            assert.notEqual(await fs.readFileText(vscode.Uri.joinPath(workspaceUri, 'template.yaml')), prevInfo)
-        })
 
-        it('build an app with appcomposer no overwrite', async function () {
-            // Given
-            getTestWindow().onDidShowMessage((message) => {
-                message.selectItem('No')
+            afterEach(async function () {
+                await fs.delete(vscode.Uri.joinPath(workspaceUri, 'template.yaml'), { force: true })
             })
-            // When
-            try {
-                // When
-                await genWalkthroughProject('Visual', workspaceUri, undefined)
-                assert.fail('A file named template.yaml already exists in this path.')
-            } catch (e) {
-                assert.equal((e as Error).message, 'A file named template.yaml already exists in this path.')
-            }
-            // Then
-            assert.equal(await fs.readFileText(vscode.Uri.joinPath(workspaceUri, 'template.yaml')), prevInfo)
-        })
 
-        it('download serverlessland proj', async function () {
-            // Given
-            // select overwrite
-            getTestWindow().onDidShowMessage((message) => {
-                message.selectItem('Yes')
+            describe('override existing template', async () => {
+                beforeEach(() => {
+                    getTestWindow().onDidShowMessage((message) => {
+                        assert.strictEqual(
+                            message.message,
+                            'template.yaml already exist in the selected directory, overwrite?'
+                        )
+                        message.selectItem('Yes')
+                    })
+                })
+
+                it('build an app with appcomposer', async function () {
+                    // When
+                    await genWalkthroughProject('Visual', workspaceUri, undefined)
+                    // Then
+                    assert.notEqual(await fs.readFileText(vscode.Uri.joinPath(workspaceUri, 'template.yaml')), prevInfo)
+                })
+
+                it('download serverlessland proj', async function () {
+                    // When
+                    await genWalkthroughProject('API', workspaceUri, 'python')
+                    // Then template should be overwritten
+                    assert.equal(await fs.exists(vscode.Uri.joinPath(workspaceUri, 'template.yaml')), true)
+                    assert.notEqual(await fs.readFileText(vscode.Uri.joinPath(workspaceUri, 'template.yaml')), prevInfo)
+                })
             })
-            // When
-            await genWalkthroughProject('API', workspaceUri, 'python')
-            // Then template should be overwritten
-            assert.equal(await fs.exists(vscode.Uri.joinPath(workspaceUri, 'template.yaml')), true)
-            assert.notEqual(await fs.readFileText(vscode.Uri.joinPath(workspaceUri, 'template.yaml')), prevInfo)
-        })
 
-        it('download serverlessland proj no overwrite', async function () {
-            // Given existing template.yaml
-            // select do not overwrite
-            getTestWindow().onDidShowMessage((message) => {
-                message.selectItem('No')
+            describe('without override existing template', async () => {
+                beforeEach(() => {
+                    // Given existing template.yaml
+                    // select do not overwrite
+                    getTestWindow().onDidShowMessage((message) => {
+                        assert.strictEqual(
+                            message.message,
+                            'template.yaml already exist in the selected directory, overwrite?'
+                        )
+                        message.selectItem('No')
+                    })
+                })
+
+                it('build an app with appcomposer', async function () {
+                    // When
+                    try {
+                        // When
+                        await genWalkthroughProject('Visual', workspaceUri, undefined)
+                        assert.fail('Expect failure due to template.yaml already exists in this path, but see success.')
+                    } catch (e) {
+                        assert.equal((e as Error).message, 'A file named template.yaml already exists in this path.')
+                    }
+                    // Then
+                    assert.equal(await fs.readFileText(vscode.Uri.joinPath(workspaceUri, 'template.yaml')), prevInfo)
+                })
+
+                it('download serverlessland proj', async function () {
+                    try {
+                        // When
+                        await genWalkthroughProject('S3', workspaceUri, 'python')
+                        assert.fail('Expect failure due to template.yaml already exists in this path, but see success.')
+                    } catch (e) {
+                        assert.equal((e as Error).message, 'A file named template.yaml already exists in this path.')
+                    }
+                    // Then no overwrite happens
+                    assert.equal(await fs.readFileText(vscode.Uri.joinPath(workspaceUri, 'template.yaml')), prevInfo)
+                })
             })
-            try {
-                // When
-                await genWalkthroughProject('S3', workspaceUri, 'python')
-                assert.fail('A file named template.yaml already exists in this path.')
-            } catch (e) {
-                assert.equal((e as Error).message, 'A file named template.yaml already exists in this path.')
-            }
-            // Then no overwrite happens
-            assert.equal(await fs.readFileText(vscode.Uri.joinPath(workspaceUri, 'template.yaml')), prevInfo)
         })
     })
 

packages/core/src/test/shared/sam/build.test.ts

@@ -332,15 +332,16 @@ describe('SAM runBuild', () => {
         })
 
         afterEach(() => {
+            spyRunInterminal.resetHistory()
             sandbox.restore()
         })
 
         const verifyCorrectDependencyCall = () => {
             // Prefer count comparison for debugging flakiness
-            assert.strictEqual(mockGetSamCliPath.callCount, 1)
-            assert.strictEqual(mockChildProcessClass.callCount, 1)
-            assert.strictEqual(mockGetSpawnEnv.callCount, 1)
-            assert.strictEqual(spyRunInterminal.callCount, 1)
+            assert.strictEqual(1, mockGetSamCliPath.callCount, 'GetSamCliPath')
+            assert.strictEqual(1, mockChildProcessClass.callCount, 'ChildProcessClass')
+            assert.strictEqual(1, mockGetSpawnEnv.callCount, 'GetSpawnEnv')
+            assert.strictEqual(1, spyRunInterminal.callCount, 'RunInterminal')
             assert.deepEqual(spyRunInterminal.getCall(0).args, [mockSamBuildChildProcess, 'build'])
         }
 
@@ -527,6 +528,7 @@ describe('SAM runBuild', () => {
                     },
                 },
             ])
+
             verifyCorrectDependencyCall()
             prompterTester.assertCallAll()
         })