9unit/9unit.h

74 lines
2.0 KiB
C

/*
9unit
Copyright (C) 2023 Jonathan Lamothe <jonathan@jlamothe.net>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
// Tracks information about the tests being run.
typedef struct TestState TestState;
// Defines a log entry in a TestState struct
typedef struct TestLogEntry TestLogEntry;
// The following structures will typically be maintained by the
// testing framework. You shouldn't need to concern yourself with
// them.
struct TestState
{
int run; // number of tests run
int passed; // number of successful tests
int failed; // number of failed tests
int postponed; // number of postponed tests
TestLogEntry *first_log; // the first log entry
TestLogEntry *last_log; //the last log entry
};
struct TestLogEntry
{
char *text; // the entry text
TestLogEntry *next; // points to the next entry
};
// Possible results of running a single test
typedef enum TestResult
{
test_success, // the test succeeded
test_failure, // the test failed
test_postponed // the test was postponed
} TestResult;
// Runs a single test
extern void run_test(
TestState *, // the TestState data
TestResult (*)(TestState *) // the test to run
);
// Runs multiple tests, displaying a summary at the end
extern void run_tests(
// runs the tests and updates a provided TestState
void (*)(TestState *)
);
// Adds an entry to the log that is displayed after the tests have
// completed
extern void append_log(
TestState *, // the current state
const char * // the message to append
);
//jl