Files
akbasic/tests/golden.cmake

43 lines
1.4 KiB
CMake
Raw Normal View History

Port the BASIC interpreter from Go to C Reproduces deps/basicinterpret in C, in the idiom of the ak* libraries. All 41 .bas files in the reference's corpus produce byte-identical stdout, including the trailing double newline on an error line -- that comes from basicError building a string ending in \n and handing it to Println, and array_outofbounds.txt encodes it. The corpus is driven in place from the submodule as 41 individual CTest cases rather than copied, so it cannot drift from upstream. Eighteen unit tests cover what the corpus cannot reach. Three structural changes carry most of the work. Go's three reflection lookups (Command*, Function*, ParseCommand*) become one sorted dispatch table in src/verbs.c searched with bsearch; adding a verb is a row and two functions. The five Go maps become one fixed open-addressed table over aksl_strhash_djb2. And run(), which owned the process until MODE_QUIT, splits into step() plus a bounded run() -- goal 3 requires a host game to be able to bound execution, and nothing in the library now terminates the process or touches SDL. Output goes through an akbasic_TextSink vtable. src/sink_stdio.c is what makes the corpus runnable with no SDL present; the akgl-backed sink is still to come and is blocked on libakgl having no text-measurement call. src/convert.c exists because libakstdlib's aksl_ato* family cannot report a conversion failure (its TODO.md 2.1.5). The reference checks strconv's error at four sites and turns it into a BASIC error; routing those through aksl_atoi would have turned four diagnosable errors into wrong answers, with VAL("garbage") quietly returning 0. TODO.md 1.9 records which libakstdlib calls are cleared for use here and which are not. Reference defects are reproduced, not fixed: the golden files encode the observed behaviour and a silent correction is a behaviour change. TODO.md section 6 lists sixteen, and tests/known_reference_defects.c asserts the *correct* contract for six of them under AKBASIC_KNOWN_FAILING_TESTS, so a fix shows up as "unexpectedly passed". Five of the sixteen were found by this port and are new: subtraction stops after one operator so 1-2-3 computes 1-2 and abandons the rest of the line (a wrong answer, not a refused one); a unary-minus argument inflates a function's arity so ABS(-9) is rejected; a comparison operator in a line's final column is dropped; hex literals never survive the scanner; and the "Reserved word in variable name" check is dead code. Where the reference reaches undefined behaviour by a route that is defined in Go -- an out-of-range shift, a negative string multiplier, integer division by zero -- this raises instead of inheriting the UB. No golden case exercises any of them. The top-level CMakeLists shadows add_test, set_tests_properties and add_custom_target around all three add_subdirectory calls. Without it libakerror's tests land in our suite as Not Run, and its un-namespaced `coverage` target stops a coverage build from configuring at all. Test targets are akbasic_test_<name>: bare test_<name> collides with libakstdlib's, which is what broke libakgl's configure in c2b16d3. ctest 59/59; ASan+UBSan 59/59; 92.3% line and 96.9% function coverage; no warnings under -Wall -Wextra. Branch coverage is not a target, for the reason libakstdlib and libakgl both record: the akerror macros expand into large branch trees at every call site. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-07-30 23:53:56 -04:00
# Golden-file driver: run one .bas through the interpreter and byte-compare
# stdout against the sibling .txt.
#
# The comparison is on raw bytes, not lines: the reference's print pipeline emits
# a trailing double newline on an error line (basicError builds a string ending
# in \n and hands it to Println, which adds another), and that is part of the
# contract. See TODO.md section 1.8.
if(NOT DEFINED BASIC OR NOT DEFINED CASE)
message(FATAL_ERROR "golden.cmake requires -DBASIC=<interpreter> -DCASE=<file.bas>")
endif()
string(REGEX REPLACE "\\.bas$" ".txt" EXPECTED "${CASE}")
if(NOT EXISTS "${EXPECTED}")
message(FATAL_ERROR "No golden output beside ${CASE}")
endif()
execute_process(
COMMAND "${BASIC}" "${CASE}"
OUTPUT_VARIABLE actual
ERROR_VARIABLE stderr_text
RESULT_VARIABLE rc
)
if(NOT rc EQUAL 0)
message(FATAL_ERROR "${CASE}: interpreter exited ${rc}\n${stderr_text}")
endif()
file(READ "${EXPECTED}" expected)
if(NOT actual STREQUAL expected)
# Write what we got beside the build so a failure can be diffed by hand.
get_filename_component(_base "${CASE}" NAME)
set(_dump "${CMAKE_CURRENT_BINARY_DIR}/${_base}.actual")
file(WRITE "${_dump}" "${actual}")
message(FATAL_ERROR
"${CASE}: output does not match ${EXPECTED}\n"
"--- expected ---\n${expected}\n"
"--- actual ---\n${actual}\n"
"(actual written to ${_dump})")
endif()