Added docstring for documentation and usage example

This commit is contained in:
Logan Lipke
2020-12-29 16:56:16 -08:00
parent 51187f85c9
commit b8e2b1a109
7 changed files with 52 additions and 2 deletions

View File

@@ -5,7 +5,7 @@
A test will run to verify stations are associated and get an IP, if these conditions are both true, the test will A test will run to verify stations are associated and get an IP, if these conditions are both true, the test will
pass, otherwise, the test will fail. pass, otherwise, the test will fail.
Use `./test_ipv4_connection.py` --help to see command line usage and options Use './test_ipv4_connection.py' --help to see command line usage and options
""" """
import sys import sys

View File

@@ -1,5 +1,13 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
"""
This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic.
A test will run for a specified amount of time with periodic checks for traffic successfully being received. The test will
monitor the bytes-rd column of the endpoints. An increase at every test interval will pass the test, otherwise it will fail
Use './test_ipv4_l4.py --help' to see command line usage and options
"""
import sys import sys
if sys.version_info[0] != 3: if sys.version_info[0] != 3:

View File

@@ -1,5 +1,13 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
"""
This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic over ftp.
A test will run for a specified amount of time with periodic checks for traffic successfully being received. The test will
monitor the bytes-wr column of the endpoints. An increase at every test interval will pass the test, otherwise it will fail
Use './test_ipv4_l4_ftp_upload.py --help' to see command line usage and options
"""
import sys import sys
if sys.version_info[0] != 3: if sys.version_info[0] != 3:

View File

@@ -1,5 +1,14 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
"""
This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic over ftp.
A test will run a specified number of times with periodic checks for traffic successfully being received every ten minutes.
The test will monitor the urls/s column of the endpoints. Being at or above 90% of the chosen url rate at each interval
will pass the test, otherwise it will fail
Use './test_ipv4_l4_ftp_urls_per_ten.py --help' to see command line usage and options
"""
import sys import sys
import os import os
if sys.version_info[0] != 3: if sys.version_info[0] != 3:

View File

@@ -1,5 +1,13 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
"""
This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic over ftp.
A test will run for a specified amount of time with periodic checks for traffic successfully being received. The test will
monitor the bytes-wr column of the endpoints. An increase at every test interval will pass the test, otherwise it will fail
Use './test_ipv4_l4_ftp_wifi.py --help' to see command line usage and options
"""
import sys import sys
if sys.version_info[0] != 3: if sys.version_info[0] != 3:
@@ -160,7 +168,7 @@ def main():
# formatter_class=argparse.RawDescriptionHelpFormatter, # formatter_class=argparse.RawDescriptionHelpFormatter,
formatter_class=argparse.RawTextHelpFormatter, formatter_class=argparse.RawTextHelpFormatter,
epilog='''\ epilog='''\
Create layer-4 endpoints and test that the bytes-rd from the chosen URL are increasing over the Create layer-4 endpoints and test that the bytes-wr from the chosen URL are increasing over the
duration of the test duration of the test
''', ''',

View File

@@ -1,5 +1,14 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
"""
This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic.
A test will run a specified number of times with periodic checks for traffic successfully being received every ten minutes.
The test will monitor the urls/s column of the endpoints. Being at or above 90% of the chosen url rate at each interval
will pass the test, otherwise it will fail
Use './test_ipv4_l4_urls_per_ten.py --help' to see command line usage and options
"""
import sys import sys
import os import os
if sys.version_info[0] != 3: if sys.version_info[0] != 3:

View File

@@ -1,5 +1,13 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
"""
This script will create a variable number of stations that will attempt to use layer 4 endpoints to generate traffic.
A test will run for a specified amount of time with periodic checks for traffic successfully being received. The test will
monitor the bytes-rd column of the endpoints. An increase at every test interval will pass the test, otherwise it will fail
Use './test_ipv4_l4_wifi.py --help' to see command line usage and options
"""
import sys import sys
if sys.version_info[0] != 3: if sys.version_info[0] != 3: