Enrich test framework interface

[m-Peter]

Work towards: onflow/developer-grants#148
Companion PRs:

• Retrieve Blockchain events cadence-tools#113
• Retrieve Blockchain logs cadence-tools#114
• Expose service account to the testing framework cadence-tools#122

Description

Adds 5 new methods to the TestFramework interface, and their native implementations.

import Test

pub let blockchain = Test.newEmulatorBlockchain()

// Retrieve all events from the blockchain
pub let events = blockchain.events()

// Retrieve events from the blockchain, filtered by type
let type: Type = CompositeType("A.01cf0e2f2f715450.FooContract.NumberAdded")!
pub let specificEvents = blockchain.eventsOfType(type)

// Retrieve the blockchain's service account. Can be used to sign transactions and send FLOW tokens to other test accounts
// among other things.
pub let serviceAccount = blockchain.serviceAccount()

// Retrieve all the log messages from the blockchain
blockchain.logs()

// Reset the state of the blockchain
blockchain.reset()

---

• Targeted PR against master branch
• Linked to Github issue with discussion and accepted design OR link to spec that describes this work
• Code follows the standards mentioned here
• Updated relevant documentation
• Re-reviewed Files changed in the Github PR explorer
• Added appropriate labels

[m-Peter]

I would like the team's input, on how to advance with this blocker: https://github.com/onflow/cadence/pull/2505/files#diff-48d2de22767ded1c341778e03aee3e1d3e1006ceeae566f4b0a3a7704c60758dR642-R646. Is there any workaround?

[codecov]

Codecov Report

Merging #2505 (6b47d46) into master (b24a708) will decrease coverage by 0.03%.
The diff coverage is 39.02%.

❗ Current head 6b47d46 differs from pull request most recent head acc49f3. Consider uploading reports for the commit acc49f3 to get more accurate results

@@            Coverage Diff             @@
##           master    #2505      +/-   ##
==========================================
- Coverage   78.36%   78.33%   -0.03%     
==========================================
  Files         336      327       -9     
  Lines       77123    73393    -3730     
==========================================
- Hits        60436    57492    -2944     
+ Misses      14429    13795     -634     
+ Partials     2258     2106     -152     

Flag	Coverage Δ
unittests	78.33% <39.02%> (-0.03%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
runtime/stdlib/test_emulatorbackend.go	32.12% <39.02%> (+2.44%)	⬆️

... and 65 files with indirect coverage changes

[SupunS]

Can you add some tests for the new functions where possible (e.g. serviceAccount())?
Please ignore, just realized we need the blockchain for that. So the test has to be on the tools repo 👍

[turbolent]

Looks good! Would it be possible to add some test cases to cover the added code?

[m-Peter]

@turbolent I am not sure how would that be possible here, since we do not have a Blockchain implementation. All these methods are defined on the Blockchain struct:

pub let events = blockchain.events()
pub let specificEvents = blockchain.eventsOfType(type)
pub let serviceAccount = blockchain.serviceAccount()
blockchain.logs()
blockchain.reset()

That's why most of the tests are located in the cadence-tools/test repository.

[m-Peter]

For example: https://github.com/onflow/cadence-tools/blob/master/test/test_framework_test.go#L684-L700, test case for the blockchain.createAccount() method.

[turbolent]

@m-Peter I see. Maybe we can add a mock/test implementation in a follow-up PR? It would be good to not have to rely on some downstream dependencies being the own tests (i.e. performing integration tests), and also have some unit tests up here. Doesn't block this PR, just some general thoughts

[m-Peter]

@turbolent You are completely right, I think it will surely increase the developer's confidence for the added code. I will follow up with PR to tackle this 🙏

[SupunS]

LGTM! left a suggestion for an improvement, which can be a follow-up PR.

[turbolent]

Nice!