The Testening: Ports improved unit tests from TG, New mapping tests, Refactors of existing tests to improve code quality

[PowerfulBacon]

About The Pull Request

Ports the following PRs in whole, or in part (There's a lot, I apologise if I missed any PRs but I included the authors as commit co-authors where I could find them):

• Screenshot tests tgstation/tgstation#67679
• Improve naming in new GitHub actions tgstation/tgstation#54821
• Juke Build 0.8.1 tgstation/tgstation#60404
• Juke Build 0.8.1 Hotfix 1 tgstation/tgstation#60897
• Improve Yarn caching in CI suite tgstation/tgstation#60962
• Juke Build 0.9.0 tgstation/tgstation#61005
• Makes integration test results be in color and have annotations tgstation/tgstation#66649
• Add lint to validate tgstation.dme is in the proper order tgstation/tgstation#66831
• Test all maps in parallel integration tests tgstation/tgstation#66864
• Upgrade actions/cache to v3 tgstation/tgstation#67486
• Screenshot tests tgstation/tgstation#67679
• Cancels the 4 initial CI tests if another commit is pushed to the same PR tgstation/tgstation#70490
• Update github actions versions in the github workflows tgstation/tgstation#70463
• Updates GH actions to use GITHUB_OUTPUT tgstation/tgstation#70633
• Add support for running tests on alternate versions tgstation/tgstation#71177
• Changes check_grep to use ripgrep and reformats/cleans up the check_grep file tgstation/tgstation#71324
• Caches Rust for Run Linters CI tgstation/tgstation#71487
• Remove cache purge key that has never worked and has meant that our cache has never worked tgstation/tgstation#71529
• Run CI, merge conflict checks, and 515 compat on "project branches" tgstation/tgstation#71601
• Replace nearly every map grep with a YML file that actually respects structure, and fixes the massive amount of failures that were never caught tgstation/tgstation#72372
• Maplint tool now has proper github action error messages tgstation/tgstation#72920
• Add merge_group to CI suite tgstation/tgstation#73369
• Add gh-readonly-queue to CI tgstation/tgstation#73381
• Change always() to success() || failure() in CI tgstation/tgstation#73396
• Only cancel concurrent CI in the same PR tgstation/tgstation#73398
• Nukes The 2.5-Minute Long Artifact Upload on Windows Build tgstation/tgstation#73474
• Fix maplint help messages tgstation/tgstation#73528
• [MDB Ignore] Manifest Destiny - The Final Tile Flattening tgstation/tgstation#74169
• Lints Against Unmanaged Local Defines tgstation/tgstation#74333
• Add test suite that just checks for if alternate tests pass so that we can require it instead of the specific tests tgstation/tgstation#74380
• Adds CI check to detect if byond starts requiring 515 clients before we want that tgstation/tgstation#74364
• Fixes coderbus item layering tgstation/tgstation#74481
• Client Compatibility Check Actually Uses Our Fork tgstation/tgstation#74514
• New Smart Fridge sprites tgstation/tgstation#75022 (Partial, obviously)
• [MDB IGNORE] Adds a map lint against using dir-var edited window panes tgstation/tgstation#75610
• [MDB IGNORE] Adds a map lint against using non-dir helper posters tgstation/tgstation#75620
• Admin Library Moderation (in-game edition) tgstation/tgstation#75645
• Ban overriding heat_capacity from maps tgstation/tgstation#75758
• Ensures that all Unit Tests are ticked in _unit_tests.dm tgstation/tgstation#76404
• Fixes up Ticked File Enforcement tgstation/tgstation#76592
• Ensures our linter and dreammaker agree on file extension ordering tgstation/tgstation#76947
• Removes stray obj/item Metastation tgstation/tgstation#77308
• Fixes Ticked File Enforcement and Missing Unit Test (and makes said Unit Test Compile) (and genericizes the C&D list to the base unit test datum) tgstation/tgstation#77632
• Replace DreamAnnotate action with a python script tgstation/tgstation#78225
• Split Run Linters step into multiple steps tgstation/tgstation#78265
• Fix some odd vscode highlighting errors in workflow files  tgstation/tgstation#78274
• [NO GBP] Fixes me actually breaking Run DreamChecker tgstation/tgstation#78291
• Caches Node and Python Bootstrap for GH Actions tgstation/tgstation#78307
• Fixes TFE being useless after #78265 tgstation/tgstation#78433
• Add mapping linter to check for duplicate machinery stacked on same tile tgstation/tgstation#79394
• Add CI mapping linter to check for duplicate windows on same tile tgstation/tgstation#79487
• Puts all traits in the globalvars file + CI Testing tgstation/tgstation#79642
• Icon Autoslicing tgstation/tgstation#79659
• Fixes Rust Caching for Run Linters tgstation/tgstation#80168
• Fix alternate tests erroring when there are no alternate versions tgstation/tgstation#80287
• Makes build tool use 515 -D argument instead of m.dme file tgstation/tgstation#80494
• Fix flaky wizard screenshot test failure, and try to make screenshot tests run more consistently tgstation/tgstation#80631
• [MDB IGNORE] Adds a map lint against using dir-var and icon-var edited windoors tgstation/tgstation#81272
• Bumps up several GitHub actions to the Node 20 Version tgstation/tgstation#81770
• Lint with OpenDream tgstation/tgstation#81892
• Improves OpenDream Linting (Annotations and More) tgstation/tgstation#82029
• Makes the DM too old to build message better. tgstation/tgstation#82110
• Adds three brain traumas (feat. returning to monkey)  tgstation/tgstation#82129
• Actually Caches The BYOND Installation in CI tgstation/tgstation#82364
• Makes the cutter lint actually work tgstation/tgstation#82913
• Fixes CI not checking warnings. tgstation/tgstation#83015
• Cancel CI on new commit tgstation/tgstation#83255
• [MDB IGNORE] Gives telescreens mapping directionals + adds a map lint for them tgstation/tgstation#84261
• [MDB IGNORE] Map lints the layer var and scrubs it off our maps tgstation/tgstation#84385
• [MDB IGNORE] Map lints the piping_layer var and scrubs it off our maps tgstation/tgstation#84686
• Build script detects sound changes properly. tgstation/tgstation#86113
• Allows people to skip the icon cutter on a DMTARGET, but properly this time tgstation/tgstation#86500

Ports the following files (Authors have been credited):
https://github.com/tgstation/tgstation/commits/master/code/controllers/subsystem/garbage.dm
https://github.com/tgstation/tgstation/commits/master/code/__DEFINES/qdel.dm
https://github.com/tgstation/tgstation/blob/776ecd60600c43d56be173a9f10505425d2c07bc/code/__DEFINES/_helpers.dm#L29
https://github.com/tgstation/tgstation/blob/776ecd60600c43d56be173a9f10505425d2c07bc/code/datums/datum.dm#L75
tgstation/tgstation@225562b

Ports the better unit testing system that TG has.

Makes improvements to the create and delete tests by adding in defines which can be used modularly.

Ports some improvements and fixes to QDEL from TGstation (excluding some content which is 515 exclusive)

Non-Goals

• Does not activate the create and destroy test. That can come in the future when I can be bothered to fix the mountain of hard-dels that we probably have.
• Does not add any screenshot tests, despite porting the framework.
• Does not add any auto-cut icons, despite porting the framework.

JukeBuild Updates

• Updates JukeBuild to the latest version.
• This adds icon cutter support, however it doesn't use either of them yet since that requires additional configuration to setup.
• On top of that, this implements support fot compiling on 514, as the latest jukebuild doesn't allow for 515 compilation.

Annotations

Any errors identified will be annotated inside of Github, click on a commit to see the errors being flagged.

Linter Expansion

Maplint

Maplint adds a simple way to check turfs for typepath based mapping related issues. This operates on the mapfile itself and isn't capable of more advanced logic, but it can catch simple things such as duplicate objects, or invalid var-edits. For more advanced map checks, I have added in a new category of unit tests; map tests.

The following tests will start disabled and will become enabled later:

• Require directional APCs (Too much work for this PR)
• Smart cable checker (We don't use smart cables)
• Require directional posters (Too much work for this PR)
• Require direction telescreens (Too much work for this PR)
• Require directional windows (Too much work for this PR)

OpenDream Linting

We now run the code against OpenDream, which will pick up some additional mistakes that Byond skips over.

Tab/Space Indentation

Ports the lint for tab vs space indentation. This lint was very flakey and was updated to allow spaces before a * symbol (as seen in block comments), however I still fixed all the issues that it brought up. A lot of these ended up being non-issues and resulted in a large number of diffs.

Test Expansion

Map Test Expansion

This adds a new abstract unit test type, map_test. This allows for you to do the following things:

• Check a turf against some custom criteria
• Check an area against some criteria
• Compile specific targets to check
• Check those specific targets
• Check a z-level for validity
• Check a map for validity

This offers quite a lot of extensibility and can do things that maplint is incapable of, such as determining if something is valid relative to the surrounding tiles. It is currently used for the following things:

• Validating area power requirements
• Ensuring no duplicate items on a turf (Fully comprehensive unlike the maplint variant, but can't handle decals)
• Ensuring that disposals are valid and the sorting tubes are placed correctly
• Ensuring that lights and cameras are attached to a wall correctly
• Ensuring that no active turfs exist at roundstart

CreateAndDestroy Code Cleanup

Modularises the create and destoy code, instead of using a global list for the exclude variables a define has been added which excludes a type, or its subtypes. This has been applied to everything that requires multiple parameters in Initialize, under the assumption that if you need to pass something in, then it isn't something you can just new() safely. This is partly why this PR is so huge.

ScreenShot Tests

Adds support for screenshot tests, as seen on TG. This PR doesn't implement any screenshot tests however. We could likely use this framework to have automatic generation of rooms for PRs that resprite items.

Why It's Good For The Game

We can now run tests against maps, which is incredibly useful because maps often get errors. As a side effect, the mapping checks are strict but making them testable prevents avoidable errors, even if it is a bit annoying to update initially.

Testing Photographs and Procedure

Everything I am changing here has unit tests and are mistakes already, making this PR a little bit easier to go through.

Testing the tests

See the output at the bottom of this PR.

Testing random maints changes

Other

Changelog

🆑 PowerfulBacon, BriggsIDP, san7890, LemonInTheDark, MrStonedOne, Mothblocks, Cyberboss, Tastyfish, ZephyrTFA, Andrew, tattle, Jolly, die_amond, Tim, optimumtact, Y0SH1M4S73R, StyleMistake, other /TG/station contributors
fix: Adds in some map checker unit tests, which check disposal networks for correct sorting.
fix: Random maints will clean up directional wall items after spawning them if they were unable to be placed on a wall.
server: Improves unit testing
tweak: Changed disposal pipe sorting logic slightly. Entering a sorting pipe backwards will continue backwards, entering a pipe from the sort direction will send you forwards. Entering from the correct direction will continue to sort.
add: Adds a new disposal pipe for filtering unsorted items that need sorting.
fix: Packages will now always arrive in their destination, no matter where on the network they are entered.
tweak: Fridges are no longer placed in walls
tweak: All areas must have APCs, unless they are unpowered.
/:cl:

[PowerfulBacon]

I have no idea why this is seg-faulting

[Crossedfall]

Some relatively small things. The python scripts aren't the best in terms of formatting and readability, but if they work I wont spend a lot of time trying to fix it (minus the two I started on)

[Crossedfall]

I think this may be a worse alternative to our current caching.. But it's a bit hard to tell without the checking being actively ran. This should be reviewed after this PR has been merged and checks have been running for a little while.