Map Conformance Testing (#1157)

* Map Conformance Testing
minor unit test code hammering

* whoops

* Unit test priority

Author: francinum

_maps/theseus.json

@@ -14,5 +14,6 @@
 		"cook": {
 			"additional_cqc_areas": ["/area/station/service/bar", "/area/station/service/kitchen/coldroom", "/area/station/commons/lounge"]
 		}
-	}
+	},
+	"run_mapping_tests": true
 }

code/datums/map_config.dm

@@ -40,6 +40,9 @@
 	/// List of additional areas that count as a part of the library
 	var/library_areas = list()
 
+	/// Do we run mapping standards unit tests on this map?
+	var/run_mapping_tests = FALSE
+
 /**
  * Proc that simply loads the default map config, which should always be functional.
  */
@@ -207,6 +210,10 @@
 
 		holomap_offsets = temp
 
+	if("run_mapping_tests" in json)
+		//This should be true, but just in case...
+		run_mapping_tests = json["run_mapping_tests"]
+
 	defaulted = FALSE
 	return TRUE
 

code/modules/unit_tests/_unit_tests.dm code/modules/unit_tests/__unit_tests.dm

@@ -6,6 +6,9 @@
 /// For advanced cases, fail unconditionally but don't return (so a test can return multiple results)
 #define TEST_FAIL(reason) (Fail(reason || "No reason", __FILE__, __LINE__))
 
+/// Mark the test as skipped.
+#define TEST_SKIP(reason) (return Skip(reason || "No reason"))
+
 /// Asserts that a condition is true
 /// If the condition is not true, fails the test
 #define TEST_ASSERT(assertion, reason) if (!(assertion)) { return Fail("Assertion failed: [reason || "No reason"]", __FILE__, __LINE__) }
@@ -46,8 +49,12 @@
 #define UNIT_TEST_FAILED 1
 #define UNIT_TEST_SKIPPED 2
 
+/// Capture pre-unit test mapping error reports. Maybe one day we can take this out back and shoot it.
 #define TEST_PRE 0
-#define TEST_DEFAULT 1
+/// Ensures map standards. Runs before standard unit tests as for production maps, these are more important.
+#define TEST_MAP_STANDARDS 1
+/// Standard unit test priority
+#define TEST_DEFAULT 2
 /// After most test steps, used for tests that run long so shorter issues can be noticed faster
 #define TEST_LONGER 10
 /// This must be the last test to run due to the inherent nature of the test iterating every single tangible atom in the game
@@ -61,10 +68,16 @@
 #define TEST_OUTPUT_GREEN(text) "\x1B\x5B1;32m[text]\x1B\x5B0m"
 /// Change color to yellow on ANSI terminal output, if enabled with -DANSICOLORS.
 #define TEST_OUTPUT_YELLOW(text) "\x1B\x5B1;33m[text]\x1B\x5B0m"
+/// Change color to blue on ANSI terminal output, if enabled with -DANSICOLORS.
+#define TEST_OUTPUT_BLUE(text) "\x1B\x5B1;34m[text]\x1B\x5B0m"
+/// Change color to magenta on ANSI terminal output, if enabled with -DANSICOLORS.
+#define TEST_OUTPUT_MAGENTA(text) "\x1B\x5B1;35m[text]\x1B\x5B0m"
 #else
 #define TEST_OUTPUT_RED(text) (text)
 #define TEST_OUTPUT_GREEN(text) (text)
 #define TEST_OUTPUT_YELLOW(text) (text)
+#define TEST_OUTPUT_BLUE(text) (text)
+#define TEST_OUTPUT_MAGENTA(text) (text)
 #endif
 
 /// A trait source when adding traits through unit tests
@@ -73,6 +86,13 @@
 /// Helper to allocate a new object with the implied type (the type of the variable it's assigned to) in the corner of the test room
 #define ALLOCATE_BOTTOM_LEFT(arguments...) allocate(__IMPLIED_TYPE__, run_loc_floor_bottom_left, ##arguments)
 
+// Include unit test base definition
+#include "_unit_test.dm"
+
+// Category Includes
+#include "mapping_standards\__include.dm"
+
+// Single File Includes
 #include "achievements.dm"
 #include "anchored_mobs.dm"
 #include "anonymous_themes.dm"
@@ -184,7 +204,7 @@
 #include "tgui_create_message.dm"
 #include "timer_sanity.dm"
 #include "traitor.dm"
-#include "unit_test.dm"
+
 #include "wizard_loadout.dm"
 #include "wounds.dm"
 #ifdef REFERENCE_TRACKING_DEBUG //Don't try and parse this file if ref tracking isn't turned on. IE: don't parse ref tracking please mr linter

code/modules/unit_tests/unit_test.dm code/modules/unit_tests/_unit_test.dm

@@ -30,10 +30,12 @@ GLOBAL_LIST_EMPTY(unit_test_mapping_logs)
 	var/priority = TEST_DEFAULT
 	//internal shit
 	var/focus = FALSE
-	var/succeeded = TRUE
+	var/test_status = UNIT_TEST_PASSED
 	var/list/allocated
 	var/list/fail_reasons
 
+	var/skip_reason
+
 	var/static/datum/space_level/reservation
 
 /proc/cmp_unit_test_priority(datum/unit_test/a, datum/unit_test/b)
@@ -65,13 +67,18 @@ GLOBAL_LIST_EMPTY(unit_test_mapping_logs)
 	TEST_FAIL("Run() called parent or not implemented")
 
 /datum/unit_test/proc/Fail(reason = "No reason", file = "OUTDATED_TEST", line = 1)
-	succeeded = FALSE
+	test_status = UNIT_TEST_FAILED
 
 	if(!istext(reason))
 		reason = "FORMATTED: [reason != null ? reason : "NULL"]"
 
 	LAZYADD(fail_reasons, list(list(reason, file, line)))
 
+
+/datum/unit_test/proc/Skip(reason = "No reason")
+	test_status = UNIT_TEST_SKIPPED
+	skip_reason = reason
+
 /// Allocates an instance of the provided type, and places it somewhere in an available loc
 /// Instances allocated through this proc will be destroyed when the test is over
 /datum/unit_test/proc/allocate(type, ...)
@@ -118,10 +125,21 @@ GLOBAL_LIST_EMPTY(unit_test_mapping_logs)
 
 	duration = REALTIMEOFDAY - duration
 	GLOB.current_test = null
-	GLOB.failed_any_test |= !test.succeeded
+	GLOB.failed_any_test |= (test.test_status == UNIT_TEST_FAILED)
+
+	var/test_log_prefix
+	switch(test.test_status)
+		if(UNIT_TEST_FAILED)
+			test_log_prefix = TEST_OUTPUT_RED("FAIL")
+		if(UNIT_TEST_PASSED)
+			test_log_prefix = TEST_OUTPUT_GREEN("PASS")
+		if(UNIT_TEST_SKIPPED)
+			test_log_prefix = TEST_OUTPUT_BLUE("SKIPPED")
+		else //what
+			test_log_prefix = TEST_OUTPUT_MAGENTA("BAD STATUS [test.test_status]")
 
 	var/list/log_entry = list(
-		"[test.succeeded ? TEST_OUTPUT_GREEN("PASS") : TEST_OUTPUT_RED("FAIL")]: [test_path] [duration / 10]s",
+		"[test_log_prefix]: [test_path] [(test.test_status != UNIT_TEST_SKIPPED ? "[duration / 10]s" : "| [test.skip_reason]")]",
 	)
 	var/list/fail_reasons = test.fail_reasons
 	var/map_name = SSmapping.config.map_name
@@ -146,7 +164,9 @@ GLOBAL_LIST_EMPTY(unit_test_mapping_logs)
 	var/message = log_entry.Join("\n")
 	log_test(message)
 
-	test_results[test_path] = list("status" = test.succeeded ? UNIT_TEST_PASSED : UNIT_TEST_FAILED, "message" = message, "name" = test_path)
+
+
+	test_results[test_path] = list("status" = test.test_status, "message" = message, "name" = test_path)
 
 	qdel(test)
 
@@ -157,10 +177,15 @@ GLOBAL_LIST_EMPTY(unit_test_mapping_logs)
 
 	var/list/tests_to_run = subtypesof(/datum/unit_test)
 	var/list/focused_tests = list()
-	for (var/_test_to_run in tests_to_run)
-		var/datum/unit_test/test_to_run = _test_to_run
+
+	for (var/datum/unit_test/test_to_run as anything in tests_to_run)
+		// Handle VSCode Testing Integration Focus Tests
 		if (initial(test_to_run.focus))
 			focused_tests += test_to_run
+		// Remove abstract tests.
+		if (isabstract(test_to_run))
+			tests_to_run -= test_to_run
+
 	if(length(focused_tests))
 		tests_to_run = focused_tests
 

code/modules/unit_tests/atmos_moles_tests.dm

@@ -1,7 +1,7 @@
 #define ALL_GASIDS xgm_gas_data.gases
 
 /datum/unit_test/atmos_machinery
-	//template = /datum/unit_test/atmos_machinery
+	abstract_type = /datum/unit_test/atmos_machinery
 	var/list/test_cases = list()
 
 /datum/unit_test/atmos_machinery/Run()

code/modules/unit_tests/mapping_standards/__include.dm

@@ -0,0 +1,5 @@
+// Master Include file for Mapping Standards Conformance Tests
+
+#include "_mapping_standards.dm"
+
+#include "ladders_must_have_openspace.dm"

code/modules/unit_tests/mapping_standards/_mapping_standards.dm

@@ -0,0 +1,11 @@
+
+/datum/unit_test/mapping_standards
+	abstract_type = /datum/unit_test/mapping_standards
+
+/datum/unit_test/mapping_standards/Run()
+	SHOULD_CALL_PARENT(TRUE)
+	. = 0 && ..() //linter defeat
+	if(!SSmapping.config.run_mapping_tests)
+		Skip("Standards tests disabled by config")
+		return TRUE
+

code/modules/unit_tests/mapping_standards/ladders_must_have_openspace.dm

@@ -0,0 +1,12 @@
+
+// Ensure openspace between two linked ladders.
+// There's an edge case here bay solves with 'allowed_directions'
+// If you encounter it, well. Good luck and god help you -Francinum
+
+/datum/unit_test/mapping_standards/ladders_must_have_openspace
+
+/datum/unit_test/mapping_standards/ladders_must_have_openspace/Run()
+	if(..()) {return};
+	for(var/obj/structure/ladder/ladder as anything in INSTANCES_OF(/obj/structure/ladder))
+		if(ladder.down && (!isopenspaceturf(get_turf(ladder))))
+			TEST_FAIL("Ladder with down linkage is not on openspace turf, at: [AREACOORD(ladder)]")

daedalus.dme

@@ -4502,7 +4502,7 @@
 #include "code\modules\three_dsix\stats\psyche.dm"
 #include "code\modules\three_dsix\stats\soma.dm"
 #include "code\modules\tooltip\tooltip.dm"
-#include "code\modules\unit_tests\_unit_tests.dm"
+#include "code\modules\unit_tests\__unit_tests.dm"
 #include "code\modules\universal_states\resonance_jump.dm"
 #include "code\modules\universal_states\universal_state.dm"
 #include "code\modules\uplink\uplink_devices.dm"