xapi-stdext-date: replace all usages to use clock instead

Not deleting the package and aliasing its main type to Clock.Date.t allows for
a smooth transition.

Signed-off-by: Pau Ruiz Safont <pau.ruizsafont@cloud.com>

Author: psafont

dune-project

@@ -338,6 +338,7 @@
     base64
     (bos :with-test)
     cdrom
+    (clock (= :version))
     cmdliner
     cohttp
     conf-pam
@@ -398,7 +399,6 @@
     (xapi-idl (= :version))
     (xapi-inventory (= :version))
     (xapi-log (= :version))
-    (xapi-stdext-date (= :version))
     (xapi-stdext-pervasives (= :version))
     (xapi-stdext-std (= :version))
     (xapi-stdext-threads (= :version))
@@ -604,6 +604,7 @@ This package provides an Lwt compatible interface to the library.")
     (alcotest :with-test)
     astring
     (base64 (>= "3.1.0"))
+    (clock (= :version))
     fmt
     ipaddr
     mtime
@@ -619,7 +620,6 @@ This package provides an Lwt compatible interface to the library.")
     xapi-backtrace
     (xapi-idl (= :version))
     (xapi-log (= :version))
-    (xapi-stdext-date (= :version))
     (xapi-stdext-pervasives (= :version))
     (xapi-stdext-threads (= :version))
     (xapi-tracing (= :version))

http-lib.opam

@@ -13,6 +13,7 @@ depends: [
   "alcotest" {with-test}
   "astring"
   "base64" {>= "3.1.0"}
+  "clock" {= version}
   "fmt"
   "ipaddr"
   "mtime"
@@ -28,7 +29,6 @@ depends: [
   "xapi-backtrace"
   "xapi-idl" {= version}
   "xapi-log" {= version}
-  "xapi-stdext-date" {= version}
   "xapi-stdext-pervasives" {= version}
   "xapi-stdext-threads" {= version}
   "xapi-tracing" {= version}

ocaml/alerts/certificate/certificate_check.ml

@@ -1,5 +1,5 @@
 module XenAPI = Client.Client
-module Date = Xapi_stdext_date.Date
+module Date = Clock.Date
 
 type cert =
   | CA of API.ref_Certificate * API.datetime

ocaml/alerts/certificate/certificate_check.mli

@@ -14,7 +14,8 @@
 
 val alert : (Rpc.call -> Rpc.response) -> [< `session] Ref.t -> unit
 
-(* Below exposed only for ease of testing *)
+(* Below exposed only for ease of testing, drop any documentation *)
+(**/**)
 
 type cert =
   | CA of API.ref_Certificate * API.datetime
@@ -25,11 +26,11 @@ val certificate_description : cert -> string
 
 val alert_conditions : cert -> (int * (string * int64)) list
 
-val get_expiry : cert -> Xapi_stdext_date.Date.t
+val get_expiry : cert -> Clock.Date.t
 
 val maybe_generate_alert :
-     Xapi_stdext_date.Date.t
+     Clock.Date.t
   -> string
   -> (int * (string * int64)) list
-  -> Xapi_stdext_date.Date.t
+  -> Clock.Date.t
   -> (string * (string * int64)) option

ocaml/alerts/certificate/dune

@@ -4,11 +4,12 @@
   (modes best)
   (libraries
     astring
+    ptime
     xapi-expiry-alerts
     xapi-client
     xapi-consts
     xapi-types
-    xapi-stdext-date
+    clock
   )
 )
 
@@ -18,7 +19,7 @@
   (modules certificate_check_main)
   (libraries
     certificate_check
-    
+
     http_lib
     xapi-client
     xapi-types

ocaml/alerts/dune

@@ -2,8 +2,8 @@
   (name expiry_alert)
   (public_name xapi-expiry-alerts)
   (libraries
+    clock
     xapi-client
     xapi-types
-    xapi-stdext-date
   )
 )

ocaml/alerts/expiry_alert.ml

@@ -13,7 +13,7 @@
  *)
 
 module XenAPI = Client.Client
-module Date = Xapi_stdext_date.Date
+module Date = Clock.Date
 
 type message_name = string
 
@@ -37,7 +37,7 @@ type raw_alert = {
   ; obj_uuid: string
   ; obj_description: string
   ; alert_conditions: (remaining_days * message_id) list
-  ; expiry: Xapi_stdext_date.Date.t (* when the obj will expire *)
+  ; expiry: Date.t (* when the obj will expire *)
 }
 
 let seconds_per_day = 3600. *. 24.
@@ -87,7 +87,7 @@ let filter_messages msg_name_list msg_obj_uuid alert all_msgs =
      )
 
 let alert ~rpc ~session_id raw_alerts =
-  let now = Date.now () in
+  let now = Clock.Date.now () in
   let all_msgs = all_messages rpc session_id in
   List.iter
     (fun {cls; obj_uuid; obj_description; alert_conditions; expiry} ->

ocaml/alerts/expiry_alert.mli

@@ -55,7 +55,7 @@ type raw_alert = {
          * sent, and when it has expired, message "host_server_certificate_expired"
          * should be sent.
          *)
-  ; expiry: Xapi_stdext_date.Date.t
+  ; expiry: Clock.Date.t
         (* the last second when the obj is valid, it will expire in the next second *)
 }
 
@@ -69,17 +69,17 @@ val alert :
 
 (* Below exposed only for ease of testing *)
 
-val message_body : string -> Xapi_stdext_date.Date.t -> string
+val message_body : string -> Clock.Date.t -> string
 
 val expired_message : string -> string
 
 val expiring_message : string -> string
 
 val maybe_generate_alert :
-     Xapi_stdext_date.Date.t
+     Clock.Date.t
   -> string
   -> (remaining_days * message_id) list
-  -> Xapi_stdext_date.Date.t
+  -> Clock.Date.t
   -> (string * message_id) option
 (** An inner function exposed only for ease of testing, it returns None if there is no
     need for an expiry alert as it is not expiring or expired yet, otherwise an "alert"

ocaml/forkexecd/lib/dune

@@ -15,7 +15,6 @@
    xapi-log
    xapi-stdext-pervasives
    xapi-stdext-unix
-   xapi-stdext-date
    xapi-tracing
  )
  (preprocess (per_module ((pps ppx_deriving_rpc) Fe))))

ocaml/forkexecd/lib/fe_systemctl.ml

@@ -139,7 +139,7 @@ let exists ~service = Sys.file_exists (path service)
 (** creation time of [path] as a string *)
 let ctime path =
   let ctime = Unix.((stat path).st_ctime) in
-  Xapi_stdext_date.Date.(of_unix_time ctime |> to_rfc3339)
+  Clock.Date.(of_unix_time ctime |> to_rfc3339)
 
 let start_transient ?env ?properties ?(exec_ty = Type.Simple) ~service cmd args
     =

ocaml/idl/datamodel_types.ml

@@ -26,7 +26,7 @@
 
 *)
 module Date = struct
-  module Date = Xapi_stdext_date.Date
+  module Date = Clock.Date
   include Date
 
   let t_of_rpc rpc = Date.of_iso8601 (Rpc.string_of_rpc rpc)

ocaml/idl/datamodel_types.mli

@@ -1,9 +1,9 @@
 module Date : sig
-  include module type of Xapi_stdext_date.Date
+  include module type of Clock.Date
 
-  val t_of_rpc : Rpc.t -> Xapi_stdext_date.Date.t
+  val t_of_rpc : Rpc.t -> Clock.Date.t
 
-  val rpc_of_t : Xapi_stdext_date.Date.t -> Rpc.t
+  val rpc_of_t : Clock.Date.t -> Rpc.t
 end
 
 val oss_since_303 : string option

ocaml/idl/dune

@@ -16,7 +16,7 @@
     xapi-backtrace
     xapi-consts
     xapi-schema
-    xapi-stdext-date
+    clock
     xapi-stdext-std
   )
   (wrapped false)

ocaml/idl/ocaml_backend/gen_api.ml

@@ -401,7 +401,7 @@ let gen_client_types _config highapi =
        ; ["module Ref = Ref"]
        ; [
            "module Date = struct"
-         ; "  open Xapi_stdext_date"
+         ; "  module Date = Clock.Date"
          ; "  include Date"
          ; "  let rpc_of_t x = DateTime (Date.to_rfc3339 x)"
          ; "  let t_of_rpc = function String x | DateTime x -> Date.of_iso8601 \

ocaml/libs/http-lib/dune

@@ -25,7 +25,7 @@
     xapi-consts.xapi_version
     xapi-idl.updates
     xapi-log
-    xapi-stdext-date
+    clock
     xapi-stdext-pervasives
     xapi-stdext-threads
     xapi-stdext-unix

ocaml/libs/http-lib/xMLRPC.ml

@@ -68,7 +68,7 @@ module To = struct
   let boolean b = value (box "boolean" [pcdata (if b then "1" else "0")])
 
   let datetime s =
-    value (box "dateTime.iso8601" [pcdata (Xapi_stdext_date.Date.to_rfc3339 s)])
+    value (box "dateTime.iso8601" [pcdata (Clock.Date.to_rfc3339 s)])
 
   let double x =
     let txt =
@@ -197,8 +197,7 @@ module From = struct
   let boolean = value (singleton ["boolean"] (( <> ) (Xml.PCData "0")))
 
   let datetime x =
-    Xapi_stdext_date.Date.of_iso8601
-      (value (singleton ["dateTime.iso8601"] (pcdata id)) x)
+    Clock.Date.of_iso8601 (value (singleton ["dateTime.iso8601"] (pcdata id)) x)
 
   let double = value (singleton ["double"] (pcdata float_of_string))
 

ocaml/libs/http-lib/xMLRPC.mli

@@ -59,7 +59,7 @@ module To : sig
   val boolean : bool -> xmlrpc
   (** Marshal a boolean. *)
 
-  val datetime : Xapi_stdext_date.Date.t -> xmlrpc
+  val datetime : Clock.Date.t -> xmlrpc
   (** Marshal a date-time. *)
 
   val double : float -> xmlrpc
@@ -98,7 +98,7 @@ module From : sig
   val boolean : xmlrpc -> bool
   (** Parse a boolean. *)
 
-  val datetime : xmlrpc -> Xapi_stdext_date.Date.t
+  val datetime : xmlrpc -> Clock.Date.t
   (** Parse a date-time. *)
 
   val double : xmlrpc -> float

ocaml/libs/xapi-stdext/lib/xapi-stdext-date/date.mli

@@ -13,7 +13,7 @@
  *)
 
 (** date-time with support for keeping timezone for ISO 8601 conversion *)
-type t
+type t = Clock.Date.t
 
 (** Conversions *)
 

ocaml/license/daily_license_check.ml

@@ -1,5 +1,5 @@
 module XenAPI = Client.Client
-module Date = Xapi_stdext_date.Date
+module Date = Clock.Date
 
 type result = Good | Expiring of string list | Expired of string list
 
@@ -18,7 +18,7 @@ let days_to_expiry ~expiry now =
 let get_expiry_date pool_license =
   List.assoc_opt "expiry" pool_license
   |> Fun.flip Option.bind (fun e -> if e = "never" then None else Some e)
-  |> Option.map Xapi_stdext_date.Date.of_iso8601
+  |> Option.map Clock.Date.of_iso8601
 
 let get_hosts all_license_params threshold =
   List.filter_map

ocaml/license/daily_license_check_main.ml

@@ -14,7 +14,7 @@ let _ =
   in
   Xapi_stdext_pervasives.Pervasiveext.finally
     (fun () ->
-      let now = Xapi_stdext_date.Date.now () in
+      let now = Clock.Date.now () in
       let pool, pool_license_state, all_license_params =
         Daily_license_check.get_info_from_db rpc session_id
       in

ocaml/license/dune

@@ -8,7 +8,7 @@
     xapi-consts
     xapi-client
     xapi-types
-    xapi-stdext-date
+    clock
   )
 )
 
@@ -21,7 +21,7 @@
     http_lib
     xapi-client
     xapi-types
-    xapi-stdext-date
+    clock
     xapi-stdext-pervasives
   )
 )

ocaml/quicktest/dune

@@ -31,7 +31,7 @@
     xapi_internal
     xapi-log
     xapi-types
-    xapi-stdext-date
+    clock
     xapi-stdext-pervasives
     xapi-stdext-std
     xapi-stdext-threads

ocaml/quicktest/qt.ml

@@ -100,9 +100,9 @@ module Time = struct
 
   let now () = Unix.gettimeofday ()
 
-  let of_field = Xapi_stdext_date.Date.to_unix_time
+  let of_field = Clock.Date.to_unix_time
 
-  let pp t = Xapi_stdext_date.Date.(of_unix_time t |> to_rfc3339)
+  let pp t = Clock.Date.(of_unix_time t |> to_rfc3339)
 
   let check t ~after ~before =
     Alcotest.(check bool)
@@ -268,8 +268,7 @@ module VDI = struct
         )
       ; ( `Same
         , "snapshot_time"
-        , fun vdi ->
-            vdi.API.vDI_snapshot_time |> Xapi_stdext_date.Date.to_rfc3339
+        , fun vdi -> vdi.API.vDI_snapshot_time |> Clock.Date.to_rfc3339
         )
       ; (`Same, "virtual_size", fun vdi -> vdi.API.vDI_location)
       ]

ocaml/quicktest/qt.mli

@@ -34,7 +34,7 @@ module Time : sig
 
   val now : unit -> t
 
-  val of_field : Xapi_stdext_date.Date.t -> t
+  val of_field : Clock.Date.t -> t
 
   val pp : t -> string
 

ocaml/quicktest/quicktest_date.ml

@@ -1,5 +1,5 @@
 module Client = Client.Client
-module Date = Xapi_stdext_date.Date
+module Date = Clock.Date
 
 let test_host_get_server_localtime rpc session_id () =
   let host = Client.Host.get_by_uuid ~rpc ~session_id ~uuid:Qt.localhost_uuid in

ocaml/quicktest/quicktest_event.ml

@@ -381,7 +381,7 @@ let event_message_test rpc session_id () =
     ) ;
   let messages =
     Client.Client.Message.get ~rpc ~session_id ~cls ~obj_uuid
-      ~since:Xapi_stdext_date.Date.epoch
+      ~since:Clock.Date.epoch
   in
   let has_msg m = List.exists (fun (r, _) -> r = m) messages in
   Alcotest.(check bool)

ocaml/quicktest/quicktest_vdi.ml

@@ -139,7 +139,7 @@ let vdi_bad_introduce rpc session_id sr_info () =
               ~location:(Ref.string_of (Ref.make ()))
               ~xenstore_data:[] ~sm_config:[] ~managed:true ~virtual_size:0L
               ~physical_utilisation:0L ~metadata_of_pool:Ref.null
-              ~is_a_snapshot:false ~snapshot_time:Xapi_stdext_date.Date.epoch
+              ~is_a_snapshot:false ~snapshot_time:Clock.Date.epoch
               ~snapshot_of:Ref.null
           in
           Alcotest.fail
@@ -161,7 +161,7 @@ let vdi_bad_introduce rpc session_id sr_info () =
             ~other_config:[] ~location:vdir.API.vDI_location ~xenstore_data:[]
             ~sm_config:[] ~managed:true ~virtual_size:0L
             ~physical_utilisation:0L ~metadata_of_pool:Ref.null
-            ~is_a_snapshot:false ~snapshot_time:Xapi_stdext_date.Date.epoch
+            ~is_a_snapshot:false ~snapshot_time:Clock.Date.epoch
             ~snapshot_of:Ref.null
         in
         Alcotest.fail