programs/winetest/main.c

   1 /*
   2  * Wine Conformance Test EXE
   3  *
   4  * Copyright 2003 Jakob Eriksson   (for Solid Form Sweden AB)
   5  * Copyright 2003 Dimitrie O. Paun
   6  * Copyright 2003 Ferenc Wagner
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  *
  21  * This program is dedicated to Anna Lindh,
  22  * Swedish Minister of Foreign Affairs.
  23  * Anna was murdered September 11, 2003.
  24  *
  25  */
  26
  27 #include "config.h"
  28 #include "wine/port.h"
  29
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <errno.h>
  33 #ifdef HAVE_UNISTD_H
  34 #  include <unistd.h>
  35 #endif
  36 #include <windows.h>
  37
  38 #include "winetest.h"
  39
  40 #define TESTRESOURCE "USERDATA"
  41
  42 struct wine_test
  43 {
  44     char *name;
  45     int resource;
  46     int subtest_count;
  47     char **subtests;
  48     int is_elf;
  49     char *exename;
  50 };
  51
  52 struct rev_info
  53 {
  54     const char* file;
  55     const char* rev;
  56 };
  57
  58 static struct wine_test *wine_tests;
  59 static struct rev_info *rev_infos;
  60
  61 static const char *wineloader;
  62
  63 void print_version ()
  64 {
  65     OSVERSIONINFOEX ver;
  66     BOOL ext;
  67
  68     ver.dwOSVersionInfoSize = sizeof(OSVERSIONINFOEX);
  69     if (!(ext = GetVersionEx ((OSVERSIONINFO *) &ver)))
  70     {
  71         ver.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
  72         if (!GetVersionEx ((OSVERSIONINFO *) &ver))
  73             report (R_FATAL, "Can't get OS version.");
  74     }
  75
  76     xprintf ("    dwMajorVersion=%ld\n    dwMinorVersion=%ld\n"
  77              "    dwBuildNumber=%ld\n    PlatformId=%ld\n    szCSDVersion=%s\n",
  78              ver.dwMajorVersion, ver.dwMinorVersion, ver.dwBuildNumber,
  79              ver.dwPlatformId, ver.szCSDVersion);
  80
  81     if (!ext) return;
  82
  83     xprintf ("    wServicePackMajor=%d\n    wServicePackMinor=%d\n"
  84              "    wSuiteMask=%d\n    wProductType=%d\n    wReserved=%d\n",
  85              ver.wServicePackMajor, ver.wServicePackMinor, ver.wSuiteMask,
  86              ver.wProductType, ver.wReserved);
  87 }
  88
  89 static inline int is_dot_dir(const char* x)
  90 {
  91     return ((x[0] == '.') && ((x[1] == 0) || ((x[1] == '.') && (x[2] == 0))));
  92 }
  93
  94 void remove_dir (const char *dir)
  95 {
  96     HANDLE  hFind;
  97     WIN32_FIND_DATA wfd;
  98     char path[MAX_PATH];
  99     size_t dirlen = strlen (dir);
 100
 101     /* Make sure the directory exists before going further */
 102     memcpy (path, dir, dirlen);
 103     strcpy (path + dirlen++, "\\*");
 104     hFind = FindFirstFile (path, &wfd);
 105     if (hFind == INVALID_HANDLE_VALUE) return;
 106
 107     do {
 108         char *lp = wfd.cFileName;
 109
 110         if (!lp[0]) lp = wfd.cAlternateFileName; /* ? FIXME not (!lp) ? */
 111         if (is_dot_dir (lp)) continue;
 112         strcpy (path + dirlen, lp);
 113         if (FILE_ATTRIBUTE_DIRECTORY & wfd.dwFileAttributes)
 114             remove_dir(path);
 115         else if (!DeleteFile (path))
 116             report (R_WARNING, "Can't delete file %s: error %d",
 117                     path, GetLastError ());
 118     } while (FindNextFile (hFind, &wfd));
 119     FindClose (hFind);
 120     if (!RemoveDirectory (dir))
 121         report (R_WARNING, "Can't remove directory %s: error %d",
 122                 dir, GetLastError ());
 123 }
 124
 125 const char* get_test_source_file(const char* test, const char* subtest)
 126 {
 127     static const char* special_dirs[][2] = {
 128         { "gdi32", "gdi"}, { "kernel32", "kernel" },
 129         { "user32", "user" }, { "winspool.drv", "winspool" },
 130         { "ws2_32", "winsock" }, { 0, 0 }
 131     };
 132     static char buffer[MAX_PATH];
 133     int i;
 134
 135     for (i = 0; special_dirs[i][0]; i++) {
 136         if (strcmp(test, special_dirs[i][0]) == 0) {
 137             test = special_dirs[i][1];
 138             break;
 139         }
 140     }
 141
 142     snprintf(buffer, sizeof(buffer), "dlls/%s/tests/%s.c", test, subtest);
 143     return buffer;
 144 }
 145
 146 const char* get_file_rev(const char* file)
 147 {
 148     const struct rev_info* rev;
 149
 150     for(rev = rev_infos; rev->file; rev++) {
 151         if (strcmp(rev->file, file) == 0) return rev->rev;
 152     }
 153
 154     return "-";
 155 }
 156
 157 void extract_rev_infos ()
 158 {
 159     char revinfo[256], *p;
 160     int size = 0, i, len;
 161     HMODULE module = GetModuleHandle (NULL);
 162
 163     for (i = 0; TRUE; i++) {
 164         if (i >= size) {
 165             size += 100;
 166             rev_infos = xrealloc (rev_infos, size * sizeof (*rev_infos));
 167         }
 168         memset(rev_infos + i, 0, sizeof(rev_infos[i]));
 169
 170         len = LoadStringA (module, i + 30000, revinfo, sizeof(revinfo));
 171         if (len == 0) break; /* end of revision info */
 172         if (len >= sizeof(revinfo) - 1)
 173             report (R_FATAL, "Revision info too long.");
 174         if(!(p = strrchr(revinfo, ':')))
 175             report (R_FATAL, "Revision info malformed (i=%d)", i);
 176         *p = 0;
 177         rev_infos[i].file = strdup(revinfo);
 178         rev_infos[i].rev = strdup(p + 1);
 179     }
 180 }
 181
 182 void* extract_rcdata (int id, DWORD* size)
 183 {
 184     HRSRC rsrc;
 185     HGLOBAL hdl;
 186     LPVOID addr = NULL;
 187
 188     if (!(rsrc = FindResource (0, (LPTSTR)id, TESTRESOURCE)) ||
 189         !(*size = SizeofResource (0, rsrc)) ||
 190         !(hdl = LoadResource (0, rsrc)) ||
 191         !(addr = LockResource (hdl)))
 192         report (R_FATAL, "Can't extract test file of id %d: %d",
 193                 id, GetLastError ());
 194     return addr;
 195 }
 196
 197 /* Fills in the name, is_elf and exename fields */
 198 void
 199 extract_test (struct wine_test *test, const char *dir, int id)
 200 {
 201     BYTE* code;
 202     DWORD size;
 203     FILE* fout;
 204     int strlen, bufflen = 128;
 205     char *exepos;
 206
 207     code = extract_rcdata (id, &size);
 208     test->name = xmalloc (bufflen);
 209     while ((strlen = LoadStringA (NULL, id, test->name, bufflen))
 210            == bufflen - 1) {
 211         bufflen *= 2;
 212         test->name = xrealloc (test->name, bufflen);
 213     }
 214     if (!strlen) report (R_FATAL, "Can't read name of test %d.", id);
 215     test->exename = strmake (NULL, "%s/%s", dir, test->name);
 216     exepos = strstr (test->name, "_test.exe");
 217     if (!exepos) report (R_FATAL, "Not an .exe file: %s", test->name);
 218     *exepos = 0;
 219     test->name = xrealloc (test->name, exepos - test->name + 1);
 220     report (R_STEP, "Extracting: %s", test->name);
 221     test->is_elf = !memcmp (code+1, "ELF", 3);
 222
 223     if (!(fout = fopen (test->exename, "wb")) ||
 224         (fwrite (code, size, 1, fout) != 1) ||
 225         fclose (fout)) report (R_FATAL, "Failed to write file %s.",
 226                                test->exename);
 227 }
 228
 229 void
 230 get_subtests (const char *tempdir, struct wine_test *test, int id)
 231 {
 232     char *subname;
 233     FILE *subfile;
 234     size_t subsize, bytes_read, total;
 235     char *buffer, *index;
 236     const char header[] = "Valid test names:", seps[] = " \r\n";
 237     int oldstdout;
 238     const char *argv[] = {"wine", NULL, NULL};
 239     int allocated;
 240
 241     subname = tempnam (0, "sub");
 242     if (!subname) report (R_FATAL, "Can't name subtests file.");
 243     oldstdout = dup (1);
 244     if (-1 == oldstdout) report (R_FATAL, "Can't preserve stdout.");
 245     subfile = fopen (subname, "w+b");
 246     if (!subfile) report (R_FATAL, "Can't open subtests file.");
 247     if (-1 == dup2 (fileno (subfile), 1))
 248         report (R_FATAL, "Can't redirect output to subtests.");
 249     fclose (subfile);
 250
 251     extract_test (test, tempdir, id);
 252     argv[1] = test->exename;
 253     if (test->is_elf)
 254         spawnvp (_P_WAIT, wineloader, argv);
 255     else
 256         spawnvp (_P_WAIT, test->exename, argv+1);
 257     subsize = lseek (1, 0, SEEK_CUR);
 258     buffer = xmalloc (subsize+1);
 259
 260     lseek (1, 0, SEEK_SET);
 261     total = 0;
 262     while ((bytes_read = read (1, buffer + total, subsize - total))
 263                && (signed)bytes_read != -1)
 264             total += bytes_read;
 265     if (bytes_read)
 266         report (R_FATAL, "Can't get subtests of %s", test->name);
 267     buffer[total] = 0;
 268     index = strstr (buffer, header);
 269     if (!index)
 270         report (R_FATAL, "Can't parse subtests output of %s",
 271                 test->name);
 272     index += sizeof header;
 273
 274     allocated = 10;
 275     test->subtests = xmalloc (allocated * sizeof(char*));
 276     test->subtest_count = 0;
 277     index = strtok (index, seps);
 278     while (index) {
 279         if (test->subtest_count == allocated) {
 280             allocated *= 2;
 281             test->subtests = xrealloc (test->subtests,
 282                                        allocated * sizeof(char*));
 283         }
 284         test->subtests[test->subtest_count++] = strdup (index);
 285         index = strtok (NULL, seps);
 286     }
 287     test->subtests = xrealloc (test->subtests,
 288                                test->subtest_count * sizeof(char*));
 289     free (buffer);
 290     close (1);
 291     if (-1 == dup2 (oldstdout, 1))
 292         report (R_FATAL, "Can't recover old stdout.");
 293     close (oldstdout);
 294     if (remove (subname))
 295         report (R_FATAL, "Can't remove subtests file.");
 296     free (subname);
 297 }
 298
 299 /* Return number of failures, -1 if couldn't spawn process. */
 300 int run_test (struct wine_test* test, const char* subtest)
 301 {
 302     int status;
 303     const char* argv[] = {"wine", test->exename, subtest, NULL};
 304     const char* file = get_test_source_file(test->name, subtest);
 305     const char* rev = get_file_rev(file);
 306
 307     xprintf ("%s:%s start %s %s\n", test->name, subtest, file, rev);
 308     if (test->is_elf)
 309         status = spawnvp (_P_WAIT, wineloader, argv);
 310     else
 311         status = spawnvp (_P_WAIT, test->exename, argv+1);
 312     if (status == -1)
 313         xprintf ("Can't run: %d, errno=%d: %s\n",
 314                  status, errno, strerror (errno));
 315     xprintf ("%s:%s done (%d)\n", test->name, subtest, status);
 316     return status;
 317 }
 318
 319 BOOL CALLBACK
 320 EnumTestFileProc (HMODULE hModule, LPCTSTR lpszType,
 321                   LPTSTR lpszName, LONG_PTR lParam)
 322 {
 323     (*(int*)lParam)++;
 324     return TRUE;
 325 }
 326
 327 char *
 328 run_tests (char *logname, const char *tag)
 329 {
 330     int nr_of_files = 0, nr_of_tests = 0, i;
 331     char *tempdir;
 332     FILE *logfile;
 333     char build_tag[128];
 334
 335     SetErrorMode (SEM_FAILCRITICALERRORS);
 336
 337     if (!(wineloader = getenv("WINELOADER"))) wineloader = "wine";
 338     if (setvbuf (stdout, NULL, _IONBF, 0))
 339         report (R_FATAL, "Can't unbuffer output.");
 340
 341     tempdir = tempnam (0, "wct");
 342     if (!tempdir)
 343         report (R_FATAL, "Can't name temporary dir (check %%TEMP%%).");
 344     report (R_DIR, tempdir);
 345     if (!CreateDirectory (tempdir, NULL))
 346         report (R_FATAL, "Could not create directory: %s", tempdir);
 347
 348     if (!logname) {
 349         logname = tempnam (0, "res");
 350         if (!logname) report (R_FATAL, "Can't name logfile.");
 351     }
 352     report (R_OUT, logname);
 353
 354     logfile = fopen (logname, "a");
 355     if (!logfile) report (R_FATAL, "Could not open logfile.");
 356     if (-1 == dup2 (fileno (logfile), 1))
 357         report (R_FATAL, "Can't redirect stdout.");
 358     fclose (logfile);
 359
 360     xprintf ("Version 2\n");
 361     i = LoadStringA (GetModuleHandle (NULL), 0,
 362                      build_tag, sizeof build_tag);
 363     if (i == 0) report (R_FATAL, "Build descriptor not found: %d",
 364                         GetLastError ());
 365     if (i >= sizeof build_tag)
 366         report (R_FATAL, "Build descriptor too long.");
 367     xprintf ("Tests from build %s\n", build_tag);
 368     xprintf ("Tag: %s\n", tag?tag:"");
 369     xprintf ("Operating system version:\n");
 370     print_version ();
 371     xprintf ("Test output:\n" );
 372
 373     report (R_STATUS, "Counting tests");
 374     if (!EnumResourceNames (NULL, TESTRESOURCE,
 375                             EnumTestFileProc, (LPARAM)&nr_of_files))
 376         report (R_FATAL, "Can't enumerate test files: %d",
 377                 GetLastError ());
 378     wine_tests = xmalloc (nr_of_files * sizeof wine_tests[0]);
 379
 380     report (R_STATUS, "Extracting tests");
 381     report (R_PROGRESS, 0, nr_of_files);
 382     for (i = 0; i < nr_of_files; i++) {
 383         get_subtests (tempdir, wine_tests+i, i+1);
 384         nr_of_tests += wine_tests[i].subtest_count;
 385     }
 386     report (R_DELTA, 0, "Extracting: Done");
 387
 388     report (R_STATUS, "Running tests");
 389     report (R_PROGRESS, 1, nr_of_tests);
 390     for (i = 0; i < nr_of_files; i++) {
 391         struct wine_test *test = wine_tests + i;
 392         int j;
 393
 394         for (j = 0; j < test->subtest_count; j++) {
 395             report (R_STEP, "Running: %s:%s", test->name,
 396                     test->subtests[j]);
 397             run_test (test, test->subtests[j]);
 398         }
 399     }
 400     report (R_DELTA, 0, "Running: Done");
 401
 402     report (R_STATUS, "Cleaning up");
 403     close (1);
 404     remove_dir (tempdir);
 405     free (tempdir);
 406     free (wine_tests);
 407
 408     return logname;
 409 }
 410
 411 void
 412 usage ()
 413 {
 414     fprintf (stderr, "\
 415 Usage: winetest [OPTION]...\n\n\
 416   -c       console mode, no GUI\n\
 417   -h       print this message and exit\n\
 418   -q       quiet mode, no output at all\n\
 419   -o FILE  put report into FILE, do not submit\n\
 420   -s FILE  submit FILE, do not run tests\n\
 421   -t TAG   include TAG of characters [-.0-9a-zA-Z] in the report\n");
 422 }
 423
 424 /* One can't nest strtok()-s, so here is a replacement. */
 425 char *
 426 mystrtok (char *newstr)
 427 {
 428     static char *start, *end;
 429     static int finish = 1;
 430
 431     if (newstr) {
 432         start = newstr;
 433         finish = 0;
 434     } else start = end;
 435     if (finish) return NULL;
 436     while (*start == ' ') start++;
 437     if (*start == 0) return NULL;
 438     end = start;
 439     while (*end != ' ')
 440         if (*end == 0) {
 441             finish = 1;
 442             return start;
 443         } else end++;
 444     *end++ = 0;
 445     return start;
 446 }
 447
 448 int WINAPI WinMain (HINSTANCE hInst, HINSTANCE hPrevInst,
 449                     LPSTR cmdLine, int cmdShow)
 450 {
 451     char *logname = NULL;
 452     char *tag = NULL, *cp;
 453     const char *submit = NULL;
 454
 455     /* initialize the revision information first */
 456     extract_rev_infos();
 457
 458     cmdLine = mystrtok (cmdLine);
 459     while (cmdLine) {
 460         if (cmdLine[0] != '-' || cmdLine[2]) {
 461             report (R_ERROR, "Not a single letter option: %s", cmdLine);
 462             usage ();
 463             exit (2);
 464         }
 465         switch (cmdLine[1]) {
 466         case 'c':
 467             report (R_TEXTMODE);
 468             break;
 469         case 'h':
 470             usage ();
 471             exit (0);
 472         case 'q':
 473             report (R_QUIET);
 474             break;
 475         case 's':
 476             submit = mystrtok (NULL);
 477             if (tag)
 478                 report (R_WARNING, "ignoring tag for submit");
 479             send_file (submit);
 480             break;
 481         case 'o':
 482             logname = mystrtok (NULL);
 483             run_tests (logname, tag);
 484             break;
 485         case 't':
 486             tag = mystrtok (NULL);
 487             cp = badtagchar (tag);
 488             if (cp) {
 489                 report (R_ERROR, "invalid char in tag: %c", *cp);
 490                 usage ();
 491                 exit (2);
 492             }
 493             break;
 494         default:
 495             report (R_ERROR, "invalid option: -%c", cmdLine[1]);
 496             usage ();
 497             exit (2);
 498         }
 499         cmdLine = mystrtok (NULL);
 500     }
 501     if (!logname && !submit) {
 502         report (R_STATUS, "Starting up");
 503         logname = run_tests (NULL, tag);
 504         if (report (R_ASK, MB_YESNO, "Do you want to submit the "
 505                     "test results?") == IDYES)
 506             if (!send_file (logname) && remove (logname))
 507                 report (R_WARNING, "Can't remove logfile: %d.", errno);
 508         free (logname);
 509         report (R_STATUS, "Finished");
 510     }
 511     exit (0);
 512 }