Testing Framework

[SirEndii]

Greetings,

I'm currently trying to make game tests for AP. After learning how the whole semi-well documented game test stuff works, I tried to check the CC repository how CC tests their computers in game.

The things that immediately flew into my eyes were the api and core package in the testMod/java folder along with the TestAPI.java file
But these files aren't included in the CC maven artifact for obvious reasons. Shall I just copy these files over to my project, or is there a better way recommended?

And if I do that, is there anything I should keep in mind when I make my lua test scripts for my computers? Or even better, is there any documentation about creating tests for lua cc scripts that I couldn't find?

[SquidDev]

Shall I just copy these files over to my project,

Yep! Everything should be licensed under the MPL 2.0, so you don't need to worry about CCPL restrictions.

And if I do that, is there anything I should keep in mind when I make my lua test scripts for my computers? Or even better, is there any documentation about creating tests for lua cc scripts that I couldn't find?

There's some notes in ARCHITECTURE.md about the game test code, and I've tried to document most classes, but it's definitely not comprehensive.

Some vague notes which hopefully help a little:

• Every computer is labelled with the test name (example). This then allows test to find and interact with the appropriate computer.
• Most tests don't actually use Lua at all. Instead, we inject a custom ILuaMachine to allow running Kotlin code (example). This makes tests much easier to write, as all the test code is in one place.
• The computers which are running Lua code have id 0 (and so share a mount). That computer's startup file then finds the actual test code to run based on the label (and thus test name). Once the test has finished, it then uses TestAPI to mark the test as passing/failing, which is then picked up by the Java-side test.

[SirEndii]

Urgh
But thank you!
I will see how I can use this in a non kts environment

[SirEdvin]

Probably the most important reason why all my build scripts become kts :)

[SirEndii]

I first wanted to port our build scripts to kts
but I stopped right away

But the game tests now work. I just need to write the actual tests now

[SirEndii]

I have one more question @SquidDev
How do you save your test structures? I am using the structure blocks, but it saves the structure as .nbt file, not .snbt while it seems that the cc structures are saved as snbt.
When I try to run my test, the game wants to read a snbt file. C:\Users\info\IdeaProjects\AdvancedPeripherals\src\testMod\resources\data\advancedperipheralstest\structures\peripheral_test.environment.snbt. The path is 100% correctly, except for the snbt file ending

I know that there are some ways using MC utilities, but I hope for something simpler

[SquidDev]

Initial disclaimer: I'm not actually sure what the Recommended workflow is — this bit of the gametest code predates Fabric/Forge support for gametests.

What CC:T does is set up an additional folder where game tests are loaded from.

CC-Tweaked/projects/common/src/testMod/kotlin/dan200/computercraft/gametest/core/TestHooks.kt

Line 39 in de930c8

StructureUtils.testStructuresDir = sourceDir.resolve("structures").toString()

This allows you to use the /test export command, which saves the test structure as snbt instead.