From df133965379f39d9143500e6d83c9ff722cf045c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=A0t=C4=9Bp=C3=A1n=20N=C4=9Bmec?= Date: Fri, 5 Nov 2021 12:39:08 +0100 Subject: tests: shell: README: copy edit MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Grammar, wording, formatting fixes (no substantial change of meaning). Signed-off-by: Štěpán Němec Signed-off-by: Phil Sutter --- tests/shell/README | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/tests/shell/README b/tests/shell/README index e0279bbd..35f6e378 100644 --- a/tests/shell/README +++ b/tests/shell/README @@ -1,16 +1,17 @@ -This test-suite is intended to perform tests of higher level than -the other regression test-suite. +This test suite is intended to perform tests on a higher level +than the other regression test suites. -It can run arbitrary executables which can perform any test apart of testing -the nft syntax or netlink code (which is what the regression tests does). +It can run arbitrary executables which can perform any test, not +limited to testing the nft syntax or netlink code (which is what +the regression tests do). To run the test suite (as root): $ cd tests/shell # ./run-tests.sh -Test files are executables files with the pattern <>, where N is the -expected return code of the executable. Since they are located with `find', -test-files can be spread in any sub-directories. +Test files are executable files matching the pattern <>, +where N is the expected return code of the executable. Since they +are located with `find', test files can be put in any subdirectory. You can turn on a verbose execution by calling: # ./run-tests.sh -v @@ -18,11 +19,11 @@ You can turn on a verbose execution by calling: And generate missing dump files with: # ./run-tests.sh -g -Before each call to the test-files, `nft flush ruleset' will be called. -Also, test-files will receive the environment variable $NFT which contains the -path to the nftables binary being tested. +Before each test file invocation, `nft flush ruleset' will be called. +Also, test file process environment will include the variable $NFT +which contains the path to the nft binary being tested. You can pass an arbitrary $NFT value as well: # NFT=/usr/local/sbin/nft ./run-tests.sh -By default the tests are run with the nft binary at '../../src/nft' +By default, the tests are run with the nft binary at '../../src/nft' -- cgit v1.2.3