From 258f2666143138f20d84665fcfed53475bc88041 Mon Sep 17 00:00:00 2001 From: Vratko Polak Date: Tue, 16 Apr 2019 16:32:59 +0200 Subject: Clean up traffic_profile vs osi_layer The two types were not well distinguished before. Error introduced in: https://gerrit.fd.io/r/#/c/17811/84/resources/libraries/robot/performance/performance_setup.robot@255 Error hotfixed in: https://gerrit.fd.io/r/#/c/18847/4/resources/libraries/robot/shared/default.robot@109 + Rename some arguments and improve method docstrings. Newly introduced argument name osi_layer should be dissimilar enough. Change-Id: Ie0f6f97dc010fc6477f09c54574970f1d15462e2 Signed-off-by: Vratko Polak --- .../robot/performance/performance_utils.robot | 36 +++++++++++++--------- 1 file changed, 21 insertions(+), 15 deletions(-) (limited to 'resources/libraries/robot/performance/performance_utils.robot') diff --git a/resources/libraries/robot/performance/performance_utils.robot b/resources/libraries/robot/performance/performance_utils.robot index 80fddc671a..45d8efe535 100644 --- a/resources/libraries/robot/performance/performance_utils.robot +++ b/resources/libraries/robot/performance/performance_utils.robot @@ -53,10 +53,11 @@ | | ... | Some inputs are read from variables to streamline suites. | | ... | | ... | *Test (or broader scope) variables read:* -| | ... | - traffic_profile - Topology type. Type: string -| | ... | - frame_size - L2 Frame Size [B] or IMIX string. Type: int or str -| | ... | - max_rate - Calculated unidirectional maximal transmit rate [pps]. -| | ... | Type: float +| | ... | - traffic_profile - Name of module defining traffc for measurements. +| | ... | Type: string +| | ... | - frame_size - L2 Frame Size [B] or IMIX string. Type: int or str +| | ... | - max_rate - Calculated unidirectional maximal transmit rate [pps]. +| | ... | Type: float | | ... | | ... | *Arguments:* | | ... | - packet_loss_ratio - Accepted loss during search. Type: float @@ -101,10 +102,11 @@ | | ... | Some inputs are read from variables to streamline suites. | | ... | | ... | *Test (or broader scope) variables read:* -| | ... | - traffic_profile - Topology type. Type: string -| | ... | - frame_size - L2 Frame Size [B] or IMIX string. Type: int or str -| | ... | - max_rate - Calculated unidirectional maximal transmit rate [pps]. -| | ... | Type: float +| | ... | - traffic_profile - Name of module defining traffc for measurements. +| | ... | Type: string +| | ... | - frame_size - L2 Frame Size [B] or IMIX string. Type: int or str +| | ... | - max_rate - Calculated unidirectional maximal transmit rate [pps]. +| | ... | Type: float | | ... | | ... | *Arguments:* | | ... | - packet_loss_ratio - Accepted loss during search. Type: float @@ -261,7 +263,8 @@ | | ... | - duration - Duration of traffic run [s]. Type: integer | | ... | - rate - Rate for sending packets. Type: string | | ... | - frame_size - L2 Frame Size [B] or IMIX_v4_1. Type: integer/string -| | ... | - traffic_profile - Topology type. Type: string +| | ... | - traffic_profile - Name of module defining traffc for measurements. +| | ... | Type: string | | ... | - fail_on_loss - If True, the keyword fails if loss occurred. | | ... | Type: boolean | | ... @@ -284,10 +287,11 @@ | | ... | Some inputs are read from variables to streamline suites. | | ... | | ... | *Test (or broader scope) variables read:* -| | ... | - traffic_profile - Topology type. Type: string -| | ... | - frame_size - L2 Frame Size [B] or IMIX string. Type: int or str -| | ... | - max_rate - Calculated unidirectional maximal transmit rate [pps]. -| | ... | Type: float +| | ... | - traffic_profile - Name of module defining traffc for measurements. +| | ... | Type: string +| | ... | - frame_size - L2 Frame Size [B] or IMIX string. Type: int or str +| | ... | - max_rate - Calculated unidirectional maximal transmit rate [pps]. +| | ... | Type: float | | ... | | ... | *Arguments:* | | ... | - subsamples - How many trials in this measurement. Type: int @@ -326,7 +330,8 @@ | | ... | - trial_duration - Duration of single trial [s]. Type: float | | ... | - rate - Rate for sending packets. Type: string | | ... | - frame_size - L2 Frame Size [B]. Type: integer/string -| | ... | - traffic_profile - Topology type. Type: string +| | ... | - traffic_profile - Name of module defining traffc for measurements. +| | ... | Type: string | | ... | - subsamples - How many trials in this measurement. Type: int | | ... | - unidirection - False if traffic is bidirectional. Type: boolean | | ... | - tx_port - TX port of TG, default 0. Type: integer @@ -377,7 +382,8 @@ | | ... | - duration - Duration of traffic run [s]. Type: integer | | ... | - rate - Rate for sending packets. Type: string | | ... | - frame_size - L2 Frame Size [B] or IMIX_v4_1. Type: integer/string -| | ... | - traffic_profile - Topology type. Type: string +| | ... | - traffic_profile - Name of module defining traffc for measurements. +| | ... | Type: string | | ... | - unidirection - False if traffic is bidirectional. Type: boolean | | ... | - tx_port - TX port of TG, default 0. Type: integer | | ... | - rx_port - RX port of TG, default 1. Type: integer -- cgit 1.2.3-korg