feat(testlib): add enable/disable test debug utils

[LNSD]

Following Javascript's Jest idea of disabling a test by adding an 'x' before/after the test keyword (see Jest docs):

When you are maintaining a large codebase, you may sometimes find a test that is temporarily broken for some reason. If you want to skip running this test, but you don't want to delete this code, you can use test.skip to specify some tests to skip.

So in our case this is how to use the new test debug utils:

1. Import the ./testlib/testutils module in your test suite file
2. Add a 'x' either before or after the test case/suite keyword: xtest, xasyncTest, xsuite, xprocSuite, etc.
3. Run the test suite. The tests you marked with an ✖️ won't be executed.

IMPORTANT: Do not forget to re-enable the test cases disabled during your debugging session before committing your changes.

[jm-clius]

Yes, great feature, thanks! Shall we add this in a README.md somewhere? (And perhaps the coding guide?)

[LNSD]

Yes, great feature, thanks! Shall we add this in a README.md somewhere? (And perhaps the coding guide?)

Agree. We need to document it with all the test development good practices I have been gathering. I add it to my documentation TO-DO list. I'll try to tackle it next week 😁

[status-im-auto]

Jenkins Builds

❔	Commit	#️⃣	Finished (UTC)	Duration	Platform	Result
✔️	dd001d3	#1	2022-10-28 12:47:30	~17 min	linux	📦bin
❌	dd001d3	#1	2022-10-28 12:49:38	~19 min	macos	📄log

[alrevuelta]

Great! +1 to documenting it.

Fun fact I just learned that nim allows for comments inside comments, which C does't. Helpful for commenting the tests also.

#[


let x = 3
# comments
echo x
#[
long comment
]#


#[

Slightly related. Is someone looking into running specific tests or testsuites?

[LNSD]

Slightly related. Is someone looking into running specific tests or testsuites?

From our documentation: https://github.com/status-im/nwaku/blob/16c85db43ca492fb762e6acf61888e16812f883a/waku/v1/README.md#L51:~:text=You%20can%20also%20run%20a%20specific%20test%20(and%20alter%20compile%20options%20as%20you%20want)%3A`

You can also run a specific test (and alter compile options as you want):

[LNSD]

Merging this without waiting for checks to pass since the module is not imported, there is no risk.

[alrevuelta]

@LNSD #1302?

[jm-clius]

@alrevuelta 🤣 go ahead and merge #1302 by bypassing the checks.