tests/testcurl.1

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2010, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  10 .\" * This software is licensed as described in the file COPYING, which
  11 .\" * you should have received as part of this distribution. The terms
  12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
  13 .\" *
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15 .\" * copies of the Software, and permit persons to whom the Software is
  16 .\" * furnished to do so, under the terms of the COPYING file.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .\"
  23 .TH testcurl.pl 1 "24 Mar 2010" "Curl 7.20.1" "testcurl"
  24 .SH NAME
  25 testcurl.pl \- (automatically) test curl
  26 .SH SYNOPSIS
  27 .B testcurl.pl [options] [dir] > output
  28 .SH DESCRIPTION
  29 \fItestcurl.pl\fP is the master script to use for automatic testing of curl
  30 off git or daily snapshots. It is written for the purpose of being run from a
  31 crontab job or similar at a regular interval. The output is suitable to be
  32 mailed to curl-autocompile@haxx.se to be dealt with automatically (make sure
  33 the subject includes the word "autobuild" as the mail gets silently discarded
  34 otherwise).  The most current build status (with a reasonable backlog) will be
  35 published on the curl site, at https://curl.haxx.se/auto/
  36
  37 \fIoptions\fP may be omitted. See \fI--setup\fP for what happens then.
  38
  39 \fIdir\fP is a curl source dir, possibly a daily snapshot one. Using this will
  40 make testcurl.pl skip the 'buildconf' stage and thus it removes the dependency
  41 on automake, autoconf, libtool, GNU m4 and possibly a few other things.
  42
  43 testcurl.pl will run 'buildconf' (or similar), run configure, build curl and
  44 libcurl in a separate build directory and then run 'make test' to test the
  45 fresh build.
  46 .SH OPTIONS
  47 .IP "--configure=[options]"
  48 Configure options passed to configure.
  49 .IP "--crosscompile"
  50 This is a cross-compile. Makes \fItestcurl.pl\fP skip a few things.
  51 .IP "--desc=[desc]"
  52 Description of your test system. Displayed on the build summary page on the
  53 weba site.
  54 .IP "--email=[email]"
  55 Set email address to report as. Displayed in the build logs on the site.
  56 .IP "--mktarball=[command]"
  57 Generic command to run after completed test.
  58 .IP "--name=[name]"
  59 Set name to report as. Displayed in the build summary on the site.
  60 .IP "--nobuildconf"
  61 Don't run buildconf. Useful when many builds use the same source tree, as then
  62 only one need to do this. Also, if multiple processes run tests simultaneously
  63 on the same source tree (like several hosts on a NFS mounted dir),
  64 simultaneous buildconf invokes may cause problems. (Added in 7.14.1)
  65 .IP "--nogitpull"
  66 Don't update from git even though it is a git tree. Useful to still be able to
  67 test even though your network is down, or similar.
  68 .IP "--runtestopts=[options]"
  69 Options that is passed to the runtests.pl script. Useful for disabling valgrind
  70 by force, and similar.
  71 .IP "--setup=[file name]"
  72 File name to read setup from (deprecated). The old style of providing info.
  73 If info is missing when testcurl.pl is started, it will prompt you and then
  74 store the info in a 'setup' file, which it will look for on each invoke. Use
  75 \fI--name\fP, \fI--email\fP, \fI--configure\fP and \fI--desc\fP instead.
  76 .IP "--target=[your os]"
  77 Specify your target environment. Recognized strings include 'vc', 'mingw32',
  78 \&'borland' and 'netware'.
  79 .SH "INITIAL SETUP"
  80 First you make a checkout from git (or you write a script that downloads daily
  81 snapshots automatically, find inspiration at
  82 https://curl.haxx.se/auto/autocurl.txt):
  83
  84 .nf
  85   $ mkdir daily-curl
  86   $ cd daily-curl
  87   $ git clone git://github.com/curl/curl.git
  88 .fi
  89
  90 With the curl sources checked out, or downloaded, you can start testing right
  91 away. If you want to use \fItestcurl.pl\fP without command line arguments and
  92 to have it store and remember the config in its 'setup' file, then start it
  93 manually now and fill in the answers to the questions it prompts you for:
  94
  95 .nf
  96   $ ./curl/tests/testcurl.pl
  97 .fi
  98
  99 Now you are ready to go. If you let the script run, it will perform a full
 100 cycle and spit out lots of output. Mail us that output as described above.
 101 .SH "CRONTAB EXAMPLE"
 102 The crontab could include something like this:
 103
 104 .nf
 105 \# autobuild curl:
 106 0 4 * * * cd daily-curl && ./testit.sh
 107 .fi
 108
 109 Where testit.sh is a shell script that could look similar to this:
 110
 111 .nf
 112 mail="mail -s autobuild curl-autocompile@haxx.se"
 113 name="--name=whoami"
 114 email="--email=iamme@nowhere"
 115 desc='"--desc=supermachine Turbo 2000"'
 116 testprog="perl ./curl/tests/testcurl.pl $name $email $desc"
 117 opts1="--configure=--enable-debug"
 118 opts2="--configure=--enable-ipv6"
 119
 120 # run first test
 121 $testprog $opts1 | $mail
 122
 123 # run second test
 124 $testprog $opts2 | $mail