Update testing/btest/README

This commit is contained in:
Jon Siwek 2018-10-02 16:05:10 -05:00
parent 35d0a4d38e
commit 98181dd67c
3 changed files with 7 additions and 6 deletions

View file

@ -1,4 +1,8 @@
2.6-beta2-17 | 2018-10-02 16:05:10 -0500
* Update testing/btest/README (Jon Siwek, Corelight)
2.6-beta2-14 | 2018-09-25 16:38:29 -0500 2.6-beta2-14 | 2018-09-25 16:38:29 -0500
* Add some missing @TEST-REQUIRES to a few tests (Daniel Thayer) * Add some missing @TEST-REQUIRES to a few tests (Daniel Thayer)

View file

@ -1 +1 @@
2.6-beta2-14 2.6-beta2-17

View file

@ -1,7 +1,7 @@
This a test suite of small "unit tests" that verify individual pieces of Bro This a test suite of small "unit tests" that verify individual pieces of Bro
functionality. They all utilize BTest, a simple framework/driver for functionality. They all utilize BTest, a simple framework/driver for
writing unit tests. More information about BTest can be found at writing unit tests. More information about BTest can be found at
http://www.bro.org/development/btest.html https://github.com/bro/btest
The test suite's BTest configuration is handled through the The test suite's BTest configuration is handled through the
``btest.cfg`` file. Of particular interest is the "TestDirs" settings, ``btest.cfg`` file. Of particular interest is the "TestDirs" settings,
@ -61,7 +61,7 @@ Adding Tests
============= =============
See either the `BTest documentation See either the `BTest documentation
<http://www.bro.org/development/btest.html>`_ or the existing unit <https://github.com/bro/btest>`_ or the existing unit
tests for examples of what they actually look like. The essential tests for examples of what they actually look like. The essential
components of a new test include: components of a new test include:
@ -80,6 +80,3 @@ 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 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 ``btest.cfg``. Do this only if your test really doesn't fit logically in
any of the extant directories. any of the extant directories.
Note that any new test you add this way will automatically be included
in the testing done in the NMI automated build & test environment.