Updated docstring use to fit with standards

This commit is contained in:
Logan Lipke
2021-01-07 15:25:15 -08:00
parent a739cf928b
commit 8a29d5df48
4 changed files with 42 additions and 35 deletions

View File

@@ -1,17 +1,19 @@
#!/usr/bin/env python3
"""
- This script will create a variable number of stations or macvlans to test fileio traffic. Pre-existing stations and
macvlans can be used as well. Command line options are available to update cross-connects as well as using a list of
existing cross-connects if desired. if none are given, cross-connects and endpoints will be created by the script.
Modes such as read-only, write-only, or both can be specified as well as ip addresses and starting numbers for sequential
stations or macvlans that are created in case of limited or pre-existing configurations. The test that is run during
this script will depend on the mode used, a read-only test will check the read-bps column, write-only will check write-bps
and both will check both columns. If the relevant columns increase over the duration of the test it will pass,
otherwise it will fail.
- Use './test_fileio.py --help' to see command line usage and options
- Copyright 2021 Candela Technologies Inc
- License: Free to distribute and modify. LANforge systems must be licensed.
"""test_fileio.py will create stations or macvlans with matching fileio endpoints to generate and verify fileio related traffic.
This script will create a variable number of stations or macvlans to test fileio traffic. Pre-existing stations and
macvlans can be used as well. Command line options are available to update cross-connects as well as using a list of
existing cross-connects if desired. if none are given, cross-connects and endpoints will be created by the script.
Modes such as read-only, write-only, or both can be specified as well as ip addresses and starting numbers for sequential
stations or macvlans that are created in case of limited or pre-existing configurations. The test that is run during
this script will depend on the mode used, a read-only test will check the read-bps column, write-only will check write-bps
and both will check both columns. If the relevant columns increase over the duration of the test it will pass,
otherwise it will fail.
Use './test_fileio.py --help' to see command line usage and options
Copyright 2021 Candela Technologies Inc
License: Free to distribute and modify. LANforge systems must be licensed.
"""
import sys

View File

@@ -1,13 +1,15 @@
#!/usr/bin/env python3
"""
- This script will create a variable number of stations to test generic endpoints. Multiple command types can be tested
including ping, speedtest, generic types. The test will check the last result column for different things
depending on what test is being run. Ping will test for successful pings, speedtest will test for download
speed, upload speed, and ping time, generic will test for successful generic commands
- Use './test_generic.py --help' to see command line usage and options
- Copyright 2021 Candela Technologies Inc
- License: Free to distribute and modify. LANforge systems must be licensed.
"""test_generic.py will create stations and endpoints to generate traffic based on a command-line specified command type.
This script will create a variable number of stations to test generic endpoints. Multiple command types can be tested
including ping, speedtest, generic types. The test will check the last result column for different things
depending on what test is being run. Ping will test for successful pings, speedtest will test for download
speed, upload speed, and ping time, generic will test for successful generic commands
Use './test_generic.py --help' to see command line usage and options
Copyright 2021 Candela Technologies Inc
License: Free to distribute and modify. LANforge systems must be licensed.
"""
import pprint

View File

@@ -1,13 +1,14 @@
#!/usr/bin/env python3
"""
- Script for creating a variable number of stations and attempting to connect them to an SSID.
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.
- Use './test_ipv4_connection.py' --help to see command line usage and options
- Copyright 2021 Candela Technologies Inc
- License: Free to distribute and modify. LANforge systems must be licensed.
- See cookbook here: https://www.candelatech.com/....?
"""test_ipv4_connection.py will create stations and attempt to connect to an SSID, WPA, WPA2, WPA3, WEP, and Open connection types are supported
Script for creating a variable number of stations and attempting to connect them to an SSID.
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.
Use './test_ipv4_connection.py' --help to see command line usage and options
Copyright 2021 Candela Technologies Inc
License: Free to distribute and modify. LANforge systems must be licensed.
"""
import sys

View File

@@ -1,12 +1,14 @@
#!/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
- Copyright 2021 Candela Technologies Inc
- License: Free to distribute and modify. LANforge systems must be licensed.
"""test_ipv4_l4.py will create stations and endpoints to generate and verify layer-4 traffic
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
Copyright 2021 Candela Technologies Inc
License: Free to distribute and modify. LANforge systems must be licensed.
"""
import sys