Andrew Kesterson
9924d74dcc
Closes internal-consistency items 1 through 6, 12 and 13. Every include guard is _AKGL_<FILE>_H_, every in-project header include is angled, and every exported function, type and global carries the akgl_ prefix. This is an ABI break; the soname goes to libakgl.so.0.5. TODO.md carries the full rename table. The renames were driven by renaming each declaration and letting the compiler find the uses, not by pattern substitution: renderer, physics and camera are also parameter and struct-member names, and a sed would have rewritten map->physics and every akgl_RenderBackend *renderer parameter without a word. Item 4 turned out not to be cosmetic. The library exported a global called renderer and tests/character.c defined an SDL_Renderer *renderer of its own; the executable's definition preempted the library's, akgl_sprite_load_json read a SDL_Renderer * through an akgl_RenderBackend *, and every texture load in that suite failed. The suite reported success anyway, because libakerror's unhandled-error handler ends in exit(errctx->status), exit keeps only the low byte, and AKGL_ERR_SDL is exactly 256. So character had been green while running one of its four tests, and every suite in the tree was unable to fail on the most common status in a library built on SDL. Both are fixed. tests/testutil.h gains TEST_TRAP_UNHANDLED_ERRORS(), which collapses any status a byte cannot carry onto 1, and every suite installs it. character binds a real backend with akgl_render_2d_bind. Its fourth test then runs for the first time and fails on a defect it has asserted all along, so akgl_heap_release_character now walks state_sprites with AKGL_ITERATOR_OP_RELEASE and destroys the property set before zeroing the slot -- TODO.md Defects item 21 and half of Carried over item 1. AKGL_TIME_ONESEC_MS said "one second in milliseconds" and held 1000000, so akgl_game_state_lock waited roughly sixteen minutes rather than one second. It is AKGL_TIME_ONEMS_NS now, the budget is its own named constant, and tests/game.c holds the mutex from a second thread to assert the wait -- the contended path had no coverage at all. Headers are self-contained and it is enforced: AKGL_PUBLIC_HEADERS drives both install() and a generated translation unit per header, so a header that ships is a header that is checked. Writing that found registry.h, which used SDL_PropertiesID in eight declarations and included no SDL header. 23/23 suites pass, memcheck is clean, reindent --check is clean. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
110 lines
3.4 KiB
C
110 lines
3.4 KiB
C
/**
|
|
* @file version.c
|
|
* @brief Unit tests for the version macros and the linked-library accessor.
|
|
*
|
|
* These assert that the several places the version appears cannot drift: the
|
|
* string, the numeric components, and what the shared library reports at
|
|
* runtime all come from one project() call, and this is what proves it.
|
|
*/
|
|
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
#include <akerror.h>
|
|
|
|
#include <akgl/error.h>
|
|
#include <akgl/version.h>
|
|
|
|
#include "testutil.h"
|
|
|
|
/**
|
|
* @brief The version string and the numeric components must describe one version.
|
|
*
|
|
* They are separate substitutions in version.h.in, so a mangled template can
|
|
* leave them disagreeing and nothing else would notice.
|
|
*/
|
|
akerr_ErrorContext *test_version_string_matches_components(void)
|
|
{
|
|
PREPARE_ERROR(e);
|
|
char assembled[64];
|
|
|
|
ATTEMPT {
|
|
snprintf(assembled, sizeof(assembled), "%d.%d.%d",
|
|
AKGL_VERSION_MAJOR, AKGL_VERSION_MINOR, AKGL_VERSION_PATCH);
|
|
TEST_ASSERT(e, strcmp(assembled, AKGL_VERSION) == 0,
|
|
"AKGL_VERSION is \"%s\" but the components assemble to \"%s\"",
|
|
AKGL_VERSION, assembled);
|
|
} CLEANUP {
|
|
} PROCESS(e) {
|
|
} FINISH(e, true);
|
|
SUCCEED_RETURN(e);
|
|
}
|
|
|
|
/**
|
|
* @brief The linked library must report the version its headers were generated from.
|
|
*
|
|
* In this build tree they are the same tree, so this can only fail if the test
|
|
* picked up an installed libakgl off LD_LIBRARY_PATH instead of the one just
|
|
* built -- which is precisely the mispairing the accessor exists to catch.
|
|
*/
|
|
akerr_ErrorContext *test_version_linked_matches_compiled(void)
|
|
{
|
|
PREPARE_ERROR(e);
|
|
|
|
ATTEMPT {
|
|
TEST_ASSERT(e, akgl_version() != NULL, "akgl_version returned NULL");
|
|
TEST_ASSERT(e, strcmp(akgl_version(), AKGL_VERSION) == 0,
|
|
"linked libakgl reports \"%s\" but the headers say \"%s\"",
|
|
akgl_version(), AKGL_VERSION);
|
|
} CLEANUP {
|
|
} PROCESS(e) {
|
|
} FINISH(e, true);
|
|
SUCCEED_RETURN(e);
|
|
}
|
|
|
|
/**
|
|
* @brief AKGL_VERSION_AT_LEAST must order versions correctly at the boundaries.
|
|
*
|
|
* Checked against the current version rather than fixed literals, so the test
|
|
* does not have to be rewritten every time the version is bumped.
|
|
*/
|
|
akerr_ErrorContext *test_version_at_least_boundaries(void)
|
|
{
|
|
PREPARE_ERROR(e);
|
|
|
|
ATTEMPT {
|
|
TEST_ASSERT(e,
|
|
AKGL_VERSION_AT_LEAST(AKGL_VERSION_MAJOR, AKGL_VERSION_MINOR, AKGL_VERSION_PATCH),
|
|
"AKGL_VERSION_AT_LEAST rejected the current version");
|
|
TEST_ASSERT(e,
|
|
!AKGL_VERSION_AT_LEAST(AKGL_VERSION_MAJOR, AKGL_VERSION_MINOR, AKGL_VERSION_PATCH + 1),
|
|
"AKGL_VERSION_AT_LEAST accepted a later patch");
|
|
TEST_ASSERT(e,
|
|
!AKGL_VERSION_AT_LEAST(AKGL_VERSION_MAJOR, AKGL_VERSION_MINOR + 1, 0),
|
|
"AKGL_VERSION_AT_LEAST accepted a later minor");
|
|
TEST_ASSERT(e,
|
|
!AKGL_VERSION_AT_LEAST(AKGL_VERSION_MAJOR + 1, 0, 0),
|
|
"AKGL_VERSION_AT_LEAST accepted a later major");
|
|
TEST_ASSERT(e,
|
|
AKGL_VERSION_AT_LEAST(AKGL_VERSION_MAJOR, AKGL_VERSION_MINOR, 0),
|
|
"AKGL_VERSION_AT_LEAST rejected an earlier patch");
|
|
} CLEANUP {
|
|
} PROCESS(e) {
|
|
} FINISH(e, true);
|
|
SUCCEED_RETURN(e);
|
|
}
|
|
|
|
int main(void)
|
|
{
|
|
PREPARE_ERROR(errctx);
|
|
|
|
ATTEMPT {
|
|
CATCH(errctx, akgl_error_init());
|
|
TEST_TRAP_UNHANDLED_ERRORS();
|
|
CATCH(errctx, test_version_string_matches_components());
|
|
CATCH(errctx, test_version_linked_matches_compiled());
|
|
CATCH(errctx, test_version_at_least_boundaries());
|
|
} CLEANUP {
|
|
} PROCESS(errctx) {
|
|
} FINISH_NORETURN(errctx);
|
|
}
|