Skip to content
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.

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

Add automated tests to the VSCode extension #5442

Closed
calebkiage opened this issue Sep 19, 2024 · 4 comments · Fixed by #5540
Closed

Add automated tests to the VSCode extension #5442

calebkiage opened this issue Sep 19, 2024 · 4 comments · Fixed by #5540
Assignees
Labels
type:infrastructure Core back-end work which includes quality work, code refactor, tests etc vscode-extension Work related to the vscode-extension

Comments

@calebkiage
Copy link
Contributor

Problem

The Visual Studio extension currently lacks automated tests, which is risky in the following ways:

  • Manual Testing: All changes need to be manually verified, which is time-consuming and prone to human error.
  • Risk of Regressions: Without automated tests, it's easy to miss regressions when refactoring, fixing bugs or adding features.
  • Missed Scenarios: Manual testing makes it difficult to cover all possible scenarios, increasing the risk of undetected bugs.

Proposal

I propose adding automated tests for the extension to improve its reliability and maintainability. This will reduce the need for manual testing and help ensure new changes don’t introduce regressions.

To start, we could follow the official Visual Studio Code testing documentation, which outlines how to set up and run tests for extensions.

Benefits

  • Improved Reliability: Automated tests will help catch issues early and ensure consistent behavior.
  • Easier Maintenance: Tests will reduce the effort needed for manual verification, speeding up the development process.
  • Better Coverage: We can write tests to cover a broader range of scenarios, improving overall confidence in the extension.

Next Steps

  1. Set up a basic test framework following the Visual Studio Code extension testing guide.
  2. Add unit tests for critical parts of the extension.
  3. Expand coverage over time to include integration tests and more complex scenarios.

Feedback

I’d love to hear the team's thoughts on this proposal and any suggestions for specific areas we should focus on for testing first. Feel free to share any relevant experiences or resources that could help improve this plan.

@calebkiage calebkiage added the status:waiting-for-triage An issue that is yet to be reviewed or assigned label Sep 19, 2024
@github-project-automation github-project-automation bot moved this to Needs Triage 🔍 in Kiota Sep 19, 2024
@sebastienlevert sebastienlevert moved this from Needs Triage 🔍 to Todo 📃 in Kiota Sep 23, 2024
@fey101 fey101 added type:infrastructure Core back-end work which includes quality work, code refactor, tests etc and removed status:waiting-for-triage An issue that is yet to be reviewed or assigned labels Sep 23, 2024
@thewahome thewahome added the vscode-extension Work related to the vscode-extension label Sep 24, 2024
@fey101 fey101 moved this from Todo 📃 to In Progress 🚧 in Kiota Sep 24, 2024
@fey101 fey101 self-assigned this Sep 24, 2024
@maisarissi
Copy link
Contributor

@thewahome @petrhollayms would you mind sharing what is still pending on this PR and whether there is any work still needed? Otherwise, we should ship it. Thanks

@thewahome
Copy link
Contributor

It was pending review of the work that @fey101 was doing which it got today. So right now it should be shipping 😀

@fey101
Copy link
Contributor

fey101 commented Nov 6, 2024

We would either need someone with project repo rights to override request for changes by @baywet since they have been succintly addressed and tested and Vincent is OOO, or wait for him to resume work for the PR to be merged.

@baywet
Copy link
Member

baywet commented Nov 11, 2024

@fey101 since #5540 was merged, should this issue now be closed?

@thewahome thewahome linked a pull request Nov 21, 2024 that will close this issue
@thewahome thewahome moved this from In Progress 🚧 to Done ✔️ in Kiota Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:infrastructure Core back-end work which includes quality work, code refactor, tests etc vscode-extension Work related to the vscode-extension
Projects
Status: Done ✔️
Development

Successfully merging a pull request may close this issue.

5 participants