git.oblomov.eu Git - wine/blob - include/wine/test.h

   1 /*
   2  * Definitions for Wine C unit tests.
   3  *
   4  * Copyright (C) 2002 Alexandre Julliard
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #ifndef __WINE_TEST_H
  22 #define __WINE_TEST_H
  23
  24 #include <stdarg.h>
  25 #include <stdlib.h>
  26 #include <windef.h>
  27 #include <winbase.h>
  28
  29 /* debug level */
  30 extern int winetest_debug;
  31
  32 /* running in interactive mode? */
  33 extern int winetest_interactive;
  34
  35 /* current platform */
  36 extern const char *winetest_platform;
  37
  38 extern void winetest_set_location( const char* file, int line );
  39 extern void winetest_start_todo( const char* platform );
  40 extern int winetest_loop_todo(void);
  41 extern void winetest_end_todo( const char* platform );
  42 extern int winetest_get_mainargs( char*** pargv );
  43
  44 #ifdef STANDALONE
  45 #define START_TEST(name) \
  46   static void func_##name(void); \
  47   const struct test winetest_testlist[] = { { #name, func_##name }, { 0, 0 } }; \
  48   static void func_##name(void)
  49 #else
  50 #define START_TEST(name) void func_##name(void)
  51 #endif
  52
  53 #ifdef __GNUC__
  54
  55 extern int winetest_ok( int condition, const char *msg, ... ) __attribute__((format (printf,2,3) ));
  56 extern void winetest_trace( const char *msg, ... ) __attribute__((format (printf,1,2)));
  57
  58 #else /* __GNUC__ */
  59
  60 extern int winetest_ok( int condition, const char *msg, ... );
  61 extern void winetest_trace( const char *msg, ... );
  62
  63 #endif /* __GNUC__ */
  64
  65 #define ok_(file, line)     (winetest_set_location(file, line), 0) ? 0 : winetest_ok
  66 #define trace_(file, line)  (winetest_set_location(file, line), 0) ? (void)0 : winetest_trace
  67
  68 #define ok     ok_(__FILE__, __LINE__)
  69 #define trace  trace_(__FILE__, __LINE__)
  70
  71 #define todo(platform) for (winetest_start_todo(platform); \
  72                             winetest_loop_todo(); \
  73                             winetest_end_todo(platform))
  74 #define todo_wine      todo("wine")
  75
  76
  77 #ifdef NONAMELESSUNION
  78 # define U(x)  (x).u
  79 # define U1(x) (x).u1
  80 # define U2(x) (x).u2
  81 # define U3(x) (x).u3
  82 # define U4(x) (x).u4
  83 # define U5(x) (x).u5
  84 # define U6(x) (x).u6
  85 # define U7(x) (x).u7
  86 # define U8(x) (x).u8
  87 #else
  88 # define U(x)  (x)
  89 # define U1(x) (x)
  90 # define U2(x) (x)
  91 # define U3(x) (x)
  92 # define U4(x) (x)
  93 # define U5(x) (x)
  94 # define U6(x) (x)
  95 # define U7(x) (x)
  96 # define U8(x) (x)
  97 #endif
  98
  99 #ifdef NONAMELESSSTRUCT
 100 # define S(x)  (x).s
 101 # define S1(x) (x).s1
 102 # define S2(x) (x).s2
 103 # define S3(x) (x).s3
 104 # define S4(x) (x).s4
 105 # define S5(x) (x).s5
 106 #else
 107 # define S(x)  (x)
 108 # define S1(x) (x)
 109 # define S2(x) (x)
 110 # define S3(x) (x)
 111 # define S4(x) (x)
 112 # define S5(x) (x)
 113 #endif
 114
 115
 116 /************************************************************************/
 117 /* Below is the implementation of the various functions, to be included
 118  * directly into the generated testlist.c file.
 119  * It is done that way so that the dlls can build the test routines with
 120  * different includes or flags if needed.
 121  */
 122
 123 #ifdef STANDALONE
 124
 125 #include <stdio.h>
 126
 127 struct test
 128 {
 129     const char *name;
 130     void (*func)(void);
 131 };
 132
 133 extern const struct test winetest_testlist[];
 134
 135 /* debug level */
 136 int winetest_debug = 1;
 137
 138 /* interactive mode? */
 139 int winetest_interactive = 0;
 140
 141 /* current platform */
 142 const char *winetest_platform = "windows";
 143
 144 /* report successful tests (BOOL) */
 145 static int report_success = 0;
 146
 147 /* passing arguments around */
 148 static int winetest_argc;
 149 static char** winetest_argv;
 150
 151 static const struct test *current_test; /* test currently being run */
 152
 153 static LONG successes;       /* number of successful tests */
 154 static LONG failures;        /* number of failures */
 155 static LONG todo_successes;  /* number of successful tests inside todo block */
 156 static LONG todo_failures;   /* number of failures inside todo block */
 157
 158 /* The following data must be kept track of on a per-thread basis */
 159 typedef struct
 160 {
 161     const char* current_file;        /* file of current check */
 162     int current_line;                /* line of current check */
 163     int todo_level;                  /* current todo nesting level */
 164     int todo_do_loop;
 165 } tls_data;
 166 static DWORD tls_index;
 167
 168 static tls_data* get_tls_data(void)
 169 {
 170     tls_data* data;
 171     DWORD last_error;
 172
 173     last_error=GetLastError();
 174     data=TlsGetValue(tls_index);
 175     if (!data)
 176     {
 177         data=HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,sizeof(tls_data));
 178         TlsSetValue(tls_index,data);
 179     }
 180     SetLastError(last_error);
 181     return data;
 182 }
 183
 184 static void exit_process( int code )
 185 {
 186     fflush( stdout );
 187     ExitProcess( code );
 188 }
 189
 190
 191 void winetest_set_location( const char* file, int line )
 192 {
 193     tls_data* data=get_tls_data();
 194     data->current_file=strrchr(file,'/');
 195     if (data->current_file==NULL)
 196         data->current_file=strrchr(file,'\\');
 197     if (data->current_file==NULL)
 198         data->current_file=file;
 199     else
 200         data->current_file++;
 201     data->current_line=line;
 202 }
 203
 204 /*
 205  * Checks condition.
 206  * Parameters:
 207  *   - condition - condition to check;
 208  *   - msg test description;
 209  *   - file - test application source code file name of the check
 210  *   - line - test application source code file line number of the check
 211  * Return:
 212  *   0 if condition does not have the expected value, 1 otherwise
 213  */
 214 int winetest_ok( int condition, const char *msg, ... )
 215 {
 216     va_list valist;
 217     tls_data* data=get_tls_data();
 218
 219     if (data->todo_level)
 220     {
 221         if (condition)
 222         {
 223             fprintf( stdout, "%s:%d: Test succeeded inside todo block",
 224                      data->current_file, data->current_line );
 225             if (msg[0])
 226             {
 227                 va_start(valist, msg);
 228                 fprintf(stdout,": ");
 229                 vfprintf(stdout, msg, valist);
 230                 va_end(valist);
 231             }
 232             InterlockedIncrement(&todo_failures);
 233             return 0;
 234         }
 235         else InterlockedIncrement(&todo_successes);
 236     }
 237     else
 238     {
 239         if (!condition)
 240         {
 241             fprintf( stdout, "%s:%d: Test failed",
 242                      data->current_file, data->current_line );
 243             if (msg[0])
 244             {
 245                 va_start(valist, msg);
 246                 fprintf( stdout,": ");
 247                 vfprintf(stdout, msg, valist);
 248                 va_end(valist);
 249             }
 250             InterlockedIncrement(&failures);
 251             return 0;
 252         }
 253         else
 254         {
 255             if (report_success)
 256                 fprintf( stdout, "%s:%d: Test succeeded\n",
 257                          data->current_file, data->current_line);
 258             InterlockedIncrement(&successes);
 259         }
 260     }
 261     return 1;
 262 }
 263
 264 void winetest_trace( const char *msg, ... )
 265 {
 266     va_list valist;
 267     tls_data* data=get_tls_data();
 268
 269     if (winetest_debug > 0)
 270     {
 271         fprintf( stdout, "%s:%d:", data->current_file, data->current_line );
 272         va_start(valist, msg);
 273         vfprintf(stdout, msg, valist);
 274         va_end(valist);
 275     }
 276 }
 277
 278 void winetest_start_todo( const char* platform )
 279 {
 280     tls_data* data=get_tls_data();
 281     if (strcmp(winetest_platform,platform)==0)
 282         data->todo_level++;
 283     data->todo_do_loop=1;
 284 }
 285
 286 int winetest_loop_todo(void)
 287 {
 288     tls_data* data=get_tls_data();
 289     int do_loop=data->todo_do_loop;
 290     data->todo_do_loop=0;
 291     return do_loop;
 292 }
 293
 294 void winetest_end_todo( const char* platform )
 295 {
 296     if (strcmp(winetest_platform,platform)==0)
 297     {
 298         tls_data* data=get_tls_data();
 299         data->todo_level--;
 300     }
 301 }
 302
 303 int winetest_get_mainargs( char*** pargv )
 304 {
 305     *pargv = winetest_argv;
 306     return winetest_argc;
 307 }
 308
 309 /* Find a test by name */
 310 static const struct test *find_test( const char *name )
 311 {
 312     const struct test *test;
 313     const char *p;
 314     int len;
 315
 316     if ((p = strrchr( name, '/' ))) name = p + 1;
 317     if ((p = strrchr( name, '\\' ))) name = p + 1;
 318     len = strlen(name);
 319     if (len > 2 && !strcmp( name + len - 2, ".c" )) len -= 2;
 320
 321     for (test = winetest_testlist; test->name; test++)
 322     {
 323         if (!strncmp( test->name, name, len ) && !test->name[len]) break;
 324     }
 325     return test->name ? test : NULL;
 326 }
 327
 328
 329 /* Display list of valid tests */
 330 static void list_tests(void)
 331 {
 332     const struct test *test;
 333
 334     fprintf( stdout, "Valid test names:\n" );
 335     for (test = winetest_testlist; test->name; test++) fprintf( stdout, "    %s\n", test->name );
 336 }
 337
 338
 339 /* Run a named test, and return exit status */
 340 static int run_test( const char *name )
 341 {
 342     const struct test *test;
 343     int status;
 344
 345     if (!(test = find_test( name )))
 346     {
 347         fprintf( stdout, "Fatal: test '%s' does not exist.\n", name );
 348         exit_process(1);
 349     }
 350     successes = failures = todo_successes = todo_failures = 0;
 351     tls_index=TlsAlloc();
 352     current_test = test;
 353     test->func();
 354
 355     if (winetest_debug)
 356     {
 357         fprintf( stdout, "%s: %ld tests executed, %ld marked as todo, %ld %s.\n",
 358                  name, successes + failures + todo_successes + todo_failures,
 359                  todo_successes, failures + todo_failures,
 360                  (failures + todo_failures != 1) ? "failures" : "failure" );
 361     }
 362     status = (failures + todo_failures < 255) ? failures + todo_failures : 255;
 363     return status;
 364 }
 365
 366
 367 /* Display usage and exit */
 368 static void usage( const char *argv0 )
 369 {
 370     fprintf( stdout, "Usage: %s test_name\n\n", argv0 );
 371     list_tests();
 372     exit_process(1);
 373 }
 374
 375
 376 /* main function */
 377 int main( int argc, char **argv )
 378 {
 379     char *p;
 380
 381     setvbuf (stdout, NULL, _IONBF, 0);
 382
 383     winetest_argc = argc;
 384     winetest_argv = argv;
 385
 386     if ((p = getenv( "WINETEST_PLATFORM" ))) winetest_platform = p;
 387     if ((p = getenv( "WINETEST_DEBUG" ))) winetest_debug = atoi(p);
 388     if ((p = getenv( "WINETEST_INTERACTIVE" ))) winetest_interactive = atoi(p);
 389     if ((p = getenv( "WINETEST_REPORT_SUCCESS"))) report_success = atoi(p);
 390     if (!argv[1])
 391     {
 392         if (winetest_testlist[0].name && !winetest_testlist[1].name)  /* only one test */
 393             return run_test( winetest_testlist[0].name );
 394         usage( argv[0] );
 395     }
 396     if (!strcmp( argv[1], "--list" ))
 397     {
 398         list_tests();
 399         return 0;
 400     }
 401     return run_test(argv[1]);
 402 }
 403
 404 #endif  /* STANDALONE */
 405
 406 #endif  /* __WINE_TEST_H */