fixup! CP-44103: Unit tests for ordering network devices

Signed-off-by: Ming Lu <[email protected]>

Author: minglumlu

ocaml/networkd/test/test_network_device_order.ml

@@ -94,6 +94,10 @@ let currents =
     }
   ]
 
+let plug dev devices = List.cons dev devices
+
+let unplug mac devices = List.filter (fun dev -> dev.Dev.mac <> mac) devices
+
 let pos_of_mac mac order =
   match List.find_opt (fun dev -> dev.mac = mac) order with
   | Some {position; _} ->
@@ -108,24 +112,22 @@ let present_of_mac mac order =
   | _ ->
       failwith "Can't find the device!"
 
+let test_postion_and_present expected_position expected_present mac order =
+  let name = Format.asprintf "Position assigned for %a" Macaddr.pp mac in
+  Alcotest.(check int) name expected_position (pos_of_mac mac order) ;
+  Alcotest.(check bool) name expected_present (present_of_mac mac order)
+
 let test_default () =
   let order = sort' ~currents ~rules:[] ~last_order:[] in
   Alcotest.(check bool) "is Ok" true (Result.is_ok order) ;
   let order = Result.get_ok order in
   Alcotest.(check int) "6 devices in the order" 6 (List.length order) ;
-  Alcotest.(check int) "position assigned" 0 (pos_of_mac mac_addr0 order) ;
-  Alcotest.(check int) "position assigned" 1 (pos_of_mac mac_addr1 order) ;
-  Alcotest.(check int) "position assigned" 2 (pos_of_mac mac_addr2 order) ;
-  Alcotest.(check int) "position assigned" 3 (pos_of_mac mac_addr3 order) ;
-  Alcotest.(check int) "position assigned" 5 (pos_of_mac mac_addr4 order) ;
-  Alcotest.(check int) "position assigned" 4 (pos_of_mac mac_addr5 order) ;
-
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr0 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr1 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr2 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr3 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr4 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr5 order)
+  test_postion_and_present 0 true mac_addr0 order ;
+  test_postion_and_present 1 true mac_addr1 order ;
+  test_postion_and_present 2 true mac_addr2 order ;
+  test_postion_and_present 3 true mac_addr3 order ;
+  test_postion_and_present 5 true mac_addr4 order ;
+  test_postion_and_present 4 true mac_addr5 order
 
 let test_initial_rules_via_mac () =
   let rules =
@@ -143,19 +145,12 @@ let test_initial_rules_via_mac () =
   Alcotest.(check bool) "is Ok" true (Result.is_ok order) ;
   let order = Result.get_ok order in
   Alcotest.(check int) "6 devices in the order" 6 (List.length order) ;
-  Alcotest.(check int) "position assigned" 5 (pos_of_mac mac_addr0 order) ;
-  Alcotest.(check int) "position assigned" 4 (pos_of_mac mac_addr1 order) ;
-  Alcotest.(check int) "position assigned" 3 (pos_of_mac mac_addr2 order) ;
-  Alcotest.(check int) "position assigned" 2 (pos_of_mac mac_addr3 order) ;
-  Alcotest.(check int) "position assigned" 1 (pos_of_mac mac_addr4 order) ;
-  Alcotest.(check int) "position assigned" 0 (pos_of_mac mac_addr5 order) ;
-
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr0 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr1 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr2 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr3 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr4 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr5 order)
+  test_postion_and_present 5 true mac_addr0 order ;
+  test_postion_and_present 4 true mac_addr1 order ;
+  test_postion_and_present 3 true mac_addr2 order ;
+  test_postion_and_present 2 true mac_addr3 order ;
+  test_postion_and_present 1 true mac_addr4 order ;
+  test_postion_and_present 0 true mac_addr5 order
 
 let test_initial_rules_via_label () =
   let rules =
@@ -173,19 +168,12 @@ let test_initial_rules_via_label () =
   Alcotest.(check bool) "is Ok" true (Result.is_ok order) ;
   let order = Result.get_ok order in
   Alcotest.(check int) "6 devices in the order" 6 (List.length order) ;
-  Alcotest.(check int) "position assigned" 5 (pos_of_mac mac_addr0 order) ;
-  Alcotest.(check int) "position assigned" 4 (pos_of_mac mac_addr1 order) ;
-  Alcotest.(check int) "position assigned" 3 (pos_of_mac mac_addr2 order) ;
-  Alcotest.(check int) "position assigned" 2 (pos_of_mac mac_addr3 order) ;
-  Alcotest.(check int) "position assigned" 1 (pos_of_mac mac_addr4 order) ;
-  Alcotest.(check int) "position assigned" 0 (pos_of_mac mac_addr5 order) ;
-
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr0 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr1 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr2 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr3 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr4 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr5 order)
+  test_postion_and_present 5 true mac_addr0 order ;
+  test_postion_and_present 4 true mac_addr1 order ;
+  test_postion_and_present 3 true mac_addr2 order ;
+  test_postion_and_present 2 true mac_addr3 order ;
+  test_postion_and_present 1 true mac_addr4 order ;
+  test_postion_and_present 0 true mac_addr5 order
 
 let test_replacement () =
   let mac_addr0' = Macaddr.of_string "fc:f4:bb:e6:d7:b8" |> Result.get_ok in
@@ -210,31 +198,20 @@ let test_replacement () =
     }
   in
   let currents =
-    currents
-    |> List.filter (fun dev -> dev.mac <> mac_addr0)
-    |> List.filter (fun dev -> dev.mac <> mac_addr1)
-    |> List.cons dev0
-    |> List.cons dev1
+    currents |> unplug mac_addr0 |> plug dev0 |> unplug mac_addr1 |> plug dev1
   in
   let order = sort' ~currents ~rules:[] ~last_order in
   Alcotest.(check bool) "is Ok" true (Result.is_ok order) ;
   let order = Result.get_ok order in
 
   Alcotest.(check int) "6 devices in the order" 6 (List.length order) ;
 
-  Alcotest.(check int) "position assigned" 0 (pos_of_mac mac_addr0' order) ;
-  Alcotest.(check int) "position assigned" 1 (pos_of_mac mac_addr1' order) ;
-  Alcotest.(check int) "position assigned" 2 (pos_of_mac mac_addr2 order) ;
-  Alcotest.(check int) "position assigned" 3 (pos_of_mac mac_addr3 order) ;
-  Alcotest.(check int) "position assigned" 4 (pos_of_mac mac_addr4 order) ;
-  Alcotest.(check int) "position assigned" 5 (pos_of_mac mac_addr5 order) ;
-
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr0' order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr1' order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr2 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr3 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr4 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr5 order)
+  test_postion_and_present 0 true mac_addr0' order ;
+  test_postion_and_present 1 true mac_addr1' order ;
+  test_postion_and_present 2 true mac_addr2 order ;
+  test_postion_and_present 3 true mac_addr3 order ;
+  test_postion_and_present 4 true mac_addr4 order ;
+  test_postion_and_present 5 true mac_addr5 order
 
 let test_adding () =
   let pci_addr6 = Pciaddr.of_string "0000:06:0f.0" |> Result.get_ok in
@@ -261,55 +238,34 @@ let test_adding () =
     }
   in
   (* Add two devices *)
-  let currents = List.rev_append currents [dev6; dev7] in
+  let currents = currents |> plug dev6 |> plug dev7 in
   let order = sort' ~currents ~rules:[] ~last_order in
   Alcotest.(check bool) "is Ok" true (Result.is_ok order) ;
   let order = Result.get_ok order in
   Alcotest.(check int) "8 devices in the order" 8 (List.length order) ;
-  Alcotest.(check int) "position assigned" 0 (pos_of_mac mac_addr0 order) ;
-  Alcotest.(check int) "position assigned" 1 (pos_of_mac mac_addr1 order) ;
-  Alcotest.(check int) "position assigned" 2 (pos_of_mac mac_addr2 order) ;
-  Alcotest.(check int) "position assigned" 3 (pos_of_mac mac_addr3 order) ;
-  Alcotest.(check int) "position assigned" 4 (pos_of_mac mac_addr4 order) ;
-  Alcotest.(check int) "position assigned" 5 (pos_of_mac mac_addr5 order) ;
-  Alcotest.(check int) "position assigned" 6 (pos_of_mac mac_addr7 order) ;
-  Alcotest.(check int) "position assigned" 7 (pos_of_mac mac_addr6 order) ;
-
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr0 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr1 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr2 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr3 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr4 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr5 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr6 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr7 order)
+  test_postion_and_present 0 true mac_addr0 order ;
+  test_postion_and_present 1 true mac_addr1 order ;
+  test_postion_and_present 2 true mac_addr2 order ;
+  test_postion_and_present 3 true mac_addr3 order ;
+  test_postion_and_present 4 true mac_addr4 order ;
+  test_postion_and_present 5 true mac_addr5 order ;
+  test_postion_and_present 6 true mac_addr7 order ;
+  test_postion_and_present 7 true mac_addr6 order
 
 let test_removing () =
   (* Remove two devices *)
-  let currents =
-    let open Dev in
-    currents
-    |> List.filter (fun dev -> dev.mac <> mac_addr0)
-    |> List.filter (fun dev -> dev.mac <> mac_addr1)
-  in
+  let currents = currents |> unplug mac_addr0 |> unplug mac_addr1 in
   let order = sort' ~currents ~rules:[] ~last_order in
   Alcotest.(check bool) "is Ok" true (Result.is_ok order) ;
   let order = Result.get_ok order in
 
   Alcotest.(check int) "6 devices in the order" 6 (List.length order) ;
-  Alcotest.(check int) "position assigned" 0 (pos_of_mac mac_addr0 order) ;
-  Alcotest.(check int) "position assigned" 1 (pos_of_mac mac_addr1 order) ;
-  Alcotest.(check int) "position assigned" 2 (pos_of_mac mac_addr2 order) ;
-  Alcotest.(check int) "position assigned" 3 (pos_of_mac mac_addr3 order) ;
-  Alcotest.(check int) "position assigned" 4 (pos_of_mac mac_addr4 order) ;
-  Alcotest.(check int) "position assigned" 5 (pos_of_mac mac_addr5 order) ;
-
-  Alcotest.(check bool) "present" false (present_of_mac mac_addr0 order) ;
-  Alcotest.(check bool) "present" false (present_of_mac mac_addr1 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr2 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr3 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr4 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr5 order)
+  test_postion_and_present 0 false mac_addr0 order ;
+  test_postion_and_present 1 false mac_addr1 order ;
+  test_postion_and_present 2 true mac_addr2 order ;
+  test_postion_and_present 3 true mac_addr3 order ;
+  test_postion_and_present 4 true mac_addr4 order ;
+  test_postion_and_present 5 true mac_addr5 order
 
 let test_replug () =
   let dev0 =
@@ -330,19 +286,12 @@ let test_replug () =
   Alcotest.(check bool) "is Ok" true (Result.is_ok order) ;
   let order = Result.get_ok order in
   Alcotest.(check int) "6 devices in the order" 6 (List.length order) ;
-  Alcotest.(check int) "position assigned" 0 (pos_of_mac mac_addr0 order) ;
-  Alcotest.(check int) "position assigned" 1 (pos_of_mac mac_addr1 order) ;
-  Alcotest.(check int) "position assigned" 2 (pos_of_mac mac_addr2 order) ;
-  Alcotest.(check int) "position assigned" 3 (pos_of_mac mac_addr3 order) ;
-  Alcotest.(check int) "position assigned" 4 (pos_of_mac mac_addr4 order) ;
-  Alcotest.(check int) "position assigned" 5 (pos_of_mac mac_addr5 order) ;
-
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr0 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr1 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr2 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr3 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr4 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr5 order)
+  test_postion_and_present 0 true mac_addr0 order ;
+  test_postion_and_present 1 true mac_addr1 order ;
+  test_postion_and_present 2 true mac_addr2 order ;
+  test_postion_and_present 3 true mac_addr3 order ;
+  test_postion_and_present 4 true mac_addr4 order ;
+  test_postion_and_present 5 true mac_addr5 order
 
 let test_multi_nic_inplace_reorder () =
   let mac_addr4' = Macaddr.of_string "01:02:c9:ed:fd:f0" |> Result.get_ok in
@@ -378,19 +327,12 @@ let test_multi_nic_inplace_reorder () =
   Alcotest.(check bool) "is Ok" true (Result.is_ok order) ;
   let order = Result.get_ok order in
   Alcotest.(check int) "6 devices in the order" 6 (List.length order) ;
-  Alcotest.(check int) "position assigned" 0 (pos_of_mac mac_addr0 order) ;
-  Alcotest.(check int) "position assigned" 1 (pos_of_mac mac_addr1 order) ;
-  Alcotest.(check int) "position assigned" 2 (pos_of_mac mac_addr2 order) ;
-  Alcotest.(check int) "position assigned" 3 (pos_of_mac mac_addr3 order) ;
-  Alcotest.(check int) "position assigned" 4 (pos_of_mac mac_addr4' order) ;
-  Alcotest.(check int) "position assigned" 5 (pos_of_mac mac_addr5' order) ;
-
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr0 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr1 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr2 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr3 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr4' order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr5' order)
+  test_postion_and_present 0 true mac_addr0 order ;
+  test_postion_and_present 1 true mac_addr1 order ;
+  test_postion_and_present 2 true mac_addr2 order ;
+  test_postion_and_present 3 true mac_addr3 order ;
+  test_postion_and_present 4 true mac_addr4' order ;
+  test_postion_and_present 5 true mac_addr5' order
 
 let test_multi_nic_new_devices () =
   let mac_addr6 = Macaddr.of_string "01:02:c9:ed:fd:f0" |> Result.get_ok in
@@ -415,29 +357,21 @@ let test_multi_nic_new_devices () =
       ; multi_nic= true
       }
   in
-  (* New devices are reported on the same PCI address. *)
-  let currents = currents |> List.cons dev6 |> List.cons dev7 in
+  (* New devices are reported on the same PCI address.
+     It's equivalent to plugging new devices but locate at the same PCI address. *)
+  let currents = currents |> plug dev6 |> plug dev7 in
   let order = sort' ~currents ~rules:[] ~last_order in
   Alcotest.(check bool) "is Ok" true (Result.is_ok order) ;
   let order = Result.get_ok order in
   Alcotest.(check int) "8 devices in the order" 8 (List.length order) ;
-  Alcotest.(check int) "position assigned" 0 (pos_of_mac mac_addr0 order) ;
-  Alcotest.(check int) "position assigned" 1 (pos_of_mac mac_addr1 order) ;
-  Alcotest.(check int) "position assigned" 2 (pos_of_mac mac_addr2 order) ;
-  Alcotest.(check int) "position assigned" 3 (pos_of_mac mac_addr3 order) ;
-  Alcotest.(check int) "position assigned" 4 (pos_of_mac mac_addr4 order) ;
-  Alcotest.(check int) "position assigned" 5 (pos_of_mac mac_addr5 order) ;
-  Alcotest.(check int) "position assigned" 6 (pos_of_mac mac_addr6 order) ;
-  Alcotest.(check int) "position assigned" 7 (pos_of_mac mac_addr7 order) ;
-
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr0 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr1 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr2 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr3 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr4 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr5 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr6 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr7 order)
+  test_postion_and_present 0 true mac_addr0 order ;
+  test_postion_and_present 1 true mac_addr1 order ;
+  test_postion_and_present 2 true mac_addr2 order ;
+  test_postion_and_present 3 true mac_addr3 order ;
+  test_postion_and_present 4 true mac_addr4 order ;
+  test_postion_and_present 5 true mac_addr5 order ;
+  test_postion_and_present 6 true mac_addr6 order ;
+  test_postion_and_present 7 true mac_addr7 order
 
 let test_pci_changes () =
   let move_bus_by_1 pci_addr = Xcp_pci.{pci_addr with bus= pci_addr.bus + 1} in
@@ -448,19 +382,27 @@ let test_pci_changes () =
   Alcotest.(check bool) "is Ok" true (Result.is_ok order) ;
   let order = Result.get_ok order in
   Alcotest.(check int) "6 devices in the order" 6 (List.length order) ;
-  Alcotest.(check int) "position assigned" 0 (pos_of_mac mac_addr0 order) ;
-  Alcotest.(check int) "position assigned" 1 (pos_of_mac mac_addr1 order) ;
-  Alcotest.(check int) "position assigned" 2 (pos_of_mac mac_addr2 order) ;
-  Alcotest.(check int) "position assigned" 3 (pos_of_mac mac_addr3 order) ;
-  Alcotest.(check int) "position assigned" 4 (pos_of_mac mac_addr4 order) ;
-  Alcotest.(check int) "position assigned" 5 (pos_of_mac mac_addr5 order) ;
-
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr0 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr1 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr2 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr3 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr4 order) ;
-  Alcotest.(check bool) "present" true (present_of_mac mac_addr5 order)
+  test_postion_and_present 0 true mac_addr0 order ;
+  test_postion_and_present 1 true mac_addr1 order ;
+  test_postion_and_present 2 true mac_addr2 order ;
+  test_postion_and_present 3 true mac_addr3 order ;
+  test_postion_and_present 4 true mac_addr4 order ;
+  test_postion_and_present 5 true mac_addr5 order
+
+let test_pci_addr_compare () =
+  let addr0 = Pciaddr.of_string "0000:01:0e.0" |> Result.get_ok in
+  let addr1 = Pciaddr.of_string "0000:01:0e.0" |> Result.get_ok in
+  let addr2 = Pciaddr.of_string "0000:01:0e.2" |> Result.get_ok in
+  let addr3 = Pciaddr.of_string "0000:01:0e.3" |> Result.get_ok in
+  let addr4 = Pciaddr.of_string "0000:01:0f.0" |> Result.get_ok in
+  let addr5 = Pciaddr.of_string "0000:02:0f.0" |> Result.get_ok in
+  let addr6 = Pciaddr.of_string "0001:02:0f.0" |> Result.get_ok in
+  Alcotest.(check bool) "equal" true (Pciaddr.compare addr0 addr1 = 0) ;
+  Alcotest.(check bool) "less than" true (Pciaddr.compare addr0 addr2 < 0) ;
+  Alcotest.(check bool) "greater than" true (Pciaddr.compare addr3 addr2 > 0) ;
+  Alcotest.(check bool) "greater than" true (Pciaddr.compare addr4 addr3 > 0) ;
+  Alcotest.(check bool) "greater than" true (Pciaddr.compare addr5 addr4 > 0) ;
+  Alcotest.(check bool) "less than" true (Pciaddr.compare addr6 addr5 > 0)
 
 let tests =
   [
@@ -479,6 +421,7 @@ let tests =
         )
       ; ("test_multi_nic_new_devices", `Quick, test_multi_nic_new_devices)
       ; ("test_pci_changes", `Quick, test_pci_changes)
+      ; ("test_pci_addr_compare", `Quick, test_pci_addr_compare)
       ]
     )
   ]