test(qdoc): Add ui tests for qdoc update readme flow #5435

gandhi-21 · 2025-03-04T19:18:36Z

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)

Description

Add UI tests to validate the Update an existing README flow
Created a sample repository from scratch,
For Update README to reflect code flow, there are 3 tests which confirm that the user is

Shown the option to confirm / change folder / cancel on selecting the update options
Shown the Update with specific changes flow when selecting Make Changes upon getting updated readme back
The Readme updates with the latest changes

For Make a specific change flow, there are 2 tests which confirm that the user is

Shown the Update with specific changes flow when selecting Make Changes upon getting updated readme back
The Readme is updated with the specific changes requested

Checklist

My code follows the code style of this project
I have added tests to cover my changes
A short description of the change has been added to the CHANGELOG if the change is customer-facing in the IDE.
I have added metrics for my changes (if required)

License

I confirm that my contribution is made under the terms of the Apache 2.0 license.

...re/aws/toolkits/jetbrains/uitests/docTests/scripts/UpdateReadmeWithSpecificChangesScripts.kt

...etbrains/uitests/docTests/updateReadmeTests/UpdateReadmeLatestChanges/MakeChangesFlowTest.kt

...brains/uitests/docTests/updateReadmeTests/UpdateReadmeSpecificChanges/MakeChangesFlowTest.kt

ui-tests-starter/tstData/qdoc/updateFlow/dockerfile

gandhi-21 · 2025-03-13T17:57:59Z

/retryBuilds

manodnyab · 2025-03-13T22:36:14Z

...ware/aws/toolkits/jetbrains/uitests/docTests/scripts/UpdateReadmeWithLatestChangesScripts.kt

+                const contents = await page.evaluate(el => el.innerHTML, await page.${'$'}(':root'));
+
+                const element = await page.${'$'}('.mynah-chat-prompt-input');
+                if(element) {
+
+                    console.log('Typing /doc in the chat window');
+
+                    await page.type('.mynah-chat-prompt-input', '/doc');
+                    await page.keyboard.press('Enter');
+
+                    console.log('Attempting to find and click Update an existing README button'); 
+                    await findAndClickButton(page, 'Update an existing README', true, 10000);
+                    console.log('Attempting to find and click Update README to reflect code button');
+                    await findAndClickButton(page, 'Update README to reflect code', true, 10000);


These few lines appear to be repeated in most tests, can they be abstracted?

abstracting parts of the testing flow can cause issues while trying to read and debug code for someone unfamiliar. So we should keep testing scripts as is to understand what's happening in the test without needing to jump around.

manodnyab · 2025-03-13T22:37:15Z

...sts-starter/tst-243+/software/aws/toolkits/jetbrains/uitests/docTests/scripts/ScriptUtils.kt

+package software.aws.toolkits.jetbrains.uitests.docTests.scripts
+
+// language=TS
+val findAndClickButtonScript = """


This is awesome! Maybe could be moved to a common utils file so other teams can also use it

sure, doesn't seem blocking though, i can do that in a followup

...sts-starter/tst-243+/software/aws/toolkits/jetbrains/uitests/docTests/scripts/ScriptUtils.kt

...e/aws/toolkits/jetbrains/uitests/docTests/updateReadmeTests/UpdateReadmeLatestChangesTest.kt

gandhi-21 · 2025-03-14T17:54:42Z

/runUiTests

…to JS (followups from aws#5435)

Add UI tests to validate the Update an existing README flow Created a sample repository from scratch, For Update README to reflect code flow, there are 3 tests which confirm that the user is Shown the option to confirm / change folder / cancel on selecting the update options Shown the Update with specific changes flow when selecting Make Changes upon getting updated readme back The Readme updates with the latest changes For Make a specific change flow, there are 2 tests which confirm that the user is Shown the Update with specific changes flow when selecting Make Changes upon getting updated readme back The Readme is updated with the specific changes requested * test(qdoc): initial tests for latest code changes flow * update tstData to test * update scripts + move test data to subfolder for update readme tests * update instructions in update readme with specific changes test * update base readme for testing the update readme flow * update test assertions for q doc update flow tests * separate out test cases into individual tests * remove gradle settings file for q doc update flow test repo * log result from scripts for debugging * manually restore readme after each test run * add end of assertions println for debugging + update readme * update q tests config for debugging * update config and rename dummy repo files for create readme tests * update build file for create readme tests sample repo * update to print the result on failures only * remove unused file from test dummy repo --------- Co-authored-by: Gaurav Gandhi <[email protected]>

…to JS (followups from aws#5435)

* move findAndClickButton to common ScriptUtils & update script syntax to JS (followups from #5435) * initial commit: add qdoc create readme tests --------- Co-authored-by: Gaurav Gandhi <[email protected]>

gandhi-21 changed the title ~~test(qdoc) Add tests for QDoc latest code changes flow~~ test(qdoc) Add tests for qdoc update readme flow Mar 4, 2025

gandhi-21 closed this Mar 4, 2025

gandhi-21 reopened this Mar 4, 2025

gandhi-21 changed the title ~~test(qdoc) Add tests for qdoc update readme flow~~ test(qdoc): Add tests for qdoc update readme flow Mar 4, 2025

gandhi-21 closed this Mar 4, 2025

gandhi-21 reopened this Mar 4, 2025

gandhi-21 marked this pull request as ready for review March 4, 2025 21:29

gandhi-21 requested a review from a team as a code owner March 4, 2025 21:29

gandhi-21 force-pushed the doc branch 2 times, most recently from 56730c2 to 8cc8c6d Compare March 6, 2025 16:21

juanbenj approved these changes Mar 7, 2025

View reviewed changes

aggagen approved these changes Mar 7, 2025

View reviewed changes

gandhi-21 force-pushed the doc branch from bdcc977 to ded6a49 Compare March 10, 2025 15:51

Gaurav Gandhi added 12 commits March 11, 2025 10:08

test(qdoc): initial tests for latest code changes flow

d142bd3

update tstData to test

62d6bff

update scripts + move test data to subfolder for update readme tests

43b4617

update instructions in update readme with specific changes test

a004a28

update base readme for testing the update readme flow

53ceb04

update test assertions for q doc update flow tests

22809cc

separate out test cases into individual tests

c00d3cd

remove gradle settings file for q doc update flow test repo

525d784

log result from scripts for debugging

fa120b2

manually restore readme after each test run

f1fa2c8

add end of assertions println for debugging + update readme

c4a34f5

update q tests config for debugging

e6b30c0

gandhi-21 force-pushed the doc branch from 7d45593 to e6b30c0 Compare March 11, 2025 14:08

gandhi-21 changed the title ~~test(qdoc): Add tests for qdoc update readme flow~~ test(qdoc): Add ui tests for qdoc update readme flow Mar 11, 2025

Gaurav Gandhi added 3 commits March 11, 2025 11:37

update config and rename dummy repo files for create readme tests

b730f6d

update build file for create readme tests sample repo

deb3d94

update to print the result on failures only

7264ff0

juanbenj approved these changes Mar 11, 2025

View reviewed changes

manodnyab reviewed Mar 11, 2025

View reviewed changes

...brains/uitests/docTests/updateReadmeTests/UpdateReadmeSpecificChanges/MakeChangesFlowTest.kt Show resolved Hide resolved

ui-tests-starter/tstData/qdoc/updateFlow/dockerfile Outdated Show resolved Hide resolved

Gaurav Gandhi and others added 2 commits March 12, 2025 13:37

remove unused file from test dummy repo

de4afb2

Merge branch 'aws:main' into doc

93ede19

gandhi-21 enabled auto-merge (squash) March 12, 2025 19:17

Gaurav Gandhi and others added 2 commits March 13, 2025 13:33

fix detekt issues

50923b7

Merge branch 'main' into doc

1d1b5a2

Gaurav Gandhi added 5 commits March 13, 2025 14:07

fix detekt issues for package declaration

0ca4932

move tests cases into single test class for update readme tests

7f9f881

move envSetup to BeforeAll and testDataSetup to BeforeEach

e99c056

fix detekt issues

cc99a6c

fix detekt issues

e828a95

manodnyab reviewed Mar 13, 2025

View reviewed changes

manodnyab approved these changes Mar 14, 2025

View reviewed changes

Merge branch 'main' into doc

28a1045

gandhi-21 merged commit 36e6a34 into aws:main Mar 14, 2025
13 of 18 checks passed

gandhi-21 pushed a commit to gandhi-21/aws-toolkit-jetbrains that referenced this pull request Mar 17, 2025

move findAndClickButton to common ScriptUtils & update script syntax …

b3a33a5

…to JS (followups from aws#5435)

gandhi-21 pushed a commit to gandhi-21/aws-toolkit-jetbrains that referenced this pull request Mar 17, 2025

move findAndClickButton to common ScriptUtils & update script syntax …

ef214cf

…to JS (followups from aws#5435)

gandhi-21 mentioned this pull request Mar 17, 2025

test(qdoc): Add ui tests for qdoc create readme flow #5479

Merged

6 tasks

gandhi-21 pushed a commit to gandhi-21/aws-toolkit-jetbrains that referenced this pull request Mar 21, 2025

move findAndClickButton to common ScriptUtils & update script syntax …

94c24ab

…to JS (followups from aws#5435)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

test(qdoc): Add ui tests for qdoc update readme flow #5435

test(qdoc): Add ui tests for qdoc update readme flow #5435

Uh oh!

gandhi-21 commented Mar 4, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gandhi-21 commented Mar 13, 2025

Uh oh!

manodnyab Mar 13, 2025

Uh oh!

gandhi-21 Mar 14, 2025

Uh oh!

manodnyab Mar 13, 2025

Uh oh!

gandhi-21 Mar 14, 2025

Uh oh!

Uh oh!

Uh oh!

gandhi-21 commented Mar 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

test(qdoc): Add ui tests for qdoc update readme flow #5435

test(qdoc): Add ui tests for qdoc update readme flow #5435

Uh oh!

Conversation

gandhi-21 commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Types of changes

Description

Checklist

License

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gandhi-21 commented Mar 13, 2025

Uh oh!

manodnyab Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

gandhi-21 Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

manodnyab Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

gandhi-21 Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gandhi-21 commented Mar 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

gandhi-21 commented Mar 4, 2025 •

edited

Loading