balena-io-experimental
Add testing
I think we could do simple jsdoc on the API routes and generate a swagger file out of that? It seems like a bit of an investment but could be worthwhile in the long run if we are adding a lot of routes
I think we could do simple jsdoc on the API routes and generate a swagger file out of that? It seems like a bit of an investment but could be worthwhile in the long run if we are adding a lot of routes
Not familiar with any of those things, whatever you think is best. It was more a getting down ideas on the project board more than thinking they would all be necessary, or thinking about what would be priority.
The tests for routes would probably be more helpful for people. Even if it was just an example of a test of a route, as it is something people should be building with the UI's as they go. I haven't got any experience with ExpressJS tests though.
Yep! auto generated API docs taken directly from express routes would be the best way to go about this I think. I will test out latest tools to see how convenient could be (remembering to swagger hell some years ago now)
Now that you mention it, we might want some tape/tap tests for the API routes as well. This could also be automated through postman. But this general genre of work is worth discussing in this ticket for sure!
There are plans to change the backend which will change the way the testing will work. It is on the project board for when that step is done so going to close this and track it on the project board instead.