Skip to content

Added test plan for TypeSpec extension #5552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 49 commits into
base: main
Choose a base branch
from
Open

Added test plan for TypeSpec extension #5552

wants to merge 49 commits into from

Conversation

xiaohua899
Copy link

@xiaohua899 xiaohua899 commented Jan 9, 2025 •
edited
Loading

fix #5444
Description

Added four test scenarios test plan to TypeSpec Extension:

  • create-typespec-project-test-plan.md
  • generate-from-typespec-test-plan.md
  • import-typespec-from-openapi3-test-plan.md
  • typespec-extension-basic-features-test-plan.md

@RodgeFu and @msyyc for notification.

@microsoft-github-policy-service microsoft-github-policy-service bot added the ide Issues for VS, VSCode, Monaco, etc. label Jan 9, 2025
@xiaohua899 xiaohua899 force-pushed the patch-1 branch 2 times, most recently from deb90af to f01671f Compare January 9, 2025 11:29
@xiaohua899
Create create-typespec-project-test-plan.md
92cb05d 
Create image

Add files via upload

Update create-typespec-project-test-plan.md

Create generate-client-code-from-typespec-test-plan.md

Add files via upload

Update generate-client-code-from-typespec-test-plan.md

Create generate-openapi3-from-typespec-test-plan.md

Add files via upload

Update generate-openapi3-from-typespec-test-plan.md

Update generate-openapi3-from-typespec-test-plan.md

Create generate-server-stub-from-typespec-test-plan.md

Add files via upload

Update generate-server-stub-from-typespec-test-plan.md

Add files via upload

Create import-typespec-from-openapi3-test-plan.md
@xiaohua899
Update create-typespec-project-test-plan.md
4b50312
@xiaohua899
Add files via upload
c5e3807
@xiaohua899
Update generate-openapi3-from-typespec-test-plan.md
43bc7bf 
Update generate-server-stub-from-typespec-test-plan.md

Update create-typespec-project-test-plan.md

Create typespec-extension-basic-features-test-plan.md

Add files via upload

Update typespec-extension-basic-features-test-plan.md

Update typespec-extension-basic-features-test-plan.md

Add files via upload

Update create-typespec-project-test-plan.md

Update generate-client-code-from-typespec-test-plan.md

Update generate-openapi3-from-typespec-test-plan.md

Add files via upload

Update generate-server-stub-from-typespec-test-plan.md

Update import-typespec-from-openapi3-test-plan.md

Update create-typespec-project-test-plan.md

Update generate-client-code-from-typespec-test-plan.md

Update generate-openapi3-from-typespec-test-plan.md

Add files via upload

Update generate-client-code-from-typespec-test-plan.md

Add files via upload

Update typespec-extension-basic-features-test-plan.md

Update typespec-extension-basic-features-test-plan.md

Update generate-client-code-from-typespec-test-plan.md

Update generate-openapi3-from-typespec-test-plan.md

Update create-typespec-project-test-plan.md

Add files via upload

Update generate-openapi3-from-typespec-test-plan.md
@xiaohua899
Copy link
Author

@microsoft-github-policy-service agree company="Microsoft"

@markcowl markcowl self-assigned this Jan 9, 2025
@RodgeFu RodgeFu self-assigned this Jan 11, 2025
@xiaohua899
Copy link
Author

xiaohua899 commented Feb 14, 2025 •
edited
Loading

@RodgeFu /@msyyc Regarding the trigger of Import TypeSpec from OpenAPI3, I changed it to three options in the test plan, please review.

@xiaohua899
Copy link
Author

@RodgeFu and @chunyu3 , Updated the test plan document based on #6032 . Please review.

@markcowl The PR has been updated according to your suggestion.

  1. Change to use "test case" instead of "test plan".
  2. Add a contributing.md.
  3. Remove anything Microsoft-specific.

CC: @msyyc

timotheeguerin
timotheeguerin reviewed Feb 20, 2025
View reviewed changes
.chronus/changes/add-testplan-for-typespec-2025-0-13-16-45-58.md Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Talking with the team

  1. this is still a lot of images which when I look at it provide very little value but add size to this repo, they just show basic vscode UI and folder structure which could just be very well be described with a few words and be easier to maintain
  2. manual test are still a nightmare to deal with and put a lof of extra work on us as well
  3. There is already quite a few prs in progress that are changing things

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually we are making some progress in the ui-automation and we may go to that approach directly. A quick question, does our CI machine have UI? or are we able to have some machine with UI in CI so that we will be able to run these UI test in CI? thanks.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't the ui run headless, windows is super slow in ci and Linux doesn't.
None of the other ui test we have have any issues

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where are these ui test? We would like to have a look into them

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is 2(3 if you include the azure repo)

  • packages/playground-website test:e2e script that runs playwright
  • packages/typespec-vscode itself that runs the basic browser smoke test

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cool, thx! @msyyc , could you help to double check these tests and see whether there is anything our ui-test can leverage? thanks.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy that.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/vitest-dev/vscode/tree/main/test-e2e vitest vscode extension also has a bunch of ui test, also running with playwright+ vitest

@markcowl markcowl assigned allenjzhang and unassigned markcowl Feb 21, 2025
@markcowl markcowl self-requested a review February 21, 2025 00:36
@xiaohua899 xiaohua899 requested a review from lirenhe as a code owner March 7, 2025 07:04
@xiaohua899
Copy link
Author

@RodgeFu and @chunyu3 , Updated the test plan document based on #6340 and #6295.
For new feature Show OpenAPI3 Documentation added documentation show-openapi3-documentation-test-case.md.
Please review.

CC: @msyyc

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 21, 2025 •
edited
Loading

All changed packages have been documented.

  • ✅ typespec-vscode
Show changes

typespec-vscode - internal ✏️

Added test plan for TypeSpec extension

@v-xuto
Copy link

v-xuto commented Apr 29, 2025

@RodgeFu and @chunyu3, We have added the new telemetry test scenario, please review.
If you have any questions, please let me know.

CC: @msyyc

@microsoft-github-policy-service microsoft-github-policy-service bot added the stale Mark a PR that hasn't been recently updated and will be closed. label Jun 12, 2025
@microsoft-github-policy-service Microsoft GitHub Policy Service
Copy link
Contributor

Hi @@xiaohua899. Your PR has had no update for 30 days and it is marked as a stale PR. If it is not updated within 30 days, the PR will automatically be closed. If you want to refresh the PR, please remove the stale label.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timotheeguerin timotheeguerin timotheeguerin left review comments

@RodgeFu RodgeFu RodgeFu left review comments

@msyyc msyyc msyyc left review comments

@bterlson bterlson Awaiting requested review from bterlson bterlson is a code owner

@allenjzhang allenjzhang Awaiting requested review from allenjzhang

@witemple-msft witemple-msft Awaiting requested review from witemple-msft

@chrisradek chrisradek Awaiting requested review from chrisradek chrisradek is a code owner

@AlitzelMendez AlitzelMendez Awaiting requested review from AlitzelMendez AlitzelMendez is a code owner

@markcowl markcowl Awaiting requested review from markcowl markcowl is a code owner

@lirenhe lirenhe Awaiting requested review from lirenhe lirenhe is a code owner

Requested changes must be addressed to merge this pull request.

Assignees

@RodgeFu RodgeFu

@allenjzhang allenjzhang

Labels
docs Improvements or additions to documentation ide Issues for VS, VSCode, Monaco, etc. stale Mark a PR that hasn't been recently updated and will be closed.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

create manual test script for vscode extension
7 participants
@xiaohua899 @RodgeFu @timotheeguerin @msyyc @markcowl @v-xuto @allenjzhang