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 <windef.h>
  26
  27 /* debug level */
  28 extern int winetest_debug;
  29
  30 /* running in interactive mode? */
  31 extern int winetest_interactive;
  32
  33 /* current platform */
  34 extern const char *winetest_platform;
  35
  36 extern void winetest_set_location( const char* file, int line );
  37 extern void winetest_start_todo( const char* platform );
  38 extern int winetest_loop_todo(void);
  39 extern void winetest_end_todo( const char* platform );
  40 extern int winetest_get_mainargs( char*** pargv );
  41
  42 #define START_TEST(name) void func_##name(void)
  43
  44 #ifdef __GNUC__
  45
  46 extern int winetest_ok( int condition, const char *msg, ... ) __attribute__((format (printf,2,3) ));
  47 extern void winetest_trace( const char *msg, ... ) __attribute__((format (printf,1,2)));
  48
  49 #else /* __GNUC__ */
  50
  51 extern int winetest_ok( int condition, const char *msg, ... );
  52 extern void winetest_trace( const char *msg, ... );
  53
  54 #endif /* __GNUC__ */
  55
  56 #define ok_(file, line)     (winetest_set_location(file, line), 0) ? 0 : winetest_ok
  57 #define trace_(file, line)  (winetest_set_location(file, line), 0) ? (void)0 : winetest_trace
  58
  59 #define ok     ok_(__FILE__, __LINE__)
  60 #define trace  trace_(__FILE__, __LINE__)
  61
  62 #define todo(platform) for (winetest_start_todo(platform); \
  63                             winetest_loop_todo(); \
  64                             winetest_end_todo(platform))
  65 #define todo_wine      todo("wine")
  66
  67
  68 /************************************************************************/
  69 /* Below is the implementation of the various functions, to be included
  70  * directly into the generated testlist.c file.
  71  * It is done that way so that the dlls can build the test routines with
  72  * different includes or flags if needed.
  73  */
  74
  75 #ifdef WINETEST_WANT_MAIN
  76
  77 /* debug level */
  78 int winetest_debug = 1;
  79
  80 /* interactive mode? */
  81 int winetest_interactive = 0;
  82
  83 /* current platform */
  84 const char *winetest_platform = "windows";
  85
  86 /* report successful tests (BOOL) */
  87 static int report_success = 0;
  88
  89 /* passing arguments around */
  90 static int winetest_argc;
  91 static char** winetest_argv;
  92
  93 static const struct test *current_test; /* test currently being run */
  94
  95 static LONG successes;       /* number of successful tests */
  96 static LONG failures;        /* number of failures */
  97 static LONG todo_successes;  /* number of successful tests inside todo block */
  98 static LONG todo_failures;   /* number of failures inside todo block */
  99
 100 /* The following data must be kept track of on a per-thread basis */
 101 typedef struct
 102 {
 103     const char* current_file;        /* file of current check */
 104     int current_line;                /* line of current check */
 105     int todo_level;                  /* current todo nesting level */
 106     int todo_do_loop;
 107 } tls_data;
 108 static DWORD tls_index;
 109
 110 static tls_data* get_tls_data(void)
 111 {
 112     tls_data* data;
 113     DWORD last_error;
 114
 115     last_error=GetLastError();
 116     data=TlsGetValue(tls_index);
 117     if (!data)
 118     {
 119         data=HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,sizeof(tls_data));
 120         TlsSetValue(tls_index,data);
 121     }
 122     SetLastError(last_error);
 123     return data;
 124 }
 125
 126 static void exit_process( int code )
 127 {
 128     fflush( stdout );
 129     ExitProcess( code );
 130 }
 131
 132
 133 void winetest_set_location( const char* file, int line )
 134 {
 135     tls_data* data=get_tls_data();
 136     data->current_file=strrchr(file,'/');
 137     if (data->current_file==NULL)
 138         data->current_file=strrchr(file,'\\');
 139     if (data->current_file==NULL)
 140         data->current_file=file;
 141     else
 142         data->current_file++;
 143     data->current_line=line;
 144 }
 145
 146 /*
 147  * Checks condition.
 148  * Parameters:
 149  *   - condition - condition to check;
 150  *   - msg test description;
 151  *   - file - test application source code file name of the check
 152  *   - line - test application source code file line number of the check
 153  * Return:
 154  *   0 if condition does not have the expected value, 1 otherwise
 155  */
 156 int winetest_ok( int condition, const char *msg, ... )
 157 {
 158     va_list valist;
 159     tls_data* data=get_tls_data();
 160
 161     if (data->todo_level)
 162     {
 163         if (condition)
 164         {
 165             fprintf( stdout, "%s:%d: Test succeeded inside todo block",
 166                      data->current_file, data->current_line );
 167             if (msg[0])
 168             {
 169                 va_start(valist, msg);
 170                 fprintf(stdout,": ");
 171                 vfprintf(stdout, msg, valist);
 172                 va_end(valist);
 173             }
 174             InterlockedIncrement(&todo_failures);
 175             return 0;
 176         }
 177         else InterlockedIncrement(&todo_successes);
 178     }
 179     else
 180     {
 181         if (!condition)
 182         {
 183             fprintf( stdout, "%s:%d: Test failed",
 184                      data->current_file, data->current_line );
 185             if (msg[0])
 186             {
 187                 va_start(valist, msg);
 188                 fprintf( stdout,": ");
 189                 vfprintf(stdout, msg, valist);
 190                 va_end(valist);
 191             }
 192             InterlockedIncrement(&failures);
 193             return 0;
 194         }
 195         else
 196         {
 197             if (report_success)
 198                 fprintf( stdout, "%s:%d: Test succeeded\n",
 199                          data->current_file, data->current_line);
 200             InterlockedIncrement(&successes);
 201         }
 202     }
 203     return 1;
 204 }
 205
 206 void winetest_trace( const char *msg, ... )
 207 {
 208     va_list valist;
 209     tls_data* data=get_tls_data();
 210
 211     if (winetest_debug > 0)
 212     {
 213         fprintf( stdout, "%s:%d:", data->current_file, data->current_line );
 214         va_start(valist, msg);
 215         vfprintf(stdout, msg, valist);
 216         va_end(valist);
 217     }
 218 }
 219
 220 void winetest_start_todo( const char* platform )
 221 {
 222     tls_data* data=get_tls_data();
 223     if (strcmp(winetest_platform,platform)==0)
 224         data->todo_level++;
 225     data->todo_do_loop=1;
 226 }
 227
 228 int winetest_loop_todo(void)
 229 {
 230     tls_data* data=get_tls_data();
 231     int do_loop=data->todo_do_loop;
 232     data->todo_do_loop=0;
 233     return do_loop;
 234 }
 235
 236 void winetest_end_todo( const char* platform )
 237 {
 238     if (strcmp(winetest_platform,platform)==0)
 239     {
 240         tls_data* data=get_tls_data();
 241         data->todo_level--;
 242     }
 243 }
 244
 245 int winetest_get_mainargs( char*** pargv )
 246 {
 247     *pargv = winetest_argv;
 248     return winetest_argc;
 249 }
 250
 251 /* Find a test by name */
 252 static const struct test *find_test( const char *name )
 253 {
 254     const struct test *test;
 255     const char *p;
 256     int len;
 257
 258     if ((p = strrchr( name, '/' ))) name = p + 1;
 259     if ((p = strrchr( name, '\\' ))) name = p + 1;
 260     len = strlen(name);
 261     if (len > 2 && !strcmp( name + len - 2, ".c" )) len -= 2;
 262
 263     for (test = winetest_testlist; test->name; test++)
 264     {
 265         if (!strncmp( test->name, name, len ) && !test->name[len]) break;
 266     }
 267     return test->name ? test : NULL;
 268 }
 269
 270
 271 /* Run a named test, and return exit status */
 272 static int run_test( const char *name )
 273 {
 274     const struct test *test;
 275     int status;
 276
 277     if (!(test = find_test( name )))
 278     {
 279         fprintf( stdout, "Fatal: test '%s' does not exist.\n", name );
 280         exit_process(1);
 281     }
 282     successes = failures = todo_successes = todo_failures = 0;
 283     tls_index=TlsAlloc();
 284     current_test = test;
 285     test->func();
 286
 287     if (winetest_debug)
 288     {
 289         fprintf( stdout, "%s: %ld tests executed, %ld marked as todo, %ld %s.\n",
 290                  name, successes + failures + todo_successes + todo_failures,
 291                  todo_successes, failures + todo_failures,
 292                  (failures + todo_failures != 1) ? "failures" : "failure" );
 293     }
 294     status = (failures + todo_failures < 255) ? failures + todo_failures : 255;
 295     return status;
 296 }
 297
 298
 299 /* Display usage and exit */
 300 static void usage( const char *argv0 )
 301 {
 302     const struct test *test;
 303
 304     fprintf( stdout, "Usage: %s test_name\n", argv0 );
 305     fprintf( stdout, "\nValid test names:\n" );
 306     for (test = winetest_testlist; test->name; test++) fprintf( stdout, "    %s\n", test->name );
 307     exit_process(1);
 308 }
 309
 310
 311 /* main function */
 312 int main( int argc, char **argv )
 313 {
 314     char *p;
 315
 316     winetest_argc = argc;
 317     winetest_argv = argv;
 318
 319     if ((p = getenv( "WINETEST_PLATFORM" ))) winetest_platform = p;
 320     if ((p = getenv( "WINETEST_DEBUG" ))) winetest_debug = atoi(p);
 321     if ((p = getenv( "WINETEST_INTERACTIVE" ))) winetest_interactive = atoi(p);
 322     if ((p = getenv( "WINETEST_REPORT_SUCCESS"))) report_success = atoi(p);
 323     if (!argv[1]) usage( argv[0] );
 324
 325     return run_test(argv[1]);
 326 }
 327
 328 #endif  /* WINETEST_WANT_MAIN */
 329
 330 #endif  /* __WINE_TEST_H */