Report: Fix listing order of new vs. see footnote

[csit.git] / resources / tools / presentation / generator_tables.py

diff --git a/resources/tools/presentation/generator_tables.py b/resources/tools/presentation/generator_tables.py
index cf8ac45..52f9573 100644 (file)
--- a/resources/tools/presentation/generator_tables.py
+++ b/resources/tools/presentation/generator_tables.py
@@ -411,18 +411,44 @@ def table_performance_comparison(table, input_data):
             item.append(round(stdev(data_t) / 1000000, 2))
         else:
             item.extend(["Not tested", "Not tested"])
-        if item[-4] is not None and item[-2] is not None and item[-4] != 0:
-            item.append(int(relative_change(float(item[-4]), float(item[-2]))))
-        elif item[-4] is None or item[-2] is None or item[-4] == 0:
+        if item[-2] == "Not tested":
+            pass
+        elif item[-4] == "Not tested":
             item.append("New in CSIT-1908")
         elif topo == "2n-skx" and "dot1q" in tbl_dict[tst_name]["name"]:
             item.append("See footnote [1]")
             footnote = True
-        if (len(item) == len(header)) and (item[-3] is not None):
+        elif item[-4] != 0:
+            item.append(int(relative_change(float(item[-4]), float(item[-2]))))
+        if (len(item) == len(header)) and (item[-3] != "Not tested"):
             tbl_lst.append(item)
 
-    # Sort the table according to the relative change
-    tbl_lst.sort(key=lambda rel: rel[-1], reverse=True)
+    # Sort the table:
+    # 1. New in CSIT-XXXX
+    # 2. See footnote
+    # 3. Delta
+    tbl_new = list()
+    tbl_see = list()
+    tbl_delta = list()
+    for item in tbl_lst:
+        if "New in CSIT" in item[-1]:
+            tbl_new.append(item)
+        elif "See footnote" in item[-1]:
+            tbl_see.append(item)
+        else:
+            tbl_delta.append(item)
+
+    # Sort the tables:
+    tbl_new.sort(key=lambda rel: rel[0], reverse=False)
+    tbl_see.sort(key=lambda rel: rel[0], reverse=False)
+    tbl_see.sort(key=lambda rel: rel[-1], reverse=False)
+    tbl_delta.sort(key=lambda rel: rel[-1], reverse=True)
+
+    # Put the tables together:
+    tbl_lst = list()
+    tbl_lst.extend(tbl_new)
+    tbl_lst.extend(tbl_see)
+    tbl_lst.extend(tbl_delta)
 
     # Generate csv tables:
     csv_file = "{0}.csv".format(table["output-file"])
@@ -437,13 +463,13 @@ def table_performance_comparison(table, input_data):
     if footnote:
         with open(txt_file_name, 'a') as txt_file:
             txt_file.writelines([
-                "Footnotes:",
+                "\nFootnotes:\n",
                 "[1] CSIT-1908 changed test methodology of dot1q tests in "
-                "2n-skx testbeds, dot1q encapsulation is now used on both "
-                "links of SUT.",
+                "2-node testbeds, dot1q encapsulation is now used on both "
+                "links of SUT.\n",
                 "    Previously dot1q was used only on a single link with the "
-                "other link carrying untagged Ethernet frames. This change "
-                "results",
+                "other link carrying untagged Ethernet frames. This changes "
+                "results\n",
                 "    in slightly lower throughput in CSIT-1908 for these "
                 "tests. See release notes."
             ])
@@ -679,18 +705,44 @@ def table_performance_comparison_nic(table, input_data):
             item.append(round(stdev(data_t) / 1000000, 2))
         else:
             item.extend(["Not tested", "Not tested"])
-        if item[-4] is not None and item[-2] is not None and item[-4] != 0:
-            item.append(int(relative_change(float(item[-4]), float(item[-2]))))
-        elif item[-4] is None or item[-2] is None or item[-4] == 0:
+        if item[-2] == "Not tested":
+            pass
+        elif item[-4] == "Not tested":
             item.append("New in CSIT-1908")
         elif topo == "2n-skx" and "dot1q" in tbl_dict[tst_name]["name"]:
             item.append("See footnote [1]")
             footnote = True
-        if (len(item) == len(header)) and (item[-3] is not None):
+        elif item[-4] != 0:
+            item.append(int(relative_change(float(item[-4]), float(item[-2]))))
+        if (len(item) == len(header)) and (item[-3] != "Not tested"):
             tbl_lst.append(item)
 
-    # Sort the table according to the relative change
-    tbl_lst.sort(key=lambda rel: rel[-1], reverse=True)
+    # Sort the table:
+    # 1. New in CSIT-XXXX
+    # 2. See footnote
+    # 3. Delta
+    tbl_new = list()
+    tbl_see = list()
+    tbl_delta = list()
+    for item in tbl_lst:
+        if "New in CSIT" in item[-1]:
+            tbl_new.append(item)
+        elif "See footnote" in item[-1]:
+            tbl_see.append(item)
+        else:
+            tbl_delta.append(item)
+
+    # Sort the tables:
+    tbl_new.sort(key=lambda rel: rel[0], reverse=False)
+    tbl_see.sort(key=lambda rel: rel[0], reverse=False)
+    tbl_see.sort(key=lambda rel: rel[-1], reverse=False)
+    tbl_delta.sort(key=lambda rel: rel[-1], reverse=True)
+
+    # Put the tables together:
+    tbl_lst = list()
+    tbl_lst.extend(tbl_new)
+    tbl_lst.extend(tbl_see)
+    tbl_lst.extend(tbl_delta)
 
     # Generate csv tables:
     csv_file = "{0}.csv".format(table["output-file"])
@@ -705,13 +757,13 @@ def table_performance_comparison_nic(table, input_data):
     if footnote:
         with open(txt_file_name, 'a') as txt_file:
             txt_file.writelines([
-                "Footnotes:",
+                "\nFootnotes:\n",
                 "[1] CSIT-1908 changed test methodology of dot1q tests in "
-                "2n-skx testbeds, dot1q encapsulation is now used on both "
-                "links of SUT.",
+                "2-node testbeds, dot1q encapsulation is now used on both "
+                "links of SUT.\n",
                 "    Previously dot1q was used only on a single link with the "
-                "other link carrying untagged Ethernet frames. This change "
-                "results",
+                "other link carrying untagged Ethernet frames. This changes "
+                "results\n",
                 "    in slightly lower throughput in CSIT-1908 for these "
                 "tests. See release notes."
             ])
@@ -740,9 +792,9 @@ def table_nics_comparison(table, input_data):
         header = ["Test case", ]
 
         if table["include-tests"] == "MRR":
-            hdr_param = "Receive Rate"
+            hdr_param = "Rec Rate"
         else:
-            hdr_param = "Throughput"
+            hdr_param = "Thput"
 
         header.extend(
             ["{0} {1} [Mpps]".format(table["reference"]["title"], hdr_param),
@@ -849,9 +901,9 @@ def table_soak_vs_ndr(table, input_data):
     try:
         header = [
             "Test case",
-            "{0} Throughput [Mpps]".format(table["reference"]["title"]),
+            "{0} Thput [Mpps]".format(table["reference"]["title"]),
             "{0} Stdev [Mpps]".format(table["reference"]["title"]),
-            "{0} Throughput [Mpps]".format(table["compare"]["title"]),
+            "{0} Thput [Mpps]".format(table["compare"]["title"]),
             "{0} Stdev [Mpps]".format(table["compare"]["title"]),
             "Delta [%]", "Stdev of delta [%]"]
         header_str = ",".join(header) + "\n"