clients/js: add unit tests on worm CLI

[AlberErre]

Resolves #2596

This PR adds unit tests for cmds commands on worm CLI 🔒🚓 located on client/ts/__tests__

In order to run them, you need to navigate to client/js folder and run:

npm run test

Also, a jest.config.json file has been added to configure jest testing environment.

---

🚨 Note: In order to test a command module, it needs to export all the module properties, following this documentation.

There are some missing tests modules on this PR, such as evm, aptos, generate. These modules need refactor to be able to test them, as they don't expose all the required interfaces, in particular exports.handler.

This refactor should be implemented in the future, as it's beyond the scope of this PR.

✅ Update:

All the worm commands are now covered with a test suite, checking all commands with their expected positional arguments, as well as checking if these commands are in sync with the auto-generated documentation (README.md).
In order to achieve this, we compare the worm CLI output expected by worm <command>--help pattern 👍🏻

Also, I've added functionality tests (to cover all cases dynamically) for the following commands:

• worm parse
• worm recover
• worm info chain-id
• worm info rpc
• worm info contract

Once all these tests are executed, a HTML report is auto-generated to evaluate them if necessary 📝. This report is generated for every npm run test execution and is stored on client/js/html-report/worm-cli-tests-report.html.

Finally, a Github Actions (.github/workflows/worm-cli.yml) has been created to integrate all these tests & build process into wormhole pipelines 🚀

Here is a recent Github Action pipeline I run successfully on my fork ✅:
https://github.com/AlberErre/wormhole/actions/runs/5337687871

[AlberErre]

@heyitaki @kcsongor @aadam-10 @evan-gray could you take a look at this? 👀

feedback and suggestions are more than welcome! 🙏🏼 🚀

[aadam-10]

hi @AlberErre, we're currently dealing with other priority items but we'll definitely take a look at this soon.

[heyitaki]

What's the point of generating an HTML report? Is there an advantage to running tests and viewing results in the CLI? Would rather keep dependency list as slim as possible!

[AlberErre]

This is useful while tests are failing in the pipeline 🚨

By using this HTML report we can see which tests are failing (and why) more easily 🏄‍♂️. The current alternative is scrolling through CLI (Jest) error output, which is harder to read and reason about.

Regarding slimming our dependency list, this package is included in devDependencies 👀 . Therefore this dependency won't be included in the Worm CLI build/main.js executable output, and won't increase bundle size.

This dependency would only live during the lifespan of the Github Action, similar to what Jest dependency does.

[heyitaki]

Hmm CLI output is usually enough for me, but I'm fine with it if others are I guess 🤷

[AlberErre]

@heyitaki just removed the HTML report generation on the next PR 👍 #3229

[AlberErre]

@evan-gray could you take a look at this MR? 🙏 The changes you requested have been applied ✅

[AlberErre]

An extension of this PR (covering worm submit command) has been created here: #3229

[evan-gray]

Closing this as some of these tests do not appear to be sufficiently meaningful or are already covered by other tests of the CLI. For example, the README.md is more efficiently covered by the check added in #3058