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

proposal: testing: add unit-tests #94

Open
muktihari opened this issue Apr 25, 2024 · 0 comments
Open

proposal: testing: add unit-tests #94

muktihari opened this issue Apr 25, 2024 · 0 comments
Labels
proposal New feature or Idea proposal that's still in discussions

Comments

@muktihari
Copy link
Member

Background

In our early development of the MVP, we had limited context on how to structure our code to accommodate implementation details of FIT, GPX, and TCX. As a result, we went through many trials and errors. Introducing unit tests early on would have slowed down our ability to freely restructure the code.

However, to ensure the correctness of the program, we need to have proper unit tests to have more confidence in delivering high-quality code. Now that we have more confidence in our current code structure, introducing unit tests would be a good option to start. This proposal would serve as guidance on how the unit tests would be delivered, even though we still have no concrete timeline on how to fully deliver it.

The unit-tests will be divided into two parts:

  1. The WebAssembly part (Golang)
  2. The Frontend part (Vue-Typescript)

To start, for each part, covering all the happy path scenarios would be sufficient. Later, we can aim for at least 80% code coverage. Given that the core engine is written in Go WebAssembly, it's preferable to prioritize the WebAssembly part first.. However, we welcome anyone who wants to contribute by adding unit-tests either for the WebAssembly part or Frontend part.

Technical Difficulties:

  1. Some code might be written in a way that makes it impossible to test, so some refactoring might be needed.
@muktihari muktihari added the proposal New feature or Idea proposal that's still in discussions label Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal New feature or Idea proposal that's still in discussions
Projects
None yet
Development

No branches or pull requests

1 participant