test/README.test

   1 $Id$
   2
   3 What is it?
   4 -----------
   5 This is a collection of bash scripts which test the features of:
   6
   7  - Wireshark
   8  - TShark
   9  - Dumpcap
  10
  11 Motivation
  12 ----------
  13
  14 The command line options of Wireshark and the companion command line tools are
  15 numerous. This makes it hard to find newly introduced bugs doing manual testing
  16 (try and error) with source code changes.
  17
  18 The current way is to do some changes, testing some scenarios by hand and
  19 commit the code so other users will complain about new problems. This obviously
  20 is far from being optimal.
  21
  22 Limitations
  23 -----------
  24
  25 The test set currently provided will only do some basic tests, but even that
  26 is far better than nothing. This may involve in time as new tests can be added
  27 to fix problems reported by users. This will hopefully lead to a "complete"
  28 and reliable testset in the future.
  29
  30 The tests are limited to command line tests, other things like unit tests or
  31 GUI test are not included.
  32
  33 Prerequisites
  34 -------------
  35
  36 What you'll need (to do):
  37
  38  - edit the file config.sh to suit your configuration
  39  - obviously, compile the programs (wireshark, ...) to be tested
  40  - have a bash (cygwin should do well)
  41  - have tput (e.g. in the cygwin ncurses package)
  42  - you'll need a network interface with some network traffic
  43    (so you can run the capture tests)
  44  - (for non-Windows platforms) An X server for running the capture tests with
  45    the graphical Wireshark program.
  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!!!