mirror of
https://github.com/git/git.git
synced 2026-01-11 13:23:12 +09:00
d5e4aef358
Update clar to commit 39f11fe (Merge pull request #131 from pks-gitlab/pks-integer-double-evaluation, 2025-12-05). This commit includes the following changes relevant to Git: - There are now typesafe integer comparison functions. Furthermore, the range of comparison functions has been included to also have relative comparisons, like "greater than". - There is a new `cl_failf()` macro that allows the caller to specify an error message with formatting directives. - The TAP format has been fixed to correctly terminate YAML blocks with "...\n" instead of "---\n". Note that we already had a `cl_failf()` function declared in our own sources. This function is equivalent to the upstreamed function, so we can simply drop it now. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>
291 lines
12 KiB
C
291 lines
12 KiB
C
/*
|
|
* Copyright (c) Vicent Marti. All rights reserved.
|
|
*
|
|
* This file is part of clar, distributed under the ISC license.
|
|
* For full terms see the included COPYING file.
|
|
*/
|
|
#ifndef __CLAR_TEST_H__
|
|
#define __CLAR_TEST_H__
|
|
|
|
#include <inttypes.h>
|
|
#include <stdlib.h>
|
|
#include <limits.h>
|
|
|
|
#if defined(_WIN32) && defined(CLAR_WIN32_LONGPATHS)
|
|
# define CLAR_MAX_PATH 4096
|
|
#elif defined(_WIN32)
|
|
# define CLAR_MAX_PATH MAX_PATH
|
|
#else
|
|
# define CLAR_MAX_PATH PATH_MAX
|
|
#endif
|
|
|
|
#ifndef CLAR_SELFTEST
|
|
# define CLAR_CURRENT_FILE __FILE__
|
|
# define CLAR_CURRENT_LINE __LINE__
|
|
# define CLAR_CURRENT_FUNC __func__
|
|
#else
|
|
# define CLAR_CURRENT_FILE "file"
|
|
# define CLAR_CURRENT_LINE 42
|
|
# define CLAR_CURRENT_FUNC "func"
|
|
#endif
|
|
|
|
enum cl_test_status {
|
|
CL_TEST_OK,
|
|
CL_TEST_FAILURE,
|
|
CL_TEST_SKIP,
|
|
CL_TEST_NOTRUN,
|
|
};
|
|
|
|
enum cl_output_format {
|
|
CL_OUTPUT_CLAP,
|
|
CL_OUTPUT_TAP,
|
|
};
|
|
|
|
/** Setup clar environment */
|
|
void clar_test_init(int argc, char *argv[]);
|
|
int clar_test_run(void);
|
|
void clar_test_shutdown(void);
|
|
|
|
/** One shot setup & run */
|
|
int clar_test(int argc, char *argv[]);
|
|
|
|
const char *clar_sandbox_path(void);
|
|
const char *clar_tempdir_path(void);
|
|
|
|
void cl_set_cleanup(void (*cleanup)(void *), void *opaque);
|
|
void cl_fs_cleanup(void);
|
|
|
|
/**
|
|
* cl_trace_* is a hook to provide a simple global tracing
|
|
* mechanism.
|
|
*
|
|
* The goal here is to let main() provide clar-proper
|
|
* with a callback to optionally write log info for
|
|
* test operations into the same stream used by their
|
|
* actual tests. This would let them print test names
|
|
* and maybe performance data as they choose.
|
|
*
|
|
* The goal is NOT to alter the flow of control or to
|
|
* override test selection/skipping. (So the callback
|
|
* does not return a value.)
|
|
*
|
|
* The goal is NOT to duplicate the existing
|
|
* pass/fail/skip reporting. (So the callback
|
|
* does not accept a status/errorcode argument.)
|
|
*
|
|
*/
|
|
typedef enum cl_trace_event {
|
|
CL_TRACE__SUITE_BEGIN,
|
|
CL_TRACE__SUITE_END,
|
|
CL_TRACE__TEST__BEGIN,
|
|
CL_TRACE__TEST__END,
|
|
CL_TRACE__TEST__RUN_BEGIN,
|
|
CL_TRACE__TEST__RUN_END,
|
|
CL_TRACE__TEST__LONGJMP,
|
|
} cl_trace_event;
|
|
|
|
typedef void (cl_trace_cb)(
|
|
cl_trace_event ev,
|
|
const char *suite_name,
|
|
const char *test_name,
|
|
void *payload);
|
|
|
|
/**
|
|
* Register a callback into CLAR to send global trace events.
|
|
* Pass NULL to disable.
|
|
*/
|
|
void cl_trace_register(cl_trace_cb *cb, void *payload);
|
|
|
|
|
|
#ifdef CLAR_FIXTURE_PATH
|
|
const char *cl_fixture(const char *fixture_name);
|
|
void cl_fixture_sandbox(const char *fixture_name);
|
|
void cl_fixture_cleanup(const char *fixture_name);
|
|
const char *cl_fixture_basename(const char *fixture_name);
|
|
#endif
|
|
|
|
/**
|
|
* Invoke a helper function, which itself will use `cl_assert`
|
|
* constructs. This will preserve the stack information of the
|
|
* current call point, so that function name and line number
|
|
* information is shown from the line of the test, instead of
|
|
* the helper function.
|
|
*/
|
|
#define cl_invoke(expr) \
|
|
do { \
|
|
clar__set_invokepoint(CLAR_CURRENT_FILE, CLAR_CURRENT_FUNC, CLAR_CURRENT_LINE); \
|
|
expr; \
|
|
clar__clear_invokepoint(); \
|
|
} while(0)
|
|
|
|
/**
|
|
* Assertion macros with explicit error message
|
|
*/
|
|
#define cl_must_pass_(expr, desc) clar__assert((expr) >= 0, CLAR_CURRENT_FILE, CLAR_CURRENT_FUNC, CLAR_CURRENT_LINE, "Function call failed: " #expr, desc, 1)
|
|
#define cl_must_fail_(expr, desc) clar__assert((expr) < 0, CLAR_CURRENT_FILE, CLAR_CURRENT_FUNC, CLAR_CURRENT_LINE, "Expected function call to fail: " #expr, desc, 1)
|
|
#define cl_assert_(expr, desc) clar__assert((expr) != 0, CLAR_CURRENT_FILE, CLAR_CURRENT_FUNC, CLAR_CURRENT_LINE, "Expression is not true: " #expr, desc, 1)
|
|
|
|
/**
|
|
* Check macros with explicit error message
|
|
*/
|
|
#define cl_check_pass_(expr, desc) clar__assert((expr) >= 0, CLAR_CURRENT_FILE, CLAR_CURRENT_FUNC, CLAR_CURRENT_LINE, "Function call failed: " #expr, desc, 0)
|
|
#define cl_check_fail_(expr, desc) clar__assert((expr) < 0, CLAR_CURRENT_FILE, CLAR_CURRENT_FUNC, CLAR_CURRENT_LINE, "Expected function call to fail: " #expr, desc, 0)
|
|
#define cl_check_(expr, desc) clar__assert((expr) != 0, CLAR_CURRENT_FILE, CLAR_CURRENT_FUNC, CLAR_CURRENT_LINE, "Expression is not true: " #expr, desc, 0)
|
|
|
|
/**
|
|
* Assertion macros with no error message
|
|
*/
|
|
#define cl_must_pass(expr) cl_must_pass_(expr, NULL)
|
|
#define cl_must_fail(expr) cl_must_fail_(expr, NULL)
|
|
#define cl_assert(expr) cl_assert_(expr, NULL)
|
|
|
|
/**
|
|
* Check macros with no error message
|
|
*/
|
|
#define cl_check_pass(expr) cl_check_pass_(expr, NULL)
|
|
#define cl_check_fail(expr) cl_check_fail_(expr, NULL)
|
|
#define cl_check(expr) cl_check_(expr, NULL)
|
|
|
|
/**
|
|
* Forced failure/warning
|
|
*/
|
|
#define cl_fail(desc) clar__fail(CLAR_CURRENT_FILE, CLAR_CURRENT_FUNC, CLAR_CURRENT_LINE, "Test failed.", desc, 1)
|
|
#define cl_failf(desc,...) clar__failf(CLAR_CURRENT_FILE, CLAR_CURRENT_FUNC, CLAR_CURRENT_LINE, 1, "Test failed.", desc, __VA_ARGS__)
|
|
#define cl_warning(desc) clar__fail(CLAR_CURRENT_FILE, CLAR_CURRENT_FUNC, CLAR_CURRENT_LINE, "Warning during test execution:", desc, 0)
|
|
|
|
#define cl_skip() clar__skip()
|
|
|
|
/**
|
|
* Typed assertion macros
|
|
*/
|
|
#define cl_assert_equal_s(s1,s2) clar__assert_equal(CLAR_CURRENT_FILE,CLAR_CURRENT_FUNC,CLAR_CURRENT_LINE,"String mismatch: " #s1 " != " #s2, 1, "%s", (s1), (s2))
|
|
#define cl_assert_equal_s_(s1,s2,note) clar__assert_equal(CLAR_CURRENT_FILE,CLAR_CURRENT_FUNC,CLAR_CURRENT_LINE,"String mismatch: " #s1 " != " #s2 " (" #note ")", 1, "%s", (s1), (s2))
|
|
|
|
#define cl_assert_equal_wcs(wcs1,wcs2) clar__assert_equal(CLAR_CURRENT_FILE,CLAR_CURRENT_FUNC,CLAR_CURRENT_LINE,"String mismatch: " #wcs1 " != " #wcs2, 1, "%ls", (wcs1), (wcs2))
|
|
#define cl_assert_equal_wcs_(wcs1,wcs2,note) clar__assert_equal(CLAR_CURRENT_FILE,CLAR_CURRENT_FUNC,CLAR_CURRENT_LINE,"String mismatch: " #wcs1 " != " #wcs2 " (" #note ")", 1, "%ls", (wcs1), (wcs2))
|
|
|
|
#define cl_assert_equal_strn(s1,s2,len) clar__assert_equal(CLAR_CURRENT_FILE,CLAR_CURRENT_FUNC,CLAR_CURRENT_LINE,"String mismatch: " #s1 " != " #s2, 1, "%.*s", (s1), (s2), (int)(len))
|
|
#define cl_assert_equal_strn_(s1,s2,len,note) clar__assert_equal(CLAR_CURRENT_FILE,CLAR_CURRENT_FUNC,CLAR_CURRENT_LINE,"String mismatch: " #s1 " != " #s2 " (" #note ")", 1, "%.*s", (s1), (s2), (int)(len))
|
|
|
|
#define cl_assert_equal_wcsn(wcs1,wcs2,len) clar__assert_equal(CLAR_CURRENT_FILE,CLAR_CURRENT_FUNC,CLAR_CURRENT_LINE,"String mismatch: " #wcs1 " != " #wcs2, 1, "%.*ls", (wcs1), (wcs2), (int)(len))
|
|
#define cl_assert_equal_wcsn_(wcs1,wcs2,len,note) clar__assert_equal(CLAR_CURRENT_FILE,CLAR_CURRENT_FUNC,CLAR_CURRENT_LINE,"String mismatch: " #wcs1 " != " #wcs2 " (" #note ")", 1, "%.*ls", (wcs1), (wcs2), (int)(len))
|
|
|
|
#define cl_assert_compare_i_(i1, i2, cmp, error, ...) clar__assert_compare_i(CLAR_CURRENT_FILE, CLAR_CURRENT_FUNC, CLAR_CURRENT_LINE, 1, cmp, \
|
|
(i1), (i2), "Expected comparison to hold: " error, __VA_ARGS__)
|
|
#define cl_assert_compare_i(i1, i2, cmp, error, fmt) do { \
|
|
intmax_t v1 = (i1), v2 = (i2); \
|
|
clar__assert_compare_i(CLAR_CURRENT_FILE, CLAR_CURRENT_FUNC, CLAR_CURRENT_LINE, 1, cmp, \
|
|
v1, v2, "Expected comparison to hold: " error, fmt, v1, v2); \
|
|
} while (0)
|
|
#define cl_assert_equal_i_(i1, i2, ...) cl_assert_compare_i_(i1, i2, CLAR_COMPARISON_EQ, #i1 " == " #i2, __VA_ARGS__)
|
|
#define cl_assert_equal_i(i1, i2) cl_assert_compare_i (i1, i2, CLAR_COMPARISON_EQ, #i1 " == " #i2, "%"PRIdMAX " != %"PRIdMAX)
|
|
#define cl_assert_equal_i_fmt(i1, i2, fmt) cl_assert_compare_i_(i1, i2, CLAR_COMPARISON_EQ, #i1 " == " #i2, fmt " != " fmt, (int)(i1), (int)(i2))
|
|
#define cl_assert_lt_i_(i1, i2, ...) cl_assert_compare_i_(i1, i2, CLAR_COMPARISON_LT, #i1 " < " #i2, __VA_ARGS__)
|
|
#define cl_assert_lt_i(i1, i2) cl_assert_compare_i (i1, i2, CLAR_COMPARISON_LT, #i1 " < " #i2, "%"PRIdMAX " >= %"PRIdMAX)
|
|
#define cl_assert_le_i_(i1, i2, ...) cl_assert_compare_i_(i1, i2, CLAR_COMPARISON_LE, #i1 " <= " #i2, __VA_ARGS__)
|
|
#define cl_assert_le_i(i1, i2) cl_assert_compare_i (i1, i2, CLAR_COMPARISON_LE, #i1 " <= " #i2, "%"PRIdMAX " > %"PRIdMAX)
|
|
#define cl_assert_gt_i_(i1, i2, ...) cl_assert_compare_i_(i1, i2, CLAR_COMPARISON_GT, #i1 " > " #i2, __VA_ARGS__)
|
|
#define cl_assert_gt_i(i1, i2) cl_assert_compare_i (i1, i2, CLAR_COMPARISON_GT, #i1 " > " #i2, "%"PRIdMAX " <= %"PRIdMAX)
|
|
#define cl_assert_ge_i_(i1, i2, ...) cl_assert_compare_i_(i1, i2, CLAR_COMPARISON_GE, #i1 " >= " #i2, __VA_ARGS__)
|
|
#define cl_assert_ge_i(i1, i2) cl_assert_compare_i (i1, i2, CLAR_COMPARISON_GE, #i1 " >= " #i2, "%"PRIdMAX " < %"PRIdMAX)
|
|
|
|
#define cl_assert_compare_u_(u1, u2, cmp, error, ...) clar__assert_compare_u(CLAR_CURRENT_FILE, CLAR_CURRENT_FUNC, CLAR_CURRENT_LINE, 1, cmp, \
|
|
(u1), (u2), "Expected comparison to hold: " error, __VA_ARGS__)
|
|
#define cl_assert_compare_u(u1, u2, cmp, error, fmt) do { \
|
|
uintmax_t v1 = (u1), v2 = (u2); \
|
|
clar__assert_compare_u(CLAR_CURRENT_FILE, CLAR_CURRENT_FUNC, CLAR_CURRENT_LINE, 1, cmp, \
|
|
v1, v2, "Expected comparison to hold: " error, fmt, v1, v2); \
|
|
} while (0)
|
|
#define cl_assert_equal_u_(u1, u2, ...) cl_assert_compare_u_(u1, u2, CLAR_COMPARISON_EQ, #u1 " == " #u2, __VA_ARGS__)
|
|
#define cl_assert_equal_u(u1, u2) cl_assert_compare_u (u1, u2, CLAR_COMPARISON_EQ, #u1 " == " #u2, "%"PRIuMAX " != %"PRIuMAX)
|
|
#define cl_assert_lt_u_(u1, u2, ...) cl_assert_compare_u_(u1, u2, CLAR_COMPARISON_LT, #u1 " < " #u2, __VA_ARGS__)
|
|
#define cl_assert_lt_u(u1, u2) cl_assert_compare_u (u1, u2, CLAR_COMPARISON_LT, #u1 " < " #u2, "%"PRIuMAX " >= %"PRIuMAX)
|
|
#define cl_assert_le_u_(u1, u2, ...) cl_assert_compare_u_(u1, u2, CLAR_COMPARISON_LE, #u1 " <= " #u2, __VA_ARGS__)
|
|
#define cl_assert_le_u(u1, u2) cl_assert_compare_u (u1, u2, CLAR_COMPARISON_LE, #u1 " <= " #u2, "%"PRIuMAX " > %"PRIuMAX)
|
|
#define cl_assert_gt_u_(u1, u2, ...) cl_assert_compare_u_(u1, u2, CLAR_COMPARISON_GT, #u1 " > " #u2, __VA_ARGS__)
|
|
#define cl_assert_gt_u(u1, u2) cl_assert_compare_u (u1, u2, CLAR_COMPARISON_GT, #u1 " > " #u2, "%"PRIuMAX " <= %"PRIuMAX)
|
|
#define cl_assert_ge_u_(u1, u2, ...) cl_assert_compare_u_(u1, u2, CLAR_COMPARISON_GE, #u1 " >= " #u2, __VA_ARGS__)
|
|
#define cl_assert_ge_u(u1, u2) cl_assert_compare_u (u1, u2, CLAR_COMPARISON_GE, #u1 " >= " #u2, "%"PRIuMAX " < %"PRIuMAX)
|
|
|
|
#define cl_assert_equal_b(b1,b2) clar__assert_equal(CLAR_CURRENT_FILE,CLAR_CURRENT_FUNC,CLAR_CURRENT_LINE,#b1 " != " #b2, 1, "%d", (int)((b1) != 0),(int)((b2) != 0))
|
|
|
|
#define cl_assert_equal_p(p1,p2) clar__assert_equal(CLAR_CURRENT_FILE,CLAR_CURRENT_FUNC,CLAR_CURRENT_LINE,"Pointer mismatch: " #p1 " != " #p2, 1, "%p", (p1), (p2))
|
|
|
|
void clar__skip(void);
|
|
|
|
void clar__fail(
|
|
const char *file,
|
|
const char *func,
|
|
size_t line,
|
|
const char *error,
|
|
const char *description,
|
|
int should_abort);
|
|
|
|
void clar__failf(
|
|
const char *file,
|
|
const char *func,
|
|
size_t line,
|
|
int should_abort,
|
|
const char *error,
|
|
const char *description,
|
|
...);
|
|
|
|
void clar__assert(
|
|
int condition,
|
|
const char *file,
|
|
const char *func,
|
|
size_t line,
|
|
const char *error,
|
|
const char *description,
|
|
int should_abort);
|
|
|
|
void clar__assert_equal(
|
|
const char *file,
|
|
const char *func,
|
|
size_t line,
|
|
const char *err,
|
|
int should_abort,
|
|
const char *fmt,
|
|
...);
|
|
|
|
enum clar_comparison {
|
|
CLAR_COMPARISON_EQ,
|
|
CLAR_COMPARISON_LT,
|
|
CLAR_COMPARISON_LE,
|
|
CLAR_COMPARISON_GT,
|
|
CLAR_COMPARISON_GE,
|
|
};
|
|
|
|
void clar__assert_compare_i(
|
|
const char *file,
|
|
const char *func,
|
|
size_t line,
|
|
int should_abort,
|
|
enum clar_comparison cmp,
|
|
intmax_t value1,
|
|
intmax_t value2,
|
|
const char *error,
|
|
const char *description,
|
|
...);
|
|
|
|
void clar__assert_compare_u(
|
|
const char *file,
|
|
const char *func,
|
|
size_t line,
|
|
int should_abort,
|
|
enum clar_comparison cmp,
|
|
uintmax_t value1,
|
|
uintmax_t value2,
|
|
const char *error,
|
|
const char *description,
|
|
...);
|
|
|
|
void clar__set_invokepoint(
|
|
const char *file,
|
|
const char *func,
|
|
size_t line);
|
|
|
|
void clar__clear_invokepoint(void);
|
|
|
|
#endif
|