Use 'sinon' for fake timers in tests - Githubissues

EYBlockchain / nightfall_3

a mono-repo containing an optimistic version of nightfall

Creative Commons Zero v1.0 Universal

260 stars 57 forks source link

Use 'sinon' for fake timers in tests #1439

Open fullkomnun opened 1 year ago

fullkomnun commented 1 year ago

What does this implement/fix? Explain your changes.

periodic-payment-test is currently the e2e tests that has the longest runtime (~ 1h)
Most time is spent waiting for 'node-cron', however instead this test can use 'sinon' for faking timers for granular control over timers for testing all kinds of use-cases and avoiding tests relaying on waiting which can lead to flacky test and/or excessive waiting

Does this close any currently open issues?

Nope

What commands can I run to test the change?

Run 'periodic-payment-test' locally and/or in ci:

NF_SERVICES_TO_START=blockchain,client,deployer,mongodb,optimist,rabbitmq,worker ./bin/setup-nightfall
NF_SERVICES_TO_START=blockchain,client,deployer,mongodb,optimist,rabbitmq,worker CONFIRMATIONS=1 WHITELISTING=disable ./bin/start-nightfall -g -d [in another terminal]
docker wait nightfall_3_deployer_1 (wait for deployer to finish)
CONFIRMATIONS=1 npm run test-periodic-payment

Any other comments?

These changes decrease total runtime of 'periodic-payment-test' from '1h 0m 40s' to '30m 50s' - a 50% decrease in runtime!
Can perhaps use @sinonjs/fake-timers directly instead