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

Open
calebkiage opened this issue Sep 19, 2024 · 0 comments
Open

Add automated tests to the VSCode extension #5442

calebkiage opened this issue Sep 19, 2024 · 0 comments
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
@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 self-assigned this Sep 24, 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: In Progress 🚧
Development

No branches or pull requests

3 participants