1#!/usr/bin/env perl
2#***************************************************************************
3#                                  _   _ ____  _
4#  Project                     ___| | | |  _ \| |
5#                             / __| | | | |_) | |
6#                            | (__| |_| |  _ <| |___
7#                             \___|\___/|_| \_\_____|
8#
9# Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al.
10#
11# This software is licensed as described in the file COPYING, which
12# you should have received as part of this distribution. The terms
13# are also available at http://curl.haxx.se/docs/copyright.html.
14#
15# You may opt to use, copy, modify, merge, publish, distribute and/or sell
16# copies of the Software, and permit persons to whom the Software is
17# furnished to do so, under the terms of the COPYING file.
18#
19# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
20# KIND, either express or implied.
21#
22###########################################################################
23
24###########################
25#  What is This Script?
26###########################
27
28# testcurl.pl is the master script to use for automatic testing of curl
29# directly off its source repository.
30# This is written for the purpose of being run from a crontab job or similar
31# at a regular interval. The output is suitable to be mailed to
32# curl-autocompile@haxx.se to be dealt with automatically (make sure the
33# subject includes the word "autobuild" as the mail gets silently discarded
34# otherwise).  The most current build status (with a resonable backlog) will
35# be published on the curl site, at http://curl.haxx.se/auto/
36
37# USAGE:
38# testcurl.pl [options] [curl-daily-name] > output
39
40# Options:
41#
42# --configure=[options]    Configure options
43# --crosscompile           This is a crosscompile
44# --desc=[desc]            Description of your test system
45# --email=[email]          Set email address to report as
46# --extvercmd=[command]    Command to use for displaying version with cross compiles.
47# --mktarball=[command]    Command to run after completed test
48# --name=[name]            Set name to report as
49# --nocvsup                Don't pull from git even though it is a git tree
50# --nogitpull              Don't pull from git even though it is a git tree
51# --nobuildconf            Don't run buildconf
52# --noconfigure            Don't run configure
53# --runtestopts=[options]  Options to pass to runtests.pl
54# --setup=[file name]      File name to read setup from (deprecated)
55# --target=[your os]       Specify your target environment.
56#
57# if [curl-daily-name] is omitted, a 'curl' git directory is assumed.
58#
59
60use strict;
61
62use Cwd;
63
64# Turn on warnings (equivalent to -w, which can't be used with /usr/bin/env)
65#BEGIN { $^W = 1; }
66
67use vars qw($version $fixed $infixed $CURLDIR $git $pwd $build $buildlog
68            $buildlogname $configurebuild $targetos $confheader $binext
69            $libext);
70
71use vars qw($name $email $desc $confopts $runtestopts $setupfile $mktarball
72            $extvercmd $nogitpull $nobuildconf $crosscompile
73            $timestamp $notes);
74
75# version of this script
76$version='2011-06-23';
77$fixed=0;
78
79# Determine if we're running from git or a canned copy of curl,
80# or if we got a specific target option or setup file option.
81$CURLDIR="curl";
82if (-f ".git/config") {
83  $CURLDIR = "./";
84}
85
86$git=1;
87$setupfile = 'setup';
88$configurebuild = 1;
89while ($ARGV[0]) {
90  if ($ARGV[0] =~ /--target=/) {
91    $targetos = (split(/=/, shift @ARGV))[1];
92  }
93  elsif ($ARGV[0] =~ /--setup=/) {
94    $setupfile = (split(/=/, shift @ARGV))[1];
95  }
96  elsif ($ARGV[0] =~ /--extvercmd=/) {
97    $extvercmd = (split(/=/, shift @ARGV))[1];
98  }
99  elsif ($ARGV[0] =~ /--mktarball=/) {
100    $mktarball = (split(/=/, shift @ARGV))[1];
101  }
102  elsif ($ARGV[0] =~ /--name=/) {
103    $name = (split(/=/, shift @ARGV))[1];
104  }
105  elsif ($ARGV[0] =~ /--email=/) {
106    $email = (split(/=/, shift @ARGV))[1];
107  }
108  elsif ($ARGV[0] =~ /--desc=/) {
109    $desc = (split(/=/, shift @ARGV))[1];
110  }
111  elsif ($ARGV[0] =~ /--configure=(.*)/) {
112    $confopts = $1;
113    shift @ARGV;
114  }
115  elsif (($ARGV[0] eq "--nocvsup") || ($ARGV[0] eq "--nogitpull")) {
116    $nogitpull=1;
117    shift @ARGV;
118  }
119  elsif ($ARGV[0] =~ /--nobuildconf/) {
120    $nobuildconf=1;
121    shift @ARGV;
122  }
123  elsif ($ARGV[0] =~ /--noconfigure/) {
124    $configurebuild=0;
125    shift @ARGV;
126  }
127  elsif ($ARGV[0] =~ /--crosscompile/) {
128    $crosscompile=1;
129    shift @ARGV;
130  }
131  elsif ($ARGV[0] =~ /--runtestopts=/) {
132    $runtestopts = (split(/=/, shift @ARGV, 2))[1];
133  }
134  else {
135    $CURLDIR=shift @ARGV;
136    $git=0; # a given dir, assume not using git
137  }
138}
139
140# Do the platform-specific stuff here
141$confheader = 'curl_config.h';
142$binext = '';
143$libext = '.la'; # .la since both libcurl and libcares are made with libtool
144if ($^O eq 'MSWin32' || $targetos) {
145  if (!$targetos) {
146    # If no target defined on Win32 lets assume vc
147    $targetos = 'vc';
148  }
149  if ($targetos =~ /vc/ || $targetos =~ /borland/ || $targetos =~ /watcom/) {
150    $binext = '.exe';
151    $libext = '.lib';
152  }
153  elsif ($targetos =~ /mingw/) {
154    $binext = '.exe';
155    if ($^O eq 'MSWin32') {
156      $libext = '.a';
157    }
158  }
159  elsif ($targetos =~ /netware/) {
160    $configurebuild = 0;
161    $binext = '.nlm';
162    if ($^O eq 'MSWin32') {
163      $libext = '.lib';
164    }
165    else {
166      $libext = '.a';
167    }
168  }
169}
170
171if (($^O eq 'MSWin32' || $^O eq 'msys') &&
172    ($targetos =~ /vc/ || $targetos =~ /mingw32/ ||
173     $targetos =~ /borland/ || $targetos =~ /watcom/)) {
174
175  # Set these things only when building ON Windows and for Win32 platform.
176  # FOR Windows since we might be cross-compiling on another system. Non-
177  # Windows builds still default to configure-style builds with curl_config.h.
178
179  $configurebuild = 0;
180  $confheader = 'config-win32.h';
181}
182
183$ENV{LC_ALL}="C" if (($ENV{LC_ALL}) && ($ENV{LC_ALL} !~ /^C$/));
184$ENV{LC_CTYPE}="C" if (($ENV{LC_CTYPE}) && ($ENV{LC_CTYPE} !~ /^C$/));
185$ENV{LANG}="C";
186
187sub rmtree($) {
188    my $target = $_[0];
189    if ($^O eq 'MSWin32') {
190      foreach (glob($target)) {
191        s:/:\\:g;
192        system("rd /s /q $_");
193      }
194    } else {
195      system("rm -rf $target");
196    }
197}
198
199sub grepfile($$) {
200    my ($target, $fn) = @_;
201    open(F, $fn) or die;
202    while (<F>) {
203      if (/$target/) {
204        close(F);
205        return 1;
206      }
207    }
208    close(F);
209    return 0;
210}
211
212sub logit($) {
213    my $text=$_[0];
214    if ($text) {
215      print "testcurl: $text\n";
216    }
217}
218
219sub logit_spaced($) {
220    my $text=$_[0];
221    if ($text) {
222      print "\ntestcurl: $text\n\n";
223    }
224}
225
226sub mydie($){
227    my $text=$_[0];
228    logit "$text";
229    chdir $pwd; # cd back to the original root dir
230
231    if ($pwd && $build) {
232      # we have a build directory name, remove the dir
233      logit "removing the $build dir";
234      rmtree "$pwd/$build";
235    }
236    if (-r $buildlog) {
237      # we have a build log output file left, remove it
238      logit "removing the $buildlogname file";
239      unlink "$buildlog";
240    }
241    logit "ENDING HERE"; # last line logged!
242    exit 1;
243}
244
245sub get_host_triplet {
246  my $triplet;
247  my $configfile = "$pwd/$build/lib/curl_config.h";
248
249  if(-f $configfile && -s $configfile && open(LIBCONFIGH, "<$configfile")) {
250    while(<LIBCONFIGH>) {
251      if($_ =~ /^\#define\s+OS\s+"*([^"][^"]*)"*\s*/) {
252        $triplet = $1;
253        last;
254      }
255    }
256    close(LIBCONFIGH);
257  }
258  return $triplet;
259}
260
261if (open(F, "$setupfile")) {
262  while (<F>) {
263    if (/(\w+)=(.*)/) {
264      eval "\$$1=$2;";
265    }
266  }
267  close(F);
268  $infixed=$fixed;
269} else {
270  $infixed=0;    # so that "additional args to configure" works properly first time...
271}
272
273if (!$name) {
274  print "please enter your name\n";
275  $name = <>;
276  chomp $name;
277  $fixed=1;
278}
279
280if (!$email) {
281  print "please enter your contact email address\n";
282  $email = <>;
283  chomp $email;
284  $fixed=2;
285}
286
287if (!$desc) {
288  print "please enter a one line system description\n";
289  $desc = <>;
290  chomp $desc;
291  $fixed=3;
292}
293
294if (!$confopts) {
295  if ($infixed < 4) {
296    print "please enter your additional arguments to configure\n";
297    print "examples: --with-ssl --enable-debug --enable-ipv6 --with-krb4\n";
298    $confopts = <>;
299    chomp $confopts;
300  }
301}
302
303
304if ($fixed < 4) {
305    $fixed=4;
306    open(F, ">$setupfile") or die;
307    print F "name='$name'\n";
308    print F "email='$email'\n";
309    print F "desc='$desc'\n";
310    print F "confopts='$confopts'\n";
311    print F "notes='$notes'\n";
312    print F "fixed='$fixed'\n";
313    close(F);
314}
315
316# Enable picky compiler warnings unless explicitly disabled
317if (($confopts !~ /--enable-debug/) &&
318    ($confopts !~ /--enable-warnings/) &&
319    ($confopts !~ /--disable-warnings/)) {
320  $confopts .= " --enable-warnings";
321}
322
323my $str1066os = 'o' x 1066;
324
325# Set timestamp to the UTC this script is running. Its value might
326# be changed later in the script to the value present in curlver.h
327$timestamp = scalar(gmtime)." UTC";
328
329logit "STARTING HERE"; # first line logged, for scripts to trigger on
330logit 'TRANSFER CONTROL ==== 1120 CHAR LINE' . $str1066os . 'LINE_END';
331logit "NAME = $name";
332logit "EMAIL = $email";
333logit "DESC = $desc";
334logit "NOTES = $notes";
335logit "CONFOPTS = $confopts";
336logit "CPPFLAGS = ".$ENV{CPPFLAGS};
337logit "CFLAGS = ".$ENV{CFLAGS};
338logit "LDFLAGS = ".$ENV{LDFLAGS};
339logit "CC = ".$ENV{CC};
340logit "MAKEFLAGS = ".$ENV{MAKEFLAGS};
341logit "PKG_CONFIG_PATH = ".$ENV{PKG_CONFIG_PATH};
342logit "target = ".$targetos;
343logit "version = $version"; # script version
344logit "date = $timestamp";  # When the test build starts
345
346$str1066os = undef;
347
348# Make $pwd to become the path without newline. We'll use that in order to cut
349# off that path from all possible logs and error messages etc.
350$pwd = getcwd();
351
352if (-d $CURLDIR) {
353  if ($git && -d "$CURLDIR/.git") {
354    logit "$CURLDIR is verified to be a fine git source dir";
355    # remove the generated sources to force them to be re-generated each
356    # time we run this test
357    unlink "$CURLDIR/src/hugehelp.c";
358  } elsif (!$git && -f "$CURLDIR/tests/testcurl.pl") {
359    logit "$CURLDIR is verified to be a fine daily source dir"
360  } else {
361    mydie "$CURLDIR is not a daily source dir or checked out from git!"
362  }
363}
364$build="build-$$";
365$buildlogname="buildlog-$$";
366$buildlog="$pwd/$buildlogname";
367
368# remove any previous left-overs
369rmtree "build-*";
370rmtree "buildlog-*";
371
372# this is to remove old build logs that ended up in the wrong dir
373foreach (glob("$CURLDIR/buildlog-*")) { unlink $_; }
374
375# create a dir to build in
376mkdir $build, 0777;
377
378if (-d $build) {
379  logit "build dir $build was created fine";
380} else {
381  mydie "failed to create dir $build";
382}
383
384# get in the curl source tree root
385chdir $CURLDIR;
386
387# Do the git thing, or not...
388if ($git) {
389  # update quietly to the latest git
390  if($nogitpull) {
391    logit "skipping git pull (--nogitpull)";
392  } else {
393    my $gitstat = 0;
394    my @commits;
395    logit "run git pull in curl";
396    system("git pull 2>&1");
397    $gitstat += $?;
398    logit "failed to update from curl git ($?), continue anyway" if ($?);
399    # get the last 5 commits for show (even if no pull was made)
400    @commits=`git log --pretty=oneline --abbrev-commit -5`;
401    logit "The most recent curl git commits:";
402    for (@commits) {
403      chomp ($_);
404      logit "  $_";
405    }
406    if (-d "ares/.git") {
407      chdir "ares";
408      logit "run git pull in ares";
409      system("git pull 2>&1");
410      $gitstat += $?;
411      logit "failed to update from ares git ($?), continue anyway" if ($?);
412      # get the last 5 commits for show (even if no pull was made)
413      @commits=`git log --pretty=oneline --abbrev-commit -5`;
414      logit "The most recent ares git commits:";
415      for (@commits) {
416        chomp ($_);
417        logit "  $_";
418      }
419      chdir "$pwd/$CURLDIR";
420    }
421    # Set timestamp to the UTC the git update took place.
422    $timestamp = scalar(gmtime)." UTC" if (!$gitstat);
423  }
424
425  if($nobuildconf) {
426    logit "told to not run buildconf";
427  }
428  elsif ($configurebuild) {
429    # remove possible left-overs from the past
430    unlink "configure";
431    unlink "autom4te.cache";
432
433    # generate the build files
434    logit "invoke buildconf, but filter off aclocal underquoted definition warnings";
435    open(F, "./buildconf 2>&1 |") or die;
436    open(LOG, ">$buildlog") or die;
437    while (<F>) {
438      next if /warning: underquoted definition of/;
439      print;
440      print LOG;
441    }
442    close(F);
443    close(LOG);
444
445    if (grepfile("^buildconf: OK", $buildlog)) {
446      logit "buildconf was successful";
447    }
448    else {
449      mydie "buildconf was NOT successful";
450    }
451  }
452  else {
453    logit "buildconf was successful (dummy message)";
454  }
455}
456
457# Set timestamp to the one in curlver.h if this isn't a git test build.
458if ((-f "include/curl/curlver.h") &&
459    (open(F, "<include/curl/curlver.h"))) {
460  while (<F>) {
461    chomp;
462    if ($_ =~ /^\#define\s+LIBCURL_TIMESTAMP\s+\"(.+)\".*$/) {
463      my $stampstring = $1;
464      if ($stampstring !~ /DEV/) {
465          $stampstring =~ s/\s+UTC//;
466          $timestamp = $stampstring." UTC";
467      }
468      last;
469    }
470  }
471  close(F);
472}
473
474# Show timestamp we are using for this test build.
475logit "timestamp = $timestamp";
476
477if ($configurebuild) {
478  if (-f "configure") {
479    logit "configure created (at least it exists)";
480  } else {
481    mydie "no configure created/found";
482  }
483} else {
484  logit "configure created (dummy message)"; # dummy message to feign success
485}
486
487sub findinpath {
488  my $c;
489  my $e;
490  my $x = ($^O eq 'MSWin32') ? '.exe' : '';
491  my $s = ($^O eq 'MSWin32') ? ';' : ':';
492  my $p=$ENV{'PATH'};
493  my @pa = split($s, $p);
494  for $c (@_) {
495    for $e (@pa) {
496      if( -x "$e/$c$x") {
497        return $c;
498      }
499    }
500  }
501}
502
503my $make = findinpath("gmake", "make", "nmake");
504if(!$make) {
505    mydie "Couldn't find make in the PATH";
506}
507# force to 'nmake' for VC builds
508$make = "nmake" if ($targetos =~ /vc/);
509# force to 'wmake' for Watcom builds
510$make = "wmake" if ($targetos =~ /watcom/);
511logit "going with $make as make";
512
513# change to build dir
514chdir "$pwd/$build";
515
516if ($configurebuild) {
517  # run configure script
518  print `../$CURLDIR/configure $confopts 2>&1`;
519
520  if (-f "lib/Makefile") {
521    logit "configure seems to have finished fine";
522  } else {
523    mydie "configure didn't work";
524  }
525} else {
526  logit "copying files to build dir ...";
527  if (($^O eq 'MSWin32') && ($targetos !~ /netware/)) {
528    system("xcopy /s /q ..\\$CURLDIR .");
529    system("buildconf.bat");
530  }
531  elsif ($targetos =~ /netware/) {
532    system("cp -afr ../$CURLDIR/* .");
533    system("cp -af ../$CURLDIR/Makefile.dist Makefile");
534    system("$make -i -C lib -f Makefile.netware prebuild");
535    system("$make -i -C src -f Makefile.netware prebuild");
536    if (-d "../$CURLDIR/ares") {
537      system("$make -i -C ares -f Makefile.netware prebuild");
538    }
539  }
540  elsif ($^O eq 'linux') {
541    system("cp -afr ../$CURLDIR/* .");
542    system("cp -af ../$CURLDIR/Makefile.dist Makefile");
543    system("cp -af ../$CURLDIR/include/curl/curlbuild.h.dist ./include/curl/curlbuild.h");
544    system("$make -i -C lib -f Makefile.$targetos prebuild");
545    system("$make -i -C src -f Makefile.$targetos prebuild");
546    if (-d "../$CURLDIR/ares") {
547      system("cp -af ../$CURLDIR/ares/ares_build.h.dist ./ares/ares_build.h");
548      system("$make -i -C ares -f Makefile.$targetos prebuild");
549    }
550  }
551}
552
553if(-f "./libcurl.pc") {
554  logit_spaced "display libcurl.pc";
555  if(open(F, "<./libcurl.pc")) {
556    while(<F>) {
557      my $ll = $_;
558      print $ll if(($ll !~ /^ *#/) && ($ll !~ /^ *$/));
559    }
560    close(F);
561  }
562}
563
564if(-f "./include/curl/curlbuild.h") {
565  logit_spaced "display include/curl/curlbuild.h";
566  if(open(F, "<./include/curl/curlbuild.h")) {
567    while(<F>) {
568      my $ll = $_;
569      print $ll if(($ll =~ /^ *# *define *CURL_/) && ($ll !~ /__CURL_CURLBUILD_H/));
570    }
571    close(F);
572  }
573}
574else {
575  mydie "no curlbuild.h created/found";
576}
577
578logit_spaced "display lib/$confheader";
579open(F, "lib/$confheader") or die "lib/$confheader: $!";
580while (<F>) {
581  print if /^ *#/;
582}
583close(F);
584
585if (grepfile("^#define USE_ARES", "lib/$confheader")) {
586  print "\n";
587  logit "setup to build ares";
588
589  if(-f "./ares/libcares.pc") {
590    logit_spaced  "display ares/libcares.pc";
591    if(open(F, "<./ares/libcares.pc")) {
592      while(<F>) {
593        my $ll = $_;
594        print $ll if(($ll !~ /^ *#/) && ($ll !~ /^ *$/));
595      }
596      close(F);
597    }
598  }
599
600  if(-f "./ares/ares_build.h") {
601    logit_spaced "display ares/ares_build.h";
602    if(open(F, "<./ares/ares_build.h")) {
603      while(<F>) {
604        my $ll = $_;
605        print $ll if(($ll =~ /^ *# *define *CARES_/) && ($ll !~ /__CARES_BUILD_H/));
606      }
607      close(F);
608    }
609  }
610  else {
611    mydie "no ares_build.h created/found";
612  }
613
614  $confheader =~ s/curl/ares/;
615  logit_spaced "display ares/$confheader";
616  if(open(F, "ares/$confheader")) {
617      while (<F>) {
618          print if /^ *#/;
619      }
620      close(F);
621  }
622
623  print "\n";
624  logit "build ares";
625  chdir "ares";
626
627  if ($targetos && !$configurebuild) {
628      logit "$make -f Makefile.$targetos";
629      open(F, "$make -f Makefile.$targetos 2>&1 |") or die;
630  }
631  else {
632      logit "$make";
633      open(F, "$make 2>&1 |") or die;
634  }
635  while (<F>) {
636    s/$pwd//g;
637    print;
638  }
639  close(F);
640
641  if (-f "libcares$libext") {
642    logit "ares is now built successfully (libcares$libext)";
643  } else {
644    mydie "ares build failed (libcares$libext)";
645  }
646
647  # cd back to the curl build dir
648  chdir "$pwd/$build";
649}
650
651my $mkcmd = "$make -i" . ($targetos && !$configurebuild ? " $targetos" : "");
652logit "$mkcmd";
653open(F, "$mkcmd 2>&1 |") or die;
654while (<F>) {
655  s/$pwd//g;
656  print;
657}
658close(F);
659
660if (-f "lib/libcurl$libext") {
661  logit "libcurl was created fine (libcurl$libext)";
662}
663else {
664  mydie "libcurl was not created (libcurl$libext)";
665}
666
667if (-f "src/curl$binext") {
668  logit "curl was created fine (curl$binext)";
669}
670else {
671  mydie "curl was not created (curl$binext)";
672}
673
674if (!$crosscompile || (($extvercmd ne '') && (-x $extvercmd))) {
675  logit "display curl${binext} --version output";
676  my $cmd = ($extvercmd ne '' ? $extvercmd.' ' : '')."./src/curl${binext} --version|";
677  open(F, $cmd);
678  while(<F>) {
679    # strip CR from output on non-win32 platforms (wine on Linux)
680    s/\r// if ($^O ne 'MSWin32');
681    print;
682  }
683  close(F);
684}
685
686if ($configurebuild && !$crosscompile) {
687  my $o;
688  if($runtestopts) {
689      $o = "TEST_F=\"$runtestopts\" ";
690  }
691  logit "$make -k ${o}test-full";
692  open(F, "$make -k ${o}test-full 2>&1 |") or die;
693  open(LOG, ">$buildlog") or die;
694  while (<F>) {
695    s/$pwd//g;
696    print;
697    print LOG;
698  }
699  close(F);
700  close(LOG);
701
702  if (grepfile("^TEST", $buildlog)) {
703    logit "tests were run";
704  } else {
705    mydie "test suite failure";
706  }
707
708  if (grepfile("^TESTFAIL:", $buildlog)) {
709    logit "the tests were not successful";
710  } else {
711    logit "the tests were successful!";
712  }
713}
714else {
715  if($crosscompile) {
716    # build test harness programs for selected cross-compiles
717    my $host_triplet = get_host_triplet();
718    if($host_triplet =~ /([^-]+)-([^-]+)-mingw(.*)/) {
719      chdir "$pwd/$build/tests";
720      logit_spaced "build test harness";
721      open(F, "$make -i 2>&1 |") or die;
722      open(LOG, ">$buildlog") or die;
723      while (<F>) {
724        s/$pwd//g;
725        print;
726        print LOG;
727      }
728      close(F);
729      close(LOG);
730      chdir "$pwd/$build";
731    }
732    logit_spaced "cross-compiling, can't run tests";
733  }
734  # dummy message to feign success
735  print "TESTDONE: 1 tests out of 0 (dummy message)\n";
736}
737
738# create a tarball if we got that option.
739if (($mktarball ne '') && (-x $mktarball)) {
740  system($mktarball);
741}
742
743# mydie to cleanup
744mydie "ending nicely";
745