Use the same maximum length for tags given on the command line and
[wine] / programs / winetest / main.c
1 /*
2  * Wine Conformance Test EXE
3  *
4  * Copyright 2003, 2004 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  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  *
22  * This program is dedicated to Anna Lindh,
23  * Swedish Minister of Foreign Affairs.
24  * Anna was murdered September 11, 2003.
25  *
26  */
27
28 #include "config.h"
29 #include "wine/port.h"
30
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <assert.h>
34 #include <errno.h>
35 #ifdef HAVE_UNISTD_H
36 #  include <unistd.h>
37 #endif
38 #include <windows.h>
39
40 #include "winetest.h"
41 #include "resource.h"
42
43 struct wine_test
44 {
45     char *name;
46     int resource;
47     int subtest_count;
48     char **subtests;
49     char *exename;
50 };
51
52 struct rev_info
53 {
54     const char* file;
55     const char* rev;
56 };
57
58 char *tag = NULL;
59 static struct wine_test *wine_tests;
60 static struct rev_info *rev_infos = NULL;
61 static const char whitespace[] = " \t\r\n";
62
63 static int running_under_wine ()
64 {
65     HMODULE module = GetModuleHandleA("ntdll.dll");
66
67     if (!module) return 0;
68     return (GetProcAddress(module, "wine_server_call") != NULL);
69 }
70
71 static int running_on_visible_desktop ()
72 {
73     HWND desktop;
74     HMODULE huser32 = GetModuleHandle("user32.dll");
75     FARPROC pGetProcessWindowStation = GetProcAddress(huser32, "GetProcessWindowStation");
76     FARPROC pGetUserObjectInformationA = GetProcAddress(huser32, "GetUserObjectInformationA");
77
78     desktop = GetDesktopWindow();
79     if (!GetWindowLongPtrW(desktop, GWLP_WNDPROC)) /* Win9x */
80         return IsWindowVisible(desktop);
81
82     if (pGetProcessWindowStation && pGetUserObjectInformationA)
83     {
84         DWORD len;
85         HWINSTA wstation;
86         USEROBJECTFLAGS uoflags;
87
88         wstation = (HWINSTA)pGetProcessWindowStation();
89         assert(pGetUserObjectInformationA(wstation, UOI_FLAGS, &uoflags, sizeof(uoflags), &len));
90         return (uoflags.dwFlags & WSF_VISIBLE) != 0;
91     }
92     return IsWindowVisible(desktop);
93 }
94
95 void print_version ()
96 {
97     OSVERSIONINFOEX ver;
98     BOOL ext;
99
100     ver.dwOSVersionInfoSize = sizeof(OSVERSIONINFOEX);
101     if (!(ext = GetVersionEx ((OSVERSIONINFO *) &ver)))
102     {
103         ver.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
104         if (!GetVersionEx ((OSVERSIONINFO *) &ver))
105             report (R_FATAL, "Can't get OS version.");
106     }
107
108     xprintf ("    bRunningUnderWine=%d\n", running_under_wine ());
109     xprintf ("    bRunningOnVisibleDesktop=%d\n", running_on_visible_desktop ());
110     xprintf ("    dwMajorVersion=%ld\n    dwMinorVersion=%ld\n"
111              "    dwBuildNumber=%ld\n    PlatformId=%ld\n    szCSDVersion=%s\n",
112              ver.dwMajorVersion, ver.dwMinorVersion, ver.dwBuildNumber,
113              ver.dwPlatformId, ver.szCSDVersion);
114
115     if (!ext) return;
116
117     xprintf ("    wServicePackMajor=%d\n    wServicePackMinor=%d\n"
118              "    wSuiteMask=%d\n    wProductType=%d\n    wReserved=%d\n",
119              ver.wServicePackMajor, ver.wServicePackMinor, ver.wSuiteMask,
120              ver.wProductType, ver.wReserved);
121 }
122
123 static inline int is_dot_dir(const char* x)
124 {
125     return ((x[0] == '.') && ((x[1] == 0) || ((x[1] == '.') && (x[2] == 0))));
126 }
127
128 void remove_dir (const char *dir)
129 {
130     HANDLE  hFind;
131     WIN32_FIND_DATA wfd;
132     char path[MAX_PATH];
133     size_t dirlen = strlen (dir);
134
135     /* Make sure the directory exists before going further */
136     memcpy (path, dir, dirlen);
137     strcpy (path + dirlen++, "\\*");
138     hFind = FindFirstFile (path, &wfd);
139     if (hFind == INVALID_HANDLE_VALUE) return;
140
141     do {
142         char *lp = wfd.cFileName;
143
144         if (!lp[0]) lp = wfd.cAlternateFileName; /* ? FIXME not (!lp) ? */
145         if (is_dot_dir (lp)) continue;
146         strcpy (path + dirlen, lp);
147         if (FILE_ATTRIBUTE_DIRECTORY & wfd.dwFileAttributes)
148             remove_dir(path);
149         else if (!DeleteFile (path))
150             report (R_WARNING, "Can't delete file %s: error %d",
151                     path, GetLastError ());
152     } while (FindNextFile (hFind, &wfd));
153     FindClose (hFind);
154     if (!RemoveDirectory (dir))
155         report (R_WARNING, "Can't remove directory %s: error %d",
156                 dir, GetLastError ());
157 }
158
159 const char* get_test_source_file(const char* test, const char* subtest)
160 {
161     static const char* special_dirs[][2] = {
162         { "gdi32", "gdi"}, { "kernel32", "kernel" },
163         { "msacm32", "msacm" },
164         { "user32", "user" }, { "winspool.drv", "winspool" },
165         { "ws2_32", "winsock" }, { 0, 0 }
166     };
167     static char buffer[MAX_PATH];
168     int i;
169
170     for (i = 0; special_dirs[i][0]; i++) {
171         if (strcmp(test, special_dirs[i][0]) == 0) {
172             test = special_dirs[i][1];
173             break;
174         }
175     }
176
177     snprintf(buffer, sizeof(buffer), "dlls/%s/tests/%s.c", test, subtest);
178     return buffer;
179 }
180
181 const char* get_file_rev(const char* file)
182 {
183     const struct rev_info* rev;
184  
185     for(rev = rev_infos; rev->file; rev++) {
186         if (strcmp(rev->file, file) == 0) return rev->rev;
187     }
188
189     return "-";
190 }
191
192 void extract_rev_infos ()
193 {
194     char revinfo[256], *p;
195     int size = 0, i;
196     unsigned int len;
197     HMODULE module = GetModuleHandle (NULL);
198
199     for (i = 0; TRUE; i++) {
200         if (i >= size) {
201             size += 100;
202             rev_infos = xrealloc (rev_infos, size * sizeof (*rev_infos));
203         }
204         memset(rev_infos + i, 0, sizeof(rev_infos[i]));
205
206         len = LoadStringA (module, REV_INFO+i, revinfo, sizeof(revinfo));
207         if (len == 0) break; /* end of revision info */
208         if (len >= sizeof(revinfo) - 1) 
209             report (R_FATAL, "Revision info too long.");
210         if(!(p = strrchr(revinfo, ':')))
211             report (R_FATAL, "Revision info malformed (i=%d)", i);
212         *p = 0;
213         rev_infos[i].file = strdup(revinfo);
214         rev_infos[i].rev = strdup(p + 1);
215     }
216 }
217
218 void* extract_rcdata (int id, int type, DWORD* size)
219 {
220     HRSRC rsrc;
221     HGLOBAL hdl;
222     LPVOID addr;
223     
224     if (!(rsrc = FindResource (NULL, (LPTSTR)id, MAKEINTRESOURCE(type))) ||
225         !(*size = SizeofResource (0, rsrc)) ||
226         !(hdl = LoadResource (0, rsrc)) ||
227         !(addr = LockResource (hdl)))
228         return NULL;
229     return addr;
230 }
231
232 /* Fills in the name and exename fields */
233 void
234 extract_test (struct wine_test *test, const char *dir, int id)
235 {
236     BYTE* code;
237     DWORD size;
238     FILE* fout;
239     int strlen, bufflen = 128;
240     char *exepos;
241
242     code = extract_rcdata (id, TESTRES, &size);
243     if (!code) report (R_FATAL, "Can't find test resource %d: %d",
244                        id, GetLastError ());
245     test->name = xmalloc (bufflen);
246     while ((strlen = LoadStringA (NULL, id, test->name, bufflen))
247            == bufflen - 1) {
248         bufflen *= 2;
249         test->name = xrealloc (test->name, bufflen);
250     }
251     if (!strlen) report (R_FATAL, "Can't read name of test %d.", id);
252     test->exename = strmake (NULL, "%s/%s", dir, test->name);
253     exepos = strstr (test->name, "_test.exe");
254     if (!exepos) report (R_FATAL, "Not an .exe file: %s", test->name);
255     *exepos = 0;
256     test->name = xrealloc (test->name, exepos - test->name + 1);
257     report (R_STEP, "Extracting: %s", test->name);
258
259     if (!(fout = fopen (test->exename, "wb")) ||
260         (fwrite (code, size, 1, fout) != 1) ||
261         fclose (fout)) report (R_FATAL, "Failed to write file %s.",
262                                test->exename);
263 }
264
265 /* Run a command for MS milliseconds.  If OUT != NULL, also redirect
266    stdout to there.
267
268    Return the exit status, -2 if can't create process or the return
269    value of WaitForSingleObject.
270  */
271 int
272 run_ex (char *cmd, const char *out, DWORD ms)
273 {
274     STARTUPINFO si;
275     PROCESS_INFORMATION pi;
276     int fd, oldstdout = -1;
277     DWORD wait, status;
278
279     GetStartupInfo (&si);
280     si.wShowWindow = SW_HIDE;
281     si.dwFlags = STARTF_USESHOWWINDOW;
282
283     if (out) {
284         fd = open (out, O_WRONLY | O_CREAT, 0666);
285         if (-1 == fd)
286             report (R_FATAL, "Can't open '%s': %d", out, errno);
287         oldstdout = dup (1);
288         if (-1 == oldstdout)
289             report (R_FATAL, "Can't save stdout: %d", errno);
290         if (-1 == dup2 (fd, 1))
291             report (R_FATAL, "Can't redirect stdout: %d", errno);
292         close (fd);
293     }
294
295     if (!CreateProcessA (NULL, cmd, NULL, NULL, TRUE, 0,
296                          NULL, NULL, &si, &pi)) {
297         status = -2;
298     } else {
299         CloseHandle (pi.hThread);
300         wait = WaitForSingleObject (pi.hProcess, ms);
301         if (wait == WAIT_OBJECT_0) {
302             GetExitCodeProcess (pi.hProcess, &status);
303         } else {
304             switch (wait) {
305             case WAIT_FAILED:
306                 report (R_ERROR, "Wait for '%s' failed: %d", cmd,
307                         GetLastError ());
308                 break;
309             case WAIT_TIMEOUT:
310                 report (R_ERROR, "Process '%s' timed out.", cmd);
311                 break;
312             default:
313                 report (R_ERROR, "Wait returned %d", wait);
314             }
315             status = wait;
316             if (!TerminateProcess (pi.hProcess, 257))
317                 report (R_ERROR, "TerminateProcess failed: %d",
318                         GetLastError ());
319             wait = WaitForSingleObject (pi.hProcess, 5000);
320             switch (wait) {
321             case WAIT_FAILED:
322                 report (R_ERROR,
323                         "Wait for termination of '%s' failed: %d",
324                         cmd, GetLastError ());
325                 break;
326             case WAIT_OBJECT_0:
327                 break;
328             case WAIT_TIMEOUT:
329                 report (R_ERROR, "Can't kill process '%s'", cmd);
330                 break;
331             default:
332                 report (R_ERROR, "Waiting for termination: %d",
333                         wait);
334             }
335         }
336         CloseHandle (pi.hProcess);
337     }
338
339     if (out) {
340         close (1);
341         if (-1 == dup2 (oldstdout, 1))
342             report (R_FATAL, "Can't recover stdout: %d", errno);
343         close (oldstdout);
344     }
345     return status;
346 }
347
348 void
349 get_subtests (const char *tempdir, struct wine_test *test, int id)
350 {
351     char *subname;
352     FILE *subfile;
353     size_t total;
354     char buffer[8192], *index;
355     static const char header[] = "Valid test names:";
356     int allocated;
357
358     test->subtest_count = 0;
359
360     subname = tempnam (0, "sub");
361     if (!subname) report (R_FATAL, "Can't name subtests file.");
362
363     extract_test (test, tempdir, id);
364     run_ex (test->exename, subname, 5000);
365
366     subfile = fopen (subname, "r");
367     if (!subfile) {
368         report (R_ERROR, "Can't open subtests output of %s: %d",
369                 test->name, errno);
370         goto quit;
371     }
372     total = fread (buffer, 1, sizeof buffer, subfile);
373     fclose (subfile);
374     if (sizeof buffer == total) {
375         report (R_ERROR, "Subtest list of %s too big.",
376                 test->name, sizeof buffer);
377         goto quit;
378     }
379     buffer[total] = 0;
380
381     index = strstr (buffer, header);
382     if (!index) {
383         report (R_ERROR, "Can't parse subtests output of %s",
384                 test->name);
385         goto quit;
386     }
387     index += sizeof header;
388
389     allocated = 10;
390     test->subtests = xmalloc (allocated * sizeof(char*));
391     index = strtok (index, whitespace);
392     while (index) {
393         if (test->subtest_count == allocated) {
394             allocated *= 2;
395             test->subtests = xrealloc (test->subtests,
396                                        allocated * sizeof(char*));
397         }
398         test->subtests[test->subtest_count++] = strdup (index);
399         index = strtok (NULL, whitespace);
400     }
401     test->subtests = xrealloc (test->subtests,
402                                test->subtest_count * sizeof(char*));
403
404  quit:
405     if (remove (subname))
406         report (R_WARNING, "Can't delete file '%s': %d",
407                 subname, errno);
408     free (subname);
409 }
410
411 void
412 run_test (struct wine_test* test, const char* subtest)
413 {
414     int status;
415     const char* file = get_test_source_file(test->name, subtest);
416     const char* rev = get_file_rev(file);
417     char *cmd = strmake (NULL, "%s %s", test->exename, subtest);
418
419     xprintf ("%s:%s start %s %s\n", test->name, subtest, file, rev);
420     status = run_ex (cmd, NULL, 120000);
421     free (cmd);
422     xprintf ("%s:%s done (%d)\n", test->name, subtest, status);
423 }
424
425 BOOL CALLBACK
426 EnumTestFileProc (HMODULE hModule, LPCTSTR lpszType,
427                   LPTSTR lpszName, LONG_PTR lParam)
428 {
429     (*(int*)lParam)++;
430     return TRUE;
431 }
432
433 char *
434 run_tests (char *logname)
435 {
436     int nr_of_files = 0, nr_of_tests = 0, i;
437     char *tempdir, *shorttempdir;
438     int logfile;
439     char *strres, *eol, *nextline;
440     DWORD strsize;
441
442     SetErrorMode (SEM_FAILCRITICALERRORS | SEM_NOGPFAULTERRORBOX);
443
444     if (!logname) {
445         logname = tempnam (0, "res");
446         if (!logname) report (R_FATAL, "Can't name logfile.");
447     }
448     report (R_OUT, logname);
449
450     logfile = open (logname, O_WRONLY | O_CREAT | O_EXCL | O_APPEND,
451                     0666);
452     if (-1 == logfile) {
453         if (EEXIST == errno)
454             report (R_FATAL, "File %s already exists.", logname);
455         else report (R_FATAL, "Could not open logfile: %d", errno);
456     }
457     if (-1 == dup2 (logfile, 1))
458         report (R_FATAL, "Can't redirect stdout: %d", errno);
459     close (logfile);
460
461     tempdir = tempnam (0, "wct");
462     if (!tempdir)
463         report (R_FATAL, "Can't name temporary dir (check %%TEMP%%).");
464     shorttempdir = strdup (tempdir);
465     if (shorttempdir) {         /* try stable path for ZoneAlarm */
466         strstr (shorttempdir, "wct")[3] = 0;
467         if (CreateDirectoryA (shorttempdir, NULL)) {
468             free (tempdir);
469             tempdir = shorttempdir;
470         } else free (shorttempdir);
471     }
472     if (tempdir != shorttempdir && !CreateDirectoryA (tempdir, NULL))
473         report (R_FATAL, "Could not create directory: %s", tempdir);
474     report (R_DIR, tempdir);
475
476     xprintf ("Version 3\n");
477     strres = extract_rcdata (WINE_BUILD, STRINGRES, &strsize);
478     xprintf ("Tests from build ");
479     if (strres) xprintf ("%.*s", strsize, strres);
480     else xprintf ("-\n");
481     strres = extract_rcdata (TESTS_URL, STRINGRES, &strsize);
482     xprintf ("Archive: ");
483     if (strres) xprintf ("%.*s", strsize, strres);
484     else xprintf ("-\n");
485     xprintf ("Tag: %s\n", tag);
486     xprintf ("Build info:\n");
487     strres = extract_rcdata (BUILD_INFO, STRINGRES, &strsize);
488     while (strres) {
489         eol = memchr (strres, '\n', strsize);
490         if (!eol) {
491             nextline = NULL;
492             eol = strres + strsize;
493         } else {
494             strsize -= eol - strres + 1;
495             nextline = strsize?eol+1:NULL;
496             if (eol > strres && *(eol-1) == '\r') eol--;
497         }
498         xprintf ("    %.*s\n", eol-strres, strres);
499         strres = nextline;
500     }
501     xprintf ("Operating system version:\n");
502     print_version ();
503     xprintf ("Test output:\n" );
504
505     report (R_STATUS, "Counting tests");
506     if (!EnumResourceNames (NULL, MAKEINTRESOURCE(TESTRES),
507                             EnumTestFileProc, (LPARAM)&nr_of_files))
508         report (R_FATAL, "Can't enumerate test files: %d",
509                 GetLastError ());
510     wine_tests = xmalloc (nr_of_files * sizeof wine_tests[0]);
511
512     report (R_STATUS, "Extracting tests");
513     report (R_PROGRESS, 0, nr_of_files);
514     for (i = 0; i < nr_of_files; i++) {
515         get_subtests (tempdir, wine_tests+i, i);
516         nr_of_tests += wine_tests[i].subtest_count;
517     }
518     report (R_DELTA, 0, "Extracting: Done");
519
520     report (R_STATUS, "Running tests");
521     report (R_PROGRESS, 1, nr_of_tests);
522     for (i = 0; i < nr_of_files; i++) {
523         struct wine_test *test = wine_tests + i;
524         int j;
525
526         for (j = 0; j < test->subtest_count; j++) {
527             report (R_STEP, "Running: %s:%s", test->name,
528                     test->subtests[j]);
529             run_test (test, test->subtests[j]);
530         }
531     }
532     report (R_DELTA, 0, "Running: Done");
533
534     report (R_STATUS, "Cleaning up");
535     close (1);
536     remove_dir (tempdir);
537     free (tempdir);
538     free (wine_tests);
539
540     return logname;
541 }
542
543 void
544 usage ()
545 {
546     fprintf (stderr, "\
547 Usage: winetest [OPTION]...\n\n\
548   -c       console mode, no GUI\n\
549   -e       preserve the environment\n\
550   -h       print this message and exit\n\
551   -q       quiet mode, no output at all\n\
552   -o FILE  put report into FILE, do not submit\n\
553   -s FILE  submit FILE, do not run tests\n\
554   -t TAG   include TAG of characters [-.0-9a-zA-Z] in the report\n");
555 }
556
557 int WINAPI WinMain (HINSTANCE hInst, HINSTANCE hPrevInst,
558                     LPSTR cmdLine, int cmdShow)
559 {
560     char *logname = NULL;
561     const char *cp, *submit = NULL;
562     int reset_env = 1;
563     int interactive = 1;
564
565     /* initialize the revision information first */
566     extract_rev_infos();
567
568     cmdLine = strtok (cmdLine, whitespace);
569     while (cmdLine) {
570         if (cmdLine[0] != '-' || cmdLine[2]) {
571             report (R_ERROR, "Not a single letter option: %s", cmdLine);
572             usage ();
573             exit (2);
574         }
575         switch (cmdLine[1]) {
576         case 'c':
577             report (R_TEXTMODE);
578             interactive = 0;
579             break;
580         case 'e':
581             reset_env = 0;
582             break;
583         case 'h':
584             usage ();
585             exit (0);
586         case 'q':
587             report (R_QUIET);
588             interactive = 0;
589             break;
590         case 's':
591             submit = strtok (NULL, whitespace);
592             if (tag)
593                 report (R_WARNING, "ignoring tag for submission");
594             send_file (submit);
595             break;
596         case 'o':
597             logname = strtok (NULL, whitespace);
598             break;
599         case 't':
600             tag = strtok (NULL, whitespace);
601             if (strlen (tag) > MAXTAGLEN)
602                 report (R_FATAL, "tag is too long (maximum %d characters)",
603                         MAXTAGLEN);
604             cp = badtagchar (tag);
605             if (cp) {
606                 report (R_ERROR, "invalid char in tag: %c", *cp);
607                 usage ();
608                 exit (2);
609             }
610             break;
611         default:
612             report (R_ERROR, "invalid option: -%c", cmdLine[1]);
613             usage ();
614             exit (2);
615         }
616         cmdLine = strtok (NULL, whitespace);
617     }
618     if (!submit) {
619         report (R_STATUS, "Starting up");
620
621         if (!running_on_visible_desktop ())
622             report (R_FATAL, "Tests must be run on a visible desktop");
623
624         if (reset_env && (putenv ("WINETEST_PLATFORM=windows") ||
625                           putenv ("WINETEST_DEBUG=1") || 
626                           putenv ("WINETEST_INTERACTIVE=0") ||
627                           putenv ("WINETEST_REPORT_SUCCESS=0")))
628             report (R_FATAL, "Could not reset environment: %d", errno);
629
630         if (!tag) {
631             if (!interactive)
632                 report (R_FATAL, "Please specify a tag (-t option) if "
633                         "running noninteractive!");
634             if (guiAskTag () == IDABORT) exit (1);
635         }
636         report (R_TAG);
637
638         if (!logname) {
639             logname = run_tests (NULL);
640             if (report (R_ASK, MB_YESNO, "Do you want to submit the "
641                         "test results?") == IDYES)
642                 if (!send_file (logname) && remove (logname))
643                     report (R_WARNING, "Can't remove logfile: %d.", errno);
644             free (logname);
645         } else run_tests (logname);
646         report (R_STATUS, "Finished");
647     }
648     exit (0);
649 }