test/README.test

   1 $Id$
   2
   3 WARNING: these tests are in alpha state!
   4
   5 What is it?
   6 -----------
   7 This is basically a collection of bash scripts to test the command line options of:
   8
   9  - Ethereal
  10  - Tethereal
  11  - Dumpcap
  12
  13 Motivation
  14 ----------
  15
  16 The command line options of Ethereal and the companion command line tools are
  17 numerous. This makes it hard to find newly introduced bugs doing manual testing
  18 (try and error) with source code changes.
  19
  20 The current way is to do some changes, testing some scenarios by hand and
  21 commit the code so other users will complain about new problems. This obviously
  22 is far from being optimal.
  23
  24 Limitations
  25 -----------
  26
  27 The test set currently provided will only do some basic tests, but even that
  28 is far better than nothing. This may involve in time as new tests can be added
  29 to fix problems reported by users. This will hopefully lead to a "complete"
  30 and reliable testset in the future.
  31
  32 The tests are limited to command line tests, other things like unit tests or
  33 GUI test are not included.
  34
  35 Prerequisites
  36 -------------
  37
  38 What you'll need (to do):
  39
  40  - THE LATEST DEVELOPER BUILDS (the 0.10.13 release won't work)!
  41  - obviously, compile the programs (ethereal, ...) to be tested
  42  - have a bash (cygwin should do well)
  43  - you'll need a network interface with some network traffic
  44    (so you can run the capture tests)
  45  - edit the file config.sh to suit your configuration
  46
  47 A Test Ride
  48 -----------
  49
  50 Start test.sh which should provide a basic menu. Just press Enter to start
  51 all tests.
  52
  53 It should start all the available tests. Each test will throw out a line
  54 which should end with a green "Ok". If one of the tests fail, the script
  55 will report it and stop at this test step.
  56
  57 PLEASE REMEMBER TO HAVE SOME TRAFFIC ON YOUR NETWORK INTERFACE!!!