unit_test

Vars
allocated	A list of instances created by this unit test. Use allocate()
fail_reasons	Lazy list of why this unit test failed.
priority	The priority of the test, the larger it is the later it fires
reservation	Reference to the blank z-level containing our testing enviroment
run_loc_floor_bottom_left	The bottom left floor turf of the testing zone
run_loc_floor_top_right	The top right floor turf of the testing zone
succeeded	If this test has passed or not
test_flags	Behavior flags for this unit test
times_to_run	How many times this unit test will run. Use the TEST_REPEAT() macro
uncreatables	List of atoms that we don't want to ever initialize in an agnostic context, like for Create and Destroy. Stored on the base datum for usability in other relevant tests that need this data.
Procs
allocate	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
build_list_of_uncreatables	Builds (and returns) a list of atoms that we shouldn't initialize in generic testing, like Create and Destroy. It is appreciated to add the reason why the atom shouldn't be initialized if you add it to this list.
click_wrapper	Helper to perform a click
get_flat_icon_for_all_directions	Helper for screenshot tests to take an image of an atom from all directions and insert it into one icon
log_for_test	Logs a test message. Will use GitHub action syntax found at https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions
restore_atmos	Resets the air of our testing room to its default

Var Details

var
allocated
– /list

A list of instances created by this unit test. Use allocate()

var
fail_reasons
– /list

Lazy list of why this unit test failed.

var
priority

The priority of the test, the larger it is the later it fires

var
reservation
– /static/datum/space_level

Reference to the blank z-level containing our testing enviroment

var
run_loc_floor_bottom_left
– /turf

The bottom left floor turf of the testing zone

var
run_loc_floor_top_right
– /turf

The top right floor turf of the testing zone

var
succeeded

If this test has passed or not

var
test_flags

Behavior flags for this unit test

var
times_to_run

How many times this unit test will run. Use the TEST_REPEAT() macro

var
uncreatables
– /static/list

List of atoms that we don't want to ever initialize in an agnostic context, like for Create and Destroy. Stored on the base datum for usability in other relevant tests that need this data.

Proc Details

proc
allocate
(type, ...)

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

proc
build_list_of_uncreatables
() as /list

Builds (and returns) a list of atoms that we shouldn't initialize in generic testing, like Create and Destroy. It is appreciated to add the reason why the atom shouldn't be initialized if you add it to this list.

proc
click_wrapper
(/mob/living/clicker, /atom/clicked_on, /list/passed_params)

Helper to perform a click

clicker: The mob that will be clicking
clicked_on: The atom that will be clicked
passed_params: A list of parameters to pass to the click

proc
get_flat_icon_for_all_directions
(/atom/thing, no_anim)

Helper for screenshot tests to take an image of an atom from all directions and insert it into one icon

proc
log_for_test
(text, priority, file, line)

Logs a test message. Will use GitHub action syntax found at https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions

proc
restore_atmos
()

Resets the air of our testing room to its default

unit_test /datum/unit_test

Vars

Procs

Var Details

var allocated – /list

var fail_reasons – /list

var priority

var reservation – /static/datum/space_level

var run_loc_floor_bottom_left – /turf

var run_loc_floor_top_right – /turf

var succeeded

var test_flags

var times_to_run

var uncreatables – /static/list