Update NeoTestRunner usage in the documentation

[meevee98]

No description provided.

[lllwvlvwlll]

Task linked: CU-8678c423x Update NeoTestRunner documentation on Neo3Boa

[ixje]

Suggested change

	function you'll need a NeoTestRunner object, which requires the path of your Neo-Express network configuration file to
	the NeoTestRunner object to set up the test environment.
	function you'll need a NeoTestRunner object, which takes the path of your Neo-Express network configuration file as an argument to set up the test environment.

[ixje]

I kind of feel we could give just enough information that they don't have to first starting reading another link. Something like

"If you do not yet have a local network, open a terminal and type neoxp create. Please refer to the Neo-Express documentation for more details on how to configure your local network."

From here they can choose to fine tune their network or just go ahead

[ixje]

Suggested change

	You'll to call the method `call_contract()`. Its parameters are the path of the compiled smart contract, the smart
	You'll have to call the method `call_contract()` to interact with your smart contract. Its parameters are the path of the compiled smart contract, the smart

[ixje]

This apparently can return an error message. If it does, then inspecting invoke.result is going to be really confusing. For example, I was calling a wrong function (=wrong name, didn't exist). What invoke.result shows is

I wanted to add the comment that we should promote error check prior to asserting the results. However, that is going to be somewhat hard because the return type is something like Union[str, list[NeoInvokeResult]] where str is an exception message. So that means one has to do something like

result = runner.execute()
if isinstance(result, str):
   raise Exception(result)
assert invoke.result is None

What I personally think would have been prettier is

success, err_msg = runner.execute()
if not success:
   raise Exception(err_msg)
assert invoke.result is None

Alternatively (and maybe even better) is that runner.execute() throws an exception if it fails. Under the assumption that we eventually move to a unittest like class you could then do scenarios like

with self.assertRaises(ValueError) as context:
   runner.execute()
self.assertIn("method not found", str(context.exception))

and maybe even nicely handle in contract asserts (if this PR ever gets accepted)

[meevee98]

On Boa3 tests, we always check if the VMState on the runner is the expected (HALT if the execution is expected to succeed, FAULT if it's expected to fail).
For now, we could recommend this on the documentation as well.

[coveralls]

coverage: 91.611% (-0.3%) from 91.88% when pulling de0f254 on CU-8678c423x into d7d8e9f on development.