test/test-real-pgn.c

/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2026 Mike Becker. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */

#include "ucxtest.h"
#include "chess/pgn.h"

#if __STDC_VERSION__ < 202310L
/* since #warning is also a C23 feature, the only hope is this: */
#pragma GCC warning "Need at least a C23 compiler to compile test-real-pgn.c"
CxTestSuite* test_real_pgn_suite(void) {
    CxTestSuite* suite = cx_test_suite_new("Skip testing real PGN Files");
    return suite;
}
#else

const char pgn_data[150][1500];

/* we have no clock info here, resign also includes running out of clock */
enum expected_result {
    EXPECTED_WRESIGN,
    EXPECTED_BRESIGN,
    EXPECTED_CHECKMATE,
    EXPECTED_STALEMATE,
    EXPECTED_THREEFOLD,
    EXPECTED_NOMATERIAL,
};

static CX_TEST_SUBROUTINE(verify_expected_result,
        const GameState *gs, enum expected_result rs) {
    CX_TEST_ASSERT(gs->wresign == (rs == EXPECTED_WRESIGN));
    CX_TEST_ASSERT(gs->bresign == (rs == EXPECTED_BRESIGN));
    CX_TEST_ASSERT(gs->stalemate == (rs == EXPECTED_STALEMATE));
    CX_TEST_ASSERT(gs->checkmate == (rs == EXPECTED_CHECKMATE));
    CX_TEST_ASSERT(gs->threefold == (rs == EXPECTED_THREEFOLD));
    CX_TEST_ASSERT(gs->nomaterial == (rs == EXPECTED_NOMATERIAL));
    CX_TEST_ASSERT(!gs->remis); /* no draw offers in example games */

    const Move *last_move = &gs->moves[gs->movecount-1];
    CX_TEST_ASSERT((last_move->checkmate == 1) == (rs == EXPECTED_CHECKMATE));
}

static CX_TEST(test_real_pgn) {
    static unsigned index = 0;
    ++index;
    GameState gamestate;
    gamestate_init(&gamestate);
    char *chkpgn = NULL;
    CX_TEST_DO {
        const enum expected_result rs = pgn_data[index-1][0];
        const char *pgn = pgn_data[index-1]+1;
        pgn_result result = parse_pgn(pgn, &gamestate);
        char msg[64];
        sprintf(msg,
            "failed to parse game%03u.pgn: code %d, pos: %zu, merr: %d",
            index, result.code, result.position, result.move_error);
        CX_TEST_ASSERTM(result.code == pgn_no_error, msg);
        CX_TEST_CALL_SUBROUTINE(verify_expected_result, &gamestate, rs);

        /* check if we get the PGN text back */
        chkpgn = create_pgn(&gamestate, false);
        /* find move blocks (ignore the STR) */
        char *chkpgn_moves = strstr(chkpgn, "1. ");
        const char *pgn_moves = strstr(pgn, "1. ");
        /* revert the formatting (test data is also unformatted) */
        for (size_t i = 0; ; i++) {
            if (chkpgn_moves[i] == '\n') chkpgn_moves[i] = ' ';
            if (chkpgn_moves[i] == '\0') {
                /* do not replace last line break */
                chkpgn_moves[i-1] = '\n';
                break;
            }
        }

        /* compare */
        CX_TEST_ASSERTM(strcmp(chkpgn_moves, pgn_moves) == 0, "PGN move text mismatch");
    }
    free(chkpgn);
    gamestate_cleanup(&gamestate);
}

CxTestSuite* test_real_pgn_suite(void) {
    CxTestSuite* suite = cx_test_suite_new("Real PGN Files");
    for (unsigned i = 0 ; i < 150 ; i++) {
        cx_test_register(suite, test_real_pgn);
    }
    return suite;
}

const char pgn_data[150][1500] = {
    {
        EXPECTED_WRESIGN,
#embed "data/game001.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game002.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game003.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game004.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game005.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game006.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game007.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game008.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game009.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game010.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game011.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game012.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game013.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game014.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game015.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game016.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game017.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game018.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game019.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game020.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game021.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game022.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game023.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game024.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game025.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game026.pgn"
        , '\0'
    },
    {
        EXPECTED_THREEFOLD,
#embed "data/game027.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game028.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game029.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game030.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game031.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game032.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game033.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game034.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game035.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game036.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game037.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game038.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game039.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game040.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game041.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game042.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game043.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game044.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game045.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game046.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game047.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game048.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game049.pgn"
        , '\0'
    },
    {
        EXPECTED_THREEFOLD,
#embed "data/game050.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game051.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game052.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game053.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game054.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game055.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game056.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game057.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game058.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game059.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game060.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game061.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game062.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game063.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game064.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game065.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game066.pgn"
        , '\0'
    },
    {
        EXPECTED_THREEFOLD,
#embed "data/game067.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game068.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game069.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game070.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game071.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game072.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game073.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game074.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game075.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game076.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game077.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game078.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game079.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game080.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game081.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game082.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game083.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game084.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game085.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game086.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game087.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game088.pgn"
        , '\0'
    },
    {
        EXPECTED_NOMATERIAL,
#embed "data/game089.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game090.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game091.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game092.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game093.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game094.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game095.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game096.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game097.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game098.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game099.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game100.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game101.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game102.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game103.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game104.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game105.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game106.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game107.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game108.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game109.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game110.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game111.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game112.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game113.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game114.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game115.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game116.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game117.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game118.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game119.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game120.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game121.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game122.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game123.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game124.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game125.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game126.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game127.pgn"
        , '\0'
    },
    {
        EXPECTED_STALEMATE,
#embed "data/game128.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game129.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game130.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game131.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game132.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game133.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game134.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game135.pgn"
        , '\0'
    },
    {
        EXPECTED_CHECKMATE,
#embed "data/game136.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game137.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game138.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game139.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game140.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game141.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game142.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game143.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game144.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game145.pgn"
        , '\0'
    },
    {
        EXPECTED_STALEMATE,
#embed "data/game146.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game147.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game148.pgn"
        , '\0'
    },
    {
        EXPECTED_WRESIGN,
#embed "data/game149.pgn"
        , '\0'
    },
    {
        EXPECTED_BRESIGN,
#embed "data/game150.pgn"
        , '\0'
    },
};

#endif /* C23 compiler */