idl: Rename pool_allowed_operations to pool_operations

This commit addresses a fixme in idl/datamodel_pool.ml. The name
pool_allowed_operations conflicts with field Pool.allowed_operations,
so renaming for clarity.

Signed-off-by: Christian Pardillo Laursen <christian.pardillolaursen@citrix.com>

Author: cplaursen

ocaml/idl/datamodel_common.ml

@@ -10,7 +10,7 @@ open Datamodel_roles
               to leave a gap for potential hotfixes needing to increment the schema version.*)
 let schema_major_vsn = 5
 
-let schema_minor_vsn = 791
+let schema_minor_vsn = 792
 
 (* Historical schema versions just in case this is useful later *)
 let rio_schema_major_vsn = 5

ocaml/idl/datamodel_pool.ml

@@ -4,9 +4,8 @@ open Datamodel_types
 
 let operations =
   Enum
-    ( "pool_allowed_operations"
-    , (* FIXME: This should really be called `pool_operations`, to avoid confusion with the Pool.allowed_operations field *)
-      [
+    ( "pool_operations"
+    , [
         ("ha_enable", "Indicates this pool is in the process of enabling HA")
       ; ("ha_disable", "Indicates this pool is in the process of disabling HA")
       ; ( "cluster_create"

ocaml/idl/schematest.ml

@@ -3,7 +3,7 @@ let hash x = Digest.string x |> Digest.to_hex
 (* BEWARE: if this changes, check that schema has been bumped accordingly in
    ocaml/idl/datamodel_common.ml, usually schema_minor_vsn *)
 
-let last_known_schema_hash = "3b20f4304cfaaa7b6213af91ae632e64"
+let last_known_schema_hash = "eceed401894f1aa22ba0fc41e08113c1"
 
 let current_schema_hash : string =
   let open Datamodel_types in

ocaml/tests/record_util/test_record_util.ml

@@ -133,7 +133,7 @@ let tests =
       , N.pool_guest_secureboot_readiness_to_string
       )
   ; mk __LINE__ None all_pool_allowed_operations
-      (O.pool_operation_to_string, N.pool_allowed_operations_to_string)
+      (O.pool_operation_to_string, N.pool_operations_to_string)
   ; mk __LINE__ None all_host_allowed_operations
       (O.host_operation_to_string, N.host_operation_to_string)
   ; mk __LINE__ None all_update_guidances

ocaml/xapi-cli-server/records.ml

@@ -1222,23 +1222,23 @@ let pool_record rpc session_id pool =
           ()
       ; make_field ~name:"allowed-operations"
           ~get:(fun () ->
-            map_and_concat Record_util.pool_allowed_operations_to_string
+            map_and_concat Record_util.pool_operations_to_string
               (x ()).API.pool_allowed_operations
           )
           ~get_set:(fun () ->
-            List.map Record_util.pool_allowed_operations_to_string
+            List.map Record_util.pool_operations_to_string
               (x ()).API.pool_allowed_operations
           )
           ()
       ; make_field ~name:"current-operations"
           ~get:(fun () ->
             map_and_concat
-              (fun (_, b) -> Record_util.pool_allowed_operations_to_string b)
+              (fun (_, b) -> Record_util.pool_operations_to_string b)
               (x ()).API.pool_current_operations
           )
           ~get_set:(fun () ->
             List.map
-              (fun (_, b) -> Record_util.pool_allowed_operations_to_string b)
+              (fun (_, b) -> Record_util.pool_operations_to_string b)
               (x ()).API.pool_current_operations
           )
           ()

ocaml/xapi/xapi_pool_helpers.ml

@@ -42,7 +42,7 @@ type waiting_operations =
 type all_operations = [blocking_operations | waiting_operations]
 
 (* Unused, ensure every API operation is statically partitioned here. *)
-let _id (op : API.pool_allowed_operations) : all_operations = op
+let _id (op : API.pool_operations) : all_operations = op
 
 (* psr is not included as a pool op because it can be considered in progress
    in between api calls (i.e. wrapping it inside with_pool_operation won't work) *)
@@ -97,7 +97,7 @@ type validity = Unknown | Allowed | Disallowed of string * string list
    element of all_operations to a value indicating whether it would be
    valid for it to be executed in the inputted execution context. *)
 let compute_valid_operations ~__context record pool :
-    API.pool_allowed_operations -> validity =
+    API.pool_operations -> validity =
   let ref = Ref.string_of pool in
   let current_ops = record.Db_actions.pool_current_operations in
   let table = (Hashtbl.create 32 : (all_operations, validity) Hashtbl.t) in
@@ -122,7 +122,7 @@ let compute_valid_operations ~__context record pool :
     let additional_info =
       match waiting_op with
       | Some (op_ref, op_type) ->
-          [API.pool_allowed_operations_to_string op_type; op_ref]
+          [API.pool_operations_to_string op_type; op_ref]
       | _ ->
           []
     in
@@ -202,8 +202,7 @@ let compute_valid_operations ~__context record pool :
   ) ;
   fun op -> Hashtbl.find_opt table op |> Option.value ~default:Unknown
 
-let assert_operation_valid ~__context ~self ~(op : API.pool_allowed_operations)
-    =
+let assert_operation_valid ~__context ~self ~(op : API.pool_operations) =
   (* No pool operations allowed during a pending PSR. *)
   if Db.Pool.get_is_psr_pending ~__context ~self:(Helpers.get_pool ~__context)
   then
@@ -218,7 +217,7 @@ let assert_operation_valid ~__context ~self ~(op : API.pool_allowed_operations)
   | Unknown ->
       (* This should never happen and implies our validity algorithm is incomplete. *)
       let detail =
-        let op = pool_allowed_operations_to_string op in
+        let op = pool_operations_to_string op in
         Printf.sprintf "%s.%s unknown operation: %s" __MODULE__ __FUNCTION__ op
       in
       raise Api_errors.(Server_error (internal_error, [detail]))
@@ -269,7 +268,7 @@ let assert_no_pool_ops ~__context =
       let err =
         ops
         |> List.map snd
-        |> List.map Record_util.pool_allowed_operations_to_string
+        |> List.map Record_util.pool_operations_to_string
         |> String.concat "; "
         |> Printf.sprintf "pool operations in progress: [ %s ]"
       in

ocaml/xapi/xapi_pool_helpers.mli

@@ -20,7 +20,7 @@ val with_pool_operation :
      __context:Context.t
   -> self:API.ref_pool
   -> doc:string
-  -> op:API.pool_allowed_operations
+  -> op:API.pool_operations
   -> (unit -> 'a)
   -> 'a