Add examples to testing framework docs

[MrDSGC]

Issue to be solved

Cadence Testing Framework documentation could use some examples to help users test on Flow

https://discord.com/channels/613813861610684416/1055155961196728380/1055155961196728380

Suggested Solution

Add examples to Cadence Testing Framework

[j1010001]

can we get some help from core-contract team here @franklywatson ?

[franklywatson]

Been chatting to the SCE team and we still feel that it's some ways away from widespread use. @satyamakgec made a valiant effort to code as much of the testing in Offers using the framework over the past weeks. The TL;DR still remains, it's not there yet. Until then it doesn't make sense to cut examples (though the above repo already give us the base material for when it's needed)

1. Allow defining types or contracts locally in the test file itself - my understanding is that this is one of the more frustrating things
2. Contracts, scripts and transactions as first-class citizens in testing framework Somewhat duplicates the item above but looking at different aspects
3. Provide detailed information about the error during smart contract execution in test This is required to cover negative test cases of the contract so that all code branches get coverage
4. No GH issue - right now it is impossible to return & consume a variable return type from the scripts within the testing framework, but there should be something so that these can be properly tested

[SupunS]

No GH issue - right now it is impossible to return & consume a variable return type from the scripts within the testing framework, but there should be something so that these can be properly tested

I guess this is onflow/cadence-tools#33. Should be already fixed in the latest CLI.

[m-Peter]

As part of an ongoing grant proposal, regarding code coverage, I have setup this repository which I intend to use for the adoption milestone, and as a learning resource for the Cadence testing framework.
I would like to undertake this issue, if you also agree, and enrich the following doc. I have a lot of examples, scattered in gists. cc @SupunS @turbolent

[m-Peter]

@j1010001 I think this issue can be closed. I have added relevant documentation in the onflow/docs repository:

• Document the new features of the Cadence testing framework docs#208
• Update Testing Framework docs for current version of Cadence docs#213

[SupunS]

Sounds good!

Closing this issue since examples have been added to the docs as mentioned above. Please feel free to re-open or open a new issue if you feel there are more areas we can improve on the docs.