CP-24903: Rename Network.purposes to purpose

This is for consistency.

Now the add/remove functions that would be autogenerated if the
field were RW would themselves have names ending "purpose", and
therefore would be the same as the hand-written add/remove
functions that add and remove a single purpose.

(Before this change, the hypothetical autogenerated
functions would have been "add/remove_purposes" even
though they add/remove only a single purpose.)

Signed-off-by: Thomas Sanders <[email protected]>

Author: thomassa

ocaml/idl/datamodel.ml

@@ -5207,7 +5207,7 @@ let network_introduce_params first_rel =
     {param_type=Map(String,String); param_name="other_config"; param_doc=""; param_release=first_rel; param_default=None};
     {param_type=String; param_name="bridge"; param_doc=""; param_release=first_rel; param_default=None};
     {param_type=Bool; param_name="managed"; param_doc=""; param_release=falcon_release; param_default=None};
-    {param_type=Set(network_purpose); param_name="purposes"; param_doc=""; param_release=inverness_release; param_default=None};
+    {param_type=Set(network_purpose); param_name="purpose"; param_doc=""; param_release=inverness_release; param_default=None};
   ]
 
 (* network pool introduce is used to copy network records on pool join -- it's the network analogue of VDI/PIF.pool_introduce *)
@@ -5317,7 +5317,7 @@ let network =
           field ~writer_roles:_R_VM_OP ~in_product_since:rel_orlando ~default_value:(Some (VSet [])) ~ty:(Set String) "tags" "user-specified tags for categorization purposes";
           field ~qualifier:DynamicRO ~in_product_since:rel_tampa ~default_value:(Some (VEnum "unlocked")) ~ty:network_default_locking_mode "default_locking_mode" "The network will use this value to determine the behaviour of all VIFs where locking_mode = default";
           field ~qualifier:DynamicRO ~in_product_since:rel_creedence ~default_value:(Some (VMap [])) ~ty:(Map (Ref _vif, String)) "assigned_ips" "The IP addresses assigned to VIFs on networks that have active xapi-managed DHCP";
-          field ~qualifier:StaticRO ~in_product_since:rel_inverness ~default_value:(Some (VSet [])) ~ty:(Set network_purpose) "purposes" "Set of purposes for which the server will use this network";
+          field ~qualifier:StaticRO ~in_product_since:rel_inverness ~default_value:(Some (VSet [])) ~ty:(Set network_purpose) "purpose" "Set of purposes for which the server will use this network";
         ])
     ()
 

ocaml/perftest/createpool.ml

@@ -51,7 +51,7 @@ let initialise session_id template pool =
   let networks_to_create = pool.interfaces_per_host - pool.bonds in
   debug "Creating %d networks..." networks_to_create;
   let networks = Array.init networks_to_create (fun i ->
-      Client.Network.create ~rpc ~session_id ~name_label:(Printf.sprintf "perftestnet%d" i) ~name_description:"" ~mTU:1500L ~other_config:[oc_key,pool.key] ~bridge:"" ~managed:true ~tags:[] ~purposes:[])
+      Client.Network.create ~rpc ~session_id ~name_label:(Printf.sprintf "perftestnet%d" i) ~name_description:"" ~mTU:1500L ~other_config:[oc_key,pool.key] ~bridge:"" ~managed:true ~tags:[] ~purpose:[])
   in
 
   (* Set up the template - create the VIFs *)

ocaml/xapi/create_networks.ml

@@ -40,7 +40,7 @@ let create_guest_installer_network ~__context =
     let h' = Xapi_network.create ~__context ~name_label:internal_management_network_name
         ~name_description:internal_management_network_desc ~mTU:1500L
         ~other_config:internal_management_network_oc ~bridge:"" ~managed:true ~tags:[]
-        ~purposes:[] in
+        ~purpose:[] in
     Db.Network.set_bridge ~__context ~self:h' ~value:internal_management_bridge;
     debug "Created new host internal management network: %s" (Ref.string_of h')
 

ocaml/xapi/dbsync_slave.ml

@@ -183,12 +183,12 @@ let record_host_memory_properties ~__context =
       ~current_operations:[] ~allowed_operations:[]
       ~name_label:"Test uniqueness constraint"
       ~name_description:"Testing"
-      ~bridge:"bridge" ~other_config:[] ~purposes:[];
+      ~bridge:"bridge" ~other_config:[] ~purpose:[];
     Db.Network.create ~__context ~ref:(Ref.make()) ~uuid:duplicate_uuid
       ~current_operations:[] ~allowed_operations:[]
       ~name_label:"Test uniqueness constraint"
       ~name_description:"Testing"
-      ~bridge:"bridge" ~other_config:[] ~purposes:[];
+      ~bridge:"bridge" ~other_config:[] ~purpose:[];
     ()
 *)
 

ocaml/xapi/debug_populate.ml

@@ -34,7 +34,7 @@ let rec make_networks __context i =
   else
     begin
       let nw_ref = Xapi_network.create ~__context ~name_label:("Network-"^(string_of_int i)) ~name_description:"dummy"
-        ~mTU:1500L ~other_config:[] ~bridge:"" ~managed:true ~tags:[] ~purposes:[] in
+        ~mTU:1500L ~other_config:[] ~bridge:"" ~managed:true ~tags:[] ~purpose:[] in
       nws := nw_ref :: !nws;
       make_networks __context (i-1)
     end

ocaml/xapi/records.ml

@@ -445,8 +445,8 @@ let net_record rpc session_id net =
                  (Record_util.string_to_network_default_locking_mode value)) ();
 
       make_field ~name:"purposes"
-        ~get:(fun () -> (x ()).API.network_purposes |> List.map Record_util.network_purpose_to_string |> (String.concat ", "))
-        ~get_set:(fun () -> (x ()).API.network_purposes |> List.map Record_util.network_purpose_to_string)
+        ~get:(fun () -> (x ()).API.network_purpose |> List.map Record_util.network_purpose_to_string |> (String.concat ", "))
+        ~get_set:(fun () -> (x ()).API.network_purpose |> List.map Record_util.network_purpose_to_string)
         ~add_to_set:(fun s -> Client.Network.add_purpose rpc session_id net
                         (Record_util.string_to_network_purpose s))
         ~remove_from_set:(fun s -> Client.Network.remove_purpose rpc session_id net

ocaml/xapi/test_common.ml

@@ -162,8 +162,8 @@ let make_pif ~__context ~network ~host ?(device="eth0") ?(mAC="C0:FF:EE:C0:FF:EE
     ~ipv6_configuration_mode ~iPv6 ~ipv6_gateway ~primary_address_type ~managed ~properties
 
 let make_network ~__context ?(name_label="net") ?(name_description="description") ?(mTU=1500L)
-    ?(other_config=[]) ?(bridge="xenbr0") ?(managed=true) ?(purposes=[]) () =
-  Xapi_network.pool_introduce ~__context ~name_label ~name_description ~mTU ~other_config ~bridge ~managed ~purposes
+    ?(other_config=[]) ?(bridge="xenbr0") ?(managed=true) ?(purpose=[]) () =
+  Xapi_network.pool_introduce ~__context ~name_label ~name_description ~mTU ~other_config ~bridge ~managed ~purpose
 
 let make_vif ~__context ?(ref=Ref.make ()) ?(uuid=make_uuid ())
     ?(current_operations=[]) ?(allowed_operations=[]) ?(reserved=false)

ocaml/xapi/xapi.ml

@@ -533,7 +533,7 @@ let check_network_reset () =
              match existing_network with
              | None ->
                let name_label = Printf.sprintf "Pool-wide network associated with %s on VLAN%s" device vlan in
-               Xapi_network.create ~__context ~name_label ~name_description:"" ~mTU:1500L ~other_config:[] ~bridge:"" ~managed:true ~tags:[] ~purposes:[]
+               Xapi_network.create ~__context ~name_label ~name_description:"" ~mTU:1500L ~other_config:[] ~bridge:"" ~managed:true ~tags:[] ~purpose:[]
              | Some network -> network
            in
            let vlan, untagged_PIF = Xapi_vlan.create_internal ~__context ~host ~tagged_PIF:pif

ocaml/xapi/xapi_network.ml

@@ -185,10 +185,10 @@ let counter = ref 0
 let mutex = Mutex.create ()
 let stem = "xapi"
 
-let pool_introduce ~__context ~name_label ~name_description ~mTU ~other_config ~bridge ~managed ~purposes =
+let pool_introduce ~__context ~name_label ~name_description ~mTU ~other_config ~bridge ~managed ~purpose =
   let r = Ref.make() and uuid = Uuid.make_uuid() in
   Db.Network.create ~__context ~ref:r ~uuid:(Uuid.to_string uuid)
-    ~current_operations:[] ~allowed_operations:[] ~purposes
+    ~current_operations:[] ~allowed_operations:[] ~purpose
     ~name_label ~name_description ~mTU ~bridge ~managed
     ~other_config ~blobs:[] ~tags:[] ~default_locking_mode:`unlocked ~assigned_ips:[];
   r
@@ -201,7 +201,7 @@ let rec choose_bridge_name bridges =
   else
     name
 
-let create ~__context ~name_label ~name_description ~mTU ~other_config ~bridge ~managed ~tags ~purposes =
+let create ~__context ~name_label ~name_description ~mTU ~other_config ~bridge ~managed ~tags ~purpose =
   Mutex.execute mutex (fun () ->
       let networks = Db.Network.get_all ~__context in
       let bridges = List.map (fun self -> Db.Network.get_bridge ~__context ~self) networks in
@@ -227,7 +227,7 @@ let create ~__context ~name_label ~name_description ~mTU ~other_config ~bridge ~
       Db.Network.create ~__context ~ref:r ~uuid:(Uuid.to_string uuid)
         ~current_operations:[] ~allowed_operations:[]
         ~name_label ~name_description ~mTU ~bridge ~managed
-        ~other_config ~blobs:[] ~tags ~purposes ~default_locking_mode:`unlocked ~assigned_ips:[];
+        ~other_config ~blobs:[] ~tags ~purpose ~default_locking_mode:`unlocked ~assigned_ips:[];
       r
     )
 
@@ -342,7 +342,7 @@ let assert_can_add_purpose ~__context ~network ~current newval =
      * type doesn't allow searching for a value inside a list. *)
     Db.Network.get_all ~__context |>
     List.iter (fun nwk ->
-      Db.Network.get_purposes ~__context ~self:nwk |>
+      Db.Network.get_purpose ~__context ~self:nwk |>
       List.iter (fun suspect -> if (List.mem suspect bads) then
         info "Cannot set new network purpose %s when there is a network with purpose %s" (sop newval) (sop suspect);
         reject (sop suspect)
@@ -354,15 +354,15 @@ let assert_can_add_purpose ~__context ~network ~current newval =
   | `insecure_nbd -> assert_no_net_has_bad_porpoise [`nbd]
 
 let add_purpose ~__context ~self ~value =
-  let current = Db.Network.get_purposes ~__context ~self in
+  let current = Db.Network.get_purpose ~__context ~self in
   if not (List.mem value current) then (
     assert_can_add_purpose ~__context ~network:self ~current value;
-    Db.Network.set_purposes ~__context ~self ~value:(value::current)
+    Db.Network.set_purpose ~__context ~self ~value:(value::current)
   )
 
 let remove_purpose ~__context ~self ~value =
-  let current = Db.Network.get_purposes ~__context ~self in
+  let current = Db.Network.get_purpose ~__context ~self in
   if (List.mem value current) then (
     let porpoises = List.filter ((<>) value) current in
-    Db.Network.set_purposes ~__context ~self ~value:(porpoises)
+    Db.Network.set_purpose ~__context ~self ~value:(porpoises)
   )

ocaml/xapi/xapi_network.mli

@@ -73,7 +73,7 @@ val pool_introduce :
   other_config:(string * string) list ->
   bridge:string ->
   managed:bool ->
-  purposes:API.network_purpose list ->
+  purpose:API.network_purpose list ->
   [ `network ] Ref.t
 
 (** Attempt to create a bridge with a unique name *)
@@ -86,7 +86,7 @@ val create :
   bridge:string ->
   managed:bool ->
   tags:string list ->
-  purposes:API.network_purpose list ->
+  purpose:API.network_purpose list ->
   [ `network ] Ref.t
 
 (** WARNING WARNING WARNING: called with the master dispatcher lock; do nothing but basic DB calls