booster icon indicating copy to clipboard operation
booster copied to clipboard

Improve documentation on how to test Booster apps

Open BorjaZarco opened this issue 2 years ago • 5 comments

Documentation bugs and improvements

Some work is necessary to improve the documentation and make the testing experience on Booster better

Description

Some of the issues found when trying to test a Booster application were:

  1. It is required to install the following libraries: sion, sion-chai, chai, chai-promised and their respective @types dependencies. Perhaps they could be already installed with the boost:new project command (or using a new specific command to setup testing)
  2. The tests folder should be moved to the tsconfig.json. There is an issue here. Apparently, ./src is set to be the rootDir. This forces the test folder to be inside it in order to be transpiled
  3. One example on the docs is deprecated. The following code:
const register = new Register('request-id-1') 

Does not work because the Register constructor requires two arguments. It is not clear what the second argument is.

BorjaZarco avatar Jan 31 '23 11:01 BorjaZarco

This is a Discord conversation related to this issue where many users discuss about the right way to configure Jest to work in Booster apps: https://discord.com/channels/763753198388510780/1044231044251013190

javiertoledo avatar Feb 23 '23 13:02 javiertoledo

@BorjaZarco Hi - is this still open?

Will-Marriott avatar Jun 19 '24 15:06 Will-Marriott

Yes @Will-Marriott, it's open, are you considering working on it?

javiertoledo avatar Jun 19 '24 20:06 javiertoledo

Yes @Will-Marriott, it's open, are you considering working on it?

Yes I'd like to work on it :)

Will-Marriott avatar Jun 20 '24 14:06 Will-Marriott

Awesome, thanks! I'll assign the issue to you :-)

javiertoledo avatar Jun 21 '24 20:06 javiertoledo