UTI: Export results

[csit.git] / resources / libraries / python / Constants.py

diff --git a/resources/libraries/python/Constants.py b/resources/libraries/python/Constants.py
index c6c9bca..672ce87 100644 (file)
--- a/resources/libraries/python/Constants.py
+++ b/resources/libraries/python/Constants.py
@@ -119,6 +119,12 @@ def get_optimistic_bool_from_env(env_var_names):
 class Constants:
     """Constants used in CSIT."""
 
+    # Version for CSIT data model. See docs/model/.
+    MODEL_VERSION = u"1.0.0"
+
+    # Global off-switch in case JSON export is large or slow.
+    EXPORT_JSON = get_optimistic_bool_from_env(u"EXPORT_JSON")
+
     # OpenVPP testing directory location at topology nodes
     REMOTE_FW_DIR = u"/tmp/openvpp-testing"
 
@@ -331,6 +337,18 @@ class Constants:
         u"Mellanox-CX556A": u"100ge2p1cx556a",
     }
 
+    # Shortened lowercase NIC model name, useful for presentation.
+    NIC_CODE_TO_SHORT_NAME = {
+        u"10ge2p1x520": u"x520",
+        u"10ge2p1x553": u"x553",
+        u"10ge2p1x710": u"x710",
+        u"40ge2p1xl710": u"xl710",
+        u"25ge2p1xxv710": u"xxv710",
+        u"100ge2p1e810cq": u"e810cq",
+        u"50ge1p1ENA": u"ena",
+        u"100ge2p1cx556a": u"cx556a",
+    }
+
     # Not each driver is supported by each NIC.
     NIC_NAME_TO_DRIVER = {
         u"Intel-X520-DA2": [u"vfio-pci", u"af_xdp"],
@@ -428,23 +446,24 @@ class Constants:
     }
 
     PERF_TYPE_TO_SUITE_DOC_VER = {
-        u"mrr": u'''fication:* In MaxReceivedRate tests TG sends traffic\\
-| ... | at line rate and reports total received packets over trial period.\\''',
-        u"ndrpdr": u'''ication:* TG finds and reports throughput NDR (Non Drop\\
-| ... | Rate) with zero packet loss tolerance and throughput PDR (Partial Drop\\
-| ... | Rate) with non-zero packet loss tolerance (LT) expressed in percentage\\
-| ... | of packets transmitted. NDR and PDR are discovered for different\\
-| ... | Ethernet L2 frame sizes using MLRsearch library.\\''',
-        u"soak": u'''fication:* TG sends traffic at dynamically computed\\
-| ... | rate as PLRsearch algorithm gathers data and improves its estimate\\
-| ... | of a rate at which a prescribed small fraction of packets\\
-| ... | would be lost. After set time, the serarch stops\\
-| ... | and the algorithm reports its current estimate.\\''',
+        u"mrr": u'''fication:** In MaxReceivedRate tests TG sends traffic at \\
+| ... | line rate and reports total received packets over trial period. \\''',
+        u"ndrpdr": u'''rification:** TG finds and reports throughput NDR (Non \\
+| ... | Drop Rate) with zero packet loss tolerance and throughput PDR \\
+| ... | (Partial Drop Rate) with non-zero packet loss tolerance (LT) \\
+| ... | expressed in percentage of packets transmitted. NDR and PDR are \\
+| ... | discovered for different Ethernet L2 frame sizes using MLRsearch \\
+| ... | library.''',
+        u"soak": u'''rification:** TG sends traffic at dynamically computed \\
+| ... | rate as PLRsearch algorithm gathers data and improves its estimate \\
+| ... | of a rate at which a prescribed small fraction of packets \\
+| ... | would be lost. After set time, the serarch stops \\
+| ... | and the algorithm reports its current estimate. \\''',
     }
 
     PERF_TYPE_TO_TEMPLATE_DOC_VER = {
-        u"mrr": u'''Measure MaxReceivedRate for ${frame_size}B frames\\
-| | ... | using burst trials throughput test.\\''',
-        u"ndrpdr": u"Measure NDR and PDR values using MLRsearch algorithm.\\",
-        u"soak": u"Estimate critical rate using PLRsearch algorithm.\\",
+        u"mrr": u'''Measure MaxReceivedRate for ${frame_size}B frames \\
+| | ... | using burst trials throughput test. \\''',
+        u"ndrpdr": u"Measure NDR and PDR values using MLRsearch algorithm.",
+        u"soak": u"Estimate critical rate using PLRsearch algorithm. \\",
     }