wireshark/test
Gerald Combs b255d8a1a1 CMake: Update wslua build and test.
Process wslua/CMakeLists.txt using add_subdirectory instead of
include. Generate files in the build directory instead of the source
directory.

Copy lua scripts to DATAFILE_DIR instead of DATAFILE_DIR/lua. That's
where init.lua looks for console.lua.

Always set WIRESHARK_RUN_FROM_BUILD_DIRECTORY when testing. We
presumably want to test our source files and not files which may or
may not be in the system path.

When we're running from the build directory look for lua scripts in both
the Autotools and CMake build locations.

Change-Id: Ic15ab8c58ff1b170d000c9b3e0a329af2ec44b7b
Reviewed-on: https://code.wireshark.org/review/7590
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
2015-03-12 16:37:51 +00:00
..
baseline Remove svn:executable attribute. 2014-01-07 22:55:03 +00:00
captures Lua: Expose tcp_dissect_pdus() to Lua 2015-01-27 15:14:12 +00:00
config test: add decryption test for isakmp with certificates 2014-09-24 22:06:31 +00:00
keys add a test for SSL/TLS decryption using the master secret 2014-03-13 21:42:50 +00:00
lua Change a lot of http:// URLs to https://. 2015-03-10 19:30:50 +00:00
README.test Continue to remove $Id$ from top of file 2014-03-31 16:00:04 +00:00
config.sh CMake: Update wslua build and test. 2015-03-12 16:37:51 +00:00
hosts.custom Continue to remove $Id$ from top of file 2014-03-31 18:48:06 +00:00
hosts.global Continue to remove $Id$ from top of file 2014-03-31 18:48:06 +00:00
hosts.personal Continue to remove $Id$ from top of file 2014-03-31 18:48:06 +00:00
suite-capture.sh test suite: fix indent (use tabs) and add modelines 2014-12-23 07:27:48 +00:00
suite-clopts.sh Test suite: Make sure we have a usable locale before we run iconv. 2014-12-31 17:13:06 +00:00
suite-decryption.sh Change a lot of http:// URLs to https://. 2015-03-10 19:30:50 +00:00
suite-fileformats.sh Continue to remove $Id$ from top of file 2014-03-31 18:48:06 +00:00
suite-io.sh Add tests for the Qt UI. 2014-10-01 22:30:33 +00:00
suite-nameres.sh CMake: Update wslua build and test. 2015-03-12 16:37:51 +00:00
suite-unittests.sh Fix lua tests on Windows 2015-01-02 16:49:40 +00:00
suite-wslua.sh Fix the Lua FPM dissector test. 2015-03-12 10:44:14 +00:00
test-backend.sh Continue to remove $Id$ from top of file 2014-03-31 18:48:06 +00:00
test.sh Fix Cygwin path 2015-01-12 12:40:04 +00:00

README.test

What is it?
-----------
This is a collection of bash scripts which test the features of:

 - Wireshark
 - TShark
 - Dumpcap 

Motivation
----------

The command line options of Wireshark and the companion command line tools are 
numerous. This makes it hard to find newly introduced bugs doing manual testing 
(try and error) with source code changes.

The current way is to do some changes, testing some scenarios by hand and 
commit the code so other users will complain about new problems. This obviously 
is far from being optimal.

Limitations
-----------

The test set currently provided will only do some basic tests, but even that 
is far better than nothing. This may involve in time as new tests can be added
to fix problems reported by users. This will hopefully lead to a "complete" 
and reliable testset in the future.

The tests are limited to command line tests, other things like unit tests or 
GUI test are not included.

Prerequisites
-------------

What you'll need (to do):

 - edit the file config.sh to suit your configuration
 - obviously, compile the programs (wireshark, ...) to be tested
 - have a bash (cygwin should do well)
 - have tput (e.g. in the cygwin ncurses package)
 - you'll need a network interface with some network traffic 
   (so you can run the capture tests)
 - (for non-Windows platforms) An X server for running the capture tests with
   the graphical Wireshark program.

A Test Ride
-----------

The default configuration might not be suitable for your set-up. Most settings
can be adjusted by setting an environment variable matching or by editing the
setting in config.sh.

For instance, the first network interface might not be used for traffic (like an
unconnected Ethernet port). In that case, you might want to set the environment
variable TRAFFIC_CAPTURE_IFACE to pick another interface. Use `dumpcap -D` to
get a list of devices.

On Windows, it is assumed that the user is able to perform captures. On
non-Windows platforms, the opposite is assumed. If your dumpcap executable
allows you to perform captures (for example, when it has appropriate
capabilities), then you can override the default with:

    SKIP_CAPTURE=0

If you do not want to test the binaries in the build directory, you can override
it with:

    WS_BIN_PATH=/usr/bin

When your configuration is sane, you can start test.sh which should provide a
basic menu. Just press Enter to start all tests.

It should start all the available tests. Each test will throw out a line 
which should end with a green "Ok". If one of the tests fail, the script
will report it and stop at this test step.

Please remember to have some ICMP traffic on your network interface! The test
suite will ping to www.wireshark.org while running capture tests, but this will
slow down the tests.