From: Phil Sutter <phil@nwl.cc>
Date: Tue, 5 Nov 2024 15:12:11 +0000 (+0100)
Subject: tests: iptables-test: Extend fast mode docs a bit
X-Git-Tag: v1.8.11~7
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=406ff3c3db9475ddf9cf4eb6854d79ca567a98fd;p=thirdparty%2Fiptables.git

tests: iptables-test: Extend fast mode docs a bit

To make things less confusing for new readers, describe at least what
the two significant functions do.

Fixes: 0e80cfea3762b ("tests: iptables-test: Implement fast test mode")
Signed-off-by: Phil Sutter <phil@nwl.cc>
---

diff --git a/iptables-test.py b/iptables-test.py
index 413e3fdc..141fec7b 100755
--- a/iptables-test.py
+++ b/iptables-test.py
@@ -241,10 +241,14 @@ def variant_res(res, variant, alt_res=None):
 
 def fast_run_possible(filename):
     '''
-    Keep things simple, run only for simple test files:
+    Return true if fast test run is possible.
+
+    To keep things simple, run only for simple test files:
     - no external commands
     - no multiple tables
     - no variant-specific results
+
+    :param filename: test file to inspect
     '''
     table = None
     rulecount = 0
@@ -267,6 +271,9 @@ def run_test_file_fast(iptables, filename, netns):
     '''
     Run a test file, but fast
 
+    Add all non-failing rules at once by use of iptables-restore, then check
+    all rules' listing at once by use of iptables-save.
+
     :param filename: name of the file with the test rules
     :param netns: network namespace to perform test run in
     '''