scottk/wlan-lanforge-scripts
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/wlan-lanforge-scripts.git synced 2025-10-31 10:48:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation for py-scripts

Browse Source
This commit is contained in:
Logan Lipke
2021-04-23 17:38:36 -07:00
parent 810377b16e
commit c7754f9c7e
1 changed files with 57 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@@ -95,16 +95,60 @@ Test scripts and helper scripts
| Name | Purpose |
|------|---------|
| `lf_tos_test.py` | Generate traffic at different QoS and report performance in a spreadsheet |
| `lf_sniff.py` | Create packet capture files, especially OFDMA /AX captures |
| `cicd_TipIntegration.py` | Facebook TIP infrastructure|
| `cicd_testrail.py` | TestRail API binding for Python 3 |
| `cicd_testrailAndInfraSetup.py` | Facebook TIP infrastructure |
| `connection_test.py` | Standard Script for Connection Testing - Creates HTML and pdf report as a result (Used for web-console) |
| `create_bond.py` | This script can be used to create a bond |
| `create_bridge.py` | Script for creating a variable number of bridges |
| `create_chamberview.py` | Script for creating a chamberview scenario |
| `create_l3.py` | This script will create a variable number of layer3 stations each with their own set of cross-connects and endpoints |
| `create_l4.py` | This script will create a variable number of layer4 stations each with their own set of cross-connects and endpoints |
| `create_macvlan.py` | Script for creating a variable number of macvlans |
| `create_qvlan.py` | Script for creating a variable number of qvlans |
| `create_station.py` | Script for creating a variable number of stations |
| `create_station_from_df.py` | Script for creating a variable number of stations from a file |
| `create_vap.py` | Script for creating a variable number of VAPs |
| `create_vr.py` | Script for creating a variable number of bridges |
| `csv_convert.py` | Python script to read in a LANforge Dataplane CSV file and output a csv file that works with a customer's RvRvO visualization tool.|
| `csv_processor.py` | Python script to assist processing csv files|
| `csv_to_influx.py` | Python script to copy the data from a CSV file from the KPI file generated from a Wifi Capacity test to an Influx database|
| `download_test.py` | download_test.py will do lf_report::add_kpi(tags, 'throughput-download-bps', $my_value);|
| `event_breaker.py` | This file is intended to expose concurrency problems in the /events/ URL handler by querying events rapidly. Please use concurrently with event_flood.py. |
| `event_flood.py` | This file is intended to expose concurrency problems in the /events/ URL handler by inserting events rapidly. Please concurrently use with event_breaker.py.|
| `example_security_connection.py` | This python script creates a variable number of stations using user-input security
| `ftp_html.py` | This FTP Test is used to "Verify that N clients connected on Specified band and can simultaneously download some amount of file from FTP server and measures the time taken by client to Download/Upload the file |
| `grafana_profile.py` | Class for creating and managing a grafana dashboard |
| `html_template.py` | This script is used for DFS Test Report generation |
| `influx.py` | Class for communicating with influx |
| `influx2.py` | Class for communicating with influx |
| `layer3_test.py` | Python script to test and monitor layer 3 connections |
| `layer4_test.py` | Python script to test and monitor layer 4 connections |
| `lf_ap_auto_test.py` | This script is used to automate running AP-Auto tests |
| `lf_dataplane_test.py` | This script is used to automate running Dataplane tests |
| `lf_dfs_test.py` | Test testing dynamic frequency selection (dfs) between an AP connected to a controller and Lanforge|
| `lf_snp_test.py` | Test scaling and performance (snp) run various configurations and measures data rates |
| `lf_dut_sta_vap_test.py` | Load an existing scenario, start some layer 3 traffic, and test the Linux based DUT that has SSH server |
| `lf_ftp_test.py` | Python script will create stations and endpoints to generate and verify layer-4 traffic over an ftp connection |
| `lf_graph.py` | Classes for creating images from graphs using data sets |
| `lf_mesh_test.py` | This script is used to automate running Mesh tests |
| `lf_report.py` | This program is a helper class for reporting results for a lanforge python script |
| `lf_report_test.py` | Python script to test reporting |
| `lf_rvr_test.py` | This script is used to automate running Rate-vs-Range tests |
| `lf_snp_test.py` | Test scaling and performance (snp) run various configurations and measures data rates |
| `lf_tr398_test.py` | This script is used to automate running TR398 tests |
| `lf_wifi_capacity_test.py` | This is a test file which will run a wifi capacity test |
| `recordinflux.py` | recordinflux will record data from existing lanforge endpoints to record to an already existing influx database |
| `run_cv_scenario.py` | Set the LANforge to a BLANK database then it will load the specified database and start a graphical report |
| `rvr_scenario.py` | This script will set the LANforge to a BLANK database then it will load the specified database and start a graphical report |
| `scenario.py` | Python script to load a database file and control test groups |
| `sta_connect.py` | Create a station, run TCP and UDP traffic then verify traffic was received. Stations are cleaned up afterwards |
| `sta_connect2.py` | Create a station, run TCP and UDP traffic then verify traffic was received. Stations are cleaned up afterwards |
| `sta_connect_example.py` | Example of how to instantiate StaConnect and run the test |
| `sta_connect_multi_example.py` | Example of how to instantiate StaConnect and run the test |
| `station_layer3.py` | this script creates one station with given arguments |
| `stations_connected.py` | Contains examples of using realm to query stations and get specific information from them |
| `test_1k_clients_jedtest.py` | Python script to test 1k client connections |
| `test_client_admission.py` | This script will create one station at a time and generate downstream traffic |
| `test_fileio.py` | Test FileIO traffic |
| `test_generic.py` | Test generic traffic using generic cross-connect and endpoint type |
| `test_ipv4_connection.py` | Test connections to a VAP of varying security types (WEP, WPA, WPA2, WPA3, Open) |
@@ -120,9 +164,19 @@ Test scripts and helper scripts
| `test_ipv6_variable_time.py` | Test IPV6 connection and traffic on VAPs of varying security types (WEP, WPA, WPA2, WPA3, Open) |
| `test_l3_WAN_LAN.py` | Test traffic over a bridged NAT connection |
| `test_l3_longevity.py` | Create variable stations on multiple radios, configurable rates, PDU, ToS, TCP and/or UDP traffic, upload and download, attenuation |
| `test_l3_powersave_traffic.py` | Python script to test for layer 3 powersave traffic |
| `test_l3_scenario_throughput.py` | Load an existing scenario and run the simultaneous throughput over time and generate report and P=plot the G=graph|
| `test_l3_unicast_traffic_gen.py` | Generate unicast traffic over a list of stations|
| `test_status_msg.py` | Test the status message passing functions of /status-msg |
| `test_wanlink.py` | Python script to test wanlink creation |
| `test_wpa_passphrases.py` | Python script to test challenging wpa psk passphrases |
| `testgroup.py` | Python script to test creation and control of test groups |
| `testgroup2.py` | Python script to test creation and control of test groups |
| `tip_station_powersave.py` | Generate and test for powersave packets within traffic run over multiple stations |
| `update_dependencies.py` | Python script to update dependencies for various Candelatech python scripts |
| `update_dut.py` | This script updates a Device Under Test (DUT) entry in the LANforge test scenario |
| `wlan_capacity_calculator.py` | Standard Script for WLAN Capacity Calculator |
| `ws_generic_monitor_test.py` | This example is to demonstrate ws_generic_monitor to monitor events triggered by scripts, This script when running, will monitor the events triggered by test_ipv4_connection.py |
## Perl and Shell Scripts ##