test(amazonq): E2E test for /doc #6215
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| /*! | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import assert from 'assert' | ||
| import { qTestingFramework } from './framework/framework' | ||
| import sinon from 'sinon' | ||
| import { registerAuthHook, using } from 'aws-core-vscode/test' | ||
| import { loginToIdC } from './utils/setup' | ||
| import { Messenger } from './framework/messenger' | ||
| import { FollowUpTypes } from 'aws-core-vscode/amazonq' | ||
| import { i18n } from 'aws-core-vscode/shared' | ||
| import { docGenerationProgressMessage, DocGenerationStep, Mode } from 'aws-core-vscode/amazonqDoc' | ||
|
|
||
| describe('Amazon Q Doc', async function () { | ||
| let framework: qTestingFramework | ||
| let tab: Messenger | ||
|
|
||
| before(async function () { | ||
| /** | ||
| * The tests are getting throttled, only run them on stable for now | ||
| * | ||
| * TODO: Re-enable for all versions once the backend can handle them | ||
| */ | ||
| const testVersion = process.env['VSCODE_TEST_VERSION'] | ||
| if (testVersion && testVersion !== 'stable') { | ||
| this.skip() | ||
| } | ||
|
|
||
| await using(registerAuthHook('amazonq-test-account'), async () => { | ||
| await loginToIdC() | ||
| }) | ||
| }) | ||
|
|
||
| beforeEach(() => { | ||
| registerAuthHook('amazonq-test-account') | ||
| framework = new qTestingFramework('doc', true, []) | ||
| tab = framework.createTab() | ||
| }) | ||
|
|
||
| afterEach(() => { | ||
| framework.removeTab(tab.tabID) | ||
| framework.dispose() | ||
| sinon.restore() | ||
|
Contributor
There was a problem hiding this comment. why is sinon needed in e2e tests? if this is part of the |
||
| }) | ||
|
|
||
| describe('Quick action availability', () => { | ||
| it('Shows /doc when doc generation is enabled', async () => { | ||
| const command = tab.findCommand('/doc') | ||
| if (!command.length) { | ||
| assert.fail('Could not find command') | ||
| } | ||
|
|
||
| if (command.length > 1) { | ||
| assert.fail('Found too many commands with the name /doc') | ||
| } | ||
| }) | ||
|
|
||
| it('Does NOT show /doc when doc generation is NOT enabled', () => { | ||
| // The beforeEach registers a framework which accepts requests. If we don't dispose before building a new one we have duplicate messages | ||
| framework.dispose() | ||
| framework = new qTestingFramework('doc', false, []) | ||
| const tab = framework.createTab() | ||
| const command = tab.findCommand('/doc') | ||
| if (command.length > 0) { | ||
| assert.fail('Found command when it should not have been found') | ||
| } | ||
| }) | ||
| }) | ||
|
|
||
| describe('/doc entry', () => { | ||
| beforeEach(async function () { | ||
| tab.addChatMessage({ command: '/doc' }) | ||
| await tab.waitForChatFinishesLoading() | ||
| }) | ||
|
|
||
| it('Checks for initial follow ups', async () => { | ||
| await tab.waitForButtons([FollowUpTypes.CreateDocumentation, FollowUpTypes.UpdateDocumentation]) | ||
| }) | ||
| }) | ||
|
|
||
| describe('Creates a README', () => { | ||
| beforeEach(async function () { | ||
| tab.addChatMessage({ command: '/doc' }) | ||
| await tab.waitForChatFinishesLoading() | ||
| }) | ||
|
|
||
| it('Creates a README for root folder', async () => { | ||
| await tab.waitForButtons([FollowUpTypes.CreateDocumentation]) | ||
|
|
||
| tab.clickButton(FollowUpTypes.CreateDocumentation) | ||
|
|
||
| await tab.waitForText(i18n('AWS.amazonq.doc.answer.createReadme')) | ||
|
|
||
| await tab.waitForButtons([FollowUpTypes.ProceedFolderSelection]) | ||
|
|
||
| tab.clickButton(FollowUpTypes.ProceedFolderSelection) | ||
|
|
||
| await tab.waitForText(docGenerationProgressMessage(DocGenerationStep.SUMMARIZING_FILES, Mode.CREATE)) | ||
|
|
||
| await tab.waitForText( | ||
| `${i18n('AWS.amazonq.doc.answer.readmeCreated')} ${i18n('AWS.amazonq.doc.answer.codeResult')}` | ||
| ) | ||
|
|
||
| await tab.waitForButtons([ | ||
| FollowUpTypes.AcceptChanges, | ||
| FollowUpTypes.MakeChanges, | ||
| FollowUpTypes.RejectChanges, | ||
| ]) | ||
| }) | ||
| }) | ||
| }) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.