spectool: Execute JSON test cases

[tomusdrw]

This PR attempts to implement the main_test function from spectool.

1. The majority of content of main.rs was moved to a new file generate.rs to avoid cluttering the main file.
2. test.rs module was created to implement JSON test vectors execution.

Some open issues:

1. While running a bunch of generated test vectors from here I've noticed that the interpreter may hang instead of going OOG.
2. I'm not sure if the way I'm handling the memory input is correct (see setup_memory function) - I didn't find a more generic API for this.

Example program that hangs: https://pvm-debugger.netlify.app/#/load?program=0x0000015101 (BRANCH_EQ_IMM).
Edit: Apologies, the program has an extremely large gas and has an edge case in parameters parsing. Our implementations were rejecting that, while polkavm correctly attempts to execute it.

[koute]

Thanks for the PR!

Hmm... I would want to at least wait for #238 to get in before merging this, although, that said, it might be better to not actually merge this here and instead finally start on w3f/jamtestvectors#7?

[tomusdrw]

I think waiting for #238 makes a lot of sense, that's the only context I'm interested in the runner actually.

Common test harness definitely makes sense, however I still think that JSON-based test case specification is and will be valuable. I imagine a following workflow (correct me if I'm missing something):

1. Detect some mismatching behaviour using a more complex fuzzing / multi-PVM test harness.
2. Prepare a JSON test case for this as an easily shareable "test case specification".
3. Use (already existing) PVM-A and PVM-B JSON test runner to debug the JSON test case.

Hence, being able to run that single JSON case on PolkaVM would be something that this PR enables. Contrasting this with running a presumably more complex test harness machinery just to debug a single test case.
However I might biased towards solutions that already exist and long term this might not be needed at all, since we will figure out better spec that could be used to reproduce the test.

[koute]

Common test harness definitely makes sense, however I still think that JSON-based test case specification is and will be valuable.

Well, isn't this orthogonal to having a test harness? (: The harness can still take the JSON test cases, just potentially run them on any PVM, not only on PolkaVM. In other words - I don't see why we should limit this to only PolkaVM - anyone interested should be able to use exactly the same code to load up the tests and run them on their PVM if they so desire. This wouldn't necessarily make it much more complex if we'd wrap the PolkaVM API in a trait (which can just have the same/very similar API to PolkaVM).

[tomusdrw]

Well, isn't this orthogonal to having a test harness?

Yes! :)

The harness can still take the JSON test cases, just potentially run them on any PVM, not only on PolkaVM.

That's what I meant with "presumably more complex test harness machinery" :) But I agree it doesn't necessarily have to be more complex.

My assumption is that most of the PVM implementers already have a setup to load JSON test cases for their PVM and my point is that it's currently missing for PolkaVM. As mentioned: I'm probably biased towards grabbing a low hanging fruit, since all other parts already exist, but if you prefer to rather focus on the test harness development I'll humbly follow too :) I'll add some discussion points to the harness issue to push the ball a bit.

[koute]

My assumption is that most of the PVM implementers already have a setup to load JSON test cases for their PVM and my point is that it's currently missing for PolkaVM.

Hm, I guess yeah, this is a good point. (:

But since PolkaVM itself is used to generate those test vectors having such a loader is not as useful as it is for other PVMs. Of course it's still useful to guard against regressions, but it's probably more sensible to just go all the way and start on the harness, since we do want to have a harness anyway, and we will want to integrate PolkaVM into the harness natively anyway for fast differential fuzzying.

[tomusdrw]

@koute let me know if/when you'd like me to get this updated to the latest master or rather closed in favour of w3f/jamtestvectors#7
In case you missed my response in the other thread, I've put together https://github.com/FluffyLabs/pvm-test-harness and I'm also curious if you think it's a step in the right direction.

[koute]

In case you missed my response in the other thread, I've put together https://github.com/FluffyLabs/pvm-test-harness and I'm also curious if you think it's a step in the right direction.

Yes, I'm most likely going to contribute there.

Could you hook up your PVM in there too?

[tomusdrw]

@koute updated the repo with some instructions and added AssemblyScript PVM as an example:
https://github.com/FluffyLabs/pvm-test-harness

Let me know if you need any help running it (after fetching submodules make sure to download half of the internet by running npm ci && npm run build inside ananas directory).

Example run:

Running `target/debug/pvm-test-harness --pvm polkavm --pvm stdin=./ananas/bin/stdin.sh json ../jamtestvectors/pvm/programs/inst_add_32.json ../jamtestvectors/pvm/programs/inst_add_32_with_overflow.json ../jamtestvectors/pvm/programs/inst_add_32_with_truncation.json ../jamtestvectors/pvm/programs/inst_add_32_with_truncation_and_sign_extension.json ../jamtestvectors/pvm/programs/inst_add_64.json ../jamtestvectors/pvm/programs/inst_add_64_with_overflow.json ../jamtestvectors/pvm/programs/inst_add_imm_32.json ../jamtestvectors/pvm/programs/inst_add_imm_32_with_truncation.json ../jamtestvectors/pvm/programs/inst_add_imm_32_with_truncation_and_sign_extension.json ../jamtestvectors/pvm/programs/inst_add_imm_64.json`
inst_add_32 running on 2 pvms...
awaiting input
inst_add_32 ✅
inst_add_32_with_overflow running on 2 pvms...
inst_add_32_with_overflow ✅
inst_add_32_with_truncation running on 2 pvms...
inst_add_32_with_truncation ✅
inst_add_32_with_truncation_and_sign_extension running on 2 pvms...
inst_add_32_with_truncation_and_sign_extension ✅
inst_add_64 running on 2 pvms...
inst_add_64 ✅
inst_add_64_with_overflow running on 2 pvms...
inst_add_64_with_overflow ✅
inst_add_imm_32 running on 2 pvms...
inst_add_imm_32 ✅
inst_add_imm_32_with_truncation running on 2 pvms...
inst_add_imm_32_with_truncation ✅
inst_add_imm_32_with_truncation_and_sign_extension running on 2 pvms...
inst_add_imm_32_with_truncation_and_sign_extension ✅
inst_add_imm_64 running on 2 pvms...
inst_add_imm_64 ✅