Changeset e971a2c in mod_gnutls for test

Timestamp:

Jan 2, 2020, 4:51:45 PM (17 months ago)

Author:

Fiona Klute <fiona.klute@…>

Branches:

asyncio, master, proxy-ticket

Children:

076049a

Parents:

4411426

Message:

Document supported test hooks

Location:

test

Files:

• README.md (modified) (1 diff)
• mgstest/hooks.py (modified) (3 diffs)

test/README.md

@@ -83 +83 @@
 
 * `hooks.py` [optional] -- Defines hook functions that modify or
-  override the default behavior of runtest.py
+  override the default behavior of `runtest.py`. Please see the module
+  documentation of [mgstest.hooks](./mgstest/hooks.py) for details.
 
 The [`runtest.py`](./runtest.py) program is used to start the required

test/mgstest/hooks.py

@@ -1 @@
-"""Test case hooks for mod_gnutls tests
+"""Test case hooks for mod_gnutls tests.
 
 Test cases can implement hooks that (depending on the hook) override
-or supplement the default test run behavior."""
+or supplement the default test run behavior. Two hooks are currently
+supported:
+
+    run_connection:
+
+        Will be called *instead* of mgstests.tests.run_test_conf() and
+        is expected to run whatever client actions the test
+        requires. This hook receives three parameters:
+
+        * testname: string containing the test name
+        * conn_log: file object for connection logging
+        * response_log: file object for HTTP response logging
+
+
+    post_check:
+
+        Execute additional checks if desired. This hook is called
+        after the test client run and after the test environment
+        terminates. This hook receives two parameters:
+
+        * conn_log: file object with connection log data
+        * response_log: file object with HTTP response log data
+
+        With the default client implementation conn_log will contain
+        gnutls-cli output, and response_log the full HTTP responses
+        (including status line and headers).
+
+"""
 
 import importlib.util
@@ -15 +42 @@
 
 class Plugin:
+    """Represents a set of hooks.
+
+    All attribute names listed in the "hooks" field are guaranteed to
+    exist in an instance of this class, with the value of each being
+    either None or a function.
+
+    """
     def __init__(self, module=None):
         self.module = module
@@ -27 +61 @@
                 setattr(self, hook, None)
 
-def load_module_file(file_path, module_name='mgstest.plugin'):
+def load_module_file(file_path, module_name):
+    """Load a module from a file path."""
     spec = importlib.util.spec_from_file_location(module_name, file_path)
     module = importlib.util.module_from_spec(spec)