feat(zombienet): Add javascript tests to zombienet testing

[edwardmack]

Changes

This PR introduces code that conducts javascript testing of gossamer nodes using Zombienet testing framework. The test files shows the following concepts:

• Test javascript code must contain export function called run that Zombienet calls as part of the test assertion: async function run(nodeName, networkInfo, args)
• The test script gets access to the testing node via polkadot.js/api by connecting as follows:

    const {wsUri, userDefinedTypes} = networkInfo.nodesByName[nodeName];
    const api = await zombie.connect(wsUri, userDefinedTypes);
  

• The test script can also get reference to keyring function as follows:

  const keyring = new zombie.Keyring({ type: "sr25519" });
  

• Arguments can be passed from test dsl file to test javascript by using the with keyword:

  alice: js-script ./scripts/transfer-tokens.js with "Alice,Bob" return is equal to 1 within 200 seconds
  

  The values are acquired in the javascript via the args parameter of the run function:

  const FROM = keyring.addFromUri("//" + args[0]);
  

• Variables can be used with in the testing dsl file using the format:
  • {% set varName = "value" %} to set values
  • {{ varName }} to read values

NOTE:

The test transfer contained in these tests fails because the gossamer nodes are not finalizing blocks and the test script checks to confirm transfers have been finalized. The test transfer will run, then timeout and fail. So, these tests should NOT be added to CI workflow until that has been fixed.

Tests

You can run make install-zombienet to download and install zombienet into your GOPATH.

 zombienet test -p native zombienet_tests/functional/0002-basic-network.zndsl 

Issues

Primary Reviewer

@timwu20

[codecov]

Codecov Report

Merging #3200 (f9df7f2) into development (db0be3f) will decrease coverage by 0.30%.
The diff coverage is n/a.

Additional details and impacted files

@@               Coverage Diff               @@
##           development    #3200      +/-   ##
===============================================
- Coverage        51.82%   51.53%   -0.30%     
===============================================
  Files              225      225              
  Lines            28549    28549              
===============================================
- Hits             14795    14712      -83     
- Misses           12366    12455      +89     
+ Partials          1388     1382       -6     

[dimartiro]

I think we have to update the makefile too

[EclesioMeloJunior]

Some small comments, but LGTM!

[dimartiro]

I approve it with one question, should we update the makefile to add the new test?

[jimjbrettj]

nice work, lgtm!

[edwardmack]

I approve it with one question, should we update the makefile to add the new test?

I don't want to add this test to makefile or CI yet, since it is testing a balance transfer, and currently blocks are not being finalized, so the test fails.

[github-actions]

🎉 This PR is included in version 0.8.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀