test.h File Reference

#include <stdarg.h>
#include <stdlib.h>
#include <windef.h>
#include <winbase.h>
#include <stdio.h>

Include dependency graph for test.h:

Go to the source code of this file.

Classes
struct	winetest_thread_data

Macros
#define	__WINE_PRINTF_ATTR(fmt, args)
#define	INVALID_FILE_ATTRIBUTES   (~0u)
#define	INVALID_SET_FILE_POINTER   (~0u)
#define	START_TEST(name)   EXTERN_C void func_##name(void)
#define	subtest_(file, line)   (winetest_set_location(file, line), 0) ? (void)0 : winetest_subtest
#define	ignore_exceptions_(file, line)   (winetest_set_location(file, line), 0) ? (void)0 : winetest_ignore_exceptions
#define	ok_(file, line)   (winetest_set_location(file, line), 0) ? (void)0 : winetest_ok
#define	skip_(file, line)   (winetest_set_location(file, line), 0) ? (void)0 : winetest_skip
#define	win_skip_(file, line)   (winetest_set_location(file, line), 0) ? (void)0 : winetest_win_skip
#define	trace_(file, line)   (winetest_set_location(file, line), 0) ? (void)0 : winetest_trace
#define	wait_child_process_(file, line)   (winetest_set_location(file, line), 0) ? (void)0 : winetest_wait_child_process
#define	subtest   subtest_(__FILE__, __LINE__)
#define	ignore_exceptions   ignore_exceptions_(__FILE__, __LINE__)
#define	ok   ok_(__FILE__, __LINE__)
#define	skip   skip_(__FILE__, __LINE__)
#define	win_skip   win_skip_(__FILE__, __LINE__)
#define	trace   trace_(__FILE__, __LINE__)
#define	wait_child_process   wait_child_process_(__FILE__, __LINE__)
#define	flaky_if(is_flaky)
#define	flaky   flaky_if(TRUE)
#define	flaky_wine   flaky_if(winetest_platform_is_wine)
#define	flaky_wine_if(is_flaky)   flaky_if((is_flaky) && winetest_platform_is_wine)
#define	todo_if(is_todo)
#define	todo_ros   todo_if(!strcmp(winetest_platform, "reactos"))
#define	todo_ros_if(is_todo)   todo_if((is_todo) && !strcmp(winetest_platform, "reactos"))
#define	todo_wine   todo_if(!strcmp(winetest_platform, "wine"))
#define	todo_wine_if(is_todo)   todo_if((is_todo) && !strcmp(winetest_platform, "wine"))
#define	ARRAY_SIZE(x)   (sizeof(x) / sizeof((x)[0]))
#define	__winetest_file_line_prefix   "%s:%d"

Functions
struct winetest_thread_data *	winetest_get_thread_data (void)
void	winetest_print_lock (void)
void	winetest_print_unlock (void)
int	winetest_vprintf (const char *msg, va_list args)
int	winetest_get_time (void)
int	winetest_get_mainargs (char ***pargv)
void	winetest_wait_child_process (HANDLE process)
static void	winetest_set_location (const char *file, int line)
static int	winetest_printf (const char *msg,...) __WINE_PRINTF_ATTR(1
static const char *	winetest_elapsed (char *buffer)
static void	winetest_print_location (const char *msg,...) __WINE_PRINTF_ATTR(1
static void	winetest_print_context (const char *msgtype)
static void	winetest_subtest (const char *name)
static void	winetest_ignore_exceptions (BOOL ignore)
static int	broken (int condition)
static LONG	winetest_add_line (void)
static int	winetest_vok (int condition, const char *msg, va_list args)
void	winetest_ok (int condition, const char *msg,...) __WINE_PRINTF_ATTR(2
void void	winetest_trace (const char *msg,...) __WINE_PRINTF_ATTR(1
void void static void	winetest_vskip (const char *msg, va_list args)
void	winetest_skip (const char *msg,...) __WINE_PRINTF_ATTR(1
void static void	winetest_win_skip (const char *msg,...) __WINE_PRINTF_ATTR(1
static void	winetest_start_flaky (int is_flaky)
static int	winetest_loop_flaky (void)
static void	winetest_end_flaky (void)
static void	winetest_start_todo (int is_todo)
static int	winetest_loop_todo (void)
static void	winetest_end_todo (void)
static void	winetest_push_context (const char *fmt,...) __WINE_PRINTF_ATTR(1
static void	winetest_pop_context (void)
static LONG	winetest_get_failures (void)
static void	winetest_add_failures (LONG new_failures)

Variables
int	winetest_debug
int	winetest_time
int	winetest_start_time
int	winetest_last_time
int	winetest_interactive
int	winetest_report_flaky
int	winetest_report_success
int	winetest_mute_threshold
const char *	winetest_platform
int	winetest_platform_is_wine
int	winetest_color
LONG	winetest_successes
LONG	winetest_failures
LONG	winetest_flaky_failures
LONG	winetest_skipped
LONG	winetest_todo_successes
LONG	winetest_todo_failures
LONG	winetest_muted_traces
LONG	winetest_muted_skipped
LONG	winetest_muted_todo_successes
static const char	winetest_color_reset [] = "\x1b[0m"
static const char	winetest_color_dark_red [] = "\x1b[31m"
static const char	winetest_color_dark_purple [] = "\x1b[35m"
static const char	winetest_color_green [] = "\x1b[32m"
static const char	winetest_color_yellow [] = "\x1b[33m"
static const char	winetest_color_blue [] = "\x1b[34m"
static const char	winetest_color_bright_red [] = "\x1b[1;91m"
static const char	winetest_color_bright_purple [] = "\x1b[1;95m"

Macro Definition Documentation

__WINE_PRINTF_ATTR

#define __WINE_PRINTF_ATTR	(		fmt,
			args
	)

Definition at line 52 of file test.h.

__winetest_file_line_prefix

#define __winetest_file_line_prefix   "%s:%d"

Definition at line 226 of file test.h.

ARRAY_SIZE

#define ARRAY_SIZE

(

x

)

(sizeof(x) / sizeof((x)[0]))

Definition at line 185 of file test.h.

flaky

#define flaky   flaky_if(TRUE)

Definition at line 166 of file test.h.

flaky_if

#define flaky_if

(

is_flaky

)

Value:

                                for (winetest_start_flaky(is_flaky); \
                                winetest_loop_flaky(); \
                                winetest_end_flaky())

Definition at line 163 of file test.h.

flaky_wine

#define flaky_wine   flaky_if(winetest_platform_is_wine)

Definition at line 167 of file test.h.

flaky_wine_if

#define flaky_wine_if

(

is_flaky

)

flaky_if((is_flaky) && winetest_platform_is_wine)

Definition at line 168 of file test.h.

ignore_exceptions

#define ignore_exceptions   ignore_exceptions_(__FILE__, __LINE__)

Definition at line 156 of file test.h.

ignore_exceptions_

#define ignore_exceptions_	(		file,
			line
	)		(winetest_set_location(file, line), 0) ? (void)0 : winetest_ignore_exceptions

Definition at line 147 of file test.h.

INVALID_FILE_ATTRIBUTES

#define INVALID_FILE_ATTRIBUTES   (~0u)

Definition at line 61 of file test.h.

INVALID_SET_FILE_POINTER

#define INVALID_SET_FILE_POINTER   (~0u)

Definition at line 64 of file test.h.

ok

#define ok   ok_(__FILE__, __LINE__)

Definition at line 157 of file test.h.

ok_

#define ok_	(		file,
			line
	)		(winetest_set_location(file, line), 0) ? (void)0 : winetest_ok

Definition at line 148 of file test.h.

skip

#define skip   skip_(__FILE__, __LINE__)

Definition at line 158 of file test.h.

skip_

#define skip_	(		file,
			line
	)		(winetest_set_location(file, line), 0) ? (void)0 : winetest_skip

Definition at line 149 of file test.h.

START_TEST

#define START_TEST

(

name

)

EXTERN_C void func_##name(void)

Definition at line 134 of file test.h.

subtest

#define subtest   subtest_(__FILE__, __LINE__)

Definition at line 155 of file test.h.

subtest_

#define subtest_	(		file,
			line
	)		(winetest_set_location(file, line), 0) ? (void)0 : winetest_subtest

Definition at line 146 of file test.h.

todo_if

#define todo_if

(

is_todo

)

Value:

                              for (winetest_start_todo(is_todo); \
                              winetest_loop_todo(); \
                              winetest_end_todo())

Definition at line 170 of file test.h.

todo_ros

#define todo_ros   todo_if(!strcmp(winetest_platform, "reactos"))

Definition at line 174 of file test.h.

todo_ros_if

#define todo_ros_if

(

is_todo

)

todo_if((is_todo) && !strcmp(winetest_platform, "reactos"))

Definition at line 175 of file test.h.

todo_wine

#define todo_wine   todo_if(!strcmp(winetest_platform, "wine"))

Definition at line 180 of file test.h.

todo_wine_if

#define todo_wine_if

(

is_todo

)

todo_if((is_todo) && !strcmp(winetest_platform, "wine"))

Definition at line 181 of file test.h.

trace

#define trace   trace_(__FILE__, __LINE__)

Definition at line 160 of file test.h.

trace_

#define trace_	(		file,
			line
	)		(winetest_set_location(file, line), 0) ? (void)0 : winetest_trace

Definition at line 151 of file test.h.

wait_child_process

#define wait_child_process   wait_child_process_(__FILE__, __LINE__)

Definition at line 161 of file test.h.

wait_child_process_

#define wait_child_process_	(		file,
			line
	)		(winetest_set_location(file, line), 0) ? (void)0 : winetest_wait_child_process

Definition at line 152 of file test.h.

win_skip

#define win_skip   win_skip_(__FILE__, __LINE__)

Definition at line 159 of file test.h.

win_skip_

#define win_skip_	(		file,
			line
	)		(winetest_set_location(file, line), 0) ? (void)0 : winetest_win_skip

Definition at line 150 of file test.h.

Function Documentation

broken()

static int broken ( int  condition )

inlinestatic

Definition at line 288 of file test.h.

{
    return ((strcmp(winetest_platform, "windows") == 0)
#ifndef USE_WINE_TODOS
    || (strcmp(winetest_platform, "reactos") == 0)
#endif
    ) && condition;
}

winetest_add_failures()

static void winetest_add_failures ( LONG  new_failures )

inlinestatic

Definition at line 567 of file test.h.

{
    while (new_failures-- > 0) InterlockedIncrement( &winetest_failures );
}

winetest_add_line()

static LONG winetest_add_line ( void  )

static

Definition at line 297 of file test.h.

{
    /* counts how many times a given line printed a message */
    static LONG line_counters[16384];
 
    struct winetest_thread_data *data;
    int index, count;
 
    if (winetest_debug > 1)
        return 0;
 
    data = winetest_get_thread_data();
    index = data->current_line % ARRAY_SIZE(line_counters);
    count = InterlockedIncrement(line_counters + index) - 1;
    if (count == winetest_mute_threshold)
    {
        //winetest_print_lock();
        winetest_print_location( "Line has been silenced after %d occurrences\n", winetest_mute_threshold );
        //winetest_print_unlock();
    }
 
    return count;
}

winetest_elapsed()

static const char * winetest_elapsed ( char *  buffer )

static

Definition at line 244 of file test.h.

{
    int now;
 
    if (!winetest_time) return "";
    winetest_last_time = now = winetest_get_time();
    sprintf( buffer, "%.3f", (now - winetest_start_time) / 1000.0 );
    return buffer;
}

winetest_end_flaky()

static void winetest_end_flaky ( void  )

inlinestatic

Definition at line 479 of file test.h.

{
    struct winetest_thread_data *data = winetest_get_thread_data();
    data->flaky_level >>= 1;
}

winetest_end_todo()

static void winetest_end_todo ( void  )

inlinestatic

Definition at line 507 of file test.h.

{
    struct winetest_thread_data *data = winetest_get_thread_data();
    data->todo_level >>= 1;
}

winetest_get_failures()

static LONG winetest_get_failures ( void  )

inlinestatic

Definition at line 562 of file test.h.

{
    return winetest_failures;
}

winetest_get_mainargs()

int winetest_get_mainargs

(

char ***

pargv

)

Referenced by create_check_id_process(), create_process(), create_target_process(), create_writepipe_process(), init(), prepare_test(), run_child_process(), run_child_process_two_dll(), runtime_is_usable(), START_TEST(), test_AllocConsole(), test_apc_deadlock(), test_arm64ec(), test_AttachConsole(), test_comctl32_classes(), test_CreateProcessCUI(), test_CtrlHandlerSubsystem(), test_DeleteFileA(), test_exit_process_async(), test_ExitProcess(), test_fls_exit_deadlock(), test_GetConsoleOriginalTitle(), test_internet_features(), test_pe_os_version(), test_pseudo_console(), test_ReplaceFileA(), test_shared_memory(), test_shared_memory_ro(), test_StdHandleInheritance(), and test_suspend_process().

winetest_get_thread_data()

struct winetest_thread_data * winetest_get_thread_data

(

void

)

Referenced by winetest_add_line(), winetest_end_flaky(), winetest_end_todo(), winetest_loop_flaky(), winetest_loop_todo(), winetest_pop_context(), winetest_print_context(), winetest_print_location(), winetest_printf(), winetest_push_context(), winetest_set_location(), winetest_start_flaky(), winetest_start_todo(), winetest_subtest(), and winetest_vok().

winetest_get_time()

int winetest_get_time

(

void

)

Referenced by winetest_elapsed().

winetest_ignore_exceptions()

static void winetest_ignore_exceptions ( BOOL  ignore )

inlinestatic

Definition at line 283 of file test.h.

{
    winetest_print_location( "IgnoreExceptions=%d\n", ignore ? 1 : 0 );
}

winetest_loop_flaky()

static int winetest_loop_flaky ( void  )

inlinestatic

Definition at line 471 of file test.h.

{
    struct winetest_thread_data *data = winetest_get_thread_data();
    int do_flaky = data->flaky_do_loop;
    data->flaky_do_loop = 0;
    return do_flaky;
}

winetest_loop_todo()

static int winetest_loop_todo ( void  )

inlinestatic

Definition at line 499 of file test.h.

{
    struct winetest_thread_data *data = winetest_get_thread_data();
    int do_loop=data->todo_do_loop;
    data->todo_do_loop=0;
    return do_loop;
}

winetest_ok()

void winetest_ok	(	int	condition,
		const char *	msg,
			...
	)

winetest_pop_context()

static void winetest_pop_context ( void  )

inlinestatic

Definition at line 554 of file test.h.

{
    struct winetest_thread_data *data = winetest_get_thread_data();
 
    if (data->context_count)
        --data->context_count;
}

winetest_print_context()

static void winetest_print_context ( const char *  msgtype )

static

Definition at line 266 of file test.h.

{
    struct winetest_thread_data *data = winetest_get_thread_data();
    unsigned int i;
 
    winetest_printf( "%s", msgtype );
    for (i = 0; i < data->context_count; ++i)
        fprintf( stdout, "%s: ", data->context[i] );
}

Referenced by winetest_trace(), winetest_vok(), and winetest_vskip().

winetest_print_location()

static void static void winetest_print_location ( const char *  msg,   ...  )

static

Definition at line 255 of file test.h.

{
    struct winetest_thread_data *data = winetest_get_thread_data();
    va_list valist;
 
    winetest_printf( "%s:%d ", data->current_file, data->current_line );
    va_start( valist, msg );
    winetest_vprintf( msg, valist );
    va_end( valist );
}

Referenced by winetest_add_line(), and winetest_ignore_exceptions().

winetest_print_lock()

void winetest_print_lock

(

void

)

winetest_print_unlock()

void winetest_print_unlock

(

void

)

winetest_printf()

static int static int winetest_printf ( const char *  msg,   ...  )

static

Definition at line 230 of file test.h.

{
    struct winetest_thread_data *data = winetest_get_thread_data();
    va_list valist;
    int ret;
 
    fprintf( stdout, __winetest_file_line_prefix ": ", data->current_file, data->current_line );
    va_start( valist, msg );
    ret = vfprintf( stdout, msg, valist );
    va_end( valist );
 
    return ret;
}

Referenced by winetest_print_context(), winetest_print_location(), and winetest_vok().

winetest_push_context()

static void winetest_push_context ( const char *  fmt,   ...  )

static

Definition at line 539 of file test.h.

{
    struct winetest_thread_data *data = winetest_get_thread_data();
    va_list valist;
 
    if (data->context_count < ARRAY_SIZE(data->context))
    {
        va_start(valist, fmt);
        vsnprintf( data->context[data->context_count], sizeof(data->context[data->context_count]), fmt, valist );
        va_end(valist);
        data->context[data->context_count][sizeof(data->context[data->context_count]) - 1] = 0;
    }
    ++data->context_count;
}

winetest_set_location()

static void winetest_set_location ( const char *  file, int  line  )

inlinestatic

Definition at line 195 of file test.h.

{
    struct winetest_thread_data *data = winetest_get_thread_data();
#if defined(WINETEST_MSVC_IDE_FORMATTING)
    data->current_file = file;
#else
    data->current_file=strrchr(file,'/');
    if (data->current_file==NULL)
        data->current_file=strrchr(file,'\\');
    if (data->current_file==NULL)
        data->current_file=file;
    else
        data->current_file++;
#endif
    data->current_line=line;
}

winetest_skip()

void winetest_skip	(	const char *	msg,
			...
	)

winetest_start_flaky()

static void winetest_start_flaky ( int  is_flaky )

inlinestatic

Definition at line 464 of file test.h.

{
    struct winetest_thread_data *data = winetest_get_thread_data();
    data->flaky_level = (data->flaky_level << 1) | (is_flaky != 0);
    data->flaky_do_loop = 1;
}

winetest_start_todo()

static void winetest_start_todo ( int  is_todo )

inlinestatic

Definition at line 492 of file test.h.

{
    struct winetest_thread_data *data = winetest_get_thread_data();
    data->todo_level = (data->todo_level << 1) | (is_todo != 0);
    data->todo_do_loop=1;
}

winetest_subtest()

static void winetest_subtest ( const char *  name )

inlinestatic

Definition at line 276 of file test.h.

{
    struct winetest_thread_data* data = winetest_get_thread_data();
    fprintf(stdout, __winetest_file_line_prefix ": Subtest %s\n",
        data->current_file, data->current_line, name);
}

winetest_trace()

void void winetest_trace	(	const char *	msg,
			...
	)

winetest_vok()

static int winetest_vok ( int  condition, const char *  msg, va_list  args  )

static

Definition at line 332 of file test.h.

{
    struct winetest_thread_data *data = winetest_get_thread_data();
 
    if (data->todo_level)
    {
        if (condition)
        {
            winetest_print_context( "Test succeeded inside todo block: " );
            vfprintf(stdout, msg, args);
            if ((data->nocount_level & 2) == 0)
            InterlockedIncrement(&winetest_todo_failures);
            return 0;
        }
        else
        {
            /* show todos even if traces are disabled*/
            /*if (winetest_debug > 0)*/
            {
                winetest_print_context( "Test marked todo: " );
                vfprintf(stdout, msg, args);
            }
            if ((data->nocount_level & 1) == 0)
            InterlockedIncrement(&winetest_todo_successes);
            return 1;
        }
    }
    else
    {
        if (!condition)
        {
            winetest_print_context( "Test failed: " );
            vfprintf(stdout, msg, args);
            if ((data->nocount_level & 2) == 0)
            InterlockedIncrement(&winetest_failures);
            return 0;
        }
        else
        {
            if (winetest_report_success && (data->nocount_level & 1) == 0)
            {
                winetest_printf("Test succeeded\n");
            }
            if ((data->nocount_level & 1) == 0)
            InterlockedIncrement(&winetest_successes);
            return 1;
        }
    }
}

Referenced by winetest_ok(), and winetest_win_skip().

winetest_vprintf()

int winetest_vprintf	(	const char *	msg,
		va_list	args
	)

Referenced by winetest_print_location().

winetest_vskip()

void void static void winetest_vskip ( const char *  msg, va_list  args  )

static

Definition at line 410 of file test.h.

{
    winetest_print_context( "Tests skipped: " );
    vfprintf(stdout, msg, args);
    winetest_skipped++;
}

Referenced by winetest_skip(), and winetest_win_skip().

winetest_wait_child_process()

void winetest_wait_child_process

(

HANDLE

process

)

Referenced by START_TEST(), test_child_env(), test_cross_process(), test_NonExistentPath(), test_rawinput(), and TestStaticDestruct().

winetest_win_skip()

void static void winetest_win_skip ( const char *  msg,   ...  )

static

Definition at line 437 of file test.h.

{
    va_list valist;
    va_start(valist, msg);
    if ((strcmp(winetest_platform, "windows") == 0)
#if !defined(USE_WINE_TODOS) || defined(USE_WIN_SKIP)
    || (strcmp(winetest_platform, "reactos") == 0)
#endif
    )
        winetest_vskip(msg, valist);
    else
        winetest_vok(0, msg, valist);
    va_end(valist);
}

Variable Documentation

winetest_color

int winetest_color

extern

winetest_color_blue

const char winetest_color_blue[] = "\x1b[34m"

static

Definition at line 217 of file test.h.

winetest_color_bright_purple

const char winetest_color_bright_purple[] = "\x1b[1;95m"

static

Definition at line 219 of file test.h.

winetest_color_bright_red

const char winetest_color_bright_red[] = "\x1b[1;91m"

static

Definition at line 218 of file test.h.

winetest_color_dark_purple

const char winetest_color_dark_purple[] = "\x1b[35m"

static

Definition at line 214 of file test.h.

winetest_color_dark_red

const char winetest_color_dark_red[] = "\x1b[31m"

static

Definition at line 213 of file test.h.

winetest_color_green

const char winetest_color_green[] = "\x1b[32m"

static

Definition at line 215 of file test.h.

winetest_color_reset

const char winetest_color_reset[] = "\x1b[0m"

static

Definition at line 212 of file test.h.

winetest_color_yellow

const char winetest_color_yellow[] = "\x1b[33m"

static

Definition at line 216 of file test.h.

winetest_debug

int winetest_debug

extern

Referenced by winetest_add_line(), and winetest_trace().

winetest_failures

LONG winetest_failures

extern

Referenced by winetest_add_failures(), winetest_get_failures(), and winetest_vok().

winetest_flaky_failures

LONG winetest_flaky_failures

extern

winetest_interactive

int winetest_interactive

extern

winetest_last_time

int winetest_last_time

Definition at line 72 of file test.h.

Referenced by winetest_elapsed().

winetest_mute_threshold

int winetest_mute_threshold

extern

Referenced by winetest_add_line().

winetest_muted_skipped

LONG winetest_muted_skipped

extern

winetest_muted_todo_successes

LONG winetest_muted_todo_successes

extern

winetest_muted_traces

LONG winetest_muted_traces

extern

winetest_platform

const char* winetest_platform

extern

Referenced by broken(), and winetest_win_skip().

winetest_platform_is_wine

int winetest_platform_is_wine

extern

Referenced by test_connect_pin(), test_monitor_dpi(), and test_uia_com_event_handler_event_advisement().

winetest_report_flaky

int winetest_report_flaky

extern

winetest_report_success

int winetest_report_success

extern

Referenced by winetest_vok().

winetest_skipped

LONG winetest_skipped

extern

Referenced by winetest_vskip().

winetest_start_time

int winetest_start_time

extern

Referenced by winetest_elapsed().

winetest_successes

LONG winetest_successes

extern

Referenced by winetest_vok().

winetest_time

int winetest_time

extern

Referenced by winetest_elapsed().

winetest_todo_failures

LONG winetest_todo_failures

extern

Referenced by winetest_vok().

winetest_todo_successes

LONG winetest_todo_successes

extern

Referenced by winetest_vok().