zeek/testing/btest
Arne Welzel 4f084b0b9a ssh: Fallback to client or server selected version for parsing
In half-duplex setups (or when client/server coalesce the SSH version
line with the KEX packet, get_version() would return UNK as version,
causing a protocol violation. Make this slightly more robust by using
and setting the version which either side had set to continue parsing.

For the special case of SSH-1.99, select SSH-2.0. We could try to peak
into the payload following the packet length field and check for
a KEX_INIT type byte to select SSH2 as a heuristic, but not sure how
to accomplish this.

Slight regression fix for 3769ed6c66
which started to require visibility for client and server version
rather than just the client's version.
2024-06-12 16:30:18 +02:00
..
af_packet
Baseline ssh: Fallback to client or server selected version for parsing 2024-06-12 16:30:18 +02:00
Baseline.cpp script optimization baseline tweaks due to recent minor changes 2024-06-04 10:36:36 -07:00
Baseline.dup
Baseline.inline
Baseline.opt
Baseline.usage
Baseline.xform
Baseline.zam script optimization baseline tweaks due to recent minor changes 2024-06-04 10:36:36 -07:00
bifs More precise error reporting for the disable_analyzer() BiF 2024-05-30 16:38:22 -07:00
broker cluster: Deprecate the Cluster::Node$interface field 2023-11-07 16:06:16 +01:00
core Move GeoIP availability test in btests to zeek-config --have-geoip 2024-01-26 14:27:19 -08:00
coverage OpaqueVal: Register TelemetryVals, too 2023-11-28 09:21:31 +01:00
doc Add btest for Zeekygen docs extraction on identifiers defined by the Zeek core. 2024-05-03 12:22:42 -07:00
Files/mmdb Add an IPv6 range to the test MMDB DBs 2024-01-25 23:43:34 -08:00
javascript testing/btest: Log::delay() from JavaScript 2023-11-29 12:52:19 +01:00
language factored BTest constants into globals to prevent premature ZAM optimization when testing 2024-04-27 19:40:39 -07:00
misc
opt updated list of BiFs for script optimization 2024-06-04 10:36:36 -07:00
plugins Remove variant from StdFunctionStmt 2024-03-19 09:07:45 -07:00
scripts ssh: Fallback to client or server selected version for parsing 2024-06-12 16:30:18 +02:00
signatures rule-parse: Remove [event_name] syntax, deprecate msg as identifier 2023-12-14 10:16:35 +01:00
spicy Merge remote-tracking branch 'origin/topic/robin/gh-3561-forward-to-udp' 2024-05-10 11:15:20 +02:00
supervisor Supervisor: Handle EAGAIN error on stem pipe 2023-10-25 12:53:37 +02:00
telemetry Change all instruments to only handle doubles 2024-05-31 13:36:37 -07:00
Traces Merge branch 'files_pe_timestamp_sync' of https://github.com/mvhensbergen/zeek 2024-05-29 14:16:31 +01:00
.gitignore
btest.cfg ci/btest: Remove ZEEK_PROFILER_FILE from btest.cfg, set in ci/test.sh explicitly 2023-12-15 15:23:52 +01:00
Makefile
random.seed
README

This a test suite of small "unit tests" that verify individual pieces of Zeek
functionality.  They all utilize BTest, a simple framework/driver for
writing unit tests.  More information about BTest can be found at
https://github.com/zeek/btest

The test suite's BTest configuration is handled through the
``btest.cfg`` file.  Of particular interest is the "TestDirs" settings,
which specifies which directories BTest will recursively search for
test files.

Significant Subdirectories
==========================

* Baseline/
	Validated baselines for comparison against the output of each
	test on future runs. If the new output differs from the Baseline
	output, then the test fails.

* Traces/
	Packet captures utilized by the various BTest tests.

* scripts/
	This hierarchy of tests emulates the hierarchy of the Zeek scripts/
	directory.

* coverage/
	This collection of tests relates to checking whether we're covering
	everything we want to in terms of tests, documentation, and which
	scripts get loaded in different Zeek configurations.  These tests are
	more prone to fail as new Zeek scripts are developed and added to the
	distribution -- checking the individual test's comments is the best
	place to check for more details on what exactly the test is checking
	and hints on how to fix it when it fails.

Running Tests
=============

Either use the ``make all`` or ``make brief`` ``Makefile`` targets, or
run ``btest`` directly with desired options/arguments.  Examples:

* btest <no arguments>
	If you simply execute btest in this directory with no arguments,
	then all directories listed as "TestDirs" in btest.cfg will be
	searched recursively for test files.


* btest <btest options> test_directory
	You can specify a directory on the command line to run just the
	tests contained in that directory. This is useful if you wish to
	run all of a given type of test, without running all the tests
	there are. For example, "btest scripts" will run all of the Zeek
	script unit tests.


* btest <btest options> test_directory/test_file
	You can specify a single test file to run just that test. This
	is useful when testing a single failing test or when developing
	a new test.

Adding Tests
=============

See either the `BTest documentation
<https://github.com/zeek/btest>`_ or the existing unit
tests for examples of what they actually look like.  The essential
components of a new test include:

* A test file in one of the subdirectories listed in the ``TestDirs``
  of the ``btest.cfg`` file.

* If the unit test requires a known-good baseline output against which
  future tests will be compared (via ``btest-diff``), then that baseline
  output will need to live in the ``Baseline`` directory.  Manually
  adding that is possible, but it's easier to just use the ``-u`` or
  ``-U`` options of ``btest`` to do it for you (using ``btest -d`` on a
  test for which no baseline exists will show you the output so it can
  be verified first before adding/updating the baseline output).

If you create a new top-level testing directory for collecting related
tests, then you'll need to add it to the list of ``TestDirs`` in
``btest.cfg``. Do this only if your test really doesn't fit logically in
any of the extant directories.