Skip to content

Commit 781fbe4

Browse files
committed
clarified helptext on options -H, -i, etc.
1 parent 5ee6ebc commit 781fbe4

File tree

3 files changed

+20
-7
lines changed

3 files changed

+20
-7
lines changed

doc/howto.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ Synopsis::
221221
-c TD_CONFIG, --config Test driver configuration module at the current directory or the path specified
222222
with the -P option. Do not use relative paths or the .py filename extension
223223
-d, --debug Print debug information to stderr
224-
-H, --prettyprint Human readable status output
224+
-H, --prettyprint Status output as human readable python dictionary
225225
-h, --help show this help message and exit
226226
-J TT_CONFIG_FILE Test target configuration in JSON format
227227
-L, --log Print HTTP log information # TODO: update documentation
@@ -232,7 +232,11 @@ Synopsis::
232232
-t, --testpackage Module describing tests (e.g. idp_samlbase.py generated from repository)
233233
-Y, --pysamllog Print pySAML2 logs to stderr
234234

235-
Remember to generate the
235+
Output on stdout is a JSON dicitionary containing the test summary (overwrite with -H).
236+
Output to stderr is the log file
237+
238+
239+
Remember to generate the test target's config file in json format from python.
236240

237241

238242
Running the script testing an SP
@@ -241,7 +245,7 @@ Running the script testing an SP
241245
Synopsis::
242246

243247
$ sp_testdrv.py --help
244-
usage: sp_testdrv.py [-h] [-d] [-C CA_CERTS] [-J TT_CONFIG_FILE] [-m] [-l] [-c TD_CONFIG] [oper]
248+
usage: sp_testdrv.py [-h] [-H] [-d] [-C CA_CERTS] [-J TT_CONFIG_FILE] [-m] [-l] [-c TD_CONFIG] [oper]
245249

246250
positional arguments:
247251
oper Which test to run (mandatory except for options -h, -l and -m)
@@ -255,6 +259,7 @@ Synopsis::
255259
with the -P option. Do not use relative paths or filename extension
256260
-d, --debug Print debug information to stderr
257261
-h, --help show this help message and exit
262+
-H, --prettyprint Status output as human readable python dictionary
258263
-J TT_CONFIG_FILE Test target configuration in JSON format
259264
-L, --log Print HTTP log information # TODO: update documentation
260265
-l, --list List all the test flows as a JSON object
@@ -264,6 +269,8 @@ Synopsis::
264269
-t, --testpackage Module describing tests (e.g. sp_testbase.py generated from repository)
265270
-Y, --pysamllog Print pySAML2 logs to stderr
266271

272+
Output on stdout is a JSON dicitionary containing the test summary (overwrite with -H).
273+
Output to stderr is the log file
267274

268275
Examples
269276
::::::::

src/idp_test/__init__.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,11 @@ def __init__(self, check_factory):
131131
help="Tests")
132132
self._parser.add_argument("-Y", dest="pysamllog", action='store_true',
133133
help="Print PySAML2 logs")
134-
self._parser.add_argument("-H", dest="pretty", action='store_true')
135-
self._parser.add_argument("-i", dest="insecure", action='store_true')
134+
self._parser.add_argument("-H", dest="pretty", action='store_true',
135+
help="Output summary on stdout as pretty "
136+
"printed python dict instead of JSON")
137+
self._parser.add_argument("-i", dest="insecure", action='store_true',
138+
help="Do not verify SSL certificate")
136139
self._parser.add_argument("oper", nargs="?", help="Which test to run")
137140

138141
self.interactions = None

src/sp_test/__init__.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,11 @@ def __init__(self, operations, check_factory):
5757
"no cert verification will be done"))
5858
self._parser.add_argument('-d', dest='debug', action='store_true',
5959
help="Print debug information")
60-
self._parser.add_argument("-H", dest="pretty", action='store_true')
61-
self._parser.add_argument("-i", dest="insecure", action='store_true')
60+
self._parser.add_argument("-H", dest="pretty", action='store_true',
61+
help="Output summary on stdout as pretty "
62+
"printed python dict instead of JSON")
63+
self._parser.add_argument("-i", dest="insecure", action='store_true',
64+
help="Do not verify SSL certificate")
6265
self._parser.add_argument('-J', dest="json_config_file",
6366
help="Script configuration")
6467
self._parser.add_argument(

0 commit comments

Comments
 (0)