tests(amazonq): improve test coverage

Author: David Hasani

packages/core/src/amazonqGumby/chat/controller/controller.ts

@@ -56,12 +56,12 @@ import {
 } from '../../../shared/telemetry/telemetry'
 import { MetadataResult } from '../../../shared/telemetry/telemetryClient'
 import { CodeTransformTelemetryState } from '../../telemetry/codeTransformTelemetryState'
-import { getAuthType } from '../../../codewhisperer/service/transformByQ/transformApiHandler'
 import DependencyVersions from '../../models/dependencies'
 import { getStringHash } from '../../../shared/utilities/textUtilities'
 import { getVersionData } from '../../../codewhisperer/service/transformByQ/transformMavenHandler'
 import AdmZip from 'adm-zip'
 import { AuthError } from '../../../auth/sso/server'
+import { getAuthType } from '../../../auth/utils'
 
 // These events can be interactions within the chat,
 // or elsewhere in the IDE

packages/core/src/auth/utils.ts

@@ -18,7 +18,7 @@ import { formatError, ToolkitError } from '../shared/errors'
 import { asString } from './providers/credentials'
 import { TreeNode } from '../shared/treeview/resourceTreeDataProvider'
 import { createInputBox } from '../shared/ui/inputPrompter'
-import { telemetry } from '../shared/telemetry/telemetry'
+import { CredentialSourceId, telemetry } from '../shared/telemetry/telemetry'
 import { createCommonButtons, createExitButton, createHelpButton, createRefreshButton } from '../shared/ui/buttons'
 import { getIdeProperties, isAmazonQ, isCloud9 } from '../shared/extensionUtilities'
 import { addScopes, getDependentAuths } from './secondaryAuth'
@@ -45,7 +45,7 @@ import { Commands, placeholder } from '../shared/vscode/commands2'
 import { Auth } from './auth'
 import { validateIsNewSsoUrl, validateSsoUrlFormat } from './sso/validation'
 import { getLogger } from '../shared/logger'
-import { isValidAmazonQConnection, isValidCodeWhispererCoreConnection } from '../codewhisperer/util/authUtil'
+import { AuthUtil, isValidAmazonQConnection, isValidCodeWhispererCoreConnection } from '../codewhisperer/util/authUtil'
 import { AuthFormId } from '../login/webview/vue/types'
 import { extensionVersion } from '../shared/vscode/env'
 import { ExtStartUpSources } from '../shared/telemetry'
@@ -798,3 +798,13 @@ export function initializeCredentialsProviderManager() {
     manager.addProviderFactory(new SharedCredentialsProviderFactory())
     manager.addProviders(new Ec2CredentialsProvider(), new EcsCredentialsProvider(), new EnvVarsCredentialsProvider())
 }
+
+export async function getAuthType() {
+    let authType: CredentialSourceId | undefined = undefined
+    if (AuthUtil.instance.isEnterpriseSsoInUse() && AuthUtil.instance.isConnectionValid()) {
+        authType = 'iamIdentityCenter'
+    } else if (AuthUtil.instance.isBuilderIdInUse() && AuthUtil.instance.isConnectionValid()) {
+        authType = 'awsId'
+    }
+    return authType
+}

packages/core/src/codewhisperer/service/transformByQ/transformApiHandler.ts

@@ -34,38 +34,28 @@ import {
 import { sleep } from '../../../shared/utilities/timeoutUtils'
 import AdmZip from 'adm-zip'
 import globals from '../../../shared/extensionGlobals'
-import { CredentialSourceId, telemetry } from '../../../shared/telemetry/telemetry'
+import { telemetry } from '../../../shared/telemetry/telemetry'
 import { CodeTransformTelemetryState } from '../../../amazonqGumby/telemetry/codeTransformTelemetryState'
 import { calculateTotalLatency } from '../../../amazonqGumby/telemetry/codeTransformTelemetry'
 import { MetadataResult } from '../../../shared/telemetry/telemetryClient'
 import request from '../../../shared/request'
 import { JobStoppedError, ZipExceedsSizeLimitError } from '../../../amazonqGumby/errors'
 import { writeLogs } from './transformFileHandler'
-import { AuthUtil } from '../../util/authUtil'
 import { createCodeWhispererChatStreamingClient } from '../../../shared/clients/codewhispererChatClient'
 import { downloadExportResultArchive } from '../../../shared/utilities/download'
 import { ExportIntent, TransformationDownloadArtifactType } from '@amzn/codewhisperer-streaming'
 import fs from '../../../shared/fs/fs'
 import { ChatSessionManager } from '../../../amazonqGumby/chat/storages/chatSession'
 import { encodeHTML } from '../../../shared/utilities/textUtilities'
 import { convertToTimeString } from '../../../shared/datetime'
+import { getAuthType } from '../../../auth/utils'
 
 export function getSha256(buffer: Buffer) {
     const hasher = crypto.createHash('sha256')
     hasher.update(buffer)
     return hasher.digest('base64')
 }
 
-export async function getAuthType() {
-    let authType: CredentialSourceId | undefined = undefined
-    if (AuthUtil.instance.isEnterpriseSsoInUse() && AuthUtil.instance.isConnectionValid()) {
-        authType = 'iamIdentityCenter'
-    } else if (AuthUtil.instance.isBuilderIdInUse() && AuthUtil.instance.isConnectionValid()) {
-        authType = 'awsId'
-    }
-    return authType
-}
-
 export function throwIfCancelled() {
     if (transformByQState.isCancelled()) {
         throw new TransformByQStoppedError()

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

@@ -6,10 +6,11 @@
 import assert, { fail } from 'assert'
 import * as vscode from 'vscode'
 import * as sinon from 'sinon'
-import { makeTemporaryToolkitFolder } from '../../../shared/filesystemUtilities'
 import { DB, transformByQState, TransformByQStoppedError } from '../../../codewhisperer/models/model'
 import {
+    finalizeTransformationJob,
     parseBuildFile,
+    setMaven,
     stopTransformByQ,
     validateSQLMetadataFile,
 } from '../../../codewhisperer/commands/startTransformByQ'
@@ -40,14 +41,14 @@ import {
 } from '../../../codewhisperer/service/transformByQ/transformProjectValidationHandler'
 import { TransformationCandidateProject, ZipManifest } from '../../../codewhisperer/models/model'
 import globals from '../../../shared/extensionGlobals'
-import { fs } from '../../../shared'
+import { env, fs } from '../../../shared'
 import { convertDateToTimestamp, convertToTimeString } from '../../../shared/datetime'
 
 describe('transformByQ', function () {
     let tempDir: string
 
     beforeEach(async function () {
-        tempDir = await makeTemporaryToolkitFolder()
+        tempDir = (await TestFolder.create()).path
         transformByQState.setToNotStarted()
     })
 
@@ -149,6 +150,30 @@ describe('transformByQ', function () {
         sinon.assert.calledWithExactly(stopJobStub, { transformationJobId: 'dummyId' })
     })
 
+    it('WHEN stopTransformByQ called with job that has already terminated THEN stop API not called', async function () {
+        const stopJobStub = sinon.stub(codeWhisperer.codeWhispererClient, 'codeModernizerStopCodeTransformation')
+        transformByQState.setToSucceeded()
+        await stopTransformByQ('abc-123')
+        sinon.assert.notCalled(stopJobStub)
+    })
+
+    it('WHEN finalizeTransformationJob on failed job THEN error thrown and error message fields are set', async function () {
+        await assert.rejects(async () => {
+            await finalizeTransformationJob('FAILED')
+        })
+        assert.notStrictEqual(transformByQState.getJobFailureErrorChatMessage(), undefined)
+        assert.notStrictEqual(transformByQState.getJobFailureErrorNotification(), undefined)
+        transformByQState.setJobDefaults() // reset error messages to undefined
+    })
+
+    it('WHEN finalizeTransformationJob on successful job THEN error not thrown and error message fields are not set', async function () {
+        await assert.doesNotReject(async () => {
+            await finalizeTransformationJob('COMPLETED')
+        })
+        assert.strictEqual(transformByQState.getJobFailureErrorChatMessage(), undefined)
+        assert.strictEqual(transformByQState.getJobFailureErrorNotification(), undefined)
+    })
+
     it('WHEN polling completed job THEN returns status as completed', async function () {
         const mockJobResponse = {
             $response: {
@@ -208,6 +233,16 @@ describe('transformByQ', function () {
         assert.deepStrictEqual(actual, expected)
     })
 
+    it(`WHEN transforming a project with a Windows Maven executable THEN mavenName set correctly`, async function () {
+        sinon.stub(env, 'isWin').returns(true)
+        const tempFileName = 'mvnw.cmd'
+        const tempFilePath = path.join(tempDir, tempFileName)
+        await toFile('', tempFilePath)
+        transformByQState.setProjectPath(tempDir)
+        await setMaven()
+        assert.strictEqual(transformByQState.getMavenName(), '.\\mvnw.cmd')
+    })
+
     it(`WHEN zip created THEN manifest.json contains test-compile custom build command`, async function () {
         const tempFileName = `testfile-${globals.clock.Date.now()}.zip`
         transformByQState.setProjectPath(tempDir)
@@ -234,6 +269,19 @@ describe('transformByQ', function () {
         })
     })
 
+    it('WHEN zipCode THEN ZIP contains all expected files and no unexpected files', async function () {
+        const zipFilePath = path.join(tempDir, 'test.zip')
+        const zip = new AdmZip()
+        await fs.writeFile(path.join(tempDir, 'pom.xml'), 'dummy pom.xml')
+        zip.addLocalFile(path.join(tempDir, 'pom.xml'))
+        zip.addFile('manifest.json', Buffer.from(JSON.stringify({ version: '1.0' })))
+        zip.writeZip(zipFilePath)
+        const zipFiles = new AdmZip(zipFilePath).getEntries()
+        const zipFileNames = zipFiles.map((file) => file.name)
+        assert.strictEqual(zipFileNames.length, 2) // expecting only pom.xml and manifest.json
+        assert.strictEqual(zipFileNames.includes('pom.xml') && zipFileNames.includes('manifest.json'), true)
+    })
+
     it(`WHEN zip created THEN dependencies contains no .sha1 or .repositories files`, async function () {
         const m2Folders = [
             'com/groupid1/artifactid1/version1',

packages/core/src/testE2E/amazonqGumby/transformByQ.test.ts renamed to packages/core/src/testInteg/amazonQTransform/transformByQ.test.ts

@@ -10,11 +10,10 @@ import * as codeWhisperer from '../../codewhisperer/client/codewhisperer'
 import assert from 'assert'
 import { getSha256, uploadArtifactToS3, zipCode } from '../../codewhisperer/service/transformByQ/transformApiHandler'
 import request from '../../shared/request'
-import AdmZip from 'adm-zip'
-import { setValidConnection } from '../util/connection'
 import { transformByQState, ZipManifest } from '../../codewhisperer/models/model'
 import globals from '../../shared/extensionGlobals'
 import { fs } from '../../shared'
+import { setValidConnection } from '../../testE2E/util/connection'
 
 describe('transformByQ', async function () {
     let tempDir = ''
@@ -35,10 +34,6 @@ describe('transformByQ', async function () {
         await fs.writeFile(tempFilePath, 'sample content for the test file')
         transformByQState.setProjectPath(tempDir)
         const zipCodeResult = await zipCode({
-            dependenciesFolder: {
-                path: tempFilePath,
-                name: tempFileName,
-            },
             projectPath: tempDir,
             zipManifest: new ZipManifest(),
         })
@@ -87,7 +82,7 @@ describe('transformByQ', async function () {
         )
     })
 
-    it('WHEN createUploadUrl THEN URL uses HTTPS and sets 60 second expiration', async function () {
+    it('WHEN createUploadUrl THEN URL uses HTTPS and sets 30 minute expiration', async function () {
         const buffer = Buffer.from(await fs.readFileBytes(zippedCodePath))
         const sha256 = getSha256(buffer)
         const response = await codeWhisperer.codeWhispererClient.createUploadUrl({
@@ -96,17 +91,8 @@ describe('transformByQ', async function () {
             uploadIntent: CodeWhispererConstants.uploadIntent,
         })
         const uploadUrl = response.uploadUrl
-        const usesHttpsAndExpiresAfter60Seconds = uploadUrl.includes('https') && uploadUrl.includes('X-Amz-Expires=60')
+        const usesHttpsAndExpiresAfter60Seconds =
+            uploadUrl.includes('https') && uploadUrl.includes('X-Amz-Expires=1800')
         assert.strictEqual(usesHttpsAndExpiresAfter60Seconds, true)
     })
-
-    it('WHEN zipCode THEN ZIP contains all expected files and no unexpected files', async function () {
-        const zipFiles = new AdmZip(zippedCodePath).getEntries()
-        const zipFileNames: string[] = []
-        zipFiles.forEach((file) => {
-            zipFileNames.push(file.name)
-        })
-        assert.strictEqual(zipFileNames.length, 2) // expecting only a dummy txt file and a manifest.json
-        assert.strictEqual(zipFileNames.includes(tempFileName) && zipFileNames.includes('manifest.json'), true)
-    })
 })